Nest API Codes
Nest API Codes
Table 1: HTTP status code list
200 |
OK |
201 |
Created |
202 |
Accepted |
302 |
Found |
400 |
Bad request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
405 |
Method not allowed |
406 |
Not acceptable |
413 |
Request entity too large |
415 |
Unsupported Media Type |
422 |
Unprocessable entity |
429 |
Too many requests |
431 |
Request header fields too large |
500 |
Internal server error |
503 |
Service unavailable |
Some of the common scenarios where each status code will be provided are outlined below
200: This status code would be sent back while checking the status of the request made. If the processing is not
complete, an indication would be sent back stating that the request processing is pending for completion.
When the final response is requested by the payroll client and after it is served, this status code would be sent
back.
201: If the processing has been completed for the given request, 201 status code will be returned.
202: When the initial request is made, 202 would be sent back to indicate to the payroll client that response would
not be available immediately, however, the request has been successfully accepted.
302: This would be sent back if the base URL is incorrect.
400: If the XML does not confirm to XSD or if there any security validation failures, then 400 status code will be
returned.
401: This would be sent back when invalid credentials were supplied.
403: This would be sent back if the requested service is valid, but the user does not have permissions to access
the service.
This would be sent back if the employer submits a request with invalid Employer Reference Number.
404: This would be sent back when the requested resource is not present/invalid.
405: This would be sent back if the PSP client tries to perform an unsupported operation.
406: This would be sent back if the data to be returned is not acceptable to the payroll client.
413: This would be sent back if the request is too large. For example if the XML can be only 2 MB of size
maximum, and if the input XML exceeds 2 MB, then this status code would be sent back.
415: This would be sent back if the request comes with an unsupported Media type.
422: This would be sent back if the provided input is unprocessable e.g. malformed xml
429: If NEST is processing an abnormally high number of requests and is unable to process any further at that
time, this status code will be sent back
431: If the headers in the request are too long, then this status code would be sent back.
500: If NEST system is unable to process the request owing to some issue, this would sent back. The exception to
this is that when a request is submitted with special characters in HTTP headers, a 500 error is thrown instead
of a 400. This is due to a technical limitation in the processing systems.
503: If NEST system is unavailable due to maintenance or for any other reason, then this would be sent back
Created with the Personal Edition of HelpNDoc: Full-featured EBook editor