MTN USSD v1

AVAILABLE IN

Eswatini Zambia

Download

Download Postman collection Download Swagger

Available endpoints

POST v1/messages/ussd/subscription

Description

This function enables 3PP to subscribe to receive MO-generated messages from MADAPI.

Header parameters

Content-Type application/json

Auth parameters

apikey x-api-key

FormData parameters

serviceCode string required
callbackUrl string required
URL from which the 3PP will receive MO-generated USSD message.
targetSystem string required
Name of the destined system for the callback url.
201Created
statusCode string
statusMessage string
transactionId string
data
subscriptionId string
The value is a random number defined by MADAPI and must be unique. Associated with the registered USSD.
_link
self
href string
{
    "statusCode": [],
    "statusMessage": [],
    "transactionId": [],
    "data": [],
    "_link": []
}
400Bad Request
statusCode string
This is the MADAPI Canonical Response Code (it is 4 characters long and it is not the HTTP Status Code which is 3 characters long). Back-end system errors are mapped to specific Canonical Response Codes which are returned. More information on these mappings can be found on the MADAPI Confluence Page 'Response Codes'
statusMessage string
More details on the returned status code which can be shown to a client
supportMessage string
Internal message meant for consumers of the API to troubleshoot the error (could possible include the back-end system error code in the message if it would be useful)
transactionId string
MADAPI generated Id to include for tracing requests
timestamp string
Timestamp that the error occurred
path string
The path that caused the error
method string
The HTTP method type that was used
{
    "statusCode": [],
    "statusMessage": [],
    "supportMessage": [],
    "transactionId": [],
    "timestamp": [],
    "path": [],
    "method": []
}
401Unauthorized
statusCode string
This is the MADAPI Canonical Response Code (it is 4 characters long and it is not the HTTP Status Code which is 3 characters long). Back-end system errors are mapped to specific Canonical Response Codes which are returned. More information on these mappings can be found on the MADAPI Confluence Page 'Response Codes'
statusMessage string
More details on the returned status code which can be shown to a client
supportMessage string
Internal message meant for consumers of the API to troubleshoot the error (could possible include the back-end system error code in the message if it would be useful)
transactionId string
MADAPI generated Id to include for tracing requests
timestamp string
Timestamp that the error occurred
path string
The path that caused the error
method string
The HTTP method type that was used
{
    "statusCode": [],
    "statusMessage": [],
    "supportMessage": [],
    "transactionId": [],
    "timestamp": [],
    "path": [],
    "method": []
}
403Forbidden
statusCode string
This is the MADAPI Canonical Response Code (it is 4 characters long and it is not the HTTP Status Code which is 3 characters long). Back-end system errors are mapped to specific Canonical Response Codes which are returned. More information on these mappings can be found on the MADAPI Confluence Page 'Response Codes'
statusMessage string
More details on the returned status code which can be shown to a client
supportMessage string
Internal message meant for consumers of the API to troubleshoot the error (could possible include the back-end system error code in the message if it would be useful)
transactionId string
MADAPI generated Id to include for tracing requests
timestamp string
Timestamp that the error occurred
path string
The path that caused the error
method string
The HTTP method type that was used
{
    "statusCode": [],
    "statusMessage": [],
    "supportMessage": [],
    "transactionId": [],
    "timestamp": [],
    "path": [],
    "method": []
}
404Not Found
statusCode string
This is the MADAPI Canonical Response Code (it is 4 characters long and it is not the HTTP Status Code which is 3 characters long). Back-end system errors are mapped to specific Canonical Response Codes which are returned. More information on these mappings can be found on the MADAPI Confluence Page 'Response Codes'
statusMessage string
More details on the returned status code which can be shown to a client
supportMessage string
Internal message meant for consumers of the API to troubleshoot the error (could possible include the back-end system error code in the message if it would be useful)
transactionId string
MADAPI generated Id to include for tracing requests
timestamp string
Timestamp that the error occurred
path string
The path that caused the error
method string
The HTTP method type that was used
{
    "statusCode": [],
    "statusMessage": [],
    "supportMessage": [],
    "transactionId": [],
    "timestamp": [],
    "path": [],
    "method": []
}
415Unsupported Media Type
statusCode string
This is the MADAPI Canonical Response Code (it is 4 characters long and it is not the HTTP Status Code which is 3 characters long). Back-end system errors are mapped to specific Canonical Response Codes which are returned. More information on these mappings can be found on the MADAPI Confluence Page 'Response Codes'
statusMessage string
More details on the returned status code which can be shown to a client
supportMessage string
Internal message meant for consumers of the API to troubleshoot the error (could possible include the back-end system error code in the message if it would be useful)
transactionId string
MADAPI generated Id to include for tracing requests
timestamp string
Timestamp that the error occurred
path string
The path that caused the error
method string
The HTTP method type that was used
{
    "statusCode": [],
    "statusMessage": [],
    "supportMessage": [],
    "transactionId": [],
    "timestamp": [],
    "path": [],
    "method": []
}
500Internal Server Error
statusCode string
This is the MADAPI Canonical Response Code (it is 4 characters long and it is not the HTTP Status Code which is 3 characters long). Back-end system errors are mapped to specific Canonical Response Codes which are returned. More information on these mappings can be found on the MADAPI Confluence Page 'Response Codes'
statusMessage string
More details on the returned status code which can be shown to a client
supportMessage string
Internal message meant for consumers of the API to troubleshoot the error (could possible include the back-end system error code in the message if it would be useful)
transactionId string
MADAPI generated Id to include for tracing requests
timestamp string
Timestamp that the error occurred
path string
The path that caused the error
method string
The HTTP method type that was used
{
    "statusCode": [],
    "statusMessage": [],
    "supportMessage": [],
    "transactionId": [],
    "timestamp": [],
    "path": [],
    "method": []
}
501Not Implemented
statusCode string
This is the MADAPI Canonical Response Code (it is 4 characters long and it is not the HTTP Status Code which is 3 characters long). Back-end system errors are mapped to specific Canonical Response Codes which are returned. More information on these mappings can be found on the MADAPI Confluence Page 'Response Codes'
statusMessage string
More details on the returned status code which can be shown to a client
supportMessage string
Internal message meant for consumers of the API to troubleshoot the error (could possible include the back-end system error code in the message if it would be useful)
transactionId string
MADAPI generated Id to include for tracing requests
timestamp string
Timestamp that the error occurred
path string
The path that caused the error
method string
The HTTP method type that was used
{
    "statusCode": [],
    "statusMessage": [],
    "supportMessage": [],
    "transactionId": [],
    "timestamp": [],
    "path": [],
    "method": []
}
503Service Unavailable
statusCode string
This is the MADAPI Canonical Response Code (it is 4 characters long and it is not the HTTP Status Code which is 3 characters long). Back-end system errors are mapped to specific Canonical Response Codes which are returned. More information on these mappings can be found on the MADAPI Confluence Page 'Response Codes'
statusMessage string
More details on the returned status code which can be shown to a client
supportMessage string
Internal message meant for consumers of the API to troubleshoot the error (could possible include the back-end system error code in the message if it would be useful)
transactionId string
MADAPI generated Id to include for tracing requests
timestamp string
Timestamp that the error occurred
path string
The path that caused the error
method string
The HTTP method type that was used
{
    "statusCode": [],
    "statusMessage": [],
    "supportMessage": [],
    "transactionId": [],
    "timestamp": [],
    "path": [],
    "method": []
}
POST v1/messages/ussd/inbound

Description

This function sends USSD MO-generated message to a 3PP with subscription on MADAPI.

Header parameters

Content-Type application/json

Auth parameters

apikey x-api-key

FormData parameters

sessionId string required
Unique identifier of the session.
messageType string required
Message type. 0-Begin|1-Continue|2-End|3-Notification|4-Cancel|5-Timeout.
msisdn string required
Mobile number of the message recipient.
serviceCode string required
ussdString string required
USSD message content. If messageType is of type 4-Abort, this attribute will contain the abort reason or message.
cellId string
Cell Id of the subscriber. A GSM Cell ID (CID) is a unique number used to identify each base transceiver station (BTS) or sector of a BTS within a location area code (LAC) if not within a GSM network.
language string
Language of preference of the subscriber
imsi string
IMSI of the subscriber. An international mobile subscriber identity (IMSI) is a unique number, usually fifteen digits, associated with Global System for Mobile Communications (GSM) and Universal Mobile Telecommunications System (UMTS) network mobile phone users. The IMSI is a unique number identifying a GSM subscriber.
200OK
statusCode string
statusMessage string
transactionId string
data
inboundResponse string
Response value.
userInputRequired boolean
Is user input required.
messageType integer
The messageType to send
serviceCode string
The service code or short code of the service.
msisdn string
The msisdn to send the response to.
_link
self
href string
{
    "statusCode": [],
    "statusMessage": [],
    "transactionId": [],
    "data": [],
    "_link": []
}
400Bad Request
statusCode string
This is the MADAPI Canonical Response Code (it is 4 characters long and it is not the HTTP Status Code which is 3 characters long). Back-end system errors are mapped to specific Canonical Response Codes which are returned. More information on these mappings can be found on the MADAPI Confluence Page 'Response Codes'
statusMessage string
More details on the returned status code which can be shown to a client
supportMessage string
Internal message meant for consumers of the API to troubleshoot the error (could possible include the back-end system error code in the message if it would be useful)
transactionId string
MADAPI generated Id to include for tracing requests
timestamp string
Timestamp that the error occurred
path string
The path that caused the error
method string
The HTTP method type that was used
{
    "statusCode": [],
    "statusMessage": [],
    "supportMessage": [],
    "transactionId": [],
    "timestamp": [],
    "path": [],
    "method": []
}
401Unauthorized
statusCode string
This is the MADAPI Canonical Response Code (it is 4 characters long and it is not the HTTP Status Code which is 3 characters long). Back-end system errors are mapped to specific Canonical Response Codes which are returned. More information on these mappings can be found on the MADAPI Confluence Page 'Response Codes'
statusMessage string
More details on the returned status code which can be shown to a client
supportMessage string
Internal message meant for consumers of the API to troubleshoot the error (could possible include the back-end system error code in the message if it would be useful)
transactionId string
MADAPI generated Id to include for tracing requests
timestamp string
Timestamp that the error occurred
path string
The path that caused the error
method string
The HTTP method type that was used
{
    "statusCode": [],
    "statusMessage": [],
    "supportMessage": [],
    "transactionId": [],
    "timestamp": [],
    "path": [],
    "method": []
}
403Forbidden
statusCode string
This is the MADAPI Canonical Response Code (it is 4 characters long and it is not the HTTP Status Code which is 3 characters long). Back-end system errors are mapped to specific Canonical Response Codes which are returned. More information on these mappings can be found on the MADAPI Confluence Page 'Response Codes'
statusMessage string
More details on the returned status code which can be shown to a client
supportMessage string
Internal message meant for consumers of the API to troubleshoot the error (could possible include the back-end system error code in the message if it would be useful)
transactionId string
MADAPI generated Id to include for tracing requests
timestamp string
Timestamp that the error occurred
path string
The path that caused the error
method string
The HTTP method type that was used
{
    "statusCode": [],
    "statusMessage": [],
    "supportMessage": [],
    "transactionId": [],
    "timestamp": [],
    "path": [],
    "method": []
}
404Not Found
statusCode string
This is the MADAPI Canonical Response Code (it is 4 characters long and it is not the HTTP Status Code which is 3 characters long). Back-end system errors are mapped to specific Canonical Response Codes which are returned. More information on these mappings can be found on the MADAPI Confluence Page 'Response Codes'
statusMessage string
More details on the returned status code which can be shown to a client
supportMessage string
Internal message meant for consumers of the API to troubleshoot the error (could possible include the back-end system error code in the message if it would be useful)
transactionId string
MADAPI generated Id to include for tracing requests
timestamp string
Timestamp that the error occurred
path string
The path that caused the error
method string
The HTTP method type that was used
{
    "statusCode": [],
    "statusMessage": [],
    "supportMessage": [],
    "transactionId": [],
    "timestamp": [],
    "path": [],
    "method": []
}
415Unsupported Media Type
statusCode string
This is the MADAPI Canonical Response Code (it is 4 characters long and it is not the HTTP Status Code which is 3 characters long). Back-end system errors are mapped to specific Canonical Response Codes which are returned. More information on these mappings can be found on the MADAPI Confluence Page 'Response Codes'
statusMessage string
More details on the returned status code which can be shown to a client
supportMessage string
Internal message meant for consumers of the API to troubleshoot the error (could possible include the back-end system error code in the message if it would be useful)
transactionId string
MADAPI generated Id to include for tracing requests
timestamp string
Timestamp that the error occurred
path string
The path that caused the error
method string
The HTTP method type that was used
{
    "statusCode": [],
    "statusMessage": [],
    "supportMessage": [],
    "transactionId": [],
    "timestamp": [],
    "path": [],
    "method": []
}
500Internal Server Error
statusCode string
This is the MADAPI Canonical Response Code (it is 4 characters long and it is not the HTTP Status Code which is 3 characters long). Back-end system errors are mapped to specific Canonical Response Codes which are returned. More information on these mappings can be found on the MADAPI Confluence Page 'Response Codes'
statusMessage string
More details on the returned status code which can be shown to a client
supportMessage string
Internal message meant for consumers of the API to troubleshoot the error (could possible include the back-end system error code in the message if it would be useful)
transactionId string
MADAPI generated Id to include for tracing requests
timestamp string
Timestamp that the error occurred
path string
The path that caused the error
method string
The HTTP method type that was used
{
    "statusCode": [],
    "statusMessage": [],
    "supportMessage": [],
    "transactionId": [],
    "timestamp": [],
    "path": [],
    "method": []
}
501Not Implemented
statusCode string
This is the MADAPI Canonical Response Code (it is 4 characters long and it is not the HTTP Status Code which is 3 characters long). Back-end system errors are mapped to specific Canonical Response Codes which are returned. More information on these mappings can be found on the MADAPI Confluence Page 'Response Codes'
statusMessage string
More details on the returned status code which can be shown to a client
supportMessage string
Internal message meant for consumers of the API to troubleshoot the error (could possible include the back-end system error code in the message if it would be useful)
transactionId string
MADAPI generated Id to include for tracing requests
timestamp string
Timestamp that the error occurred
path string
The path that caused the error
method string
The HTTP method type that was used
{
    "statusCode": [],
    "statusMessage": [],
    "supportMessage": [],
    "transactionId": [],
    "timestamp": [],
    "path": [],
    "method": []
}
503Service Unavailable
statusCode string
This is the MADAPI Canonical Response Code (it is 4 characters long and it is not the HTTP Status Code which is 3 characters long). Back-end system errors are mapped to specific Canonical Response Codes which are returned. More information on these mappings can be found on the MADAPI Confluence Page 'Response Codes'
statusMessage string
More details on the returned status code which can be shown to a client
supportMessage string
Internal message meant for consumers of the API to troubleshoot the error (could possible include the back-end system error code in the message if it would be useful)
transactionId string
MADAPI generated Id to include for tracing requests
timestamp string
Timestamp that the error occurred
path string
The path that caused the error
method string
The HTTP method type that was used
{
    "statusCode": [],
    "statusMessage": [],
    "supportMessage": [],
    "transactionId": [],
    "timestamp": [],
    "path": [],
    "method": []
}
DELETE v1/messages/ussd/subscription/{subscriptionId}

Description

This function enables 3PP to unsubscribe from receiving MO-generated messages from MADAPI.

Header parameters

Content-Type application/json

Auth parameters

apikey x-api-key
200OK
statusCode string
statusMessage string
transactionId string
data
subscriptionId string
The value is a random number defined by MADAPI and must be unique. Associated with the registered USSD.
_link
self
href string
{
    "statusCode": [],
    "statusMessage": [],
    "transactionId": [],
    "data": [],
    "_link": []
}
400Bad Request
statusCode string
This is the MADAPI Canonical Response Code (it is 4 characters long and it is not the HTTP Status Code which is 3 characters long). Back-end system errors are mapped to specific Canonical Response Codes which are returned. More information on these mappings can be found on the MADAPI Confluence Page 'Response Codes'
statusMessage string
More details on the returned status code which can be shown to a client
supportMessage string
Internal message meant for consumers of the API to troubleshoot the error (could possible include the back-end system error code in the message if it would be useful)
transactionId string
MADAPI generated Id to include for tracing requests
timestamp string
Timestamp that the error occurred
path string
The path that caused the error
method string
The HTTP method type that was used
{
    "statusCode": [],
    "statusMessage": [],
    "supportMessage": [],
    "transactionId": [],
    "timestamp": [],
    "path": [],
    "method": []
}
401Unauthorized
statusCode string
This is the MADAPI Canonical Response Code (it is 4 characters long and it is not the HTTP Status Code which is 3 characters long). Back-end system errors are mapped to specific Canonical Response Codes which are returned. More information on these mappings can be found on the MADAPI Confluence Page 'Response Codes'
statusMessage string
More details on the returned status code which can be shown to a client
supportMessage string
Internal message meant for consumers of the API to troubleshoot the error (could possible include the back-end system error code in the message if it would be useful)
transactionId string
MADAPI generated Id to include for tracing requests
timestamp string
Timestamp that the error occurred
path string
The path that caused the error
method string
The HTTP method type that was used
{
    "statusCode": [],
    "statusMessage": [],
    "supportMessage": [],
    "transactionId": [],
    "timestamp": [],
    "path": [],
    "method": []
}
403Forbidden
statusCode string
This is the MADAPI Canonical Response Code (it is 4 characters long and it is not the HTTP Status Code which is 3 characters long). Back-end system errors are mapped to specific Canonical Response Codes which are returned. More information on these mappings can be found on the MADAPI Confluence Page 'Response Codes'
statusMessage string
More details on the returned status code which can be shown to a client
supportMessage string
Internal message meant for consumers of the API to troubleshoot the error (could possible include the back-end system error code in the message if it would be useful)
transactionId string
MADAPI generated Id to include for tracing requests
timestamp string
Timestamp that the error occurred
path string
The path that caused the error
method string
The HTTP method type that was used
{
    "statusCode": [],
    "statusMessage": [],
    "supportMessage": [],
    "transactionId": [],
    "timestamp": [],
    "path": [],
    "method": []
}
404Not Found
statusCode string
This is the MADAPI Canonical Response Code (it is 4 characters long and it is not the HTTP Status Code which is 3 characters long). Back-end system errors are mapped to specific Canonical Response Codes which are returned. More information on these mappings can be found on the MADAPI Confluence Page 'Response Codes'
statusMessage string
More details on the returned status code which can be shown to a client
supportMessage string
Internal message meant for consumers of the API to troubleshoot the error (could possible include the back-end system error code in the message if it would be useful)
transactionId string
MADAPI generated Id to include for tracing requests
timestamp string
Timestamp that the error occurred
path string
The path that caused the error
method string
The HTTP method type that was used
{
    "statusCode": [],
    "statusMessage": [],
    "supportMessage": [],
    "transactionId": [],
    "timestamp": [],
    "path": [],
    "method": []
}
415Unsupported Media Type
statusCode string
This is the MADAPI Canonical Response Code (it is 4 characters long and it is not the HTTP Status Code which is 3 characters long). Back-end system errors are mapped to specific Canonical Response Codes which are returned. More information on these mappings can be found on the MADAPI Confluence Page 'Response Codes'
statusMessage string
More details on the returned status code which can be shown to a client
supportMessage string
Internal message meant for consumers of the API to troubleshoot the error (could possible include the back-end system error code in the message if it would be useful)
transactionId string
MADAPI generated Id to include for tracing requests
timestamp string
Timestamp that the error occurred
path string
The path that caused the error
method string
The HTTP method type that was used
{
    "statusCode": [],
    "statusMessage": [],
    "supportMessage": [],
    "transactionId": [],
    "timestamp": [],
    "path": [],
    "method": []
}
500Internal Server Error
statusCode string
This is the MADAPI Canonical Response Code (it is 4 characters long and it is not the HTTP Status Code which is 3 characters long). Back-end system errors are mapped to specific Canonical Response Codes which are returned. More information on these mappings can be found on the MADAPI Confluence Page 'Response Codes'
statusMessage string
More details on the returned status code which can be shown to a client
supportMessage string
Internal message meant for consumers of the API to troubleshoot the error (could possible include the back-end system error code in the message if it would be useful)
transactionId string
MADAPI generated Id to include for tracing requests
timestamp string
Timestamp that the error occurred
path string
The path that caused the error
method string
The HTTP method type that was used
{
    "statusCode": [],
    "statusMessage": [],
    "supportMessage": [],
    "transactionId": [],
    "timestamp": [],
    "path": [],
    "method": []
}
501Not Implemented
statusCode string
This is the MADAPI Canonical Response Code (it is 4 characters long and it is not the HTTP Status Code which is 3 characters long). Back-end system errors are mapped to specific Canonical Response Codes which are returned. More information on these mappings can be found on the MADAPI Confluence Page 'Response Codes'
statusMessage string
More details on the returned status code which can be shown to a client
supportMessage string
Internal message meant for consumers of the API to troubleshoot the error (could possible include the back-end system error code in the message if it would be useful)
transactionId string
MADAPI generated Id to include for tracing requests
timestamp string
Timestamp that the error occurred
path string
The path that caused the error
method string
The HTTP method type that was used
{
    "statusCode": [],
    "statusMessage": [],
    "supportMessage": [],
    "transactionId": [],
    "timestamp": [],
    "path": [],
    "method": []
}
503Service Unavailable
statusCode string
This is the MADAPI Canonical Response Code (it is 4 characters long and it is not the HTTP Status Code which is 3 characters long). Back-end system errors are mapped to specific Canonical Response Codes which are returned. More information on these mappings can be found on the MADAPI Confluence Page 'Response Codes'
statusMessage string
More details on the returned status code which can be shown to a client
supportMessage string
Internal message meant for consumers of the API to troubleshoot the error (could possible include the back-end system error code in the message if it would be useful)
transactionId string
MADAPI generated Id to include for tracing requests
timestamp string
Timestamp that the error occurred
path string
The path that caused the error
method string
The HTTP method type that was used
{
    "statusCode": [],
    "statusMessage": [],
    "supportMessage": [],
    "transactionId": [],
    "timestamp": [],
    "path": [],
    "method": []
}
POST v1/messages/ussd/outbound

Description

This function is used to send/push USSD MT Message to USSDGW for 3PPs with subscription on MADAPI.

Header parameters

Content-Type application/json

Auth parameters

apikey x-api-key

FormData parameters

sessionId string required
Unique identifier of the session.
messageType string required
Message type. 0-Begin|1-Continue|2-End|3-Notification|4-Cancel|5-Timeout.
msisdn string required
Mobile number of the message recipient.
serviceCode string required
ussdString string required
USSD message content. If messageType is of type 4-Abort, this attribute will contain the abort reason or message.
201Created
statusCode string
statusMessage string
transactionId string
data
outboundResponse string
Value 0 indicates success.
sessionId string
Unique identifier of the session.
msisdn string
Mobile user msisdn.
_link
self
href string
{
    "statusCode": [],
    "statusMessage": [],
    "transactionId": [],
    "data": [],
    "_link": []
}
400Bad Request
statusCode string
This is the MADAPI Canonical Response Code (it is 4 characters long and it is not the HTTP Status Code which is 3 characters long). Back-end system errors are mapped to specific Canonical Response Codes which are returned. More information on these mappings can be found on the MADAPI Confluence Page 'Response Codes'
statusMessage string
More details on the returned status code which can be shown to a client
supportMessage string
Internal message meant for consumers of the API to troubleshoot the error (could possible include the back-end system error code in the message if it would be useful)
transactionId string
MADAPI generated Id to include for tracing requests
timestamp string
Timestamp that the error occurred
path string
The path that caused the error
method string
The HTTP method type that was used
{
    "statusCode": [],
    "statusMessage": [],
    "supportMessage": [],
    "transactionId": [],
    "timestamp": [],
    "path": [],
    "method": []
}
401Unauthorized
statusCode string
This is the MADAPI Canonical Response Code (it is 4 characters long and it is not the HTTP Status Code which is 3 characters long). Back-end system errors are mapped to specific Canonical Response Codes which are returned. More information on these mappings can be found on the MADAPI Confluence Page 'Response Codes'
statusMessage string
More details on the returned status code which can be shown to a client
supportMessage string
Internal message meant for consumers of the API to troubleshoot the error (could possible include the back-end system error code in the message if it would be useful)
transactionId string
MADAPI generated Id to include for tracing requests
timestamp string
Timestamp that the error occurred
path string
The path that caused the error
method string
The HTTP method type that was used
{
    "statusCode": [],
    "statusMessage": [],
    "supportMessage": [],
    "transactionId": [],
    "timestamp": [],
    "path": [],
    "method": []
}
403Forbidden
statusCode string
This is the MADAPI Canonical Response Code (it is 4 characters long and it is not the HTTP Status Code which is 3 characters long). Back-end system errors are mapped to specific Canonical Response Codes which are returned. More information on these mappings can be found on the MADAPI Confluence Page 'Response Codes'
statusMessage string
More details on the returned status code which can be shown to a client
supportMessage string
Internal message meant for consumers of the API to troubleshoot the error (could possible include the back-end system error code in the message if it would be useful)
transactionId string
MADAPI generated Id to include for tracing requests
timestamp string
Timestamp that the error occurred
path string
The path that caused the error
method string
The HTTP method type that was used
{
    "statusCode": [],
    "statusMessage": [],
    "supportMessage": [],
    "transactionId": [],
    "timestamp": [],
    "path": [],
    "method": []
}
404Not Found
statusCode string
This is the MADAPI Canonical Response Code (it is 4 characters long and it is not the HTTP Status Code which is 3 characters long). Back-end system errors are mapped to specific Canonical Response Codes which are returned. More information on these mappings can be found on the MADAPI Confluence Page 'Response Codes'
statusMessage string
More details on the returned status code which can be shown to a client
supportMessage string
Internal message meant for consumers of the API to troubleshoot the error (could possible include the back-end system error code in the message if it would be useful)
transactionId string
MADAPI generated Id to include for tracing requests
timestamp string
Timestamp that the error occurred
path string
The path that caused the error
method string
The HTTP method type that was used
{
    "statusCode": [],
    "statusMessage": [],
    "supportMessage": [],
    "transactionId": [],
    "timestamp": [],
    "path": [],
    "method": []
}
415Unsupported Media Type
statusCode string
This is the MADAPI Canonical Response Code (it is 4 characters long and it is not the HTTP Status Code which is 3 characters long). Back-end system errors are mapped to specific Canonical Response Codes which are returned. More information on these mappings can be found on the MADAPI Confluence Page 'Response Codes'
statusMessage string
More details on the returned status code which can be shown to a client
supportMessage string
Internal message meant for consumers of the API to troubleshoot the error (could possible include the back-end system error code in the message if it would be useful)
transactionId string
MADAPI generated Id to include for tracing requests
timestamp string
Timestamp that the error occurred
path string
The path that caused the error
method string
The HTTP method type that was used
{
    "statusCode": [],
    "statusMessage": [],
    "supportMessage": [],
    "transactionId": [],
    "timestamp": [],
    "path": [],
    "method": []
}
500Internal Server Error
statusCode string
This is the MADAPI Canonical Response Code (it is 4 characters long and it is not the HTTP Status Code which is 3 characters long). Back-end system errors are mapped to specific Canonical Response Codes which are returned. More information on these mappings can be found on the MADAPI Confluence Page 'Response Codes'
statusMessage string
More details on the returned status code which can be shown to a client
supportMessage string
Internal message meant for consumers of the API to troubleshoot the error (could possible include the back-end system error code in the message if it would be useful)
transactionId string
MADAPI generated Id to include for tracing requests
timestamp string
Timestamp that the error occurred
path string
The path that caused the error
method string
The HTTP method type that was used
{
    "statusCode": [],
    "statusMessage": [],
    "supportMessage": [],
    "transactionId": [],
    "timestamp": [],
    "path": [],
    "method": []
}
501Not Implemented
statusCode string
This is the MADAPI Canonical Response Code (it is 4 characters long and it is not the HTTP Status Code which is 3 characters long). Back-end system errors are mapped to specific Canonical Response Codes which are returned. More information on these mappings can be found on the MADAPI Confluence Page 'Response Codes'
statusMessage string
More details on the returned status code which can be shown to a client
supportMessage string
Internal message meant for consumers of the API to troubleshoot the error (could possible include the back-end system error code in the message if it would be useful)
transactionId string
MADAPI generated Id to include for tracing requests
timestamp string
Timestamp that the error occurred
path string
The path that caused the error
method string
The HTTP method type that was used
{
    "statusCode": [],
    "statusMessage": [],
    "supportMessage": [],
    "transactionId": [],
    "timestamp": [],
    "path": [],
    "method": []
}
503Service Unavailable
statusCode string
This is the MADAPI Canonical Response Code (it is 4 characters long and it is not the HTTP Status Code which is 3 characters long). Back-end system errors are mapped to specific Canonical Response Codes which are returned. More information on these mappings can be found on the MADAPI Confluence Page 'Response Codes'
statusMessage string
More details on the returned status code which can be shown to a client
supportMessage string
Internal message meant for consumers of the API to troubleshoot the error (could possible include the back-end system error code in the message if it would be useful)
transactionId string
MADAPI generated Id to include for tracing requests
timestamp string
Timestamp that the error occurred
path string
The path that caused the error
method string
The HTTP method type that was used
{
    "statusCode": [],
    "statusMessage": [],
    "supportMessage": [],
    "transactionId": [],
    "timestamp": [],
    "path": [],
    "method": []
}