Error Codes

Standard HTTP error codes will be used to communicate success or failure. Along with this, we will return a response in the format requested detailing more information on the cause of the error.

Common HTTP Responses

  • 200 OK Success : The resource has been accessed successfully. A response will be returned.
  • 401 Not Authorised Failure : User does not have sufficient authority to access the resource.
  • 500 Internal Server Error Failure : A server error has occurred. Please try again.

Response

<?xml version="1.0" encoding="UTF-8"?>
  <vzaar-api>
  <error>
  <type>string</type>
  <description>string</description>
  </error>
  </vzaar-api>

Description

  • type - This is the type of error that occurred. It will represent the HTTP error code.
  • description - Where appropriate this will be a longer description of the error.

Example

Call: http://vzaar.com/api/test/whoami

Response

<?xml version="1.0" encoding="UTF-8"?>
  <vzaar-api>
  <error>
  <type>Not Authorized</type>
  </error>
  </vzaar-api>

contact us   by phone, mail or twitter...
libraries
ruby java php .net node
affiliates
affiliate program


Powered by Olark