Reference Guide

Zend Server Reference Manual
Response Format
About
API HTTP response messages use standard HTTP response codes to designate high-level status
(success, failure, etc.) and simple XML payload in the response body to provide additional method
specific data or specific error messages.
HTTP Response Codes
Zend Server Web API operations will return standard HTTP response codes in order to indicate overall
success or failure. In case of an error, the HTTP status code may further indicate the nature of the
problem, and a specific error code contained in the response body will indicate the specific nature of the
error.
The following HTTP response codes may be used:
332
200 OK - The operation has completed successfully.
202 Accepted - The operation was accepted and is being processed, but is not complete yet.
4xx - HTTP status codes between 400 and 499 are used to designate a client-side error. For
example, a missing request parameter or an authentication error.
5xx - HTTP status codes between 500 and 599 are used to designate a server-side error. For
example, a temporary locking issue or an unexpected error in the server operation.
Additional information about HTTP response codes for error responses is available in Error Responses,
as well as in the documentation for each method.
HTTP Response Headers
The following HTTP response headers will be included in API responses:
Content-type - Unless stated otherwise, these will be “application/vnd.zend.serverapi+xml;
version=”. For more information about API versions see API Versioning
Negotiation.