Request/Response

Top-level overview of Request and Response objects/codes used within DTO API

Request Types

essCert API HTTPS request support is limited to a subset of RFC 2616 for both UAT and Production APIs.

❗️

Header First

Never access the response body without confirming over the HTTP Response Code within the Header first.

Request Type	Supported	Description
GET	Yes	Most common and widely used methods within API's. essCert methods using GET retrieves relevant details within the system.
POST	Yes	Commonly used to send data to the API. essCert primary method to submit CO Application to chamber Submit CO Application is a POST.

Response Codes

essCert uses conventional HTTP response codes to indicate the success or failure of an API request. In general:

• Codes in the 200 OK range indicate success.
• Codes in the 400 Bad Request,401 Unauthorized, 403 Forbidden indicate an error that failed given the information provided.
• Codes in the 500 Internal Server Error range indicate an error within essCert servers however these are rare.

❗️

Graceful Error Handling

Our libraries raise exceptions for many reasons, such as parameters issues, authentication errors, and network unavailability. We recommend writing code that gracefully handles all possible API exceptions.

🚧

Additional HTTP Response Codes

Other standard HTTP errors may be generated by our stack and not directly from our API. Here are the categories of possible Standard HTTP response codes.

1xx: Communication transfer protocol-level information.
Informational

2xx: This indicates that the client's request was accepted successfully.
Success

3xx: Indicates that the client must take some additional action to complete their request.
Redirection

4xx: This category of error status codes points to the clients.
Client Error

5xx: This category of error is related to server exceptions due to internal incapability to perform the request. The user is advised to contact essCert Support.
Server Code

For more information please refer https://developer.mozilla.org/en-US/docs/Web/HTTP/Status

Error Response Body

Any response code within the 4xx or 5xx range will have a static response object alongside a relevant error message to aid the developer.

JSON

{
  "errorMessage": "Invalid Parameter"
}