Preview physical capacity for a complete resource bundle
const url = 'https://scheduling.example.test/v1/availability/preview';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"additionalAllocations":[{"offering":"example","resource":"example","units":1}],"durationMinutes":1,"offering":"example","party":{"attendees":1,"recipients":1},"resource":"example","resourceUnits":1,"start":"2026-04-15T12:00:00Z"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://scheduling.example.test/v1/availability/preview \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "additionalAllocations": [ { "offering": "example", "resource": "example", "units": 1 } ], "durationMinutes": 1, "offering": "example", "party": { "attendees": 1, "recipients": 1 }, "resource": "example", "resourceUnits": 1, "start": "2026-04-15T12:00:00Z" }'Read-scope advice for one exact-time start and every requested resource allocation. A positive answer is neither authorization nor a reservation. No manager, references, duplicate key, or eligibility assertions are accepted. Unavailability exposes only capacity.exhausted; an unavailable store or oversized snapshot remains service.unavailable. No idempotency key is needed because this operation has no capacity effect.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Header Parameters
Section titled “Header Parameters”Optional W3C trace context continued in the response.
Request Bodyrequired
Section titled “Request Bodyrequired”object
object
object
Example generated
{ "additionalAllocations": [ { "offering": "example", "resource": "example", "units": 1 } ], "durationMinutes": 1, "offering": "example", "party": { "attendees": 1, "recipients": 1 }, "resource": "example", "resourceUnits": 1, "start": "2026-04-15T12:00:00Z"}Responses
Section titled “Responses”Success
object
Example generated
{ "capacityAvailable": true, "end": "2026-04-15T12:00:00Z", "offering": "example", "publicCode": "example", "start": "2026-04-15T12:00:00Z"}Headers
Section titled “Headers”Every answer is marked no-store, so a booking view is never served from a cache.
W3C trace context for the request and response.
Problem response: request.invalid
object
Example
{ "code": "request.invalid", "detail": "The request could not be read as a Scheduling request.", "status": 400, "title": "Request invalid", "type": "https://id.registrystack.org/problems/registry-scheduling/request/invalid"}Headers
Section titled “Headers”Every answer is marked no-store, so a booking view is never served from a cache.
W3C trace context for the request and response.
Problem response: authentication.refused
object
Example
{ "code": "authentication.refused", "detail": "The bearer credential is missing, invalid, or expired. Sign in again.", "status": 401, "title": "Authentication refused", "type": "https://id.registrystack.org/problems/registry-scheduling/authentication/refused"}Headers
Section titled “Headers”Bearer authentication challenge.
Every answer is marked no-store, so a booking view is never served from a cache.
W3C trace context for the request and response.
Problem response: profile.not-authorized
object
Example
{ "code": "profile.not-authorized", "detail": "The selected Scheduling profile does not authorize this request.", "status": 403, "title": "Profile not authorized", "type": "https://id.registrystack.org/problems/registry-scheduling/profile/not-authorized"}Headers
Section titled “Headers”Every answer is marked no-store, so a booking view is never served from a cache.
W3C trace context for the request and response.
Problem response: request.not-found
object
Example
{ "code": "request.not-found", "detail": "The requested route does not exist.", "status": 404, "title": "Route not found", "type": "https://id.registrystack.org/problems/registry-scheduling/request/not-found"}Headers
Section titled “Headers”Every answer is marked no-store, so a booking view is never served from a cache.
W3C trace context for the request and response.
Problem response: request.method-not-allowed
object
Example
{ "code": "request.method-not-allowed", "detail": "The route exists but not for this method.", "status": 405, "title": "Method not allowed", "type": "https://id.registrystack.org/problems/registry-scheduling/request/method-not-allowed"}Headers
Section titled “Headers”Every answer is marked no-store, so a booking view is never served from a cache.
W3C trace context for the request and response.
Problem response: request.body-too-large
object
Example
{ "code": "request.body-too-large", "detail": "The request body exceeds the accepted size.", "status": 413, "title": "Payload too large", "type": "https://id.registrystack.org/problems/registry-scheduling/request/body-too-large"}Headers
Section titled “Headers”Every answer is marked no-store, so a booking view is never served from a cache.
W3C trace context for the request and response.
Problem response: request.unsupported-media-type
object
Example
{ "code": "request.unsupported-media-type", "detail": "The request body is not JSON.", "status": 415, "title": "Unsupported media type", "type": "https://id.registrystack.org/problems/registry-scheduling/request/unsupported-media-type"}Headers
Section titled “Headers”Every answer is marked no-store, so a booking view is never served from a cache.
W3C trace context for the request and response.
Problem response: request.unprocessable
object
Example
{ "code": "request.unprocessable", "detail": "The request body could not be processed.", "status": 422, "title": "Request unprocessable", "type": "https://id.registrystack.org/problems/registry-scheduling/request/unprocessable"}Headers
Section titled “Headers”Every answer is marked no-store, so a booking view is never served from a cache.
W3C trace context for the request and response.
Problem response: service.unavailable
object
Example
{ "code": "service.unavailable", "detail": "Scheduling storage is unavailable. Try again after the service recovers.", "status": 503, "title": "Scheduling service unavailable", "type": "https://id.registrystack.org/problems/registry-scheduling/service/unavailable"}Headers
Section titled “Headers”Seconds before retrying the unavailable dependency; the runtime answers 5.
Every answer is marked no-store, so a booking view is never served from a cache.
W3C trace context for the request and response.