Responses; Success; Success Response Format; Error - Multitech MultiConnect rCell MTR-H5 Developer's Manual

3

Responses

All API requests return a JSON object. The JSON response will always contain the members code and status.
The status member indicates a high-level result of the request and has two possible values: success and fail. The
code member is a HTTP response code describing the outcome of the API result. Certain actions or events in
the API may result in a URL redirect, such as trying to access API methods when a user is not logged in. In these
situations, the JSON response may contain the member referrer.
3.1

Success

In the event of a successful request a success message will be returned with the member status set to success
and code set to 200. If data is sent in the response it will be found in the result field.
3.1.1

Success response format

1 Status : HTTP /1.1 200 OK
2
3 " code " : 200 ,
4 " status " : " success "
5 " result " : [ JSON Object or Array
6
3.2

Error

An error response will always contain the members: code, status, and error. If an error is encountered during a
request, the API will halt processing and return an error message. This means that a request with multiple errors
will receive a response containing error information on only the first error that the API finds during the processing
of that request.
3.2.1

Error response format

1 Status : HTTP /1.1 [
2
3 " code " : [ Error Code
4 " status " : " fail "
5 " error " : " [ Error Message
6
10
,
]
Error Code ] [ Error Message
] ,
,
] "
]
Multi-Tech Systems, Inc. MultiConnect
3 RESPONSES
R
rCell API Developer Guide