The Knox Deployment Program Reseller API uses the conventional HTTP response codes to indicate the success or failure of a request. A 2XX response code indicates success, a 4XX response code indicates a client-side error due to the request inputs, and a 5XX response code indicates a server-side error. It also includes custom error codes that are specific to Knox Deployment Program. In addition, errors will contain a JSON response body with more information about the error:

HTTP/1.1 200 OK

Content-Type: application/json

        {
            "totalCount": 0,
            "pageNum": 0,
            "customers": []
        }

Async result: GET /kcs/v1/rp/devices/status

HTTP/1.1 200: OK

Content-Type: application/json

        {
            "transactionId": "string",
            "state": "Complete",
            "type": "Delete",
            "orderNo": "string",
            "devices": [
                {
                    "imei": "string",
                    "code": 40000004,
                    "message": "DEVICE_INVALID",
                    "data": "The specified device is not valid."
                }
            ],
            "operationType": "DELETE"
        }

HTTP/1.1 400: Bad Request

Content-Type: application/json

        {
            "errorId": "string",
            "code": 40000011,
            "message": "CUSTOMER_ID_INVALID",
            "data": "The specified customer ID is not valid."
        }

HTTP/1.1 401: Unauthorized

Content-Type: application/json

        {
            "code": 4012250,
            "message": "ACCESS_TOKEN_BAD_REQUEST",
            "data": "ACCESS_TOKEN_BAD_REQUEST"
        }

HTTP/1.1 403: Forbidden

Content-Type: application/json

        {
            "errorId": "string",
            "code": 40300000,
            "message": "AUTHORIZATION_FAIL",
            "data": "The current user is unauthorized to use this service."
        }

HTTP/1.1 404: Not Found

Content-Type: application/json

        {
            "errorId": "string",
            "code": 40400001,
            "message": "RESELLER_NOT_FOUND",
            "data": "The specified reseller does not exist."
        }

HHTTP/1.1 500: Internal Server Error

Content-Type: application/json

        {
            "errorId" : "string",
            "code" : 50000000,
            "message":"INTERNAL_SERVER_ERROR",
            "data": "An unknown internal server error has occurred."
        }

Error object

The error objects contain the following attributes:

Standard HTTP error codes

The following table lists the most common HTTP error responses:

Knox Deployment Program error codes

Knox Deployment Program specifies several custom error codes which provide more information than the standard HTTP error response codes. The following table lists the standard Knox Deployment Program error codes and their descriptions:

Troubleshooting

If your request returns a 400 level error

Check the specific error code and refer to the error codes section of this reference. To further debug, check the response payload and the Activity Log on the Reseller Portal.

If your request returns a 500 level error

Please try the request again at a later time.