We added a new parameter called ‘http_error_status’ which user can use in the API query parameter to set the behavior of how you want to have the HTTP response code in your client. The possible values are
- ‘Failed’,
- ‘Pending’,
- ‘Partial Completed’.
Users can set for example all 3 or only 1 or two. In this example &http_error_status =Failed, Pending, Partial Completed it means that want to get the HTTP status code 500 internal error when the message status is ‘Failed’, ‘Pending’, or ‘Partial Completed’. When you set like this &http_error_status =Failed, Pending then it means that you want only to get the HTTP status code 500 when the message status is ‘Pending’, or ‘Failed’ but not ‘Partial Completed’. In case the message has the status ‘Partial Completed’ you will get the HTTP 200 OK. The separator to use here is the semicolon.
If you don’t use this query parameter then the behavior is the old one as you know e.g. we return the HTTP 200 OK code even the message has the status ‘Failed’, ‘Pending’, or ‘Partial Completed’.
- – Default return the HTTP 200 OK code when the message has the status ‘Failed’, ‘Pending’, or ‘Partial Completed’. and Param is *http_error_status = Blank
- Return the HTTP 500 error code when the message has the status ‘Failed’, ‘Pending’, or ‘Partial Completed’. and Param is http_error_status = Failed, Pending,Partial Completed