createCompleteReservation
This request bundles the functionality of createReservation and completeReservation together.
It's advisable to use this end-point when your application create & completes in the same second.
URL
https://globalreseller.nl/webservices/createCompleteReservation
HMAC calculation
apiKey + customerEmailAddress + customerFirstName + customerSurname + environment + ticketDate + ticketTime + tickets + userId
Please note: optional fields only needs to be included when an optional field is used.
Input:
Name | Datatype | Description | ||||||
---|---|---|---|---|---|---|---|---|
apiKey | String | Your public apiKey needs to be included in every request. | ||||||
environment | Enum | "test" or "production" | ||||||
userId | Integer | The userId is a reference to the user (museum / attraction). The userId can be requested via getAvailableUsers and can be cached in your application. | ||||||
tickets |
Array with the tickets
|
|||||||
ticketDate | Date | The ticket date must comply with the yyyy-mm-dd format. | ||||||
ticketTime | Time | (optional) 24 hours format (hh:mm), this field is optional based on the user. | ||||||
customerFirstName | String | (optional) Firstname of the customer. (please read "Contactinfo required" below) | ||||||
customerSurname | String | (optional) Surname of the customer. (please read "Contactinfo required" below) | ||||||
customerEmailAddress | String | (optional) Emailaddress of the customer. (please read "Contactinfo required" below) | ||||||
HMACKey | String | The HMACKey is calculated based on the input fields. |
Contactinfo required
for some clients it is mandatory to add contact info to this request.
Below is the list of clients where this information is required.
Clients
The VanGogh Museum | Required as of 01-01-2019. |
Output:
Name | Datatype | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
success | Boolean | Indicates if the request was successfully executed. | ||||||||
reservationId | String | Indicates the reservation id. | ||||||||
ticketBarcodes |
Array with ticket barcodes
|
JSON input example
{
"apiKey":"PUT-YOUR-PUBLIC-API-KEY-HERE",
"environment":"test",
"userId":1,
"tickets":[
{
"ticketTypeId":1001,
"ticketNumber":2
},
{
"ticketTypeId":1002,
"ticketNumber":1
}
],
"ticketDate":"2017-01-02",
"HMACKey":"PUT-YOUR-CALCULATED-HMAC-KEY-HERE"
}
JSON output example
{
"success":true,
"reservationId":"123456789",
"ticketBarcodes":[
{
"barcode":1231231928311,
"ticketTypeId":1001,
"barcodeType":"QR"
},
{
"barcode":1287192831231,
"ticketTypeId":1001,
"barcodeType":"QR"
},
{
"barcode":7172313127312,
"ticketTypeId":1002,
"barcodeType":"QR"
},
{
"barcode":5181237123612312,
"ticketTypeId":1002,
"barcodeType":"QR"
}
]
}