Getting confirmed timeslot of an applicants event
This endpoint is deprecated. Please do not use it for new projects. The documentation remains here for legacy API consumers.
Getting a confirmed timeslot of an applicants event
The common use-case of obtaining a users confirmed timeslot to a given event-ID is associated with the /events/{eventId}/confirmedtimeslot endpoint. When a user is invited to an event, he is offered several timeslots, from which he can chose and confirm one. This API endpoint delivers the confirmed timeslot of an event a user is attending.
By sending the following GET-request, you can receive the confirmed timeslot, if one exists.
1 2 |
curl -i -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" -X GET "https://api.softgarden.io/api/rest/v2/frontend/events/{eventId}/confirmedtimeslot" |
with TOKEN being the user access token of the user in question. It is used to determine the validity of this request. And {eventId} is the required ID of the event you want to get the confirmed timeslot of.
Path parameters
Name | Description |
eventId | The ID of the event you want to display. |
Query parameters
– none –
Response values
Upon | Returned value | Description |
---|---|---|
success | JSON-encoded TimeSlotData-Object | n/a |
no confirmed timeslot | null | n/a |
failure | 500 – INTERNAL SERVER ERROR | When an error appears while processing your request. |
authorization error | 401 / 403 | See here for details. |
Example return value for call with eventId=”6110l656ds620009667g4331gjj0987″
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 |
{ "id" : "h45590881165kd006594664lol003649", "startDate" : 1361360954, "endDate" : 1361378954, "deadline" : 1360519200, "freeSeats" : 0, "totalSeats" : 1, "eventAddress" : { "id" : "6111221498621111ju3004551g100q9", "street" : "Musterstrasse 5", "zip" : "01234", "email" : "joe.doe@acme.com", "city" : "Musterstadt", "country" : "Deutschland", "fax" : "012 3456", "phone" : "012 3457", "url" : "http://www.acme.com", "note" : "", "displayName" : "", "postBox" : "", "building" : "E 4.3", "room" : "3041", "timeZoneId" : "UTC+1", } } |
Another example return value, when the user has no confirmed timeslot at eventId=”6110l656ds620009667g4331gjj0987″
1 |
nulL |