Document toolboxDocument toolbox

_REST Response Codes

HTTP Response

Response Codes

HTTP CodeDescription

200

OK. Request was processed successfully.

(info) Even though the request may return a successful code of 200, the body may still contain warning details.

400

Syntax error in request. The response body will provide more details on the specific reason. Verify the URI, its parameters, and request body.

401

Unauthorized. The credentials are incorrect, please verify and try again.

404

Not Found. The URL is incorrect, please verify and try again.

405

The specified HTTP method is not supported for this resource.

409

Conflict. This error usually occurs when attempting to overwrite an existing object that can not be replaced.

410

The specified object does not exists. Please verify the URI.

500

An error has occurred within ServiceMobility. Please review the error message details and if necessary, contact customer support.

Response Body

{
    "code": 400,
    "detail": {
        "message": "",
        "params": {
            "value": ""
        },
        "dataPath": ""
    }
}

Response Object Properties

PropertyTypeDescription
codeintegerThe HTTP response code.
detailobject

This object provides additional details the system provided while processing the transactions. Usually the details provide additional information on why an error occurred. However, it may also provide warning details even when the requests was successful. For example, the request may have returned a response of 200=OK, but included warnings in the response body of properties that are still being used that are marked for deprecation.

PropertyTypeDescription
messagestringA human readable message related to the processing of the request.
paramscollectionA collection of additional key/value pairs that contain the values that caused the warning/error condition.
dataPathstringIdentifies the location within the request body the message refers to.