Booking · Resources
Preview resource template change
Previews the effect of a booking template selection on a resource’s PDF tickets, wallet passes and QR check-in. Provide the organization ID, resource ID and a booking template ID, or null to follow the standard template. The response reports what would turn on or off and, when the resolved template changes, how many wallet passes have already been issued; otherwise, issuedPasses is zero. Nothing is saved.
Permissions
Send an API key of the organization in the path, using the X-API-Key header.
Who may call it
- The caller must have organization access.
- The caller needs
resource.read. - If the resource is found, the caller also needs
mandate.readfor its mandate.
Request
Path parameters
-
organizationIdidrequired -
resourceIdidrequired
Body
Content-Type: application/json
-
bookingTemplateidrequirednullable
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
--request POST 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/booking/resources/YOUR_RESOURCE_ID/bookingTemplateChange' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/booking/resources/YOUR_RESOURCE_ID/bookingTemplateChange", {
method: "POST",
headers: {
"X-API-Key": "YOUR_API_KEY"
},
redirect: 'error',
signal: AbortSignal.timeout(30_000),
});
if (!response.ok) throw new Error(`campai HTTP ${response.status}`);
const text = await response.text();
const result = text ? JSON.parse(text) : null;
console.log(JSON.stringify(result, null, 2));<?php
$context = stream_context_create(['http' => [
'method' => 'POST',
'header' => [
'X-API-Key: YOUR_API_KEY',
],
'timeout' => 30,
'follow_location' => 0,
'ignore_errors' => true,
]]);
$text = @file_get_contents('https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/booking/resources/YOUR_RESOURCE_ID/bookingTemplateChange', false, $context);
preg_match('/^HTTP\/\S+ (\d{3})/', $http_response_header[0] ?? '', $match);
$status = (int) ($match[1] ?? 0);
if ($text === false || $status < 200 || $status >= 300) {
throw new RuntimeException("campai HTTP $status (0 means no response)");
}
$result = $text === '' ? null : json_decode($text, true, 512, JSON_THROW_ON_ERROR);
echo json_encode($result, JSON_PRETTY_PRINT | JSON_THROW_ON_ERROR), PHP_EOL;
No request that worked has been recorded yet, so the body is not shown.
Response
200 Successful response
Content-Type: application/json
-
changesobject3 properties
-
ticketstringnullableonoffchanges.ticketis null when PDF tickets would not change. -
passstringnullableonoffchanges.passis null when wallet passes would not change. -
qrCheckInstringnullableonoffchanges.qrCheckInis null when QR check-in would not change.
-
-
issuedPassesintegerat least 0
issuedPassesis zero when the same template applies before and after the selection.
{
"changes": {
"ticket": "on",
"pass": "on",
"qrCheckIn": "on"
},
"issuedPasses": 0
}
Errors
Other errors
| Status | Error | When |
|---|---|---|
| 404 | No fixed message | If the resource is not found in the organization, the request returns NOT_FOUND. |
Errors nearly every request can meet are listed under Errors.