AdvisoryMessage
The AdvisoryMessage custom type provides more detail about status messages.
The following table lists the status types and related codes for the AdvisoryMessage type.
Status Type | Description | Code |
---|---|---|
STATUS_LEVEL_INFO | Informational message only. Does not reflect a failure in the call to the Deliver TMS. | 0 |
STATUS_LEVEL_WARNING | The call to the Deliver TMS succeeded, but an issue exists that requires further investigation. | 1 |
STATUS_LEVEL_ERROR | The call to the Deliver TMS failed. | 2 |
Methods for AdvisoryMessage
The AdvisoryMessage type contains the following methods.
Method | Description | Returns |
---|---|---|
getStatusLevel |
Returns the severity level of the status messages: Informational, Warning, or Error. For example, for STATUS_LEVEL_ERROR, this method returns the code: 2. |
Int |
getMessageCode |
Returns the code for an error message. For example, for the error, INVALID_LOGIN, this method returns the code: 1. |
Int |
getMessage |
Returns an error message. |
String |
getDetailMessage |
Returns more details about an error message, if available. |
String |