Retrouvez une liste de l'ensemble des contrôles d'accès effectués
Check-in fournit une API paginée pour récupérer la liste des check-ins de votre événement. Commence à la page=1. Paginez tous les 500 check-ins. Si vous souhaitez connaître le nombre de check-ins effectués lors de votre événement, vous devez interroger GET /api/v1/events/{id}.format et consulter la propriété check_in_count.
JSON
Requête
GET /api/v1/events/{event_id}/access_controls.json?page=1&auth_token=YOUR_API_TOKENRéponse
// 200 OK
[
{
"_id": "{id}",
// When did the check-in took place? (UTC, use event.timezone for display purposes)
"access_stamp": "2012-11-26T15:44:44+01:00",
// The UID found in the scanned QR code. Beware, guest.uid != guest.id
"guest_uid": "68vju8yxgl",
// ACCESS_GRANTED = 0, GUEST_UNKNOWN = 1, NOT_AUTHORIZED = 2, TOO_MANY_CHECK_INS = 3
"access_status": 0,
// The check-in point where the check-in took place
"accesspoint_id": "{check_in_point_id}",
"event_id": "{event_id}",
"created_at": "2012-11-26T15:44:44+01:00",
"updated_at": "2012-11-26T15:44:44+01:00"
},
{
"_id": "{id}",
"access_stamp": "2012-11-26T15:44:44+01:00",
"guest_uid": "5ch0b30mnc",
"access_status": 0,
"accesspoint_id": "{check_in_point_id}",
"event_id": "{event_id}",
"created_at": "2012-11-26T15:44:44+01:00",
"updated_at": "2012-11-26T15:44:44+01:00"
},
// ...
]
XML
Requête
GET /api/v1/events/{event_id}/access_controls.xml?page=1&auth_token=YOUR_API_TOKENRéponse
<!-- 200 OK -->
<?xml version="1.0" encoding="UTF-8"?>
<access-controls type="array">
<access-control>
<_id>{id}</_id>
<access-stamp type="datetime">2012-11-26T14:44:44Z</access-stamp>
<access-status type="integer">0</access-status>
<guest-uid>68vju8yxgl</guest-uid>
<accesspoint-id>{check_in_point_id}</accesspoint-id>
<event-id>{event_id}</event-id>
<created-at type="datetime">2012-11-26T14:44:44Z</created-at>
<updated-at type="datetime">2012-11-26T14:44:44Z</updated-at>
</access-control>
<access-control>
<_id>{id}</_id>
<access-stamp type="datetime">2012-11-26T14:44:44Z</access-stamp>
<access-status type="integer">0</access-status>
<guest-uid>5ch0b30mnc</guest-uid>
<accesspoint-id>{check_in_point_id}</accesspoint-id>
<event-id>{event_id}</event-id>
<created-at type="datetime">2012-11-26T14:44:44Z</created-at>
<updated-at type="datetime">2012-11-26T14:44:44Z</updated-at>
</access-control>
</access-controls>
Retrouvez les check-ins d'un participant
Il s'agit essentiellement de la méthode appelée par notre application iPad de gestion des listes d'invités. Chaque fois que vous enregistrez une personne (en touchant la liste ou en scannant un code QR).
JSON
Requête
POST /api/v1/{event_id}/access_controls.json?auth_token=YOUR_API_TOKEN
Content-Type: application/json; charset=utf-8{
// Where did the check-in took place?
"accesspoint_id": "{check_in_point_id}",
// For which UID?
"guest_uid": "19j38293ju",
// When (UTC)? If you don't provide this, the server will set the access_stamp to DateTime.now
"access_stamp": "2012-11-26T14:44:44Z"
}Réponse
// 201 Created
{
// The check-in created. You can have a look at access_status, if 0 then
// that was a "green" check-in. Otherwise it's red.
}
XML
Requête
POST /api/v1/{event_id}/access_controls.xml?auth_token=YOUR_API_TOKEN
Content-Type: application/xml; charset=utf-8<access-control>
<!-- Where did the check-in took place? -->
<accesspoint-id>{check_in_point_id}"</accesspoint-id>
<!-- For which UID? -->
<guest-uid>19j38293ju</guest-uid>
<!-- When (UTC)? If you don't provide this, the server will set the access_stamp to DateTime.now -->
<access-stamp>2012-11-26T14:44:44Z"</access-stamp>
</access-control>
Réponse
<!-- 201 Created -->
<?xml version="1.0" encoding="UTF-8"?>
<access-control>
<!-- The check-in created. You can have a look at access_status, if 0 then
that was a "green" check-in. Otherwise it's red. -->
</access-control>
Insertion groupée de contrôle d'accès effectués.
l s'agit là encore d'une autre méthode utilisée par notre application iPad de gestion des listes d'invités. En mode hors ligne, elle permet de synchroniser les enregistrements une fois que le réseau est rétabli.
Vous devez soumettre un ensemble d'enregistrements à créer. Si tous sont valides et que l'insertion est réussie, vous recevrez une réponse 201 Created. Mais si au moins un des enregistrements ne peut être inséré, vous recevrez une réponse 422 Unprocessable Entity. Dans ce cas, consultez la réponse, qui sera un ensemble d'enregistrements créés et un rapport d'erreur (dans le même ordre que l'ensemble que vous avez soumis dans la charge utile de la requête).
JSON
Requête
POST /api/v1/{event_id}/access_controls/batch_create.json?auth_token=YOUR_API_TOKEN
Content-Type: application/json; charset=utf-8[
{
"accesspoint_id": "{check_in_point_id}",
"guest_uid": "19j38293ju",
// "access_stamp": "2012-11-26T14:44:44Z"
},
{
"accesspoint_id": "{check_in_point_id}",
"guest_uid": "ieuwh8w7wn",
// "access_stamp": "2012-11-26T15:44:44Z"
}
}
Réponse
// 201 Created
[
{
// The first check-in created
},
{
// The second check-in created
}
]
XML
Requête
POST /api/v1/{event_id}/access_controls/batch_create.xml?auth_token=YOUR_API_TOKEN
Content-Type: application/xml; charset=utf-8<access-controls type="array">
<access-control>
<accesspoint-id><{check_in_point_id}/accesspoint-id>
<guest-uid>19j38293ju</guest-uid>
<!-- <access-stamp>2012-11-26T14:44:44Z</access-stamp> -->
</access-control>
<access-control>
<accesspoint-id><{check_in_point_id}/accesspoint-id>
<guest-uid>ieuwh8w7wn</guest-uid>
<!-- <access-stamp>2012-11-26T15:44:44Z</access-stamp> -->
</access-control>
</access-controls>
Réponse
<!-- 201 Created -->
<access-controls type="array">
<access-control>
<!-- The first check-in created -->
</access-control>
<access-control>
<!-- The second check-in created -->
</access-control>
</access-controls>
Supprimer un accès contrôlé
JSON
Requête
DELETE /api/v1/{event_id}/access_controls/{id}.json?auth_token=YOUR_API_TOKENRéponse
// 204 No Content
XML
Requête
DELETE /api/v1/{event_id}/access_controls/{id}.xml?auth_token=YOUR_API_TOKENRéponse
<!-- 204 No Content -->