Click or drag to resize
Status codes and responses
Print this page

This topic contains the following sections:

HTTP Status Codes

For all template web service calls, errors are returned through the response and HTTP status codes.

  • 200 - OK: Indicates that the request was completed successfully. However, there could be errors in the response body depending on the action performed. See the JSON response body section below for more information.
  • 202 - Accepted: Indicates the template is running and you must check the status by another request to the supplied URL.
  • 303 - See Other: The response to the request can be found under a different URI and should be retrieved using a GET method on that resource.
  • 400 - Bad Request: Indicates that there was an issue with the request.
  • 401 - Unauthorized/Bad Authorization: Indicates that the server cannot use the provided login; the user authentication is incorrect or expired.
  • 403 - Forbidden: Indicates that the server has refused to fulfill a request.
  • 404 - Not Found: Indicates that the item requested could not be found.
  • 429 - Too many requests: Indicates that too many requests have been received from this IP address in a given amount of time.
  • 500 - Internal server error: Indicates that a generic error has occurred on the server.
  • 503 - Service Unavailable: The server is temporarily unavailable, because it is overloaded or down for maintenance. Retry your request.
  • 504 - Gateway Timeout: The server did not respond in time. This may be a temporary state. If you receive this error repeatedly, contact your support representative.

JSON response body

For web service calls that execute a template, a status code of 200 indicates that the template completed successfully, however, individual entries might have failed. In that case, the JSON response body includes information about the number of failed, created, updated, and deleted changes and information about the failures.

  • Created: Number of records created.
  • Deleted: Number of records deleted.
  • Failed: Number of records that failed.
  • Updated: Number of updated records.
  • Failed Records: Array of JSON objects detailing errors associated with the request. Errors of this kind can occur if the row being processed fails validation or if there is a problem committing the change to the table.
  • Parse Failed Records: Array of JSON objects detailing parsing errors. Errors of this kind occur when there is a problem parsing the input data provided for Create, Update, or Delete templates.

For example:

JSON
{
    "Created": 2,
    "Deleted": 0,
    "Failed": 2,
    "Updated": 0,
    "Failed Records": [
        {
            "errorInfo": [
                {
                    "errorText": "131 invalid for Lat. Value must be between -90 - 90 degrees",
                    "errorCode": "3.4.2",
                    "errorParameters": {
                        "parameter": "Lat",
                        "value": "131"
                    }
                }
            ],
        "Error Messages:": "131 invalid for Lat. Value must be between -90 - 90 degrees",
        "InputRow": 3
        }
    ],
    "Parse Failed Records": [
        {
            "InputRow": 1,
            "Row": "668733,Marker 5,3394,Esperanza Xing,Austin,Texas,78758,bob,-97.7267097071832,,\"3394 Esperanza Xing, Austin, Travis, Texas, 78758\",False,,,,,\"Mon, Wed, Fri\",hello my name is,,front porch,,1,2,,1",
            "Reason": "Cannot convert Text to Angle.",
            "errorInfo": [
                {
                    "errorText": "Cannot convert Text to Angle.",
                    "errorCode": "3.2.1"
                }
            ]
        }
    ]

When you are trying to execute a template and get back an error return status code (400s or 500s), then the response contains a JSON object describing the errors that have occurred. For example:

JSON
{  
   "errorInfo":[  
      {  
         "errorCode":"5",
         "errorText":"Internal server error.",
         "errorParameters":[  
            {  
               "parameter":"ExecutionId",
               "value":"123a8eec-321f-1ae2-3214-00a123abc0aa"
            }
         ]
      }
   ],
   "errorText":"Internal server error."
}

See Also