Sign in
latestSwagger 2.02026-08-10143234301.7 KB

dc2736850e42

Rest

Searches for availability schedule details for specific staff.

post/Business/Schedules/Availability/Search

Headers

Authorizationstring required

Bearer {user_token}

SiteIdinteger required

Site ID

Request body

AvailabilityScheduleIdinteger

Availability schedule unique identifier, usually maps to the [tblTrainerSchedules].[ID] attribute.

LocationReferenceinteger

Location unique identifier.

StaffReferenceinteger

Staff the availability belongs to.

DaysOfWeekstring[]

Days of the week for the availability.

StartTimestring

Start time for the availability.

EndTimestring

End time for the availability.

StartDatestring date-time

Start date for the availability. In some cases this will be the full DateTime for the availability to prevent from separating the date and time.

EndDatestring date-time

End date for the availability. In some cases this will be the full DateTime for the availability to prevent from separating the date and time.

GroupIdinteger

Schedule group unique identifer.

Updatedstring date-time

Last DateTime the schedule was updated.

Createdstring date-time

DateTime the schedule was created.

Status'Public' | 'Masked' | 'Hidden'

Availability status.

ServiceCategoryReferencesinteger[]

Service category unique identifiers for the availability.

Response

OK

Errorsstring[]

List of errors, if any