AwardStage

API Documentation

Introduction

The AwardStage API is a programmable web interface to gain access through to your Awards. The API is a REST api that currently only supports GET opperations to fetch data from our system.

As with any REST api, the endpoints are predictable resource-orientated URLs, that follow a standardised format. A full URL can be obtained by appending the resource uri to the api endpoint

API endpoint

/api.awardstage.com

Resource endpoint

entry/1

Full url example

URL:
/api.awardstage.com/entry/1
METHOD:
GET

AwardStage API uses conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a authentication failed, etc.), and codes in the 5xx range indicate an error with AwardStage's servers (these are rare).

Authentication

Firstly to gain access to the API, like most API's you need to authenticate. AwardStage's API is currently private, only access can be given to Awards that have request to do so. We will provide a client id and client secret which you will use in the next step.

Getting an access token

URL:
/api.awardstage.com/authorize
METHOD:
POST
REQUEST:
client_id
string
The client_id that is assigned to your awards
client_secret
string
The client_secret that is assigned to your awards

After a access token has been obtained, this should be used whenever accessing a resource. The access token should be sent in the HTTP header like so.

Header

X-ApiToken:
{{ exampleapitokenhere }}

Entrants

List entrants

URL:
/api.awardstage.com/entrants
METHOD:
GET
REQUEST:
limit
integer
Limit of the items returned, ( accepted values are between 1 & 200 ) default is set to 20
offset
integer
Offset of the collection of items to paginate
created_at_from
datetime
Date created from eg 2018-06-15 08:10:40
created_at_to
datetime
Date created to eg 2018-06-15 08:10:40
updated_at_from
datetime
Date updated from eg 2018-06-15 08:10:40
updated_at_to
datetime
Date updated to eg 2018-06-15 08:10:40

Count entrants

URL:
/api.awardstage.com/entrants/count
METHOD:
GET
REQUEST:
created_at_from
datetime
Date created from eg 2018-06-15 08:10:40
created_at_to
datetime
Date created to eg 2018-06-15 08:10:40
updated_at_from
datetime
Date updated from eg 2018-06-15 08:10:40
updated_at_to
datetime
Date updated to eg 2018-06-15 08:10:40

Get entrant

URL:
/api.awardstage.com/entrant/:id
METHOD:
GET

Judges

List judges

URL:
/api.awardstage.com/judges
METHOD:
GET
REQUEST:
limit
integer
Limit of the items returned, ( accepted values are between 1 & 200 ) default is set to 20
offset
integer
Offset of the collection of items to paginate
created_at_from
datetime
Date created from eg 2018-06-15 08:10:40
created_at_to
datetime
Date created to eg 2018-06-15 08:10:40
updated_at_from
datetime
Date updated from eg 2018-06-15 08:10:40
updated_at_to
datetime
Date updated to eg 2018-06-15 08:10:40

Count judges

URL:
/api.awardstage.com/judges/count
METHOD:
GET
REQUEST:
created_at_from
datetime
Date created from eg 2018-06-15 08:10:40
created_at_to
datetime
Date created to eg 2018-06-15 08:10:40
updated_at_from
datetime
Date updated from eg 2018-06-15 08:10:40
updated_at_to
datetime
Date updated to eg 2018-06-15 08:10:40

Get judge

URL:
/api.awardstage.com/judge/:id
METHOD:
GET

Categories

List categories

URL:
/api.awardstage.com/categories
METHOD:
GET
REQUEST:
limit
integer
Limit of the items returned, ( accepted values are between 1 & 200 ) default is set to 20
offset
integer
Offset of the collection of items to paginate
created_at_from
datetime
Date created from eg 2018-06-15 08:10:40
created_at_to
datetime
Date created to eg 2018-06-15 08:10:40
updated_at_from
datetime
Date updated from eg 2018-06-15 08:10:40
updated_at_to
datetime
Date updated to eg 2018-06-15 08:10:40

Count categories

URL:
/api.awardstage.com/categories/count
METHOD:
GET
REQUEST:
created_at_from
datetime
Date created from eg 2018-06-15 08:10:40
created_at_to
datetime
Date created to eg 2018-06-15 08:10:40
updated_at_from
datetime
Date updated from eg 2018-06-15 08:10:40
updated_at_to
datetime
Date updated to eg 2018-06-15 08:10:40

Get category

URL:
/api.awardstage.com/category/:id
METHOD:
GET

Entries

List entries

URL:
/api.awardstage.com/entries
METHOD:
GET
REQUEST:
limit
integer
Limit of the items returned, ( accepted values are between 1 & 200 ) default is set to 20
offset
integer
Offset of the collection of items to paginate
created_at_from
datetime
Date created from eg 2018-06-15 08:10:40
created_at_to
datetime
Date created to eg 2018-06-15 08:10:40
updated_at_from
datetime
Date updated from eg 2018-06-15 08:10:40
updated_at_to
datetime
Date updated to eg 2018-06-15 08:10:40

Count entries

URL:
/api.awardstage.com/entries/count
METHOD:
GET
REQUEST:
created_at_from
datetime
Date created from eg 2018-06-15 08:10:40
created_at_to
datetime
Date created to eg 2018-06-15 08:10:40
updated_at_from
datetime
Date updated from eg 2018-06-15 08:10:40
updated_at_to
datetime
Date updated to eg 2018-06-15 08:10:40

Get entry

URL:
/api.awardstage.com/entry/:id
METHOD:
GET

Judging Rounds

List judging rounds

URL:
/api.awardstage.com/judging-rounds
METHOD:
GET
REQUEST:
limit
integer
Limit of the items returned, ( accepted values are between 1 & 200 ) default is set to 20
offset
integer
Offset of the collection of items to paginate
created_at_from
datetime
Date created from eg 2018-06-15 08:10:40
created_at_to
datetime
Date created to eg 2018-06-15 08:10:40
updated_at_from
datetime
Date updated from eg 2018-06-15 08:10:40
updated_at_to
datetime
Date updated to eg 2018-06-15 08:10:40

Count judging rounds

URL:
/api.awardstage.com/judging-rounds/count
METHOD:
GET
REQUEST:
created_at_from
datetime
Date created from eg 2018-06-15 08:10:40
created_at_to
datetime
Date created to eg 2018-06-15 08:10:40
updated_at_from
datetime
Date updated from eg 2018-06-15 08:10:40
updated_at_to
datetime
Date updated to eg 2018-06-15 08:10:40

Get judging round

URL:
/api.awardstage.com/judging-round/:id
METHOD:
GET

Forms

List forms

URL:
/api.awardstage.com/forms
METHOD:
GET
REQUEST:
limit
integer
Limit of the items returned, ( accepted values are between 1 & 200 ) default is set to 20
offset
integer
Offset of the collection of items to paginate
created_at_from
datetime
Date created from eg 2018-06-15 08:10:40
created_at_to
datetime
Date created to eg 2018-06-15 08:10:40
updated_at_from
datetime
Date updated from eg 2018-06-15 08:10:40
updated_at_to
datetime
Date updated to eg 2018-06-15 08:10:40
form_type
string
Name of the form type default to "Entry"
Possible types: Entry, Entrant, Public Entry

Count forms

URL:
/api.awardstage.com/forms/count
METHOD:
GET
REQUEST:
created_at_from
datetime
Date created from eg 2018-06-15 08:10:40
created_at_to
datetime
Date created to eg 2018-06-15 08:10:40
updated_at_from
datetime
Date updated from eg 2018-06-15 08:10:40
updated_at_to
datetime
Date updated to eg 2018-06-15 08:10:40
form_type
string
Name of the form type default to "Entry"
Possible types: Entry, Entrant, Public Entry

Get form

URL:
/api.awardstage.com/form/:id
METHOD:
GET

Events

List events

URL:
/api.awardstage.com/events
METHOD:
GET
REQUEST:
limit
integer
Limit of the items returned, ( accepted values are between 1 & 200 ) default is set to 20
offset
integer
Offset of the collection of items to paginate
created_at_from
datetime
Date created from eg 2018-06-15 08:10:40
created_at_to
datetime
Date created to eg 2018-06-15 08:10:40
updated_at_from
datetime
Date updated from eg 2018-06-15 08:10:40
updated_at_to
datetime
Date updated to eg 2018-06-15 08:10:40

Count events

URL:
/api.awardstage.com/events/count
METHOD:
GET
REQUEST:
created_at_from
datetime
Date created from eg 2018-06-15 08:10:40
created_at_to
datetime
Date created to eg 2018-06-15 08:10:40
updated_at_from
datetime
Date updated from eg 2018-06-15 08:10:40
updated_at_to
datetime
Date updated to eg 2018-06-15 08:10:40

Get event

URL:
/api.awardstage.com/event/:id
METHOD:
GET

Event Registrations

List event registrations

URL:
/api.awardstage.com/event-registrations
METHOD:
GET
REQUEST:
event_id
integer
The event id
limit
integer
Limit of the items returned, ( accepted values are between 1 & 200 ) default is set to 20
offset
integer
Offset of the collection of items to paginate
created_at_from
datetime
Date created from eg 2018-06-15 08:10:40
created_at_to
datetime
Date created to eg 2018-06-15 08:10:40
updated_at_from
datetime
Date updated from eg 2018-06-15 08:10:40
updated_at_to
datetime
Date updated to eg 2018-06-15 08:10:40

Count event registrations

URL:
/api.awardstage.com/event-registrations/count
METHOD:
GET
REQUEST:
event_id
integer
The event id
created_at_from
datetime
Date created from eg 2018-06-15 08:10:40
created_at_to
datetime
Date created to eg 2018-06-15 08:10:40
updated_at_from
datetime
Date updated from eg 2018-06-15 08:10:40
updated_at_to
datetime
Date updated to eg 2018-06-15 08:10:40

Get event registration

URL:
/api.awardstage.com/event-registration/:id
METHOD:
GET