Skip to main content
Yosemite CrewDeveloper Docs

Availability API

On this page

Manages an organisation's scheduling availability: base (default) hours, weekly overrides, occupancy, and the computed final availability used when booking appointments. Called by the PIMS (Practice Information Management System, the clinic-facing web app); routes are scoped to an organisation by orgId.

Endpoints

POST /:orgId/base

  • Params: orgId
  • Controller: AvailabilityController.setAllBaseAvailability

GET /:orgId/base

  • Params: orgId
  • Controller: AvailabilityController.getBaseAvailability

DELETE /:orgId/base

  • Params: orgId
  • Controller: AvailabilityController.deleteBaseAvailability

POST /:orgId/:userId/base

  • Params: orgId, userId
  • Controller: AvailabilityController.setBaseAvailabilityForUser

POST /:orgId/weekly

  • Params: orgId
  • Controller: AvailabilityController.addWeeklyAvailabilityOverride

GET /:orgId/weekly

  • Params: orgId
  • Controller: AvailabilityController.getWeeklyAvailabilityOverride

DELETE /:orgId/weekly

  • Params: orgId
  • Controller: AvailabilityController.deleteWeeklyAvailabilityOverride

POST /:orgId/occupancy

  • Params: orgId
  • Controller: AvailabilityController.addOccupancy

POST /:orgId/occupancy/bulk

  • Params: orgId
  • Controller: AvailabilityController.addAllOccupancies

GET /:orgId/occupancy

  • Params: orgId
  • Controller: AvailabilityController.getOccupancy

GET /:orgId/final

  • Params: orgId
  • Controller: AvailabilityController.getFinalAvailability

GET /:orgId/status

  • Params: orgId
  • Controller: AvailabilityController.getCurrentStatus