POST api/partners/v1/appointments/self-cancel

Request Information

URI Parameters

None.

Body Parameters

PartnerAppointmentSelfCancelRequest
NameDescriptionTypeAdditional information
AppointmentId

integer

None.

CustomerFolderId

integer

None.

CancellationReasonId

integer

None.

CancellationMessage

string

None.

UserId

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "AppointmentId": 1,
  "CustomerFolderId": 2,
  "CancellationReasonId": 3,
  "CancellationMessage": "sample string 4",
  "UserId": 5
}

application/xml, text/xml

Sample:
<PartnerAppointmentSelfCancelRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Atlantis.Library.Web.Models">
  <AppointmentId>1</AppointmentId>
  <CancellationMessage>sample string 4</CancellationMessage>
  <CancellationReasonId>3</CancellationReasonId>
  <CustomerFolderId>2</CustomerFolderId>
  <UserId>5</UserId>
</PartnerAppointmentSelfCancelRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

PartnerAppointmentActionResponse
NameDescriptionTypeAdditional information
Appointment

PartnerAppointment

None.

ReturnCode

integer

None.

ReturnMessage

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Appointment": {
    "CFId": 1,
    "FolderAlias": "sample string 2",
    "CFPId": 3,
    "CustId": 4,
    "AppId": 5,
    "TrtId": 6,
    "TrtDescription": "sample string 7",
    "TrtDuration": 8,
    "TrtPrice": 9.1,
    "AppointmentDate": "sample string 10",
    "AppointmentStartTime": "sample string 11",
    "AppointmentEndTime": "sample string 12",
    "AppointmentTherapist": "sample string 13",
    "AppointmentRoom": "sample string 14",
    "CustomerName": "sample string 15",
    "CustomerSurname": "sample string 16",
    "CustomerEmail": "sample string 17",
    "CustomerPhone": "sample string 18",
    "Resource1Id": 19,
    "Resource2Id": 20,
    "Resource3Id": 21,
    "Notes": "sample string 22",
    "IsLocked": true,
    "EntryType": 0,
    "SessionId": 24
  },
  "ReturnCode": 1,
  "ReturnMessage": "sample string 2"
}

application/xml, text/xml

Sample:
<PartnerAppointmentActionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Atlantis.Library.Web.Models">
  <Appointment>
    <AppId>5</AppId>
    <AppointmentDate>sample string 10</AppointmentDate>
    <AppointmentEndTime>sample string 12</AppointmentEndTime>
    <AppointmentRoom>sample string 14</AppointmentRoom>
    <AppointmentStartTime>sample string 11</AppointmentStartTime>
    <AppointmentTherapist>sample string 13</AppointmentTherapist>
    <CFId>1</CFId>
    <CFPId>3</CFPId>
    <CustId>4</CustId>
    <CustomerEmail>sample string 17</CustomerEmail>
    <CustomerName>sample string 15</CustomerName>
    <CustomerPhone>sample string 18</CustomerPhone>
    <CustomerSurname>sample string 16</CustomerSurname>
    <EntryType>Single</EntryType>
    <FolderAlias>sample string 2</FolderAlias>
    <IsLocked>true</IsLocked>
    <Notes>sample string 22</Notes>
    <Resource1Id>19</Resource1Id>
    <Resource2Id>20</Resource2Id>
    <Resource3Id>21</Resource3Id>
    <SessionId>24</SessionId>
    <TrtDescription>sample string 7</TrtDescription>
    <TrtDuration>8</TrtDuration>
    <TrtId>6</TrtId>
    <TrtPrice>9.1</TrtPrice>
  </Appointment>
  <ReturnCode>1</ReturnCode>
  <ReturnMessage>sample string 2</ReturnMessage>
</PartnerAppointmentActionResponse>