Skip to main content

Access Points

An access point is a location where guests are checked in. It can represent either a physical location (entrance, exit, VIP room) or an activity (workshop, conference, etc.).

Retrieve all access points

JSON

Request

GET /api/v1/events/{event_id}/accesspoints.json?auth_token=YOUR_API_TOKEN

Response

// 200 OK 
[
{
// The first access point
},
{
// The second access point
}
]

XML

Request

GET /api/v1/events/{event_id}/accesspoints.xml?auth_token=YOUR_API_TOKEN

Response

<!-- 200 OK -->
<?xml version="1.0" encoding="UTF-8"?> <accesspoints type="array">
<accesspoint>
<!-- [...] -->
</accesspoint>
<accesspoint>
<!-- [...] -->
</accesspoint>
</accesspoints>

Retrieve a specific access point

JSON

Request

GET /api/v1/events/{event_id}/accesspoints/{id}.json?auth_token=YOUR_API_TOKEN

Response

// 200 OK
{
"_id": "{id}",
"name": "VIP Room",
"event_id": "{event_id}",
"created_at": "2012-11-28T10:09:35+01:00",
"updated_at": "2012-11-28T10:09:35+01:00",
"guest_category_accesspoints": [
{
"access_once": false,
"guest_category_id": "{vip_guest_category_id}"
}
]
}

XML

Request

GET /api/v1/events/{event_id}/accesspoints/{id}.xml?auth_token=YOUR_API_TOKEN

Response

<!-- 200 OK -->
<accesspoint>
<_id>{id}</_id>
<name>VIP Room</name>
<event-id>{event_id}</event-id>
<created-at type="datetime">2012-11-28T09:09:35Z</created-at>
<updated-at type="datetime">2012-11-28T09:09:35Z</updated-at>
<guest-category-accesspoints type="array">
<guest-category-accesspoint>
<access-once type="boolean">false</access-once>
<accesspoint-id>{id}</accesspoint-id>
<guest-category-id>{vip_guest_category_id}</guest-category-id>
</guest-category-accesspoint>
</guest-category-accesspoints>
</accesspoint>

Create an access point

JSON

Request

POST /api/v1/events/{event_id}/accesspoints.json?auth_token=YOUR_API_TOKEN Content-Type: application/json; charset=utf-8 
 {
// Fields of the access point to create (see the GET request for the complete list)
}

Response

// 201 Created
{
// Your newly created access point as a JSON object
}

XML

Request

POST /api/v1/events/{event_id}/accesspoints.xml?auth_token=YOUR_API_TOKEN Content-Type: application/xml; charset=utf-8
  <accesspoint>
<!-- Fields of the access point to create (see the GET request for the complete list) -->
</accesspoint>

Response

<!-- 201 Created -->
<?xml version="1.0" encoding="UTF-8"?>
<accesspoint>
<!-- Your newly created access point -->
</accesspoint>

Update an access point

JSON

Request

PUT /api/v1/events/{event_id}/accesspoints/{id}.json?auth_token=YOUR_API_TOKEN Content-Type: application/json; charset=utf-8
  {
// Fields of the access point to update (see the GET request for the complete list)
}

Response

// 204 No Content

XML

Request

PUT /api/v1/events/{event_id}/accesspoints/{id}.xml?auth_token=YOUR_API_TOKEN Content-Type: application/xml; charset=utf-8 
 <accesspoint>
<!-- Fields of the access point to update (see the GET request for the complete list) -->
</accesspoint>

Response

<!-- 204 No Content -->
Did this answer your question?