openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

github.com/httptoolkit/openapi-directory-js

1 lines • 226 kB

JSON

{"openapi":"3.0.1","servers":[{"url":"https://sandbox-api.onsched.com/"}],"info":{"description":"Build secure and scalable custom apps for onboarding and setup. Our flexible API provides many options for configuration.\r\n \r\nTake the API for a test drive. Just click on the Authorize button below and authenticate. \r\nYou can access our demo company profile if you are not a customer, or your own profile by using your assigned ClientId and Secret.\r\n \r\nThe API has two interfaces, consumer and setup. \r\n<ul>\r\n<li>\r\nThe consumer interface provides all the endpoints required for implementing consumer booking flows.\r\n</li>\r\n<li>\r\nThe setup interface provides endpoints for profile configuration and setup.\r\n</li>\r\n</ul>\r\nToggle freely between the two interfaces using the swagger tool bar option labelled 'Select a definition'.\r\n","title":"OnSched Setup API","version":"v1","x-apisguru-categories":["collaboration"],"x-logo":{"url":"https://onsched.com/img/apple-touch-icon-57x57-precomposed.ico"},"x-origin":[{"format":"openapi","url":"https://sandbox-api.onsched.com/swagger/setup/swagger.json","version":"3.0"}],"x-providerName":"onsched.com","x-serviceName":"setup"},"security":[{"oauth2":["OnSchedApi"]}],"paths":{"/setup/v1/appointments":{"get":{"description":"Use this endpoint to return a List of Appointments. Use the offset and limit parameters to control the page start and number of results. Default offset is 0, limit is 20, max is 100. Use the query parameters to filter the results further. For more information: <a href=\"https://onsched.readme.io/docs/appointments-overview\">Appointments Overview</a>","parameters":[{"description":"id of business location, defaults to primary business location","in":"query","name":"locationId","schema":{"type":"string"}},{"description":"Filter appointments by email address","in":"query","name":"email","schema":{"type":"string"}},{"description":"Filter appointments by lastname or part of","in":"query","name":"lastname","schema":{"type":"string"}},{"description":"Filter appointments by service","in":"query","name":"serviceId","schema":{"type":"string"}},{"description":"Filter appointments by calendar","in":"query","name":"calendarId","schema":{"type":"string"}},{"description":"Filter appointments by resource","in":"query","name":"resourceId","schema":{"type":"string"}},{"description":"Filter appointments by customer","in":"query","name":"customerId","schema":{"type":"string"}},{"description":"Filter appointments by service allocation","in":"query","name":"serviceAllocationId","schema":{"type":"string"}},{"description":"Format YYYY-MM-DD: Filter appointments by on/after startDate","in":"query","name":"startDate","schema":{"format":"date-time","type":"string"}},{"description":"Format YYYY-MM-DD: Filter appointments on/before endDate","in":"query","name":"endDate","schema":{"format":"date-time","type":"string"}},{"description":"Filter appointments by status: IN, BK, CN, RE, RS","in":"query","name":"status","schema":{"type":"string"}},{"description":"Filter appointments by user email who booked","in":"query","name":"bookedBy","schema":{"type":"string"}},{"description":"Starting row of page, default 0","in":"query","name":"offset","schema":{"format":"int32","type":"integer"}},{"description":"Page limit default 20, max 100","in":"query","name":"limit","schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppointmentListViewModel"}}},"description":"Success"}},"summary":"List Appointments","tags":["Appointments"]}},"/setup/v1/appointments/{id}":{"get":{"description":"Use this endpoint to return an Appointment object. A valid appointment id is required. Find appointment id's by using the GET/setup/v1/appointments endpoint.","parameters":[{"description":"id of appointment object","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppointmentViewModel"}}},"description":"Success"}},"summary":"Get Appointment","tags":["Appointments"]}},"/setup/v1/appointments/{id}/reassign/resource/{resourceId}":{"put":{"description":"Use this endpoint to Reassign an appointment from one resource to another. The result returned is a single appointment that was reassigned to the target resource. A valid appointment id and resource id is required. Find appointment id's by using the GET /setup/v1/appointments endpoint, find resource id's by using the GET /setup/v1/resources endpoint.","parameters":[{"description":"id of appointment object","in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"id of target resource","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppointmentViewModel"}}},"description":"Success"}},"summary":"Reassign Appointment","tags":["Appointments"]}},"/setup/v1/businessusers":{"get":{"description":"Use this endpoint to return a List of Business Users and their Roles. The results are returned in pages. Use the offset and limit parameters to control the page start and number of results. Default offset is 0, limit is 20, max is 100. Use the query parameters to filter the results further.","parameters":[{"description":"id of business location, defaults to primary business location","in":"query","name":"locationId","schema":{"type":"string"}},{"description":"Filter by email address","in":"query","name":"email","schema":{"type":"string"}},{"description":"Filter user role","in":"query","name":"role","schema":{"type":"string"}},{"description":"Starting row of page, default 0","in":"query","name":"offset","schema":{"format":"int32","type":"integer"}},{"description":"Page limit default 20, max 100","in":"query","name":"limit","schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessUserListViewModel"}}},"description":"Success"}},"summary":"List Users","tags":["BusinessUsers"]},"post":{"description":"Use this endpoint to Create a Business User. If not specified, the business location defaults to the primary business location. \r\nRequired fields: Name, Email and RoleNote: If the businessUser is a bookable resource (bizresource) then a resourceId is required.\r\nFor role, use one of the values listed. Business Roles Include: bizowner (Business Owner), bizadmin (Business Administrator), bizresource (Business User - Bookable Resource).\r\nThe sendRegistrationInvite parameter is available to API consumers for their own use. It provides no added functionality in OnSched.","requestBody":{"content":{"application/*+json":{"schema":{"$ref":"#/components/schemas/BusinessUserInputModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/BusinessUserInputModel"}},"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/BusinessUserInputModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/BusinessUserInputModel"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessUserViewModel"}}},"description":"Success"}},"summary":"Create User","tags":["BusinessUsers"]}},"/setup/v1/businessusers/permissions":{"get":{"description":"Use this endpoint to return a List of Business User Permissions by Role. Results are returned in pages. Use the offset and limit parameters to control the page start and number of results. Default offset is 0, limit is 20, max is 100. Use the query parameters to filter the results further.","parameters":[{"description":"Filter permissions by role","in":"query","name":"role","schema":{"type":"string"}},{"description":"Starting row of page, default 0","in":"query","name":"offset","schema":{"format":"int32","type":"integer"}},{"description":"Page limit default 20, max 100","in":"query","name":"limit","schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessPermissionListViewModel"}}},"description":"Success"}},"summary":"List User Permissions","tags":["BusinessUsers"]}},"/setup/v1/businessusers/{email}/companies":{"get":{"description":"Use this endpoint to return a List of Companies associated with the business users email requested. A business user email address is required. Use the offset and limit parameters to control the page start and number of results. Default offset is 0, limit is 20, max is 100. Use the query parameters to filter the results further.","parameters":[{"description":"Email of business user","in":"path","name":"email","required":true,"schema":{"type":"string"}},{"description":"All or partial company name","in":"query","name":"searchText","schema":{"type":"string"}},{"description":"Starting row of page, default 0","in":"query","name":"offset","schema":{"format":"int32","type":"integer"}},{"description":"Page limit default 20, max 100","in":"query","name":"limit","schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizedCompanyListViewModel"}}},"description":"Success"}},"summary":"List User Companies","tags":["BusinessUsers"]}},"/setup/v1/businessusers/{id}":{"delete":{"description":"Use this endpoint to permanently Delete a Business User. A valid businessUser id is required.","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"}},"summary":"Delete User","tags":["BusinessUsers"]},"get":{"description":"Use this endpoint to return a Business User object. A valid businessUser id is required. Find businessUser id's using the GET /setup/v1/businessusers endpoint.","parameters":[{"description":"id of businessUser object","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessUserViewModel"}}},"description":"Success"}},"summary":"Get User","tags":["BusinessUsers"]},"put":{"description":"Use this endpoint to Update a Business User. A valid businessUser id is required.\r\n\r\n Business Roles Include: bizowner (Business Owner), bizadmin (Business Administrator), bizresource (Business User - Bookable Resource).","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/*+json":{"schema":{"$ref":"#/components/schemas/BusinessUserUpdateModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/BusinessUserUpdateModel"}},"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/BusinessUserUpdateModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/BusinessUserUpdateModel"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessUserViewModel"}}},"description":"Success"}},"summary":"Update User","tags":["BusinessUsers"]}},"/setup/v1/calendars":{"get":{"description":"Use this endpoint to return a List of Calendars from the requested location. If not specified, the business location defaults to the primary business location. ","parameters":[{"description":"id of business location, defaults to primary business location","in":"query","name":"locationId","schema":{"type":"string"}},{"description":"Filter by deleted status","in":"query","name":"deleted","schema":{"type":"boolean"}},{"description":"Starting row of page, default 0","in":"query","name":"offset","schema":{"format":"int32","type":"integer"}},{"description":"Page limit default 20, max 100","in":"query","name":"limit","schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduleListViewModel"}}},"description":"Success"}},"summary":"List Calendars","tags":["Calendars"]},"post":{"description":"\r\n DEPRECATING: Create Calendar\r\nWe are no longer supporting Multiple Calendar Functionality as it is part of our Legacy Application and has no relevance in the API.","requestBody":{"content":{"application/*+json":{"schema":{"$ref":"#/components/schemas/ScheduleInputModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/ScheduleInputModel"}},"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/ScheduleInputModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/ScheduleInputModel"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduleViewModel"}}},"description":"Success"}},"summary":"DEPRECATING: Create","tags":["Calendars"]}},"/setup/v1/calendars/block/{id}":{"delete":{"description":"Use this endpoint to permanently Delete a calendar block. A valid calendarBlock id is required.","parameters":[{"description":"id of a calendarBlock object","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CalendarBlockViewModel"}}},"description":"Success"}},"summary":"Delete Calendar Block","tags":["Calendars"]},"put":{"description":"Use this endpoint to Create a Calendar Block. A valid calendarBlock id is required. Refer to the POST /setup/v1/calendars/{id}/block endpoint for fieldnames and details.","parameters":[{"description":"id of calendarBlock object","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/*+json":{"schema":{"$ref":"#/components/schemas/CalendarBlockUpdateModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/CalendarBlockUpdateModel"}},"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/CalendarBlockUpdateModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/CalendarBlockUpdateModel"}}},"description":"Resource Block input model"},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CalendarBlockViewModel"}}},"description":"Success"}},"summary":"Update Calendar Block","tags":["Calendars"]}},"/setup/v1/calendars/blocks/{id}":{"get":{"description":"Use this endpoint to return a Calendar Block. A valid calendarBlock id is required. ","parameters":[{"description":"id of calendarBlock object","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CalendarBlockViewModel"}}},"description":"Success"}},"summary":"Get Calendar Block","tags":["Calendars"]}},"/setup/v1/calendars/{id}":{"delete":{"description":"Use this endpoint to Delete a calendar object. A valid calendar id is required. The calendar is not permanently deleted and can be recovered by using the PUT /setup/v1/calendars/{id}/recover endpoint.","parameters":[{"description":"id of calendar object","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduleViewModel"}}},"description":"Success"}},"summary":"Delete Calendar","tags":["Calendars"]},"get":{"description":"Use this endpoint to return a Calendar object. A valid calendar id is required.","parameters":[{"description":"id of calendar object","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduleViewModel"}}},"description":"Success"}},"summary":"Get Calendar","tags":["Calendars"]},"put":{"description":"Use this endpoint to Update a calendar object. A valid calendar id is required. When your company was created a calendar object was automatically created with 24-hour weekly availability. Its name = Main, the type = resource and by default the interval = 30 mins. We are currently supporting resource calendar type. Other types were part of our Legacy Application and has no relevance in the API product.","parameters":[{"description":"id of calendar object","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/*+json":{"schema":{"$ref":"#/components/schemas/ScheduleUpdateModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/ScheduleUpdateModel"}},"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/ScheduleUpdateModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/ScheduleUpdateModel"}}},"description":"Input model for the calendar object"},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduleViewModel"}}},"description":"Success"}},"summary":"Update Calendar","tags":["Calendars"]}},"/setup/v1/calendars/{id}/block":{"post":{"description":"Use this endpoint to Create a Calendar Block. A valid calendar id is required.\r\nRequired fields: startDate, endDate, startTime, endTime and reason.\r\nCalendar blocks can be set to specific time ranges or for the whole day. Th block a whole day set the startTime to 0 and endTime to 2400.\r\nCalendar blocks can be for a specific date range instance or set to repeat at a specified frequency.\r\n\r\n Repeat object: (repeats = true)\r\n\r\nThe frequency can be set to a value of D, W or M for Day, Week or Month respectively.\r\nUse the interval property to specify the interval that the block repeats. For example, an interval of 2 for a weekly block means that the block will repeat every 2nd week beginning at the day specified. A daily block with an interval of 10 means the block will repeat every 10 days. The interval property applies to all repeat frequencies. If using the repeat functionality an interval value is required.\r\n\r\n DAILY BLOCKS: Will repeat for each day of the week for the date range specified for the interval specified. An interval value of “1” repeats every day, and an interval value of “3” is every 3rd day.\r\n\r\n WEEKLY BLOCKS: Will repeat only on the specified days of the week for the date range specified. For weekly the frequency is required and should be set to “W”. You must specify the weekdays parameter. Weekdays are expressed as a string of digits with each single digit in the string representing a day of the week. The possible values are 0,1,2,3,4,5,6 where 0=Sunday, 1=Monday, 2=Tuesday, 3=Wednesday, 4=Thursday, 5=Friday, 6=Saturday. For example, a weekly frequency with an interval of “1”, and an entry of weekdays = “24”, will repeat each week on Tuesday and Thursday for the duration of the block date range.\r\n\r\n MONTHLY BLOCKS: Will repeat either on the day of the month specified in the monthDay property or on the day of the week and week of the month specified by the monthType property. In both cases frequency is required and should be set to “M”, monthly, monthDay is the day of the month you want blocked. If monthDay=’15’ this means to block the 15th of every month in the date range requested. Using monthDay in conjunction with monthType addresses “day of the week and week of the month” scenario. There are two possible values for monthType: D for Day of Month or W for Week of Month. For monthType D, monthDay value must be between 1 and 31. It is the day of the month to repeat on. For monthType M, monthDay value contains 2 digits: day of week (0-6), (0,1,2,3,4,5,6 where 0=Sunday, 1=Monday, 2=Tuesday, 3=Wednesday, 4=Thursday, 5=Friday, 6=Saturday) and week of month (1-5). 1 being the first week, 2 being the second. The third Thursday of the month is depicted as a monthType=”M” and monthDay=”43”.\r\n\r\n Repeats will end on the date specified by the end date.\r\n","parameters":[{"description":"id of calendar object","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/*+json":{"schema":{"$ref":"#/components/schemas/CalendarBlockInputModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/CalendarBlockInputModel"}},"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/CalendarBlockInputModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/CalendarBlockInputModel"}}},"description":""},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceBlockViewModel"}}},"description":"Success"}},"summary":"Create Calendar Block","tags":["Calendars"]}},"/setup/v1/calendars/{id}/blocks":{"get":{"description":"Use this endpoint to return a List of Calendar Blocks for the requested calendar. A valid calendar id is required. ","parameters":[{"description":"id of calendar to list blocks","in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"Starting row of page, default 0","in":"query","name":"offset","schema":{"format":"int32","type":"integer"}},{"description":"Page limit default 20, max 100","in":"query","name":"limit","schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CalendarBlockListViewModel"}}},"description":"Valid response"},"400":{"description":"Missing or invalid values in the request"},"401":{"description":"Authorization error."},"404":{"description":"Resource was not found"}},"summary":"List Calendar Blocks","tags":["Calendars"]}},"/setup/v1/calendars/{id}/recover":{"put":{"description":"Use this endpoint to Recover a previously deleted calendar object. A valid calendar id is required.","parameters":[{"description":"id of calendar object","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduleViewModel"}}},"description":"Success"}},"summary":"Recover Calendar","tags":["Calendars"]}},"/setup/v1/calendars/{id}/services":{"get":{"description":"Use this endpoint to return a List of Linked Services of a calendar object. A valid calendar id is required. Find calendar id's by using the GET /setup/v1/calendars endpoint.","parameters":[{"description":"id of calendar object","in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"Starting row of page, default 0","in":"query","name":"offset","schema":{"format":"int32","type":"integer"}},{"description":"Page limit default 20, max 100","in":"query","name":"limit","schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceListViewModel"}}},"description":"Success"}},"summary":"List Calendar Services","tags":["Calendars"]}},"/setup/v1/companies":{"get":{"description":"Use this endpoint to return the Authorized Company information. The company is the main entity that oversees all business locations defined below it, hierarchically. \r\nAccess to the company credentials gives you access to all business locations defined in the authorized company. Client credentials resolve to a single company and are purposely hidden from this endpoint.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyViewModel"}}},"description":"Success"}},"summary":"Get Company","tags":["Companies"]},"post":{"description":"Use this endpoint to Create a new authorized company.\r\n\r\n Note: Special API Partner credentials are required to access this endpoint.\r\n\r\nThe name, registrationEmail, phone, country and timezoneName are required fields. For country use the standard ISO 3166 2-character country code.\r\nThe timezoneName must be expressed as an IANA Timezone e.g., America/New_York.\r\nFor more information: <a href=\"https://en.wikipedia.org/wiki/List_of_tz_database_time_zones\">Timezone IANA Wiki</a>","requestBody":{"content":{"application/*+json":{"schema":{"$ref":"#/components/schemas/CompanyInputModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/CompanyInputModel"}},"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/CompanyInputModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/CompanyInputModel"}}},"description":"Company Input Model"},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyViewModel"}}},"description":"Success"}},"summary":"Create Company","tags":["Companies"]},"put":{"description":"Use this endpoint to Update the authorized company information. Your client credentials resolve to a single company. The timezoneName must be expressed as an IANA Timezone, e.g., America/New_York. \r\nFor more information: <a href=\"https://en.wikipedia.org/wiki/List_of_tz_database_time_zones\">Timezone IANA Wiki</a>","requestBody":{"content":{"application/*+json":{"schema":{"$ref":"#/components/schemas/CompanyUpdateModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/CompanyUpdateModel"}},"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/CompanyUpdateModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/CompanyUpdateModel"}}},"description":"Company Update Model"},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyViewModel"}}},"description":"Success"}},"summary":"Update Company","tags":["Companies"]}},"/setup/v1/companies/domains":{"get":{"description":"Use this endpoint to return a List of Company Domains for the authorized company. To share the OnSchedJS booking widget on your website or in your application your domain must be listed.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyDomainListViewModel"}}},"description":"Success"}},"summary":"List Company Domains","tags":["Companies"]},"post":{"description":"Use this endpoint to Create an OnSchedJs domain for your authorized company. To share the OnSchedJS booking widget on your website or in your application you must add the domain.","requestBody":{"content":{"application/*+json":{"schema":{"$ref":"#/components/schemas/CompanyDomainInputModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/CompanyDomainInputModel"}},"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/CompanyDomainInputModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/CompanyDomainInputModel"}}},"description":"Company Domain Input Model"},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyDomainViewModel"}}},"description":"Success"}},"summary":"Create Company Domain","tags":["Companies"]}},"/setup/v1/companies/domains/{id}":{"delete":{"description":"Use this endpoint to Delete an OnSchedJs domain from your authorized company. A valid companyDomain id is required.","parameters":[{"description":"id of companyDomain object","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyDomainViewModel"}}},"description":"Success"}},"summary":"Delete Company Domain","tags":["Companies"]},"get":{"description":"Use this endpoint to return a Company Domain object. A valid companyDomain id is required. ","parameters":[{"description":"id of companyDomain object","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyDomainViewModel"}}},"description":"Success"}},"summary":"Get Company Domain","tags":["Companies"]},"put":{"description":"Use this endpoint to Update an OnSchedJs domain for your authorized company. A valid companyDomain id is required.","parameters":[{"description":"id of companyDomain object","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/*+json":{"schema":{"$ref":"#/components/schemas/CompanyDomainUpdateModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/CompanyDomainUpdateModel"}},"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/CompanyDomainUpdateModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/CompanyDomainUpdateModel"}}},"description":"Company Domain Update Model"},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyDomainViewModel"}}},"description":"Success"}},"summary":"Update Company Domain","tags":["Companies"]}},"/setup/v1/companies/email/templates":{"get":{"description":"Use this endpoint to return a List of Email Templates that are provided and may be customized. If the template has been customized, the customized property is true. The scope parameter indicates if the email template has been customized at the Business Location level or Company level. This endpoint returns only company level templates, so the scope is always company.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailTemplateListViewModel"}}},"description":"Success"}},"summary":"List Email Templates","tags":["Companies"]}},"/setup/v1/companies/email/templates/master":{"delete":{"description":"Use this endpoint to Delete Custom Master Email Template Settings. Deleting a custom master email template setting will reactivate the original default OnSched template settings.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MasterEmailTemplateSettingsViewModel"}}},"description":"Success"}},"summary":"Delete Master Template Settings","tags":["Companies"]},"get":{"description":"Use this endpoint to return the Master Email Template Settings. Settings exist for showing or hiding email panels and for changing color schemes. ","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MasterEmailTemplateSettingsViewModel"}}},"description":"Success"}},"summary":"Get Master Template Settings","tags":["Companies"]},"post":{"description":"Use this endpoint to Create Custom Master Email Template Settings. Settings exist for showing or hiding email panels and for changing color schemes. Use the GET /setup/v1/companies/email/templates endpoint to display the settings offered. Changes to the Master Template Settings will be reflected in all business locations associated with this company. \r\nThe email template endpoints work a little differently than most. There are no endpoints to update the templates, we use the post endpoint to create a custom template instead. This endpoint creates a new custom Master Template Settings file that will be used instead. If you delete it you are deleting the custom template settings you created and the original default Master Template created by OnSched would be reactivated.","requestBody":{"content":{"application/*+json":{"schema":{"$ref":"#/components/schemas/MasterTemplateSettingsInputModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/MasterTemplateSettingsInputModel"}},"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/MasterTemplateSettingsInputModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/MasterTemplateSettingsInputModel"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MasterEmailTemplateSettingsViewModel"}}},"description":"Success"}},"summary":"Create Master Template Settings","tags":["Companies"]}},"/setup/v1/companies/email/templates/{templateName}":{"get":{"description":"Use this endpoint to return the requested Email Template. If it wasn't customized the default template is returned. The response content is in html format. A valid emailTemplate name is required. Find template names by using the: GET /setup/v1/companies/email/templates endpoint. Note: The master template cannot be accessed here. \r\nTo create custom company email templates, go to the POST /setup/v1/locations/{id}/email/templates endpoint and create a template using the Primary Business Location Id.","parameters":[{"description":"Email template name","in":"path","name":"templateName","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentResult"}}},"description":"Success"}},"summary":"Get Email Template","tags":["Companies"]}},"/setup/v1/companies/regions":{"get":{"description":"Use this endpoint to return a list of Regions in the authorized company. The results are returned in pages. Use the offset and limit parameters to control the page start and number of results. Default offset is 0, limit is 20, max is 100. Use the query parameters to filter the results further. ","parameters":[{"description":"Starting row of page, default 0","in":"query","name":"offset","schema":{"format":"int32","type":"integer"}},{"description":"Page limit default 20, max 100","in":"query","name":"limit","schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegionListViewModel"}}},"description":"region object's"},"400":{"description":"Missing or invalid values in the request"},"401":{"description":"Authorization error."},"404":{"description":"Resource was not found"}},"summary":"List Regions","tags":["Companies"]},"post":{"description":"Use this endpoint to Create a region object. Regions can be mapped to business locations. They can be used by the locations endpoints to filter locations by region id.","requestBody":{"content":{"application/*+json":{"schema":{"$ref":"#/components/schemas/RegionInputModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/RegionInputModel"}},"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/RegionInputModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/RegionInputModel"}}},"description":""},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegionViewModel"}}},"description":"Success"}},"summary":"Create Region","tags":["Companies"]}},"/setup/v1/companies/regions/{id}":{"delete":{"description":"Use this endpoint to Delete a region object. A valid region id is required. If the region is related to any business locations it won't be deleted. You must first remove any references to region id from the business locations prior to deleting.","parameters":[{"description":"id of Region","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegionViewModel"}}},"description":"Success"}},"summary":"Delete Region","tags":["Companies"]},"get":{"description":"Use this endpoint to return a Region object. A valid region id is required.","parameters":[{"description":"id of a region object","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegionViewModel"}}},"description":"Success"}},"summary":"Get Region","tags":["Companies"]},"put":{"description":"Use this endpoint to Update a region object. A valid region id is required.","parameters":[{"description":"id of Region","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/*+json":{"schema":{"$ref":"#/components/schemas/RegionUpdateModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/RegionUpdateModel"}},"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/RegionUpdateModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/RegionUpdateModel"}}},"description":"Region Update Model"},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegionViewModel"}}},"description":"Success"}},"summary":"Update Region","tags":["Companies"]}},"/setup/v1/companies/timezones/{date}":{"get":{"description":"Use this endpoint to return a List of timezone names, timezoneIana and tzOffset values calculated for the date requested. Daylight Savings may or may not apply depending on the date specified.","parameters":[{"description":"\"YYYY-MM-DD: Date for timezone info\"","in":"path","name":"date","required":true,"schema":{"format":"date-time","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TimezoneViewModel"}}},"description":"Success"}},"summary":"List Time Zones","tags":["Companies"]}},"/setup/v1/customers":{"get":{"description":"Use this endpoint to return a List of Customers. The results are returned in pages. Use the offset and limit parameters to control the page start and number of results. Default offset is 0, limit is 20, max is 100. Use the query parameters to filter the results further.","parameters":[{"description":"id of business location, defaults to primary business location","in":"query","name":"locationId","schema":{"type":"string"}},{"description":"Filter by groupId","in":"query","name":"groupId","schema":{"type":"string"}},{"description":"Filter by email address.","in":"query","name":"email","schema":{"type":"string"}},{"description":"Search by lastname.","in":"query","name":"lastname","schema":{"type":"string"}},{"description":"Filter by deleted status.","in":"query","name":"deleted","schema":{"type":"boolean"}},{"description":"Starting row of page, default 0","in":"query","name":"offset","schema":{"format":"int32","type":"integer"}},{"description":"Page limit default 20, max 100","in":"query","name":"limit","schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerListViewModel"}}},"description":"Success"}},"summary":"List Customers","tags":["Customers"]}},"/setup/v1/customers/{id}":{"get":{"description":"Use this endpoint to return a Customer object. A valid customer id is required. Find customer id's by using the GET /setup/v1/customers endpoint.","parameters":[{"description":"id of customer object","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerViewModel"}}},"description":"Success"}},"summary":"Get Customer","tags":["Customers"]}},"/setup/v1/customers/{id}/privacy":{"get":{"description":"Use this endpoint to return the Customer object. A valid customer id is required. Find customer id's using the GET /setup/v1/customers endpoint.","parameters":[{"description":"id of customer object","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerPrivacyViewModel"}}},"description":"Success"}},"summary":"Get Customer Data","tags":["Customers"]}},"/setup/v1/locations":{"get":{"description":"Use this endpoint to List Business Locations associated with your company. The results are returned in pages. Use the offset and limit parameters to control the page start and number of results. Default offset is 0, limit is 20, max is 100. Use the query parameters to filter the results further.\r\n\r\n IMPORTANT DEPRECATION NOTICE: The following online settings parameters were intended for internal use in our Portal application only. They will be deprecated on OCTOBER 15, 2022. These fields are currently part of the SETTINGS object in all location endpoints: businessId, enabled, familyMembersEnabled, serviceLabel, resourceLabel, resourceAnyLabel, resourceSelection, liveMode, formFlow, availabilityForm, showServiceGroups, showOnSchedLogo, showBusinessLogo, disableAuthorization, hideNavBar, hideLocationNav, hideServiceGroupsNav, hideServicesNav, hideContinueBooking, returnToService, returnToAvailability, hideBreadCrumbNav. If you are using these fields, please adjust your code to handle the deprecation or let us know by submitting a ticket to: support@onsched.com as we do not want to interrupt your existing workflows.","parameters":[{"description":"Location name(full or partial) to filter on","in":"query","name":"name","schema":{"type":"string"}},{"description":"Find locations that offer this service","in":"query","name":"serviceId","schema":{"type":"string"}},{"description":"friendlyId of location","in":"query","name":"friendlyId","schema":{"type":"string"}},{"description":"Filter locations on deleted status","in":"query","name":"deleted","schema":{"type":"boolean"}},{"description":"Starting row of page, default 0","in":"query","name":"offset","schema":{"format":"int32","type":"integer"}},{"description":"Page limit default 20, max 100","in":"query","name":"limit","schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationListViewModel"}}},"description":"Success"}},"summary":"List Locations","tags":["Locations"]},"post":{"description":"Use this endpoint to Create a new business location. The result is a business location object with a GUID assigned to the location.\r\nThe name and timezoneName fields are required. The timezoneName must be expressed as an IANA Timezone e.g., America/New_York. Refer to: <a href=\"https://en.wikipedia.org/wiki/List_of_tz_database_time_zones\">Timezone Wiki</a> for a listing of IANA time zones.\r\n\r\n Business hours are set by defining the startTime and endTime values for each day available/open. All days of the week must be provided when setting availability. Days are defined as sun, mon, tue, wed, thu, fri and sat. Start and End Times are entered in military format. e.g., 800 is 8:00am, 2230 is 10:30pm. If there is no physical location and the business hours are irrelevant, set the hours to open 24 hours by setting startTime=0 and endTime=2400. To set a whole day as unavailable, set both the startTime and endTime to 0. \r\n\r\n Settings can be set here. Booking timer minutes, book ahead restrictions and customer bookings per day are all available here. Please read about the settings scope parameter before setting these values as it may simplify your process.\r\n\r\n Settings Scope can be set to the company or the business location level. You can have all locations use the same company level settings or individual business locations can define their own, business location scope. If you want to use the company settings throughout all locations, do not pass in settings element. To create business location scoped settings, pass in the settings element with the field values defined in the post body. \r\n\r\n Appointment Reminders Reminder values are used to define how many hours, days, or weeks (interval value) prior to the appointment to send the reminder. Interval values are used to define the reminder interval: 1 = Hours, 2 = Days and 3 = Weeks. The reminder fields are numbers. If you are using the hours interval, use a number from 1 to 24.\r\nExample 1: emailFirstReminder: 1, emailFirstReminderInterval: 2 - results in 1st reminder being sent 1 Day before the appointment time.\r\nExample 2: emailSecondReminder: 3, emailSecondReminderInterval: 1 - results in 2nd reminder being sent 3 Hours before the appointment time.\r\n\r\n IMPORTANT DEPRECATION NOTICE: The following online settings parameters were intended for internal use in our Portal application only. They will be deprecated on OCTOBER 15, 2022. These fields are currently part of the SETTINGS object in all location endpoints: businessId, enabled, familyMembersEnabled, serviceLabel, resourceLabel, resourceAnyLabel, resourceSelection, liveMode, formFlow, availabilityForm, showServiceGroups, showOnSchedLogo, showBusinessLogo, disableAuthorization, hideNavBar, hideLocationNav, hideServiceGroupsNav, hideServicesNav, hideContinueBooking, returnToService, returnToAvailability, hideBreadCrumbNav. If you are using these fields, please adjust your code to handle the deprecation or let us know by submitting a ticket to: support@onsched.com as we do not want to interrupt your existing workflows.","requestBody":{"content":{"application/*+json":{"schema":{"$ref":"#/components/schemas/LocationInputModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/LocationInputModel"}},"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/LocationInputModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/LocationInputModel"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationViewModel"}}},"description":"Success"}},"summary":"Create Location","tags":["Locations"]}},"/setup/v1/locations/bulk":{"post":{"description":"Use this endpoint to Create Bulk business locations. The posted list of locations cannot exceed 100 location objects per transaction for performance purposes. The result is a list of new business location objects with a GUID assigned to each location.\r\nThe name and timezoneName fields are required. The timezoneName must be expressed as an IANA Timezone e.g., America/New_York. Refer to: <a href=\"https://en.wikipedia.org/wiki/List_of_tz_database_time_zones\">Timezone Wiki</a> for a listing of IANA time zones.\r\n\r\n Business hours are set by defining the startTime and endTime values for each day available/open. All days of the week must be provided when setting availability. Days are defined as sun, mon, tue, wed, thu, fri and sat. Start and End Times are entered in military format. e.g., 800 is 8:00am, 2230 is 10:30pm. If there is no physical location and the business hours are irrelevant, set the hours to open 24 hours by setting startTime=0 and endTime=2400. To set a whole day as unavailable, set both the startTime and endTime to 0. \r\n\r\n Settings can be set here. Booking timer minutes, book ahead restrictions and customer bookings per day are all available here. Please read about the settings scope parameter before setting these values as it may simplify your process.\r\n\r\n Settings Scope can be set to the company or the business location level. You can have all locations use the same company level settings or individual business locations can define their own, business location scope. If you want to use the company settings throughout all locations, do not pass in settings element. To create business location scoped settings, pass in the settings element with the field values defined in the post body. \r\n\r\n Appointment Reminders Reminder values are used to define how many hours, days, or weeks (interval value) prior to the appointment to send the reminder. Interval values are used to define the reminder interval: 1 = Hours, 2 = Days and 3 = Weeks. The reminder fields are numbers. If you are using the hours interval, use a number from 1 to 24.\r\nExample 1: emailFirstReminder: 1, emailFirstReminderInterval: 2 - results in 1st reminder being sent 1 Day before the appointment time.\r\nExample 2: emailSecondReminder: 3, emailSecondReminderInterval: 1 - results in 2nd reminder being sent 3 Hours before the appointment time.\r\n\r\n IMPORTANT DEPRECATION NOTICE: The following online settings parameters were intended for internal use in our Portal application only. They will be deprecated on OCTOBER 15, 2022. These fields are currently part of the SETTINGS object in all location endpoints: businessId, enabled, familyMembersEnabled, serviceLabel, resourceLabel, resourceAnyLabel, resourceSelection, liveMode, formFlow, availabilityForm, showServiceGroups, showOnSchedLogo, showBusinessLogo, disableAuthorization, hideNavBar, hideLocationNav, hideServiceGroupsNav, hideServicesNav, hideContinueBooking, returnToService, returnToAvailability, hideBreadCrumbNav. If you are using these fields, please adjust your code to handle the deprecation or let us know by submitting a ticket to: support@onsched.com as we do not want to interrupt your existing workflows.","requestBody":{"content":{"application/*+json":{"schema":{"$ref":"#/components/schemas/LocationsInputModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/LocationsInputModel"}},"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/LocationsInputModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/LocationsInputModel"}}}},"responses":{"200":{"content":{"application/js