{"swagger":"2.0","info":{"version":"v1","title":"REST API"},"host":"api.mindbodyonline.com","schemes":["https"],"paths":{"/AutoPay/region/{regionId}/covid19/close/enddate/{endDate}":{"post":{"tags":["Rest"],"summary":"Used to help close open ended supensions on autopays for a region","operationId":"POSTAutoPayregion{regionId}covid19closeenddate{endDate}","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"regionId","in":"path","description":"","required":true,"type":"integer","format":"int32"},{"name":"endDate","in":"path","description":"","required":true,"type":"string","format":"date-time"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/AutoPay/region/{regionId}/covid19/Suspend/startdate/{startDate}":{"post":{"tags":["Rest"],"summary":"Used to help create open ended supensions on autopays for a region","operationId":"POSTAutoPayregion{regionId}covid19Suspendstartdate{startDate}","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"regionId","in":"path","description":"","required":true,"type":"integer","format":"int32"},{"name":"startDate","in":"path","description":"","required":true,"type":"string","format":"date-time"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/AutoPay/subscriber/{subscriberId}/covid19/close/enddate/{endDate}":{"post":{"tags":["Rest"],"summary":"Used to help close open ended supensions on autopays for a subscriber","operationId":"POSTAutoPaysubscriber{subscriberId}covid19closeenddate{endDate}","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"subscriberId","in":"path","description":"","required":true,"type":"integer","format":"int32"},{"name":"endDate","in":"path","description":"","required":true,"type":"string","format":"date-time"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/AutoPay/subscriber/{subscriberId}/covid19/Suspend/startdate/{startDate}":{"post":{"tags":["Rest"],"summary":"Used to help create open ended supensions on autopays for a subscriber","operationId":"POSTAutoPaysubscriber{subscriberId}covid19Suspendstartdate{startDate}","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"subscriberId","in":"path","description":"","required":true,"type":"integer","format":"int32"},{"name":"startDate","in":"path","description":"","required":true,"type":"string","format":"date-time"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/Business/Calendars/Staff/{staffId}":{"get":{"tags":["Rest"],"summary":"Gets calendar events for a given staff.  Staff members can only retrieve their own calendar events.\r\nEndpoint also supports Service Identity.","operationId":"GETBusinessCalendarsStaff{staffId}","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"staffId","in":"path","description":"","required":true,"type":"integer","format":"int64"},{"name":"request.startDateTime","in":"query","description":"Optional start datetime to filter the request on in ISO-8601.","required":false,"type":"string","format":"date-time"},{"name":"request.endDateTime","in":"query","description":"Optional end datetime to filter the request on in ISO-8601.","required":false,"type":"string","format":"date-time"},{"name":"request.includeAppointments","in":"query","description":"Whether to include appointments in the result set.","required":false,"type":"boolean"},{"name":"request.includeClasses","in":"query","description":"Whether to include classes in the result set.","required":false,"type":"boolean"},{"name":"request.includeEnrollments","in":"query","description":"Whether to include enrollments in the result set.","required":false,"type":"boolean"},{"name":"request.includeUnavailabilities","in":"query","description":"Whether to include unavailabilities in the result set.","required":false,"type":"boolean"},{"name":"request.locationIds","in":"query","description":"Optional list of location identifiers to filter the results on.","required":false,"type":"array","items":{"type":"integer","format":"int32"},"collectionFormat":"multi"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Site.Schedules.CalendarEvent"}}},"400":{"description":"BadRequest","schema":{"type":"string"}},"401":{"description":"Unauthorized","schema":{"type":"string"}}}}},"/Business/Categories":{"get":{"tags":["Rest"],"summary":"Retrieve Category by verical ids","operationId":"GETBusinessCategories","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"verticalIds","in":"query","description":"","required":false,"type":"array","items":{"type":"integer","format":"int32"},"collectionFormat":"multi"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Business.GetCategoriesResponse"}}},"400":{"description":"BadRequest","schema":{"type":"string"}},"401":{"description":"Unauthorized","schema":{"type":"string"}}}}},"/Business/Closures":{"get":{"tags":["Rest"],"summary":"Retrieves a business's closures for a given start and end date","operationId":"GETBusinessClosures","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"startDate","in":"query","description":"","required":true,"type":"string","format":"date-time"},{"name":"endDate","in":"query","description":"","required":true,"type":"string","format":"date-time"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Subscribers.BusinessClosuresController.BusinessClosure"}},"400":{"description":"BadRequest"},"401":{"description":"Unauthorized","schema":{"type":"string"}}}}},"/Business/Features":{"get":{"tags":["Rest"],"summary":"Get all features for the studio","operationId":"GETBusinessFeatures","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"type":"string"}}},"400":{"description":"BadRequest","schema":{"type":"string"}},"401":{"description":"Unauthorized","schema":{"type":"string"}},"403":{"description":"Forbidden","schema":{"type":"string"}}}}},"/Business/Features/{featureDescriptor}":{"patch":{"tags":["Rest"],"summary":"Patch a Feature resource","operationId":"PATCHBusinessFeatures{featureDescriptor}","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"featureDescriptor","in":"path","description":"","required":true,"type":"string"},{"name":"request","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/Mindbody.RestApi.WebApi.Areas.Business.Features.Models.FeatureRequest"}}],"responses":{"200":{"description":"OK"},"400":{"description":"BadRequest","schema":{"type":"string"}},"401":{"description":"Unauthorized","schema":{"type":"string"}},"403":{"description":"Forbidden","schema":{"type":"string"}}}}},"/Business/PromoCodes":{"get":{"tags":["Rest"],"summary":"Retrieve a list of promo codes","operationId":"GETBusinessPromoCodes","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"request.activeOnly","in":"query","description":"Filter only active","required":false,"type":"boolean"},{"name":"request.onlineOnly","in":"query","description":"Filter only the ones that can be sold online","required":false,"type":"boolean"},{"name":"request.ids","in":"query","description":"Filter by promo code IDs","required":false,"type":"array","items":{"type":"integer","format":"int32"},"collectionFormat":"multi"},{"name":"request.startDate","in":"query","description":"Filter by activation start date","required":false,"type":"string","format":"date-time"},{"name":"request.endDate","in":"query","description":"Filter by activation end date","required":false,"type":"string","format":"date-time"},{"name":"request.orderBy","in":"query","description":"Specify order of the results.\r\nOptions are Name, CreationDate, ActivationDate and Id","required":false,"type":"string"},{"name":"request.limit","in":"query","description":"Number of results to return, defaults to 100","required":false,"type":"integer","format":"int32"},{"name":"request.offset","in":"query","description":"Number of results to skip, defaults to 0","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Business.GetPromoCodesResponse"}}},"400":{"description":"BadRequest","schema":{"type":"string"}},"401":{"description":"Unauthorized","schema":{"type":"string"}}}},"post":{"tags":["Rest"],"summary":"Create a new promo code","operationId":"POSTBusinessPromoCodes","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"promocode","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Business.PromoCode"}}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Business.PromoCode"}},"400":{"description":"BadRequest","schema":{"type":"string"}},"401":{"description":"Unauthorized","schema":{"type":"string"}}}}},"/Business/PromoCodes/{id}":{"put":{"tags":["Rest"],"summary":"Update an existing promo code","operationId":"PUTBusinessPromoCodes{id}","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"id","in":"path","description":"","required":true,"type":"integer","format":"int32"},{"name":"promocode","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Business.PromoCode"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Business.PromoCode"}},"400":{"description":"BadRequest","schema":{"type":"string"}},"401":{"description":"Unauthorized","schema":{"type":"string"}}}}},"/Business/Sales/{saleId}/EventDetails":{"get":{"tags":["Rest"],"summary":"Get calendar event details for a sale.","operationId":"GETBusinessSales{saleId}EventDetails","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"saleId","in":"path","description":"The sale id.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Sale.EventDetail"}}},"400":{"description":"BadRequest"}}}},"/Business/Sales/SalesDetails":{"get":{"tags":["Rest"],"summary":"Retrieve a list of sales details records","operationId":"GETBusinessSalesSalesDetails","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"request.saleId","in":"query","description":"When provided, returns SalesDetails that belong to this Sale ID","required":false,"type":"integer","format":"int64"},{"name":"request.startDate","in":"query","description":"When provided, returns SalesDetails on and after this date","required":false,"type":"string","format":"date-time"},{"name":"request.endDate","in":"query","description":"When provided, returns SalesDetails before and on this date","required":false,"type":"string","format":"date-time"},{"name":"request.excludedRevenueCategoryIds","in":"query","description":"When included, these revenue categories will be excluded from the results.","required":false,"type":"array","items":{"type":"integer","format":"int32"},"collectionFormat":"multi"},{"name":"request.clientId","in":"query","description":"When provided, returns SalesDetails that belong to this client ID","required":false,"type":"integer","format":"int64"},{"name":"request.limit","in":"query","description":"Number of results to return, defaults to 100","required":false,"type":"integer","format":"int32"},{"name":"request.offset","in":"query","description":"Number of results to skip, defaults to 0","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Sale.SalesDetail"}}},"400":{"description":"BadRequest","schema":{"type":"string"}},"401":{"description":"Unauthorized","schema":{"type":"string"}}}}},"/Business/Sales/User/ServicePaymentOptions/Apply":{"post":{"tags":["Rest"],"summary":"Request takes a list of appointment Ids.\r\nChecks if the appointment and current series exist, and then apply payment.","operationId":"POSTBusinessSalesUserServicePaymentOptionsApply","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"appointmentReferences","in":"body","description":"","required":true,"schema":{"type":"array","items":{"format":"int64","type":"integer"}}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Users.ApplyServicePaymentOptionsResponse"}},"400":{"description":"BadRequest","schema":{"type":"string"}},"401":{"description":"Unauthorized","schema":{"type":"string"}}}}},"/Business/Schedules/AppointmentRequests/{id}":{"get":{"tags":["Rest"],"summary":"Returns the Appointment Request identified by the ID.","operationId":"GETBusinessSchedulesAppointmentRequests{id}","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"id","in":"path","description":"The appointment request ID","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Site.Schedules.AppointmentRequest"}},"401":{"description":"Unauthorized","schema":{"type":"string"}},"404":{"description":"NotFound","schema":{"type":"string"}}}}},"/Business/Schedules/AppointmentRequests/Approve":{"post":{"tags":["Rest"],"summary":"Approves a single or multiple request(s) and sends the appointment request confirmation email.\r\nTakes a list of appointment requests which includes AppointmentRequestReference, StaffReference, \r\nAppointmentTypeReference, Range, ConsumerReference, LocationReference, ResourceReferences, AvailabilityReference.","operationId":"POSTBusinessSchedulesAppointmentRequestsApprove","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"appointments","in":"body","description":"List of AppointmentRequestConfirmationRequest.","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/Mindbody.Contract.Scheduling.Models.AppointmentRequests.AppointmentRequestConfirmationRequest"}}}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/Mindbody.Contract.Scheduling.Responses.StaffConfirmRequestResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/Mindbody.Contract.Scheduling.Responses.StaffConfirmRequestResponse"}},"401":{"description":"Unauthorized","schema":{"type":"string"}}}}},"/Business/Schedules/AppointmentRequests/Deny":{"post":{"tags":["Rest"],"summary":"Deny a single or multiple appointment requests and sends the appointment request denial email.\r\nTakes a list of appointment request Ids.","operationId":"POSTBusinessSchedulesAppointmentRequestsDeny","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"appointmentRequestIds","in":"body","description":"","required":true,"schema":{"type":"array","items":{"format":"int64","type":"integer"}}}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Results.DenyAppointmentRequestsResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Results.DenyAppointmentRequestsResponse"}},"401":{"description":"Unauthorized","schema":{"type":"string"}}}}},"/Business/Schedules/AppointmentRequests/deny-multiple":{"post":{"tags":["Rest"],"summary":"Deny multiple appointment requests in a single operation with optional consumer notification control.\r\nThis endpoint processes appointment requests and provides detailed error reporting.","operationId":"POSTBusinessSchedulesAppointmentRequestsdeny-multiple","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"request","in":"body","description":"The request containing appointment request IDs and notification preference","required":true,"schema":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Request.DenyMultipleAppointmentRequestsRequest"}}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Results.DenyMultipleAppointmentRequestsResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Results.DenyMultipleAppointmentRequestsResponse"}},"401":{"description":"Unauthorized","schema":{"type":"string"}}}}},"/Business/Schedules/Appointments":{"get":{"tags":["Rest"],"summary":"Gets appointment details.\r\nTakes a list of appointment ids and returns dictionary of appointment and its related objects.","operationId":"GETBusinessSchedulesAppointments","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"appointmentId","in":"query","description":"","required":true,"type":"array","items":{"type":"integer","format":"int64"},"collectionFormat":"multi"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Site.Appointments.BuildAppointmentsResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Site.Appointments.BuildAppointmentsResponse"}},"401":{"description":"Unauthorized","schema":{"type":"string"}},"403":{"description":"Forbidden"}}}},"/Business/Schedules/Appointments/Addons/Add":{"post":{"tags":["Rest"],"summary":"Adds Addons.","operationId":"POSTBusinessSchedulesAppointmentsAddonsAdd","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"addons","in":"body","description":"","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/MindbodyApi.Models.Business.Schedules.AddonViewModel"}}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MindbodyApi.Models.Business.Schedules.AddAddonResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/MindbodyApi.Models.Business.Schedules.AddAddonResponse"}},"401":{"description":"Unauthorized","schema":{"type":"string"}}}}},"/Business/Schedules/Appointments/Addons/Addons":{"get":{"tags":["Rest"],"summary":"Gets add-on details of a list of appointments\r\nTakes a list of appointment Ids and returns \r\ndictionary of add-on details keyed by appointment Id.","operationId":"GETBusinessSchedulesAppointmentsAddonsAddons","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"appointmentId","in":"query","description":"","required":true,"type":"array","items":{"type":"integer","format":"int64"},"collectionFormat":"multi"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MindbodyApi.Models.Business.Schedules.GetAddonsByAppointmentIdResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/MindbodyApi.Models.Business.Schedules.GetAddonsByAppointmentIdResponse"}},"401":{"description":"Unauthorized","schema":{"type":"string"}}}}},"/Business/Schedules/Appointments/Addons/Complete":{"post":{"tags":["Rest"],"summary":"Updates the appointment status to completed","operationId":"POSTBusinessSchedulesAppointmentsAddonsComplete","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"appointmentIds","in":"body","description":"","required":true,"schema":{"type":"array","items":{"format":"int64","type":"integer"}}}],"responses":{"200":{"description":"OK","schema":{"type":"boolean"}},"400":{"description":"BadRequest","schema":{"type":"boolean"}},"401":{"description":"Unauthorized","schema":{"type":"string"}}}}},"/Business/Schedules/Appointments/Addons/Delete":{"post":{"tags":["Rest"],"summary":"Delete Addons","operationId":"POSTBusinessSchedulesAppointmentsAddonsDelete","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"addonIds","in":"body","description":"","required":true,"schema":{"type":"array","items":{"format":"int64","type":"integer"}}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Results.Schedules.DeleteAddonsResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Results.Schedules.DeleteAddonsResponse"}},"401":{"description":"Unauthorized","schema":{"type":"string"}}}}},"/Business/Schedules/Appointments/Addons/GetAddons":{"get":{"tags":["Rest"],"summary":"Gets add-on details of an addon\r\nTakes a query string of addon Ids and returns \r\ndictionary of add-on details keyed by parent appointment Id.","operationId":"GETBusinessSchedulesAppointmentsAddonsGetAddons","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"addonId","in":"query","description":"","required":true,"type":"array","items":{"type":"integer","format":"int64"},"collectionFormat":"multi"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MindbodyApi.Models.Business.Schedules.GetAddonsByAppointmentIdResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/MindbodyApi.Models.Business.Schedules.GetAddonsByAppointmentIdResponse"}},"401":{"description":"Unauthorized","schema":{"type":"string"}}}}},"/Business/Schedules/Appointments/Addons/Modify":{"post":{"tags":["Rest"],"summary":"Modifies multiple appointments.\r\nTakes a list of appointment objects and sendEmail\r\nreturns success or errors.","operationId":"POSTBusinessSchedulesAppointmentsAddonsModify","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"request","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/MindbodyApi.Areas.Business.Schedules.Appointments.Requests.ModifyAppointmentControllerRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Results.Schedules.ModifyAppointmentsResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Results.Schedules.ModifyAppointmentsResponse"}},"401":{"description":"Unauthorized","schema":{"type":"string"}}}}},"/Business/Schedules/Appointments/Complete":{"post":{"tags":["Rest"],"summary":"Updates the appointment status to completed","operationId":"POSTBusinessSchedulesAppointmentsComplete","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"appointmentIds","in":"body","description":"","required":true,"schema":{"type":"array","items":{"format":"int64","type":"integer"}}}],"responses":{"200":{"description":"OK","schema":{"type":"boolean"}},"400":{"description":"BadRequest","schema":{"type":"boolean"}},"401":{"description":"Unauthorized","schema":{"type":"string"}}}}},"/Business/Schedules/Appointments/Modify":{"post":{"tags":["Rest"],"summary":"Modifies multiple appointments.\r\nTakes a list of appointment objects and sendEmail\r\nreturns success or errors.","operationId":"POSTBusinessSchedulesAppointmentsModify","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"request","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/MindbodyApi.Areas.Business.Schedules.Appointments.Requests.ModifyAppointmentControllerRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Results.Schedules.ModifyAppointmentsResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Results.Schedules.ModifyAppointmentsResponse"}},"401":{"description":"Unauthorized","schema":{"type":"string"}}}}},"/Business/Schedules/Appointments/Recurring":{"post":{"tags":["Rest"],"summary":"Books a recurring appointment group based on the options and returns list of AppointmentIds","operationId":"POSTBusinessSchedulesAppointmentsRecurring","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"request","in":"body","required":true,"schema":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.RecurringAppointments.RecurringRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.RecurringAppointments.BookResponse"}},"401":{"description":"Unauthorized","schema":{"type":"string"}},"403":{"description":"Forbidden"}}}},"/Business/Schedules/Appointments/Recurring/Validate":{"post":{"tags":["Rest"],"summary":"Validates recurring appointment options and returns list of conflicts that might happen based on the options","operationId":"POSTBusinessSchedulesAppointmentsRecurringValidate","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"request","in":"body","required":true,"schema":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.RecurringAppointments.RecurringRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.RecurringAppointments.ValidateResponse"}},"401":{"description":"Unauthorized","schema":{"type":"string"}},"403":{"description":"Forbidden"}}}},"/Business/Schedules/Availability":{"get":{"tags":["Rest"],"summary":"Gets availability schedule details.\r\nTakes a list of availability ids and returns availability schedule objects.","operationId":"GETBusinessSchedulesAvailability","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"availabilityId","in":"query","description":"","required":true,"type":"array","items":{"type":"integer","format":"int32"},"collectionFormat":"multi"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Results.Schedules.BuildAvailabilitySchedulesResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Results.Schedules.BuildAvailabilitySchedulesResponse"}},"401":{"description":"Unauthorized","schema":{"type":"string"}}}}},"/Business/Schedules/Availability/Add":{"post":{"tags":["Rest"],"summary":"Takes a list of AvailabilitySchedules and adds them to the schedule. Returns a list of AvailabilitySchedules with Id.\r\nThe following are required parameters: DaysOfWeek,StartTime,EndTime,StartDate,EndDate","operationId":"POSTBusinessSchedulesAvailabilityAdd","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"availabilitySchedules","in":"body","description":"","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Schedules.AvailabilitySchedule"}}}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Results.Schedules.AddAvailabilityScheduleResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Results.Schedules.AddAvailabilityScheduleResponse"}},"401":{"description":"Unauthorized","schema":{"type":"string"}}}}},"/Business/Schedules/Availability/Group":{"post":{"tags":["Rest"],"summary":"Takes a list of AvailabilitySchedules and updates availabilityscheduleGroup.\r\nReturns a list of AvailabilitySchedules with GroupId","operationId":"POSTBusinessSchedulesAvailabilityGroup","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"availabilitySchedules","in":"body","description":"List of availability schedules","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Schedules.AvailabilitySchedule"}}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Results.Schedules.UpdateAvailabilityScheduleGroupResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Results.Schedules.UpdateAvailabilityScheduleGroupResponse"}},"401":{"description":"Unauthorized","schema":{"type":"string"}}}}},"/Business/Schedules/Availability/Search":{"post":{"tags":["Rest"],"summary":"Searches for availability schedule details for specific staff.","operationId":"POSTBusinessSchedulesAvailabilitySearch","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"AvailabilitySchedules","in":"body","description":"","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Site.Schedules.AvailabilitySchedule"}}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Site.Controllers.SearchAvailabilityResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Site.Controllers.SearchAvailabilityResponse"}},"401":{"description":"Unauthorized","schema":{"type":"string"}}}}},"/Business/Schedules/Classes":{"get":{"tags":["Rest"],"summary":"Gets class instance details for the given instance.","operationId":"GETBusinessSchedulesClasses","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"classInstanceId","in":"query","description":"","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Site.Schedules.ClassInstance"}},"401":{"description":"Unauthorized","schema":{"type":"string"}},"404":{"description":"NotFound","schema":{"type":"string"}}}}},"/Business/Schedules/Classes/{classInstanceId}":{"get":{"tags":["Rest"],"summary":"Gets class instance details for the given instance.","operationId":"GETBusinessSchedulesClasses{classInstanceId}","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"classInstanceId","in":"path","description":"","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Site.Schedules.ClassInstance"}},"401":{"description":"Unauthorized","schema":{"type":"string"}},"404":{"description":"NotFound","schema":{"type":"string"}}}}},"/Business/Schedules/Classes/{classInstanceId}/Location":{"get":{"tags":["Rest"],"summary":"Gets class instance details for the given instance.","operationId":"GETBusinessSchedulesClasses{classInstanceId}Location","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"classInstanceId","in":"path","description":"","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Site.Schedules.ClassInstanceTiny"}},"400":{"description":"BadRequest","schema":{"type":"string"}},"403":{"description":"Forbidden","schema":{"type":"string"}},"404":{"description":"NotFound","schema":{"type":"string"}}}}},"/Business/Schedules/Classes/Upcoming":{"get":{"tags":["Rest"],"summary":"Gets upcoming classes for the subscriber","operationId":"GETBusinessSchedulesClassesUpcoming","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"startDateTime","in":"query","description":"","required":false,"type":"string","format":"date-time"},{"name":"endDateTime","in":"query","description":"","required":false,"type":"string","format":"date-time"},{"name":"locationId","in":"query","description":"","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Site.Schedules.ClassSchedule"}}},"204":{"description":"NoContent"},"400":{"description":"BadRequest","schema":{"type":"string"}}}}},"/Business/Schedules/Enrollments":{"get":{"tags":["Rest"],"summary":"Gets enrollment details for a subscriber.","operationId":"GETBusinessSchedulesEnrollments","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"request.locationIds","in":"query","description":"The requested location ids as a string. Should be a comma-delimited string that represents integers.\r\nOptional","required":false,"type":"string"},{"name":"request.serviceCategoryIds","in":"query","description":"The requested service category ids as a string. Should be a comma-delimited string that represents integers.  \r\nOptional","required":false,"type":"string"},{"name":"request.startDate","in":"query","description":"The start date range. Any active enrollments that are on or after this day.\r\n<br />Defaults to today.  Optional.","required":false,"type":"string","format":"date-time"},{"name":"request.endDate","in":"query","description":"The end date range. Any active enrollments that are on or before this day.\r\n<br />Defaults to StartDate.  Optional.","required":false,"type":"string","format":"date-time"},{"name":"request.active","in":"query","description":"Whether to return active enrollments or not. This filter is only valid for non-consumer users, i.e. staff,\r\nowners, etc.  Optional.","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Business.GetEnrollmentsResponse"}},"400":{"description":"BadRequest","schema":{"type":"string"}},"401":{"description":"Unauthorized","schema":{"type":"string"}}}}},"/Business/Scheduling/Appointments/BookingTemplates":{"post":{"tags":["Rest"],"summary":"Gets booking templates based on passed in consumer ID and the max days to get. This call is intended to help make booking easier\r\nby providing templates that have much of the information, needed to make an appointment, already filled out. The templates are\r\nbuilt based on the consumer's past appointment activity.","operationId":"POSTBusinessSchedulingAppointmentsBookingTemplates","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"request","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/MindbodyApi.Areas.Business.Schedules.Appointments.Requests.GetConsumerBookingTemplateRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MindbodyApi.Areas.Business.Schedules.Appointments.Responses.GetConsumerBookingTemplatesResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/MindbodyApi.Areas.Business.Schedules.Appointments.Responses.GetConsumerBookingTemplatesResponse"}},"401":{"description":"Unauthorized","schema":{"type":"string"}},"403":{"description":"Forbidden"}}}},"/Business/Subcategories":{"get":{"tags":["Rest"],"summary":"Retrieve Category by category ids","operationId":"GETBusinessSubcategories","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"categoryIds","in":"query","description":"","required":false,"type":"array","items":{"type":"integer","format":"int32"},"collectionFormat":"multi"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Business.GetCategoriesResponse"}}},"400":{"description":"BadRequest","schema":{"type":"string"}},"401":{"description":"Unauthorized","schema":{"type":"string"}}}}},"/Clients/Directory":{"get":{"tags":["Rest"],"summary":"Get a list of clients with services on date provided.","operationId":"GETClientsDirectory","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"date","in":"query","description":"","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Site.Directory.DirectoryClient"}}},"401":{"description":"Unauthorized","schema":{"type":"string"}},"404":{"description":"NotFound","schema":{"type":"string"}}}}},"/Consumer/Sales/User/Location/{LocationId}/ServicePaymentOptions":{"get":{"tags":["Rest"],"summary":"Returns the current series available on account for a user\r\nIf you're checking a date range and any 1 of those dates cannot be paid for by the pricing option, the call will return \"Invalid data\"","operationId":"GETConsumerSalesUserLocation{LocationId}ServicePaymentOptions","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"locationId","in":"query","required":true,"type":"string"},{"name":"request.locationId","in":"query","description":"LocationId","required":false,"type":"integer","format":"int32"},{"name":"request.appointmentTypeId","in":"query","description":"AppointmentTypeId","required":false,"type":"integer","format":"int32"},{"name":"request.start","in":"query","description":"Start date","required":false,"type":"string","format":"date-time"},{"name":"request.end","in":"query","description":"End date","required":false,"type":"string","format":"date-time"},{"name":"request.dependentId","in":"query","description":"Optional user if of a dependent.  When used, will get the service options for that dependent instead of the custodian making the request.","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Sale.ServicePaymentOption"}},"400":{"description":"BadRequest","schema":{"type":"string"}},"401":{"description":"Unauthorized","schema":{"type":"string"}}}}},"/Consumer/Schedules/Appointments/AppointmentTypes":{"get":{"tags":["Rest"],"summary":"Gets a list of all active consumer mode appointment types if appointment type Id is not provided. Gets a specific appointment type if Id is specified.","operationId":"GETConsumerSchedulesAppointmentsAppointmentTypes","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"id","in":"query","description":"Appointment Type Id, if not provided all active consumer mode appointment types will be returned.","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Mindbody.Contract.Scheduling.Responses.GuestBuildAppointmentTypesResponse"}},"401":{"description":"Unauthorized","schema":{"type":"string"}}}}},"/Consumer/Schedules/Appointments/AppointmentTypes/{id}":{"get":{"tags":["Rest"],"summary":"Gets a list of all active consumer mode appointment types if appointment type Id is not provided. Gets a specific appointment type if Id is specified.","operationId":"GETConsumerSchedulesAppointmentsAppointmentTypes{id}","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"id","in":"path","description":"Appointment Type Id, if not provided all active consumer mode appointment types will be returned.","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Mindbody.Contract.Scheduling.Responses.GuestBuildAppointmentTypesResponse"}},"401":{"description":"Unauthorized","schema":{"type":"string"}}}}},"/Consumer/Schedules/Appointments/Locations":{"get":{"tags":["Rest"],"summary":"This action returns a list of locations that can schedule appointments.","operationId":"GETConsumerSchedulesAppointmentsLocations","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Site.LocationSmall"}}},"401":{"description":"Unauthorized","schema":{"type":"string"}}}}},"/Consumer/Schedules/Location/{locationId}/Appointments":{"post":{"tags":["Rest"],"summary":"Books single or multiple appointments and sends booking confirmation email.\r\nMakes single or multiple appointment requests and sends appointment requested email if booking option is turned off.\r\nBooks and applies payment for single appointment if payment is required and sends booking confirmation email.\r\nLocation Id,StaffReference, AppointmentTypeReference, Range is required.\r\ncheckVerified is a boolean used for Connect on versions above 2.0.4. Returns booked appointment details","operationId":"POSTConsumerSchedulesLocation{locationId}Appointments","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"locationId","in":"path","description":"Location Id is required.","required":true,"type":"integer","format":"int32"},{"name":"appointments","in":"body","description":"List of appointment requests, StaffReference, AppointmentTypeReference, Range are required.","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/Mindbody.Contract.Scheduling.Models.Appointments.AppointmentBookingRequest"}}},{"name":"checkVerified","in":"query","description":"Boolean used for Connect on versions above 2.0.4","required":false,"type":"boolean"},{"name":"searchId","in":"query","description":"","required":false,"type":"integer","format":"int32"},{"name":"userId","in":"query","description":"","required":false,"type":"string"},{"name":"creditCardTokenId","in":"query","description":"","required":false,"type":"string"}],"responses":{"201":{"description":"Returns a ConsumerBookAppointmentManagerResponse if the option to allow clients to book online is turned on; or a ConsumerRequestAppointmentManagerResponse otherwise.","schema":{"type":"object"}},"400":{"description":"Returns a ConsumerBookAppointmentManagerResponse if the option to allow clients to book online is turned on; or a ConsumerRequestAppointmentManagerResponse otherwise.","schema":{"type":"object"}},"401":{"description":"Unauthorized","schema":{"type":"string"}}}}},"/Consumer/Schedules/Location/{locationId}/Appointments/StaffBookableTimeRanges":{"get":{"tags":["Rest"],"summary":"List of bookable time ranges, appointment types, and staff appointment type details.\r\nLocation Id,Appointment type Id is required.\r\nStaff id is optional. Can pass multiple staffId params\r\nDate part is requried, time part is optional.","operationId":"GETConsumerSchedulesLocation{locationId}AppointmentsStaffBookableTimeRanges","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"locationId","in":"path","description":"Location Id is required","required":true,"type":"integer","format":"int32"},{"name":"appointmentTypeId","in":"query","description":"Appointment type Id is required","required":true,"type":"integer","format":"int32"},{"name":"staffId","in":"query","description":"Staff id is optional. Can pass multiple staffId params","required":true,"type":"array","items":{"type":"integer","format":"int64"},"collectionFormat":"multi"},{"name":"start","in":"query","description":"Date part is requried, time part is optional","required":true,"type":"string","format":"date-time"},{"name":"end","in":"query","description":"Date part is required, time part is optional","required":true,"type":"string","format":"date-time"},{"name":"dependentId","in":"query","description":"Dependent id is optional","required":false,"type":"string"},{"name":"ignoreMembershipRestrictions","in":"query","description":"If true, will not filter out results based on the consumer's membership status. Optional, default = false","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Mindbody.Contract.Scheduling.Responses.BuildBookableTimeRangesResponse"}},"401":{"description":"Unauthorized","schema":{"type":"string"}}}}},"/Consumer/Schedules/Location/{locationId}/Appointments-Addons":{"post":{"tags":["Rest"],"summary":"Books single or multiple appointments with add-ons.","operationId":"POSTConsumerSchedulesLocation{locationId}Appointments-Addons","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"locationId","in":"path","description":"Location Id is required.","required":true,"type":"integer","format":"int32"},{"name":"bookAppointmentsAndAddonsRequest","in":"body","description":"List of appointments.","required":true,"schema":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Schedules.BookAppointmentsAndAddonsRequest"}},{"name":"userId","in":"query","description":"","required":false,"type":"string"},{"name":"creditCardTokenId","in":"query","description":"","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Schedules.BookAppointmentsAndAddonsResponse"}},"400":{"description":"BadRequest","schema":{"type":"object"}},"401":{"description":"Unauthorized","schema":{"type":"string"}}}}},"/Consumer/Users/Location/{locationId}/Staff/StaffAvailableAppointmentTypes":{"get":{"tags":["Rest"],"summary":"Gets appointment types for a specific staff at a specific location","operationId":"GETConsumerUsersLocation{locationId}StaffStaffAvailableAppointmentTypes","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"staffId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"locationId","in":"path","description":"","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Results.StaffResponse"}},"401":{"description":"Unauthorized","schema":{"type":"string"}}}}},"/Consumer/Users/Staff/StaffAvailableAppointmentTypes":{"get":{"tags":["Rest"],"summary":"Gets appointment types for a specific staff.","operationId":"GETConsumerUsersStaffStaffAvailableAppointmentTypes","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"staffId","in":"query","description":"Staff Id","required":true,"type":"integer","format":"int64"},{"name":"appointmentTypeId","in":"query","description":"Appointment Type Id","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Results.StaffResponse"}},"401":{"description":"Unauthorized","schema":{"type":"string"}}}}},"/Dashboard/ByCategory/GetTotalSales":{"get":{"tags":["Rest"],"summary":"Gets the sales data by category for the specified month","operationId":"GETDashboardByCategoryGetTotalSales","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"requestModel.dateRange.start","in":"query","required":false,"type":"string","format":"date-time"},{"name":"requestModel.dateRange.end","in":"query","required":false,"type":"string","format":"date-time"},{"name":"requestModel.locationIds","in":"query","description":"Location Ids to grab data for","required":false,"type":"array","items":{"type":"integer","format":"int32"},"collectionFormat":"multi"},{"name":"requestModel.accrual","in":"query","description":"Whether to get data on an accrual basis or cash","required":false,"type":"boolean"},{"name":"requestModel.yearOverYear","in":"query","description":"Whether to get comparison data year over year or month over month","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"type":"object","additionalProperties":{"format":"double","type":"number"}}}}}},"/Dashboard/Summary":{"get":{"tags":["Rest"],"summary":"Get's the summary data for the given criteria","operationId":"GETDashboardSummary","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"requestModel.dateRange.start","in":"query","required":false,"type":"string","format":"date-time"},{"name":"requestModel.dateRange.end","in":"query","required":false,"type":"string","format":"date-time"},{"name":"requestModel.locationIds","in":"query","description":"Location Ids to grab data for","required":false,"type":"array","items":{"type":"integer","format":"int32"},"collectionFormat":"multi"},{"name":"requestModel.accrual","in":"query","description":"Whether to get data on an accrual basis or cash","required":false,"type":"boolean"},{"name":"requestModel.yearOverYear","in":"query","description":"Whether to get comparison data year over year or month over month","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MindbodyApi.Models.Dashboard.SummaryData"}}}}},"/Dashboard/YoY/GetMonthlyActiveMembers":{"get":{"tags":["Rest"],"summary":"Gets the monthly active member data between the specified dates","operationId":"GETDashboardYoYGetMonthlyActiveMembers","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"requestModel.dateRange.start","in":"query","required":false,"type":"string","format":"date-time"},{"name":"requestModel.dateRange.end","in":"query","required":false,"type":"string","format":"date-time"},{"name":"requestModel.locationIds","in":"query","description":"Location Ids to grab data for","required":false,"type":"array","items":{"type":"integer","format":"int32"},"collectionFormat":"multi"},{"name":"requestModel.accrual","in":"query","description":"Whether to get data on an accrual basis or cash","required":false,"type":"boolean"},{"name":"requestModel.yearOverYear","in":"query","description":"Whether to get comparison data year over year or month over month","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/MindbodyApi.Models.Dashboard.MonthlyData`1[[System.Decimal, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]"}}}}}},"/Dashboard/YoY/GetMonthlyAttendance":{"get":{"tags":["Rest"],"summary":"Get the monthly attendance data between the specified dates","operationId":"GETDashboardYoYGetMonthlyAttendance","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"requestModel.dateRange.start","in":"query","required":false,"type":"string","format":"date-time"},{"name":"requestModel.dateRange.end","in":"query","required":false,"type":"string","format":"date-time"},{"name":"requestModel.locationIds","in":"query","description":"Location Ids to grab data for","required":false,"type":"array","items":{"type":"integer","format":"int32"},"collectionFormat":"multi"},{"name":"requestModel.accrual","in":"query","description":"Whether to get data on an accrual basis or cash","required":false,"type":"boolean"},{"name":"requestModel.yearOverYear","in":"query","description":"Whether to get comparison data year over year or month over month","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/MindbodyApi.Models.Dashboard.MonthlyData`1[[System.Decimal, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]"}}}}}},"/Dashboard/YoY/GetMonthlyOnlineBookings":{"get":{"tags":["Rest"],"summary":"Gets the monthly online booking data between the specified dates","operationId":"GETDashboardYoYGetMonthlyOnlineBookings","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"requestModel.dateRange.start","in":"query","required":false,"type":"string","format":"date-time"},{"name":"requestModel.dateRange.end","in":"query","required":false,"type":"string","format":"date-time"},{"name":"requestModel.locationIds","in":"query","description":"Location Ids to grab data for","required":false,"type":"array","items":{"type":"integer","format":"int32"},"collectionFormat":"multi"},{"name":"requestModel.accrual","in":"query","description":"Whether to get data on an accrual basis or cash","required":false,"type":"boolean"},{"name":"requestModel.yearOverYear","in":"query","description":"Whether to get comparison data year over year or month over month","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/MindbodyApi.Models.Dashboard.MonthlyData`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]"}}}}}},"/Dashboard/YoY/GetMonthlySales":{"get":{"tags":["Rest"],"summary":"Gets the monthly sales data between the specified dates","operationId":"GETDashboardYoYGetMonthlySales","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"requestModel.dateRange.start","in":"query","required":false,"type":"string","format":"date-time"},{"name":"requestModel.dateRange.end","in":"query","required":false,"type":"string","format":"date-time"},{"name":"requestModel.locationIds","in":"query","description":"Location Ids to grab data for","required":false,"type":"array","items":{"type":"integer","format":"int32"},"collectionFormat":"multi"},{"name":"requestModel.accrual","in":"query","description":"Whether to get data on an accrual basis or cash","required":false,"type":"boolean"},{"name":"requestModel.yearOverYear","in":"query","description":"Whether to get comparison data year over year or month over month","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/MindbodyApi.Models.Dashboard.MonthlyData`1[[System.Decimal, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]"}}}}}},"/DEIB/{subscriberId}/Amenities":{"get":{"tags":["Rest"],"summary":"Retrieve a list of all amenities that can be applied to a location.","operationId":"GETDEIB{subscriberId}Amenities","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"subscriberId","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.DEIB.Responses.Amenities.GetStudioAmenitiesResponse"}},"401":{"description":"Unauthorized","schema":{"type":"string"}}}}},"/DEIB/{subscriberId}/BusinessIdentifiesAs":{"get":{"tags":["Rest"],"summary":"Retrieve a list of all BusinessIdentifiesAs that can be applied to a location.","operationId":"GETDEIB{subscriberId}BusinessIdentifiesAs","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"subscriberId","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.DEIB.Responses.BusinessIdentifiesAs.GetStudioBusinessIdentifiesAsResponse"}},"401":{"description":"Unauthorized","schema":{"type":"string"}}}}},"/DEIB/{subscriberId}/CrowdSafeAs":{"get":{"tags":["Rest"],"summary":"Retrieve a list of all CrowdSafeAs that can be applied to a location.","operationId":"GETDEIB{subscriberId}CrowdSafeAs","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"subscriberId","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.DEIB.Responses.CrowdSafeAs.GetStudioCrowdSafeAsResponse"}},"401":{"description":"Unauthorized","schema":{"type":"string"}}}}},"/DEIB/{subscriberId}/Location/{locationId}/Amenities":{"get":{"tags":["Rest"],"summary":"Retrieve a list of all amenities assigned to the location indicated.","operationId":"GETDEIB{subscriberId}Location{locationId}Amenities","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"subscriberId","in":"path","description":"The subscriber in which the desired location is held.","required":true,"type":"integer","format":"int32"},{"name":"locationId","in":"path","description":"The location to retrieve assigned amenities for.","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.DEIB.Responses.Amenities.GetAllAmenitiesResponse"}},"401":{"description":"Unauthorized","schema":{"type":"string"}}}},"put":{"tags":["Rest"],"summary":"Updates the amenities list assigned to a specific location to the amenities specified in the body.","operationId":"PUTDEIB{subscriberId}Location{locationId}Amenities","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"subscriberId","in":"path","description":"The subscriber in which the desired location is held.","required":true,"type":"integer","format":"int32"},{"name":"locationId","in":"path","description":"The location to update assigned amenities for.","required":true,"type":"integer","format":"int32"},{"name":"amenityIds","in":"body","description":"The list of amenities to set the location's amenity list to.","required":true,"schema":{"type":"array","items":{"format":"int32","type":"integer"}}}],"responses":{"204":{"description":"NoContent","schema":{"$ref":"#/definitions/System.Void"}},"400":{"description":"BadRequest","schema":{"type":"string"}},"403":{"description":"Forbidden","schema":{"type":"string"}}}}},"/DEIB/{subscriberId}/Location/{locationId}/BusinessIdentifiesAs":{"get":{"tags":["Rest"],"summary":"Retrieve a list of all BusinessIdentifiesAs assigned to the location indicated.","operationId":"GETDEIB{subscriberId}Location{locationId}BusinessIdentifiesAs","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"subscriberId","in":"path","description":"The subscriber in which the desired location is held.","required":true,"type":"integer","format":"int32"},{"name":"locationId","in":"path","description":"The location to retrieve assigned BusinessIdentifiesAs for.","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.DEIB.Responses.BusinessIdentifiesAs.GetAllBusinessIdentifiesAsResponse"}},"401":{"description":"Unauthorized","schema":{"type":"string"}}}},"put":{"tags":["Rest"],"summary":"Updates the BusinessIdentifiesAs list assigned to a specific location to the BusinessIdentifiesAs specified in the body.","operationId":"PUTDEIB{subscriberId}Location{locationId}BusinessIdentifiesAs","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"subscriberId","in":"path","description":"The subscriber in which the desired location is held.","required":true,"type":"integer","format":"int32"},{"name":"locationId","in":"path","description":"The location to update assigned BusinessIdentifiesAs for.","required":true,"type":"integer","format":"int32"},{"name":"BusinessIdentifiesAsIds","in":"body","description":"The list of BusinessIdentifiesAs to set the location's BusinessIdentifiesAs list to.","required":true,"schema":{"type":"array","items":{"format":"int32","type":"integer"}}}],"responses":{"204":{"description":"NoContent","schema":{"$ref":"#/definitions/System.Void"}},"400":{"description":"BadRequest","schema":{"type":"string"}},"403":{"description":"Forbidden","schema":{"type":"string"}}}}},"/DEIB/{subscriberId}/Location/{locationId}/CrowdSafeAs":{"get":{"tags":["Rest"],"summary":"Retrieve a list of all CrowdSafeAs assigned to the location indicated.","operationId":"GETDEIB{subscriberId}Location{locationId}CrowdSafeAs","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"subscriberId","in":"path","description":"The subscriber in which the desired location is held.","required":true,"type":"integer","format":"int32"},{"name":"locationId","in":"path","description":"The location to retrieve assigned CrowdSafeAs for.","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.DEIB.Responses.CrowdSafeAs.GetAllCrowdSafeAsResponse"}},"401":{"description":"Unauthorized","schema":{"type":"string"}}}},"put":{"tags":["Rest"],"summary":"Updates the CrowdSafeAs list assigned to a specific location to the CrowdSafeAs specified in the body.","operationId":"PUTDEIB{subscriberId}Location{locationId}CrowdSafeAs","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"subscriberId","in":"path","description":"The subscriber in which the desired location is held.","required":true,"type":"integer","format":"int32"},{"name":"locationId","in":"path","description":"The location to update assigned CrowdSafeAs for.","required":true,"type":"integer","format":"int32"},{"name":"CrowdSafeAsIds","in":"body","description":"The list of CrowdSafeAs to set the location's CrowdSafeAs list to.","required":true,"schema":{"type":"array","items":{"format":"int32","type":"integer"}}}],"responses":{"204":{"description":"NoContent","schema":{"$ref":"#/definitions/System.Void"}},"400":{"description":"BadRequest","schema":{"type":"string"}},"403":{"description":"Forbidden","schema":{"type":"string"}}}}},"/DEIB/Amenities":{"get":{"tags":["Rest"],"summary":"Retrieve a list of all amenities that can be applied to a location.","operationId":"GETDEIBAmenities","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.DEIB.Responses.Amenities.GetAllAmenitiesResponse"}},"401":{"description":"Unauthorized","schema":{"type":"string"}}}}},"/DEIB/BusinessIdentifiesAs":{"get":{"tags":["Rest"],"summary":"Retrieve a list of all BusinessIdentifiesAs that can be applied to a location.","operationId":"GETDEIBBusinessIdentifiesAs","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.DEIB.Responses.BusinessIdentifiesAs.GetAllBusinessIdentifiesAsResponse"}},"401":{"description":"Unauthorized","schema":{"type":"string"}}}}},"/DEIB/CrowdSafeAs":{"get":{"tags":["Rest"],"summary":"Retrieve a list of all CrowdSafeAs that can be applied to a location.","operationId":"GETDEIBCrowdSafeAs","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.DEIB.Responses.CrowdSafeAs.GetAllCrowdSafeAsResponse"}},"401":{"description":"Unauthorized","schema":{"type":"string"}}}}},"/Documents/{id}/Signature":{"get":{"tags":["Rest"],"summary":"Find the signature image url for a specified sale.","operationId":"GETDocuments{id}Signature","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"id","in":"path","description":"Sale id of desired signature","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Documents.GetSaleSignatureUrlResponse"}},"401":{"description":"Unauthorized","schema":{"type":"string"}},"404":{"description":"NotFound"}}}},"/Documents/LiabilityRelease":{"post":{"tags":["Rest"],"summary":"Uploads a liability waiver for a consumer.\r\nExpects a file of type pdf,jpg,jpeg,tif,tiff,png,doc,docx,bmp,txt,rtf,xlsx,xls,gif,zip,ppt,pptx, or mov and size of less than 4194304 bytes. The name of the file is irrelevant.","operationId":"POSTDocumentsLiabilityRelease","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"consumerId","in":"query","description":"","required":false,"type":"string"}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Documents.UploadLiabilityReleaseResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Documents.UploadLiabilityReleaseResponse"}},"401":{"description":"Unauthorized","schema":{"type":"string"}},"415":{"description":"UnsupportedMediaType"}}}},"/Feedback":{"post":{"tags":["Rest"],"summary":"Endpoint used to process feedback requests.","operationId":"POSTFeedback","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"request","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Subscribers.Mobile.Controller.MobileFeedbackRequest"}}],"responses":{"204":{"description":"NoContent"},"400":{"description":"BadRequest","schema":{"type":"string"}},"401":{"description":"Unauthorized","schema":{"type":"string"}}}}},"/live_stream/eligibility":{"post":{"tags":["Rest"],"summary":"Callback registered with the live_stream API to ensure that a user is eligible join a live stream session","operationId":"POSTlive_streameligibility","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"request","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.LiveStream.LiveStreamEligibilityRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.LiveStream.LiveStreamEligibilityResponse"}},"400":{"description":"BadRequest","schema":{"type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Errors.Error"}}},"401":{"description":"Unauthorized","schema":{"type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Errors.Error"}}},"403":{"description":"Forbidden","schema":{"type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Errors.Error"}}}}}},"/live_stream_webhooks/status_changed":{"post":{"tags":["Rest"],"summary":"Callback registered with the live_stream API to ensure that a user is eligible join a live stream session","operationId":"POSTlive_stream_webhooksstatus_changed","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"request","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.LiveStream.LiveStreamStatusChangedRequest"}}],"responses":{"200":{"description":"OK"},"400":{"description":"BadRequest","schema":{"type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Errors.Error"}}},"403":{"description":"Forbidden","schema":{"type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Errors.Error"}}}}}},"/MobileAppVersions":{"get":{"tags":["Rest"],"summary":"Gets a list of mobile application versions.\r\nCan return version information specifically for a given product and platform. \r\nAuthorization Header not required but preferred","operationId":"GETMobileAppVersions","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"product","in":"query","description":"","required":false,"type":"string"},{"name":"platform","in":"query","description":"","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.MobileAppVersions.MobileAppVersion"}}},"400":{"description":"BadRequest","schema":{"type":"string"}},"503":{"description":"ServiceUnavailable","schema":{"type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.MobileAppVersions.MobileAppVersion"}}}}}},"/NetworkMetrics":{"get":{"tags":["Rest"],"summary":"Fetches network metric metadata filtered based on the provided request.","operationId":"GETNetworkMetrics","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"request.locationIds","in":"query","description":"Location ids to filter by","required":false,"type":"array","items":{"type":"integer","format":"int32"},"collectionFormat":"multi"},{"name":"request.startDate","in":"query","description":"Start date","required":false,"type":"string","format":"date-time"},{"name":"request.endDate","in":"query","description":"End date","required":false,"type":"string","format":"date-time"},{"name":"request.metricTypes","in":"query","description":"Metric types to filter by","required":false,"type":"array","items":{"type":"string","enum":["NewClientsCount","NewClientsMonetaryValue","BookingsCount","PurchasesMonetaryValue","IntroOffersCount","All"]},"collectionFormat":"multi"},{"name":"request.applicationTypes","in":"query","description":"Application types to filter by","required":false,"type":"array","items":{"type":"string","enum":["MobileApp","BusinessMode","ConsumerMode","Engage","ThirdParty","Overall","All"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/PrivacyPreferences/PrivacyPreferencesUrl":{"get":{"tags":["Rest"],"summary":"This endpoint will get the shortened privacy preferences URL for a Subscriber or MB App user\r\nIf the url is for a subscriber user, use the subscriberId and the consumerId.\r\nIf the url is for an MB App user, use the user email.","operationId":"GETPrivacyPreferencesPrivacyPreferencesUrl","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"requestType","in":"query","description":"","required":true,"type":"string","enum":["SubscriberPreferencesPage","MbUserPreferencesPage"]},{"name":"requestTarget","in":"query","description":"","required":true,"type":"string","enum":["PreferencesPage","DataOptions"]},{"name":"consumerId","in":"query","description":"","required":false,"type":"integer","format":"int64"},{"name":"subscriberId","in":"query","description":"","required":false,"type":"integer","format":"int32"},{"name":"userEmail","in":"query","description":"","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}},"deprecated":true}},"/Products/Inventory":{"get":{"tags":["Rest"],"summary":"Get inventory items","operationId":"GETProductsInventory","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"request.subscriberId","in":"query","description":"Subscriber ID to retrieve the inventory for","required":false,"type":"integer","format":"int32"},{"name":"request.itemType","in":"query","description":"Item type to filter. Possible values:\r\nRetail\r\nAccountCredit\r\nGiftCard\r\nServicePricingOption\r\nTip\r\nContractDeposit\r\nContractRegistrationFee\r\nPackage\r\nContract","required":false,"type":"string"},{"name":"request.itemId","in":"query","description":"Item ID to filter for specific item","required":false,"type":"integer","format":"int64"},{"name":"request.availableOnline","in":"query","description":"Filter for only online products","required":false,"type":"boolean"},{"name":"request.introductoryOffer","in":"query","description":"Filter for only intro offer pricing options","required":false,"type":"boolean"},{"name":"request.includeContractPricingOptions","in":"query","description":"When true, includes pricing options that are only available in contracts and packages.\r\nDefault is false.","required":false,"type":"boolean"},{"name":"request.serviceCategoryId","in":"query","description":"Filter by service category ID. The results include \r\nitems whose service category is related to the specified service category ID.","required":false,"type":"integer","format":"int32"},{"name":"request.locationId","in":"query","description":"Filter by location ID that the item is sold at","required":false,"type":"integer","format":"int32"},{"name":"request.lastUpdatedDate","in":"query","description":"Filter by last updated date","required":false,"type":"string","format":"date-time"},{"name":"request.revenueCategoryId","in":"query","description":"Filter by revenue category ID.","required":false,"type":"integer","format":"int32"},{"name":"request.orderBy","in":"query","description":"Value to order inventory by (ascending).\r\nPossible Values: Name, Default, [null]\r\nDefault/null sort is by Elastic SortOrder (ServiceCategoryId, then Name)","required":false,"type":"string"},{"name":"request.limit","in":"query","description":"Number of results to return, defaults to 100","required":false,"type":"integer","format":"int32"},{"name":"request.offset","in":"query","description":"Number of results to skip, defaults to 0","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Site.Controllers.GetInventoryResponse"}},"400":{"description":"BadRequest","schema":{"type":"string"}},"401":{"description":"Unauthorized","schema":{"type":"string"}}}}},"/Products/ScheduledProducts/Services":{"get":{"tags":["Rest"],"summary":"Finds and returns all of the Services for the current subscriber.","operationId":"GETProductsScheduledProductsServices","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Site.ScheduledProducts.Service"}}},"401":{"description":"Unauthorized","schema":{"type":"string"}},"404":{"description":"NotFound"}}}},"/Reviews/Classes/Report":{"post":{"tags":["Rest"],"summary":"Endpoint used to report MB class review abuse.","operationId":"POSTReviewsClassesReport","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"request","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Subscribers.ReviewsController.ClassReviewAbuseRequest"}}],"responses":{"204":{"description":"NoContent"},"400":{"description":"BadRequest","schema":{"type":"string"}},"401":{"description":"Unauthorized","schema":{"type":"string"}}}}},"/Settings":{"get":{"tags":["Rest"],"summary":"Gets settings from General Setup and Options page.","operationId":"GETSettings","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"request.categories","in":"query","description":"Categories of the site settings to retrieve.  If null, retrieve all settings.\r\nCategory possible values:\r\n- Client\r\n- Communication\r\n- General: General site settings.\r\n- Location: Site location settings.\r\n- Scheduling: Site scheduling settings, i.e. class and enrollments settings, etc.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"request.locationId","in":"query","description":"Location identifier if location settings are specified.  Will be ignored if location category is not \r\nspecified.","required":false,"type":"integer","format":"int32"},{"name":"request.dependentId","in":"query","description":"User identifier for an optional dependent account.  Retained for backwards compatibility only - the\r\nsettings returned are site-scoped and identical for every caller, so this value is ignored.","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Settings.Setting`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]"}}}}}},"/Settings/AppointmentOptions":{"get":{"tags":["Rest"],"summary":"Gets AppointmentOptions for a Subscriber","operationId":"GETSettingsAppointmentOptions","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Site.AppointmentOptions"}},"400":{"description":"BadRequest"},"401":{"description":"Unauthorized","schema":{"type":"string"}}}}},"/Settings/AutoEmail":{"get":{"tags":["Rest"],"summary":"Retrieves a subscriber's Auto Email Settings","operationId":"GETSettingsAutoEmail","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Site.AutoEmailSetting"}}},"401":{"description":"Unauthorized","schema":{"type":"string"}},"404":{"description":"NotFound"}}}},"/Settings/Clients/GenderOptions":{"get":{"tags":["Rest"],"summary":"Gets custom gender options for a specific subscriber.","operationId":"GETSettingsClientsGenderOptions","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"request.includeInactive","in":"query","description":"Include inactive gender options or not.","required":false,"type":"boolean"},{"name":"request.includeSystem","in":"query","description":"Include default/system gender options or not.","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Settings.Controllers.GetGenderOptionsResponse"}}}}},"/Settings/Countries":{"get":{"tags":["Rest"],"summary":"Gets list of all available countries.","operationId":"GETSettingsCountries","consumes":[],"produces":["application/json","text/json"],"parameters":[],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Settings.Country"}}},"401":{"description":"Unauthorized","schema":{"type":"string"}}}}},"/Settings/Countries/Territories":{"get":{"tags":["Rest"],"summary":"Gets a list of countries with the associated territories (states or provinces).","operationId":"GETSettingsCountriesTerritories","consumes":[],"produces":["application/json","text/json"],"parameters":[],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Settings.CountryWithTerritories"}}},"401":{"description":"Unauthorized","schema":{"type":"string"}}}}},"/Settings/LiabilityRelease":{"get":{"tags":["Rest"],"summary":"Retrieves a subscriber's Liability Release Waiver","operationId":"GETSettingsLiabilityRelease","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"stripHtml","in":"query","description":"Boolean flag used to determine whether strip the HTML from the waiver text and\r\n            intro paragraph (true) or not (false)","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Site.Settings.LiabilityRelease"}},"401":{"description":"Unauthorized","schema":{"type":"string"}},"404":{"description":"NotFound"}}},"put":{"tags":["Rest"],"summary":"Replaces a subscriber's Liability Release Waiver with the given resource.","operationId":"PUTSettingsLiabilityRelease","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"liabilityRelease","in":"body","required":true,"schema":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Site.Settings.LiabilityRelease"}}],"responses":{"204":{"description":"NoContent"},"401":{"description":"Unauthorized","schema":{"type":"string"}},"404":{"description":"NotFound"},"415":{"description":"UnsupportedMediaType"}}},"post":{"tags":["Rest"],"summary":"Adds a subscriber's Liability Release Waiver","operationId":"POSTSettingsLiabilityRelease","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"liabilityRelease","in":"body","required":true,"schema":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Site.Settings.LiabilityRelease"}}],"responses":{"201":{"description":"Created"},"401":{"description":"Unauthorized","schema":{"type":"string"}},"409":{"description":"Conflict"},"415":{"description":"UnsupportedMediaType"}}}},"/Settings/TaxTables/{id}":{"get":{"tags":["Rest"],"summary":"List of tax tables. Every location may have up to a maximum of 5 taxes. Tax values are represented as decimals.","operationId":"GETSettingsTaxTables{id}","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"id","in":"path","description":"Location Id. If this parameter is not provided all tax tables will be returned.","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Site.TaxTable"}}},"401":{"description":"Unauthorized","schema":{"type":"string"}},"404":{"description":"NotFound"}}},"put":{"tags":["Rest"],"summary":"Replaces tax tables with the given resource. Each location may have up to a maximum of 5 taxes.","operationId":"PUTSettingsTaxTables{id}","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"id","in":"path","description":"Location Id.","required":true,"type":"integer","format":"int32"},{"name":"taxTable","in":"body","description":"A tax table. Tax values are represented as decimals. If a value is not provided it will be set to null and the tax rate will not be active. (If you want a rate of 0 tax set it.)","required":true,"schema":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Site.TaxTable"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Unauthorized","schema":{"type":"string"}},"404":{"description":"NotFound"},"415":{"description":"UnsupportedMediaType"}}}},"/SmokeTest/Ping":{"get":{"tags":["Rest"],"summary":"The ping endpoint for the application","operationId":"GETSmokeTestPing","consumes":[],"produces":["application/json","text/json"],"parameters":[],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/SmokeTest/Ready":{"get":{"tags":["Rest"],"summary":"Endpoint for readiness probe to check mandatory services are available","operationId":"GETSmokeTestReady","consumes":[],"produces":["application/json","text/json"],"parameters":[],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/SmokeTest/Status":{"get":{"tags":["Rest"],"summary":"Check status","operationId":"GETSmokeTestStatus","consumes":[],"produces":["application/json","text/json"],"parameters":[],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/SmtpSettings":{"put":{"tags":["Rest"],"summary":"Updates the SMTP settings for the subscriber","operationId":"PUTSmtpSettings","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"settings","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Notifications.SmtpSettings"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Notifications.SmtpSettings"}},"401":{"description":"Unauthorized","schema":{"type":"string"}},"500":{"description":"InternalServerError"}}}},"/SmtpSettings/Test":{"post":{"tags":["Rest"],"summary":"Sends a test email to the provided address with the given custom settings","operationId":"POSTSmtpSettingsTest","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"to","in":"query","description":"The email address to send the message to","required":true,"type":"string"},{"name":"settings","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Notifications.CustomSmtpSettings"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Notifications.CustomSmtpSettings"}},"400":{"description":"BadRequest"},"401":{"description":"Unauthorized","schema":{"type":"string"}},"403":{"description":"Forbidden"},"500":{"description":"InternalServerError"}}}},"/Subscribers/Businessinformation":{"get":{"tags":["Rest"],"summary":"Finds business information for a business.","operationId":"GETSubscribersBusinessinformation","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Site.BusinessInformation"}},"401":{"description":"Unauthorized","schema":{"type":"string"}},"404":{"description":"NotFound"}}},"put":{"tags":["Rest"],"summary":"Replaces the business information for a business with the given resource.","operationId":"PUTSubscribersBusinessinformation","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"businessInformation","in":"body","description":"Business information to replace with.","required":true,"schema":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Site.BusinessInformation"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Unauthorized","schema":{"type":"string"}},"404":{"description":"NotFound"},"415":{"description":"UnsupportedMediaType"}}}},"/Subscribers/Businessinformation/Owner":{"get":{"tags":["Rest"],"summary":"Finds Owner information for a business.","operationId":"GETSubscribersBusinessinformationOwner","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"request.includeCorporateUser","in":"query","description":"It would include corporate user too. By default it's false","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Site.Owner"}}},"401":{"description":"Unauthorized","schema":{"type":"string"}},"404":{"description":"NotFound"}}}},"/Subscribers/Businessinformation/UnmigratedOwners":{"get":{"tags":["Rest"],"summary":"Finds owner logins which have not been migrated to Staff Identity.","operationId":"GETSubscribersBusinessinformationUnmigratedOwners","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Site.UnmigratedStaffLogin"}}},"401":{"description":"Unauthorized","schema":{"type":"string"}}}}},"/Subscribers/LocationCounts":{"get":{"tags":["Rest"],"summary":"Get aggregated location count for specified studio IDs. \r\nIf date range is not specified, it defaults to today's date. \r\nIf endDate is not specified, it will be set to startDate vice versa.\r\nTime part of the date range will be ignored.","operationId":"GETSubscribersLocationCounts","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"request.studioIds","in":"query","description":"Studio IDs to filter","required":false,"type":"array","items":{"type":"integer","format":"int32"},"collectionFormat":"multi"},{"name":"request.startDate","in":"query","description":"Start date to filter location count date","required":false,"type":"string","format":"date-time"},{"name":"request.endDate","in":"query","description":"End date to filter location count date","required":false,"type":"string","format":"date-time"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Subscribers.LocationCountController.StudioLocationCount"}}},"400":{"description":"BadRequest","schema":{"type":"string"}},"401":{"description":"Unauthorized","schema":{"type":"string"}}}}},"/Subscribers/Locations/{locationId}":{"get":{"tags":["Rest"],"summary":"Find and returns location information for the given location within a given studio.","operationId":"GETSubscribersLocations{locationId}","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"locationId","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Location.Location"}},"401":{"description":"Unauthorized","schema":{"type":"string"}}}}},"/Subscribers/SiteInformation":{"get":{"tags":["Rest"],"summary":"Finds basic site info.","operationId":"GETSubscribersSiteInformation","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"studioId","in":"query","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Subscribers.SiteInformationController.GetSiteInformationResponse"}},"404":{"description":"NotFound"}}}},"/Subscribers/SiteInformation/MbAccountNumbers":{"get":{"tags":["Rest"],"summary":"Find all MbAccountNumbers for active locations within a given studio","operationId":"GETSubscribersSiteInformationMbAccountNumbers","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"studioId","in":"query","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"type":"string"}}},"401":{"description":"Unauthorized","schema":{"type":"string"}}}}},"/Subscribers/SiteInformation/Region":{"get":{"tags":["Rest"],"summary":"Finds and returns region info for site.","operationId":"GETSubscribersSiteInformationRegion","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Subscribers.SiteInformationController.GetRegionInfoResponse"}},"401":{"description":"Unauthorized","schema":{"type":"string"}}}}},"/Subscribers/SiteInformation/Search":{"get":{"tags":["Rest"],"summary":"Finds and returns basic site info for sites that fit the search criteria.","operationId":"GETSubscribersSiteInformationSearch","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"request.searchText","in":"query","description":"(optional) A search string used to filter down the returned results.","required":false,"type":"string"},{"name":"request.relatedSiteId","in":"query","description":"(optional) Returns all sites related to given site id.","required":false,"type":"integer","format":"int32"},{"name":"request.showOnlyTotalWod","in":"query","description":"(optional) Returns all sites related to given site id.","required":false,"type":"boolean"},{"name":"request.limit","in":"query","description":"Number of results to return, defaults to 100","required":false,"type":"integer","format":"int32"},{"name":"request.offset","in":"query","description":"Number of results to skip, defaults to 0","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Subscribers.SiteInformationController.SearchSitesResponse"}},"401":{"description":"Unauthorized","schema":{"type":"string"}}}}},"/Subscribers/Studios":{"get":{"tags":["Rest"],"summary":"Retrieve basic information for all subscribers. \r\nMax page limit is 3000","operationId":"GETSubscribersStudios","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"request.includeInactive","in":"query","description":"Includes inactive (deleted and deactivated) ones.\r\nDefaults to false.","required":false,"type":"boolean"},{"name":"request.limit","in":"query","description":"Number of results to return, defaults to 100","required":false,"type":"integer","format":"int32"},{"name":"request.offset","in":"query","description":"Number of results to skip, defaults to 0","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Subscribers.StudiosController.GetStudiosResponse"}},"400":{"description":"BadRequest","schema":{"type":"string"}},"401":{"description":"Unauthorized","schema":{"type":"string"}},"403":{"description":"Forbidden","schema":{"type":"string"}}}}},"/Subscribers/Studios/BusinessInformation":{"get":{"tags":["Rest"],"summary":"Retrieve business information for specified studio IDs\r\nseparated by a comma. Studio IDs limit is 100.","operationId":"GETSubscribersStudiosBusinessInformation","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"studioIds","in":"query","description":"","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Subscribers.StudiosController.StudioBusinessInfo"}}},"400":{"description":"BadRequest","schema":{"type":"string"}},"401":{"description":"Unauthorized","schema":{"type":"string"}},"403":{"description":"Forbidden","schema":{"type":"string"}}}}},"/Subscribers/Studios/UpdateStudioModuleType":{"patch":{"tags":["Rest"],"summary":"Update Studio Module type in Subscriber DB and WsMaster DB","operationId":"PATCHSubscribersStudiosUpdateStudioModuleType","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"siteIds","in":"body","description":"","required":true,"schema":{"type":"array","items":{"format":"int32","type":"integer"}}}],"responses":{"200":{"description":"OK"},"400":{"description":"BadRequest","schema":{"type":"string"}},"401":{"description":"Unauthorized","schema":{"type":"string"}},"403":{"description":"Forbidden","schema":{"type":"string"}}}}},"/Subscribers/Tabs":{"get":{"tags":["Rest"],"summary":"Finds tab information for a site.","operationId":"GETSubscribersTabs","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"request.includeConsumerTabs","in":"query","description":"Whether to include consumer mode tabs.","required":false,"type":"boolean"},{"name":"request.includeBusinessTabs","in":"query","description":"Whether to include business mode tabs.","required":false,"type":"boolean"},{"name":"request.includeSystemTabs","in":"query","description":"Whether to include system tabs.","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Subscribers.TabsController.GetTabsResponse"}}}}},"/Users/{id}/RequestPasswordChange":{"post":{"tags":["Rest"],"summary":"Requests a password reset/change for the user. \r\n\r\nThis sends the user an email with instructions on how to change their password.","operationId":"POSTUsers{id}RequestPasswordChange","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"id","in":"path","description":"the user id","required":true,"type":"integer","format":"int32"}],"responses":{"204":{"description":"NoContent"},"401":{"description":"Unauthorized","schema":{"type":"string"}},"404":{"description":"NotFound","schema":{"type":"string"}}}}},"/Users/AuthorizationInformation":{"post":{"tags":["Rest"],"summary":"Gets additional user authorization information needed for Arcus APIs.","operationId":"POSTUsersAuthorizationInformation","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"request","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Users.AuthorizationInformationRequest"}}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/Users/Classes/{classInstanceId}/Visit":{"patch":{"tags":["Rest"],"summary":"Updates a particular class visit for a consumer by finding it using class instance ID","operationId":"PATCHUsersClasses{classInstanceId}Visit","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"classInstanceId","in":"path","description":"The unique identifier of the class instance whoes class visit to update","required":true,"type":"integer","format":"int32"},{"name":"request","in":"body","description":"The updated class visit by using class instance ID and client ID","required":true,"schema":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Users.Controllers.UpdateClassVisitForConsumerRequest"}}],"responses":{"204":{"description":"NoContent"},"400":{"description":"BadRequest","schema":{"type":"string"}},"401":{"description":"Unauthorized","schema":{"type":"string"}},"403":{"description":"Forbidden","schema":{"type":"string"}},"404":{"description":"NotFound","schema":{"type":"string"}}}}},"/users/client":{"post":{"tags":["Rest"],"summary":"Create a new client profile","operationId":"POSTusersclient","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"request","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Client.CreateClientProfileRequest"}}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Client.ClientProfile"}},"400":{"description":"BadRequest","schema":{"type":"string"}},"401":{"description":"Unauthorized","schema":{"type":"string"}},"403":{"description":"Forbidden","schema":{"type":"string"}},"404":{"description":"NotFound"}}}},"/users/client/{clientId}":{"get":{"tags":["Rest"],"summary":"Gets a client profile at a studio","operationId":"GETusersclient{clientId}","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"clientId","in":"path","description":"Unique ID of the client","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Client.ClientProfile"}}}}},"/users/client/{clientId}/FormulaNotes":{"get":{"tags":["Rest"],"summary":"Gets the formula notes for a client","operationId":"GETusersclient{clientId}FormulaNotes","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"clientId","in":"path","description":"Unique ID of the client","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Site.Clients.ClientNotes"}}}}},"/users/client/{clientId}/notes":{"get":{"tags":["Rest"],"summary":"Gets the notes section from a client profile at a studio","operationId":"GETusersclient{clientId}notes","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"clientId","in":"path","description":"Unique ID of the client","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Site.Clients.ClientNotes"}}}}},"/users/client/ClientsProfile":{"post":{"tags":["Rest"],"summary":"Gets multiple client profile with image url at a studio","operationId":"POSTusersclientClientsProfile","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"clientsProfileRequest","in":"body","description":"Unique ID of the client","required":true,"schema":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Client.ClientsProfileRequest"}},{"name":"includeImage","in":"query","description":"Opition to include client image with response, default value false","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Client.ClientProfileAndImage"}}},"400":{"description":"BadRequest","schema":{"type":"string"}},"404":{"description":"NotFound"}}}},"/users/client/LiabilityReleaseStatus":{"get":{"tags":["Rest"],"summary":"Get the user liability waiver status (if User has signed then check for the latest waiver is signed or not)","operationId":"GETusersclientLiabilityReleaseStatus","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"clientId","in":"query","description":"Subscriber consumer ID","required":false,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Client.ClientLiabilityReleaseStatus"}},"401":{"description":"Unauthorized","schema":{"type":"string"}},"404":{"description":"NotFound"}}}},"/Users/ClientSeries":{"get":{"tags":["Rest"],"summary":"Gets all the available sessions for a client at a studio","operationId":"GETUsersClientSeries","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"clientId","in":"query","description":"","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Users.ClientSeries"}}},"401":{"description":"Unauthorized","schema":{"type":"string"}},"403":{"description":"Forbidden"}}}},"/Users/Get/FlexMembershipUsers":{"get":{"tags":["Rest"],"summary":"Gets a list of users who has subscribed for flex membership matching the provided search keyword query.\r\nFind by FirstName, LastName, Email, or ID","operationId":"GETUsersGetFlexMembershipUsers","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"searchKeyword","in":"query","description":"Query parameters","required":true,"type":"string"},{"name":"rows","in":"query","description":"Maximum no of rows: 200","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Users.Controllers.UserIdentityResponse"}},"400":{"description":"BadRequest","schema":{"type":"string"}},"401":{"description":"Unauthorized","schema":{"type":"string"}},"404":{"description":"NotFound","schema":{"type":"string"}}}}},"/Users/NotificationPreferences":{"get":{"tags":["Rest"],"summary":"Get the notification preferences for an existing consumer","operationId":"GETUsersNotificationPreferences","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"consumerId","in":"query","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}},"post":{"tags":["Rest"],"summary":"Create or update notification preferences for an existing consumer","operationId":"POSTUsersNotificationPreferences","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"preferences","in":"body","required":true,"schema":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Users.ConsumerNotificationPreferencesRequest"}}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/Users/Staff":{"get":{"tags":["Rest"],"summary":"The way to find all staff or a single staff member.","operationId":"GETUsersStaff","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"request.staffIds","in":"query","description":"(optional) A requested list of staffIDs.","required":false,"type":"array","items":{"type":"integer","format":"int64"},"collectionFormat":"multi"},{"name":"request.staffCredentials.username","in":"query","description":"Username of the staff member.","required":false,"type":"string"},{"name":"request.staffCredentials.password","in":"query","description":"Password of the staff member.","required":false,"type":"string"},{"name":"request.staffCredentials.siteIds","in":"query","description":"A list of Sites / Subscribers that the staff member has access to.","required":false,"type":"array","items":{"type":"integer","format":"int32"},"collectionFormat":"multi"},{"name":"request.filters","in":"query","description":"(optional) A list of filters applied to the search.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"request.sessionTypeId","in":"query","description":"(optional) Filter search by staff that are available for specified SessionTypeID.  Must be used with a valid StartDateTime value and LocationID.","required":false,"type":"integer","format":"int32"},{"name":"request.startDateTime","in":"query","description":"(optional) Filter search by staff that are available at specified date and time.  Must be used with a valid SessionTypeID and LocationID.","required":false,"type":"string","format":"date-time"},{"name":"request.locationId","in":"query","description":"(optional) Filter search by staff that are available at specified location.  Must be used with a valid SessionTypeID and StartDateTime.","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Site.Staff"}}},"400":{"description":"BadRequest","schema":{"type":"string"}},"401":{"description":"Unauthorized","schema":{"type":"string"}}}},"put":{"tags":["Rest"],"summary":"Replaces the staff member with the given resource.","operationId":"PUTUsersStaff","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"staff","in":"body","description":"The staff to replace with.","required":true,"schema":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Site.Users.Staff"}}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Site.Users.Staff"}}},"400":{"description":"BadRequest","schema":{"type":"string"}},"401":{"description":"Unauthorized","schema":{"type":"string"}}}},"post":{"tags":["Rest"],"summary":"Adds the staff member.","operationId":"POSTUsersStaff","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"staff","in":"body","description":"The staff member to add","required":true,"schema":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Site.Users.Staff"}}],"responses":{"200":{"description":"OK"},"400":{"description":"BadRequest","schema":{"type":"string"}},"401":{"description":"Unauthorized","schema":{"type":"string"}},"415":{"description":"UnsupportedMediaType"}}}},"/Users/Staff/ClockIn":{"post":{"tags":["Rest"],"summary":"Do ClockIn for current staff.","operationId":"POSTUsersStaffClockIn","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"timeClockInOutRequest","in":"body","required":true,"schema":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Users.Controllers.ClockInOut.TimeClockInRequest"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Unauthorized","schema":{"type":"string"}}}}},"/Users/Staff/ClockInOutWidgetInformation":{"get":{"tags":["Rest"],"summary":"Gets current staff clockin/out information for Arcus APIs.","operationId":"GETUsersStaffClockInOutWidgetInformation","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""}],"responses":{"200":{"description":"OK"},"401":{"description":"Unauthorized","schema":{"type":"string"}}}}},"/Users/Staff/ClockOut":{"post":{"tags":["Rest"],"summary":"Do ClockOut for Current Staff.","operationId":"POSTUsersStaffClockOut","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"timeClockInOutRequest","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Users.Controllers.ClockInOut.TimeClockOutRequest"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Unauthorized","schema":{"type":"string"}}}}},"/Users/Staff/PermissionInformation":{"get":{"tags":["Rest"],"summary":"Gets current staff permission information needed for Arcus APIs.","operationId":"GETUsersStaffPermissionInformation","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""}],"responses":{"200":{"description":"OK"},"401":{"description":"Unauthorized","schema":{"type":"string"}}}}},"/Users/Staff/VisitorStatus":{"get":{"tags":["Rest"],"summary":"Gets Visitor status for current user login if user is visitor type staff or not","operationId":"GETUsersStaffVisitorStatus","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""}],"responses":{"200":{"description":"OK"},"401":{"description":"Unauthorized","schema":{"type":"string"}}}}},"/Users/UserInfo":{"post":{"tags":["Rest"],"summary":"Gets user information by id or email.","operationId":"POSTUsersUserInfo","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"request","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Users.Controllers.UserInfoRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Users.Controllers.UserResponse"}},"401":{"description":"Unauthorized","schema":{"type":"string"}},"404":{"description":"NotFound","schema":{"type":"string"}}}}},"/Users/Visits/{id}/Classes":{"put":{"tags":["Rest"],"summary":"Updates a user's class visit.","operationId":"PUTUsersVisits{id}Classes","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"id","in":"path","description":"The unique identifier for the class visit to update","required":true,"type":"integer","format":"int64"},{"name":"request","in":"body","description":"The updated class visit","required":true,"schema":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Users.ClassVisit"}}],"responses":{"204":{"description":"NoContent"},"400":{"description":"BadRequest","schema":{"type":"string"}},"401":{"description":"Unauthorized","schema":{"type":"string"}},"404":{"description":"NotFound","schema":{"type":"string"}}}}},"/video_on_demand/eligibility":{"post":{"tags":["Rest"],"summary":"Callback registered with the live_stream API to ensure that a user is eligible to view the video on demand content","operationId":"POSTvideo_on_demandeligibility","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"UserProfileId","in":"header","description":"User ProfileId","required":false,"type":"integer","default":""},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""}],"responses":{"200":{"description":"OK"},"400":{"description":"BadRequest","schema":{"type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Errors.Error"}}},"401":{"description":"Unauthorized","schema":{"type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Errors.Error"}}},"403":{"description":"Forbidden","schema":{"type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Errors.Error"}}}}}},"/WaiverForm/AccessLog":{"get":{"tags":["Rest"],"summary":"Gets a list of all the forms associated with the provided form identifiers.","operationId":"GETWaiverFormAccessLog","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"formId","in":"query","description":"","required":true,"type":"string"}],"responses":{"200":{"description":"OK"},"400":{"description":"BadRequest","schema":{"type":"string"}},"401":{"description":"Unauthorized","schema":{"type":"string"}}}}},"/WaiverForm/Delete":{"post":{"tags":["Rest"],"summary":"Delete Completed client form based on the formID","operationId":"POSTWaiverFormDelete","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"formId","in":"query","description":"","required":true,"type":"string"}],"responses":{"200":{"description":"OK"},"400":{"description":"BadRequest","schema":{"type":"string"}},"401":{"description":"Unauthorized","schema":{"type":"string"}}}}},"/WaiverForm/FormsCountByAppointment":{"get":{"tags":["Rest"],"summary":"Fetch count of pending/completed forms for a given appointment by client.","operationId":"GETWaiverFormFormsCountByAppointment","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"appointmentId","in":"query","description":"","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK"},"400":{"description":"BadRequest","schema":{"type":"string"}},"401":{"description":"Unauthorized","schema":{"type":"string"}}}}},"/WaiverForm/FormsCountByClassInstance":{"get":{"tags":["Rest"],"summary":"Fetch count of forms (Pending/Completed) for all clients in a given class instance.","operationId":"GETWaiverFormFormsCountByClassInstance","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"classInstanceId","in":"query","description":"This is the class instance is","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK"},"400":{"description":"BadRequest","schema":{"type":"string"}},"401":{"description":"Unauthorized","schema":{"type":"string"}}}}},"/WaiverForm/GetFormsByAppointmentId":{"get":{"tags":["Rest"],"summary":"Fetch list of forms for a given appointment.\r\nResults are sorted by form state (pending first, completed last),\r\nreverse chronological order (most recent first).","operationId":"GETWaiverFormGetFormsByAppointmentId","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"appointmentId","in":"query","description":"","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK"},"400":{"description":"BadRequest","schema":{"type":"string"}},"401":{"description":"Unauthorized","schema":{"type":"string"}}}}},"/WaiverForm/GetFormsByClassInstanceId":{"get":{"tags":["Rest"],"summary":"Fetch list of forms for all clients in a given class instance.\r\nResults are sorted by form state (pending first, completed last),\r\nreverse chronological order (most recent first).","operationId":"GETWaiverFormGetFormsByClassInstanceId","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"classInstanceId","in":"query","description":"","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK"},"400":{"description":"BadRequest","schema":{"type":"string"}},"401":{"description":"Unauthorized","schema":{"type":"string"}}}}},"/WaiverForm/GetFormsWithPagination":{"get":{"tags":["Rest"],"summary":"Fetch list of all forms for a given consumer\r\nBy default, results are sorted by form state (pending first, completed last),\r\nreverse chronological order (most recent first). Response is paginated.","operationId":"GETWaiverFormGetFormsWithPagination","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"clientId","in":"query","description":"","required":true,"type":"integer","format":"int64"},{"name":"pageNumber","in":"query","description":"","required":true,"type":"integer","format":"int32"},{"name":"pageSize","in":"query","description":"","required":true,"type":"integer","format":"int32"},{"name":"sortBy","in":"query","description":"","required":true,"type":"string","enum":["name","state","submissionDate"]}],"responses":{"200":{"description":"OK"},"400":{"description":"BadRequest","schema":{"type":"string"}},"401":{"description":"Unauthorized","schema":{"type":"string"}}}}},"/WaiverForm/Regenerate":{"post":{"tags":["Rest"],"summary":"Mark delete client form based on the formId\r\nRegenerate client form in pending state","operationId":"POSTWaiverFormRegenerate","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"formId","in":"query","description":"","required":true,"type":"string"}],"responses":{"200":{"description":"OK"},"400":{"description":"BadRequest","schema":{"type":"string"}},"401":{"description":"Unauthorized","schema":{"type":"string"}}}}},"/WaiverForm/ResendBookingConfirmationEmail":{"post":{"tags":["Rest"],"summary":"Request to resend a form to a consumer","operationId":"POSTWaiverFormResendBookingConfirmationEmail","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer {user_token}","required":true,"type":"string","default":"Bearer "},{"name":"SiteId","in":"header","description":"Site ID","required":true,"type":"integer","default":""},{"name":"formId","in":"query","description":"","required":true,"type":"string"}],"responses":{"200":{"description":"OK"},"400":{"description":"BadRequest","schema":{"type":"string"}},"401":{"description":"Unauthorized","schema":{"type":"string"}}}}}},"definitions":{"MindbodyApi.Models.Dashboard.DashboardRequestModel":{"description":"model for making requests for dashboard data","type":"object","properties":{"DateRange":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Site.NetworkDashboard.DateRange","description":"date range for data"},"LocationIds":{"description":"Location Ids to grab data for","type":"array","items":{"format":"int32","type":"integer"}},"Accrual":{"description":"Whether to get data on an accrual basis or cash","type":"boolean"},"YearOverYear":{"description":"Whether to get comparison data year over year or month over month","type":"boolean"}}},"Mindbody.RestApi.Common.Models.Site.NetworkDashboard.DateRange":{"type":"object","properties":{"Start":{"format":"date-time","type":"string"},"End":{"format":"date-time","type":"string"}}},"MindbodyApi.Models.Dashboard.SummaryData":{"description":"Dashboard Summary Data","type":"object","properties":{"Total":{"format":"double","description":"The total amount of sales","type":"number"},"LastMonthTotal":{"format":"double","description":"The total percent changes in sales","type":"number"},"TotalGraph":{"description":"The total plot data","type":"array","items":{"format":"double","type":"number"}},"Products":{"format":"double","description":"The total amount of product sales","type":"number"},"LastMonthProducts":{"format":"double","description":"The total percent changes in product sales","type":"number"},"ProductsGraph":{"description":"The total plot data","type":"array","items":{"format":"double","type":"number"}},"NewContracts":{"format":"int32","description":"The total amount of new contract sales","type":"integer"},"LastMonthNewContracts":{"format":"int32","description":"The total percent changes in new contract sales","type":"integer"},"NewContractsGraph":{"description":"The total plot data","type":"array","items":{"format":"int32","type":"integer"}},"OnlineBookings":{"format":"int32","description":"The total amount of online booking sales","type":"integer"},"LastMonthOnlineBookings":{"format":"int32","description":"The total percent changes in online booking sales","type":"integer"},"OnlineBookingsGraph":{"description":"The total plot data","type":"array","items":{"format":"int32","type":"integer"}},"Attendance":{"format":"int32","description":"The total amount of attendance sales","type":"integer"},"LastMonthAttendance":{"format":"int32","description":"The total percent changes in attendance sales","type":"integer"},"AttendanceGraph":{"description":"The total plot data","type":"array","items":{"format":"int32","type":"integer"}},"FirstVisits":{"format":"int32","description":"The total amount of first visit sales","type":"integer"},"LastMonthFirstVisits":{"format":"int32","description":"The total percent changes in first visit sales","type":"integer"},"FirstVisitsGraph":{"description":"The total plot data for first visits","type":"array","items":{"format":"int32","type":"integer"}},"ComparisonDateRangeStart":{"description":"The date range start used for comparing summary totals","type":"string"},"ComparisonDateRangeEnd":{"description":"The date range end used for comparing summary totals","type":"string"}}},"Mindbody.RestApi.Dto.Models.Site.Controller.GetStaffRequest":{"description":"Request for the GetStaff endpoint.","type":"object","properties":{"StaffIds":{"description":"(optional) A requested list of staffIDs.","type":"array","items":{"format":"int64","type":"integer"}},"StaffCredentials":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Site.StaffCredentials","description":"(optional) A set of staff login credentials to search for."},"Filters":{"description":"(optional) A list of filters applied to the search.","type":"array","items":{"type":"string"}},"SessionTypeId":{"format":"int32","description":"(optional) Filter search by staff that are available for specified SessionTypeID.  Must be used with a valid StartDateTime value and LocationID.","type":"integer"},"StartDateTime":{"format":"date-time","description":"(optional) Filter search by staff that are available at specified date and time.  Must be used with a valid SessionTypeID and LocationID.","type":"string"},"LocationId":{"format":"int32","description":"(optional) Filter search by staff that are available at specified location.  Must be used with a valid SessionTypeID and StartDateTime.","type":"integer"}}},"Mindbody.RestApi.Dto.Models.Site.StaffCredentials":{"description":"Credentials for a staff member.","type":"object","properties":{"Username":{"description":"Username of the staff member.","type":"string"},"Password":{"description":"Password of the staff member.","type":"string"},"SiteIds":{"description":"A list of Sites / Subscribers that the staff member has access to.","type":"array","items":{"format":"int32","type":"integer"}}}},"Mindbody.RestApi.Dto.Models.Site.Staff":{"description":"Object that represents a staff member with more information.","type":"object","properties":{"Nickname":{"description":"Nickname for the staff member.  Maps to TrDear in DB.","type":"string"},"Address":{"description":"Address of the staff member.","type":"string"},"Address2":{"description":"Second line of the address of the staff member.","type":"string"},"City":{"description":"The city the staff is in.","type":"string"},"State":{"description":"The state the staff is in.","type":"string"},"PostalCode":{"description":"The postal code for the staff.","type":"string"},"ForeignZip":{"description":"Foreign postal code for staff","type":"string"},"Country":{"description":"The country the staff is in.","type":"string"},"WorkPhone":{"description":"The work phone number for the staff.","type":"string"},"WorkExt":{"description":"The work extension number for the staff's work phone number.","type":"string"},"HomePhone":{"description":"The home phone number for the staff member.","type":"string"},"CellPhone":{"description":"The cell phone number of the staff.","type":"string"},"PhoneNumber":{"description":"Computed between the three available","type":"string","readOnly":true},"Pager":{"description":"The pager number of the staff if applicable.","type":"string"},"FaxNumber":{"description":"The fax number of the staff.","type":"string"},"Birthdate":{"format":"date-time","description":"The birthdate of the staff.","type":"string"},"Notes":{"description":"The notes for the staff.","type":"string"},"Teacher":{"description":"If the staff is a teacher or not.","type":"boolean"},"MassageTherapist":{"description":"If the staff is a massage therapist.","type":"boolean"},"WorkshopInstructor":{"description":"If the staff is a workshop instructor.","type":"boolean"},"Employee":{"description":"If the staff is an employee.","type":"boolean"},"Active":{"description":"If the staff is active.","type":"boolean"},"Deleted":{"description":"If the staff is deleted.","type":"boolean"},"Locked":{"description":"If the staff is locked.","type":"boolean"},"Location":{"format":"int32","description":"The studio location of the staff if there are more than 1 studio location possibilities.","type":"integer"},"Closed":{"description":"If the staff is closed.","type":"boolean"},"Assistant":{"description":"If the staff can be an assistant.","type":"boolean"},"Ssn":{"description":"The social security number of the staff.","type":"string"},"Assistant2":{"description":"If the staff can be an assistant2.","type":"boolean"},"EmpID":{"description":"The employee ID of the staff.","type":"string"},"CanBeAssignedFollowups":{"description":"If the staff can be assigned followups. Maps to CRM in the DB.","type":"boolean"},"HourlyRate":{"format":"double","description":"The hourly rate of the staff.","type":"number"},"StdStaffCommissionPercRate":{"format":"float","description":"The standard staff commission percent rate.","type":"number"},"StdStaffCommissionFlatRate":{"format":"double","description":"The standard staff commission flat rate.","type":"number"},"PromoStaffCommissionPercRate":{"format":"float","description":"The promo staff commission flat rate.","type":"number"},"PromoStaffCommissionFlatRate":{"format":"double","description":"The promo staff commission flat rate.","type":"number"},"EarnsCommissions":{"description":"If the staff earns commissions.","type":"boolean"},"AppointmentStaff":{"description":"If the staff is an appointment trainer.","type":"boolean"},"ReservationStaff":{"description":"If the staff is a reservation trainer.","type":"boolean"},"DefaultDeptID":{"description":"The default department ID of the staff.","type":"string"},"Rep1":{"description":"If the staff is a rep1 for clients.","type":"boolean"},"Rep2":{"description":"If the staff is a rep2 for clients.","type":"boolean"},"Rep3":{"description":"If the staff is a rep3 for clients.","type":"boolean"},"Rep4":{"description":"If the staff is a rep4 for clients.","type":"boolean"},"Rep5":{"description":"If the staff is a rep5 for clients.","type":"boolean"},"Rep6":{"description":"If the staff is a rep6 for clients.","type":"boolean"},"EarnsTips":{"description":"If the staff earns tips.","type":"boolean"},"HideInPayrollExport":{"description":"If the staff is hidden in payroll exports.","type":"boolean"},"DisableAttachments":{"description":"If the staff has attachments disabled.","type":"boolean"},"EmploymentEnd":{"format":"date-time","description":"The staff's Employment end date.","type":"string"},"EmploymentStart":{"format":"date-time","description":"The staff's Employment start date.","type":"string"},"IndependentContractor":{"description":"If the staff is an independent contractor.","type":"boolean"},"GoogleCalUserName":{"description":"The google calendar user name for the staff.","type":"string"},"GoogleCalID":{"description":"The google calendar ID for the staff.","type":"string"},"MobileProvider":{"format":"int32","description":"The Mobile provider enum for the staff.","type":"integer"},"AutomatedContactMethod":{"format":"int32","description":"The automated contact method for the staff.","type":"integer"},"IsSystem":{"description":"If the staff is a system staff.","type":"boolean"},"LastGoogleSyncStart":{"format":"date-time","description":"The date of the last google sync start.","type":"string"},"LastGoogleSyncEnd":{"format":"date-time","description":"The date of the last google sync end.","type":"string"},"AlwaysAllowDoubleBooking":{"description":"If double booking is always allowed.","type":"boolean"},"NameForDropDown":{"description":"Name of the staff member.","type":"string","readOnly":true},"ImageURL":{"description":"The staff member's profile image URL. It will not be returned if it does not exist.","type":"string"},"IsSalesRep":{"description":"Whether or not this staff member can be a client rep.","type":"boolean","readOnly":true},"IsOwner":{"description":"If the staff is a HIPAA-fied owner.","type":"boolean"},"MindbodyEmailOptIn":{"description":"Whether the staff is opted in for Mindbody emails.","type":"boolean"},"CreationDateTime":{"format":"date-time","description":"Creation date of the staff member.","type":"string"},"UserAccessLevel":{"description":"User access level for the staff.\r\nNote: This is only available when providing staff credentials.","type":"string"},"IsServiceProvider":{"description":"Flag set for staff that have had services booked within last 30 days.","type":"boolean"},"LoginLocations":{"description":"Login locations for the staff member.","type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Site.LoginLocation"}},"Gender":{"description":"Gender of the staff member.  Male if true, female if false.","type":"boolean"},"Bio":{"description":"The staff member's biography information.","type":"string"},"ProviderIDs":{"description":"Providers for the staff member.","type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Site.StaffProvider"}},"ID":{"format":"int64","description":"Unique identifier for the staff member.","type":"integer"},"UserGuid":{"format":"uuid","description":"GUID for the staff member.","type":"string"},"PermissionGroupName":{"description":"Permission group name for the staff member.  Usually maps to 'status' in DB.","type":"string"},"SModeID":{"format":"int32","description":"The user unique identifier for the staff member.","type":"integer"},"DisplayName":{"description":"The display name for the staff member.","type":"string"},"SortOrder":{"format":"int32","description":"Integer that represents the sort order for the staff member.","type":"integer"},"EmailAddress":{"description":"Staff member's email address.","type":"string"},"FirstName":{"description":"Staff member's first name.","type":"string"},"LastName":{"description":"Staff member's last name.","type":"string"},"Name":{"description":"The Full Name of this staff, a calculated field that returns the FirstName + \" \" + LastName","type":"string"},"UserName":{"description":"The username of this staff","type":"string"},"HomeSiteID":{"format":"int32","description":"The homesite ID of this staff","type":"integer"},"Appointments":{"description":"Appointments for the staff member.","type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Site.Appointment"}},"AppointmentPayRates":{"description":"Appointment pay rates for the given staff member.","type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Site.AppointmentPayRate"}},"StaffSchedules":{"description":"Schedules for the given staff member.","type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Site.StaffSchedule"}}}},"Mindbody.RestApi.Dto.Models.Site.LoginLocation":{"description":"Object that represents the login locations for staff members.","type":"object","properties":{"Id":{"format":"int32","description":"Location unique identifier.","type":"integer"},"Address":{"description":"Location address","type":"string"},"Address2":{"description":"Second line of the location address","type":"string"},"BusinessDescription":{"description":"Location's business description","type":"string"},"City":{"description":"City of location","type":"string"},"Description":{"description":"Location's description","type":"string"},"FacilitySquareFeet":{"format":"int32","description":"Location's total square footage","type":"integer"},"HasClasses":{"description":"If the location has classes scheduled","type":"boolean"},"Latitude":{"format":"double","description":"Location's latitude value","type":"number"},"Longitude":{"format":"double","description":"Location's longitude value","type":"number"},"Name":{"description":"Name of the location","type":"string"},"Phone":{"description":"Location's phone number","type":"string"},"PhoneExtension":{"description":"Location's phone extension, if any","type":"string"},"PostalCode":{"description":"Location's postal code","type":"string"},"SiteId":{"format":"int32","description":"Location's subscriber id, if any","type":"integer"},"StateProvCode":{"description":"Location's state code","type":"string"},"Tax1":{"format":"float","description":"Location's tax 1 value","type":"number"},"Tax2":{"format":"float","description":"Location's tax 2 value","type":"number"},"Tax3":{"format":"float","description":"Location's tax 3 value","type":"number"},"Tax4":{"format":"float","description":"Location's tax 4 value","type":"number"},"Tax5":{"format":"float","description":"Location's tax 5 value","type":"number"},"TreatmentRooms":{"format":"int32","description":"Number of treatment rooms at the location, if available","type":"integer"},"MasterLocationId":{"format":"int32","description":"Unique identifier for the master location, if any","type":"integer"}}},"Mindbody.RestApi.Dto.Models.Site.StaffProvider":{"description":"Object that maps staff to providers.","type":"object","properties":{"ID":{"format":"int64","description":"Unique identifier","type":"integer"},"StaffID":{"format":"int64","description":"Staff associated with the provider","type":"integer"},"ProviderID":{"description":"Provider associated with the staff","type":"string"},"Active":{"description":"Whether this is an active mapping or not.","type":"boolean"}}},"Mindbody.RestApi.Common.Models.Site.Appointment":{"type":"object","properties":{"Client":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Site.Clients.ClientMedium"},"Staff":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Site.StaffSmall"},"ID":{"format":"int64","type":"integer"},"VisitDataID":{"format":"int64","type":"integer"},"ClientID":{"format":"int64","type":"integer"},"StaffID":{"format":"int64","type":"integer"},"SessionTypeID":{"format":"int32","type":"integer"},"SessionTypeName":{"type":"string"},"LateCancelled":{"type":"boolean"},"EarlyCancelled":{"type":"boolean"},"LocationID":{"format":"int32","type":"integer"},"ClientSeriesID":{"format":"int64","type":"integer"},"ProgramID":{"format":"int32","type":"integer"},"BookedOnline":{"type":"boolean"},"ModifiedDateTime":{"format":"date-time","type":"string"},"Notes":{"type":"string"},"Confirmed":{"type":"boolean"},"Completed":{"type":"boolean"},"Arrived":{"type":"boolean"},"Status":{"enum":["Booked","Completed","Confirmed","Arrived","NoShow","Cancelled"],"type":"string"},"ModifiedByID":{"format":"int64","type":"integer"},"BookedByID":{"format":"int64","type":"integer"},"BookedDateTime":{"format":"date-time","type":"string"},"RequestedStaffID":{"format":"int64","type":"integer"},"AppointmentOfAddOnID":{"format":"int64","type":"integer"},"MBFBookingID":{"format":"int32","type":"integer"},"ConfirmedByID":{"format":"int64","type":"integer"},"ConfirmedDateTime":{"format":"date-time","type":"string"},"StaffGetsPaid":{"type":"boolean"},"Missed":{"type":"boolean"},"CurrentSeries":{"type":"boolean"},"Lock":{"type":"boolean"},"Closed":{"type":"boolean"},"ClosedRevenue":{"type":"boolean"},"Recurring":{"type":"boolean"},"Full":{"type":"boolean"},"Pending":{"type":"boolean"},"NumDeducted":{"format":"int32","type":"integer","readOnly":true},"EmailReminderSent":{"type":"boolean"},"MobileReminderSent":{"type":"boolean"},"EmailFollowupSent":{"type":"boolean"},"StaffSessionTypeRateID":{"format":"int32","type":"integer"},"Waitlist":{"type":"boolean"},"Studio":{"format":"int32","type":"integer"},"OldClientID":{"format":"int32","type":"integer"},"ParentStaffScheduleID":{"format":"int32","type":"integer"},"ReservedFor":{"type":"string"},"ReservedByClientID":{"format":"int64","type":"integer"},"RESTSource":{"type":"string"},"Program":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Site.Programs.AppointmentProgram"},"SessionType":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Site.AppointmentSessionType"},"ConfirmedBy":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Site.StaffSmall"},"BookedBy":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Site.StaffSmall"},"ModifiedBy":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Site.StaffSmall"},"RequestedStaff":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Site.StaffSmall"},"PrepFinishUnavailabilities":{"type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Site.StaffSchedule"}},"Location":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Site.Location"},"ReservedByClient":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Site.Clients.ClientMedium"},"ClientSeries":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Site.__Old_ClientSeriesMedium"},"ReservedByClientNameString":{"type":"string","readOnly":true},"GenderPreference":{"enum":["None","Male","Female"],"type":"string"},"Capacity":{"format":"int32","type":"integer","readOnly":true},"BookedOnFinder":{"type":"boolean","readOnly":true},"PaymentApplied":{"type":"boolean","readOnly":true},"StaffRequested":{"type":"boolean","readOnly":true},"SystemClient":{"type":"boolean","readOnly":true},"PrepTime":{"format":"int32","type":"integer"},"FinishTime":{"format":"int32","type":"integer"},"AddOns":{"type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Site.AddOn"}},"AdditionalAppointments":{"type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Site.AdditionalAppointment"}},"Resources":{"type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Site.Resource"}},"FormulaNotes":{"type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Site.FormulaNote"}},"ICDCodeIDs":{"type":"array","items":{"format":"int32","type":"integer"}},"CPTModifiers":{"type":"array","items":{"type":"string"}},"StaffProviderID":{"format":"int64","type":"integer"},"CPTUnits":{"format":"int32","type":"integer"},"ProgressNote":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Site.ProgressNotes.AppointmentProgressNoteSummary"},"ScheduleItemId":{"format":"int64","type":"integer"},"ScheduleItemName":{"type":"string"},"ScheduleItemType":{"enum":["Appointment","ClassInstance","Unavailability"],"type":"string"},"Start":{"format":"date-time","type":"string"},"End":{"format":"date-time","type":"string"}}},"Mindbody.RestApi.Dto.Models.Site.AppointmentPayRate":{"description":"Represents an Appointment Pay Rate for a specific staff member.","type":"object","properties":{"ID":{"format":"int32","description":"Unique identifier","type":"integer"},"StaffID":{"format":"int64","description":"Staff member the Pay Rate belongs to","type":"integer"},"AppointmentSessionTypeID":{"format":"int32","description":"Session type identifier that generally maps to the VisitTypeID","type":"integer"},"PayRateType":{"description":"Pay rate type that generally maps to the PayRateTypeId","enum":["NoPay","FlatPay","PercentPay"],"type":"string"},"PayRateTypeLocalizedName":{"description":"Localized name in cases where there is a Pay Rate Type","type":"string"},"LanguageCategory":{"description":"Language category for the pay rate","type":"string"},"LanguagePhrase":{"description":"Language phrase for the pay rate","type":"string"},"PayAmount":{"format":"double","description":"The pay amount for the staff member","type":"number"},"PercentPay":{"format":"float","description":"Pay percentage for the staff member","type":"number"},"TimeLength":{"format":"int32","description":"The length of the visit in minutes.","type":"integer"},"PrepTime":{"format":"int32","description":"The length of the prep time in minutes.","type":"integer"},"FinishTime":{"format":"int32","description":"The length of the finish time in minutes.","type":"integer"},"PrepTimeBak":{"format":"int32","description":"Prep time for staff member","type":"integer"},"FinishTimeBak":{"format":"int32","description":"Finish time for staff member","type":"integer"},"Active":{"description":"Whether the Pay Rate is active (true) or inactive (false) for the Staff member.","type":"boolean"},"StaffPrice":{"format":"double","description":"Pay rate staff price","type":"number"},"DefaultPrice":{"format":"double","description":"Default price for the pay rate","type":"number"},"CreatedBy":{"format":"int32","description":"Unique idenifier for the creator of the pay rate.","type":"integer"},"CreationDateTime":{"format":"date-time","description":"Date time that the pay rate was created.","type":"string"},"LastModifiedBy":{"format":"int32","description":"Unique idenifier for the user who last modified the pay rate.","type":"integer"},"LastModifiedOn":{"format":"date-time","description":"The date that the pay rate was last modified on.","type":"string"}}},"Mindbody.RestApi.Dto.Models.Site.StaffSchedule":{"description":"Object used to represent a scheduled item for a given staff member.","type":"object","properties":{"ID":{"format":"int32","description":"Unique identifier for the staff schedule","type":"integer"},"StaffID":{"format":"int64","description":"Staff that the schedule belongs to","type":"integer"},"StartTime":{"description":"Scheduled start time","type":"string"},"EndTime":{"description":"Scheduled end time","type":"string"},"StartDate":{"format":"date-time","description":"Scheduled start date","type":"string"},"EndDate":{"format":"date-time","description":"Scheduled end date","type":"string"},"Updated":{"format":"date-time","description":"Date when schedule was last updated","type":"string"},"Created":{"format":"date-time","description":"Date when schedule was created","type":"string"},"DaySun":{"description":"Whether this schedule is available on Sunday or not.","type":"boolean"},"DayMon":{"description":"Whether this schedule is available on Monday or not.","type":"boolean"},"DayTue":{"description":"Whether this schedule is available on Tuesday or not.","type":"boolean"},"DayWed":{"description":"Whether this schedule is available on Wednesday or not.","type":"boolean"},"DayThu":{"description":"Whether this schedule is available on Thursday or not.","type":"boolean"},"DayFri":{"description":"Whether this schedule is available on Friday or not.","type":"boolean"},"DaySat":{"description":"Whether this schedule is available on Saturday or not.","type":"boolean"},"ShowPublic":{"description":"Whether to show publicly or not.","type":"boolean"},"MaskPublic":{"description":"Whether to mask from public or not.","type":"boolean"},"Unavailable":{"description":"Whether the staff is unavailable or not.","type":"boolean"},"AvailName":{"description":"Available name for the schedule","type":"string"},"Location":{"format":"int32","description":"Location associated with the schedule, if any.","type":"integer"},"ClassID":{"format":"int32","description":"Class associated with the schedule, if any.","type":"integer"},"TGs":{"description":"The list of TypeGroups associated with the schedule","type":"array","items":{"format":"int32","type":"integer"}},"SingleDayAvailability":{"description":"Whether the schedule is available on a single day or not.","type":"boolean"},"VisitRefNo":{"format":"int64","description":"The VisitRefNo for the schedule","type":"integer"},"ToBeDetermined":{"description":"Whether or not the schedule is for a TBD class","type":"boolean"},"Description":{"description":"The description of this schedule.\r\nNote this is created from a view StaffScheduleDescription that must be exclicitly loaded","type":"string"},"DaysOfWeek":{"description":"Days of the week for the schedule","type":"array","items":{"enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],"type":"string"}},"GroupId":{"format":"int32","description":"Schedule group unique identifier","type":"integer"}}},"Mindbody.RestApi.Common.Models.Site.Clients.ClientMedium":{"required":["FirstName","LastName"],"type":"object","properties":{"ExternalID":{"type":"string"},"OptedIn":{"type":"boolean"},"OptedInForPromotions":{"type":"boolean"},"WorkPhone":{"type":"string"},"WorkExtension":{"type":"string"},"HomePhone":{"type":"string"},"MobilePhone":{"type":"string"},"Email":{"type":"string"},"YellowAlert":{"type":"string"},"RedAlert":{"type":"string"},"GenderPreference":{"enum":["None","Male","Female"],"type":"string"},"IsSystem":{"type":"boolean"},"FirstApptDate":{"format":"date-time","type":"string"},"Inactive":{"type":"boolean"},"CommunicationPreferences":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Site.Clients.ClientNotificationPreferences"},"Name":{"type":"string","readOnly":true},"NameFormattedForAppointmentSchedule":{"type":"string","readOnly":true},"IsCompany":{"type":"boolean"},"FormulaNotes":{"type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Site.FormulaNote"}},"ClientMembership":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Site.ClientMembership"},"ID":{"format":"int64","type":"integer"},"FirstName":{"type":"string"},"LastName":{"type":"string"},"UserName":{"type":"string"},"HomeSiteID":{"format":"int32","type":"integer"},"UserGuid":{"format":"uuid","type":"string"}}},"Mindbody.RestApi.Common.Models.Site.StaffSmall":{"required":["FirstName","LastName"],"type":"object","properties":{"PermissionGroupName":{"type":"string"},"SModeID":{"format":"int32","type":"integer"},"DisplayName":{"type":"string"},"SortOrder":{"format":"int32","type":"integer"},"EmailAddress":{"type":"string"},"Name":{"type":"string","readOnly":true},"Appointments":{"type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Site.Appointment"}},"AppointmentPayRates":{"type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Site.AppointmentPayRate"}},"StaffSchedules":{"type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Site.StaffSchedule"}},"ID":{"format":"int64","type":"integer"},"FirstName":{"type":"string"},"LastName":{"type":"string"},"UserName":{"type":"string"},"HomeSiteID":{"format":"int32","type":"integer"},"UserGuid":{"format":"uuid","type":"string"}}},"Mindbody.RestApi.Common.Models.Site.Programs.AppointmentProgram":{"type":"object","properties":{"Color":{"type":"string"},"DefaultCapacity":{"format":"int32","maximum":999,"minimum":1,"type":"integer"},"SchedOffset":{"format":"int32","type":"integer"},"SchedOffsetEnd":{"format":"int32","type":"integer"},"Asst1PayrollCode":{"maxLength":50,"minLength":0,"type":"string"},"StaffPayrollCode":{"maxLength":50,"minLength":0,"type":"string"},"CancelOffset":{"format":"int32","type":"integer"},"ID":{"format":"int32","type":"integer"},"Name":{"type":"string"},"Active":{"type":"boolean"},"Disabled":{"type":"boolean"},"ShowOnline":{"type":"boolean"},"ProgramType":{"enum":["Class","Appointment","Enrollment","Media","Resource","Arrival"],"type":"string","readOnly":true},"CancelConMode":{"type":"boolean"},"MembersOnly":{"type":"boolean"},"DefaultBookingLengthInMinutes":{"format":"int32","type":"integer"},"CreatedBy":{"format":"int32","type":"integer"},"LastModifiedBy":{"format":"int32","type":"integer"},"LastModifiedOn":{"format":"date-time","type":"string"}}},"Mindbody.RestApi.Common.Models.Site.AppointmentSessionType":{"required":["DefaultTimeLength","Capacity","ProgramID","Name","SortOrder","NumberDeducted"],"type":"object","properties":{"Description":{"type":"string"},"DefaultTimeLength":{"format":"int32","maximum":2147483647,"minimum":0,"type":"integer"},"ShowInConsumerMode":{"type":"boolean"},"AddOn":{"type":"boolean"},"BackbarAmount":{"format":"double","type":"number"},"Capacity":{"format":"int32","maximum":999,"minimum":1,"type":"integer"},"MBFSessionTypeID":{"format":"int32","type":"integer"},"MBFAutoMapped":{"type":"boolean"},"MBFFeatured":{"format":"int32","type":"integer"},"CPTID":{"format":"int32","type":"integer"},"ResourceRequired":{"type":"boolean"},"Color":{"maxLength":7,"minLength":0,"type":"string"},"FinishTimeAfterAppt":{"type":"boolean"},"CPTCode":{"pattern":"[a-zA-Z0-9]{5}","type":"string"},"ProductId":{"format":"int32","type":"integer"},"ID":{"format":"int32","type":"integer"},"ProgramID":{"format":"int32","type":"integer"},"Name":{"maxLength":50,"minLength":0,"type":"string"},"Active":{"type":"boolean"},"Deleted":{"type":"boolean"},"Locked":{"type":"boolean"},"SortOrder":{"format":"int32","maximum":999,"minimum":0,"type":"integer"},"PayrollIdentifier":{"maxLength":50,"minLength":0,"type":"string"},"NumberDeducted":{"format":"int32","maximum":999,"minimum":0,"type":"integer"},"CreatedBy":{"format":"int32","type":"integer"},"LastModifiedBy":{"format":"int32","type":"integer"},"LastModifiedOn":{"format":"date-time","type":"string"}}},"Mindbody.RestApi.Common.Models.Site.StaffSchedule":{"type":"object","properties":{"ID":{"format":"int32","type":"integer"},"StaffID":{"format":"int64","type":"integer"},"Updated":{"format":"date-time","type":"string"},"Created":{"format":"date-time","type":"string"},"DaySun":{"type":"boolean"},"DayMon":{"type":"boolean"},"DayTue":{"type":"boolean"},"DayWed":{"type":"boolean"},"DayThu":{"type":"boolean"},"DayFri":{"type":"boolean"},"DaySat":{"type":"boolean"},"ShowPublic":{"type":"boolean"},"MaskPublic":{"type":"boolean"},"Unavailable":{"type":"boolean"},"AvailName":{"type":"string"},"Location":{"format":"int32","type":"integer"},"ClassID":{"format":"int32","type":"integer"},"TGs":{"type":"array","items":{"format":"int32","type":"integer"}},"SingleDayAvailability":{"type":"boolean"},"VisitRefNo":{"format":"int64","type":"integer"},"ToBeDetermined":{"type":"boolean"},"Description":{"type":"string"},"GroupId":{"format":"int32","type":"integer"},"DaysOfWeek":{"type":"array","items":{"enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],"type":"string"}},"StartTime":{"type":"string"},"EndTime":{"type":"string"},"StartDate":{"format":"date-time","type":"string"},"EndDate":{"format":"date-time","type":"string"}}},"Mindbody.RestApi.Common.Models.Site.Location":{"type":"object","properties":{"ID":{"format":"int32","type":"integer"},"Name":{"type":"string"},"Active":{"type":"boolean"},"InvActive":{"type":"boolean"},"WsShow":{"type":"boolean"},"Phone":{"type":"string"},"Ext":{"type":"string"},"Address":{"type":"string"},"Email":{"type":"string"},"ContactName":{"type":"string"},"ShipAddress":{"type":"string"},"ShipCity":{"type":"string"},"ShipState":{"type":"string"},"ShipPostal":{"type":"string"},"ShipPhone":{"type":"string"},"ShipPoc":{"type":"string"},"TaxGrouping":{"type":"boolean"},"Tax1":{"format":"float","type":"number"},"Tax2":{"format":"float","type":"number"},"Tax3":{"format":"float","type":"number"},"Tax4":{"format":"float","type":"number"},"LabelTax1":{"type":"string"},"LabelTax2":{"type":"string"},"LabelTax3":{"type":"string"},"LabelTax4":{"type":"string"},"Wac":{"type":"boolean"},"Address2":{"type":"string"},"CsiAlertNonPreReg":{"type":"boolean"},"CsiPrtReceipts":{"type":"boolean"},"Mid":{"type":"string"},"Tid":{"type":"string"},"OpAcctNum":{"type":"string"},"Tax5":{"format":"float","type":"number"},"LabelTax5":{"type":"string"},"AutoInactiveClients":{"format":"int32","type":"integer"},"EnableAutoBatch":{"type":"boolean"},"HostStudioID":{"format":"int32","type":"integer"},"FtpUsername":{"type":"string"},"FtpPassword":{"type":"string"},"FtpHeaderRecord":{"type":"string"},"AdpCoCode":{"type":"string"},"ShipAddress2":{"type":"string"},"MasterLocID":{"format":"int32","type":"integer"},"BankClientID":{"type":"string"},"BatchProcessing":{"type":"boolean"},"StreetAddress":{"type":"string"},"City":{"type":"string"},"StateProvCode":{"type":"string"},"PostalCode":{"type":"string"},"Longitude":{"format":"double","type":"number"},"Latitude":{"format":"double","type":"number"},"LocationDescription":{"type":"string"},"Country":{"type":"string"},"StudioID":{"format":"int32","type":"integer"},"VATIdentificationNumber":{"type":"string"},"EnableTax1":{"type":"boolean"},"EnableTax2":{"type":"boolean"},"EnableTax3":{"type":"boolean"},"EnableTax4":{"type":"boolean"},"EnableTax5":{"type":"boolean"},"FacilitySquareFeet":{"format":"int32","type":"integer"},"NumberTreatmentRooms":{"format":"int32","type":"integer"},"TaxRate1DefaultLabel":{"type":"string","readOnly":true},"TaxRate2DefaultLabel":{"type":"string","readOnly":true},"TaxRate3DefaultLabel":{"type":"string","readOnly":true},"TaxRate4DefaultLabel":{"type":"string","readOnly":true},"TaxRate5DefaultLabel":{"type":"string","readOnly":true},"StudioName":{"type":"string"},"StudioShort":{"type":"string"},"SubscriptionLevel":{"type":"string"},"DistanceInMiles":{"format":"float","type":"number"},"ImageVersion":{"format":"int32","type":"integer"},"CountryCode":{"type":"string"},"BusinessDescription":{"type":"string"},"StudioAllowsGeofencedCheckins":{"type":"boolean"},"UserFavoriteLocation":{"type":"boolean"},"OptedInToConnect":{"type":"boolean"},"ThirdPartyMonetizationOptIn":{"type":"boolean"},"TotalConnectRatings":{"format":"int32","type":"integer"},"AverageConnectRating":{"format":"double","type":"number"},"Locale":{"type":"string"},"SpecialCurrencyID":{"format":"int32","type":"integer"},"ExchangeApproved":{"type":"boolean"},"OnlineBooking":{"type":"boolean"},"Website":{"type":"string"},"ModifiedDateTimeUTC":{"format":"date-time","type":"string"},"TimezoneId":{"type":"string"},"TotalDeals":{"format":"int32","type":"integer"},"ShowInventoryToThirdParties":{"type":"boolean"},"BillingAccountId":{"type":"string"},"HasClasses":{"type":"boolean"},"SiteId":{"format":"int32","type":"integer"}}},"Mindbody.RestApi.Common.Models.Site.__Old_ClientSeriesMedium":{"type":"object","properties":{"ID":{"format":"int64","type":"integer"},"Name":{"type":"string"},"Duration":{"format":"int32","type":"integer"},"DurationUnit":{"format":"int32","type":"integer"},"SeriesTypeID":{"format":"int32","type":"integer"},"NumberOfClasses":{"format":"int32","type":"integer"},"Remaining":{"format":"int32","type":"integer"},"RealRemaining":{"format":"int32","type":"integer"},"Count":{"format":"int32","type":"integer"},"IsReturned":{"type":"boolean"},"ActiveDate":{"format":"date-time","type":"string"},"PaymentDate":{"format":"date-time","type":"string"},"ExpirationDate":{"format":"date-time","type":"string"},"ActivatesOnFirstVisit":{"type":"boolean"},"IsCurrentSeries":{"type":"boolean"},"AllUsedUp":{"type":"boolean"},"ProductID":{"format":"int64","type":"integer"},"SeriesType":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Site.MembershipSeriesType"}}},"Mindbody.RestApi.Common.Models.Site.AddOn":{"type":"object","properties":{"ID":{"format":"int64","type":"integer"},"AppointmentReference":{"format":"int64","type":"integer"},"ServiceCategoryReference":{"format":"int32","type":"integer"},"ServiceCategory":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Site.Programs.AppointmentProgram"},"AppointmentTypeReference":{"format":"int32","type":"integer"},"AppointmentType":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Site.AppointmentSessionType"},"Staff":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Site.StaffSmall"},"StaffReference":{"format":"int64","type":"integer"},"BookedOnline":{"type":"boolean"},"ClientSeriesReference":{"format":"int64","type":"integer"},"PaymentApplied":{"type":"boolean","readOnly":true},"Pending":{"type":"boolean"},"Completed":{"type":"boolean"},"RESTSource":{"type":"string"},"Appointment":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Site.Appointment"}}},"Mindbody.RestApi.Common.Models.Site.AdditionalAppointment":{"type":"object","properties":{"ID":{"format":"int64","type":"integer"},"StaffID":{"format":"int64","type":"integer"},"ProgramID":{"format":"int32","type":"integer"},"SessionTypeID":{"format":"int32","type":"integer"},"ScheduleItemId":{"format":"int64","type":"integer"},"ScheduleItemName":{"type":"string"},"ScheduleItemType":{"enum":["Appointment","ClassInstance","Unavailability"],"type":"string"},"Start":{"format":"date-time","type":"string"},"End":{"format":"date-time","type":"string"}}},"Mindbody.RestApi.Common.Models.Site.Resource":{"required":["Name","LocationID"],"type":"object","properties":{"ID":{"format":"int32","type":"integer"},"Name":{"type":"string"},"LocationID":{"format":"int32","type":"integer"},"Quantity":{"format":"int32","type":"integer"},"Active":{"type":"boolean"},"ResourceTypeID":{"format":"int32","type":"integer"},"Resv":{"type":"boolean"},"Appt":{"type":"boolean"},"Enroll":{"type":"boolean"},"SortOrder":{"format":"int32","type":"integer"},"ShowOnPDF":{"type":"boolean"}}},"Mindbody.RestApi.Common.Models.Site.FormulaNote":{"type":"object","properties":{"ID":{"format":"int64","type":"integer"},"ClientID":{"format":"int64","type":"integer"},"Note":{"type":"string"},"EntryDateTime":{"format":"date-time","type":"string"},"CreatedByID":{"format":"int64","type":"integer"},"AppointmentID":{"format":"int64","type":"integer"},"CreatedBy":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Site.StaffSmall"}}},"Mindbody.RestApi.Common.Models.Site.ProgressNotes.AppointmentProgressNoteSummary":{"type":"object","properties":{"AppointmentId":{"format":"int64","type":"integer"},"CreatedBySmodeId":{"format":"int64","type":"integer"},"ModifiedBySmodeId":{"format":"int64","type":"integer"},"CreatedDate":{"format":"date-time","type":"string"},"ModifiedDate":{"format":"date-time","type":"string"},"NoteModified":{"type":"boolean"},"SaveState":{"enum":["Unsaved","InProgress","Complete"],"type":"string"},"CreatedByDisplayName":{"type":"string"},"ModifiedByDisplayName":{"type":"string"},"CreatedByFirstName":{"type":"string"},"CreatedByLastName":{"type":"string"},"ModifiedByFirstName":{"type":"string"},"ModifiedByLastName":{"type":"string"}}},"Mindbody.RestApi.Common.Models.Site.Clients.ClientNotificationPreferences":{"type":"object","properties":{"ClientId":{"format":"int64","type":"integer"},"StudioId":{"format":"int32","type":"integer"},"PromotionalEmailOptIn":{"type":"boolean"},"PromotionalTextOptIn":{"type":"boolean"},"ScheduleEmailOptIn":{"type":"boolean"},"ScheduleTextOptIn":{"type":"boolean"},"AccountEmailOptIn":{"type":"boolean"},"AccountTextOptIn":{"type":"boolean"},"OperationalEmailOptIn":{"type":"boolean"},"TwilioOptIn":{"type":"boolean"},"LegacyPreferences":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Site.Clients.LegacyClientNotificationPreferences"},"OptOutSMSSentDateUTC":{"format":"date-time","type":"string"}}},"Mindbody.RestApi.Common.Models.Site.ClientMembership":{"type":"object","properties":{"ID":{"format":"int32","type":"integer"},"ClientID":{"format":"int64","type":"integer"},"ActiveDate":{"format":"date-time","type":"string"},"ExpDate":{"format":"date-time","type":"string"},"SeriesTypeName":{"type":"string"},"TypePurch":{"type":"string"},"SeriesTypeID":{"format":"int32","type":"integer"},"IconNum":{"format":"int32","type":"integer"},"SeriesType":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Site.MembershipSeriesType"}}},"Mindbody.RestApi.Common.Models.Site.AppointmentPayRate":{"required":["TimeLength"],"type":"object","properties":{"ID":{"format":"int32","type":"integer"},"StaffID":{"format":"int64","type":"integer"},"AppointmentSessionTypeID":{"format":"int32","type":"integer"},"PayAmount":{"format":"double","minimum":0,"type":"number"},"TimeLength":{"format":"int32","maximum":2147483647,"minimum":0,"type":"integer"},"PercentPay":{"format":"float","minimum":0,"type":"number"},"PrepTime":{"format":"int32","maximum":2147483647,"minimum":0,"type":"integer"},"FinishTime":{"format":"int32","maximum":2147483647,"minimum":0,"type":"integer"},"PrepTimeBak":{"format":"int32","type":"integer"},"FinishTimeBak":{"format":"int32","type":"integer"},"Active":{"type":"boolean"},"StaffPrice":{"format":"double","type":"number"},"DefaultPrice":{"format":"double","type":"number"},"CreatedBy":{"format":"int32","type":"integer"},"LastModifiedBy":{"format":"int32","type":"integer"},"LastModifiedOn":{"format":"date-time","type":"string"}}},"Mindbody.RestApi.Common.Models.Site.MembershipSeriesType":{"required":["Name"],"type":"object","properties":{"SortOrder":{"format":"int32","maximum":99,"minimum":0,"type":"integer"},"MembersOnlyServiceDiscount":{"format":"double","type":"number"},"MembersOnlyProductDiscount":{"format":"double","type":"number"},"AllowInSSI":{"type":"boolean"},"AllowUnpaidAppointmentBooking":{"type":"boolean"},"AllowNonMemberServicePurchases":{"type":"boolean"},"IconPlainList":{"type":"array","items":{"format":"int32","type":"integer"},"readOnly":true},"IconWithMList":{"type":"array","items":{"format":"int32","type":"integer"},"readOnly":true},"IconList":{"type":"array","items":{"format":"int32","type":"integer"},"readOnly":true},"IconNumber":{"format":"int32","type":"integer"},"AllowClientModeUnpaidScheduling":{"type":"boolean"},"Active":{"type":"boolean"},"IsSystem":{"type":"boolean"},"AllowNonMemberProductPurchases":{"type":"boolean"},"ScheduleOpenDayOfMonth":{"format":"int32","type":"integer"},"MembershipImgURL":{"type":"string"},"Use2013Workflow":{"type":"boolean"},"ID":{"format":"int32","type":"integer"},"Name":{"maxLength":50,"minLength":0,"pattern":"([^<>]+)|(?:<[^>]+)","type":"string"}}},"Mindbody.RestApi.Common.Models.Site.Clients.LegacyClientNotificationPreferences":{"type":"object","properties":{"OptedIn":{"type":"boolean"},"OptedInForPromotions":{"type":"boolean"},"AutomatedContactMethod":{"enum":["NormalOnly","MobileOnly","MobileAndNormal"],"type":"string"}}},"Mindbody.RestApi.Common.Models.Site.Users.Staff":{"type":"object","properties":{"ID":{"format":"int64","type":"integer"},"Email":{"type":"string"},"FirstName":{"type":"string"},"LastName":{"type":"string"},"Bio":{"type":"string"},"Gender":{"type":"string"}}},"Mindbody.RestApi.Dto.Models.Users.Controllers.ClockInOut.TimeClockInRequest":{"description":"TimeClockIn Request","type":"object","properties":{"SelectedLocationID":{"format":"int32","description":"Currently Selected LocationId","type":"integer"},"SelectedTaskID":{"format":"int32","description":"Selected TaskId for which staff is doing the clockin","type":"integer"},"Notes":{"description":"Informative description","type":"string"}}},"Mindbody.RestApi.Dto.Models.Users.Controllers.ClockInOut.TimeClockOutRequest":{"description":"TimeClockOut Request for Current Staff","type":"object","properties":{"LastTimeClockId":{"format":"int32","description":"ClockOut Id","type":"integer"},"LastTimeClockNotes":{"description":"Informative description for clockout","type":"string"}}},"Mindbody.RestApi.Dto.Models.DEIB.Responses.Amenities.GetAllAmenitiesResponse":{"description":"Response object for FindAllAmenities","type":"object","properties":{"Amenities":{"description":"The amenities","type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.DEIB.Dto.Amenities.Amenity"}}}},"Mindbody.RestApi.Dto.Models.DEIB.Dto.Amenities.Amenity":{"description":"This represents an amenity which can be applied to a location.","type":"object","properties":{"Id":{"format":"int32","description":"The identifying ID of the amenity.","type":"integer"},"Name":{"description":"The name of the amenity (e.g. \"Lockers\" or \"Food/Drink\").","type":"string"},"CategoryName":{"description":"categoryName of the Aminity","type":"string"}}},"Mindbody.RestApi.Dto.Models.DEIB.Responses.Amenities.GetStudioAmenitiesResponse":{"description":"GetStudioAmenitiesResponse","type":"object","properties":{"AmenityLocations":{"description":"AmenityLocations","type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.DEIB.Dto.Amenities.AmenityLocation"}}}},"Mindbody.RestApi.Dto.Models.DEIB.Dto.Amenities.AmenityLocation":{"description":"AmenityLocation","type":"object","properties":{"LocationId":{"format":"int32","description":"LocationId","type":"integer"},"SubscriberId":{"format":"int32","description":"SubscriberId","type":"integer"},"Amenities":{"description":"Amenities","type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.DEIB.Dto.Amenities.Amenity"}}}},"System.Void":{"type":"object","properties":{}},"Mindbody.RestApi.Dto.Models.Site.Appointments.BuildAppointmentsResponse":{"description":"Build Appointments response - all data members are keyed by appointment ID","type":"object","properties":{"Appointments":{"description":"Appointments","type":"object","additionalProperties":{"$ref":"#/definitions/Mindbody.Contract.Scheduling.Models.Appointments.Appointment"}},"AppointmentNotes":{"description":"Appointment notes","type":"object","additionalProperties":{"$ref":"#/definitions/Mindbody.Contract.Scheduling.Models.Appointments.AppointmentNotes"}},"AppointmentReservationInfo":{"description":"Appointment reservation information","type":"object","additionalProperties":{"$ref":"#/definitions/Mindbody.Contract.Scheduling.Models.Appointments.AppointmentReservationInfo"}},"AppointmentStatus":{"description":"Appointment status","type":"object","additionalProperties":{"$ref":"#/definitions/Mindbody.Contract.Scheduling.Models.Appointments.AppointmentStatus"}},"AppointmentPaymentInfo":{"description":"Appointment payment info","type":"object","additionalProperties":{"$ref":"#/definitions/Mindbody.Contract.Scheduling.Models.Appointments.AppointmentPaymentInfo"}},"AppointmentAddOnIds":{"description":"Add-on IDs added to the Appointment (if any)","type":"object","additionalProperties":{"type":"array","items":{"format":"int64","type":"integer"}}},"Errors":{"description":"Error messages","type":"array","items":{"type":"string"}}}},"Mindbody.Contract.Scheduling.Models.Appointments.Appointment":{"type":"object","properties":{"ID":{"format":"int64","type":"integer"},"ServiceCategoryReference":{"format":"int32","type":"integer"},"AppointmentTypeReference":{"format":"int32","type":"integer"},"StaffReference":{"format":"int64","type":"integer"},"AvailabilityReference":{"format":"int32","type":"integer"},"Range":{"$ref":"#/definitions/Mindbody.Contract.Scheduling.Models.Common.DateTimeRange"},"LocationReference":{"format":"int32","type":"integer"},"ConsumerReference":{"format":"int64","type":"integer"},"PrepTime":{"format":"int32","type":"integer"},"FinishTime":{"format":"int32","type":"integer"},"WrapupTime":{"format":"int32","type":"integer"},"ResourceReferences":{"type":"array","items":{"format":"int32","type":"integer"}},"ApptGroupID":{"format":"int32","type":"integer"},"Addons":{"type":"array","items":{"$ref":"#/definitions/Mindbody.Contract.Scheduling.Models.Appointments.AppointmentAddon"}},"Recurring":{"type":"boolean"}}},"Mindbody.Contract.Scheduling.Models.Appointments.AppointmentNotes":{"type":"object","properties":{"AppointmentReference":{"format":"int64","type":"integer"},"Notes":{"type":"string"}}},"Mindbody.Contract.Scheduling.Models.Appointments.AppointmentReservationInfo":{"type":"object","properties":{"AppointmentReference":{"format":"int64","type":"integer"},"ReservedByClientReference":{"format":"int64","type":"integer"},"ReservedFor":{"type":"string"},"GenderPreference":{"enum":["Male","Female","None"],"type":"string"}}},"Mindbody.Contract.Scheduling.Models.Appointments.AppointmentStatus":{"type":"object","properties":{"AppointmentReference":{"format":"int64","type":"integer"},"Arrived":{"type":"boolean"},"Confirmed":{"type":"boolean"},"Completed":{"type":"boolean"},"BookedOnline":{"type":"boolean"},"Cancelled":{"type":"boolean"},"RequestedStaffReference":{"format":"int64","type":"integer"},"BookedBy":{"format":"int64","type":"integer"},"ConfirmedBy":{"format":"int64","type":"integer"},"ModifiedDate":{"format":"date-time","type":"string"},"ConfirmedDate":{"format":"date-time","type":"string"}}},"Mindbody.Contract.Scheduling.Models.Appointments.AppointmentPaymentInfo":{"type":"object","properties":{"AppointmentReference":{"format":"int64","type":"integer"},"PaymentReference":{"format":"int64","type":"integer"},"PaymentDescription":{"type":"string"},"StaffGetsPaid":{"type":"boolean"},"NumberDeducted":{"format":"int32","type":"integer"}}},"Mindbody.Contract.Scheduling.Models.Common.DateTimeRange":{"type":"object","properties":{"Start":{"format":"date-time","type":"string"},"End":{"format":"date-time","type":"string"}}},"Mindbody.Contract.Scheduling.Models.Appointments.AppointmentAddon":{"type":"object","properties":{"ID":{"format":"int64","type":"integer"},"AppointmentTypeReference":{"format":"int32","type":"integer"},"ServiceCategoryReference":{"format":"int32","type":"integer"},"StaffAppointmentTypeReference":{"format":"int32","type":"integer"},"StaffReference":{"format":"int64","type":"integer"},"AppointmentReference":{"format":"int64","type":"integer"}}},"MindbodyApi.Areas.Business.Schedules.Appointments.Requests.GetConsumerBookingTemplateRequest":{"description":"Request object for GetConsumerBookingTemplates.","type":"object","properties":{"ConsumerId":{"format":"int64","type":"integer"},"MaxDays":{"format":"int32","type":"integer"}}},"MindbodyApi.Areas.Business.Schedules.Appointments.Responses.GetConsumerBookingTemplatesResponse":{"description":"Response content for GetConsumerBookingTemplates REST call.","type":"object","properties":{"BookingTemplates":{"description":"A list of booking templates containing information to help book new appointments.","type":"array","items":{"$ref":"#/definitions/Mindbody.Contract.Scheduling.Models.BookingTemplates.BookingTemplate"}},"MetaData":{"description":"An object containing useful booking-related information about a consumer.","type":"object","additionalProperties":{"type":"object"}},"Errors":{"description":"A list of any error messages from errors that may have occured during the call.","type":"array","items":{"type":"string"}}}},"Mindbody.Contract.Scheduling.Models.BookingTemplates.BookingTemplate":{"type":"object","properties":{"Subscriber":{"format":"int32","type":"integer"},"BookingTemplateItems":{"type":"array","items":{"$ref":"#/definitions/Mindbody.Contract.Scheduling.Models.BookingTemplates.BookingTemplateItem"}}}},"Mindbody.Contract.Scheduling.Models.BookingTemplates.BookingTemplateItem":{"type":"object","properties":{"Location":{"format":"int32","type":"integer"},"ServiceType":{"format":"int32","type":"integer"},"Range":{"$ref":"#/definitions/Mindbody.Contract.Scheduling.Models.Common.TimeRange"},"Staff":{"format":"int64","type":"integer"},"Consumer":{"format":"int64","type":"integer"},"Resources":{"type":"array","items":{"format":"int32","type":"integer"}},"Date":{"format":"date-time","type":"string"},"PrepTime":{"format":"int32","type":"integer"},"FinishTime":{"format":"int32","type":"integer"},"WrapupTime":{"format":"int32","type":"integer"},"MetaData":{"type":"object","additionalProperties":{"type":"object"}}}},"Mindbody.Contract.Scheduling.Models.Common.TimeRange":{"type":"object","properties":{"Start":{"type":"string"},"End":{"type":"string"}}},"Mindbody.RestApi.Dto.Models.Subscribers.BusinessClosuresController.BusinessClosure":{"description":"Represents a closure at the business","type":"object","properties":{"StartDate":{"format":"date-time","description":"The start date of the business closure","type":"string"},"EndDate":{"format":"date-time","description":"The end date of the business closure","type":"string"},"Description":{"description":"The description of the business closure","type":"string"},"ServiceCategories":{"description":"The service categories that the closure applies to. A value of 0 represents all service categories.","type":"array","items":{"format":"int32","type":"integer"}}}},"MindbodyApi.Models.Dashboard.FetchNetworkMetricsRequestModel":{"description":"WebApi representation of FetchNetworkMetricsRequest","type":"object","properties":{"LocationIds":{"description":"Location ids to filter by","type":"array","items":{"format":"int32","type":"integer"}},"StartDate":{"format":"date-time","description":"Start date","type":"string"},"EndDate":{"format":"date-time","description":"End date","type":"string"},"MetricTypes":{"description":"Metric types to filter by","type":"array","items":{"enum":["NewClientsCount","NewClientsMonetaryValue","BookingsCount","PurchasesMonetaryValue","IntroOffersCount","All"],"type":"string"}},"ApplicationTypes":{"description":"Application types to filter by","type":"array","items":{"enum":["MobileApp","BusinessMode","ConsumerMode","Engage","ThirdParty","Overall","All"],"type":"string"}}}},"Mindbody.RestApi.Dto.Models.Users.ClassVisit":{"description":"Model object that represents a user's class visit.","type":"object","properties":{"Id":{"format":"int64","description":"The visit unique identifier","type":"integer"},"SignIn":{"description":"Sign in status of the class visit.","type":"boolean"}}},"Mindbody.RestApi.Dto.Models.Users.Controllers.UpdateClassVisitForConsumerRequest":{"description":"Represents a class visit update request for a consumer.","type":"object","properties":{"ClientId":{"format":"int64","description":"The consumer unique identifier","type":"integer"},"SignIn":{"description":"Sign in status of the class visit.","type":"boolean"}}},"Mindbody.RestApi.Dto.Models.Users.ClientSeries":{"description":"Contains details for a client series on a client's account at a business.","type":"object","properties":{"ID":{"format":"int64","description":"ID of the client series.","type":"integer"},"ProductId":{"format":"int64","description":"ProductId of the series.","type":"integer"},"Name":{"description":"Name of the series.","type":"string"},"TotalSessions":{"format":"int32","description":"Total sessions the series is initially sold with.","type":"integer"},"SessionsRemaining":{"format":"int32","description":"Sessions remaining on the client series.","type":"integer"},"ActiveDate":{"format":"date-time","description":"Activation date of the client series.","type":"string"},"ExpirationDate":{"format":"date-time","description":"Expiration date of the client series.","type":"string"},"IsUnlimited":{"description":"Represents whether or not this series has unlimited sessions.","type":"boolean"},"ProgramId":{"format":"int32","description":"ProgramId that the series can be used to pay for.","type":"integer"},"SessionTypeIds":{"description":"List of session type ids that this series can be used to pay for.","type":"array","items":{"format":"int32","type":"integer"}},"ProgramType":{"description":"Program type that this series can be used to pay for.","enum":["Class","Appointment","Enrollment","Media","Resource","Arrival"],"type":"string"}}},"Mindbody.RestApi.Dto.Models.Business.GetEnrollmentsRequest":{"description":"Request specifically for getting enrollments.","type":"object","properties":{"LocationIds":{"description":"The requested location ids as a string. Should be a comma-delimited string that represents integers.\r\nOptional","type":"string"},"ServiceCategoryIds":{"description":"The requested service category ids as a string. Should be a comma-delimited string that represents integers.  \r\nOptional","type":"string"},"StartDate":{"format":"date-time","description":"The start date range. Any active enrollments that are on or after this day.\r\n<br />Defaults to today.  Optional.","type":"string"},"EndDate":{"format":"date-time","description":"The end date range. Any active enrollments that are on or before this day.\r\n<br />Defaults to StartDate.  Optional.","type":"string"},"Active":{"description":"Whether to return active enrollments or not. This filter is only valid for non-consumer users, i.e. staff,\r\nowners, etc.  Optional.","type":"boolean"}}},"Mindbody.RestApi.Dto.Models.Business.GetEnrollmentsResponse":{"description":"Response for the GET /Enrollments endpoint.","type":"object","properties":{"Enrollments":{"description":"Enrollments part of the response.","type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Site.Schedules.EnrollmentSchedule"}}}},"Mindbody.RestApi.Dto.Models.Site.Schedules.EnrollmentSchedule":{"description":"Object representing a schedule for enrollments.","type":"object","properties":{"AllowDateForwardEnrollment":{"description":"True if the enrollment shows in consumer mode, the enrollment has not started yet, and there is room \r\nin each class of the enrollment.","type":"boolean"},"AllowOpenEnrollment":{"description":"True if the enrollment allows booking after the enrollment has started.  False otherwise.","type":"boolean"},"ClassDescription":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Site.Schedules.ClassDescription","description":"The class description of this class schedule."},"IsAvailable":{"description":"True if the enrollment shows in consumer mode, the enrollment has not started yet, and there is room \r\nin each class of the enrollment.","type":"boolean"},"Location":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Site.Schedules.ScheduleLocation","description":"The regularly scheduled location of this enrollment."},"Id":{"format":"int64","description":"The unique ID of the enrollment schedule.","type":"integer"},"StartTime":{"format":"date-time","description":"The start time of this class schedule.","type":"string"},"EndTime":{"format":"date-time","description":"The end time of this class schedule.","type":"string"},"StartDate":{"format":"date-time","description":"The start date of this class schedule.","type":"string"},"EndDate":{"format":"date-time","description":"The end date of this class schedule.","type":"string"},"DaySunday":{"description":"Whether this schedule occurs on Sundays.","type":"boolean"},"DayMonday":{"description":"Whether this schedule occurs on Mondays.","type":"boolean"},"DayTuesday":{"description":"Whether this schedule occurs on Tuesdays.","type":"boolean"},"DayWednesday":{"description":"Whether this schedule occurs on Wednesdays.","type":"boolean"},"DayThursday":{"description":"Whether this schedule occurs on Thursdays.","type":"boolean"},"DayFriday":{"description":"Whether this schedule occurs on Fridays.","type":"boolean"},"DaySaturday":{"description":"Whether this schedule occurs on Saturdays.","type":"boolean"}}},"Mindbody.RestApi.Dto.Models.Site.Schedules.ClassDescription":{"description":"Description for classes","type":"object","properties":{"Id":{"format":"int32","description":"The unique Id of the class description.","type":"integer"},"Name":{"description":"The name of this class description.","type":"string"},"Description":{"description":"The long description of the class.","type":"string"},"Prereq":{"description":"The prereq of this class description.","type":"string"},"Notes":{"description":"The notes the class description.","type":"string"},"LastUpdated":{"format":"date-time","description":"The date this class description was last updated.","type":"string"},"Program":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Site.Program","description":"The program for the class description."},"SessionType":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Site.SessionType","description":"The session type for the class description."}}},"Mindbody.RestApi.Dto.Models.Site.Schedules.ScheduleLocation":{"description":"Location that is associated with a specific schedule.","type":"object","properties":{"SiteId":{"format":"int32","description":"The site Id of this location.","type":"integer"},"TimeZoneId":{"description":"The time zone unique identifier for the location.","type":"string"},"BusinessDescription":{"description":"The description of this business.","type":"string"},"FacilitySquareFeet":{"format":"int32","description":"Size in square feet of the location.","type":"integer"},"TreatmentRooms":{"format":"int32","description":"Number of treatment rooms at location.","type":"integer"},"HasClasses":{"description":"If the location has classes.","type":"boolean"},"Address":{"description":"The address line 1 of the location.","type":"string"},"Address2":{"description":"The address line 2 of the location.","type":"string"},"City":{"description":"The city of the location.","type":"string"},"StateProvCode":{"description":"The state / province of the location.","type":"string"},"PostalCode":{"description":"The postal code of the location.","type":"string"},"Phone":{"description":"The phone number of the location.","type":"string"},"Tax1":{"format":"float","description":"The tax 1 rate of the location.","type":"number"},"Tax2":{"format":"float","description":"The tax 2 rate of the location.","type":"number"},"Tax3":{"format":"float","description":"The tax 3 rate of the location.","type":"number"},"Tax4":{"format":"float","description":"The tax 4 rate of the location.","type":"number"},"Tax5":{"format":"float","description":"The tax 1 rate of the location.","type":"number"},"Latitude":{"format":"double","description":"The Latitude of the location.","type":"number"},"Longitude":{"format":"double","description":"The longitude of the location.","type":"number"},"Description":{"description":"The description of the location.","type":"string"},"Id":{"format":"int32","description":"location identifier","type":"integer"},"Name":{"description":"location name","type":"string"},"BillingAccountId":{"description":"location specific BillingAccountId","type":"string"},"MerchantAccountProcessingId":{"description":"Location specific Merchant Account Processing Id.","type":"string"}}},"Mindbody.RestApi.Dto.Models.Site.Program":{"description":"Object that represents a Program","type":"object","properties":{"Id":{"format":"int32","description":"Program unique identifier","type":"integer"},"Name":{"description":"Program name","type":"string"},"ScheduleType":{"description":"Program schedule type","enum":["All","DropIn","Enrollment","Appointment","Resource","Media","Arrival"],"type":"string"}}},"Mindbody.RestApi.Dto.Models.Site.SessionType":{"description":"Session type","type":"object","properties":{"Id":{"format":"int32","description":"The unique Id of the session type.","type":"integer"},"Name":{"description":"The name of the session type.","type":"string"},"ProgramId":{"format":"int32","description":"Unique identifier for the program.","type":"integer"},"DefaultTimeLength":{"format":"int32","description":"Default time length for the session type.","type":"integer"},"NumDeducted":{"format":"int32","description":"Number deducted for the session type.","type":"integer"}}},"Mindbody.RestApi.Dto.Models.Settings.Controllers.GetGenderOptionsRequest":{"description":"Request for retrieving gender options for a site.","type":"object","properties":{"IncludeInactive":{"description":"Include inactive gender options or not.","type":"boolean"},"IncludeSystem":{"description":"Include default/system gender options or not.","type":"boolean"}}},"Mindbody.RestApi.Dto.Models.Settings.Controllers.GetGenderOptionsResponse":{"description":"Response that contains gender options results for specific site.","type":"object","properties":{"GenderOptions":{"description":"The gender options that are available for a specific site.","type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Settings.GenderOption"}}}},"Mindbody.RestApi.Dto.Models.Settings.GenderOption":{"description":"Custom Gender Options model","type":"object","properties":{"Id":{"format":"int32","description":"The gender option unique identifier.","type":"integer"},"Name":{"description":"The name of the gender option.","type":"string"},"IsActive":{"description":"If the gender option is active.","type":"boolean"},"IsSystem":{"description":"If the gender option is a default or system option.","type":"boolean"}}},"MindbodyApi.Areas.Business.Schedules.Appointments.Requests.ModifyAppointmentControllerRequest":{"description":"controller request for ModifyAppointment","type":"object","properties":{"Appointments":{"description":"list of appointments that are  modified","type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Schedules.Appointment"}},"SendEmail":{"description":"trigger appointment change notification email","type":"boolean"}}},"Mindbody.RestApi.Common.Models.Schedules.Appointment":{"type":"object","properties":{"ID":{"format":"int64","type":"integer"},"Range":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Schedules.TimeRange"},"ServiceCategoryReference":{"format":"int32","type":"integer"},"AppointmentTypeReference":{"format":"int32","type":"integer"},"StaffReference":{"format":"int64","type":"integer"},"AvailabilityReference":{"format":"int32","type":"integer"},"LocationReference":{"format":"int32","type":"integer"},"ConsumerReference":{"format":"int64","type":"integer"},"ResourceReferences":{"type":"array","items":{"format":"int32","type":"integer"}},"PrepTime":{"format":"int32","type":"integer"},"FinishTime":{"format":"int32","type":"integer"}}},"Mindbody.RestApi.Common.Models.Schedules.TimeRange":{"type":"object","properties":{"Start":{"format":"date-time","type":"string"},"End":{"format":"date-time","type":"string"}}},"Mindbody.RestApi.Common.Models.Results.Schedules.ModifyAppointmentsResponse":{"type":"object","properties":{"Success":{"type":"boolean"},"Errors":{"type":"array","items":{"type":"string"}}}},"MindbodyApi.Models.Business.Schedules.GetAddonsByAppointmentIdResponse":{"description":"","type":"object","properties":{"Addons":{"description":"","type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/definitions/MindbodyApi.Models.Business.Schedules.AddonViewModel"}}},"Errors":{"description":"","type":"array","items":{"type":"string"}}}},"MindbodyApi.Models.Business.Schedules.AddonViewModel":{"description":"","type":"object","properties":{"Id":{"format":"int64","description":"Addon Id","type":"integer"},"Name":{"description":"Addon Name","type":"string"},"AppointmentReference":{"format":"int64","description":"Appointment Id","type":"integer"},"ServiceCategoryReference":{"format":"int32","description":"Service category Id","type":"integer"},"AppointmentTypeReference":{"format":"int32","description":"Appointment type Id","type":"integer"},"StaffReference":{"format":"int64","description":"Staff Id","type":"integer"},"Paid":{"description":"Paid","type":"boolean"},"Completed":{"description":"Completed (tblReservation.Booked","type":"boolean"}}},"MindbodyApi.Models.Business.Schedules.AddAddonResponse":{"description":"","type":"object","properties":{"Addons":{"description":"","type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/definitions/MindbodyApi.Models.Business.Schedules.AddonViewModel"}}},"Errors":{"description":"","type":"array","items":{"type":"string"}}}},"Mindbody.RestApi.Common.Models.Results.Schedules.DeleteAddonsResponse":{"type":"object","properties":{"Success":{"type":"boolean"},"Errors":{"type":"array","items":{"type":"string"}}}},"Mindbody.RestApi.Dto.Models.Location.Location":{"description":"Object that represents a subscriber's location.","type":"object","properties":{"Id":{"format":"int32","description":"location identifier","type":"integer"},"Name":{"description":"location name","type":"string"},"BillingAccountId":{"description":"location specific BillingAccountId","type":"string"},"MerchantAccountProcessingId":{"description":"Location specific Merchant Account Processing Id.","type":"string"}}},"Mindbody.RestApi.Dto.Models.Site.ScheduledProducts.Service":{"description":"A service is a Product with an ItemTypeId = EItemTypeId.Service.","type":"object","properties":{"ProductId":{"format":"double","description":"The Product Id for the Service.","type":"number"},"Description":{"description":"The Description for the Service.","type":"string"},"UnitPrice":{"format":"double","description":"The UnitPrice for the Service.","type":"number"},"Count":{"format":"int32","description":"The Count for the Service.","type":"integer"},"Duration":{"format":"int32","description":"The Duration for the Service.","type":"integer"},"Deleted":{"description":"Whether the Service has been deleted or not.","type":"boolean"},"Discontinued":{"description":"Whether the Service has been discontinued or not.","type":"boolean"}}},"Mindbody.RestApi.Common.Models.Schedules.AvailabilitySchedule":{"type":"object","properties":{"AvailabilityScheduleId":{"format":"int32","type":"integer"},"GroupId":{"format":"int32","type":"integer"},"StaffReference":{"format":"int64","type":"integer"},"Updated":{"format":"date-time","type":"string"},"Created":{"format":"date-time","type":"string"},"Status":{"enum":["Public","Masked","Hidden"],"type":"string"},"LocationReference":{"format":"int32","type":"integer"},"ServiceCategoryReferences":{"type":"array","items":{"format":"int32","type":"integer"}},"DaysOfWeek":{"type":"array","items":{"enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],"type":"string"}},"StartTime":{"type":"string"},"EndTime":{"type":"string"},"StartDate":{"format":"date-time","type":"string"},"EndDate":{"format":"date-time","type":"string"}}},"Mindbody.RestApi.Common.Models.Results.Schedules.AddAvailabilityScheduleResponse":{"type":"object","properties":{"AvailabilitySchedule":{"type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Schedules.AvailabilitySchedule"}},"Errors":{"type":"array","items":{"type":"string"}}}},"Mindbody.RestApi.Common.Models.Results.Schedules.UpdateAvailabilityScheduleGroupResponse":{"type":"object","properties":{"UpdatedAvailabilitySchedules":{"type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Schedules.AvailabilitySchedule"}},"Errors":{"type":"array","items":{"type":"string"}}}},"Mindbody.RestApi.Common.Models.Results.Schedules.BuildAvailabilitySchedulesResponse":{"type":"object","properties":{"AvailabilitySchedules":{"type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Schedules.AvailabilitySchedule"}},"Errors":{"type":"array","items":{"type":"string"}}}},"Mindbody.RestApi.Dto.Models.Site.Schedules.AvailabilitySchedule":{"description":"Availability schedule for a specific staff member.","type":"object","properties":{"AvailabilityScheduleId":{"format":"int32","description":"Availability schedule unique identifier, usually maps to the [tblTrainerSchedules].[ID] attribute.","type":"integer"},"LocationReference":{"format":"int32","description":"Location unique identifier.","type":"integer"},"StaffReference":{"format":"int64","description":"Staff the availability belongs to.","type":"integer"},"DaysOfWeek":{"description":"Days of the week for the availability.","type":"array","items":{"type":"string"}},"StartTime":{"description":"Start time for the availability.","type":"string"},"EndTime":{"description":"End time for the availability.","type":"string"},"StartDate":{"format":"date-time","description":"Start date for the availability.  In some cases this will be the full DateTime for the availability to\r\nprevent from separating the date and time.","type":"string"},"EndDate":{"format":"date-time","description":"End date for the availability.  In some cases this will be the full DateTime for the availability to\r\nprevent from separating the date and time.","type":"string"},"GroupId":{"format":"int32","description":"Schedule group unique identifer.","type":"integer"},"Updated":{"format":"date-time","description":"Last DateTime the schedule was updated.","type":"string"},"Created":{"format":"date-time","description":"DateTime the schedule was created.","type":"string"},"Status":{"description":"Availability status.","enum":["Public","Masked","Hidden"],"type":"string"},"ServiceCategoryReferences":{"description":"Service category unique identifiers for the availability.","type":"array","items":{"format":"int32","type":"integer"}}}},"Mindbody.RestApi.Dto.Models.Site.Controllers.SearchAvailabilityResponse":{"description":"Response type returned with staff availability window data.","type":"object","properties":{"AvailabilitySchedules":{"description":"List of availability schedules","type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Site.Schedules.AvailabilitySchedule"}},"Errors":{"description":"List of errors, if any","type":"array","items":{"type":"string"}}}},"Mindbody.RestApi.Dto.Models.Errors.Error":{"description":"Error model","type":"object","properties":{"Code":{"description":"Error code","type":"string"},"Description":{"description":"Error description","type":"string"}}},"Mindbody.RestApi.Dto.Models.DEIB.Responses.CrowdSafeAs.GetAllCrowdSafeAsResponse":{"description":"Response object for GetAllCrowdSafeAsResponse","type":"object","properties":{"CrowdSafeAs":{"description":"The CrowdSafeAs","type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.DEIB.Dto.CrowdSafeAs.CrowdSafeAs"}}}},"Mindbody.RestApi.Dto.Models.DEIB.Dto.CrowdSafeAs.CrowdSafeAs":{"description":"CrowdSafeAs","type":"object","properties":{"Id":{"format":"int32","description":"The identifying ID of the CrowdSafeAs.","type":"integer"},"Name":{"description":"The name of the CrowdSafeAs (e.g. \"Family-friendly\" or \"Pet-friendly\").","type":"string"}}},"Mindbody.RestApi.Dto.Models.DEIB.Responses.CrowdSafeAs.GetStudioCrowdSafeAsResponse":{"description":"GetStudioCrowdSafeAsResponse","type":"object","properties":{"CrowdSafeAsLocation":{"description":"CrowdSafeAsLocation","type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.DEIB.Dto.CrowdSafeAs.CrowdSafeAsLocationMap"}}}},"Mindbody.RestApi.Dto.Models.DEIB.Dto.CrowdSafeAs.CrowdSafeAsLocationMap":{"description":"CrowdSafeAsLocationMap","type":"object","properties":{"LocationId":{"format":"int32","description":"LocationId","type":"integer"},"SubscriberId":{"format":"int32","description":"SubscriberId","type":"integer"},"CrowdSafeAs":{"description":"CrowdSafeAs","type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.DEIB.Dto.CrowdSafeAs.CrowdSafeAs"}}}},"Mindbody.RestApi.Dto.Models.Site.Schedules.ClassInstance":{"description":"Represents a class instance for a specific site.","type":"object","properties":{"ClassInstanceId":{"format":"int32","description":"Class instance unique identifier","type":"integer"},"ContentFormats":{"description":"Indicates what content format is configured for the class's type (Program).","type":"array","items":{"enum":["Livestream:Mindbody","Livestream:Other","InPerson"],"type":"string"}},"LiveStreamLink":{"description":"The meeting link for the instance of the livestreamed class.","type":"string"},"TimeZoneId":{"description":"Time zone unique identifier for the class.","type":"string"}}},"Mindbody.RestApi.Dto.Models.Site.Schedules.ClassInstanceTiny":{"description":"Tiny version of the classinstace having information \r\nrelated to class location based billing account number.","type":"object","properties":{"ClassInstanceId":{"format":"int32","description":"Class instance unique identifier","type":"integer"},"TimeZoneId":{"description":"Time zone unique identifier for the class.","type":"string"},"Location":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Location.Location","description":"Location"}}},"Mindbody.RestApi.Dto.Models.Site.Schedules.ClassSchedule":{"description":"Class Schedule Details","type":"object","properties":{"MaxCapacity":{"format":"int32","description":"Maximum capacity of Class","type":"integer"},"NumRegistered":{"format":"int32","description":"Number of candidates enrolled in the class","type":"integer"},"ProgramId":{"format":"int32","description":"Program Id","type":"integer"},"ResourceId":{"format":"int32","description":"Resource Id","type":"integer"},"ResourceName":{"description":"Resource Name","type":"string"},"ClassScheduleId":{"format":"int32","description":"Class Schedule Id","type":"integer"},"ClassDescription":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Site.Schedules.ClassDetails","description":"Class Description Details"},"Staff":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Site.Schedules.StaffDetails","description":"Staff Details"},"Location":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Site.Schedules.LocationDetails","description":"Location Details"},"Start":{"format":"date-time","description":"Start Time of the Class","type":"string"},"Type":{"description":"Type of class","type":"string"},"TimeZoneId":{"description":"Specifies the time zone of the subscriber","type":"string"}}},"Mindbody.RestApi.Dto.Models.Site.Schedules.ClassDetails":{"description":"Class Description Details","type":"object","properties":{"Id":{"format":"int32","description":"Class Id","type":"integer"},"ClassDetailsId":{"format":"int32","description":"Class Details Id","type":"integer"},"ClassName":{"description":"Class Name","type":"string"}}},"Mindbody.RestApi.Dto.Models.Site.Schedules.StaffDetails":{"description":"Staff Details","type":"object","properties":{"Id":{"format":"int64","description":"Trainer Id of the Class","type":"integer"},"Name":{"description":"Trainer Name","type":"string"}}},"Mindbody.RestApi.Dto.Models.Site.Schedules.LocationDetails":{"description":"Location Details","type":"object","properties":{"Id":{"format":"int32","description":"Location Id","type":"integer"},"Name":{"description":"Location Name","type":"string"}}},"Mindbody.RestApi.Dto.Models.Subscribers.TabsController.GetTabsRequest":{"description":"Request specifically to retrieve Tab data.","type":"object","properties":{"IncludeConsumerTabs":{"description":"Whether to include consumer mode tabs.","type":"boolean"},"IncludeBusinessTabs":{"description":"Whether to include business mode tabs.","type":"boolean"},"IncludeSystemTabs":{"description":"Whether to include system tabs.","type":"boolean"}}},"Mindbody.RestApi.Dto.Models.Subscribers.TabsController.GetTabsResponse":{"description":"Response to the request to GetTabs.","type":"object","properties":{"Tabs":{"description":"Resulting tab list","type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Subscribers.Tab"}}}},"Mindbody.RestApi.Dto.Models.Subscribers.Tab":{"description":"Object that represents a tab for a site.","type":"object","properties":{"TabId":{"format":"int32","description":"Tab unique identifier","type":"integer"},"ConsumerModeName":{"description":"Tab name in consumer/client mode","type":"string"},"SortOrder":{"format":"int32","description":"Sort order, if any, of the tab","type":"integer"},"IsReservation":{"description":"Whether the tab is for classes or not","type":"boolean"},"IsEnrollment":{"description":"Whether the tab is for enrollments or not","type":"boolean"},"IsAppointment":{"description":"Whether the tab is for appointments or not","type":"boolean"},"TypeGroupIds":{"description":"List that corresponds to the type groups that the tab is associated with","type":"array","items":{"format":"int32","type":"integer"}},"TabData":{"description":"Additional tab data","type":"string"}}},"Mindbody.RestApi.Dto.Models.DEIB.Responses.BusinessIdentifiesAs.GetAllBusinessIdentifiesAsResponse":{"description":"Response object for FindAllBusinessIdentifiesAs","type":"object","properties":{"BusinessIdentifiesAs":{"description":"The BusinessIdentifiesAs","type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.DEIB.Dto.BusinessIdentifiesAs.BusinessIdentifiesAs"}}}},"Mindbody.RestApi.Dto.Models.DEIB.Dto.BusinessIdentifiesAs.BusinessIdentifiesAs":{"description":"BusinessIdentifiesAs","type":"object","properties":{"Id":{"format":"int32","description":"The identifying ID of the BusinessIdentifiesAs.","type":"integer"},"Name":{"description":"The name of the BusinessIdentifiesAs (e.g. \"Family-owned\" or \"Asian-owned\").","type":"string"}}},"Mindbody.RestApi.Dto.Models.DEIB.Responses.BusinessIdentifiesAs.GetStudioBusinessIdentifiesAsResponse":{"description":"GetStudioBusinessIdentifiesAsResponse","type":"object","properties":{"BusinessIdentifiesAsLocation":{"description":"BusinessIdentifiesAsLocation","type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.DEIB.Dto.BusinessIdentifiesAs.BusinessIdentifiesAsLocationMap"}}}},"Mindbody.RestApi.Dto.Models.DEIB.Dto.BusinessIdentifiesAs.BusinessIdentifiesAsLocationMap":{"description":"BusinessIdentifiesAsLocationMap","type":"object","properties":{"LocationId":{"format":"int32","description":"LocationId","type":"integer"},"SubscriberId":{"format":"int32","description":"SubscriberId","type":"integer"},"BusinessIdentifiesAs":{"description":"BusinessIdentifiesAs","type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.DEIB.Dto.BusinessIdentifiesAs.BusinessIdentifiesAs"}}}},"Mindbody.RestApi.Dto.Models.Users.Controllers.UserInfoRequest":{"description":"Represents a request to retrieve user information.","type":"object","properties":{"Id":{"format":"int32","description":"User Id.","type":"integer"},"Email":{"description":"User email.","type":"string"}}},"Mindbody.RestApi.Dto.Models.Users.Controllers.UserResponse":{"description":"Response type returned from successful GET /Users/{userId} roundtrip containing user data.","type":"object","properties":{"Id":{"format":"int32","description":"User identifier","type":"integer"},"FirstName":{"description":"User first name","type":"string"},"LastName":{"description":"User last name","type":"string"},"Email":{"description":"User email","type":"string"},"Gender":{"description":"User gender","enum":["NotChosen","Male","Female"],"type":"string"},"BirthDay":{"format":"date-time","description":"User birthday","type":"string"},"LastSignedIn":{"format":"date-time","description":"Date that user last signed in","type":"string"},"IsVerified":{"description":"User account verification status","type":"boolean"}}},"Mindbody.RestApi.Common.Models.Users.AuthorizationInformationRequest":{"type":"object","properties":{"ApiName":{"type":"string"},"EndPoint":{"type":"string"}}},"Mindbody.RestApi.Dto.Models.Users.Controllers.UserIdentityResponse":{"description":"Response type returned from successful POST /Users/Get roundtrip containing basic user identity data.","type":"object","properties":{"Id":{"format":"int32","description":"User's identifier","type":"integer"},"FirstName":{"description":"User's first name","type":"string"},"LastName":{"description":"User's last name","type":"string"},"Email":{"description":"User's email address","type":"string"},"Country":{"description":"User's country","type":"string"},"IsVerified":{"description":"Flag indicating if the user's email has been verified","type":"boolean"},"VerifiedDateTimeUtc":{"format":"date-time","description":"Datetime that the user verified their email","type":"string"}}},"Mindbody.RestApi.Dto.Models.Sale.GetServicePaymentOptionsRequest":{"description":"Request parameters for GET ServicePaymentOptions","type":"object","properties":{"LocationId":{"format":"int32","description":"LocationId","type":"integer"},"AppointmentTypeId":{"format":"int32","description":"AppointmentTypeId","type":"integer"},"Start":{"format":"date-time","description":"Start date","type":"string"},"End":{"format":"date-time","description":"End date","type":"string"},"DependentId":{"description":"Optional user if of a dependent.  When used, will get the service options for that dependent instead of the custodian making the request.","type":"string"}}},"Mindbody.RestApi.Dto.Models.Sale.ServicePaymentOption":{"description":"Represents a service payment option.","type":"object","properties":{"Name":{"description":"Name","type":"string"},"PaymentRefNo":{"format":"int64","description":"Payment reference number","type":"integer"},"Remaining":{"format":"int32","description":"Remaining","type":"integer"},"Initial":{"format":"int32","description":"Initial","type":"integer"},"RemainingFromAllApplied":{"format":"int32","description":"Remaining from all applied","type":"integer"},"ActiveDate":{"format":"date-time","description":"Active date","type":"string"},"ExpirationDate":{"format":"date-time","description":"Expiration date","type":"string"}}},"Mindbody.RestApi.Common.Models.Site.Settings.LiabilityRelease":{"type":"object","properties":{"RequireInConsumerMode":{"type":"boolean"},"Text":{"type":"string"},"IntroParagraph":{"type":"string"}}},"Mindbody.RestApi.Dto.Models.Subscribers.SiteInformationController.GetSiteInformationResponse":{"type":"object","properties":{"StudioId":{"format":"int32","type":"integer"},"StudioName":{"type":"string"},"BusinessUrl":{"type":"string"},"LogoUrl":{"type":"string"},"MobileLogoUrl":{"type":"string"},"TimeZoneId":{"description":"Unique identifier that matches this studio's timezone.\r\nFor example: America/Los_Angeles","type":"string"},"StudioLocale":{"description":"Studio's locale","type":"string"},"CurrencyIsoCode":{"description":"Studio's currency ISO code.","type":"string"},"IsoDecimalDigits":{"format":"int32","description":"Gets number of decimal digits used by the currency (e.g. 2 for USD).","type":"integer"},"RoundingMethod":{"description":"Gets or sets the rounding method used for currency calculations.","type":"string"}}},"Mindbody.RestApi.Dto.Models.Subscribers.SiteInformationController.SearchSitesRequest":{"description":"Request used when searching for sites/studios.","type":"object","properties":{"SearchText":{"description":"(optional) A search string used to filter down the returned results.","type":"string"},"RelatedSiteId":{"format":"int32","description":"(optional) Returns all sites related to given site id.","type":"integer"},"ShowOnlyTotalWod":{"description":"(optional) Returns all sites related to given site id.","type":"boolean"},"Limit":{"format":"int32","description":"Number of results to return, defaults to 100","type":"integer"},"Offset":{"format":"int32","description":"Number of results to skip, defaults to 0","type":"integer"}}},"Mindbody.RestApi.Dto.Models.Subscribers.SiteInformationController.SearchSitesResponse":{"description":"Response used when searching for sites/studios.","type":"object","properties":{"SiteInfos":{"description":"Resulting site info objects.","type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Site.SiteInfoBasic"}},"PaginationResponse":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Pagination.PaginationResponse","description":"Resulting pagination info objects."}}},"Mindbody.RestApi.Dto.Models.Site.SiteInfoBasic":{"description":"Basic information for a site.","type":"object","properties":{"StudioId":{"format":"int32","description":"Studio unique identifier","type":"integer"},"StudioName":{"description":"Name of the studio/site","type":"string"},"BusinessUrl":{"description":"Business Url for the site","type":"string"},"LogoUrl":{"description":"Logo Url for the site.","type":"string"},"MobileLogoUrl":{"description":"Mobile logo Url for the site.","type":"string"}}},"Mindbody.RestApi.Dto.Models.Pagination.PaginationResponse":{"type":"object","properties":{"RequestedLimit":{"format":"int32","description":"Limit from pagination request","type":"integer"},"RequestedOffset":{"format":"int32","description":"Offset from pagination request","type":"integer"},"PageSize":{"format":"int32","description":"Number of results returned in this response","type":"integer"},"TotalResults":{"format":"int32","description":"Total number of results in dataset","type":"integer"}}},"Mindbody.RestApi.Dto.Models.Subscribers.SiteInformationController.GetRegionInfoResponse":{"description":"Response for GetRegionInfo","type":"object","properties":{"RegionId":{"format":"int32","description":"Region ID for Site","type":"integer"}}},"Mindbody.RestApi.Dto.Models.Subscribers.Mobile.Controller.MobileFeedbackRequest":{"description":"Request object used to identify mobile app feedback requests.","type":"object","properties":{"Accounts":{"description":"The app accounts linked to the feedback.","type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Subscribers.Mobile.MobileAccount"}},"AppName":{"description":"The app where the feedback originated from.","type":"string"},"AppVersion":{"description":"The app version for the feedback.","type":"string"},"OsVersion":{"description":"Operating system version for the feedback.","type":"string"},"Device":{"description":"The device where the feedback originated.","type":"string"},"Rating":{"format":"int32","description":"The rating of the feedback from a scale of 1-5.","type":"integer"},"Message":{"description":"The message of the feedback.","type":"string"}}},"Mindbody.RestApi.Dto.Models.Subscribers.Mobile.MobileAccount":{"description":"Mobile App Account information model object.","type":"object","properties":{"SiteId":{"format":"int64","description":"The site unique identifier for the account.","type":"integer"},"SiteName":{"description":"The site name for the account.","type":"string"},"LogoUrl":{"description":"Logo url for the Site icon","type":"string"},"StaffId":{"format":"int64","description":"The staff unique identifier for the account.","type":"integer"},"LocationId":{"format":"int32","description":"The location unique identifier for the account.","type":"integer"},"LocationName":{"description":"The location for the account.","type":"string"}}},"Mindbody.RestApi.Dto.Models.Site.AutoEmailSetting":{"description":"Auto email settings for a specific subscriber.","type":"object","properties":{"StudioId":{"format":"int32","description":"Subscriber ID that the auto email settings belong to.","type":"integer"},"EmailType":{"description":"Email type of the auto email settings.","enum":["NewClientWelcomeConsumerMode","CancellationNotificationEarly","CancellationNotificationLate","ReservationConfirmationsSingle","ReservationConfirmationsRecurring","EnrollmentConfirmationsPaymentPlan","EnrollmentConfirmationsPaymentPlanResourceType","AppointmentRequestConfirmationsSingle","AppointmentRequestConfirmationsRecurring","AppointmentBookingConfirmationsSingle","AppointmentBookingConfirmationsRecurring","ClassEventCancellationNotifications","AutoPayPurchaseConfirmation","PurchaseReceiptBizMode","NoShowNotification","ReservationAddedFromWaitlistNotification","GiftCardRecipientNotification","SeriesNotificationTimeRunningOut","SeriesNotificationVisitsRemainingLow","PurchaseReceiptConsumerMode","SecurityVerificationApproved","EnrollmentConfirmations","NewClientWelcomeBizMode","AppointmentChangeNotification","AppointmentBookingConfirmationsManual","ContactLogFollowUpNotification","NewLeadGenerated","ContractBizMode","OpenTicketQuote","AppointmentRequestNotification","AppointmentRequestDenial","BirthdayEmail","PartnerStorePurchaseReceipt","PartnerStoreOrderNotification","OrderShippedNotification","ContractAutoPayCreditCardExpiring","AutoPayFailedNotification","ContractReminder","ClientClosed","CloseFollowup","ForgotLoginInformation","ContractUnsuspended","AppointmentReminder","ReservationReminder","CourseEnrollmentConfirmations","CourseEnrollmentConfirmationsPaymentPlan","FirstVisitReservation","FirstVisitAppointment","TeacherSubReminder","ClientScheduleManual","AppointmentFollowUp","FirstVisitAnniversary","AppointmentCancellationEarly","AppointmentCancellationLate","EnrollmentWaitlistNotification","ContractRenewalNotification","TeacherSubNotification","ActiveClient","LostClient","LostPayingClient","LostNonPayingClient","ActivePayingClient","ActiveNonPayingClient","LostWelcomeBackClient","InvoiceEmail","ClientFormsNotification","ContractDateUpdateNotification","AppointmentFromWaitlist","AppointmentFirstToClaim"],"type":"string"},"Active":{"description":"Flag to determine if the auto email setting is active.","type":"boolean"},"AlwaysSend":{"description":"Flag used to determine whether to always send the email or not.","type":"boolean"},"SendStudioMode":{"description":"SendStudioMode flag for the auto email setting.","type":"boolean"}}},"Mindbody.RestApi.Dto.Models.MobileAppVersions.MobileAppVersion":{"description":"Name class so object can be stored/serialized for redis","type":"object","properties":{"Id":{"format":"int32","description":"","type":"integer"},"Version":{"description":"","type":"string"},"Product":{"description":"","type":"string"},"Platform":{"description":"","type":"string"},"Status":{"description":"","type":"string"},"RecommendedOperatingSystem":{"description":"","type":"string"}}},"Mindbody.RestApi.Dto.Models.Sale.EventDetail":{"description":"Represents calendar event details of a sale.","type":"object","properties":{"AppointmentId":{"format":"int64","description":"The appointment id.","type":"integer"}}},"Mindbody.RestApi.Dto.Models.Settings.Country":{"description":"Country","type":"object","properties":{"ID":{"format":"int32","description":"Id.","type":"integer"},"Name":{"description":"Country name.","type":"string"},"Code":{"description":"Country code.","type":"string"},"PhoneCode":{"description":"Phone code.","type":"string"}}},"Mindbody.RestApi.Dto.Models.Settings.CountryWithTerritories":{"description":"A list of countries with their state provinces.","type":"object","properties":{"Territories":{"description":"The state provinces that belong to the country.","type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Settings.Territory"}},"ID":{"format":"int32","description":"Id.","type":"integer"},"Name":{"description":"Country name.","type":"string"},"Code":{"description":"Country code.","type":"string"},"PhoneCode":{"description":"Phone code.","type":"string"}}},"Mindbody.RestApi.Dto.Models.Settings.Territory":{"description":"Represents a state or province.","type":"object","properties":{"Name":{"description":"Name of the state or province.","type":"string"},"Code":{"description":"Code for the state or province.","type":"string"}}},"Mindbody.RestApi.Dto.Models.Settings.Controllers.GetSettingsRequest":{"description":"Request used for retrieving site settings.","type":"object","properties":{"Categories":{"description":"Categories of the site settings to retrieve.  If null, retrieve all settings.\r\nCategory possible values:\r\n- Client\r\n- Communication\r\n- General: General site settings.\r\n- Location: Site location settings.\r\n- Scheduling: Site scheduling settings, i.e. class and enrollments settings, etc.","type":"array","items":{"type":"string"}},"LocationId":{"format":"int32","description":"Location identifier if location settings are specified.  Will be ignored if location category is not \r\nspecified.","type":"integer"},"DependentId":{"description":"User identifier for an optional dependent account.  Retained for backwards compatibility only - the\r\nsettings returned are site-scoped and identical for every caller, so this value is ignored.","type":"string"}}},"Mindbody.RestApi.Dto.Models.Settings.Setting`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]":{"description":"Generic Setting class, to support multiple types","type":"object","properties":{"Category":{"description":"The setting category (ie. \"Communication\")","type":"string"},"Name":{"description":"Name of site setting","type":"string"},"Value":{"description":"Value of the site setting","type":"string"},"ValueType":{"description":"Data type of the setting value (ie. \"string\", \"bool\", etc.)","type":"string","readOnly":true}}},"Mindbody.RestApi.Dto.Models.Site.AppointmentOptions":{"description":"DTO Model for AppointmentOptions","type":"object","properties":{"AppointmentScheduleBookingInterval":{"format":"int32","description":"The interval in minutes for allowable booking times","type":"integer"},"UseGenderPreferences":{"description":"Enables/Disables showing GenderOptions for staff selection. e.g., Male Staff, Female Staff.","type":"boolean"},"RequireClientPaymentForBookedAppointments":{"description":"Decides whether client needs payment for an appointment","type":"boolean"}}},"Mindbody.RestApi.Common.Models.Results.StaffResponse":{"type":"object","properties":{"Staff":{"type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Site.MbApp.Staff"}},"StaffProfiles":{"type":"object","additionalProperties":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Site.MbApp.StaffProfile"}},"StaffAppointmentTypes":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Site.MbApp.StaffAppointmentType"}}}}},"Mindbody.RestApi.Common.Models.Site.MbApp.Staff":{"type":"object","properties":{"Active":{"type":"boolean"},"Deleted":{"type":"boolean"},"System":{"type":"boolean"},"Gender":{"enum":["Male","Female","None"],"type":"string"},"NickName":{"type":"string"},"MaskStaffName":{"type":"boolean"},"ID":{"format":"int64","type":"integer"},"FirstName":{"type":"string"},"LastName":{"type":"string"},"UserName":{"type":"string"},"Email":{"type":"string"},"HomeSiteID":{"format":"int32","type":"integer"},"UserType":{"enum":["Consumer","Staff","Owner","Admin"],"type":"string","readOnly":true}}},"Mindbody.RestApi.Common.Models.Site.MbApp.StaffProfile":{"type":"object","properties":{"StaffReference":{"format":"int64","type":"integer"},"Biography":{"type":"string"},"ImageURL":{"type":"string"}}},"Mindbody.RestApi.Common.Models.Site.MbApp.StaffAppointmentType":{"type":"object","properties":{"ID":{"format":"int32","type":"integer"},"StaffReference":{"format":"int64","type":"integer"},"AppointmentTypeReference":{"format":"int32","type":"integer"},"ServiceCategoryReference":{"format":"int32","type":"integer"}}},"Mindbody.RestApi.Dto.Models.LiveStream.LiveStreamEligibilityRequest":{"description":"Live stream eligibility request","type":"object","properties":{"BusinessId":{"description":"Business that the live stream is being hosted with","type":"string"},"Context":{"description":"Eligibility context used to determine if a user should be eligible to join a live stream session","type":"object","additionalProperties":{"type":"string"}}}},"Mindbody.RestApi.Dto.Models.LiveStream.LiveStreamEligibilityResponse":{"description":"Response body of Livestream eligibility check","type":"object","properties":{"Metadata":{"description":"Addtional Supplemental Metadata data regarding the user's livestream session","type":"object","additionalProperties":{"type":"string"}}}},"Mindbody.RestApi.Dto.Models.Site.Controllers.GetInventoryRequest":{"description":"Inventory request object","type":"object","properties":{"SubscriberId":{"format":"int32","description":"Subscriber ID to retrieve the inventory for","type":"integer"},"ItemType":{"description":"Item type to filter. Possible values:\r\nRetail\r\nAccountCredit\r\nGiftCard\r\nServicePricingOption\r\nTip\r\nContractDeposit\r\nContractRegistrationFee\r\nPackage\r\nContract","type":"string"},"ItemId":{"format":"int64","description":"Item ID to filter for specific item","type":"integer"},"AvailableOnline":{"description":"Filter for only online products","type":"boolean"},"IntroductoryOffer":{"description":"Filter for only intro offer pricing options","type":"boolean"},"IncludeContractPricingOptions":{"description":"When true, includes pricing options that are only available in contracts and packages.\r\nDefault is false.","type":"boolean"},"ServiceCategoryId":{"format":"int32","description":"Filter by service category ID. The results include \r\nitems whose service category is related to the specified service category ID.","type":"integer"},"LocationId":{"format":"int32","description":"Filter by location ID that the item is sold at","type":"integer"},"LastUpdatedDate":{"format":"date-time","description":"Filter by last updated date","type":"string"},"RevenueCategoryId":{"format":"int32","description":"Filter by revenue category ID.","type":"integer"},"OrderBy":{"description":"Value to order inventory by (ascending).\r\nPossible Values: Name, Default, [null]\r\nDefault/null sort is by Elastic SortOrder (ServiceCategoryId, then Name)","type":"string"},"Limit":{"format":"int32","description":"Number of results to return, defaults to 100","type":"integer"},"Offset":{"format":"int32","description":"Number of results to skip, defaults to 0","type":"integer"}}},"Mindbody.RestApi.Dto.Models.Site.Controllers.GetInventoryResponse":{"description":"Inventory response object","type":"object","properties":{"PaginationResponse":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Pagination.PaginationResponse","description":"Pagination information"},"PaginationResult":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Pagination.PaginationResponse","description":"Pagination information"},"InventoryItems":{"description":"Merchant inventory items","type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Site.InventoryItem"}},"ErrorMessage":{"description":"Error","type":"string"}}},"Mindbody.RestApi.Dto.Models.Site.InventoryItem":{"description":"Represents an inventory item available at the subscriber","type":"object","properties":{"ItemId":{"format":"int64","description":"Item ID","type":"integer"},"Name":{"description":"Item name","type":"string"},"Description":{"description":"Item Description","type":"string"},"ItemType":{"description":"Type of item","type":"string"},"BusinessModePrice":{"format":"double","description":"Price in business mode","type":"number"},"ConsumerModePrice":{"format":"double","description":"Price in consumer mode","type":"number"},"PerSessionPricing":{"description":"Calculates price based on how many sessions are purchased","type":"boolean"},"DurationValue":{"format":"int32","description":"Duration","type":"integer"},"DurationType":{"description":"Type of duration (Days/Months)","type":"string"},"ActivationType":{"description":"How pricing option is activated. (purchase date/first visit/fixed date)","type":"string"},"SessionCount":{"format":"int32","description":"Session count","type":"integer"},"SeriesTypeId":{"format":"int32","description":"Options are: none, count (session count based), time (time based), membership","type":"integer"},"ServiceCategoryId":{"format":"int32","description":"Service category which this item pays for","type":"integer"},"ServiceCategoryType":{"description":"Type of service category which this item pays for","type":"string"},"IntroOfferType":{"description":"Type of intro offer if this item is a pricing option.\r\nPossible values: None, NewConsumer, and NewAndReturningConsumer","type":"string"},"UsedAtLocationIds":{"description":"Location IDs which locations the item can be used at to pay for services","type":"array","items":{"format":"int32","type":"integer"}},"SoldAtLocationRestrictions":{"description":"Location IDs which locations the item can be sold at","type":"array","items":{"format":"int32","type":"integer"}},"MembershipRequirementRestrictions":{"description":"Restrictions associated with the membership a consumer has","type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Site.MembershipRestriction"}},"ModifiedDateTimeUtc":{"format":"date-time","description":"The time that the item has been recently modified in UTC.","type":"string"},"AvailableOnline":{"description":"Whether or not the item can be sold online.","type":"boolean"}}},"Mindbody.RestApi.Dto.Models.Site.MembershipRestriction":{"type":"object","properties":{"Id":{"format":"int32","description":"Membership ID (SeriesTypeId)","type":"integer"},"Name":{"description":"Name of the Membership","type":"string"}}},"Mindbody.Contract.Scheduling.Responses.GuestBuildAppointmentTypesResponse":{"type":"object","properties":{"AppointmentTypes":{"type":"array","items":{"$ref":"#/definitions/Mindbody.Contract.Scheduling.Models.AppointmentTypes.AppointmentType"}}}},"Mindbody.Contract.Scheduling.Models.AppointmentTypes.AppointmentType":{"type":"object","properties":{"ID":{"format":"int32","type":"integer"},"ServiceCategoryReference":{"format":"int32","type":"integer"},"ServiceCategoryGroupReferences":{"type":"array","items":{"format":"int32","type":"integer"}},"Name":{"type":"string"},"Active":{"type":"boolean"},"Deleted":{"type":"boolean"},"PayrollIdentifier":{"type":"string"},"NumberDeducted":{"format":"int32","type":"integer"},"Description":{"type":"string"},"DefaultTimeLength":{"format":"int32","type":"integer"},"AddOn":{"type":"boolean"},"BackbarAmount":{"format":"double","type":"number"},"Capacity":{"format":"int32","type":"integer"},"ResourceRequired":{"type":"boolean"},"ShowInConsumerMode":{"type":"boolean"},"Category":{"type":"string"},"CategoryId":{"format":"int32","type":"integer"},"Subcategory":{"type":"string"},"SubcategoryId":{"format":"int32","type":"integer"}}},"Mindbody.RestApi.Dto.Models.Notifications.SmtpSettings":{"description":"SMTP Settings","type":"object","properties":{"ReplyTo":{"description":"The reply-to address associated with emails sent by the subscriber/","type":"string"},"CustomSettings":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Notifications.CustomSmtpSettings","description":"Custom settings to use if not using the default MINDBODY SMTP provider"}}},"Mindbody.RestApi.Dto.Models.Notifications.CustomSmtpSettings":{"description":"Custom SMTP Settings","type":"object","properties":{"Host":{"description":"The hostname of the subscriber's SMTP server","type":"string"},"Username":{"description":"Username for the provided SMTP server - \r\nThis should be a valid email address.","type":"string"},"Password":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Notifications.Password","description":"Password for the provided SMTP server"},"Port":{"format":"int32","description":"The port used to connect to the specified host - \r\nOfficial SMTP ports per RFC 3207 are 25 for insecure connections and 587 for\r\nusing the STARTTLS command. Other ports are technically valid but not recommended.","type":"integer"},"Timeout":{"format":"int32","description":"The timeout in milliseconds for requests sent to the specified host","type":"integer"},"Secure":{"description":"Whether to use SSL/TLS to secure the connection with the specified host -\r\nThis option only supports securing the connection via the explicit STARTTLS command\r\nwhich should be performed on port 587.\r\nOptional: when omitted on an update the stored value is left as it is, so a caller that\r\ndoes not manage this setting cannot turn TLS off by not mentioning it.","type":"boolean"}}},"Mindbody.RestApi.Dto.Models.Notifications.Password":{"description":"A password value that may or may not be encrypted","type":"object","properties":{"Encrypted":{"description":"Whether or not the password is encrypted","type":"boolean"},"Value":{"description":"Password value","type":"string"}}},"Mindbody.RestApi.Dto.Models.Sale.GetSalesDetailsRequest":{"description":"GET SalesDetails request","type":"object","properties":{"SaleId":{"format":"int64","description":"When provided, returns SalesDetails that belong to this Sale ID","type":"integer"},"StartDate":{"format":"date-time","description":"When provided, returns SalesDetails on and after this date","type":"string"},"EndDate":{"format":"date-time","description":"When provided, returns SalesDetails before and on this date","type":"string"},"ExcludedRevenueCategoryIds":{"description":"When included, these revenue categories will be excluded from the results.","type":"array","items":{"format":"int32","type":"integer"}},"ClientId":{"format":"int64","description":"When provided, returns SalesDetails that belong to this client ID","type":"integer"},"Limit":{"format":"int32","description":"Number of results to return, defaults to 100","type":"integer"},"Offset":{"format":"int32","description":"Number of results to skip, defaults to 0","type":"integer"}}},"Mindbody.RestApi.Dto.Models.Sale.SalesDetail":{"description":"Detailed item of a sale","type":"object","properties":{"SaleId":{"format":"int64","description":"The ID of the sale","type":"integer"},"SalesDetailId":{"format":"int64","description":"The sales detail ID","type":"integer"},"ItemAmount":{"format":"double","description":"The amount of the item purchased","type":"number"},"SaleDate":{"format":"date-time","description":"The date when the sale took place","type":"string"},"ContractId":{"format":"int32","description":"The ID of the contract purchased","type":"integer"},"ClientContractId":{"format":"int32","description":"The unique contract ID for the client","type":"integer"},"ContractType":{"description":"The type of contract","type":"string"},"Autopay":{"description":"Whether the item was sold as part of an Autopay","type":"boolean"},"ServiceCategoryId":{"format":"int32","description":"The service category ID of the purchased item","type":"integer"},"ProductId":{"format":"double","description":"The ID of the product purchased","type":"number"},"ProductDescription":{"description":"The product description","type":"string"},"PaymentMethod":{"description":"The type of payment method used","type":"string"},"RevenueCategoryId":{"format":"int32","description":"The revenue category ID of the purchased item","type":"integer"},"RevenueCategoryName":{"description":"The revenue category of the purchased item","type":"string"},"DiscountAmount":{"format":"double","description":"The discount amount","type":"number"},"TaxAmount":{"format":"double","description":"The summed tax amount","type":"number"},"PromoCodeId":{"format":"int32","description":"The ID of the promo code used (if any)","type":"integer"},"FirstName":{"description":"Client First name","type":"string"},"LastName":{"description":"Client last name","type":"string"},"Email":{"description":"Client Email","type":"string"},"Phone":{"description":"Client Phone no","type":"string"}}},"Mindbody.RestApi.Dto.Models.Users.ApplyServicePaymentOptionsResponse":{"description":"Response from apply current series","type":"object","properties":{"AppointmentServicePaymentOptionDetails":{"description":"Dictionary keyed in by appointment Id and value will be the dictionary of payment reference and payment applied or not","type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Users.AppointmentServicePaymentOption"}}}},"Mindbody.RestApi.Dto.Models.Users.AppointmentServicePaymentOption":{"description":"To store appointment id and current series payment reference number.","type":"object","properties":{"AppointmentReference":{"format":"int64","description":"appointment id","type":"integer"},"ServicePaymentOptionReference":{"format":"int64","description":"current series pmtrefno","type":"integer"},"ServicePaymentOptionDescription":{"description":"session type name","type":"string"},"PaymentApplied":{"description":"payment applied or not","type":"boolean"},"Error":{"description":"Validation exceptions or errors","type":"string"}}},"Mindbody.RestApi.Dto.Models.Documents.GetSaleSignatureUrlResponse":{"description":"Response of get sale signature.","type":"object","properties":{"SignatureUrl":{"description":"The url to get the signature image","type":"string"}}},"Mindbody.RestApi.Dto.Models.Documents.UploadLiabilityReleaseResponse":{"description":"Response of upload liability release.","type":"object","properties":{"ResponseContext":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Documents.ResponseContext","description":"Did it succeed"},"ConsumerDocumentFileName":{"description":"File name of the uploaded document","type":"string"}}},"Mindbody.RestApi.Dto.Models.Documents.ResponseContext":{"type":"object","properties":{"Messages":{"description":"A set of messages which compose the response information","type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Documents.ResponseMessage"}},"IsSuccessful":{"description":"A calculated field based on an error being present in the response messages","type":"boolean","readOnly":true}}},"Mindbody.RestApi.Dto.Models.Documents.ResponseMessage":{"type":"object","properties":{"Code":{"type":"string"},"SubCode":{"type":"string"},"Detail":{"type":"string"},"Level":{"enum":["Error","Warning","Info"],"type":"string"}}},"Mindbody.RestApi.Dto.Models.Site.Schedules.GetStaffCalendarRequest":{"description":"Request specifically for getting a staff's calendar.","type":"object","properties":{"StartDateTime":{"format":"date-time","description":"Optional start datetime to filter the request on in ISO-8601.","type":"string"},"EndDateTime":{"format":"date-time","description":"Optional end datetime to filter the request on in ISO-8601.","type":"string"},"IncludeAppointments":{"description":"Whether to include appointments in the result set.","type":"boolean"},"IncludeClasses":{"description":"Whether to include classes in the result set.","type":"boolean"},"IncludeEnrollments":{"description":"Whether to include enrollments in the result set.","type":"boolean"},"IncludeUnavailabilities":{"description":"Whether to include unavailabilities in the result set.","type":"boolean"},"LocationIds":{"description":"Optional list of location identifiers to filter the results on.","type":"array","items":{"format":"int32","type":"integer"}}}},"Mindbody.RestApi.Dto.Models.Site.Schedules.CalendarEvent":{"description":"Event for a specific Calendar","type":"object","properties":{"EventId":{"format":"int64","description":"Event unique identifier:\r\n- For appointment events, this will be the appointment id or visit ref no.\r\n- For class events, this will be the class instance id.\r\n- For unavailability events, this will be the unavailability id.","type":"integer"},"EventName":{"description":"Name of the event.","type":"string"},"EventType":{"description":"Event type.  Possible values are availble here: {Mindbody.RestApi.Dto.Enums.ECalendarEventType}.","enum":["core.appointment","core.classInstance","core.unavailability"],"type":"string"},"StaffId":{"format":"int64","description":"Staff that the event belong to.","type":"integer"},"Client":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Site.Clients.Client","description":"Client associated with the event, if any."},"StartTime":{"format":"date-time","description":"The start time/date of the event in Coordinated Universal Time or UTC.","type":"string"},"EndTime":{"format":"date-time","description":"The end time/date of the event in Coordinated Universal Time or UTC.","type":"string"},"Unscheduled":{"description":"Whether the event represents an unscheduled or TBD class.","type":"boolean"},"Location":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Site.Schedules.CalendarLocation","description":"Location info for the event."}}},"Mindbody.RestApi.Dto.Models.Site.Clients.Client":{"description":"Client information for a specific studio.","type":"object","properties":{"FirstName":{"description":"The first name of the client.","type":"string"},"LastName":{"description":"The last name of the client.","type":"string"},"NickName":{"description":"The nickname or display name of the client.","type":"string"}}},"Mindbody.RestApi.Dto.Models.Site.Schedules.CalendarLocation":{"description":"Calendar location","type":"object","properties":{"Id":{"format":"int32","description":"Location identifier","type":"integer"},"Name":{"description":"Location name","type":"string"},"TimeZoneId":{"description":"The time zone unique identifier for the location.","type":"string"},"Address":{"description":"The address line 1 of the location.","type":"string"},"Address2":{"description":"The address line 2 of the location.","type":"string"},"City":{"description":"The city of the location.","type":"string"},"StateProvCode":{"description":"The state / province of the location.","type":"string"},"PostalCode":{"description":"The postal code of the location.","type":"string"},"Country":{"description":"The country of the location.","type":"string"},"Latitude":{"format":"double","description":"The Latitude of the location.","type":"number"},"Longitude":{"format":"double","description":"The longitude of the location.","type":"number"}}},"Mindbody.RestApi.Dto.Models.Subscribers.LocationCountController.GetLocationCountRequest":{"type":"object","properties":{"StudioIds":{"description":"Studio IDs to filter","type":"array","items":{"format":"int32","type":"integer"}},"StartDate":{"format":"date-time","description":"Start date to filter location count date","type":"string"},"EndDate":{"format":"date-time","description":"End date to filter location count date","type":"string"}}},"Mindbody.RestApi.Dto.Models.Subscribers.LocationCountController.StudioLocationCount":{"type":"object","properties":{"StudioId":{"format":"int32","description":"ID of a studio","type":"integer"},"LocationCountDate":{"format":"date-time","description":"Date the count is calculated","type":"string"},"LocationCount":{"format":"int32","description":"Location count value","type":"integer"}}},"MindbodyApi.Models.Dashboard.MonthlyData`1[[System.Decimal, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]":{"description":"Dashboard data for the specified month","type":"object","properties":{"Value":{"format":"double","type":"number"},"Month":{"format":"int32","type":"integer"},"Year":{"format":"int32","type":"integer"}}},"MindbodyApi.Models.Dashboard.MonthlyData`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]":{"description":"Dashboard data for the specified month","type":"object","properties":{"Value":{"format":"int32","type":"integer"},"Month":{"format":"int32","type":"integer"},"Year":{"format":"int32","type":"integer"}}},"Mindbody.RestApi.Dto.Models.Site.Schedules.AppointmentRequest":{"description":"Object that represents an AppointmentRequest made by a user.","type":"object","properties":{"Id":{"format":"int64","description":"Request unique identifier","type":"integer"},"StartDateTime":{"format":"date-time","description":"Start date time of the appointment","type":"string"},"EndDateTime":{"format":"date-time","description":"End date time of the appointment","type":"string"},"Status":{"description":"Return the appointment status.\r\nTODO: this should replace the status fields above.","enum":["Booked","Completed","Confirmed","Arrived","NoShow","Cancelled"],"type":"string"},"ProgramId":{"format":"int32","description":"Program unique identifier","type":"integer"},"SessionTypeId":{"format":"int32","description":"Session type unique identifier","type":"integer"},"PrepTime":{"format":"int32","description":"Prep time for the appointment","type":"integer"},"FinishTime":{"format":"int32","description":"Finish time for the appointment","type":"integer"},"StaffId":{"format":"int64","description":"Appointment staff","type":"integer"},"ClientId":{"format":"int64","description":"Appointment client","type":"integer"},"LocationId":{"format":"int32","description":"Location unique identifier for the appointment","type":"integer"},"ClientName":{"description":"Client for the appointment request","type":"string"},"ClientFormattedNameForSchedule":{"description":"Client name for the appointment request, formatted for schedule view","type":"string"},"ClientHomePhone":{"description":"Client home phone number","type":"string"},"ClientMobilePhone":{"description":"Client mobile phone number","type":"string"},"ClientWorkPhone":{"description":"Client work phone number","type":"string"},"ClientEmail":{"description":"Client email","type":"string"},"StaffProviderId":{"format":"int64","description":"Staff provider unique identifier","type":"integer"},"MemberIcon":{"format":"int32","description":"Membership icon","type":"integer"},"MemberDetails":{"description":"Membership details","type":"string"},"RequestedStaffId":{"format":"int64","description":"Staff that requested the appointment","type":"integer"},"SystemClient":{"description":"Whether the client is a system generated client","type":"boolean"},"Arrived":{"description":"Whether the client has arrived for the appointment or not","type":"boolean"},"Confirmed":{"description":"Whether the client has confirmed the appointment or not","type":"boolean"},"Completed":{"description":"Whether the client has completed the appointment or not","type":"boolean"},"BookedOnline":{"description":"Whether the request was booked online or not","type":"boolean"},"FinderAppointment":{"description":"Whether the appointment was booked on Finder or not","type":"boolean"},"PaymentApplied":{"description":"Whether a payment was applied or not","type":"boolean"},"Capacity":{"format":"int32","description":"Capacity of the appointment","type":"integer"},"Notes":{"description":"Notes, if any, for this Appointment request","type":"string"},"ReservedFor":{"description":"Reserved for, if any","type":"string"},"ReservedByClientId":{"format":"int64","description":"Client's unique identifier who reserved the appointment, if any","type":"integer"},"ReservedByClientName":{"description":"Client's name who reserved the appointment, if any","type":"string"},"Recurring":{"description":"Whether the appointment is recurring or not","type":"boolean"},"GenderPreference":{"description":"Gender preference of the client","enum":["None","Male","Female"],"type":"string"},"ResourceIds":{"description":"Resources for the appointment","type":"array","items":{"format":"int32","type":"integer"}},"BookedById":{"format":"int64","description":"Staff that booked the appointment","type":"integer"},"BookedDateTime":{"format":"date-time","description":"Date time of the appointment","type":"string"},"ModifiedById":{"format":"int64","description":"Staff that modified the appointment","type":"integer"},"ModifiedDateTime":{"format":"date-time","description":"Date time of the last time the appointment request was modified","type":"string"},"ConfirmedById":{"format":"int64","description":"Confirmed by","type":"integer"},"ConfirmedDateTime":{"format":"date-time","description":"Date time for the confirmation of the appointment","type":"string"}}},"Mindbody.Contract.Scheduling.Models.AppointmentRequests.AppointmentRequestConfirmationRequest":{"type":"object","properties":{"AppointmentRequestReference":{"format":"int64","type":"integer"},"AppointmentTypeReference":{"format":"int32","type":"integer"},"StaffReference":{"format":"int64","type":"integer"},"AvailabilityReference":{"format":"int32","type":"integer"},"Range":{"$ref":"#/definitions/Mindbody.Contract.Scheduling.Models.Common.DateTimeRange"},"LocationReference":{"format":"int32","type":"integer"},"ConsumerReference":{"format":"int64","type":"integer"},"Notes":{"type":"string"},"ReservedByConsumerReference":{"format":"int64","type":"integer"},"ReservedFor":{"type":"string"},"ResourceReferences":{"type":"array","items":{"format":"int32","type":"integer"}},"GenderPreference":{"enum":["Male","Female","None"],"type":"string"},"PrepTime":{"format":"int32","type":"integer"},"FinishTime":{"format":"int32","type":"integer"},"WrapupTime":{"format":"int32","type":"integer"},"TrainerRequested":{"type":"boolean"},"RestSource":{"type":"string"},"Recurring":{"type":"boolean"},"RecurringAppointmentGroupId":{"format":"int32","type":"integer"},"Addons":{"type":"array","items":{"$ref":"#/definitions/Mindbody.Contract.Scheduling.Models.Appointments.AddonAppointmentRequest"}}}},"Mindbody.Contract.Scheduling.Models.Appointments.AddonAppointmentRequest":{"type":"object","properties":{"ID":{"format":"int64","type":"integer"},"SessionTypeID":{"format":"int32","type":"integer"},"SessionTypeName":{"type":"string"},"StaffID":{"format":"int64","type":"integer"},"StaffName":{"type":"string"},"PaymentApplied":{"type":"boolean"},"AppointmentType":{"$ref":"#/definitions/Mindbody.Contract.Scheduling.Models.AppointmentTypes.AppointmentType"},"StaffAppointmentType":{"$ref":"#/definitions/Mindbody.Contract.Scheduling.Models.StaffAppointmentTypes.StaffAppointmentType"}}},"Mindbody.Contract.Scheduling.Models.StaffAppointmentTypes.StaffAppointmentType":{"type":"object","properties":{"ID":{"format":"int32","type":"integer"},"StaffReference":{"format":"int64","type":"integer"},"AppointmentTypeReference":{"format":"int32","type":"integer"},"Active":{"type":"boolean"},"Duration":{"format":"int32","type":"integer"},"PrepTime":{"format":"int32","type":"integer"},"FinishTime":{"format":"int32","type":"integer"},"PerStaffPrice":{"format":"double","type":"number"},"SmartBookingLengthApplied":{"type":"boolean"}}},"Mindbody.Contract.Scheduling.Responses.StaffConfirmRequestResponse":{"type":"object","properties":{"Appointments":{"type":"object","additionalProperties":{"$ref":"#/definitions/Mindbody.Contract.Scheduling.Models.Appointments.Appointment"}},"AppointmentNotes":{"type":"object","additionalProperties":{"$ref":"#/definitions/Mindbody.Contract.Scheduling.Models.Appointments.AppointmentNotes"}},"AppointmentReservationInfo":{"type":"object","additionalProperties":{"$ref":"#/definitions/Mindbody.Contract.Scheduling.Models.Appointments.AppointmentReservationInfo"}},"AppointmentStatus":{"type":"object","additionalProperties":{"$ref":"#/definitions/Mindbody.Contract.Scheduling.Models.Appointments.AppointmentStatus"}},"AppointmentPaymentInfo":{"type":"object","additionalProperties":{"$ref":"#/definitions/Mindbody.Contract.Scheduling.Models.Appointments.AppointmentPaymentInfo"}},"Errors":{"type":"array","items":{"type":"string"}},"ErrorList":{"type":"array","items":{"$ref":"#/definitions/Mindbody.Contract.Scheduling.Models.Errors.Error"}},"BookingRolledBack":{"type":"boolean"},"PostBookingProcessSuccess":{"type":"boolean"},"AppointmentRequestDeleted":{"type":"boolean"}}},"Mindbody.Contract.Scheduling.Models.Errors.Error":{"type":"object","properties":{"Description":{"type":"string"},"Code":{"type":"string"}}},"Mindbody.RestApi.Common.Models.Results.DenyAppointmentRequestsResponse":{"type":"object","properties":{"Errors":{"type":"array","items":{"type":"string"}},"ErrorList":{"type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Errors.Error"}},"AppointmentRequestsDenied":{"type":"boolean"},"AppointmentRequestsDeniedIds":{"type":"array","items":{"format":"int64","type":"integer"}},"NotificationSent":{"type":"boolean"}}},"Mindbody.RestApi.Common.Models.Errors.Error":{"type":"object","properties":{"Code":{"type":"string"},"Description":{"type":"string"}}},"Mindbody.RestApi.Common.Models.Request.DenyMultipleAppointmentRequestsRequest":{"required":["AppointmentRequestIds"],"type":"object","properties":{"AppointmentRequestIds":{"type":"array","items":{"format":"int64","type":"integer"}},"ShouldNotifyConsumer":{"type":"boolean"}}},"Mindbody.RestApi.Common.Models.Results.DenyMultipleAppointmentRequestsResponse":{"type":"object","properties":{"ErrorList":{"type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Errors.Error"}},"AppointmentRequestsDenied":{"type":"array","items":{"format":"int64","type":"integer"}},"ShouldNotifyConsumer":{"type":"boolean"},"NotificationSent":{"type":"boolean"}}},"Mindbody.RestApi.Dto.Models.Users.ConsumerNotificationPreferencesRequest":{"description":"For updating a subscriber consumer's notification preferences.  Similar to ClientNotificationPreferences but only\r\ncontains opt ins that are editable","type":"object","properties":{"ConsumerId":{"description":"The consumer's profile ID or their User ID","type":"string"},"SubscriberId":{"format":"int32","description":"The Subscriber ID","type":"integer"},"PromotionalEmailOptIn":{"description":"Whether the consumer is opted into receiving promotional emails","type":"boolean"},"PromotionalTextOptIn":{"description":"Whether the consumer is opted into receiving promotional texts","type":"boolean"},"ScheduleEmailOptIn":{"description":"Whether the consumer is opted into receiving schedule related emails","type":"boolean"},"ScheduleTextOptIn":{"description":"Whether the consumer is opted into receiving schedule related texts","type":"boolean"},"AccountEmailOptIn":{"description":"Whether the consumer is opted into receiving account related emails","type":"boolean"},"AccountTextOptIn":{"description":"Whether the consumer is opted into receiving account related texts","type":"boolean"}}},"Mindbody.RestApi.Dto.Models.Business.GetCategoriesResponse":{"type":"object","properties":{"Categories":{"description":"Category results","type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Results.ClassCategory.ClassCategory"}}}},"Mindbody.RestApi.Common.Models.Results.ClassCategory.ClassCategory":{"type":"object","properties":{"VerticalId":{"format":"int32","type":"integer"},"VerticalName":{"type":"string"},"Categories":{"type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Results.ClassCategory.Category"}}}},"Mindbody.RestApi.Common.Models.Results.ClassCategory.Category":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Name":{"type":"string"}}},"Mindbody.RestApi.Common.Models.Site.BusinessInformation":{"type":"object","properties":{"Id":{"format":"int64","type":"integer"},"Industry":{"type":"string"},"BusinessName":{"type":"string"},"TimeZoneOffsetMinutes":{"format":"int32","type":"integer"},"ReplyEmail":{"type":"string"},"ReplyName":{"type":"string"},"BusinessEmail":{"type":"string"},"CountryCode":{"type":"string"},"StateProvCode":{"type":"string"},"City":{"type":"string"},"BusinessAutoEmailReplyName":{"type":"string"},"BusinessAutoEmailReplyAddress":{"type":"string"},"BusinessDescription":{"type":"string"}}},"Mindbody.RestApi.Dto.Models.Subscribers.BusinessInformationController.GetOwnerRequest":{"description":"Request class for GetOwner operation.","type":"object","properties":{"IncludeCorporateUser":{"description":"It would include corporate user too. By default it's false","type":"boolean"}}},"Mindbody.RestApi.Dto.Models.Site.Owner":{"type":"object","properties":{"Email":{"description":"Email Address","type":"string"},"FirstName":{"description":"First Name","type":"string"},"LastName":{"description":"Last Name","type":"string"},"TrainerId":{"format":"int64","description":"Local Staff Id for the owner","type":"integer"},"UniversalLoginId":{"format":"int32","description":"Universal Id for the owner's login name (sModeId)","type":"integer"}}},"Mindbody.RestApi.Dto.Models.Site.UnmigratedStaffLogin":{"description":"Represents a staff user that has not been migrated to Identity","type":"object","properties":{"FirstName":{"description":"Owner's first name","type":"string"},"LastName":{"description":"Owner's last name","type":"string"},"Username":{"description":"Owner's username","type":"string"}}},"Mindbody.RestApi.Dto.Models.Business.GetPromoCodesRequest":{"description":"Contract for promo code request","type":"object","properties":{"ActiveOnly":{"description":"Filter only active","type":"boolean"},"OnlineOnly":{"description":"Filter only the ones that can be sold online","type":"boolean"},"Ids":{"description":"Filter by promo code IDs","type":"array","items":{"format":"int32","type":"integer"}},"StartDate":{"format":"date-time","description":"Filter by activation start date","type":"string"},"EndDate":{"format":"date-time","description":"Filter by activation end date","type":"string"},"OrderBy":{"description":"Specify order of the results.\r\nOptions are Name, CreationDate, ActivationDate and Id","type":"string"},"Limit":{"format":"int32","description":"Number of results to return, defaults to 100","type":"integer"},"Offset":{"format":"int32","description":"Number of results to skip, defaults to 0","type":"integer"}}},"Mindbody.RestApi.Dto.Models.Business.GetPromoCodesResponse":{"description":"Response of getting promo codes","type":"object","properties":{"PaginationResponse":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Pagination.PaginationResponse","description":"Pagination info"},"PromoCodes":{"description":"Promo code results","type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Business.PromoCode"}}}},"Mindbody.RestApi.Dto.Models.Business.PromoCode":{"description":"Promo code","type":"object","properties":{"Id":{"format":"int32","description":"ID","type":"integer"},"Name":{"description":"Name of the promo code","type":"string"},"Code":{"description":"Code to be used at purchase for discount","type":"string"},"Active":{"description":"Active status","type":"boolean"},"Discount":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Business.Discount","description":"Discount info"},"ActivationDate":{"description":"Date activated","type":"string"},"ExpirationDate":{"description":"Date expired","type":"string"},"MaxUses":{"format":"int32","description":"How many times it can be used","type":"integer"},"NumberOfAutopays":{"format":"int32","description":"Number of Autopays","type":"integer"},"DaysAfterCloseDate":{"format":"int32","description":"Days after close date","type":"integer"},"AllowOnline":{"description":"Whether it can be used online","type":"boolean"},"DaysValid":{"description":"What days the promo code can be used","type":"array","items":{"enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],"type":"string"}},"ApplicableItems":{"description":"Items that the promo code will have the discount for.\r\nIf Null, promo code applies to all items.","type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Business.ApplicableItem"}}}},"Mindbody.RestApi.Dto.Models.Business.Discount":{"description":"Discount for a promo code","type":"object","properties":{"Type":{"description":"Type of discount percentage/amount","type":"string"},"Amount":{"format":"double","description":"Amount of discount","type":"number"}}},"Mindbody.RestApi.Dto.Models.Business.ApplicableItem":{"description":"Item that will be applied to a promo code","type":"object","properties":{"Type":{"description":"Type of a promo code","type":"string"},"Id":{"format":"int32","description":"ID of the item","type":"integer"},"Name":{"description":"Name of the item","type":"string"}}},"Mindbody.RestApi.Common.Models.Site.TaxTable":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Tax1":{"format":"double","type":"number"},"Tax2":{"format":"double","type":"number"},"Tax3":{"format":"double","type":"number"},"Tax4":{"format":"double","type":"number"},"Tax5":{"format":"double","type":"number"}}},"System.Web.Http.Results.JsonResult`1[[System.Collections.Generic.HashSet`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]], System.Core, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]":{"type":"object","properties":{"Content":{"type":"array","items":{"type":"string"},"readOnly":true},"SerializerSettings":{"$ref":"#/definitions/Newtonsoft.Json.JsonSerializerSettings","readOnly":true},"Encoding":{"$ref":"#/definitions/System.Text.Encoding","readOnly":true},"Request":{"type":"object","readOnly":true}}},"Newtonsoft.Json.JsonSerializerSettings":{"type":"object","properties":{"ReferenceLoopHandling":{"enum":["Error","Ignore","Serialize"],"type":"string"},"MissingMemberHandling":{"enum":["Ignore","Error"],"type":"string"},"ObjectCreationHandling":{"enum":["Auto","Reuse","Replace"],"type":"string"},"NullValueHandling":{"enum":["Include","Ignore"],"type":"string"},"DefaultValueHandling":{"enum":["Include","Ignore","Populate","IgnoreAndPopulate"],"type":"string"},"Converters":{"type":"array","items":{"$ref":"#/definitions/Newtonsoft.Json.JsonConverter"}},"PreserveReferencesHandling":{"enum":["None","Objects","Arrays","All"],"type":"string"},"TypeNameHandling":{"enum":["None","Objects","Arrays","All","Auto"],"type":"string"},"MetadataPropertyHandling":{"enum":["Default","ReadAhead","Ignore"],"type":"string"},"TypeNameAssemblyFormat":{"enum":["Simple","Full"],"type":"string"},"TypeNameAssemblyFormatHandling":{"enum":["Simple","Full"],"type":"string"},"ConstructorHandling":{"enum":["Default","AllowNonPublicDefaultConstructor"],"type":"string"},"ContractResolver":{"$ref":"#/definitions/Newtonsoft.Json.Serialization.IContractResolver"},"EqualityComparer":{"$ref":"#/definitions/System.Collections.IEqualityComparer"},"ReferenceResolver":{"$ref":"#/definitions/Newtonsoft.Json.Serialization.IReferenceResolver"},"ReferenceResolverProvider":{"$ref":"#/definitions/System.Func`1[[Newtonsoft.Json.Serialization.IReferenceResolver, Newtonsoft.Json, Version=13.0.0.0, Culture=neutral, PublicKeyToken=30ad4fe6b2a6aeed]]"},"TraceWriter":{"$ref":"#/definitions/Newtonsoft.Json.Serialization.ITraceWriter"},"Binder":{"$ref":"#/definitions/System.Runtime.Serialization.SerializationBinder"},"SerializationBinder":{"$ref":"#/definitions/Newtonsoft.Json.Serialization.ISerializationBinder"},"Error":{"type":"object"},"Context":{"$ref":"#/definitions/System.Runtime.Serialization.StreamingContext"},"DateFormatString":{"type":"string"},"MaxDepth":{"format":"int32","type":"integer"},"Formatting":{"enum":["None","Indented"],"type":"string"},"DateFormatHandling":{"enum":["IsoDateFormat","MicrosoftDateFormat"],"type":"string"},"DateTimeZoneHandling":{"enum":["Local","Utc","Unspecified","RoundtripKind"],"type":"string"},"DateParseHandling":{"enum":["None","DateTime","DateTimeOffset"],"type":"string"},"FloatFormatHandling":{"enum":["String","Symbol","DefaultValue"],"type":"string"},"FloatParseHandling":{"enum":["Double","Decimal"],"type":"string"},"StringEscapeHandling":{"enum":["Default","EscapeNonAscii","EscapeHtml"],"type":"string"},"Culture":{"type":"string"},"CheckAdditionalContent":{"type":"boolean"}}},"System.Text.Encoding":{"type":"object","properties":{"m_codePage":{"format":"int32","type":"integer"},"dataItem":{"$ref":"#/definitions/System.Globalization.CodePageDataItem"},"m_isReadOnly":{"type":"boolean"},"encoderFallback":{"$ref":"#/definitions/System.Text.EncoderFallback"},"decoderFallback":{"$ref":"#/definitions/System.Text.DecoderFallback"}}},"Newtonsoft.Json.JsonConverter":{"type":"object","properties":{"CanRead":{"type":"boolean","readOnly":true},"CanWrite":{"type":"boolean","readOnly":true}}},"Newtonsoft.Json.Serialization.IContractResolver":{"type":"object","properties":{}},"System.Collections.IEqualityComparer":{"type":"object","properties":{}},"Newtonsoft.Json.Serialization.IReferenceResolver":{"type":"object","properties":{}},"System.Func`1[[Newtonsoft.Json.Serialization.IReferenceResolver, Newtonsoft.Json, Version=13.0.0.0, Culture=neutral, PublicKeyToken=30ad4fe6b2a6aeed]]":{"type":"object","properties":{"Method":{"$ref":"#/definitions/System.Reflection.MethodInfo","readOnly":true},"Target":{"type":"object","readOnly":true}}},"Newtonsoft.Json.Serialization.ITraceWriter":{"type":"object","properties":{"LevelFilter":{"enum":["Off","Error","Warning","Info","Verbose"],"type":"string","readOnly":true}}},"System.Runtime.Serialization.SerializationBinder":{"type":"object","properties":{}},"Newtonsoft.Json.Serialization.ISerializationBinder":{"type":"object","properties":{}},"System.Runtime.Serialization.StreamingContext":{"type":"object","properties":{"m_additionalContext":{"type":"object"},"m_state":{"enum":["CrossProcess","CrossMachine","File","Persistence","Remoting","Other","Clone","CrossAppDomain","All"],"type":"string"}}},"System.Globalization.CodePageDataItem":{"type":"object","properties":{"m_dataIndex":{"format":"int32","type":"integer"},"m_uiFamilyCodePage":{"format":"int32","type":"integer"},"m_webName":{"type":"string"},"m_headerName":{"type":"string"},"m_bodyName":{"type":"string"},"m_flags":{"format":"int32","type":"integer"}}},"System.Text.EncoderFallback":{"type":"object","properties":{"bIsMicrosoftBestFitFallback":{"type":"boolean"}}},"System.Text.DecoderFallback":{"type":"object","properties":{"bIsMicrosoftBestFitFallback":{"type":"boolean"}}},"System.Reflection.MethodInfo":{"type":"object","properties":{}},"Mindbody.RestApi.WebApi.Areas.Business.Features.Models.FeatureRequest":{"description":"Request for the Feature resource","type":"object","properties":{"Status":{"description":"Status of the feature\r\nCurrently only supporting \"OFF\" value","type":"string"}}},"Mindbody.RestApi.Dto.Models.RecurringAppointments.RecurringRequest":{"description":"Request object for Recurring Appointment Validate.","type":"object","properties":{"Options":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.RecurringAppointments.RecurringOptions","description":"Gets configuration options for booking."},"Organizer":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.RecurringAppointments.Organizer","description":"Gets consumer/Organizer details."},"LocationId":{"format":"int32","description":"Gets location Id.","type":"integer"},"Itineraries":{"description":"Gets itineraries for appointment booking.","type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.RecurringAppointments.Itinerary"}}}},"Mindbody.RestApi.Dto.Models.RecurringAppointments.RecurringOptions":{"description":"Request object for Recurring Options.","type":"object","properties":{"StartDate":{"format":"date-time","description":"Gets start date of the recurring pattern.","type":"string"},"EndDate":{"format":"date-time","description":"Gets end date of the recurring pattern.","type":"string"},"StartTime":{"description":"Gets start time of the appointment.","type":"string"},"FrequencyInterval":{"format":"int32","description":"Gets of recurring interval.","type":"integer"},"EndBy":{"description":"Gets recurring End by Mode.","enum":["ByOccurrence","ByDate"],"type":"string"},"MaxOccurrence":{"format":"int32","description":"Gets max Occurrence when end by selected as By occurance.","type":"integer"},"SelectedDays":{"description":"Gets selected days into as list of DayOfWeek Enum values.","type":"array","items":{"enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],"type":"string"}},"IsSendConfirmationNotification":{"description":"Gets a value indicating whether send Confirmation Notification or not.","type":"boolean"},"BookingSource":{"description":"Gets platform identification for booking.","type":"string"},"IsApplyPayment":{"description":"Gets a value indicating whether apply Payment or not.","type":"boolean"}}},"Mindbody.RestApi.Dto.Models.RecurringAppointments.Organizer":{"description":"Booking Organizer","type":"object","properties":{"Attendee":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.RecurringAppointments.Attendee","description":"Gets organizer details ."}}},"Mindbody.RestApi.Dto.Models.RecurringAppointments.Itinerary":{"description":"Request object for Itinerarie.","type":"object","properties":{"Attendee":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.RecurringAppointments.Attendee","description":"Gets consumer/Organizer details."},"ItineraryEvents":{"description":"Gets list of ItineraryEvents.","type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.RecurringAppointments.ItineraryEvent"}}}},"Mindbody.RestApi.Dto.Models.RecurringAppointments.Attendee":{"description":"Request object for attendee.","type":"object","properties":{"LegacyConsumerId":{"format":"int64","description":"Gets or sets legacy consumer Id.","type":"integer"},"ConsumerId":{"format":"uuid","description":"Gets or sets consumer Id.","type":"string"},"Name":{"description":"Gets or sets consumer Name.","type":"string"}}},"Mindbody.RestApi.Dto.Models.RecurringAppointments.ItineraryEvent":{"description":"ItineraryEvent base Class.","type":"object","properties":{"ServiceTypeId":{"format":"int32","description":"Gets id of the service.","type":"integer"},"IsAddOn":{"description":"Gets a value indicating whether service is AddOn or not.","type":"boolean"},"ServiceGroupId":{"format":"int32","description":"Gets serviceGroupId of the recurring request.","type":"integer"},"DurationInMinutes":{"format":"int32","description":"Gets duration of the service. If missing, then uses service default.","type":"integer"},"Notes":{"description":"Gets of appointment notes.","type":"string"},"Resources":{"description":"Gets of Resources.","type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.RecurringAppointments.AppointmentResource"}}}},"Mindbody.RestApi.Dto.Models.RecurringAppointments.AppointmentResource":{"description":"AppointmentResource Class.","type":"object","properties":{"Type":{"description":"Gets or sets Type of the resoure.","enum":["Staff","Room"],"type":"string"},"Id":{"format":"int64","description":"Gets or sets Id of the resoure.","type":"integer"}}},"Mindbody.RestApi.Dto.Models.RecurringAppointments.ValidateResponse":{"description":"Response for validate endpoint","type":"object","properties":{"IsSuccess":{"description":"Is validation passed successfully","type":"boolean"},"Errors":{"description":"List of errors if any happened","type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.RecurringAppointments.ValidateError"}},"TotalSuccessCount":{"format":"int32","description":"Count of success from recurring list","type":"integer"}}},"Mindbody.RestApi.Dto.Models.RecurringAppointments.ValidateError":{"description":"Error object with date of the specific error","type":"object","properties":{"Date":{"format":"date-time","description":"Date of the error. If an error is generic and not related to specific date, then it would be null","type":"string"},"Code":{"description":"Error code","type":"string"},"Description":{"description":"Error description","type":"string"}}},"Mindbody.RestApi.Dto.Models.RecurringAppointments.BookResponse":{"description":"Response object for book a recurring appointment endpoint","type":"object","properties":{"ApptGroupId":{"format":"int32","description":"Id of the recurring appointment group","type":"integer"},"AppointmentIds":{"description":"Ids of the created appointments","type":"array","items":{"format":"int64","type":"integer"}},"Errors":{"description":"List of errors if any happened","type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.RecurringAppointments.ValidateError"}}}},"Mindbody.Contract.Scheduling.Models.Appointments.AppointmentBookingRequest":{"type":"object","properties":{"AppointmentTypeReference":{"format":"int32","type":"integer"},"StaffReference":{"format":"int64","type":"integer"},"AvailabilityReference":{"format":"int32","type":"integer"},"Range":{"$ref":"#/definitions/Mindbody.Contract.Scheduling.Models.Common.DateTimeRange"},"LocationReference":{"format":"int32","type":"integer"},"ConsumerReference":{"format":"int64","type":"integer"},"Notes":{"type":"string"},"ReservedByConsumerReference":{"format":"int64","type":"integer"},"ReservedFor":{"type":"string"},"ResourceReferences":{"type":"array","items":{"format":"int32","type":"integer"}},"GenderPreference":{"enum":["Male","Female","None"],"type":"string"},"PrepTime":{"format":"int32","type":"integer"},"FinishTime":{"format":"int32","type":"integer"},"WrapupTime":{"format":"int32","type":"integer"},"TrainerRequested":{"type":"boolean"},"RestSource":{"type":"string"},"Recurring":{"type":"boolean"},"RecurringAppointmentGroupId":{"format":"int32","type":"integer"},"Addons":{"type":"array","items":{"$ref":"#/definitions/Mindbody.Contract.Scheduling.Models.Appointments.AddonAppointmentRequest"}}}},"Mindbody.RestApi.Dto.Models.Schedules.BookAppointmentsAndAddonsRequest":{"description":"Booking Request for appointments and addons.","type":"object","properties":{"Appointments":{"description":"The list of appointments that are part of this booking request.","type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Schedules.Appointment"}}}},"Mindbody.RestApi.Dto.Models.Schedules.Appointment":{"description":"An instance of a service at a particular date and time. E.g. A hot stone massage at 9:30 am on Friday.","type":"object","properties":{"AppointmentTypeReference":{"format":"int32","description":"The type of the service. E.g. Hot Stone Massage.","type":"integer"},"StaffReference":{"format":"int64","description":"Id of the Staff that will be performing the service.","type":"integer"},"Range":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Schedules.DateTimeRange","description":"Gets {Mindbody.RestApi.Dto.Models.Schedules.Appointment}'s time range based on Studio's time zone."},"ConsumerReference":{"format":"int64","description":"An identifier for a consumer that is unique only within a subscriber context.","type":"integer"},"Notes":{"description":"Gets notes.","type":"string"},"ReservedFor":{"description":"The name of the person that will be attending the appointment in case it is for someone else.","type":"string"},"GenderPreference":{"description":"Gender preference of the staff which will perform the appointment.","enum":["Male","Female","NoPreference"],"type":"string"},"TrainerRequested":{"description":"Checks if the client has asked for this staff member specifically.","type":"boolean"},"AddonReferences":{"description":"List of addons for this service.","type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Schedules.AddOnRequest"}}}},"Mindbody.RestApi.Dto.Models.Schedules.DateTimeRange":{"description":"Object that holds a range between two dates.","type":"object","properties":{"Start":{"format":"date-time","description":"The start date and time of the range.","type":"string"},"End":{"format":"date-time","description":"The end date and time of the range.","type":"string"}}},"Mindbody.RestApi.Dto.Models.Schedules.AddOnRequest":{"description":"An instance of an add-on, a secondary service that can be scheduled together with a client's regular appointment.","type":"object","properties":{"AppointmentTypeReference":{"format":"int32","description":"The type of the service. E.g. Hot Stone Massage.","type":"integer"}}},"Mindbody.RestApi.Dto.Models.Schedules.BookAppointmentsAndAddonsResponse":{"description":"Response for booking an appointment with add-ons.","type":"object","properties":{"Appointments":{"description":"The list of appointments that are part of this booking response.","type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Schedules.AppointmentResponse"}},"Errors":{"description":"A collection of errors that have occurred.","type":"array","items":{"type":"string"}}}},"Mindbody.RestApi.Dto.Models.Schedules.AppointmentResponse":{"description":"An instance of a service at a particular date and time. E.g. A hot stone massage at 9:30 am on Friday.","type":"object","properties":{"Id":{"format":"int64","description":"The unique identifier for the appointment (VisitRefNo).","type":"integer"},"AppointmentTypeReference":{"format":"int32","description":"The type of the service. E.g. Hot Stone Massage (VisitType).","type":"integer"},"PaymentReference":{"format":"int64","description":"The identifier for the payment (PmtRefNo).","type":"integer"},"AddonReferences":{"description":"List of addons for this service.","type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Schedules.AddOnResponse"}}}},"Mindbody.RestApi.Dto.Models.Schedules.AddOnResponse":{"description":"An instance of an add-on, a secondary service that can be scheduled together with a client's regular appointment.","type":"object","properties":{"AddOnId":{"format":"int64","description":"The unique identifier for the add-on (VisitRefNo).","type":"integer"},"AppointmentTypeReference":{"format":"int32","description":"The type of the service. E.g. Hot Stone Massage (VisitType).","type":"integer"},"PaymentReference":{"format":"int64","description":"The identifier for the payment (PmtRefNo).","type":"integer"}}},"Mindbody.RestApi.Common.Models.Site.LocationSmall":{"type":"object","properties":{"ID":{"format":"int32","type":"integer"},"IsActive":{"type":"boolean"},"Name":{"type":"string"}}},"Mindbody.Contract.Scheduling.Responses.BuildBookableTimeRangesResponse":{"type":"object","properties":{"StaffAppointmentTypes":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/definitions/Mindbody.Contract.Scheduling.Models.StaffAppointmentTypes.StaffAppointmentType"}}},"BookableTimeRanges":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/definitions/Mindbody.Contract.Scheduling.Models.Common.DateTimeRange"}}}},"ActiveTimes":{"type":"array","items":{"type":"string"}},"Errors":{"type":"array","items":{"type":"string"}}}},"Mindbody.RestApi.Common.Models.Site.Directory.DirectoryClient":{"type":"object","properties":{"Id":{"type":"string"},"LegacyId":{"format":"int64","type":"integer"},"Alerts":{"type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Site.Directory.Alert"}},"FirstName":{"type":"string"},"LastName":{"type":"string"},"Email":{"type":"string"},"Phone":{"type":"string"},"Services":{"type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Site.Directory.DirectoryService"}}}},"Mindbody.RestApi.Common.Models.Site.Directory.Alert":{"type":"object","properties":{"Type":{"enum":["Staff","Medical"],"type":"string"},"Message":{"type":"string"}}},"Mindbody.RestApi.Common.Models.Site.Directory.DirectoryService":{"type":"object","properties":{"LegacyId":{"format":"int64","type":"integer"},"Name":{"type":"string"},"Staff":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Site.Directory.DirectoryStaff"},"Location":{"$ref":"#/definitions/Mindbody.RestApi.Common.Models.Site.Directory.Location"},"StartTime":{"format":"date-time","type":"string"}}},"Mindbody.RestApi.Common.Models.Site.Directory.DirectoryStaff":{"type":"object","properties":{"LegacyId":{"format":"int64","type":"integer"},"FirstName":{"type":"string"},"LastName":{"type":"string"}}},"Mindbody.RestApi.Common.Models.Site.Directory.Location":{"type":"object","properties":{"LegacyId":{"format":"int32","type":"integer"},"Name":{"type":"string"}}},"Mindbody.RestApi.Dto.Models.Client.ClientProfile":{"description":"Contains information for a client or staff member to view about the client.","type":"object","properties":{"Id":{"format":"int64","description":"ClientId aka UniqueId","type":"integer"},"ExternalId":{"description":"RSSID","type":"string"},"FirstName":{"description":"First Name","type":"string"},"LastName":{"description":"Last Name","type":"string"},"MiddleName":{"description":"Middle Name","type":"string"},"Email":{"description":"Email","type":"string"},"HomePhone":{"description":"Home Phone Number","type":"string"},"WorkPhone":{"description":"Work Phone Number","type":"string"},"MobilePhone":{"description":"Mobile Phone Number","type":"string"},"Address":{"description":"Client Stree Address","type":"string"},"Address2":{"description":"Client Street Address Line 2","type":"string"},"City":{"description":"City for Client Address","type":"string"},"State":{"description":"State for Client Address","type":"string"},"Country":{"description":"Country for Client Address","type":"string"},"PostalCode":{"description":"Client Address Zip Code","type":"string"},"Gender":{"description":"Gender","type":"string"},"BirthDate":{"format":"date-time","description":"Birthdate","type":"string"},"ReferredBy":{"description":"Name of client who referred this client","type":"string"},"EmergencyContactInfoName":{"description":"Name of Emergency contact","type":"string"},"EmergencyContactInfoRelationship":{"description":"Emergency contact's relationship to this client","type":"string"},"EmergencyContactInfoPhone":{"description":"Phone number of emergency contact","type":"string"},"EmergencyContactInfoEmail":{"description":"Email of emergency contact","type":"string"},"HomeLocation":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Location.Location","description":"The default studio location for this client"},"ClientCreditCard":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Client.ClientCreditCard","description":"Client credit card information"}}},"Mindbody.RestApi.Dto.Models.Client.ClientCreditCard":{"type":"object","properties":{"CardType":{"type":"string"},"CardLastFour":{"type":"string"}}},"Mindbody.RestApi.Common.Models.Site.Clients.ClientNotes":{"type":"object","properties":{"ClientId":{"format":"int64","type":"integer"},"Notes":{"type":"string"}}},"Mindbody.RestApi.Dto.Models.Client.ClientLiabilityReleaseStatus":{"description":"Client liability waiver status (if Consumer/Client has signed then status of the latest waiver is signed or not)\r\nand has studio opted for liability waiver","type":"object","properties":{"HasConsumerSigned":{"description":"latest status of the liability waiver signed by consumer","type":"boolean"},"RequireInConsumerMode":{"description":"Enables/disables requiring customers to sign the release form when creating an account.","type":"boolean"}}},"Mindbody.RestApi.Dto.Models.Client.CreateClientProfileRequest":{"description":"Request for creating a client profile","type":"object","properties":{"UserId":{"description":"The User ID of the authenticated client OR their dependent. When provided, the client profile will be created for this user.","type":"string"},"ExternalId":{"description":"RSSID","type":"string"},"MiddleName":{"description":"Middle Name","type":"string"},"HomePhone":{"description":"Home Phone Number","type":"string"},"WorkPhone":{"description":"Work Phone Number","type":"string"},"MobilePhone":{"description":"Mobile Phone Number","type":"string"},"Address":{"description":"Client Stree Address","type":"string"},"Address2":{"description":"Client Street Address Line 2","type":"string"},"City":{"description":"City for Client Address","type":"string"},"State":{"description":"State for Client Address","type":"string"},"Country":{"description":"Country for Client Address","type":"string"},"PostalCode":{"description":"Client Address Zip Code","type":"string"},"Gender":{"description":"Gender","type":"string"},"BirthDate":{"format":"date-time","description":"Birthdate","type":"string"},"ReferredBy":{"description":"Name of client who referred this client","type":"string"},"EmergencyContactInfoName":{"description":"Name of Emergency contact","type":"string"},"EmergencyContactInfoRelationship":{"description":"Emergency contact's relationship to this client","type":"string"},"EmergencyContactInfoPhone":{"description":"Phone number of emergency contact","type":"string"},"EmergencyContactInfoEmail":{"description":"Email of emergency contact","type":"string"},"Test":{"description":"When true, the client will not actually be created in the database.\r\nDefaults to false.","type":"boolean"}}},"Mindbody.RestApi.Dto.Models.Client.ClientsProfileRequest":{"description":"Request for getting client profile for multiple client ids","type":"object","properties":{"ClientIds":{"description":"List of client ids","type":"array","items":{"format":"int64","type":"integer"}}}},"Mindbody.RestApi.Dto.Models.Client.ClientProfileAndImage":{"description":"Contains information for a client with client profile image","type":"object","properties":{"ImageUrl":{"description":"Client profile image Url","type":"string"},"Id":{"format":"int64","description":"ClientId aka UniqueId","type":"integer"},"ExternalId":{"description":"RSSID","type":"string"},"FirstName":{"description":"First Name","type":"string"},"LastName":{"description":"Last Name","type":"string"},"MiddleName":{"description":"Middle Name","type":"string"},"Email":{"description":"Email","type":"string"},"HomePhone":{"description":"Home Phone Number","type":"string"},"WorkPhone":{"description":"Work Phone Number","type":"string"},"MobilePhone":{"description":"Mobile Phone Number","type":"string"},"Address":{"description":"Client Stree Address","type":"string"},"Address2":{"description":"Client Street Address Line 2","type":"string"},"City":{"description":"City for Client Address","type":"string"},"State":{"description":"State for Client Address","type":"string"},"Country":{"description":"Country for Client Address","type":"string"},"PostalCode":{"description":"Client Address Zip Code","type":"string"},"Gender":{"description":"Gender","type":"string"},"BirthDate":{"format":"date-time","description":"Birthdate","type":"string"},"ReferredBy":{"description":"Name of client who referred this client","type":"string"},"EmergencyContactInfoName":{"description":"Name of Emergency contact","type":"string"},"EmergencyContactInfoRelationship":{"description":"Emergency contact's relationship to this client","type":"string"},"EmergencyContactInfoPhone":{"description":"Phone number of emergency contact","type":"string"},"EmergencyContactInfoEmail":{"description":"Email of emergency contact","type":"string"},"HomeLocation":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Location.Location","description":"The default studio location for this client"},"ClientCreditCard":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Client.ClientCreditCard","description":"Client credit card information"}}},"Mindbody.RestApi.Dto.Models.Subscribers.StudiosController.GetStudiosRequest":{"description":"Request for getting the list of studios","type":"object","properties":{"IncludeInactive":{"description":"Includes inactive (deleted and deactivated) ones.\r\nDefaults to false.","type":"boolean"},"Limit":{"format":"int32","description":"Number of results to return, defaults to 100","type":"integer"},"Offset":{"format":"int32","description":"Number of results to skip, defaults to 0","type":"integer"}}},"Mindbody.RestApi.Dto.Models.Subscribers.StudiosController.GetStudiosResponse":{"description":"Response for requested studio info","type":"object","properties":{"PaginationResponse":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Pagination.PaginationResponse","description":"Pagination response"},"Studios":{"description":"List of businesses","type":"array","items":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Site.Studio"}}}},"Mindbody.RestApi.Dto.Models.Site.Studio":{"description":"Basic information for a studio","type":"object","properties":{"StudioId":{"format":"int32","description":"Studio ID","type":"integer"},"StudioName":{"description":"Studio name","type":"string"},"IsDemo":{"description":"Indicate demo or test studio","type":"boolean"}}},"Mindbody.RestApi.Dto.Models.Subscribers.StudiosController.StudioBusinessInfo":{"description":"Studio business information","type":"object","properties":{"StudioId":{"format":"int32","description":"Studio ID","type":"integer"},"Name":{"description":"Studio name","type":"string"},"City":{"description":"Studio city","type":"string"},"StateProvinceCode":{"description":"Studio state or province code","type":"string"},"CountryCode":{"description":"Studio country code","type":"string"},"Deactivated":{"description":"Determine if the studio has been deactivated.","type":"boolean"},"Deleted":{"description":"Determine if the studio has been deleted.","type":"boolean"},"LogoUrl":{"description":"Full sized logo URL","type":"string"},"MobileLogoUrl":{"description":"Mobile logo URL","type":"string"}}},"Mindbody.RestApi.Dto.Models.Subscribers.ReviewsController.ClassReviewAbuseRequest":{"description":"Request used for reporting MB class review abuse.","type":"object","properties":{"ReportingUserId":{"description":"Reporting user identifier.","type":"string"},"ReportingUserFirstName":{"description":"Reporting user's first name.","type":"string"},"ReportingUserLastName":{"description":"Reporting user's last name.","type":"string"},"ReportingUserEmail":{"description":"Reporting user's email address.","type":"string"},"ReportingAppType":{"description":"Reporting application type.  Should be either 'MBBMA' or 'MBAPP' as of this writing.","type":"string"},"ReportingAppName":{"description":"Reporting application name.","type":"string"},"ReportingAppBrandId":{"description":"Reporting application brand identifier.","type":"string"},"ReportedReview":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Subscribers.Review","description":"Review that was reported."}}},"Mindbody.RestApi.Dto.Models.Subscribers.Review":{"description":"Represents a user review.","type":"object","properties":{"Id":{"format":"int64","description":"Review unique identifier.","type":"integer"},"UserFirstName":{"description":"User's first name.","type":"string"},"UserLastName":{"description":"User's last name.","type":"string"},"UserImageUrl":{"description":"User's image url.","type":"string"},"UserId":{"format":"int32","description":"User's unique identifier.","type":"integer"},"Rating":{"format":"int32","description":"Review rating.","type":"integer"},"Created":{"format":"date-time","description":"Date/time review was created.","type":"string"},"StaffId":{"format":"int32","description":"Staff's unique identifier.","type":"integer"},"StaffName":{"description":"Staff's name.","type":"string"},"VisitId":{"format":"int64","description":"Unique visit identifier.","type":"integer"},"VisitName":{"description":"Visit name.","type":"string"},"ClassId":{"format":"int32","description":"Optional unique identifier for class that was reviewed.","type":"integer"},"ClassScheduleId":{"format":"int32","description":"Optional unique identifier for class schedule that was reviewed.","type":"integer"},"SiteId":{"format":"int32","description":"Unique site identifier.","type":"integer"},"LocationId":{"format":"int32","description":"Unique location identifier.","type":"integer"},"MasterLocationId":{"format":"int32","description":"Unique master location identifier.","type":"integer"},"ReviewText":{"description":"Review text.","type":"string"},"UpVotes":{"format":"int32","description":"Number of upvotes for the review.","type":"integer"},"DownVotes":{"format":"int32","description":"Number of downvotes for the review.","type":"integer"},"Deleted":{"description":"Whether this review has been deleted or not.","type":"boolean"},"ReviewTypeId":{"description":"Optional review type identifier.","enum":["Class","Appointment","Location","Staff","Workshop","Enrollment"],"type":"string"},"DetailId":{"format":"int32","description":"Optional review detail unique identifier.","type":"integer"},"ReviewResponse":{"$ref":"#/definitions/Mindbody.RestApi.Dto.Models.Subscribers.ReviewResponse","description":"Review response."}}},"Mindbody.RestApi.Dto.Models.Subscribers.ReviewResponse":{"description":"Response for a specific review.","type":"object","properties":{"Id":{"format":"int64","description":"Response unique identifier.","type":"integer"},"ReviewId":{"format":"int64","description":"Review unique identifier.","type":"integer"},"ResponseText":{"description":"Response text for the review.","type":"string"},"DateResponded":{"format":"date-time","description":"Date responded","type":"string"},"SmodeId":{"format":"int64","description":"Globally unique staff identifier.","type":"integer"},"Deleted":{"description":"Whether review response has been deleted or not.","type":"boolean"},"DeletedBy":{"format":"int64","description":"If review response was deleted, by whom.","type":"integer"}}},"Mindbody.RestApi.Dto.Models.LiveStream.LiveStreamStatusChangedRequest":{"description":"Live stream status changed payload","type":"object","properties":{"StudioId":{"description":"Studio the live stream change event is originating from","type":"string"},"ClassInstanceId":{"description":"Class instance id affected by the change","type":"string"},"MeetingId":{"description":"Meeting affected by the change","type":"string"},"Status":{"description":"Status change : created or deleted","type":"string"}}}}}