A guest category accesspoint allows you to create a connection between a guest category and a check-in point. A given guest category will automatically give access to the check-in points that are bound to it.

Retrieve the list of guest category accesspoints for a given guest category

JSON

Request

GET /api/v1/events/{event_id}/guest_category_accesspoints.json?guest_category_id={guest_category_id}&auth_token=YOUR_API_TOKEN

Response

// 200 OK
[
  {
    "id": {id_1},
    "max_allowed_accesses": -1,
    "accesspoint_id": "{vip_room_id}",
    "guest_category_id": "{guest_category_id}"
  },
  {
    "id": {id_2},
    "max_allowed_accesses": 1,
    "accesspoint_id": "{entrance_id}",
    "guest_category_id": "{guest_category_id}"
  }
]

XML

Request

GET /api/v1/events/{event_id}/guest_category_accesspoints.xml?guest_category_id={guest_category_id}&auth_token=YOUR_API_TOKEN

Response

<!-- 200 OK -->
<?xml version="1.0" encoding="UTF-8"?>
<guest-category-accesspoints type="array">
  <guest-category-accesspoint>
    <id>{id_1}</id>
    <max-allowed-accesses type="integer">-1</max-allowed-accesses>
    <accesspoint-id>{vip_room_id}</accesspoint-id>
    <guest-category-id>{guest_category_id}</guest-category-id>
  </guest-category-accesspoint>
  <guest-category-accesspoint>
    <id>{id_2}</id>
    <max-allowed-accesses type="integer">1</max-allowed-accesses>
    <accesspoint-id>{entrance_id}</accesspoint-id>
    <guest-category-id>{guest_category_id}</guest-category-id>
  </guest-category-accesspoint>
</guest-category-accesspoints>

Create a guest category accesspoint

JSON

Request

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

Response

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

XML

Request

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

Response

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

Update a guest category accesspoint

JSON

Request

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

Response

// 204 No Content

XML

Request

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

Response

<!-- 204 No Content -->

Delete a guest category accesspoint

JSON

Request

DELETE /api/v1/events/{event_id}/guest_category_accesspoints/{id}.json?auth_token=YOUR_API_TOKEN

Response

// 204 No Content

XML

Request

DELETE /api/v1/events/{event_id}/guest_category_accesspoints/{id}.xml?auth_token=YOUR_API_TOKEN

Response

<!-- 204 No Content -->