Reservations
Retrieve a Single Asset Reservation #
|
Sample Object
|
Retrieves a single Asset reservation.
| Name | Type | Required? | Description | Details |
|---|---|---|---|---|
| asset_type_id | Number | Yes |
The reservation's Asset type. Capital tracks one item; Collateral tracks quantities. Supply the type even when you know the reservation ID.
|
Allowed values:
1 (Capital) | 2 (Collateral) |
| id | Number | Yes |
The reservation ID for the selected Asset type.
|
The current Asset and Event are determined automatically. No additional Asset or Event ID is needed.
|
| hydrate_optional_accessories | Boolean | No |
Set to
false to skip the Capital reservation’s Optional Accessories and quantities.
|
Default: true. Collateral has no Optional Accessories and returns an empty collection when this option is true.
|
| hydrate_logistical_records | Boolean | No |
Set to
false to skip the reservation’s Logistical Records.
|
Default: true when the feature is available; otherwise not loaded. Explicitly requesting true without access is refused.
|
| hydrate_attachment_metadata | Boolean | No |
Set to
false to skip the attachment metadata.
|
Default: true. Only files you can read are included; file contents are not downloaded.
|
| $include_record_revision | Boolean | No |
Set to
true to include a record_revision for checking a later update.
|
Default: false. The revision checks the complete reservation material, regardless of which optional collections you choose to load.
|
| $result_format | String | No |
By default, the response is a single object. Send
array to get it inside a one-item array.
|
Allowed values:
array |
| $on_error_return_empty_result | Boolean | No |
Set to
true to return an empty result for supported validation or not-found errors.
|
Default: false. Malformed inputs, authentication errors, rate limits, read conflicts and unexpected errors keep their error response.
|
| $include_error_list_in_response_message | Boolean | No |
Set to
true to include individual validation errors in the response message.
|
Default: false. The normal error response still includes its error list.
|
| If-None-Match | String | No |
Send the ETag from an earlier response when checking whether this result changed.
|
Optional request header. A matching current result returns HTTP 304 with no body; reuse your earlier response. This header compares GET responses. It cannot prevent a conflicting update.
|
Good to know
Retrieves one Asset reservation using its type and reservation ID. By default, it loads Capital Optional Accessories, eligible Logistical Records and readable attachment metadata. Set the corresponding hydration option to false when you do not need those details.
Reading the reservation
The API derives the reservation’s current Asset and Event and checks your access. You do not need to provide extra Asset or Event IDs. A missing or inaccessible reservation normally returns HTTP 404.
A hydration option set to false leaves that collection unloaded with a null value. A requested collection with no applicable or readable items is empty. Skipping a collection does not change the reservation.
Understanding reservation dates and quantity
For Capital, Reservation Date is the checkout date and quantity is always 1. The response also preserves the saved Return Date.
For Collateral, Reservation Date is when the signed inventory change takes effect. quantity gives its size without a sign; quantity_adjustment preserves the signed change. return_date is the scheduled Return to Storage / Check-in date, when that quantity change reverses. It does not confirm a physical return.
An unknown Collateral return remains unknown. Manual inventory increases and decreases without an Event use the inventory-adjustment methods. Older unsupported quantities remain readable and are marked with is_quantity_editable=false.
Shared Assets and private details
For a borrowed Asset, access to a reservation through your Event can remain available after the Asset is unshared. This does not grant access to the owner’s other Assets, private storage details or unrelated reservations.
When your shared Asset is reserved for another workspace’s Event, you can read that Event’s name, the reservation notes and, when requested, its Logistical Records, as in the Assets area. event_id is null because the Event belongs to the other workspace, so Event methods can’t open it with this key; exhibitday_url opens the reservation in your Assets area. A reservation on your own Event keeps its event_id. Each Logistical Record’s logistical_record_created_by is a User Lite object; someone who is not a current member of your workspace, such as the other workspace’s staff, is shown by name only, with no id or email.
Each attachment still needs its own file-origin permission. Reading the current reservation does not grant access to every file, and moving the reservation does not change a file’s original Event rights. Attachment metadata contains the file ID, original filename and added time, not file bytes, a storage key or a permanent public download link.
Notes are returned as text: HTML-encoded, with line breaks as <br/>. Formatting added in ExhibitDay is not returned.
Getting a revision before an update
- Retrieve this Info response with
$include_record_revision=true. - Send that exact
record_revisionasexpected_revisionwhen updating or deleting one of this reservation’s Logistical Records.
What $include_record_revision covers
Set $include_record_revision=true to receive record_revision in this GET response. It covers the reservation fields, Capital Optional Accessory quantities, all Logistical Records, note formatting saved in ExhibitDay and related-item links. Attachment metadata and file contents are excluded. Its scope does not shrink when you skip a hydrated collection.
If you own the Asset and the reservation is on another workspace’s Event, you still get a record_revision. Use it for the changes you can make there, such as dates, flags and shipping logistics. If the reservation’s Event is yours but its Assets tab is hidden, the request returns HTTP 400 with a message naming the tab. The revision grants no additional access.
Without this option, no record_revision is returned. An ETag for the GET response is separate from the edit revision. If concurrent changes prevent the read, HTTP 409 with error_code=record_changed means you should retrieve the reservation again.
Checking whether a response changed
Normal API-key and access checks still apply. This header compares the response; it does not authorize access or protect an update.
- Save the response body and its
ETagheader from an earlier GET. - Repeat the same GET, including the same filters and response options, with that ETag in the
If-None-Matchheader. - If the response is HTTP
304, keep using your saved body. If it is HTTP200, use the new body and ETag.
curl -X GET "https://api.exhibitday.com/v1/assets/reservations/info?asset_type_id=1&id=12345" -H "Authorization: Bearer YOUR_API_KEY"
const response = await fetch("https://api.exhibitday.com/v1/assets/reservations/info?" + new URLSearchParams({ "asset_type_id": "1", "id": "12345" }), {
method: "GET",
headers: { "Authorization": "Bearer YOUR_API_KEY" }
});
const data = await response.json();
console.log(response.status, data);
import requests
response = requests.get(
"https://api.exhibitday.com/v1/assets/reservations/info",
headers={"Authorization": "Bearer YOUR_API_KEY"},
params={"asset_type_id": 1, "id": 12345},
)
print(response.status_code, response.json())
using System;
using System.Net.Http;
using System.Net.Http.Headers;
using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", "YOUR_API_KEY");
var response = await client.GetAsync("https://api.exhibitday.com/v1/assets/reservations/info?asset_type_id=1&id=12345");
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class ExhibitDayExample {
public static void main(String[] args) throws Exception {
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.exhibitday.com/v1/assets/reservations/info?asset_type_id=1&id=12345"))
.header("Authorization", "Bearer YOUR_API_KEY")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode() + " " + response.body());
}
}
<?php
$curl = curl_init('https://api.exhibitday.com/v1/assets/reservations/info?asset_type_id=1&id=12345');
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['Authorization: Bearer YOUR_API_KEY'],
]);
$response = curl_exec($curl);
if ($response === false) {
throw new RuntimeException(curl_error($curl));
}
echo curl_getinfo($curl, CURLINFO_HTTP_CODE) . PHP_EOL . $response;
curl_close($curl);
require 'net/http'
require 'uri'
uri = URI('https://api.exhibitday.com/v1/assets/reservations/info?asset_type_id=1&id=12345')
request = Net::HTTP::Get.new(uri)
request['Authorization'] = 'Bearer YOUR_API_KEY'
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(request)
end
puts "#{response.code} #{response.body}"
package main
import (
"fmt"
"io"
"log"
"net/http"
)
func main() {
request, err := http.NewRequest("GET", "https://api.exhibitday.com/v1/assets/reservations/info?asset_type_id=1&id=12345", nil)
if err != nil { log.Fatal(err) }
request.Header.Set("Authorization", "Bearer YOUR_API_KEY")
response, err := (&http.Client{}).Do(request)
if err != nil { log.Fatal(err) }
defer response.Body.Close()
body, err := io.ReadAll(response.Body)
if err != nil { log.Fatal(err) }
fmt.Printf("%d %s\n", response.StatusCode, body)
}
Example response
{
"id": 12345,
"exhibitday_url": "https://www.exhibitday.com/Workspace/Event/98765?eid=45678&riType=5&riSub=1&riId=12345",
"asset_type_id": 1,
"asset_id": 12345,
"asset_name": "Display stand",
"is_asset_owned_by_this_workspace": true,
"event_id": 45678,
"event_name": "Spring industry show",
"reservation_date": "2030-01-15",
"return_date": "2030-01-16",
"storage_location_id": 2345,
"storage_location_name": "Main Warehouse",
"quantity": 1,
"quantity_adjustment": null,
"is_quantity_editable": true,
"notes": "Pack with the setup guide.",
"shipping_logistics_id": 1,
"is_flagged": false,
"is_starred": false,
"is_checked": false,
"asset_reservation_created_timestamp": "2030-01-02T17:00:00Z",
"optional_accessories": [
{
"id": 14001,
"optional_accessory_id": 13001,
"name": "Transport case",
"quantity": 1
},
{
"id": 14002,
"optional_accessory_id": 13002,
"name": "Spotlight",
"quantity": 2
}
],
"logistical_records": [
{
"id": 15001,
"asset_type_id": 1,
"reservation_id": 12345,
"asset_id": 12345,
"record_type_id": 1,
"record_type": "Prepped",
"record_date": "2030-01-14",
"description": "Packed and ready for collection.",
"logistical_record_created_by": {
"id": null,
"first_name": "ExhibitDay",
"last_name": "API",
"display_name": "ExhibitDay API",
"email": null,
"type": null,
"workspace_role": null,
"is_active": true
},
"logistical_record_created_timestamp": "2030-01-02T17:00:00Z"
},
{
"id": 15002,
"asset_type_id": 1,
"reservation_id": 12345,
"asset_id": 12345,
"record_type_id": 2,
"record_type": "Sent",
"record_date": "2030-01-15",
"description": "Collected by the carrier.",
"logistical_record_created_by": {
"id": null,
"first_name": "ExhibitDay",
"last_name": "API",
"display_name": "ExhibitDay API",
"email": null,
"type": null,
"workspace_role": null,
"is_active": true
},
"logistical_record_created_timestamp": "2030-01-02T17:00:00Z"
}
],
"attachments": [
{
"id": 16001,
"filename": "packing-list.pdf",
"attachment_created_timestamp": "2030-01-02T17:00:00Z"
},
{
"id": 16002,
"filename": "setup-guide.pdf",
"attachment_created_timestamp": "2030-01-02T17:00:00Z"
}
],
"related_items": [
{
"id": 5551,
"related_item_id": 67890,
"related_item_exhibitday_url": "https://www.exhibitday.com/Workspace/TaskView/98765?tid=67890",
"related_item_type_id": 1,
"related_item_type": "Task",
"related_item_asset_type_id": null,
"related_item_name": "Confirm booth graphics with the printer",
"related_item_created_timestamp": "2030-01-10T14:03:00Z"
},
{
"id": 5552,
"related_item_id": 45678,
"related_item_exhibitday_url": "https://www.exhibitday.com/Workspace/RelatedItemView/98765?typeId=4&subTypeId=0&rid=45678",
"related_item_type_id": 4,
"related_item_type": "Shipment",
"related_item_asset_type_id": null,
"related_item_name": "Booth crates to convention center",
"related_item_created_timestamp": "2030-01-10T14:03:00Z"
}
]
}
{
"status_code": 400,
"status": "Bad Request",
"message": "HTTP method override is not supported.",
"error_code": "invalid_request",
"errors": [
"Send the documented HTTP method directly. X-HTTP-Method-Override cannot change a request's HTTP method."
],
"error_params": [
"X-HTTP-Method-Override"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "No API key was provided. Send your key in the Authorization header as 'Bearer YOUR_API_KEY'. Alternatively, you can use the api_key parameter.",
"error_code": "missing_api_key",
"errors": [
"Copy the key from Workspace Settings > API & Integrations > API Access in ExhibitDay."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "The API key is not valid. Check that you copied the whole key from Workspace Settings > API & Integrations > API Access, then send it in the Authorization header as 'Bearer YOUR_API_KEY'. Alternatively, you can use the api_key parameter.",
"error_code": "invalid_api_key",
"errors": [
"Check that you sent the whole key. If it was regenerated, use the current key from Workspace Settings > API & Integrations > API Access."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "Access to the ExhibitDay API is not enabled for your workspace. Please contact support@exhibitday.com to enable API Access. Once access is enabled, send your key in the Authorization header as 'Bearer YOUR_API_KEY'.",
"error_code": "api_access_disabled",
"errors": [
"Nothing was read or changed."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 404,
"status": "Not Found",
"message": "Asset Reservation not found. Invalid Asset Reservation ID: 12345.",
"error_code": "not_found",
"errors": [
"Asset Reservation not found. Invalid Asset Reservation ID: 12345."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "The record was being changed while it was read, so no record_revision could be issued. Read it again.",
"error_code": "record_changed",
"errors": [
"The record was being changed while it was read, so no record_revision could be issued. Read it again."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "This reservation changed while it was being read. Read it again; no data was changed.",
"error_code": "record_changed",
"errors": [
"This reservation changed while it was being read. Read it again; no data was changed."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 429,
"status": "Too Many Requests",
"message": "Error 429 - Too Many Requests",
"error_code": "rate_limited",
"errors": [
"Error 429 - Too Many Requests"
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"An unexpected error occurred. Please try again later."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"Check whether your change was saved before trying again."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
Retrieve Asset Reservations #
|
Retrieves the Asset reservations in your workspace.
| Name | Type | Required? | Description | Details |
|---|---|---|---|---|
| asset_type_id | Number | Yes |
The reservation's Asset type. Capital tracks one item; Collateral tracks quantities. Supply the type even when you know the reservation ID.
|
Allowed values:
1 (Capital) | 2 (Collateral) |
| filter_by_reservation_id | Number | No |
Only return this reservation for the selected type.
|
|
| filter_by_asset_id | Number | No |
Only return reservations for this Asset.
|
|
| filter_by_event_id | Number | No |
Return records for this Event only. Omit for all readable Events in your workspace.
|
|
| $result_format | String | No |
By default, the response is an object containing
list_data and the paging totals (records_found, total_records, has_more). Send array to get just a JSON array of the records, or wrapped_in_array to get the default object inside a one-item array.
|
Allowed values:
array | wrapped_in_array |
| $on_error_return_empty_result | Boolean | No |
Set to
true to return an empty collection for supported validation errors.
|
Default: false. No matching reservations normally returns an empty collection. Other errors keep their normal status.
|
| $include_error_list_in_response_message | Boolean | No |
Set to
true to include individual validation errors in the response message.
|
Default: false. The normal error response still includes its error list.
|
| hydrate_optional_accessories | Boolean | No |
Set to
true to load Optional Accessories and quantities for each Capital reservation.
|
Default: false. Collateral has no Optional Accessories; when requested, its collection is empty.
|
| hydrate_logistical_records | Boolean | No |
Set to
true to load Logistical Records for each returned reservation.
|
Default: false. Your workspace needs the feature. Explicitly requesting it without access is refused.
|
| hydrate_attachment_metadata | Boolean | No |
Set to
true to load attachment metadata you can read for each returned reservation.
|
Default: false. This does not download file contents.
|
| filter_by_shipping_logistics_id | Number | No |
Only return reservations with this Shipping Logistics ID.
|
Standard values: 1 (Unspecified), 2 (Advance Warehouse), 3 (Direct Shipment), 4 (Other).
|
| filter_by_is_flagged | Boolean | No |
Only return reservations matching this flag status.
|
true selects flagged; false selects unflagged. Omit to include both. |
| filter_by_is_starred | Boolean | No |
Only return reservations matching this star status.
|
true selects starred; false selects unstarred. Omit to include both. |
| filter_by_is_checked | Boolean | No |
Only return reservations matching this checked status.
|
true selects checked; false selects unchecked. Omit to include both. |
| filter_by_reservation_date_greater_than_or_equal_to | Date | No |
Only return reservations dated on or after this date.
|
Use
YYYY-MM-DD. This is Capital checkout or the Collateral inventory Effective Date. |
| filter_by_reservation_date_smaller_than_or_equal_to | Date | No |
Only return reservations dated on or before this date.
|
Use
YYYY-MM-DD. It must not precede the lower date when both are supplied. |
| filter_by_reservation_return_date_greater_than_or_equal_to | Date | No |
Only return Capital reservations with a saved Return Date on or after this date.
|
Capital only. Use
YYYY-MM-DD. An unknown return does not match. |
| filter_by_reservation_return_date_smaller_than_or_equal_to | Date | No |
Only return Capital reservations with a saved Return Date on or before this date.
|
Capital only. Use
YYYY-MM-DD. An unknown return does not match. |
| filter_by_reservation_overlaps_start_date | Date | With the overlap end date |
The first date of a period that a Capital reservation must overlap.
|
Capital only. Use
YYYY-MM-DD. Supply both overlap dates. |
| filter_by_reservation_overlaps_end_date | Date | With the overlap start date |
The last date of the overlap period.
|
Capital only. Use
YYYY-MM-DD, on or after the overlap start. An unknown return does not match. |
| $limit | Number | No |
The maximum number of matching reservations to return.
|
One positive whole number. Omit to return all matches after
$offset; there is no fixed page-size cap. |
| $offset | Number | No |
The number of matching reservations to skip.
|
Default: 0. Send a nonnegative whole number.
|
| $result_sort | String | No |
Order reservations by reservation date, creation time or ID. Omit for reservation date ascending. Date and time ties use ID ascending. Unsupported values are refused.
|
Allowed values:
reservation_date_asc | reservation_date_desc | create_timestamp_asc | create_timestamp_desc | id_asc | id_desc |
| hydrate_related_items | Boolean | No |
Set to true to include each record's related_items: the Tasks and items linked to it, with the key to use when adding or removing a link. Omit it or send false to leave related_items out of list results. Single-record GETs always include related_items.
|
Default: false.
|
| If-None-Match | String | No |
Send the ETag from an earlier response when checking whether this result changed.
|
Optional request header. A matching current result returns HTTP 304 with no body; reuse your earlier response. This header compares GET responses. It cannot prevent a conflicting update.
|
Good to know
Retrieves Asset reservations across your workspace. Choose Capital or Collateral with the required asset_type_id. Use filter_by_event_id to narrow the list to one Event, or omit it for all matching reservations.
What the list covers
The list includes reservations against your workspace's Assets and readable reservations on its Events for borrowed Assets. A borrowed reservation can remain readable after sharing is removed; this does not open the other workspace's Asset list, storage details or other reservations.
Capital Other Purpose reservations can have no Event. Manual Collateral inventory increases and decreases use the Inventory Adjustments methods.
Reservations keep the Event name and notes shown in the Assets area, including when a shared Asset is reserved for another workspace’s Event. For that Event, event_id is null because it belongs to the other workspace, and Event methods can't open it with this key. Your own Events keep their IDs.
Choosing and filtering reservations
Set asset_type_id=1 for Capital or 2 for Collateral. The type is always required because the two kinds can have the same reservation ID.
Omit filter_by_event_id for the workspace list. Supply it to match one of your workspace's Events; a missing or inaccessible Event has no matching rows. The filter does not grant access. Unrecognized parameters are ignored and listed in the X-API-Warnings response header.
The existing Asset, reservation, date, Shipping Logistics and marker filters combine with AND. An explicit false marker matches unmarked reservations and is not treated as omission.
Understanding dates and quantity
For Capital, Reservation Date is checkout and Return Date is the end of that reservation. For Collateral, Reservation Date is when the quantity change takes effect; a scheduled Return to Storage date is when its quantity effect reverses, not confirmation of a physical return.
An unknown Collateral return date remains unknown. Collateral return-date and overlap filters are not supported. Capital overlap filters require both inclusive endpoints.
Including details
Optional Accessories, Logistical Records and attachment metadata are off by default for this collection. Their hydrate options add details only to the selected page. Optional Accessories apply to Capital; Collateral returns an empty collection when that detail is requested.
Logistical Records require your workspace's feature. Explicitly requesting them without access returns an error.
Attachment metadata follows each file's owning workspace and original Event. Moving a reservation does not grant access to every file. No file content, storage key or permanent download link is included. Notes are returned as text: HTML-encoded, with line breaks as <br/>. Formatting added in ExhibitDay is not returned.
Reading pages and handling changes
Filters and the full count are applied before paging and optional details. The default is Reservation Date ascending, then ID ascending; $result_sort retains its existing date, creation-time and ID choices. Omit $limit for all remaining matches or use it with $offset for successive pages.
Current API access is checked even for an empty result. A selected record changing while the page is being read can return HTTP 409; retrieve the list again. These reads do not update reservations, tags or notifications.
Events with a hidden Assets tab
Records on Events whose Assets tab is hidden are not listed. If filter_by_event_id names such an Event, the response is HTTP 200 with no records for it and a warning that names the tab and the Event.
Hidden or locked Assets tab
Reservations on Events in your workspace whose Assets tab is hidden are left out of this list. If filter_by_event_id names such an Event, the response is HTTP 200 with no records for it and a warning that names the tab and the Event. Show the tab in ExhibitDay to list them.
curl -X GET "https://api.exhibitday.com/v1/assets/reservations?asset_type_id=1" -H "Authorization: Bearer YOUR_API_KEY"
const response = await fetch("https://api.exhibitday.com/v1/assets/reservations?" + new URLSearchParams({ "asset_type_id": "1" }), {
method: "GET",
headers: { "Authorization": "Bearer YOUR_API_KEY" }
});
const data = await response.json();
console.log(response.status, data);
import requests
response = requests.get(
"https://api.exhibitday.com/v1/assets/reservations",
headers={"Authorization": "Bearer YOUR_API_KEY"},
params={"asset_type_id": 1},
)
print(response.status_code, response.json())
using System;
using System.Net.Http;
using System.Net.Http.Headers;
using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", "YOUR_API_KEY");
var response = await client.GetAsync("https://api.exhibitday.com/v1/assets/reservations?asset_type_id=1");
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class ExhibitDayExample {
public static void main(String[] args) throws Exception {
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.exhibitday.com/v1/assets/reservations?asset_type_id=1"))
.header("Authorization", "Bearer YOUR_API_KEY")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode() + " " + response.body());
}
}
<?php
$curl = curl_init('https://api.exhibitday.com/v1/assets/reservations?asset_type_id=1');
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['Authorization: Bearer YOUR_API_KEY'],
]);
$response = curl_exec($curl);
if ($response === false) {
throw new RuntimeException(curl_error($curl));
}
echo curl_getinfo($curl, CURLINFO_HTTP_CODE) . PHP_EOL . $response;
curl_close($curl);
require 'net/http'
require 'uri'
uri = URI('https://api.exhibitday.com/v1/assets/reservations?asset_type_id=1')
request = Net::HTTP::Get.new(uri)
request['Authorization'] = 'Bearer YOUR_API_KEY'
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(request)
end
puts "#{response.code} #{response.body}"
package main
import (
"fmt"
"io"
"log"
"net/http"
)
func main() {
request, err := http.NewRequest("GET", "https://api.exhibitday.com/v1/assets/reservations?asset_type_id=1", nil)
if err != nil { log.Fatal(err) }
request.Header.Set("Authorization", "Bearer YOUR_API_KEY")
response, err := (&http.Client{}).Do(request)
if err != nil { log.Fatal(err) }
defer response.Body.Close()
body, err := io.ReadAll(response.Body)
if err != nil { log.Fatal(err) }
fmt.Printf("%d %s\n", response.StatusCode, body)
}
Example response
{
"records_found": 2,
"total_records": 2,
"has_more": false,
"list_type": "asset_reservation",
"list_data": [
{
"id": 12345,
"exhibitday_url": "https://www.exhibitday.com/Workspace/Event/98765?eid=23456&riType=5&riSub=1&riId=12345",
"asset_type_id": 1,
"asset_id": 34567,
"asset_name": "Display stand",
"is_asset_owned_by_this_workspace": true,
"event_id": 23456,
"event_name": "Spring industry show",
"reservation_date": "2030-01-15",
"return_date": "2030-01-16",
"storage_location_id": null,
"storage_location_name": null,
"quantity": 1,
"quantity_adjustment": null,
"is_quantity_editable": true,
"notes": "Pack with the setup guide.",
"shipping_logistics_id": 1,
"is_flagged": false,
"is_starred": false,
"is_checked": false,
"asset_reservation_created_timestamp": "2030-01-02T12:00:00Z",
"optional_accessories": null,
"logistical_records": null,
"attachments": null
},
{
"id": 12346,
"exhibitday_url": "https://www.exhibitday.com/Workspace/Event/98765?eid=23457&riType=5&riSub=1&riId=12346",
"asset_type_id": 1,
"asset_id": 34568,
"asset_name": "Banner kit",
"is_asset_owned_by_this_workspace": true,
"event_id": 23457,
"event_name": "Autumn industry show",
"reservation_date": "2030-02-15",
"return_date": "2030-02-16",
"storage_location_id": null,
"storage_location_name": null,
"quantity": 1,
"quantity_adjustment": null,
"is_quantity_editable": true,
"notes": "Bring the spare display materials.",
"shipping_logistics_id": 1,
"is_flagged": false,
"is_starred": false,
"is_checked": false,
"asset_reservation_created_timestamp": "2030-01-03T12:00:00Z",
"optional_accessories": null,
"logistical_records": null,
"attachments": null
}
]
}
{
"status_code": 400,
"status": "Bad Request",
"message": "HTTP method override is not supported.",
"error_code": "invalid_request",
"errors": [
"Send the documented HTTP method directly. X-HTTP-Method-Override cannot change a request's HTTP method."
],
"error_params": [
"X-HTTP-Method-Override"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "No API key was provided. Send your key in the Authorization header as 'Bearer YOUR_API_KEY'. Alternatively, you can use the api_key parameter.",
"error_code": "missing_api_key",
"errors": [
"Copy the key from Workspace Settings > API & Integrations > API Access in ExhibitDay."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "The API key is not valid. Check that you copied the whole key from Workspace Settings > API & Integrations > API Access, then send it in the Authorization header as 'Bearer YOUR_API_KEY'. Alternatively, you can use the api_key parameter.",
"error_code": "invalid_api_key",
"errors": [
"Check that you sent the whole key. If it was regenerated, use the current key from Workspace Settings > API & Integrations > API Access."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "Access to the ExhibitDay API is not enabled for your workspace. Please contact support@exhibitday.com to enable API Access. Once access is enabled, send your key in the Authorization header as 'Bearer YOUR_API_KEY'.",
"error_code": "api_access_disabled",
"errors": [
"Nothing was read or changed."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "The API key is not valid for this request. Send your current key in the Authorization header as 'Bearer YOUR_API_KEY'.",
"error_code": "invalid_api_key",
"errors": [
"The API key is not valid for this request. Send your current key in the Authorization header as 'Bearer YOUR_API_KEY'."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "Access to the ExhibitDay API is not enabled for your workspace. Please contact support@exhibitday.com to enable API Access. Once access is enabled, send your key in the Authorization header as 'Bearer YOUR_API_KEY'.",
"error_code": "api_access_disabled",
"errors": [
"Access to the ExhibitDay API is not enabled for your workspace. Please contact support@exhibitday.com to enable API Access. Once access is enabled, send your key in the Authorization header as 'Bearer YOUR_API_KEY'."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "This reservation changed while it was being read. Read it again; no data was changed.",
"error_code": "record_changed",
"errors": [
"This reservation changed while it was being read. Read it again; no data was changed."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 429,
"status": "Too Many Requests",
"message": "Error 429 - Too Many Requests",
"error_code": "rate_limited",
"errors": [
"Error 429 - Too Many Requests"
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"An unexpected error occurred. Please try again later."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"An unexpected error occurred. Please try again later."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"Check whether your change was saved before trying again."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
Add an Asset Reservation #
|
Adds an Asset reservation.
| Name | Type | Required? | Description | Details |
|---|---|---|---|---|
| asset_type_id | Number | Yes |
The type of Asset to reserve. Capital tracks one item; Collateral tracks quantities. Supply this with the Asset ID.
|
Allowed values:
1 (Capital) | 2 (Collateral) |
| asset_id | Number | Yes |
The ID of the Asset to reserve.
|
The Asset must be Active and either in your workspace or currently shared with it.
|
| reservation_date | Date | Yes |
The checkout date.
|
YYYY-MM-DD.
|
| event_id | Number | For Collateral, or a borrowed Capital Asset |
The Event for the new reservation.
|
Use an Event in your workspace. For a Capital Asset in your workspace, omit it to make an Other Purpose reservation and describe that purpose in notes.
|
| return_date | Date | For Capital, or Collateral with a known return date |
The reservation’s return date.
|
YYYY-MM-DD, on or after checkout. Required for Capital. For Collateral, omit this date or send JSON null when the return is unknown.
|
| storage_location_id | Number | When asset_type_id=2 |
The Storage Location from which to reserve Collateral.
|
Collateral only. Use a Storage Location that belongs to the Asset’s owner.
|
| quantity | Number | When asset_type_id=2 |
The quantity of Collateral to reserve.
|
Collateral only. A whole number from 1 through 2,147,483,647. The matching inventory deduction is saved with the reservation.
|
| shipping_logistics_id | Number | No |
The Shipping Logistics choice. Omit for Unspecified.
|
Allowed values:
1 (Unspecified) | 2 (Advance Warehouse) | 3 (Direct Shipment) | 4 (Other) |
| notes | String | For an Other Purpose Capital reservation |
Reservation Notes, or the description of an Other Purpose reservation.
|
Plain text, up to 1,000 characters. HTML tags are removed and line breaks are preserved. A Capital reservation without an Event needs a purpose, so its notes cannot be blank.
|
| is_flagged | Boolean | No |
Whether to flag this reservation.
|
Boolean. Default: false.
|
| is_starred | Boolean | No |
Whether to star this reservation.
|
Boolean. Default: false.
|
| is_checked | Boolean | No |
Whether to mark this reservation as checked.
|
Boolean. Default: false.
|
| optional_accessories | JSON object/list | No |
The complete Optional Accessory selection for a Capital reservation.
View value format and limitsFile uploads use multipart form data. Other structured values use a JSON object or array; form/query values use JSON text.
|
Capital only. Send a JSON array such as [{"optional_accessory_id":12345,"quantity":1}]. IDs must be unique and quantities whole numbers of zero or more. Zero leaves that accessory unselected. Omit to use current defaults; [] selects none. Current choices and quantity limits are checked when saving.
|
| notify_new_reservation | Boolean | No |
Whether to notify eligible Storage Location followers.
|
Default: true. Existing recipient access and notification preferences apply.
|
| $result_format | String | No |
By default, the response is a single object. Send
array to get it inside a one-item array.
|
Allowed values:
array |
| Idempotency-Key | String | No |
A unique key for safely repeating this create request.
|
Optional HTTP header: 1–255 visible ASCII characters without spaces. Reuse it only for the same request; the replay window is 24 hours.
|
Good to know
Reserves an individual Capital Asset or a quantity of Collateral. Use an Event for Collateral or borrowed Assets. A Capital Asset in your workspace can also be reserved for another purpose, described in its notes. The response includes exhibitday_url, the record's page in ExhibitDay.
Creating the reservation
- Supply asset_type_id, asset_id and reservation_date.
- For Capital, supply return_date. For Collateral, also supply an Event, Storage Location and quantity. For Collateral, omit return_date or send JSON null when the return is unknown.
- Optionally choose Shipping Logistics, notes, markers, Optional Accessories and related-item links. Dates, quantities and these choices are saved together.
- Keep the returned typed reservation ID for future reads or changes. This request does not add files or Logistical Records.
How the Asset can be reserved
Capital Assets are individual reusable items, such as a display monitor. Collateral is tracked in quantities, such as brochures.
- Strict blocks every day of an existing Capital reservation, including checkout and return.
- Moderate permits another reservation on checkout and return days and blocks only the days between them. A one- or two-day reservation blocks no days.
- Liberal permits overlap. Collateral uses its dated inventory movements and scheduled returns. An availability check does not guarantee that a later save will succeed.
Archived or unshared Assets
A new reservation needs an Active Asset that your workspace owns or that is currently shared with it. Otherwise the request returns HTTP 409 with error_code=invalid_request and error_params lists asset_id; the message names the Asset and how to resolve it.
Choosing Optional Accessories
Optional Accessories apply only to Capital. When omitted, current selectable definitions contribute their saved default quantities. Send an explicit list to choose a different complete selection, or [] to choose none.
New selections use current choices and quantity limits. A saved default or existing historical quantity can have a specific legacy exception; it is checked against the current reservation editor rather than silently reduced.
Repeating the create safely
Use the optional Idempotency-Key header when repeating the same create request. Keep both the key and request unchanged. A replay does not make another reservation or send the followers another copy of the same notification.
Sending values and handling errors
Send notes containing commas through JSON, a query string or a form field.
An inaccessible or missing typed reservation can return HTTP 404. HTTP 409 with error_code=record_changed means the reservation or its content changed or could not be prepared safely; retrieve it again before deciding whether to retry. Other allocation or cancellation conflicts can return error_code=invalid_request. No automatic retry is performed.
History and notifications after saving
A confirmed change is recorded in history. Notifications are sent afterward to eligible Storage Location followers, subject to their existing access and preferences. Delivery or file-cleanup failure does not undo a saved reservation.
If the save outcome could not be confirmed, check the current reservation and inventory before deciding whether to repeat the action. Do not assume the server rolled it back.
Hidden or locked Assets tab
If the reservation's Event is in your workspace and its Assets tab is hidden or locked, this request returns HTTP 400 (not_allowed), and the message names the tab. Show or unlock the tab in ExhibitDay first.
curl -X POST "https://api.exhibitday.com/v1/assets/reservations" -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d "{\"asset_type_id\":1,\"asset_id\":12345,\"event_id\":12345,\"reservation_date\":\"2030-01-02\",\"return_date\":\"2030-01-04\",\"notes\":\"Equipment for the demonstration\"}"
const response = await fetch("https://api.exhibitday.com/v1/assets/reservations", {
method: "POST",
headers: { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" },
body: JSON.stringify({ "asset_type_id": 1, "asset_id": 12345, "event_id": 12345, "reservation_date": "2030-01-02", "return_date": "2030-01-04", "notes": "Equipment for the demonstration" })
});
const data = await response.json();
console.log(response.status, data);
import requests
response = requests.post(
"https://api.exhibitday.com/v1/assets/reservations",
headers={"Authorization": "Bearer YOUR_API_KEY"},
json={"asset_type_id": 1, "asset_id": 12345, "event_id": 12345, "reservation_date": "2030-01-02", "return_date": "2030-01-04", "notes": "Equipment for the demonstration"},
)
print(response.status_code, response.json())
using System;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Net.Http.Json;
using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", "YOUR_API_KEY");
var response = await client.PostAsync("https://api.exhibitday.com/v1/assets/reservations",
JsonContent.Create(new { asset_type_id = 1, asset_id = 12345, event_id = 12345, reservation_date = "2030-01-02", return_date = "2030-01-04", notes = "Equipment for the demonstration" }));
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class ExhibitDayExample {
public static void main(String[] args) throws Exception {
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.exhibitday.com/v1/assets/reservations"))
.header("Authorization", "Bearer YOUR_API_KEY")
.header("Content-Type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\"asset_type_id\":1,\"asset_id\":12345,\"event_id\":12345,\"reservation_date\":\"2030-01-02\",\"return_date\":\"2030-01-04\",\"notes\":\"Equipment for the demonstration\"}"))
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode() + " " + response.body());
}
}
<?php
$curl = curl_init('https://api.exhibitday.com/v1/assets/reservations');
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['Authorization: Bearer YOUR_API_KEY', 'Content-Type: application/json'],
CURLOPT_POSTFIELDS => '{"asset_type_id":1,"asset_id":12345,"event_id":12345,"reservation_date":"2030-01-02","return_date":"2030-01-04","notes":"Equipment for the demonstration"}',
]);
$response = curl_exec($curl);
if ($response === false) {
throw new RuntimeException(curl_error($curl));
}
echo curl_getinfo($curl, CURLINFO_HTTP_CODE) . PHP_EOL . $response;
curl_close($curl);
require 'net/http'
require 'uri'
uri = URI('https://api.exhibitday.com/v1/assets/reservations')
request = Net::HTTP::Post.new(uri)
request['Authorization'] = 'Bearer YOUR_API_KEY'
request['Content-Type'] = 'application/json'
request.body = '{"asset_type_id":1,"asset_id":12345,"event_id":12345,"reservation_date":"2030-01-02","return_date":"2030-01-04","notes":"Equipment for the demonstration"}'
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(request)
end
puts "#{response.code} #{response.body}"
package main
import (
"fmt"
"io"
"log"
"net/http"
"strings"
)
func main() {
request, err := http.NewRequest("POST", "https://api.exhibitday.com/v1/assets/reservations", strings.NewReader("{\"asset_type_id\":1,\"asset_id\":12345,\"event_id\":12345,\"reservation_date\":\"2030-01-02\",\"return_date\":\"2030-01-04\",\"notes\":\"Equipment for the demonstration\"}"))
if err != nil { log.Fatal(err) }
request.Header.Set("Authorization", "Bearer YOUR_API_KEY")
request.Header.Set("Content-Type", "application/json")
response, err := (&http.Client{}).Do(request)
if err != nil { log.Fatal(err) }
defer response.Body.Close()
body, err := io.ReadAll(response.Body)
if err != nil { log.Fatal(err) }
fmt.Printf("%d %s\n", response.StatusCode, body)
}
Example response
{
"id": 23456,
"exhibitday_url": "https://www.exhibitday.com/Workspace/Event/98765?eid=12345&riType=5&riSub=1&riId=23456",
"asset_type_id": 1,
"asset_id": 12345,
"asset_name": "Reusable display",
"is_asset_owned_by_this_workspace": true,
"event_id": 12345,
"event_name": "Annual conference",
"reservation_date": "2030-01-02",
"return_date": "2030-01-04",
"storage_location_id": null,
"storage_location_name": "",
"quantity": 1,
"quantity_adjustment": null,
"is_quantity_editable": true,
"notes": "Equipment for the demonstration",
"shipping_logistics_id": 1,
"is_flagged": false,
"is_starred": false,
"is_checked": false,
"asset_reservation_created_timestamp": "2030-01-01T12:00:00Z",
"optional_accessories": [],
"logistical_records": [],
"attachments": []
}
{
"status_code": 400,
"status": "Bad Request",
"message": "HTTP method override is not supported.",
"error_code": "invalid_request",
"errors": [
"Send the documented HTTP method directly. X-HTTP-Method-Override cannot change a request's HTTP method."
],
"error_params": [
"X-HTTP-Method-Override"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 400,
"status": "Bad Request",
"message": "This Idempotency-Key was already used with a different request. Use a new key for a new request.",
"error_code": "idempotency_key_reused",
"errors": [
"This Idempotency-Key was already used with a different request. Use a new key for a new request."
],
"error_params": [
"Idempotency-Key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 400,
"status": "Bad Request",
"message": "Invalid, repeated or inapplicable asset_type_id.",
"error_code": "invalid_request",
"errors": [
"Invalid, repeated or inapplicable asset_type_id."
],
"error_params": [
"asset_type_id"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 400,
"status": "Bad Request",
"message": "The Assets tab is hidden on this Event, so its records can't be added, changed or deleted. Show the tab in ExhibitDay before trying again.",
"error_code": "not_allowed",
"errors": [
"The Assets tab is hidden on this Event, so its records can't be added, changed or deleted. Show the tab in ExhibitDay before trying again."
],
"error_params": [
"event_id"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 400,
"status": "Bad Request",
"message": "Enter a description / purpose for this reservation.",
"error_code": "invalid_request",
"errors": [
"Enter a description / purpose for this reservation."
],
"error_params": [
"notes"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "No API key was provided. Send your key in the Authorization header as 'Bearer YOUR_API_KEY'. Alternatively, you can use the api_key parameter.",
"error_code": "missing_api_key",
"errors": [
"Copy the key from Workspace Settings > API & Integrations > API Access in ExhibitDay."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "The API key is not valid. Check that you copied the whole key from Workspace Settings > API & Integrations > API Access, then send it in the Authorization header as 'Bearer YOUR_API_KEY'. Alternatively, you can use the api_key parameter.",
"error_code": "invalid_api_key",
"errors": [
"Check that you sent the whole key. If it was regenerated, use the current key from Workspace Settings > API & Integrations > API Access."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "Access to the ExhibitDay API is not enabled for your workspace. Please contact support@exhibitday.com to enable API Access. Once access is enabled, send your key in the Authorization header as 'Bearer YOUR_API_KEY'.",
"error_code": "api_access_disabled",
"errors": [
"Nothing was read or changed."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "The API key is not valid for this request. Send your current key in the Authorization header as 'Bearer YOUR_API_KEY'.",
"error_code": "invalid_api_key",
"errors": [
"The API key is not valid for this request. Send your current key in the Authorization header as 'Bearer YOUR_API_KEY'."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "Access to the ExhibitDay API is not enabled for your workspace. Please contact support@exhibitday.com to enable API Access. Once access is enabled, send your key in the Authorization header as 'Bearer YOUR_API_KEY'.",
"error_code": "api_access_disabled",
"errors": [
"Access to the ExhibitDay API is not enabled for your workspace. Please contact support@exhibitday.com to enable API Access. Once access is enabled, send your key in the Authorization header as 'Bearer YOUR_API_KEY'."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 404,
"status": "Not Found",
"message": "Asset or Event not found. Use an Asset ID from GET /v1/assets and, when you send event_id, an Event ID from GET /v1/events.",
"error_code": "not_found",
"errors": [
"Asset or Event not found. Use an Asset ID from GET /v1/assets and, when you send event_id, an Event ID from GET /v1/events."
],
"error_params": [
"asset_id"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "A request with this Idempotency-Key is still being processed. Retry after a moment.",
"error_code": "idempotency_key_in_use",
"errors": [
"A request with this Idempotency-Key is still being processed. Retry after a moment."
],
"error_params": [
"Idempotency-Key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "A previous request with this Idempotency-Key did not finish and its outcome is unknown, so this retry was not run to avoid creating a duplicate. Check whether the earlier request succeeded; to try again, use a new Idempotency-Key.",
"error_code": "idempotency_key_indeterminate",
"errors": [
"A previous request with this Idempotency-Key did not finish and its outcome is unknown, so this retry was not run to avoid creating a duplicate. Check whether the earlier request succeeded; to try again, use a new Idempotency-Key."
],
"error_params": [
"Idempotency-Key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "The saved response cannot be replayed safely.",
"error_code": "idempotency_key_indeterminate",
"errors": [
"The earlier request with this Idempotency-Key completed, but its saved response cannot be returned safely. This retry was not run and its key was not released. Look for the existing record with a GET; use a new Idempotency-Key only after checking whether another create is needed."
],
"error_params": [
"Idempotency-Key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "The reservation or its content changed while the request was being prepared or saved. Read it again before deciding whether to retry; nothing was changed.",
"error_code": "record_changed",
"errors": [
"The reservation or its content changed while the request was being prepared or saved. Read it again before deciding whether to retry; nothing was changed."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "Display stand is archived, so it can't be reserved. Unarchive it in ExhibitDay, or choose an Active Asset.",
"error_code": "invalid_request",
"errors": [
"Display stand is archived, so it can't be reserved. Unarchive it in ExhibitDay, or choose an Active Asset."
],
"error_params": [
"asset_id"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 429,
"status": "Too Many Requests",
"message": "Error 429 - Too Many Requests",
"error_code": "rate_limited",
"errors": [
"Error 429 - Too Many Requests"
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"An unexpected error occurred. Please try again later."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"The reservation save outcome could not be confirmed. Review the current reservation and inventory before deciding whether to retry; the API did not repeat the action."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"An unexpected error occurred. Please try again later."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"Check whether your change was saved before trying again."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
Update an Asset Reservation #
|
Updates an existing Asset reservation.
| Name | Type | Required? | Description | Details |
|---|---|---|---|---|
| asset_type_id | Number | Yes |
The reservation's Asset type. Capital tracks one item; Collateral tracks quantities. Supply the type even when you know the reservation ID.
|
Allowed values:
1 (Capital) | 2 (Collateral) |
| id | Number | Yes |
The reservation’s ID.
|
Use the ID for the selected Asset type. A manual Collateral inventory adjustment is not a reservation. The Asset and current Event are derived automatically.
|
| new_event_id | Number | No |
A new Event for this reservation, or null for Other Purpose.
|
Only for an Asset in your workspace. The current Event is derived automatically. Capital may use null to become Other Purpose, with nonblank purpose notes. Collateral must remain with an Event.
|
| reservation_date | Date | No |
A replacement checkout date.
|
YYYY-MM-DD. Omit to keep it. Resending the same calendar date preserves an older saved time of day.
|
| return_date | Date | No |
The reservation’s return date.
|
YYYY-MM-DD, on or after checkout. Capital cannot clear it. Collateral can use null to remove its scheduled return.
|
| storage_location_id | Number | No |
The Storage Location from which to reserve Collateral.
|
Collateral only. A changed location must belong to the Asset’s owner.
|
| quantity | Number | No |
The quantity of Collateral to reserve.
|
Collateral only. A whole number from 1 through 2,147,483,647. This replaces the reserved quantity.
|
| shipping_logistics_id | Number | No |
The Shipping Logistics choice. Omit to keep the current choice.
|
Allowed values:
1 (Unspecified) | 2 (Advance Warehouse) | 3 (Direct Shipment) | 4 (Other) |
| notes | String | No |
Reservation Notes, or the description of an Other Purpose reservation.
|
Plain text, up to 1,000 characters. HTML tags are removed and line breaks are preserved. If older notes are already longer, their current length remains the maximum. Send null to clear notes unless the reservation requires a purpose.
|
| is_flagged | Boolean | No |
Whether to flag this reservation.
|
Boolean. Omit to keep the current value.
|
| is_starred | Boolean | No |
Whether to star this reservation.
|
Boolean. Omit to keep the current value.
|
| is_checked | Boolean | No |
Whether to mark this reservation as checked.
|
Boolean. Omit to keep the current value.
|
| optional_accessories | JSON object/list | No |
The complete Optional Accessory selection for a Capital reservation.
View value format and limitsFile uploads use multipart form data. Other structured values use a JSON object or array; form/query values use JSON text.
|
Capital only. Send a JSON array such as [{"optional_accessory_id":12345,"quantity":1}]. IDs must be unique and quantities whole numbers of zero or more. Zero leaves that accessory unselected. Omit to keep the selection; [] clears it. Null is refused. Current choices and quantity limits are checked when saving.
|
| notify_reservation_update | Boolean | No |
Whether to notify eligible followers about a meaningful reservation change.
|
Default: true. Dates, Event, notes, quantity or location changes can send mail. Marker, Optional Accessory, Shipping Logistics or formatting-only changes do not.
|
| expected_revision | String | No |
The record_revision from the reservation's Info response. Include it to avoid overwriting changes to that reservation or its Logistical Records. Omit it to skip this check.
|
Optional. Blank, null, malformed or conflicting copies are refused with HTTP 400. A stale revision returns HTTP 409 with error_code=record_changed.
|
| $ignore_params_with_empty_values | Boolean | No |
Whether to ignore empty values instead of applying their empty-value meaning.
|
Default: false. True omits real JSON null and blank values. The text "null" still asks to clear an applicable clearable field. This does not hide invalid IDs or expected_revision.
|
Good to know
Changes a reservation’s dates, quantity, location, notes, markers, Optional Accessories or related-item links. Supply its Asset type and reservation ID; its Asset and current Event are found automatically. Send only the values you intend to change.
Keeping, changing and clearing values
Omitted and blank values keep the saved values. A blank value can add an empty-field warning. Real JSON null or the text "null" clears only an applicable clearable field: notes, a Collateral return date, or a Capital new_event_id.
With $ignore_params_with_empty_values=true, a real JSON null is omitted; the text "null" still asks to clear. Use [] to clear Optional Accessories; null is refused. Inapplicable fields are refused even if they are null or would otherwise be ignored.
A true no-op preserves the saved dates, formatting, revision and history. A supplied Optional Accessory list replaces the previous selection. Related add/remove lists change links only.
Dates, quantities and Storage Locations
Capital needs a known return date. For Collateral, omission keeps the saved return date and JSON null makes the return unknown, removing its scheduled return.
When a reservation or return date is supplied, the resulting date range must be in order. An unrelated edit can retain a legacy reversed Capital period. Resending the same calendar date preserves its saved time of day.
A changed Collateral location must belong to the Asset’s owner. Quantity is the replacement reservation quantity, never a signed inventory adjustment.
Archived or unshared Assets
While an Asset is Archived, or after its owner stops sharing it with your workspace, an existing reservation can’t be moved to another Event, and its return date can’t be moved later to today or a future date. Making a Collateral return date unknown also counts as an extension. The request returns HTTP 409 with error_code=invalid_request; error_params names new_event_id or return_date, and the message names the Asset and how to resolve it.
Edits that don’t extend the hold remain available: notes and other fields, a different reservation date with the same return date, an earlier return date, and corrections that stay in the past. "Today" uses your workspace’s time zone.
Moving to another Event or Other Purpose
Use new_event_id to request a move for an Asset in your workspace. Do not supply the previous Event as another selector. The API checks the current and target content access and preserves historical file permissions.
Only Capital can become Other Purpose by clearing new_event_id; its notes must explain the purpose. Protected Event content, Logistical Records, related links or files can prevent a move. A borrowed reservation does not gain a new move or content grant.
Access to the reservation and its Event
The typed reservation ID determines its Asset and current Event. Do not send a separate Asset ID or Event ID to select an existing reservation. A change in that binding while the request is being prepared is refused.
An existing reservation can remain accessible after sharing ends. The current access and locks still apply. Being able to edit dates or quantities for an Asset does not grant access to another workspace’s private Event notes, related items, files or Logistical Records.
Event moves, notes and related-item edits need the corresponding current Event content access. Protected saved content or historical file permissions can prevent a move or cancellation, even when an ordinary scalar edit remains available.
How the Asset can be reserved
Capital Assets are individual reusable items, such as a display monitor. Collateral is tracked in quantities, such as brochures.
- Strict blocks every day of an existing Capital reservation, including checkout and return.
- Moderate permits another reservation on checkout and return days and blocks only the days between them. A one- or two-day reservation blocks no days.
- Liberal permits overlap. Collateral uses its dated inventory movements and scheduled returns. An availability check does not guarantee that a later save will succeed.
Checking for another change
The revision covers the complete reservation fields, Optional Accessory selections, Logistical Records, note formatting saved in ExhibitDay and related-item links. It does not cover attachment metadata or file contents; their permissions and safe handling are checked separately.
- Retrieve
/v1/assets/reservations/infowith asset_type_id, id and $include_record_revision=true. - Send the returned record_revision as expected_revision with this request. Treat it as an opaque value.
- After HTTP 409 record_changed, retrieve the reservation, review it and decide whether to send the request again.
Receiving the result
The response is a status object. It contains record_revision only when expected_revision was sent. The Idempotency-Key header is ignored for this PATCH; use expected_revision for the optional change check.
Sending values and handling errors
Send notes containing commas through JSON, a query string or a form field.
An inaccessible or missing typed reservation can return HTTP 404. HTTP 409 with error_code=record_changed means the reservation or its content changed or could not be prepared safely; retrieve it again before deciding whether to retry. Other allocation or cancellation conflicts can return error_code=invalid_request. No automatic retry is performed.
History and notifications after saving
A confirmed change is recorded in history. Notifications are sent afterward to eligible Storage Location followers, subject to their existing access and preferences. Delivery or file-cleanup failure does not undo a saved reservation.
If the save outcome could not be confirmed, check the current reservation and inventory before deciding whether to repeat the action. Do not assume the server rolled it back.
Hidden or locked Assets tab
If the reservation's Event is in your workspace and its Assets tab is hidden or locked, this request returns HTTP 400 (not_allowed), and the message names the tab. Show or unlock the tab in ExhibitDay first.
curl -X PATCH "https://api.exhibitday.com/v1/assets/reservations" -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d "{\"asset_type_id\":1,\"id\":12345,\"is_checked\":true}"
const response = await fetch("https://api.exhibitday.com/v1/assets/reservations", {
method: "PATCH",
headers: { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" },
body: JSON.stringify({ "asset_type_id": 1, "id": 12345, "is_checked": true })
});
const data = await response.json();
console.log(response.status, data);
import requests
response = requests.patch(
"https://api.exhibitday.com/v1/assets/reservations",
headers={"Authorization": "Bearer YOUR_API_KEY"},
json={"asset_type_id": 1, "id": 12345, "is_checked": True},
)
print(response.status_code, response.json())
using System;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Net.Http.Json;
using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", "YOUR_API_KEY");
var response = await client.PatchAsync("https://api.exhibitday.com/v1/assets/reservations",
JsonContent.Create(new { asset_type_id = 1, id = 12345, is_checked = true }));
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class ExhibitDayExample {
public static void main(String[] args) throws Exception {
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.exhibitday.com/v1/assets/reservations"))
.header("Authorization", "Bearer YOUR_API_KEY")
.header("Content-Type", "application/json")
.method("PATCH", HttpRequest.BodyPublishers.ofString("{\"asset_type_id\":1,\"id\":12345,\"is_checked\":true}"))
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode() + " " + response.body());
}
}
<?php
$curl = curl_init('https://api.exhibitday.com/v1/assets/reservations');
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'PATCH',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['Authorization: Bearer YOUR_API_KEY', 'Content-Type: application/json'],
CURLOPT_POSTFIELDS => '{"asset_type_id":1,"id":12345,"is_checked":true}',
]);
$response = curl_exec($curl);
if ($response === false) {
throw new RuntimeException(curl_error($curl));
}
echo curl_getinfo($curl, CURLINFO_HTTP_CODE) . PHP_EOL . $response;
curl_close($curl);
require 'net/http'
require 'uri'
uri = URI('https://api.exhibitday.com/v1/assets/reservations')
request = Net::HTTP::Patch.new(uri)
request['Authorization'] = 'Bearer YOUR_API_KEY'
request['Content-Type'] = 'application/json'
request.body = '{"asset_type_id":1,"id":12345,"is_checked":true}'
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(request)
end
puts "#{response.code} #{response.body}"
package main
import (
"fmt"
"io"
"log"
"net/http"
"strings"
)
func main() {
request, err := http.NewRequest("PATCH", "https://api.exhibitday.com/v1/assets/reservations", strings.NewReader("{\"asset_type_id\":1,\"id\":12345,\"is_checked\":true}"))
if err != nil { log.Fatal(err) }
request.Header.Set("Authorization", "Bearer YOUR_API_KEY")
request.Header.Set("Content-Type", "application/json")
response, err := (&http.Client{}).Do(request)
if err != nil { log.Fatal(err) }
defer response.Body.Close()
body, err := io.ReadAll(response.Body)
if err != nil { log.Fatal(err) }
fmt.Printf("%d %s\n", response.StatusCode, body)
}
Example response
{
"status_code": 200,
"status": "OK",
"message": "Asset Reservation updated.",
"errors": []
}
{
"status_code": 400,
"status": "Bad Request",
"message": "HTTP method override is not supported.",
"error_code": "invalid_request",
"errors": [
"Send the documented HTTP method directly. X-HTTP-Method-Override cannot change a request's HTTP method."
],
"error_params": [
"X-HTTP-Method-Override"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 400,
"status": "Bad Request",
"message": "Invalid, repeated or inapplicable asset_type_id.",
"error_code": "invalid_request",
"errors": [
"Invalid, repeated or inapplicable asset_type_id."
],
"error_params": [
"asset_type_id"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 400,
"status": "Bad Request",
"message": "The Assets tab is hidden on this Event, so its records can't be added, changed or deleted. Show the tab in ExhibitDay before trying again.",
"error_code": "not_allowed",
"errors": [
"The Assets tab is hidden on this Event, so its records can't be added, changed or deleted. Show the tab in ExhibitDay before trying again."
],
"error_params": [
"event_id"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 400,
"status": "Bad Request",
"message": "This reservation's Event belongs to another workspace, so you cannot move it with new_event_id or change its notes or related items.",
"error_code": "invalid_request",
"errors": [
"This reservation's Event belongs to another workspace, so you cannot move it with new_event_id or change its notes or related items."
],
"error_params": [
"new_event_id"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "No API key was provided. Send your key in the Authorization header as 'Bearer YOUR_API_KEY'. Alternatively, you can use the api_key parameter.",
"error_code": "missing_api_key",
"errors": [
"Copy the key from Workspace Settings > API & Integrations > API Access in ExhibitDay."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "The API key is not valid. Check that you copied the whole key from Workspace Settings > API & Integrations > API Access, then send it in the Authorization header as 'Bearer YOUR_API_KEY'. Alternatively, you can use the api_key parameter.",
"error_code": "invalid_api_key",
"errors": [
"Check that you sent the whole key. If it was regenerated, use the current key from Workspace Settings > API & Integrations > API Access."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "Access to the ExhibitDay API is not enabled for your workspace. Please contact support@exhibitday.com to enable API Access. Once access is enabled, send your key in the Authorization header as 'Bearer YOUR_API_KEY'.",
"error_code": "api_access_disabled",
"errors": [
"Nothing was read or changed."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "The API key is not valid for this request. Send your current key in the Authorization header as 'Bearer YOUR_API_KEY'.",
"error_code": "invalid_api_key",
"errors": [
"The API key is not valid for this request. Send your current key in the Authorization header as 'Bearer YOUR_API_KEY'."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "Access to the ExhibitDay API is not enabled for your workspace. Please contact support@exhibitday.com to enable API Access. Once access is enabled, send your key in the Authorization header as 'Bearer YOUR_API_KEY'.",
"error_code": "api_access_disabled",
"errors": [
"Access to the ExhibitDay API is not enabled for your workspace. Please contact support@exhibitday.com to enable API Access. Once access is enabled, send your key in the Authorization header as 'Bearer YOUR_API_KEY'."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 404,
"status": "Not Found",
"message": "Asset Reservation not found. Invalid Asset Reservation ID: 12345.",
"error_code": "not_found",
"errors": [
"Asset Reservation not found. Invalid Asset Reservation ID: 12345."
],
"error_params": [
"id"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "The reservation or its content changed while the request was being prepared or saved. Read it again before deciding whether to retry; nothing was changed.",
"error_code": "record_changed",
"errors": [
"The reservation or its content changed while the request was being prepared or saved. Read it again before deciding whether to retry; nothing was changed."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "This reservation changed since you read it. Read it again before retrying; nothing was changed.",
"error_code": "record_changed",
"errors": [
"This reservation changed since you read it. Read it again before retrying; nothing was changed."
],
"error_params": [
"expected_revision"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "Display stand is archived, so it can't be reserved for future dates or moved to another Event. Unarchive it in ExhibitDay to extend or move this reservation, or keep the reservation's current Event and return date.",
"error_code": "invalid_request",
"errors": [
"Display stand is archived, so it can't be reserved for future dates or moved to another Event. Unarchive it in ExhibitDay to extend or move this reservation, or keep the reservation's current Event and return date."
],
"error_params": [
"new_event_id"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "Display stand is no longer shared with your workspace, so this reservation can't be extended or moved. Ask the owner workspace to share it again, or keep the reservation's current Event and return date.",
"error_code": "invalid_request",
"errors": [
"Display stand is no longer shared with your workspace, so this reservation can't be extended or moved. Ask the owner workspace to share it again, or keep the reservation's current Event and return date."
],
"error_params": [
"return_date"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 429,
"status": "Too Many Requests",
"message": "Error 429 - Too Many Requests",
"error_code": "rate_limited",
"errors": [
"Error 429 - Too Many Requests"
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"An unexpected error occurred. Please try again later."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"The reservation save outcome could not be confirmed. Review the current reservation and inventory before deciding whether to retry; the API did not repeat the action."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"An unexpected error occurred. Please try again later."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"Check whether your change was saved before trying again."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
Retrieve Reservation Cancellation Options #
|
Shows what cancelling an Asset reservation would do to its inventory.
Note: Inputs that do not apply to this operation, including the ignore-empty option, are ignored and reported in the X-API-Warnings response header.
| Name | Type | Required? | Description | Details |
|---|---|---|---|---|
| asset_type_id | Number | Yes |
The reservation's Asset type. Capital tracks one item; Collateral tracks quantities. Supply the type even when you know the reservation ID.
|
Allowed values:
1 (Capital) | 2 (Collateral) |
| id | Number | Yes |
The reservation’s ID.
|
Use the ID for the selected Asset type. A manual Collateral inventory adjustment is not a reservation. The Asset and current Event are derived automatically.
|
| If-None-Match | String | No |
An ETag from an earlier response to this GET.
|
Optional HTTP header. A matching successful response returns HTTP 304 with no body.
|
Good to know
Shows what cancelling this reservation would do to its inventory today. Review the available choices, their effects and eligible return locations before you cancel. The reservation’s Asset and current Event are derived from its typed ID.
Reviewing the available choices
- Supply asset_type_id and id.
- Read can_cancel, suggested_inventory_outcome, has_suggested_outcome, requires_explicit_inventory_outcome and the returned inventory_outcomes and their effects. Older rows can represent recorded history rather than a future allocation.
- If the automatic suggestion is unavailable, choose a safe explicit alternative only from the returned choices. Do not assume another outcome will be substituted.
- For a RecordReturn choice, use an eligible receiving location from this response and supply the actual returned quantity and date when cancelling.
What this review means
Only choices this workspace key can currently complete are listed. A choice that would retain, clear or copy protected notes, Logistical Records or attachments can be unavailable, while another safe cancellation outcome remains possible.
An Other Purpose Capital reservation is removed directly; it has no Event inventory outcome to choose. This GET changes nothing and sends no notifications.
These options are advice, not a hold on the choice. Cancellation checks the current reservation, inventory, permissions and content again. This response provides no edit revision. Use GET /v1/assets/reservations/info with $include_record_revision=true before a conditional cancellation.
Access to the reservation and its Event
The typed reservation ID determines its Asset and current Event. Do not send a separate Asset ID or Event ID to select an existing reservation. A change in that binding while the request is being prepared is refused.
An existing reservation can remain accessible after sharing ends. The current access and locks still apply. Being able to edit dates or quantities for an Asset does not grant access to another workspace’s private Event notes, related items, files or Logistical Records.
Event moves, notes and related-item edits need the corresponding current Event content access. Protected saved content or historical file permissions can prevent a move or cancellation, even when an ordinary scalar edit remains available.
Sending values and handling errors
Send notes containing commas through JSON, a query string or a form field.
An inaccessible or missing typed reservation can return HTTP 404. HTTP 409 with error_code=record_changed means the reservation or its content changed or could not be prepared safely; retrieve it again before deciding whether to retry. Other allocation or cancellation conflicts can return error_code=invalid_request. No automatic retry is performed.
curl -X GET "https://api.exhibitday.com/v1/assets/reservation_cancellation_inventory_options?asset_type_id=1&id=12345" -H "Authorization: Bearer YOUR_API_KEY"
const response = await fetch("https://api.exhibitday.com/v1/assets/reservation_cancellation_inventory_options?" + new URLSearchParams({ "asset_type_id": "1", "id": "12345" }), {
method: "GET",
headers: { "Authorization": "Bearer YOUR_API_KEY" }
});
const data = await response.json();
console.log(response.status, data);
import requests
response = requests.get(
"https://api.exhibitday.com/v1/assets/reservation_cancellation_inventory_options",
headers={"Authorization": "Bearer YOUR_API_KEY"},
params={"asset_type_id": 1, "id": 12345},
)
print(response.status_code, response.json())
using System;
using System.Net.Http;
using System.Net.Http.Headers;
using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", "YOUR_API_KEY");
var response = await client.GetAsync("https://api.exhibitday.com/v1/assets/reservation_cancellation_inventory_options?asset_type_id=1&id=12345");
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class ExhibitDayExample {
public static void main(String[] args) throws Exception {
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.exhibitday.com/v1/assets/reservation_cancellation_inventory_options?asset_type_id=1&id=12345"))
.header("Authorization", "Bearer YOUR_API_KEY")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode() + " " + response.body());
}
}
<?php
$curl = curl_init('https://api.exhibitday.com/v1/assets/reservation_cancellation_inventory_options?asset_type_id=1&id=12345');
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['Authorization: Bearer YOUR_API_KEY'],
]);
$response = curl_exec($curl);
if ($response === false) {
throw new RuntimeException(curl_error($curl));
}
echo curl_getinfo($curl, CURLINFO_HTTP_CODE) . PHP_EOL . $response;
curl_close($curl);
require 'net/http'
require 'uri'
uri = URI('https://api.exhibitday.com/v1/assets/reservation_cancellation_inventory_options?asset_type_id=1&id=12345')
request = Net::HTTP::Get.new(uri)
request['Authorization'] = 'Bearer YOUR_API_KEY'
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(request)
end
puts "#{response.code} #{response.body}"
package main
import (
"fmt"
"io"
"log"
"net/http"
)
func main() {
request, err := http.NewRequest("GET", "https://api.exhibitday.com/v1/assets/reservation_cancellation_inventory_options?asset_type_id=1&id=12345", nil)
if err != nil { log.Fatal(err) }
request.Header.Set("Authorization", "Bearer YOUR_API_KEY")
response, err := (&http.Client{}).Do(request)
if err != nil { log.Fatal(err) }
defer response.Body.Close()
body, err := io.ReadAll(response.Body)
if err != nil { log.Fatal(err) }
fmt.Printf("%d %s\n", response.StatusCode, body)
}
Example response
{
"asset_type_id": 1,
"asset_id": 12345,
"reservation_id": 12345,
"is_event_reservation": true,
"can_cancel": true,
"can_choose_inventory_outcome": true,
"is_recorded_history": false,
"suggested_inventory_outcome": "UndoOriginal",
"has_suggested_outcome": true,
"requires_explicit_inventory_outcome": false,
"unavailable_message": "",
"inventory_outcomes": [
{
"value": "UndoOriginal",
"label": "Undo Reservation (as if it never took place)",
"effect": "The recorded check-out/return of this asset will be removed from inventory records"
},
{
"value": "KeepCapital",
"label": "Unlink reservation from this event, but keep the asset reserved",
"effect": "The asset will remain reserved for the original reservation period, but the reservation will no longer be tied to this event."
}
],
"can_record_return": false,
"suggested_return_quantity": null,
"suggested_return_date": "",
"suggested_receiving_storage_location_id": null,
"receiving_storage_locations": []
}
{
"status_code": 400,
"status": "Bad Request",
"message": "HTTP method override is not supported.",
"error_code": "invalid_request",
"errors": [
"Send the documented HTTP method directly. X-HTTP-Method-Override cannot change a request's HTTP method."
],
"error_params": [
"X-HTTP-Method-Override"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 400,
"status": "Bad Request",
"message": "Invalid, repeated or inapplicable asset_type_id.",
"error_code": "invalid_request",
"errors": [
"Invalid, repeated or inapplicable asset_type_id."
],
"error_params": [
"asset_type_id"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "No API key was provided. Send your key in the Authorization header as 'Bearer YOUR_API_KEY'. Alternatively, you can use the api_key parameter.",
"error_code": "missing_api_key",
"errors": [
"Copy the key from Workspace Settings > API & Integrations > API Access in ExhibitDay."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "The API key is not valid. Check that you copied the whole key from Workspace Settings > API & Integrations > API Access, then send it in the Authorization header as 'Bearer YOUR_API_KEY'. Alternatively, you can use the api_key parameter.",
"error_code": "invalid_api_key",
"errors": [
"Check that you sent the whole key. If it was regenerated, use the current key from Workspace Settings > API & Integrations > API Access."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "Access to the ExhibitDay API is not enabled for your workspace. Please contact support@exhibitday.com to enable API Access. Once access is enabled, send your key in the Authorization header as 'Bearer YOUR_API_KEY'.",
"error_code": "api_access_disabled",
"errors": [
"Nothing was read or changed."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "The API key is not valid for this request. Send your current key in the Authorization header as 'Bearer YOUR_API_KEY'.",
"error_code": "invalid_api_key",
"errors": [
"The API key is not valid for this request. Send your current key in the Authorization header as 'Bearer YOUR_API_KEY'."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "Access to the ExhibitDay API is not enabled for your workspace. Please contact support@exhibitday.com to enable API Access. Once access is enabled, send your key in the Authorization header as 'Bearer YOUR_API_KEY'.",
"error_code": "api_access_disabled",
"errors": [
"Access to the ExhibitDay API is not enabled for your workspace. Please contact support@exhibitday.com to enable API Access. Once access is enabled, send your key in the Authorization header as 'Bearer YOUR_API_KEY'."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 404,
"status": "Not Found",
"message": "Asset Reservation not found. Invalid Asset Reservation ID: 12345.",
"error_code": "not_found",
"errors": [
"Asset Reservation not found. Invalid Asset Reservation ID: 12345."
],
"error_params": [
"id"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "The reservation or its content changed while the request was being prepared or saved. Read it again before deciding whether to retry; nothing was changed.",
"error_code": "record_changed",
"errors": [
"The reservation or its content changed while the request was being prepared or saved. Read it again before deciding whether to retry; nothing was changed."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 429,
"status": "Too Many Requests",
"message": "Error 429 - Too Many Requests",
"error_code": "rate_limited",
"errors": [
"Error 429 - Too Many Requests"
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"An unexpected error occurred. Please try again later."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"An unexpected error occurred. Please try again later."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"Check whether your change was saved before trying again."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
Cancel an Asset Reservation #
|
Cancels an Asset reservation.
Note: Inputs that do not apply to this operation, including the ignore-empty option, are ignored and reported in the X-API-Warnings response header.
| Name | Type | Required? | Description | Details |
|---|---|---|---|---|
| asset_type_id | Number | Yes |
The reservation's Asset type. Capital tracks one item; Collateral tracks quantities. Supply the type even when you know the reservation ID.
|
Allowed values:
1 (Capital) | 2 (Collateral) |
| id | Number | Yes |
The reservation’s ID.
|
Use the ID for the selected Asset type. A manual Collateral inventory adjustment is not a reservation. The Asset and current Event are derived automatically.
|
| inventory_outcome | String | No |
The exact outcome value to apply from the current options response.
|
Case-sensitive. Omit for ExhibitDay’s current automatic choice. An unavailable automatic choice is refused, without fallback. Do not supply this for Other Purpose Capital.
|
| return_quantity | Number | When inventory_outcome=RecordReturn |
The quantity actually returned.
|
A positive whole number, up to the original quantity and 2,147,483,647. Supply all three return fields together.
|
| return_date | Date | When inventory_outcome=RecordReturn |
The actual return date.
|
YYYY-MM-DD, on or after checkout.
|
| receiving_storage_location_id | Number | When inventory_outcome=RecordReturn |
The Storage Location receiving the return.
|
Choose an eligible location from the current options response; it belongs to the Asset’s owner.
|
| notify_reservation_cancellation | Boolean | No |
Whether to notify eligible followers of the affected locations.
|
Default: true. Recipient access and notification preferences still apply.
|
| expected_revision | String | No |
The record_revision from the reservation's Info response. Include it to avoid overwriting changes to that reservation or its Logistical Records. Omit it to skip this check.
|
Optional. Blank, null, malformed or conflicting copies are refused with HTTP 400. A stale revision returns HTTP 409 with error_code=record_changed.
|
Good to know
Cancels a reservation using its current inventory rules. Depending on the available outcome, this can undo an allocation, keep a Capital reservation as Other Purpose, or preserve Collateral use and record a return. It does not delete the Asset.
Choosing how to cancel
- Review
/v1/assets/reservation_cancellation_inventory_optionswith the typed reservation ID. - Omit inventory_outcome only when you intend to use the current automatic choice. Otherwise send an exact value from the returned choices.
- With RecordReturn, send return_quantity, return_date and receiving_storage_location_id together. Do not send those fields with another outcome.
- Optionally supply expected_revision from reservation Info, then submit the cancellation.
Automatic and explicit outcomes
- An older reservation may be recorded history that should be preserved rather than undone. Read the returned effect before choosing.
- If the automatic outcome cannot safely preserve or handle the current content, the API refuses it. It does not silently choose a different result; review the options for a safe explicit alternative.
- An Other Purpose Capital reservation is removed directly. Omit inventory_outcome and all return fields.
Access to the reservation and its Event
The typed reservation ID determines its Asset and current Event. Do not send a separate Asset ID or Event ID to select an existing reservation. A change in that binding while the request is being prepared is refused.
An existing reservation can remain accessible after sharing ends. The current access and locks still apply. Being able to edit dates or quantities for an Asset does not grant access to another workspace’s private Event notes, related items, files or Logistical Records.
Event moves, notes and related-item edits need the corresponding current Event content access. Protected saved content or historical file permissions can prevent a move or cancellation, even when an ordinary scalar edit remains available.
Checking for another change
The revision covers the complete reservation fields, Optional Accessory selections, Logistical Records, note formatting saved in ExhibitDay and related-item links. It does not cover attachment metadata or file contents; their permissions and safe handling are checked separately.
- Retrieve
/v1/assets/reservations/infowith asset_type_id, id and $include_record_revision=true. - Send the returned record_revision as expected_revision with this request. Treat it as an opaque value.
- After HTTP 409 record_changed, retrieve the reservation, review it and decide whether to send the request again.
Receiving the result and handling retained records
The response is a status object. With expected_revision, a new revision is returned only when your Capital reservation remains readable afterward. Removed or converted records, and borrowed reservations that leave their readable context, have no replacement token.
Associated files and saved content follow the chosen outcome and their original permissions. Confirmed pointer changes can be followed by best-effort cleanup; a cleanup or notification failure does not undo the cancellation.
Do not send Idempotency-Key: cancellation rejects it and does not automatically repeat the action. Inspect the current reservation and inventory after an uncertain outcome before deciding what to do.
Sending values and handling errors
Send notes containing commas through JSON, a query string or a form field.
An inaccessible or missing typed reservation can return HTTP 404. HTTP 409 with error_code=record_changed means the reservation or its content changed or could not be prepared safely; retrieve it again before deciding whether to retry. Other allocation or cancellation conflicts can return error_code=invalid_request. No automatic retry is performed.
History and notifications after saving
A confirmed change is recorded in history. Notifications are sent afterward to eligible Storage Location followers, subject to their existing access and preferences. Delivery or file-cleanup failure does not undo a saved reservation.
If the save outcome could not be confirmed, check the current reservation and inventory before deciding whether to repeat the action. Do not assume the server rolled it back.
curl -X POST "https://api.exhibitday.com/v1/assets/cancel_reservation" -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d "{\"asset_type_id\":1,\"id\":12345}"
const response = await fetch("https://api.exhibitday.com/v1/assets/cancel_reservation", {
method: "POST",
headers: { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" },
body: JSON.stringify({ "asset_type_id": 1, "id": 12345 })
});
const data = await response.json();
console.log(response.status, data);
import requests
response = requests.post(
"https://api.exhibitday.com/v1/assets/cancel_reservation",
headers={"Authorization": "Bearer YOUR_API_KEY"},
json={"asset_type_id": 1, "id": 12345},
)
print(response.status_code, response.json())
using System;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Net.Http.Json;
using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", "YOUR_API_KEY");
var response = await client.PostAsync("https://api.exhibitday.com/v1/assets/cancel_reservation",
JsonContent.Create(new { asset_type_id = 1, id = 12345 }));
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class ExhibitDayExample {
public static void main(String[] args) throws Exception {
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.exhibitday.com/v1/assets/cancel_reservation"))
.header("Authorization", "Bearer YOUR_API_KEY")
.header("Content-Type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\"asset_type_id\":1,\"id\":12345}"))
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode() + " " + response.body());
}
}
<?php
$curl = curl_init('https://api.exhibitday.com/v1/assets/cancel_reservation');
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['Authorization: Bearer YOUR_API_KEY', 'Content-Type: application/json'],
CURLOPT_POSTFIELDS => '{"asset_type_id":1,"id":12345}',
]);
$response = curl_exec($curl);
if ($response === false) {
throw new RuntimeException(curl_error($curl));
}
echo curl_getinfo($curl, CURLINFO_HTTP_CODE) . PHP_EOL . $response;
curl_close($curl);
require 'net/http'
require 'uri'
uri = URI('https://api.exhibitday.com/v1/assets/cancel_reservation')
request = Net::HTTP::Post.new(uri)
request['Authorization'] = 'Bearer YOUR_API_KEY'
request['Content-Type'] = 'application/json'
request.body = '{"asset_type_id":1,"id":12345}'
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(request)
end
puts "#{response.code} #{response.body}"
package main
import (
"fmt"
"io"
"log"
"net/http"
"strings"
)
func main() {
request, err := http.NewRequest("POST", "https://api.exhibitday.com/v1/assets/cancel_reservation", strings.NewReader("{\"asset_type_id\":1,\"id\":12345}"))
if err != nil { log.Fatal(err) }
request.Header.Set("Authorization", "Bearer YOUR_API_KEY")
request.Header.Set("Content-Type", "application/json")
response, err := (&http.Client{}).Do(request)
if err != nil { log.Fatal(err) }
defer response.Body.Close()
body, err := io.ReadAll(response.Body)
if err != nil { log.Fatal(err) }
fmt.Printf("%d %s\n", response.StatusCode, body)
}
Example response
{
"status_code": 200,
"status": "OK",
"message": "Asset Reservation canceled.",
"errors": []
}
{
"status_code": 400,
"status": "Bad Request",
"message": "HTTP method override is not supported.",
"error_code": "invalid_request",
"errors": [
"Send the documented HTTP method directly. X-HTTP-Method-Override cannot change a request's HTTP method."
],
"error_params": [
"X-HTTP-Method-Override"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 400,
"status": "Bad Request",
"message": "Invalid, repeated or inapplicable asset_type_id.",
"error_code": "invalid_request",
"errors": [
"Invalid, repeated or inapplicable asset_type_id."
],
"error_params": [
"asset_type_id"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 400,
"status": "Bad Request",
"message": "Invalid, repeated or inapplicable inventory_outcome.",
"error_code": "invalid_request",
"errors": [
"Invalid, repeated or inapplicable inventory_outcome."
],
"error_params": [
"inventory_outcome"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 400,
"status": "Bad Request",
"message": "Unable to cancel the reservation. Invalid Storage Location ID in receiving_storage_location_id. Use the ID of a Storage Location listed under receiving_storage_locations by /v1/assets/reservation_cancellation_inventory_options.",
"error_code": "invalid_request",
"errors": [
"Unable to cancel the reservation. Invalid Storage Location ID in receiving_storage_location_id. Use the ID of a Storage Location listed under receiving_storage_locations by /v1/assets/reservation_cancellation_inventory_options."
],
"error_params": [
"receiving_storage_location_id"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 400,
"status": "Bad Request",
"message": "The return quantity is not valid for this reservation. In return_quantity, enter a whole number from 1 up to the reservation's quantity.",
"error_code": "invalid_request",
"errors": [
"The return quantity is not valid for this reservation. In return_quantity, enter a whole number from 1 up to the reservation's quantity."
],
"error_params": [
"return_quantity"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 400,
"status": "Bad Request",
"message": "The return date is before the reservation's checkout date. In return_date, enter a date in YYYY-MM-DD format on or after the reservation_date.",
"error_code": "invalid_request",
"errors": [
"The return date is before the reservation's checkout date. In return_date, enter a date in YYYY-MM-DD format on or after the reservation_date."
],
"error_params": [
"return_date"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "No API key was provided. Send your key in the Authorization header as 'Bearer YOUR_API_KEY'. Alternatively, you can use the api_key parameter.",
"error_code": "missing_api_key",
"errors": [
"Copy the key from Workspace Settings > API & Integrations > API Access in ExhibitDay."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "The API key is not valid. Check that you copied the whole key from Workspace Settings > API & Integrations > API Access, then send it in the Authorization header as 'Bearer YOUR_API_KEY'. Alternatively, you can use the api_key parameter.",
"error_code": "invalid_api_key",
"errors": [
"Check that you sent the whole key. If it was regenerated, use the current key from Workspace Settings > API & Integrations > API Access."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "Access to the ExhibitDay API is not enabled for your workspace. Please contact support@exhibitday.com to enable API Access. Once access is enabled, send your key in the Authorization header as 'Bearer YOUR_API_KEY'.",
"error_code": "api_access_disabled",
"errors": [
"Nothing was read or changed."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "The API key is not valid for this request. Send your current key in the Authorization header as 'Bearer YOUR_API_KEY'.",
"error_code": "invalid_api_key",
"errors": [
"The API key is not valid for this request. Send your current key in the Authorization header as 'Bearer YOUR_API_KEY'."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "Access to the ExhibitDay API is not enabled for your workspace. Please contact support@exhibitday.com to enable API Access. Once access is enabled, send your key in the Authorization header as 'Bearer YOUR_API_KEY'.",
"error_code": "api_access_disabled",
"errors": [
"Access to the ExhibitDay API is not enabled for your workspace. Please contact support@exhibitday.com to enable API Access. Once access is enabled, send your key in the Authorization header as 'Bearer YOUR_API_KEY'."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 404,
"status": "Not Found",
"message": "Asset Reservation not found. Invalid Asset Reservation ID: 12345.",
"error_code": "not_found",
"errors": [
"Asset Reservation not found. Invalid Asset Reservation ID: 12345."
],
"error_params": [
"id"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "The reservation or its content changed while the request was being prepared or saved. Read it again before deciding whether to retry; nothing was changed.",
"error_code": "record_changed",
"errors": [
"The reservation or its content changed while the request was being prepared or saved. Read it again before deciding whether to retry; nothing was changed."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "This reservation changed since you read it. Read it again; nothing was changed.",
"error_code": "record_changed",
"errors": [
"This reservation changed since you read it. Read it again; nothing was changed."
],
"error_params": [
"expected_revision"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 429,
"status": "Too Many Requests",
"message": "Error 429 - Too Many Requests",
"error_code": "rate_limited",
"errors": [
"Error 429 - Too Many Requests"
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"An unexpected error occurred. Please try again later."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"The reservation save outcome could not be confirmed. Review the current reservation and inventory before deciding whether to retry; the API did not repeat the action."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"An unexpected error occurred. Please try again later."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"Check whether your change was saved before trying again."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
Retrieve Asset Reservation General File Attachments #
|
Retrieves the General File Attachments on an Asset Reservation.
| Name | Type | Required? | Description | Details |
|---|---|---|---|---|
| asset_type_id | Number | Yes |
The type of Asset being reserved. Capital tracks one item; Collateral tracks quantities.
|
Allowed values:
1 (Capital) | 2 (Collateral) |
| reservation_id | Number | Yes |
The ID of the Asset Reservation, from Retrieve Asset Reservations (GET /v1/assets/reservations) or its add response.
|
Use the matching asset_type_id. The server finds the reservation's Asset and current Event; no asset_id or event_id is needed.
|
| $limit | Number | No |
The most File Attachments to return.
|
A positive whole number. Omit for all remaining matching files.
|
| $offset | Number | No |
The number of matching File Attachments to skip.
|
A whole number of 0 or more. Default: 0.
|
| $result_format | String | No |
By default, the response is an object containing
list_data and the paging totals (records_found, total_records, has_more). Send array to get just a JSON array of the records.
|
Allowed values:
array |
| If-None-Match | String | No |
An ETag from an earlier response to this GET.
|
Optional HTTP header. If the successful response is unchanged, the API returns HTTP 304 with no body.
|
Good to know
Retrieves the General File Attachments on this Asset Reservation. Each result includes the file's ID, name and added time; use the download method for its contents.
Reading the file list
Files are ordered by attachment ID, lowest first. Each file follows its own current file permissions; files you can't view are left out.
Paging totals and X-Total-Count count all matching files before $limit and $offset are applied. A record with no files you can view returns an empty list. This list does not return edit revisions or support changed-since filtering.
Which reservation to select
Capital assets are tracked individually; Collateral items are tracked by quantity. These methods select an actual Asset Reservation. Manual inventory adjustments are separate.
File access
Each file retains its original Event or owning-workspace rules even if the reservation has moved. A permitted file read or removal grants no access to other reservation information or permission to upload. Hidden original Event content remains private.
Applicable original Event/file settings are respected. Permitted reads remain available on the Free plan.
curl -X GET "https://api.exhibitday.com/v1/assets/reservations/attachments?asset_type_id=1&reservation_id=12345" -H "Authorization: Bearer YOUR_API_KEY"
const response = await fetch("https://api.exhibitday.com/v1/assets/reservations/attachments?" + new URLSearchParams({ "asset_type_id": "1", "reservation_id": "12345" }), {
method: "GET",
headers: { "Authorization": "Bearer YOUR_API_KEY" }
});
const data = await response.json();
console.log(response.status, data);
import requests
response = requests.get(
"https://api.exhibitday.com/v1/assets/reservations/attachments",
headers={"Authorization": "Bearer YOUR_API_KEY"},
params={"asset_type_id": 1, "reservation_id": 12345},
)
print(response.status_code, response.json())
using System;
using System.Net.Http;
using System.Net.Http.Headers;
using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", "YOUR_API_KEY");
var response = await client.GetAsync("https://api.exhibitday.com/v1/assets/reservations/attachments?asset_type_id=1&reservation_id=12345");
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class ExhibitDayExample {
public static void main(String[] args) throws Exception {
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.exhibitday.com/v1/assets/reservations/attachments?asset_type_id=1&reservation_id=12345"))
.header("Authorization", "Bearer YOUR_API_KEY")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode() + " " + response.body());
}
}
<?php
$curl = curl_init('https://api.exhibitday.com/v1/assets/reservations/attachments?asset_type_id=1&reservation_id=12345');
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['Authorization: Bearer YOUR_API_KEY'],
]);
$response = curl_exec($curl);
if ($response === false) {
throw new RuntimeException(curl_error($curl));
}
echo curl_getinfo($curl, CURLINFO_HTTP_CODE) . PHP_EOL . $response;
curl_close($curl);
require 'net/http'
require 'uri'
uri = URI('https://api.exhibitday.com/v1/assets/reservations/attachments?asset_type_id=1&reservation_id=12345')
request = Net::HTTP::Get.new(uri)
request['Authorization'] = 'Bearer YOUR_API_KEY'
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(request)
end
puts "#{response.code} #{response.body}"
package main
import (
"fmt"
"io"
"log"
"net/http"
)
func main() {
request, err := http.NewRequest("GET", "https://api.exhibitday.com/v1/assets/reservations/attachments?asset_type_id=1&reservation_id=12345", nil)
if err != nil { log.Fatal(err) }
request.Header.Set("Authorization", "Bearer YOUR_API_KEY")
response, err := (&http.Client{}).Do(request)
if err != nil { log.Fatal(err) }
defer response.Body.Close()
body, err := io.ReadAll(response.Body)
if err != nil { log.Fatal(err) }
fmt.Printf("%d %s\n", response.StatusCode, body)
}
Example response
{
"records_found": 1,
"total_records": 1,
"has_more": false,
"list_type": "attachment",
"list_data": [
{
"id": 12345,
"filename": "attachment.pdf",
"attachment_created_timestamp": "2027-01-30T12:00:00Z"
}
]
}
{
"status_code": 400,
"status": "Bad Request",
"message": "HTTP method override is not supported.",
"error_code": "invalid_request",
"errors": [
"Send the documented HTTP method directly. X-HTTP-Method-Override cannot change a request's HTTP method."
],
"error_params": [
"X-HTTP-Method-Override"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "No API key was provided. Send your key in the Authorization header as 'Bearer YOUR_API_KEY'. Alternatively, you can use the api_key parameter.",
"error_code": "missing_api_key",
"errors": [
"Copy the key from Workspace Settings > API & Integrations > API Access in ExhibitDay."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "The API key is not valid. Check that you copied the whole key from Workspace Settings > API & Integrations > API Access, then send it in the Authorization header as 'Bearer YOUR_API_KEY'. Alternatively, you can use the api_key parameter.",
"error_code": "invalid_api_key",
"errors": [
"Check that you sent the whole key. If it was regenerated, use the current key from Workspace Settings > API & Integrations > API Access."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "Access to the ExhibitDay API is not enabled for your workspace. Please contact support@exhibitday.com to enable API Access. Once access is enabled, send your key in the Authorization header as 'Bearer YOUR_API_KEY'.",
"error_code": "api_access_disabled",
"errors": [
"Nothing was read or changed."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 404,
"status": "Not Found",
"message": "Asset Reservation not found. Check asset_type_id and reservation_id.",
"error_code": "not_found",
"errors": [
"Asset Reservation not found. Check asset_type_id and reservation_id."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "The reservation or attachment changed or is busy. Read its current state before retrying.",
"error_code": "record_changed",
"errors": [
"The reservation or attachment changed or is busy. Read its current state before retrying."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 429,
"status": "Too Many Requests",
"message": "Error 429 - Too Many Requests",
"error_code": "rate_limited",
"errors": [
"Error 429 - Too Many Requests"
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"An unexpected error occurred. Please try again later."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"Check whether your change was saved before trying again."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
Add Asset Reservation General File Attachments #
|
Adds General File Attachments to an Asset Reservation.
| Name | Type | Required? | Description | Details |
|---|---|---|---|---|
| asset_type_id | Number | Yes |
The type of Asset being reserved. Capital tracks one item; Collateral tracks quantities.
|
Allowed values:
1 (Capital) | 2 (Collateral) |
| reservation_id | Number | Yes |
The ID of the Asset Reservation, from Retrieve Asset Reservations (GET /v1/assets/reservations) or its add response.
|
Use the matching asset_type_id. The server finds the reservation's Asset and current Event; no asset_id or event_id is needed.
|
| file | File (multipart) | Yes |
The File Attachments to upload.
Maximum size per file: 25 MiB (26,214,400 bytes). Allowed file types: .png, .jpg, .jpeg, .bmp, .gif, .pdf, .msg, .eml, .doc, .docx, .ppt, .pptx, .xls, .xlsx, .csv, .rtf, .odp, .odt, .ods, .txt, .wks, .zip. View value format and limitsFile uploads use multipart form data. Other structured values use a JSON object or array; form/query values use JSON text.
|
Send one or more complete, nonempty multipart/form-data parts, each named file. Supported types and the current per-file limit are shown below. The complete request limit includes all files and multipart overhead; split larger batches. A missing or null upload is not a removal request.
|
| Idempotency-Key | String | No |
A unique key for safely retrying this upload.
|
Optional HTTP header: 1 to 255 visible ASCII characters without spaces or commas. Retry the identical request with the same key to replay its first saved response. Use a new key for a different upload.
|
Good to know
Adds one or more General File Attachments to this Asset Reservation. Send each file as a multipart upload part named file.
After the upload
The response's list_data contains the newly attached files, including each id, filename and attachment_created_timestamp. Existing files are kept. Use each returned id to download or remove that file.
Each uploaded part becomes a separate attachment, including identical parts in the same request.
Upload access
New uploads require current authority for the reservation and its actual Asset/Event context, permission to edit its files, an upload-enabled paid plan and no overdue billing restriction. An existing file does not grant permission to add another one.
The API derives the Asset and current Event from reservation_id and asset_type_id. Files already attached keep their original access context.
History and retries
A confirmed file change is recorded in history. expected_revision is not supported by these file methods. If the save outcome cannot be confirmed, retrieve the current file list before deciding whether to retry; the API does not automatically repeat an uncertain change.
Supporting File Attachments have no PATCH replacement. To replace one, add the new file and remove the old one using their separate requests; each request has its own outcome.
# bash; inspect an error body instead of saving it as the requested file.
status=$(curl --silent --show-error -X POST "https://api.exhibitday.com/v1/assets/reservations/attachments" -H "Authorization: Bearer YOUR_API_KEY" --output response-body.tmp --write-out "%{http_code}" --form-string "asset_type_id=1" --form-string "reservation_id=12345" --form "file=@attachment.pdf;type=application/octet-stream")
if [ "$status" != 200 ]; then cat response-body.tmp; exit 1; fi
cat response-body.tmp
// Node.js 18+; use a local file only for a declared multipart operation.
import { readFile, writeFile } from 'node:fs/promises';
const form = new FormData();
form.append("asset_type_id", "1");
form.append("reservation_id", "12345");
form.append("file", new Blob([await readFile("attachment.pdf")], { type: "application/octet-stream" }), "attachment.pdf");
const response = await fetch("https://api.exhibitday.com/v1/assets/reservations/attachments", { method: "POST", headers: { Authorization: 'Bearer YOUR_API_KEY' }, body: form });
if (response.status !== 200) throw new Error(`${response.status}: ${await response.text()}`);
console.log(await response.json());
import requests
import json
from contextlib import ExitStack
with ExitStack() as stack:
files = [
("file", ("attachment.pdf", stack.enter_context(open("attachment.pdf", 'rb')), "application/octet-stream")),
]
response = requests.request("POST", "https://api.exhibitday.com/v1/assets/reservations/attachments", headers={'Authorization': 'Bearer YOUR_API_KEY'}, files=files, data={"asset_type_id": "1", "reservation_id": "12345"}, timeout=30)
if response.status_code != 200:
raise RuntimeError(f'{response.status_code}: {response.text}')
print(response.json())
using System;
using System.IO;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", "YOUR_API_KEY");
using var request = new HttpRequestMessage(new HttpMethod("POST"), "https://api.exhibitday.com/v1/assets/reservations/attachments");
var form = new MultipartFormDataContent();
form.Add(new StringContent("1"), "asset_type_id");
form.Add(new StringContent("12345"), "reservation_id");
var file0 = new StreamContent(File.OpenRead("attachment.pdf"));
file0.Headers.ContentType = new MediaTypeHeaderValue("application/octet-stream");
form.Add(file0, "file", "attachment.pdf");
request.Content = form;
using var response = await client.SendAsync(request);
if ((int)response.StatusCode != 200) throw new Exception(await response.Content.ReadAsStringAsync());
Console.WriteLine(await response.Content.ReadAsStringAsync());
import java.net.URI;
import java.net.http.*;
import java.nio.file.*;
import java.nio.charset.StandardCharsets;
import java.io.ByteArrayOutputStream;
import java.util.UUID;
public class ExhibitDayExample {
public static void main(String[] args) throws Exception {
HttpRequest.Builder request = HttpRequest.newBuilder(URI.create("https://api.exhibitday.com/v1/assets/reservations/attachments")).header("Authorization", "Bearer YOUR_API_KEY");
String boundary = "ExhibitDay-" + UUID.randomUUID();
ByteArrayOutputStream form = new ByteArrayOutputStream();
form.write(("--" + boundary + "\r\nContent-Disposition: form-data; name=\"asset_type_id\"\r\n\r\n" + "1" + "\r\n").getBytes(StandardCharsets.UTF_8));
form.write(("--" + boundary + "\r\nContent-Disposition: form-data; name=\"reservation_id\"\r\n\r\n" + "12345" + "\r\n").getBytes(StandardCharsets.UTF_8));
form.write(("--" + boundary + "\r\nContent-Disposition: form-data; name=\"file\"; filename=\"attachment.pdf\"\r\nContent-Type: application/octet-stream\r\n\r\n").getBytes(StandardCharsets.UTF_8));
form.write(Files.readAllBytes(Path.of("attachment.pdf")));
form.write("\r\n".getBytes(StandardCharsets.UTF_8));
form.write(("--" + boundary + "--\r\n").getBytes(StandardCharsets.UTF_8));
request.header("Content-Type", "multipart/form-data; boundary=" + boundary);
HttpResponse<byte[]> response = HttpClient.newHttpClient().send(request.method("POST", HttpRequest.BodyPublishers.ofByteArray(form.toByteArray())).build(), HttpResponse.BodyHandlers.ofByteArray());
if (response.statusCode() != 200) throw new RuntimeException(new String(response.body(), StandardCharsets.UTF_8));
System.out.println(new String(response.body(), StandardCharsets.UTF_8));
}
}
<?php
$curl = curl_init('https://api.exhibitday.com/v1/assets/reservations/attachments');
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['Authorization: Bearer YOUR_API_KEY'],
CURLOPT_POSTFIELDS => [
'asset_type_id' => '1',
'reservation_id' => '12345',
'file' => new CURLFile('attachment.pdf', 'application/octet-stream', 'attachment.pdf'),
],
]);
$response = curl_exec($curl);
if ($response === false) throw new RuntimeException(curl_error($curl));
$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl);
if ($status !== 200) throw new RuntimeException($response);
echo $response;
require 'net/http'
require 'uri'
uri = URI('https://api.exhibitday.com/v1/assets/reservations/attachments')
request = Net::HTTP::Post.new(uri)
request['Authorization'] = 'Bearer YOUR_API_KEY'
files = []
begin
parts = [
['asset_type_id', '1'],
['reservation_id', '12345'],
['file', (files << File.open('attachment.pdf', 'rb')).last, {filename: 'attachment.pdf', content_type: 'application/octet-stream'}],
]
request.set_form(parts, 'multipart/form-data')
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') { |http| http.request(request) }
raise response.body unless response.code == '200'
puts response.body
ensure
files.each(&:close)
end
package main
import (
"fmt"
"io"
"log"
"net/http"
"os"
"bytes"
"mime/multipart"
"net/textproto"
)
func main() {
var form bytes.Buffer
writer := multipart.NewWriter(&form)
if err := writer.WriteField("asset_type_id", "1"); err != nil { log.Fatal(err) }
if err := writer.WriteField("reservation_id", "12345"); err != nil { log.Fatal(err) }
header0 := textproto.MIMEHeader{}
header0.Set("Content-Disposition", "form-data; name=\"file\"; filename=\"attachment.pdf\"")
header0.Set("Content-Type", "application/octet-stream")
part0, err := writer.CreatePart(header0)
if err != nil { log.Fatal(err) }
file0, err := os.Open("attachment.pdf")
if err != nil { log.Fatal(err) }
if _, err = io.Copy(part0, file0); err != nil { log.Fatal(err) }
file0.Close()
if err := writer.Close(); err != nil { log.Fatal(err) }
request, err := http.NewRequest("POST", "https://api.exhibitday.com/v1/assets/reservations/attachments", &form)
if err != nil { log.Fatal(err) }
request.Header.Set("Authorization", "Bearer YOUR_API_KEY")
request.Header.Set("Content-Type", writer.FormDataContentType())
response, err := (&http.Client{}).Do(request)
if err != nil { log.Fatal(err) }
defer response.Body.Close()
data, err := io.ReadAll(response.Body)
if err != nil { log.Fatal(err) }
if response.StatusCode != 200 { log.Fatalf("%d %s", response.StatusCode, data) }
fmt.Printf("%s\n", data)
}
Example response
{
"records_found": 1,
"total_records": 1,
"has_more": false,
"list_type": "attachment",
"list_data": [
{
"id": 12345,
"filename": "attachment.pdf",
"attachment_created_timestamp": "2027-01-30T12:00:00Z"
}
]
}
{
"status_code": 400,
"status": "Bad Request",
"message": "HTTP method override is not supported.",
"error_code": "invalid_request",
"errors": [
"Send the documented HTTP method directly. X-HTTP-Method-Override cannot change a request's HTTP method."
],
"error_params": [
"X-HTTP-Method-Override"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 400,
"status": "Bad Request",
"message": "This Idempotency-Key was already used with a different request. Use a new key for a new request.",
"error_code": "idempotency_key_reused",
"errors": [
"This Idempotency-Key was already used with a different request. Use a new key for a new request."
],
"error_params": [
"Idempotency-Key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "No API key was provided. Send your key in the Authorization header as 'Bearer YOUR_API_KEY'. Alternatively, you can use the api_key parameter.",
"error_code": "missing_api_key",
"errors": [
"Copy the key from Workspace Settings > API & Integrations > API Access in ExhibitDay."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "The API key is not valid. Check that you copied the whole key from Workspace Settings > API & Integrations > API Access, then send it in the Authorization header as 'Bearer YOUR_API_KEY'. Alternatively, you can use the api_key parameter.",
"error_code": "invalid_api_key",
"errors": [
"Check that you sent the whole key. If it was regenerated, use the current key from Workspace Settings > API & Integrations > API Access."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "Access to the ExhibitDay API is not enabled for your workspace. Please contact support@exhibitday.com to enable API Access. Once access is enabled, send your key in the Authorization header as 'Bearer YOUR_API_KEY'.",
"error_code": "api_access_disabled",
"errors": [
"Nothing was read or changed."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 404,
"status": "Not Found",
"message": "Asset Reservation not found. Check asset_type_id and reservation_id.",
"error_code": "not_found",
"errors": [
"Asset Reservation not found. Check asset_type_id and reservation_id."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "A request with this Idempotency-Key is still being processed. Retry after a moment.",
"error_code": "idempotency_key_in_use",
"errors": [
"A request with this Idempotency-Key is still being processed. Retry after a moment."
],
"error_params": [
"Idempotency-Key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "A previous request with this Idempotency-Key did not finish and its outcome is unknown, so this retry was not run to avoid creating a duplicate. Check whether the earlier request succeeded; to try again, use a new Idempotency-Key.",
"error_code": "idempotency_key_indeterminate",
"errors": [
"A previous request with this Idempotency-Key did not finish and its outcome is unknown, so this retry was not run to avoid creating a duplicate. Check whether the earlier request succeeded; to try again, use a new Idempotency-Key."
],
"error_params": [
"Idempotency-Key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "The saved response cannot be replayed safely.",
"error_code": "idempotency_key_indeterminate",
"errors": [
"The earlier request with this Idempotency-Key completed, but its saved response cannot be returned safely. This retry was not run and its key was not released. Look for the existing record with a GET; use a new Idempotency-Key only after checking whether another create is needed."
],
"error_params": [
"Idempotency-Key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "The reservation or attachment changed or is busy. Read its current state before retrying.",
"error_code": "record_changed",
"errors": [
"The reservation or attachment changed or is busy. Read its current state before retrying."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 429,
"status": "Too Many Requests",
"message": "Error 429 - Too Many Requests",
"error_code": "rate_limited",
"errors": [
"Error 429 - Too Many Requests"
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"An unexpected error occurred. Please try again later."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"Check whether your change was saved before trying again."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
Remove an Asset Reservation General File Attachment #
|
Deletes a General File Attachment from an Asset Reservation.
Other attached files and the record's details stay in place.
Note: Inputs that do not apply to this operation, including the ignore-empty option, are ignored and reported in the X-API-Warnings response header.
| Name | Type | Required? | Description | Details |
|---|---|---|---|---|
| id | Number | Yes |
The ID of the File Attachment.
|
Use the id from the attachment list. The API finds the record the file belongs to, so no record ID is sent. An Invoice Attachment is not selected by this method.
|
After the removal
Only the selected file association is removed. Its physical file is scheduled for cleanup after a confirmed save; cleanup may finish later. Other attached files stay in place.
Send only the file's id; the API finds the record it belongs to. A missing, already removed or unavailable attachment returns HTTP 404 Not Found. Do not send file parts with DELETE.
File access
Each file retains its original Event or owning-workspace rules even if the reservation has moved. A permitted file read or removal grants no access to other reservation information or permission to upload. Hidden original Event content remains private.
Removal also checks the file's original Event attachment, Assets and Deep Lock settings. Permitted removals remain available on the Free plan.
History and retries
A confirmed file change is recorded in history. expected_revision is not supported by these file methods. DELETE does not use Idempotency-Key replay. If the save outcome cannot be confirmed, retrieve the current file list before deciding whether to retry; the API does not automatically repeat an uncertain change.
Supporting File Attachments have no PATCH replacement. To replace one, add the new file and remove the old one using their separate requests; each request has its own outcome.
curl -X DELETE "https://api.exhibitday.com/v1/assets/reservations/attachments?id=12345" -H "Authorization: Bearer YOUR_API_KEY"
const response = await fetch("https://api.exhibitday.com/v1/assets/reservations/attachments?" + new URLSearchParams({ "id": "12345" }), {
method: "DELETE",
headers: { "Authorization": "Bearer YOUR_API_KEY" }
});
const data = await response.json();
console.log(response.status, data);
import requests
response = requests.delete(
"https://api.exhibitday.com/v1/assets/reservations/attachments",
headers={"Authorization": "Bearer YOUR_API_KEY"},
params={"id": 12345},
)
print(response.status_code, response.json())
using System;
using System.Net.Http;
using System.Net.Http.Headers;
using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", "YOUR_API_KEY");
var response = await client.DeleteAsync("https://api.exhibitday.com/v1/assets/reservations/attachments?id=12345");
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class ExhibitDayExample {
public static void main(String[] args) throws Exception {
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.exhibitday.com/v1/assets/reservations/attachments?id=12345"))
.header("Authorization", "Bearer YOUR_API_KEY")
.method("DELETE", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode() + " " + response.body());
}
}
<?php
$curl = curl_init('https://api.exhibitday.com/v1/assets/reservations/attachments?id=12345');
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'DELETE',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['Authorization: Bearer YOUR_API_KEY'],
]);
$response = curl_exec($curl);
if ($response === false) {
throw new RuntimeException(curl_error($curl));
}
echo curl_getinfo($curl, CURLINFO_HTTP_CODE) . PHP_EOL . $response;
curl_close($curl);
require 'net/http'
require 'uri'
uri = URI('https://api.exhibitday.com/v1/assets/reservations/attachments?id=12345')
request = Net::HTTP::Delete.new(uri)
request['Authorization'] = 'Bearer YOUR_API_KEY'
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(request)
end
puts "#{response.code} #{response.body}"
package main
import (
"fmt"
"io"
"log"
"net/http"
)
func main() {
request, err := http.NewRequest("DELETE", "https://api.exhibitday.com/v1/assets/reservations/attachments?id=12345", nil)
if err != nil { log.Fatal(err) }
request.Header.Set("Authorization", "Bearer YOUR_API_KEY")
response, err := (&http.Client{}).Do(request)
if err != nil { log.Fatal(err) }
defer response.Body.Close()
body, err := io.ReadAll(response.Body)
if err != nil { log.Fatal(err) }
fmt.Printf("%d %s\n", response.StatusCode, body)
}
Example response
{
"status_code": 200,
"status": "OK",
"message": "Attachment removed.",
"errors": []
}
{
"status_code": 400,
"status": "Bad Request",
"message": "HTTP method override is not supported.",
"error_code": "invalid_request",
"errors": [
"Send the documented HTTP method directly. X-HTTP-Method-Override cannot change a request's HTTP method."
],
"error_params": [
"X-HTTP-Method-Override"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "No API key was provided. Send your key in the Authorization header as 'Bearer YOUR_API_KEY'. Alternatively, you can use the api_key parameter.",
"error_code": "missing_api_key",
"errors": [
"Copy the key from Workspace Settings > API & Integrations > API Access in ExhibitDay."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "The API key is not valid. Check that you copied the whole key from Workspace Settings > API & Integrations > API Access, then send it in the Authorization header as 'Bearer YOUR_API_KEY'. Alternatively, you can use the api_key parameter.",
"error_code": "invalid_api_key",
"errors": [
"Check that you sent the whole key. If it was regenerated, use the current key from Workspace Settings > API & Integrations > API Access."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "Access to the ExhibitDay API is not enabled for your workspace. Please contact support@exhibitday.com to enable API Access. Once access is enabled, send your key in the Authorization header as 'Bearer YOUR_API_KEY'.",
"error_code": "api_access_disabled",
"errors": [
"Nothing was read or changed."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 404,
"status": "Not Found",
"message": "Attachment not found. Use an Attachment ID from GET /v1/assets/reservations/attachments.",
"error_code": "not_found",
"errors": [
"Attachment not found. Use an Attachment ID from GET /v1/assets/reservations/attachments."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "The reservation or attachment changed or is busy. Read its current state before retrying.",
"error_code": "record_changed",
"errors": [
"The reservation or attachment changed or is busy. Read its current state before retrying."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 429,
"status": "Too Many Requests",
"message": "Error 429 - Too Many Requests",
"error_code": "rate_limited",
"errors": [
"Error 429 - Too Many Requests"
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"An unexpected error occurred. Please try again later."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"Check whether your change was saved before trying again."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
Download an Asset Reservation General File Attachment #
|
Downloads a General File Attachment from an Asset Reservation.
| Name | Type | Required? | Description | Details |
|---|---|---|---|---|
| id | Number | Yes |
The ID of the File Attachment.
|
Use the id from the attachment list. The API finds the record the file belongs to, so no record ID is sent. An Invoice Attachment is not selected by this method.
|
Good to know
Downloads one original General File Attachment from this Asset Reservation. Select the file using its ID from the attachment list.
Download response
A successful response contains the original uploaded file with a safe download filename. API errors use the usual JSON response. A missing or unavailable file returns HTTP 404.
Send only the file's id from the attachment list to download that one file; the API finds the record it belongs to. The download leaves the record unchanged.
File access
Each file retains its original Event or owning-workspace rules even if the reservation has moved. A permitted file read or removal grants no access to other reservation information or permission to upload. Hidden original Event content remains private.
Applicable original Event/file settings are respected. Permitted reads remain available on the Free plan.
Files still being copied
If this file is still being copied, the download returns HTTP 409 with file_copy_pending. Try the download again in a few minutes.
# bash; inspect an error body instead of saving it as the requested file.
status=$(curl --silent --show-error -X GET "https://api.exhibitday.com/v1/assets/reservations/attachments/download?id=12345" -H "Authorization: Bearer YOUR_API_KEY" --output response-body.tmp --write-out "%{http_code}")
if [ "$status" != 200 ]; then cat response-body.tmp; exit 1; fi
mv response-body.tmp 'attachment.pdf'
// Node.js 18+; use a local file only for a declared multipart operation.
import { readFile, writeFile } from 'node:fs/promises';
const response = await fetch("https://api.exhibitday.com/v1/assets/reservations/attachments/download?id=12345", { method: "GET", headers: { Authorization: 'Bearer YOUR_API_KEY' } });
if (response.status !== 200) throw new Error(`${response.status}: ${await response.text()}`);
await writeFile("attachment.pdf", new Uint8Array(await response.arrayBuffer()));
import requests
import json
response = requests.request("GET", "https://api.exhibitday.com/v1/assets/reservations/attachments/download?id=12345", headers={'Authorization': 'Bearer YOUR_API_KEY'}, timeout=30)
if response.status_code != 200:
raise RuntimeError(f'{response.status_code}: {response.text}')
with open("attachment.pdf", 'wb') as destination:
destination.write(response.content)
using System;
using System.IO;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", "YOUR_API_KEY");
using var request = new HttpRequestMessage(new HttpMethod("GET"), "https://api.exhibitday.com/v1/assets/reservations/attachments/download?id=12345");
using var response = await client.SendAsync(request);
if ((int)response.StatusCode != 200) throw new Exception(await response.Content.ReadAsStringAsync());
await File.WriteAllBytesAsync("attachment.pdf", await response.Content.ReadAsByteArrayAsync());
import java.net.URI;
import java.net.http.*;
import java.nio.file.*;
import java.nio.charset.StandardCharsets;
import java.io.ByteArrayOutputStream;
import java.util.UUID;
public class ExhibitDayExample {
public static void main(String[] args) throws Exception {
HttpRequest.Builder request = HttpRequest.newBuilder(URI.create("https://api.exhibitday.com/v1/assets/reservations/attachments/download?id=12345")).header("Authorization", "Bearer YOUR_API_KEY");
HttpResponse<byte[]> response = HttpClient.newHttpClient().send(request.method("GET", HttpRequest.BodyPublishers.noBody()).build(), HttpResponse.BodyHandlers.ofByteArray());
if (response.statusCode() != 200) throw new RuntimeException(new String(response.body(), StandardCharsets.UTF_8));
Files.write(Path.of("attachment.pdf"), response.body());
}
}
<?php
$curl = curl_init('https://api.exhibitday.com/v1/assets/reservations/attachments/download?id=12345');
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['Authorization: Bearer YOUR_API_KEY'],
]);
$response = curl_exec($curl);
if ($response === false) throw new RuntimeException(curl_error($curl));
$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl);
if ($status !== 200) throw new RuntimeException($response);
file_put_contents('attachment.pdf', $response);
require 'net/http'
require 'uri'
uri = URI('https://api.exhibitday.com/v1/assets/reservations/attachments/download?id=12345')
request = Net::HTTP::Get.new(uri)
request['Authorization'] = 'Bearer YOUR_API_KEY'
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') { |http| http.request(request) }
raise response.body unless response.code == '200'
File.binwrite('attachment.pdf', response.body)
package main
import (
"fmt"
"io"
"log"
"net/http"
"os"
)
func main() {
request, err := http.NewRequest("GET", "https://api.exhibitday.com/v1/assets/reservations/attachments/download?id=12345", nil)
if err != nil { log.Fatal(err) }
request.Header.Set("Authorization", "Bearer YOUR_API_KEY")
response, err := (&http.Client{}).Do(request)
if err != nil { log.Fatal(err) }
defer response.Body.Close()
data, err := io.ReadAll(response.Body)
if err != nil { log.Fatal(err) }
if response.StatusCode != 200 { log.Fatalf("%d %s", response.StatusCode, data) }
if err := os.WriteFile("attachment.pdf", data, 0600); err != nil { log.Fatal(err) }
fmt.Println("File saved")
}
Example response
Content type: application/octet-stream
{
"status_code": 400,
"status": "Bad Request",
"message": "HTTP method override is not supported.",
"error_code": "invalid_request",
"errors": [
"Send the documented HTTP method directly. X-HTTP-Method-Override cannot change a request's HTTP method."
],
"error_params": [
"X-HTTP-Method-Override"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "No API key was provided. Send your key in the Authorization header as 'Bearer YOUR_API_KEY'. Alternatively, you can use the api_key parameter.",
"error_code": "missing_api_key",
"errors": [
"Copy the key from Workspace Settings > API & Integrations > API Access in ExhibitDay."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "The API key is not valid. Check that you copied the whole key from Workspace Settings > API & Integrations > API Access, then send it in the Authorization header as 'Bearer YOUR_API_KEY'. Alternatively, you can use the api_key parameter.",
"error_code": "invalid_api_key",
"errors": [
"Check that you sent the whole key. If it was regenerated, use the current key from Workspace Settings > API & Integrations > API Access."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "Access to the ExhibitDay API is not enabled for your workspace. Please contact support@exhibitday.com to enable API Access. Once access is enabled, send your key in the Authorization header as 'Bearer YOUR_API_KEY'.",
"error_code": "api_access_disabled",
"errors": [
"Nothing was read or changed."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 404,
"status": "Not Found",
"message": "File not found.",
"error_code": "not_found",
"errors": [
"File not found."
],
"error_params": [
"id"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "This file is still being copied. Try again in a few minutes.",
"error_code": "file_copy_pending",
"errors": [
"This file is still being copied. Try again in a few minutes."
],
"error_params": [
"file"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "The reservation or attachment changed or is busy. Read its current state before retrying.",
"error_code": "record_changed",
"errors": [
"The reservation or attachment changed or is busy. Read its current state before retrying."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 429,
"status": "Too Many Requests",
"message": "Error 429 - Too Many Requests",
"error_code": "rate_limited",
"errors": [
"Error 429 - Too Many Requests"
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"An unexpected error occurred. Please try again later."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"Check whether your change was saved before trying again."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}