Jump to: navigation, search

HTTP Response Codes and Errors

The Genesys Web Engagement Server returns HTTP status codes and messages for every operation, in the requested format. Status codes match standard HTTP codes, but messages can differ and provide additional details included in the header of the response.

Important
Additional results and error codes may be returned due to external web servers and layers involved in your operations.

Successful Result

A successful response to a request is marked by HTTP Status Code 200 (OK). In that case, your application may get additional information in the header and the body of the response. Refer to the Response section of your operation's page to get the detailed list of returned information. The following table lists the standard HTTP codes used by Genesys Web Engagement Server for a successful response.

Code Title Description
200 OK Success!
204 No Content For "filtered collection read" requests only. The request was correct and successful but the server has no appropriate entities to return.

Errors

For responses with HTTP status code 4xx or 5xx, the response body contains an application-specific description of the error instead of a representation of the requested resource. The following table lists the specific errors that operations can encounter. This list is not restrictive; additional error codes could be returned due to external web servers and layers involved:

Code Title Description
400 Bad Request General error which could be caused by:
  • Missing required parameter.
  • Parameter value of unexpected type.
401 Not Authorized Credentials are missing or incorrect, or the given user is not allowed to execute a given service (such as an administrative service method that changes the profile schema). See Basic Access Authentication.
403 Forbidden The operation is forbidden and the reason is specified in the error message.
404 Not Found For "identified entity read" request only. The specified URI is invalid, or the requested resource (such as identity, visit, event, and so on) does not exist.
500 Internal Server Error An unexpected error occurred in the Web Engagement Server (for instance, a runtime exception). The error message suggests you forward logs to Genesys Customer Care.
502 Bad Gateway Returned when one or more of the systems required to fulfill the response (the Cassandra database or the Genesys environment, for example) are either unavailable or returned an error.
503 Service Unavailable Web Engagement Server is unable to process the given request. Example situations include:
  • Too many requests.

Feedback

Comment on this article:

blog comments powered by Disqus
This page was last modified on 1 May 2017, at 16:18.