POST api/AppointmentRequestsLimited
Creates a new appointment request or updates an existent appointment request.
Request Information
URI Parameters
None.
Body Parameters
Model used to retrieve or set information about an appointment.
AppointmentRequestLimitedModel| Name | Description | Type | Additional information |
|---|---|---|---|
| PatientId |
ID of the patient. |
globally unique identifier |
None. |
| AppointmentRequestId |
ID of the appointment request. |
globally unique identifier |
None. |
| VisionInsuranceCarrier |
Vision Insurance Carrier. |
string |
None. |
| VisionGroupNumber |
Vision group number. |
string |
None. |
| VisionPolicyNumber |
Vision policy number. |
string |
None. |
| MedicalInsuranceCarrier |
Medical insurance carrier. |
string |
None. |
| MedicalGroupNumber |
Medical group number. |
string |
None. |
| MedicalPolicyNumber |
Medical policy number. |
string |
None. |
| PatientEmailAddress |
Patient email address |
string |
None. |
| PhoneNumber |
Phone number. |
string |
None. |
| AppointmentRequestReasonId |
Appointment request reason ID. |
globally unique identifier |
None. |
| CountryId |
Country ID. |
globally unique identifier |
None. |
| AppointmentId |
Unique ID od appointment. |
globally unique identifier |
None. |
| DoctorId |
Unique ID of doctor. |
globally unique identifier |
None. |
| LocationId |
Unique ID of location. |
globally unique identifier |
None. |
| DateRangeFrom |
Date range from. |
date |
None. |
| DateRangeTo |
Date range to. |
date |
None. |
| PreferredTime |
Preferred time should be (Any, Morning, Afternoon). |
string |
None. |
| SundaySelected |
Indicates whether the patient selected Sunday or not. |
boolean |
None. |
| MondaySelected |
Indicates whether the patient selected Monday or not. |
boolean |
None. |
| TuesdaySelected |
Indicates whether the patient selected Tuesday or not. |
boolean |
None. |
| WednesdaySelected |
Indicates whether the patient selected Wednesday or not. |
boolean |
None. |
| ThursdaySelected |
Indicates whether the patient selected Thursday or not. |
boolean |
None. |
| FridaySelected |
Indicates whether the patient selected Friday or not. |
boolean |
None. |
| SaturdaySelected |
Indicates whether the patient selected Saturday or not. |
boolean |
None. |
| ContactPrefixId |
ID of contact prefix. |
integer |
None. |
| FirstName |
First name of the patient. |
string |
None. |
| LastName |
Last name of the patient. |
string |
None. |
| MiddleName |
Middle name of the patient. |
string |
None. |
| ContactSuffixId |
ID of contact suffix. |
integer |
None. |
| DateOfBirth |
DateOfBirth of the patient. |
date |
None. |
| Address1 |
Address line1 of the patient. |
string |
None. |
| Address2 |
Address line2 of the patient. |
string |
None. |
| City |
City of the patient. |
string |
None. |
| State |
State of the patient. |
string |
None. |
| Zip |
Zip code of the patient. |
string |
None. |
| PhoneNumberIsMobile |
Indicates whether phone number is mobile or not. |
boolean |
None. |
| Username |
Username of the patient |
string |
None. |
| Password |
Password of the patient |
string |
None. |
| TermsOfUseAccepted |
Indicates if user has accepted the terms of use. |
boolean |
None. |
Request Formats
application/json, text/json
{
"PatientId": "73bb4446-401f-424c-b719-5b2f4ef9557a",
"AppointmentRequestId": "d830c8d8-aca2-45a8-93b3-8ec8dbb12393",
"VisionInsuranceCarrier": "sample string 2",
"VisionGroupNumber": "sample string 3",
"VisionPolicyNumber": "sample string 4",
"MedicalInsuranceCarrier": "sample string 5",
"MedicalGroupNumber": "sample string 6",
"MedicalPolicyNumber": "sample string 7",
"PatientEmailAddress": "sample string 8",
"PhoneNumber": "sample string 9",
"AppointmentRequestReasonId": "2ce58035-4a7a-4cce-a240-8db15e725450",
"CountryId": "64f1f701-ab22-486d-8c7f-24c72cd8a3c8",
"AppointmentId": "0f101d72-1ded-4cb2-a062-a65d3d564eb2",
"DoctorId": "47d2e253-60ac-4dd7-a9ef-a55e75c7865a",
"LocationId": "9f123575-7bda-48a5-933c-eec5da2244c5",
"DateRangeFrom": "2021-03-05T07:56:44.3598562-05:00",
"DateRangeTo": "2021-03-05T07:56:44.3598562-05:00",
"PreferredTime": "sample string 12",
"SundaySelected": true,
"MondaySelected": true,
"TuesdaySelected": true,
"WednesdaySelected": true,
"ThursdaySelected": true,
"FridaySelected": true,
"SaturdaySelected": true,
"ContactPrefixId": 20,
"FirstName": "sample string 21",
"LastName": "sample string 22",
"MiddleName": "sample string 23",
"ContactSuffixId": 24,
"DateOfBirth": "2021-03-05T07:56:44.3598562-05:00",
"Address1": "sample string 26",
"Address2": "sample string 27",
"City": "sample string 28",
"State": "sample string 29",
"Zip": "sample string 30",
"PhoneNumberIsMobile": true,
"Username": "sample string 32",
"Password": "sample string 33",
"TermsOfUseAccepted": true
}
application/xml, text/xml
<AppointmentRequestLimitedModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Mobile.Api.Models.AppointmentRequestsLimited"> <Address1>sample string 26</Address1> <Address2>sample string 27</Address2> <AppointmentId>0f101d72-1ded-4cb2-a062-a65d3d564eb2</AppointmentId> <AppointmentRequestId>d830c8d8-aca2-45a8-93b3-8ec8dbb12393</AppointmentRequestId> <AppointmentRequestReasonId>2ce58035-4a7a-4cce-a240-8db15e725450</AppointmentRequestReasonId> <City>sample string 28</City> <ContactPrefixId>20</ContactPrefixId> <ContactSuffixId>24</ContactSuffixId> <CountryId>64f1f701-ab22-486d-8c7f-24c72cd8a3c8</CountryId> <DateOfBirth>2021-03-05T07:56:44.3598562-05:00</DateOfBirth> <DateRangeFrom>2021-03-05T07:56:44.3598562-05:00</DateRangeFrom> <DateRangeTo>2021-03-05T07:56:44.3598562-05:00</DateRangeTo> <DoctorId>47d2e253-60ac-4dd7-a9ef-a55e75c7865a</DoctorId> <FirstName>sample string 21</FirstName> <FridaySelected>true</FridaySelected> <LastName>sample string 22</LastName> <LocationId>9f123575-7bda-48a5-933c-eec5da2244c5</LocationId> <MedicalGroupNumber>sample string 6</MedicalGroupNumber> <MedicalInsuranceCarrier>sample string 5</MedicalInsuranceCarrier> <MedicalPolicyNumber>sample string 7</MedicalPolicyNumber> <MiddleName>sample string 23</MiddleName> <MondaySelected>true</MondaySelected> <Password>sample string 33</Password> <PatientEmailAddress>sample string 8</PatientEmailAddress> <PatientId>73bb4446-401f-424c-b719-5b2f4ef9557a</PatientId> <PhoneNumber>sample string 9</PhoneNumber> <PhoneNumberIsMobile>true</PhoneNumberIsMobile> <PreferredTime>sample string 12</PreferredTime> <SaturdaySelected>true</SaturdaySelected> <State>sample string 29</State> <SundaySelected>true</SundaySelected> <TermsOfUseAccepted>true</TermsOfUseAccepted> <ThursdaySelected>true</ThursdaySelected> <TuesdaySelected>true</TuesdaySelected> <Username>sample string 32</Username> <VisionGroupNumber>sample string 3</VisionGroupNumber> <VisionInsuranceCarrier>sample string 2</VisionInsuranceCarrier> <VisionPolicyNumber>sample string 4</VisionPolicyNumber> <WednesdaySelected>true</WednesdaySelected> <Zip>sample string 30</Zip> </AppointmentRequestLimitedModel>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
AppointmentRequestLimitedModel| Name | Description | Type | Additional information |
|---|---|---|---|
| PatientId |
ID of the patient. |
globally unique identifier |
None. |
| AppointmentRequestId |
ID of the appointment request. |
globally unique identifier |
None. |
| VisionInsuranceCarrier |
Vision Insurance Carrier. |
string |
None. |
| VisionGroupNumber |
Vision group number. |
string |
None. |
| VisionPolicyNumber |
Vision policy number. |
string |
None. |
| MedicalInsuranceCarrier |
Medical insurance carrier. |
string |
None. |
| MedicalGroupNumber |
Medical group number. |
string |
None. |
| MedicalPolicyNumber |
Medical policy number. |
string |
None. |
| PatientEmailAddress |
Patient email address |
string |
None. |
| PhoneNumber |
Phone number. |
string |
None. |
| AppointmentRequestReasonId |
Appointment request reason ID. |
globally unique identifier |
None. |
| CountryId |
Country ID. |
globally unique identifier |
None. |
| AppointmentId |
Unique ID od appointment. |
globally unique identifier |
None. |
| DoctorId |
Unique ID of doctor. |
globally unique identifier |
None. |
| LocationId |
Unique ID of location. |
globally unique identifier |
None. |
| DateRangeFrom |
Date range from. |
date |
None. |
| DateRangeTo |
Date range to. |
date |
None. |
| PreferredTime |
Preferred time should be (Any, Morning, Afternoon). |
string |
None. |
| SundaySelected |
Indicates whether the patient selected Sunday or not. |
boolean |
None. |
| MondaySelected |
Indicates whether the patient selected Monday or not. |
boolean |
None. |
| TuesdaySelected |
Indicates whether the patient selected Tuesday or not. |
boolean |
None. |
| WednesdaySelected |
Indicates whether the patient selected Wednesday or not. |
boolean |
None. |
| ThursdaySelected |
Indicates whether the patient selected Thursday or not. |
boolean |
None. |
| FridaySelected |
Indicates whether the patient selected Friday or not. |
boolean |
None. |
| SaturdaySelected |
Indicates whether the patient selected Saturday or not. |
boolean |
None. |
| ContactPrefixId |
ID of contact prefix. |
integer |
None. |
| FirstName |
First name of the patient. |
string |
None. |
| LastName |
Last name of the patient. |
string |
None. |
| MiddleName |
Middle name of the patient. |
string |
None. |
| ContactSuffixId |
ID of contact suffix. |
integer |
None. |
| DateOfBirth |
DateOfBirth of the patient. |
date |
None. |
| Address1 |
Address line1 of the patient. |
string |
None. |
| Address2 |
Address line2 of the patient. |
string |
None. |
| City |
City of the patient. |
string |
None. |
| State |
State of the patient. |
string |
None. |
| Zip |
Zip code of the patient. |
string |
None. |
| PhoneNumberIsMobile |
Indicates whether phone number is mobile or not. |
boolean |
None. |
| Username |
Username of the patient |
string |
None. |
| Password |
Password of the patient |
string |
None. |
| TermsOfUseAccepted |
Indicates if user has accepted the terms of use. |
boolean |
None. |
Response Formats
application/json, text/json
{
"PatientId": "dac86619-0ef9-4ef1-b5e5-bfc1b697f73d",
"AppointmentRequestId": "0405baa0-a7ab-4ed9-b44e-6933131b14cb",
"VisionInsuranceCarrier": "sample string 2",
"VisionGroupNumber": "sample string 3",
"VisionPolicyNumber": "sample string 4",
"MedicalInsuranceCarrier": "sample string 5",
"MedicalGroupNumber": "sample string 6",
"MedicalPolicyNumber": "sample string 7",
"PatientEmailAddress": "sample string 8",
"PhoneNumber": "sample string 9",
"AppointmentRequestReasonId": "36096706-e0cf-4eac-a4ed-c9a0ce380651",
"CountryId": "a24ece3e-fc76-496a-908d-308c01878375",
"AppointmentId": "d72a62da-d9a0-4832-9a07-4e9821335c86",
"DoctorId": "dd9f3f33-1f2e-425c-beaa-c51b38e8a59b",
"LocationId": "dec4212a-2559-4234-91d8-73be00514a8a",
"DateRangeFrom": "2021-03-05T07:56:44.391105-05:00",
"DateRangeTo": "2021-03-05T07:56:44.391105-05:00",
"PreferredTime": "sample string 12",
"SundaySelected": true,
"MondaySelected": true,
"TuesdaySelected": true,
"WednesdaySelected": true,
"ThursdaySelected": true,
"FridaySelected": true,
"SaturdaySelected": true,
"ContactPrefixId": 20,
"FirstName": "sample string 21",
"LastName": "sample string 22",
"MiddleName": "sample string 23",
"ContactSuffixId": 24,
"DateOfBirth": "2021-03-05T07:56:44.391105-05:00",
"Address1": "sample string 26",
"Address2": "sample string 27",
"City": "sample string 28",
"State": "sample string 29",
"Zip": "sample string 30",
"PhoneNumberIsMobile": true,
"Username": "sample string 32",
"Password": "sample string 33",
"TermsOfUseAccepted": true
}
application/xml, text/xml
<AppointmentRequestLimitedModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Mobile.Api.Models.AppointmentRequestsLimited"> <Address1>sample string 26</Address1> <Address2>sample string 27</Address2> <AppointmentId>d72a62da-d9a0-4832-9a07-4e9821335c86</AppointmentId> <AppointmentRequestId>0405baa0-a7ab-4ed9-b44e-6933131b14cb</AppointmentRequestId> <AppointmentRequestReasonId>36096706-e0cf-4eac-a4ed-c9a0ce380651</AppointmentRequestReasonId> <City>sample string 28</City> <ContactPrefixId>20</ContactPrefixId> <ContactSuffixId>24</ContactSuffixId> <CountryId>a24ece3e-fc76-496a-908d-308c01878375</CountryId> <DateOfBirth>2021-03-05T07:56:44.391105-05:00</DateOfBirth> <DateRangeFrom>2021-03-05T07:56:44.391105-05:00</DateRangeFrom> <DateRangeTo>2021-03-05T07:56:44.391105-05:00</DateRangeTo> <DoctorId>dd9f3f33-1f2e-425c-beaa-c51b38e8a59b</DoctorId> <FirstName>sample string 21</FirstName> <FridaySelected>true</FridaySelected> <LastName>sample string 22</LastName> <LocationId>dec4212a-2559-4234-91d8-73be00514a8a</LocationId> <MedicalGroupNumber>sample string 6</MedicalGroupNumber> <MedicalInsuranceCarrier>sample string 5</MedicalInsuranceCarrier> <MedicalPolicyNumber>sample string 7</MedicalPolicyNumber> <MiddleName>sample string 23</MiddleName> <MondaySelected>true</MondaySelected> <Password>sample string 33</Password> <PatientEmailAddress>sample string 8</PatientEmailAddress> <PatientId>dac86619-0ef9-4ef1-b5e5-bfc1b697f73d</PatientId> <PhoneNumber>sample string 9</PhoneNumber> <PhoneNumberIsMobile>true</PhoneNumberIsMobile> <PreferredTime>sample string 12</PreferredTime> <SaturdaySelected>true</SaturdaySelected> <State>sample string 29</State> <SundaySelected>true</SundaySelected> <TermsOfUseAccepted>true</TermsOfUseAccepted> <ThursdaySelected>true</ThursdaySelected> <TuesdaySelected>true</TuesdaySelected> <Username>sample string 32</Username> <VisionGroupNumber>sample string 3</VisionGroupNumber> <VisionInsuranceCarrier>sample string 2</VisionInsuranceCarrier> <VisionPolicyNumber>sample string 4</VisionPolicyNumber> <WednesdaySelected>true</WednesdaySelected> <Zip>sample string 30</Zip> </AppointmentRequestLimitedModel>