POST api/partners/v1/appointment
Request Information
URI Parameters
None.
Body Parameters
PartnerAppointmentCreateRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| CFId | integer |
None. |
|
| AppId | integer |
None. |
|
| TrtId | integer |
None. |
|
| AppointmentDate | string |
None. |
|
| AppointmentStartTime | string |
None. |
|
| Resource1Id | integer |
None. |
|
| Resource2Id | integer |
None. |
|
| Resource3Id | integer |
None. |
|
| Notes | string |
None. |
|
| UnitPrice | decimal number |
None. |
|
| DiscountValue | decimal number |
None. |
|
| IsLocked | boolean |
None. |
|
| CustomerName | string |
None. |
|
| CustomerSurname | string |
None. |
|
| CustomerEmail | string |
None. |
|
| CustomerPhone | string |
None. |
|
| CustomerAddress | string |
None. |
|
| CustomerNotes | string |
None. |
|
| CustomerRoom | string |
None. |
|
| PMSProperty | string |
None. |
|
| PMSRoom | string |
None. |
|
| PMSAccount | string |
None. |
|
| PMSReservationId | string |
None. |
|
| PMSCustomerAlias | string |
None. |
|
| PMSArrival | string |
None. |
|
| PMSDeparture | string |
None. |
|
| PropertyId | integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"CFId": 1,
"AppId": 2,
"TrtId": 3,
"AppointmentDate": "sample string 4",
"AppointmentStartTime": "sample string 5",
"Resource1Id": 6,
"Resource2Id": 7,
"Resource3Id": 8,
"Notes": "sample string 9",
"UnitPrice": 10.1,
"DiscountValue": 11.1,
"IsLocked": true,
"CustomerName": "sample string 13",
"CustomerSurname": "sample string 14",
"CustomerEmail": "sample string 15",
"CustomerPhone": "sample string 16",
"CustomerAddress": "sample string 17",
"CustomerNotes": "sample string 18",
"CustomerRoom": "sample string 19",
"PMSProperty": "sample string 20",
"PMSRoom": "sample string 21",
"PMSAccount": "sample string 22",
"PMSReservationId": "sample string 23",
"PMSCustomerAlias": "sample string 24",
"PMSArrival": "sample string 25",
"PMSDeparture": "sample string 26",
"PropertyId": 27
}
application/xml, text/xml
Sample:
<PartnerAppointmentCreateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Atlantis.Library.Web.Models"> <AppId>2</AppId> <AppointmentDate>sample string 4</AppointmentDate> <AppointmentStartTime>sample string 5</AppointmentStartTime> <CFId>1</CFId> <CustomerAddress>sample string 17</CustomerAddress> <CustomerEmail>sample string 15</CustomerEmail> <CustomerName>sample string 13</CustomerName> <CustomerNotes>sample string 18</CustomerNotes> <CustomerPhone>sample string 16</CustomerPhone> <CustomerRoom>sample string 19</CustomerRoom> <CustomerSurname>sample string 14</CustomerSurname> <DiscountValue>11.1</DiscountValue> <IsLocked>true</IsLocked> <Notes>sample string 9</Notes> <PMSAccount>sample string 22</PMSAccount> <PMSArrival>sample string 25</PMSArrival> <PMSCustomerAlias>sample string 24</PMSCustomerAlias> <PMSDeparture>sample string 26</PMSDeparture> <PMSProperty>sample string 20</PMSProperty> <PMSReservationId>sample string 23</PMSReservationId> <PMSRoom>sample string 21</PMSRoom> <PropertyId>27</PropertyId> <Resource1Id>6</Resource1Id> <Resource2Id>7</Resource2Id> <Resource3Id>8</Resource3Id> <TrtId>3</TrtId> <UnitPrice>10.1</UnitPrice> </PartnerAppointmentCreateRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
PartnerAppointment| Name | Description | Type | Additional information |
|---|---|---|---|
| CFId | integer |
None. |
|
| FolderAlias | string |
None. |
|
| CFPId | integer |
None. |
|
| CustId | integer |
None. |
|
| AppId | integer |
None. |
|
| TrtId | integer |
None. |
|
| TrtDescription | string |
None. |
|
| TrtDuration | integer |
None. |
|
| TrtPrice | decimal number |
None. |
|
| AppointmentDate | string |
None. |
|
| AppointmentStartTime | string |
None. |
|
| AppointmentEndTime | string |
None. |
|
| AppointmentTherapist | string |
None. |
|
| AppointmentRoom | string |
None. |
|
| CustomerName | string |
None. |
|
| CustomerSurname | string |
None. |
|
| CustomerEmail | string |
None. |
|
| CustomerPhone | string |
None. |
|
| Resource1Id | integer |
None. |
|
| Resource2Id | integer |
None. |
|
| Resource3Id | integer |
None. |
|
| Notes | string |
None. |
|
| IsLocked | boolean |
None. |
|
| EntryType | AppointmentTypes |
None. |
|
| SessionId | integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"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
}
application/xml, text/xml
Sample:
<PartnerAppointment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Atlantis.Library.Web.Models"> <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> </PartnerAppointment>