action onsched_get_consumer_v1_availability_service_id_start_date_end_date_unav { label: "Get Unavailable Times" description: "
This endpoint is used to show Unavailable 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.
\nA serviceId is required. The startDate and endDate are required and are formatted as: YYYY-MM-DD
\nLocation 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.
" provider: onsched method: GET path: "/consumer/v1/availability/{serviceId}/{startDate}/{endDate}/unavailable" encoding: json input: { type: "object" properties: { duration: { type: "integer" format: "int32" } endDate: { type: "string" format: "date-time" } locationId: { type: "string" } resourceId: { type: "string" } serviceId: { type: "string" } skipTimePastUnavailability: { type: "boolean" } startDate: { type: "string" format: "date-time" } tzOffset: { type: "integer" format: "int32" } } required: ["endDate", "serviceId", "startDate"] additionalProperties: false } output: { type: "object" properties: { object: { type: "string" } unavailableTimes: { type: "array" items: { type: "object" properties: { calendarId: { type: "string" } date: { type: "string" } endDateTime: { type: "string" } entityId: { type: "integer" format: "int32" } entityType: { type: "string" } fromTime: { type: "integer" format: "int32" } locationId: { type: "string" } objectName: { type: "string" } reason: { type: "string" } reasonCode: { type: "string" } resourceId: { type: "string" } resourceName: { type: "string" } serviceId: { type: "string" } serviceName: { type: "string" } startDateTime: { type: "string" } toTime: { type: "integer" format: "int32" } tzOffset: { type: "integer" format: "int32" } } additionalProperties: false } } url: { type: "string" } } additionalProperties: false } }