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": "d5ba4a98-51fe-47b1-8976-1144f43eb003",
"AppointmentRequestId": "08557e52-7231-42d0-ab92-133844b0f251",
"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": "72eb263d-885a-4872-82ec-47d399e4085b",
"CountryId": "f39c9da3-83ae-457d-b5f2-591ab4f46bbf",
"AppointmentId": "21b58130-b0e4-4dcd-8fbf-9c038ded2234",
"DoctorId": "52e58e61-4223-4b3a-8ec2-87b228f16514",
"LocationId": "8801b373-edb3-4252-8485-4592aa993626",
"DateRangeFrom": "2026-10-29T10:37:44.1833118+00:00",
"DateRangeTo": "2026-10-29T10:37:44.1833118+00: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": "2026-10-29T10:37:44.1833118+00: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>21b58130-b0e4-4dcd-8fbf-9c038ded2234</AppointmentId> <AppointmentRequestId>08557e52-7231-42d0-ab92-133844b0f251</AppointmentRequestId> <AppointmentRequestReasonId>72eb263d-885a-4872-82ec-47d399e4085b</AppointmentRequestReasonId> <City>sample string 28</City> <ContactPrefixId>20</ContactPrefixId> <ContactSuffixId>24</ContactSuffixId> <CountryId>f39c9da3-83ae-457d-b5f2-591ab4f46bbf</CountryId> <DateOfBirth>2026-10-29T10:37:44.1833118+00:00</DateOfBirth> <DateRangeFrom>2026-10-29T10:37:44.1833118+00:00</DateRangeFrom> <DateRangeTo>2026-10-29T10:37:44.1833118+00:00</DateRangeTo> <DoctorId>52e58e61-4223-4b3a-8ec2-87b228f16514</DoctorId> <FirstName>sample string 21</FirstName> <FridaySelected>true</FridaySelected> <LastName>sample string 22</LastName> <LocationId>8801b373-edb3-4252-8485-4592aa993626</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>d5ba4a98-51fe-47b1-8976-1144f43eb003</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": "75be7803-0228-4843-8e52-03ae7f8ba38f",
"AppointmentRequestId": "335acbe1-6315-40eb-928d-62c4ebb472f0",
"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": "64666705-8e05-4b08-9fec-12e951886a9e",
"CountryId": "fcc11c98-a2f2-40e1-85d1-24a74f7caab6",
"AppointmentId": "a8436447-e4a3-4bf3-b785-08e02bd7580e",
"DoctorId": "25054404-4d25-4876-ac87-ee60f2d7994d",
"LocationId": "11fed207-fd9d-4481-9592-d4644910c038",
"DateRangeFrom": "2026-10-29T10:37:44.2062307+00:00",
"DateRangeTo": "2026-10-29T10:37:44.2062307+00: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": "2026-10-29T10:37:44.2062307+00: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>a8436447-e4a3-4bf3-b785-08e02bd7580e</AppointmentId> <AppointmentRequestId>335acbe1-6315-40eb-928d-62c4ebb472f0</AppointmentRequestId> <AppointmentRequestReasonId>64666705-8e05-4b08-9fec-12e951886a9e</AppointmentRequestReasonId> <City>sample string 28</City> <ContactPrefixId>20</ContactPrefixId> <ContactSuffixId>24</ContactSuffixId> <CountryId>fcc11c98-a2f2-40e1-85d1-24a74f7caab6</CountryId> <DateOfBirth>2026-10-29T10:37:44.2062307+00:00</DateOfBirth> <DateRangeFrom>2026-10-29T10:37:44.2062307+00:00</DateRangeFrom> <DateRangeTo>2026-10-29T10:37:44.2062307+00:00</DateRangeTo> <DoctorId>25054404-4d25-4876-ac87-ee60f2d7994d</DoctorId> <FirstName>sample string 21</FirstName> <FridaySelected>true</FridaySelected> <LastName>sample string 22</LastName> <LocationId>11fed207-fd9d-4481-9592-d4644910c038</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>75be7803-0228-4843-8e52-03ae7f8ba38f</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>