POST api/Appointment/ConfirmAppointment
Request Information
URI Parameters
None.
Body Parameters
ReservationPayload| Name | Description | Type | Additional information |
|---|---|---|---|
| PatientBundleKey | string |
None. |
|
| TimeZone | integer |
None. |
|
| TakafulCardKey | string |
None. |
|
| PaymentMethod | integer |
None. |
|
| Type | integer |
None. |
|
| Source | integer |
None. |
|
| ActionMaker | integer |
None. |
|
| UpdateReservationStatus | integer |
None. |
|
| ExaminationRoomKey | string |
None. |
|
| CallKey | string |
None. |
|
| ReservationDate | date |
None. |
|
| Duration | integer |
None. |
|
| InsuranceKey | string |
None. |
|
| PatientName | string |
None. |
|
| PatientPhone | string |
None. |
|
| PatientMail | string |
None. |
|
| PatientBirthDate | date |
None. |
|
| UserId | integer |
None. |
|
| RequiresConfirmation | boolean |
None. |
|
| PendingReservation | boolean |
None. |
|
| ModifierName | string |
None. |
|
| CreatedOn | date |
None. |
|
| ReservationKey | string |
None. |
|
| SurveyInstanceKey | string |
None. |
|
| OldReservationKey | string |
None. |
|
| Notes | string |
None. |
|
| PatientGender | boolean |
None. |
|
| CallerPhone | string |
None. |
|
| FollowUpNumber | string |
None. |
|
| ReservationNumber | string |
None. |
|
| AreaId | integer |
None. |
|
| AlternativeMobilePhone | string |
None. |
|
| LandLine | string |
None. |
|
| SecondReservationDate | date |
None. |
|
| ThirdReservationDate | date |
None. |
|
| CloseReasonId | integer |
None. |
|
| VisitTypeId | integer |
None. |
|
| Reason | string |
None. |
|
| DoctorMail | string |
None. |
|
| Action | string |
None. |
|
| RelativeName | string |
None. |
|
| PatientRelativeId | integer |
None. |
|
| IsCheckedIn | boolean |
None. |
|
| PatientCustomIdentifier | string |
None. |
|
| ForceSendReminderMessage | boolean |
None. |
|
| IsVacationCancelled | boolean |
None. |
|
| IsInsured | boolean |
None. |
|
| CreatedBy | integer |
None. |
|
| PatientKey | string |
None. |
|
| NoShow | boolean |
None. |
|
| IsHomeVisit | boolean |
None. |
|
| PatientAddress | string |
None. |
|
| CountryIsoCode | string |
None. |
|
| PatientCountryCode | string |
None. |
|
| ServiceKey | string |
None. |
|
| SendCancellationMessage | boolean |
None. |
|
| PatientCountryIsoCode | string |
None. |
|
| LocationKey | string |
None. |
|
| ReservationDateChaged | boolean |
None. |
|
| ProcessedCount | integer |
None. |
|
| PromoCodeKey | string |
None. |
|
| Fees | decimal number |
None. |
|
| FeesBeforeOffer | decimal number |
None. |
|
| CallSourceId | integer |
None. |
|
| SurveyId | integer |
None. |
|
| CallReasonId | integer |
None. |
|
| IsOnlinePayment | boolean |
None. |
|
| CashAtClinic | decimal number |
None. |
|
| LanguageId | integer |
None. |
|
| VoucherKey | string |
None. |
|
| BookingTypeId | integer |
None. |
|
| SubBookingTypeKey | string |
None. |
|
| EarnSelected | boolean |
None. |
|
| GlobalBooking | boolean |
None. |
|
| RegionId | string |
None. |
|
| HaveSymptoms | boolean |
None. |
|
| BrandKey | string |
None. |
|
| IsFastPass | boolean |
None. |
|
| InsuranceCardKey | string |
None. |
|
| ProofOfCheckInNo | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"PatientBundleKey": "sample string 1",
"TimeZone": 2,
"TakafulCardKey": "sample string 3",
"PaymentMethod": 1,
"Type": 4,
"Source": 5,
"ActionMaker": 6,
"UpdateReservationStatus": 7,
"ExaminationRoomKey": "sample string 8",
"CallKey": "sample string 9",
"ReservationDate": "2025-12-06T06:41:27.1869498+02:00",
"Duration": 1,
"InsuranceKey": "sample string 10",
"PatientName": "sample string 11",
"PatientPhone": "sample string 12",
"PatientMail": "sample string 13",
"PatientBirthDate": "2025-12-06T06:41:27.1869498+02:00",
"UserId": 1,
"RequiresConfirmation": true,
"PendingReservation": true,
"ModifierName": "sample string 14",
"CreatedOn": "2025-12-06T06:41:27.1869498+02:00",
"ReservationKey": "sample string 15",
"SurveyInstanceKey": "sample string 16",
"OldReservationKey": "sample string 17",
"Notes": "sample string 18",
"PatientGender": true,
"CallerPhone": "sample string 19",
"FollowUpNumber": "sample string 20",
"ReservationNumber": "sample string 21",
"AreaId": 1,
"AlternativeMobilePhone": "sample string 22",
"LandLine": "sample string 23",
"SecondReservationDate": "2025-12-06T06:41:27.1869498+02:00",
"ThirdReservationDate": "2025-12-06T06:41:27.1869498+02:00",
"CloseReasonId": 1,
"VisitTypeId": 1,
"Reason": "sample string 24",
"DoctorMail": "sample string 25",
"Action": "sample string 26",
"RelativeName": "sample string 27",
"PatientRelativeId": 1,
"IsCheckedIn": true,
"PatientCustomIdentifier": "sample string 28",
"ForceSendReminderMessage": true,
"IsVacationCancelled": true,
"IsInsured": true,
"CreatedBy": 29,
"PatientKey": "sample string 30",
"NoShow": true,
"IsHomeVisit": true,
"PatientAddress": "sample string 33",
"CountryIsoCode": "sample string 34",
"PatientCountryCode": "sample string 35",
"ServiceKey": "sample string 36",
"SendCancellationMessage": true,
"PatientCountryIsoCode": "sample string 38",
"LocationKey": "sample string 39",
"ReservationDateChaged": true,
"ProcessedCount": 41,
"PromoCodeKey": "sample string 42",
"Fees": 1.0,
"FeesBeforeOffer": 1.0,
"CallSourceId": 1,
"SurveyId": 43,
"CallReasonId": 1,
"IsOnlinePayment": true,
"CashAtClinic": 45.0,
"LanguageId": 46,
"VoucherKey": "sample string 47",
"BookingTypeId": 48,
"SubBookingTypeKey": "sample string 49",
"EarnSelected": true,
"GlobalBooking": true,
"RegionId": "sample string 52",
"HaveSymptoms": true,
"BrandKey": "sample string 54",
"IsFastPass": true,
"InsuranceCardKey": "sample string 56",
"ProofOfCheckInNo": "sample string 57"
}
application/xml, text/xml
Sample:
<ReservationPayload xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Vezeeta.Reservations.Consumer.Models"> <Action>sample string 26</Action> <ActionMaker>6</ActionMaker> <AlternativeMobilePhone>sample string 22</AlternativeMobilePhone> <AreaId>1</AreaId> <BookingTypeId>48</BookingTypeId> <BrandKey>sample string 54</BrandKey> <CallKey>sample string 9</CallKey> <CallReasonId>1</CallReasonId> <CallSourceId>1</CallSourceId> <CallerPhone>sample string 19</CallerPhone> <CashAtClinic>45</CashAtClinic> <CloseReasonId>1</CloseReasonId> <CountryIsoCode>sample string 34</CountryIsoCode> <CreatedBy>29</CreatedBy> <CreatedOn>2025-12-06T06:41:27.1869498+02:00</CreatedOn> <DoctorMail>sample string 25</DoctorMail> <Duration>1</Duration> <EarnSelected>true</EarnSelected> <ExaminationRoomKey>sample string 8</ExaminationRoomKey> <Fees>1</Fees> <FeesBeforeOffer>1</FeesBeforeOffer> <FollowUpNumber>sample string 20</FollowUpNumber> <ForceSendReminderMessage>true</ForceSendReminderMessage> <GlobalBooking>true</GlobalBooking> <HaveSymptoms>true</HaveSymptoms> <InsuranceCardKey>sample string 56</InsuranceCardKey> <InsuranceKey>sample string 10</InsuranceKey> <IsCheckedIn>true</IsCheckedIn> <IsFastPass>true</IsFastPass> <IsHomeVisit>true</IsHomeVisit> <IsInsured>true</IsInsured> <IsOnlinePayment>true</IsOnlinePayment> <IsVacationCancelled>true</IsVacationCancelled> <LandLine>sample string 23</LandLine> <LanguageId>46</LanguageId> <LocationKey>sample string 39</LocationKey> <ModifierName>sample string 14</ModifierName> <NoShow>true</NoShow> <Notes>sample string 18</Notes> <OldReservationKey>sample string 17</OldReservationKey> <PatientAddress>sample string 33</PatientAddress> <PatientBirthDate>2025-12-06T06:41:27.1869498+02:00</PatientBirthDate> <PatientBundleKey>sample string 1</PatientBundleKey> <PatientCountryCode>sample string 35</PatientCountryCode> <PatientCountryIsoCode>sample string 38</PatientCountryIsoCode> <PatientCustomIdentifier>sample string 28</PatientCustomIdentifier> <PatientGender>true</PatientGender> <PatientKey>sample string 30</PatientKey> <PatientMail>sample string 13</PatientMail> <PatientName>sample string 11</PatientName> <PatientPhone>sample string 12</PatientPhone> <PatientRelativeId>1</PatientRelativeId> <PaymentMethod>1</PaymentMethod> <PendingReservation>true</PendingReservation> <ProcessedCount>41</ProcessedCount> <PromoCodeKey>sample string 42</PromoCodeKey> <ProofOfCheckInNo>sample string 57</ProofOfCheckInNo> <Reason>sample string 24</Reason> <RegionId>sample string 52</RegionId> <RelativeName>sample string 27</RelativeName> <RequiresConfirmation>true</RequiresConfirmation> <ReservationDate>2025-12-06T06:41:27.1869498+02:00</ReservationDate> <ReservationDateChaged>true</ReservationDateChaged> <ReservationKey>sample string 15</ReservationKey> <ReservationNumber>sample string 21</ReservationNumber> <SecondReservationDate>2025-12-06T06:41:27.1869498+02:00</SecondReservationDate> <SendCancellationMessage>true</SendCancellationMessage> <ServiceKey>sample string 36</ServiceKey> <Source>5</Source> <SubBookingTypeKey>sample string 49</SubBookingTypeKey> <SurveyId>43</SurveyId> <SurveyInstanceKey>sample string 16</SurveyInstanceKey> <TakafulCardKey>sample string 3</TakafulCardKey> <ThirdReservationDate>2025-12-06T06:41:27.1869498+02:00</ThirdReservationDate> <TimeZone>2</TimeZone> <Type>4</Type> <UpdateReservationStatus>7</UpdateReservationStatus> <UserId>1</UserId> <VisitTypeId>1</VisitTypeId> <VoucherKey>sample string 47</VoucherKey> </ReservationPayload>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |