Retrouvez une liste de signature
Check-in fournit une API paginée pour récupérer la liste des signatures des invités de votre événement. Commence à la page=1. Paginez toutes les 500 signatures. Si vous souhaitez connaître le nombre de signatures recueillies lors de votre événement, vous devez interroger GET /api/v1/events/{id}.format et consulter la propriété signature_count.
JSON
Requête
GET /api/v1/events/{event_id}/signatures.json?page=1&auth_token=YOUR_API_TOKENRéponse
// 200 OK
[
{
"_id": "{id}",
// When did the signature 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",
// The check-in point where the signature took place
"accesspoint_id": "{check_in_point_id}",
// The SVG representation of the signature
"points": {
"width": "276",
"height": "266",
"lines": [
{
"x2": "250.625",
"x1": "272",
"stroke-width": "2.3333332538604736",
"y2": "65.75",
"y1": "92"
},
{
"x2": "218.75",
"x1": "250.625",
"stroke-width": "1.7055554389953613",
"y2": "42.375",
"y1": "65.75"
},
// ...
]
}
"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",
"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}/signatures.xml?page=1&auth_token=YOUR_API_TOKENRéponse
<!-- 200 OK -->
<?xml version="1.0" encoding="UTF-8"?>
<signatures type="array">
<signature>
<_id>{id}</_id>
<access-stamp type="datetime">2012-11-26T14:44:44Z</access-stamp>
<guest-uid>68vju8yxgl</guest-uid>
<accesspoint-id>{check_in_point_id}</accesspoint-id>
<event-id>{event_id}</event-id>
<points>
<width>276</width>
<height>266</height>
<lines type="array">
<line>
<x1>272</x1>
<x2>250.625</x2>
<stroke-width>2.3333332538604736</stroke-width>
<y1>92</y1>
<y2>65.75</y2>
</line>
<!-- [...] -->
</lines>
</points>
<created-at type="datetime">2012-11-26T14:44:44Z</created-at>
<updated-at type="datetime">2012-11-26T14:44:44Z</updated-at>
</signature>
<signature>
<!-- [...] -->
</signature>
</signatures>
Enregistré une nouvelle signature
C'est la méthode utilisé par nos Ipad à chaque signature.
JSON
Requête
POST /api/v1/{event_id}/signatures.json?auth_token=YOUR_API_TOKEN
Content-Type: application/json; charset=utf-8{
// Where did the signature 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"
// The SVG representation of the signature
"points": {
"width": "276",
"height": "266",
"lines": [
{
"x2": "250.625",
"x1": "272",
"stroke-width": "2.3333332538604736",
"y2": "65.75",
"y1": "92"
},
{
"x2": "218.75",
"x1": "250.625",
"stroke-width": "1.7055554389953613",
"y2": "42.375",
"y1": "65.75"
},
// ...
]
}
}Réponse
// 201 Created
{
// The signature has been created.
}
XML
Requête
POST /api/v1/{event_id}/signatures.xml?auth_token=YOUR_API_TOKEN
Content-Type: application/xml; charset=utf-8<signature>
<!-- Where did the signature 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>
<!-- The SVG representation of the signature -->
<points>
<width>276</width>
<height>266</height>
<lines type="array">
<line>
<x1>272</x1>
<x2>250.625</x2>
<stroke-width>2.3333332538604736</stroke-width>
<y1>92</y1>
<y2>65.75</y2>
</line>
<!-- [...] -->
</lines>
</points>
</signature>
Réponse
<!-- 201 Created -->
<?xml version="1.0" encoding="UTF-8"?>
<signature>
<!-- The signature -->
</signature>
Insertion groupée de signatures
Il 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 signatures une fois que le réseau est rétabli.
Vous devez soumettre un ensemble de signatures à créer. Si toutes les signatures sont valides et que l'insertion est réussie, vous recevrez une réponse 201 Created. Mais si au moins une des signatures ne peut être insérée, vous recevrez une réponse 422 Unprocessable Entity. Dans ce cas, consultez la réponse, qui sera un ensemble de signatures créées 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}/signatures/batch_create.json?auth_token=YOUR_API_TOKEN
Content-Type: application/json; charset=utf-8[
{
"accesspoint_id": "{check_in_point_id}",
"guest_uid": "19j38293ju",
"points": "[...]"
},
{
"accesspoint_id": "{check_in_point_id}",
"guest_uid": "ieuwh8w7wn",
"points": "[...]"
}
}
Réponse
// 201 Created
[
{
// The first signature created
},
{
// The second signature created
}
]
XML
Requête
POST /api/v1/{event_id}/signatures/batch_create.xml?auth_token=YOUR_API_TOKEN
Content-Type: application/xml; charset=utf-8<signatures type="array">
<signature>
<accesspoint-id>{check_in_point_id}</accesspoint-id>
<guest-uid>19j38293ju</guest-uid>
<points><!-- [...] --></points>
</signature>
<signature>
<accesspoint-id>{check_in_point_id}</accesspoint-id>
<guest-uid>ieuwh8w7wn</guest-uid>
<points><!-- [...] --></points>
</signature>
</signatures>
Réponse
<!-- 201 Created -->
<signatures type="array">
<signature>
<!-- The first signature created -->
</signature>
<signature>
<!-- The second signature created -->
</signature>
</signatures>