GET api/appointment/{id}

Request Information

URI Parameters

Name	Description	Type	Additional information
id		integer	Required

Body Parameters

None.

Response Information

Resource Description

AppointmentDTO

Name	Type	Additional information
CFId	integer	None.
FolderAlias	string	None.
CFPId	integer	None.
CustId	integer	None.
AppId	integer	None.
TrtId	integer	None.
LockId	integer	None.
TrtDescription	string	None.
TrtDuration	integer	None.
TrtPrice	decimal number	None.
SaleTypeId	integer	None.
PriceListId	integer	None.
UnitPrice	decimal number	None.
DiscountPrcnt	decimal number	None.
DiscountValue	decimal number	None.
PayoutValue	decimal number	None.
LeaderId	integer	None.
IsMaison	boolean	None.
ExtraInfo	string	None.
AppointmentStartDateTime	date	None.
AppointmentDate	string	None.
AppointmentStartTime	string	None.
AppointmentEndTime	string	None.
AppointmentTherapist	string	None.
AppointmentRoom	string	None.
CustomerRoom	string	None.
CustomerName	string	None.
CustomerSurname	string	None.
CustomerEmail	string	None.
CustomerPhone	string	None.
CustomerAddress	string	None.
CustomerLanguageId	integer	None.
CustomerTypeId	integer	None.
CustomerNotes	string	None.
PMSProperty	string	None.
PMSRoom	string	None.
PMSAccount	string	None.
PMSReservationId	string	None.
PMSCustomerAlias	string	None.
PMSArrival	string	None.
PMSDeparture	string	None.
Resource1Id	integer	None.
Resource2Id	integer	None.
Resource3Id	integer	None.
ProdDescr	string	None.
Notes	string	None.
BookingSourceId	integer	None.
IsLocked	boolean	None.
PropertyId	integer	None.
CancellationReasonId	integer	None.
CancellationMessage	string	None.
ProductRecommendationId	integer	None.
IsCancelled	boolean	None.
IsCharged	boolean	None.
AcceptsMarketingEmails	boolean	None.
AcceptsOperationEmails	boolean	None.
IsForCouple	boolean	None.
ExtReference1	string	None.
ExtReference2	string	None.
CheckInState	byte	None.
ModifierId1	integer	None.
ModifierId2	integer	None.
ModifierId3	integer	None.
ModifierId4	integer	None.
TherapistState	byte	None.
ActualStartTimeSerial	integer	None.
ActualEndTimeSerial	integer	None.
TherapistNotes	string	None.

Response Formats

application/json, text/json

Sample:

{
  "CFId": 1,
  "FolderAlias": "sample string 2",
  "CFPId": 3,
  "CustId": 4,
  "AppId": 5,
  "TrtId": 6,
  "LockId": 7,
  "TrtDescription": "sample string 8",
  "TrtDuration": 9,
  "TrtPrice": 10.1,
  "SaleTypeId": 11,
  "PriceListId": 12,
  "UnitPrice": 13.1,
  "DiscountPrcnt": 14.1,
  "DiscountValue": 15.1,
  "PayoutValue": 16.1,
  "LeaderId": 17,
  "IsMaison": true,
  "ExtraInfo": "sample string 19",
  "AppointmentStartDateTime": "2025-05-04T19:24:04.5399407+03:00",
  "AppointmentDate": "sample string 21",
  "AppointmentStartTime": "sample string 22",
  "AppointmentEndTime": "sample string 23",
  "AppointmentTherapist": "sample string 24",
  "AppointmentRoom": "sample string 25",
  "CustomerRoom": "sample string 26",
  "CustomerName": "sample string 27",
  "CustomerSurname": "sample string 28",
  "CustomerEmail": "sample string 29",
  "CustomerPhone": "sample string 30",
  "CustomerAddress": "sample string 31",
  "CustomerLanguageId": 32,
  "CustomerTypeId": 33,
  "CustomerNotes": "sample string 34",
  "PMSProperty": "sample string 35",
  "PMSRoom": "sample string 36",
  "PMSAccount": "sample string 37",
  "PMSReservationId": "sample string 38",
  "PMSCustomerAlias": "sample string 39",
  "PMSArrival": "sample string 40",
  "PMSDeparture": "sample string 41",
  "Resource1Id": 42,
  "Resource2Id": 43,
  "Resource3Id": 44,
  "ProdDescr": "sample string 45",
  "Notes": "sample string 46",
  "BookingSourceId": 47,
  "IsLocked": true,
  "PropertyId": 49,
  "CancellationReasonId": 50,
  "CancellationMessage": "sample string 51",
  "ProductRecommendationId": 52,
  "IsCancelled": true,
  "IsCharged": true,
  "AcceptsMarketingEmails": true,
  "AcceptsOperationEmails": true,
  "IsForCouple": true,
  "ExtReference1": "sample string 58",
  "ExtReference2": "sample string 59",
  "CheckInState": 64,
  "ModifierId1": 61,
  "ModifierId2": 62,
  "ModifierId3": 63,
  "ModifierId4": 64,
  "TherapistState": 64,
  "ActualStartTimeSerial": 66,
  "ActualEndTimeSerial": 67,
  "TherapistNotes": "sample string 68"
}

application/xml, text/xml

Sample:

<AppointmentDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Atlantis.Web.Api.Models">
  <AcceptsMarketingEmails>true</AcceptsMarketingEmails>
  <AcceptsOperationEmails>true</AcceptsOperationEmails>
  <ActualEndTimeSerial>67</ActualEndTimeSerial>
  <ActualStartTimeSerial>66</ActualStartTimeSerial>
  <AppId>5</AppId>
  <AppointmentDate>sample string 21</AppointmentDate>
  <AppointmentEndTime>sample string 23</AppointmentEndTime>
  <AppointmentRoom>sample string 25</AppointmentRoom>
  <AppointmentStartDateTime>2025-05-04T19:24:04.5399407+03:00</AppointmentStartDateTime>
  <AppointmentStartTime>sample string 22</AppointmentStartTime>
  <AppointmentTherapist>sample string 24</AppointmentTherapist>
  <BookingSourceId>47</BookingSourceId>
  <CFId>1</CFId>
  <CFPId>3</CFPId>
  <CancellationMessage>sample string 51</CancellationMessage>
  <CancellationReasonId>50</CancellationReasonId>
  <CheckInState>64</CheckInState>
  <CustId>4</CustId>
  <CustomerAddress>sample string 31</CustomerAddress>
  <CustomerEmail>sample string 29</CustomerEmail>
  <CustomerLanguageId>32</CustomerLanguageId>
  <CustomerName>sample string 27</CustomerName>
  <CustomerNotes>sample string 34</CustomerNotes>
  <CustomerPhone>sample string 30</CustomerPhone>
  <CustomerRoom>sample string 26</CustomerRoom>
  <CustomerSurname>sample string 28</CustomerSurname>
  <CustomerTypeId>33</CustomerTypeId>
  <DiscountPrcnt>14.1</DiscountPrcnt>
  <DiscountValue>15.1</DiscountValue>
  <ExtReference1>sample string 58</ExtReference1>
  <ExtReference2>sample string 59</ExtReference2>
  <ExtraInfo>sample string 19</ExtraInfo>
  <FolderAlias>sample string 2</FolderAlias>
  <IsCancelled>true</IsCancelled>
  <IsCharged>true</IsCharged>
  <IsForCouple>true</IsForCouple>
  <IsLocked>true</IsLocked>
  <IsMaison>true</IsMaison>
  <LeaderId>17</LeaderId>
  <LockId>7</LockId>
  <ModifierId1>61</ModifierId1>
  <ModifierId2>62</ModifierId2>
  <ModifierId3>63</ModifierId3>
  <ModifierId4>64</ModifierId4>
  <Notes>sample string 46</Notes>
  <PMSAccount>sample string 37</PMSAccount>
  <PMSArrival>sample string 40</PMSArrival>
  <PMSCustomerAlias>sample string 39</PMSCustomerAlias>
  <PMSDeparture>sample string 41</PMSDeparture>
  <PMSProperty>sample string 35</PMSProperty>
  <PMSReservationId>sample string 38</PMSReservationId>
  <PMSRoom>sample string 36</PMSRoom>
  <PayoutValue>16.1</PayoutValue>
  <PriceListId>12</PriceListId>
  <ProdDescr>sample string 45</ProdDescr>
  <ProductRecommendationId>52</ProductRecommendationId>
  <PropertyId>49</PropertyId>
  <Resource1Id>42</Resource1Id>
  <Resource2Id>43</Resource2Id>
  <Resource3Id>44</Resource3Id>
  <SaleTypeId>11</SaleTypeId>
  <TherapistNotes>sample string 68</TherapistNotes>
  <TherapistState>64</TherapistState>
  <TrtDescription>sample string 8</TrtDescription>
  <TrtDuration>9</TrtDuration>
  <TrtId>6</TrtId>
  <TrtPrice>10.1</TrtPrice>
  <UnitPrice>13.1</UnitPrice>
</AppointmentDTO>