GET /consumer/v1/availability/{serviceId}/{startDate}/{endDate}/unavailable

onsched.com:consumer

Summary: Get Unavailable Times
Operation ID: —
Auth: unknown
Description

<p>This endpoint is used to show <b>Unavailable</b> times and provides valuable information as to why a time slot is unavailable. If you question your availability results, populate the same parameters to this endpoint to find out why.</p> <p>A <b>serviceId</b> is required. The <b>startDate</b> and <b>endDate</b> are required and are formatted as: <b>YYYY-MM-DD</b></p> <p>Location hours, holidays, services, resources, blocks, allocations, and appointments are just some of variables that may cause time slots to become unavailable. Use this endpoint to understand why you don't see availability.</p>

Parameters (8)

duration (integer, query, optional)

Duration of the service if different from default

endDate (string, path, required)

Format YYYY-MM-DD: End Date for unavailable time search

locationId (string, query, optional)

Id of business location, defaults to primary business location

resourceId (string, query, optional)

Resource Id to filter on

serviceId (string, path, required)

Service Id for availability search

skipTimePastUnavailability (boolean, query, optional)

Set as true to remove Time Past (TP) blocks in the response

startDate (string, path, required)

Format YYYY-MM-DD: Start Date for unavailable time search

tzOffset (integer, query, optional)

Request timezone offset to view unavailable times

No probe data for this endpoint yet.