Skip to content

Protocol Reception

Jacob Sparre Andersen edited this page Mar 24, 2014 · 1 revision

List all receptions

GET /reception/list[?includeInactive=(True|False)]

Returns a list of receptions. The includeInactive parameter specifies wheter or not the list should include disabled receptions. THe reception list may be empty.

Condition: Success.

HTTP 200 OK

{
"receptions": [
{
"org_name": "AdaHeads K/S",
"website": "http://adaheads.com",
"identifier": "sip://adaheads",
"id": 1
},
{
"org_name": "Fishermans Friends A/S",
"website": "http://fishermansfriends.dk",
"identifier": "sip://fishermansfriends",
"id": 2
},
....
]
}

Retrieve a single reception

GET /reception/<recption_id>

Returns the reception associated with the supplied <recption_id>.

Condition: Success.

HTTP 200 OK

{
"org_name": "AdaHeads K/S",
"website": "http://adaheads.com",
"identifier": "sip://adaheads",
"id": 1,
}

Condition: Error. <recption_id> not found.

HTTP 404 Not Found

{}

Retrieve the calendar of a reception

GET /reception/<recption_id>/calendar

Condition: Success.

HTTP 200 OK

{
"reception_id" : <reception_id>,"calendar_entries" : [<calendar_entry_object>+]
}

Clone this wiki locally