Begin using APIs

All the APIs available are listed to the left. Click on an API to get more information.

The structure of the url you will need to make the HTTP request should look like this:

Structure: http://<host>/<apiVersion>/<uri> Example:

Service Errors

HTTP Response Codes

A 200 response code will be returned for successful requests. A 400 response code for errors along with a list of the errors. A 500 response code if there was an internal error on our side (no error message will be returned in this case.)

Error Representaton

In the case of a webservice error, a json response will be returned to the caller. The representation can show multiple errors for the same call. Example error representation:


{"errors": [{"message":"You have entered an invalid email address."}]}