API HTTP SOAP Response Status Codes

The APIs follow SOAP design principles and return an HTTP response status code. The following series of status codes can be categorized:

• 2xx: Success – This status code class indicates that the client's request was successfully received, understood, and accepted.

• 4xx: Client Error – This status code class indicates that the client seems to have erred. The EVV Providers must take an action to resolve the returned error.

• 5xx: Server Error – This status code class indicates that the server is responsible for the status code errors. HHAeXchange must take an action to resolve the error.

The following are the HTTP Response Status Codes returned by the APIs and their meaning.

HTTP Status Code	Result	Status	Description
200	Success	OK	Standard response for successful requests.
201		Created	The request has been fulfilled and resulted in a new resource being created.
202		Accepted	The request has been accepted for processing, but the processing has not been completed. The request might or might not eventually be acted upon, as it might be disallowed when processing takes place.
204		No Content	The request has been fulfilled and result has returned nothing based on input values
400		Error Message	Agency-specific error alerts received, along with the corresponding error message.
401		Unauthorized	The request requires user authentication information. The response must include a WWW-Authenticate header field containing a challenge applicable to the requested resource.
403		Forbidden	The client does not have access rights to the content. Unlike 401, the client’s identity is known to the server. Contact HHAeXchange at 3rd Party Integration Support Desk to gain permission to access the API.
404		Not Found	The requested resource could not be found but may be available again in the future. Subsequent requests by the client are permissible.
429		Too Many Requests	The user has sent too many requests in a given amount of time. Intended for use with rate limiting schemes.
500		Failure Message	Failure message received, along with the detailed failure description.