Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Creates and returns an error response.

Syntax

Code Block
Response = HTTP_Services('GetErrorResponse')

Returns

A JSON formatted object that contains the URL, HTTP method, HTTP status code, phrase, and any system errors (if any).

Parameters

N/A

Remarks

This is intended to be used when there is no response body to return to the client. This response will contain the current response status and any error information stored using Error_Services. Here is an example of what this can look like:

{
   "URL" : "http://api.contacts.com/v1/",
   "method" : "GET",
   "phrase" : "Unauthorized (RFC 7235)",
   "status" : 401
}