Check-in points

Check-in points

A check-in point is a place where you will check-in guests. It can be physical (Entrance, Exit, VIP Room) or represent an activity (Workshop, Conference, ...).

Retrieve the list of Check-in points

JSON

Request

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

Response

// 200 OK
[
  {
    // the first check-in point
  },
  {
    // the second check-in 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>

Get information about a given check-in 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 a new check-in point

JSON

Request

POST /api/v1/{event_id}/accesspoints.json?auth_token=YOUR_API_TOKEN
Content-Type: application/json; charset=utf-8

{
  // Fields of the check-in point to create (see GET request for a complete list)
}

Response

// 201 Created
{
   // Your newly created guest category as a JSON object
}

XML

Request

POST /api/v1/{event_id}/accesspoints.xml?auth_token=YOUR_API_TOKEN
Content-Type: application/xml; charset=utf-8

<accesspoint>
  <!-- Fields of the check-in point to create (see GET request for a complete list) -->
</accesspoint>

Response

<!-- 201 Created -->
<?xml version="1.0" encoding="UTF-8"?>
<accesspoint>
  <!-- Your newly created guest category as a JSON object -->
</accesspoint>

Update a check-in 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 check-in point to update (see GET request for a 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

<guest-category>
  <!-- Fields of the check-in point to update (see GET request for a complete list) -->
</guest-category>

Response

<!-- 204 No Content -->