The main endpoint for organizers. GET will return a single organizer and the details of that organizer. POST will add a new organizer with OAuth. PUT will edit the organizer with OAuth.
Resource URI
/Organizers/10/?api_key=xxx
Resource Properties
| Parameter | Format | Description | Allows Null |
|---|
| organizerID |
long |
ID for organizer |
no |
| organizerName |
string |
Name of organizer |
no |
| website |
string |
Website for the organizer |
yes |
| organizerLogoID |
long |
ID for organizer photo (logo) |
yes |
| email |
string |
Organizer email |
yes |
| status |
string |
Status of approval by RTC either Available (A)
|
no |
| address |
string |
Address of organizer |
yes |
Error Responses
HTTP GET
This GET will return one organizer with its detail.
JSON Request:
JSON Response:
{
"address": "123 Bikes Rd. Portland, OR 97035",
"email": "sb@mailinator.com",
"organizerID": 6,
"organizerLogoID": 6,
"organizerName": "Speedy Bikes",
"status": "A",
"website": "speedybikes.org"
}
XML Request:
Request Body is empty
XML Response:
HTTP POST
This will POST a new organizer. OAuth required.
JSON Request:
{
"address": "123 Bikes Rd. Portland, OR 97035",
"email": "sb@mailinator.com",
"organizerID": 0,
"organizerLogoID": 6,
"organizerName": "Speedy Bikes",
"status": "A",
"website": "speedybikes.org"
}
JSON Response:
6
XML Request:
XML Response:
HTTP PUT
This will edit the organizer. OAuth required. Returns true if organizer successfully edited and saved.
JSON Request:
{
"address": "123 Bikes Rd. Portland, OR 97035",
"email": "sb@mailinator.com",
"organizerID": 6,
"organizerLogoID": 6,
"organizerName": "New Speedy Bikes",
"status": "A",
"website": "speedybikes.org"
}
JSON Response:
true
XML Request:
XML Response:
HTTP DELETE
Request Body is empty
JSON Request:
JSON Response:
XML Request:
XML Response:
REST API: Organizers Set
Resource URI
Set Filters
HTTP GET
Request Body is empty
JSON Request:
JSON Response:
XML Request:
XML Response:
HTTP POST
Request Body is empty
JSON Request:
JSON Response:
XML Request:
XML Response:
HTTP PUT
Request Body is empty
JSON Request:
JSON Response:
XML Request:
XML Response:
HTTP DELETE
Request Body is empty
JSON Request:
JSON Response:
XML Request:
XML Response: