Checkins¶
This resource represents the status of a particular customer and their checkin status in relation to their booking. Checkins are used within Good To Go, and can be fetched pragmatically to support your post-booking flows.
Here’s an example of a checkin resource:
{
"id": "<check-in-hash>",
"href": "https://rest.gadventures.com/checkins/<check-in-hash>",
"expires": "2020-01-04",
"booking": {
"id": "<booking-id>",
"href": "https://developers.gadventures.com/playground/bookings/<booking-id>"
},
"customer": {
"id": "<customer-id>",
"href": "https://rest.gadventures.com/customers/<customer-id>",
"name": {
"legal_middle_name": "Danger",
"common_name": "John",
"legal_first_name": "Johnathan",
"title": "Mr",
"legal_last_name": "Doe"
}
},
"status": "INCOMPLETE",
"requirements": [
{
"name": "Passport Information",
"code": "PASSPORT_INFORMATION",
"COMPLETE": [
{"code": "MIDDLE_NAME"},
{"code": "NAME"},
{"code": "GENDER"},
{"code": "AGE_RESTRICTED"},
{"code": "DATE_OF_BIRTH"},
{"code": "NATIONALITY"}
],
"INCOMPLETE": []
}
]
}
With the above, you are able to understand the state of a single customers checkin, including the requirements they have left to complete. These are the requirements displayed in the API, and likewise, Good to Go.
Additionally, when the check-in-hash
is obtained, that can be used to access
Good To Go for that customer (at the least, visit an authentication screen), e.g. https://www.gadventures.com/goodtogo/<check-in-hash>
Get Checkins For Booking¶
One can get all checkins for a booking.
- GET /bookings/(string: booking_id)/checkins¶
Get a Checkin¶
And the checkin can be queried in isolation.
- GET /checkins/(string: checkin_id)¶