Voxe API

Our Restful API are only returning JSON results, and are read-only for public users. All parameters and keys are in CamelCase. POST requests are only accessible to admin users.

API v1 is deployed on: 

http://voxe.org/api/v1

Questions?

Send an email to [email protected]

Endpoints

Each endpoints is accessible on the following URL by replacing ENDPOINT_NAME: 

http://voxe.org/api/v1/ENDPOINT_NAME
An example to get an election: 
http://voxe.org/api/v1/elections/4ef479f8bc60fb0004000001

Structure

Envelope

Every response is contained by an envelope. This is how the envelope looks like: 

{
  "meta": {
    "code": 200
  },
  "response": {
    ...
  }
}

Dealing with errors

In case of error is raised, this is how the response will looks like:

{
  "meta": {
    "code": 200,
    "errorType": "param_error",
    "errorDetail": "..."
  },
  "response": {}
}

JSONP

In the case you want to use our response with a JS callback, you can pass your callback name. 

http://voxe.org/api/v1/.../?callback=callbackFunction
Would response with 
callbackFunction({
  ...
});

Models

Access to the description of each model on the left menu.