DELETE api/Appointment

Request Information

URI Parameters

None.

Body Parameters

AppointmentEventBody
NameDescriptionTypeAdditional information
MessageID

string

None.

EventID

string

None.

EventSchemaVersion

integer

None.

EventInstanceOriginDate

string

None.

eventData

AppointmentEventData

None.

Request Formats

application/json, text/json

Sample:
{
  "MessageID": "sample string 1",
  "EventID": "sample string 2",
  "EventSchemaVersion": 3,
  "EventInstanceOriginDate": "sample string 4",
  "eventData": {
    "SiteID": 1,
    "AppointmentID": 2,
    "Status": "sample string 3",
    "IsConfirmed": true,
    "HasArrived": true,
    "LocationID": 6,
    "ClientID": "sample string 7",
    "ClientFirstName": "sample string 8",
    "ClientLastName": "sample string 9",
    "ClientEmail": "sample string 10",
    "ClientPhone": "sample string 11",
    "StaffID": 12,
    "StaffFirstName": "sample string 13",
    "StaffLastName": "sample string 14",
    "StartDateTime": "sample string 15",
    "EndDateTime": "sample string 16",
    "DurationMinutes": 17,
    "GenderRequested": "sample string 18",
    "resources": [
      {},
      {}
    ],
    "ResourcesID": 19,
    "ResourcesName": "sample string 20",
    "Notes": "sample string 21",
    "FormulaNotes": "sample string 22",
    "IcdCodes": [
      {},
      {}
    ],
    "IcdCodesCode": "sample string 23",
    "IcdCodesDescription": "sample string 24",
    "ProviderId": "sample string 25"
  }
}

text/plain

Sample:
{"MessageID":"sample string 1","EventID":"sample string 2","EventSchemaVersion":3,"EventInstanceOriginDate":"sample string 4","eventData":{"SiteID":1,"AppointmentID":2,"Status":"sample string 3","IsConfirmed":true,"HasArrived":true,"LocationID":6,"ClientID":"sample string 7","ClientFirstName":"sample string 8","ClientLastName":"sample string 9","ClientEmail":"sample string 10","ClientPhone":"sample string 11","StaffID":12,"StaffFirstName":"sample string 13","StaffLastName":"sample string 14","StartDateTime":"sample string 15","EndDateTime":"sample string 16","DurationMinutes":17,"GenderRequested":"sample string 18","resources":[{},{}],"ResourcesID":19,"ResourcesName":"sample string 20","Notes":"sample string 21","FormulaNotes":"sample string 22","IcdCodes":[{},{}],"IcdCodesCode":"sample string 23","IcdCodesDescription":"sample string 24","ProviderId":"sample string 25"}}

text/xml

Sample:
<AppointmentEventBody xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MindBody.Models">
  <EventID>sample string 2</EventID>
  <EventInstanceOriginDate>sample string 4</EventInstanceOriginDate>
  <EventSchemaVersion>3</EventSchemaVersion>
  <MessageID>sample string 1</MessageID>
  <eventData>
    <AppointmentID>2</AppointmentID>
    <ClientEmail>sample string 10</ClientEmail>
    <ClientFirstName>sample string 8</ClientFirstName>
    <ClientID>sample string 7</ClientID>
    <ClientLastName>sample string 9</ClientLastName>
    <ClientPhone>sample string 11</ClientPhone>
    <DurationMinutes>17</DurationMinutes>
    <EndDateTime>sample string 16</EndDateTime>
    <FormulaNotes>sample string 22</FormulaNotes>
    <GenderRequested>sample string 18</GenderRequested>
    <HasArrived>true</HasArrived>
    <IcdCodes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:anyType />
      <d3p1:anyType />
    </IcdCodes>
    <IcdCodesCode>sample string 23</IcdCodesCode>
    <IcdCodesDescription>sample string 24</IcdCodesDescription>
    <IsConfirmed>true</IsConfirmed>
    <LocationID>6</LocationID>
    <Notes>sample string 21</Notes>
    <ProviderId>sample string 25</ProviderId>
    <ResourcesID>19</ResourcesID>
    <ResourcesName>sample string 20</ResourcesName>
    <SiteID>1</SiteID>
    <StaffFirstName>sample string 13</StaffFirstName>
    <StaffID>12</StaffID>
    <StaffLastName>sample string 14</StaffLastName>
    <StartDateTime>sample string 15</StartDateTime>
    <Status>sample string 3</Status>
    <resources xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:anyType />
      <d3p1:anyType />
    </resources>
  </eventData>
</AppointmentEventBody>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

boolean

Response Formats

application/json, text/json, text/plain

Sample:
true

text/xml

Sample:
<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>