• Getting Started
  • API Reference
Information
Other endpoints
    Get rooftopsgetGet timeslotsgetCreate appointmentpostSearch fleetspostCancel appointmentpost
Schemas
powered by Zuplo
BScheduler Partner Integration Gateway
BScheduler Partner Integration Gateway

Schemas

CreateAppointmentRequest

fleetId
​number · required

Fleet ID from /fleets/search

rooftopId
​number · required

Rooftop ID from /rooftops

start
​string · required

Start time (UTC, ISO 8601) matching a startTimeUtc from /timeslots

CreateAppointmentResponse

​object
success
​boolean

FleetSearchRequest

fleetName
​string

Fleet name to search for

FleetSearchResponse

​object[]
success
​boolean

CancelAppointmentRequest

id
​number · required

ID of the appointment to cancel

CreateKeyRequest

tenancyName
​string · required

The tenant name for the integration partner

username
​string · required

Integration account username

password
​string · required

Integration account password

CreateKeyResponse

success
​boolean
consumerId
​string
apiKey
​string
metadata
​object
On this page
  • CreateAppointmentRequest
  • CreateAppointmentResponse
  • FleetSearchRequest
  • FleetSearchResponse
  • CancelAppointmentRequest
  • CreateKeyRequest
  • CreateKeyResponse