Handling Errors

If an API call fails (SOAP fault or HTTP error), CampaignException object is thrown. This object contains the following attributes

• message a message describing the error
• statusCode a HTTP status code. In case of a SOAP fault, the status code will be 500
• errorCode the Campaign error code if one is available (ex: XSV-350013)
• methodCall the SOAP call which caused the error. It will contain the following attributes
  • type the type of the API call ("SOAP" or "HTTP")
  • urn the SOAP call URN, i.e. the schema id. Will be empty for HTTP methods
  • url the HTTP URL
  • methodName the name of the SOAP method. For HTTP methods, the query path
  • request the raw SOAP request, as text. For HTTP requests, this is an option object containing details about the request
  • response the raw SOAP/HTTP response, as text
• faultCode for SOAP faults, the Campaign error code
• faultString the error message
• detail optional additional details about the error

In general all errors are mapped to a CampaignException and we try to keep the semantic of errors: for instance a call with an incorrect parameter will return an HTTP stauts of 400 even if it's not actually a, HTTP call. SDK specific errors will have an errorCode with the "SDK-######" format, using "SDK" as a prefix.

try {
  await client.logon();
  result = await NLWS.xtkSession.getServerTime();
} catch (ex) {
  /*
    CampaignException object
    ex.statusCode: the HTTP status code, such as 500, 404…
    ex.errorCode the Campaign error code (ex: XSV-350013)
    ex.faultCode the Campaign iRc or some other error code (ex: -53)
    ex.faultString the Error message
  */
  console.log(ex.message);  
}

It's also noteworthy that all the data returned in a CampaignException is trimmed, i.e. session and security token values are hidden, so that the exception object can be safely logged.

Note: The transport protocol returns errors of type HttpError which are wrapped into CampaignException objects.