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.
AppointmentRequestLimitedModelName | 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": "b36def1e-f4f9-45b6-abd0-f19b70f3de80", "AppointmentRequestId": "0c212ed8-d23a-4ae7-873e-4b0afb46a426", "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": "d7246c90-789f-472c-89e8-f3ace4161c34", "CountryId": "ad03ee1f-7e2a-4963-9042-0f6697ad85ec", "AppointmentId": "4519bd14-7f1d-4c9f-a5b5-d46d918e01bf", "DoctorId": "f79dcd07-379b-447e-ad47-314a813c4852", "LocationId": "0513c335-0b9c-4cc6-b0d5-c2ee4f977f32", "DateRangeFrom": "2025-09-18T14:58:56.3163675-04:00", "DateRangeTo": "2025-09-18T14:58:56.3163675-04: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": "2025-09-18T14:58:56.3163675-04: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>4519bd14-7f1d-4c9f-a5b5-d46d918e01bf</AppointmentId> <AppointmentRequestId>0c212ed8-d23a-4ae7-873e-4b0afb46a426</AppointmentRequestId> <AppointmentRequestReasonId>d7246c90-789f-472c-89e8-f3ace4161c34</AppointmentRequestReasonId> <City>sample string 28</City> <ContactPrefixId>20</ContactPrefixId> <ContactSuffixId>24</ContactSuffixId> <CountryId>ad03ee1f-7e2a-4963-9042-0f6697ad85ec</CountryId> <DateOfBirth>2025-09-18T14:58:56.3163675-04:00</DateOfBirth> <DateRangeFrom>2025-09-18T14:58:56.3163675-04:00</DateRangeFrom> <DateRangeTo>2025-09-18T14:58:56.3163675-04:00</DateRangeTo> <DoctorId>f79dcd07-379b-447e-ad47-314a813c4852</DoctorId> <FirstName>sample string 21</FirstName> <FridaySelected>true</FridaySelected> <LastName>sample string 22</LastName> <LocationId>0513c335-0b9c-4cc6-b0d5-c2ee4f977f32</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>b36def1e-f4f9-45b6-abd0-f19b70f3de80</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
AppointmentRequestLimitedModelName | 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": "cfa1e168-d987-4ff7-bbfc-d0d6a2610525", "AppointmentRequestId": "c9f317fd-347d-41d6-953c-2d553dbc1fd2", "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": "2e4ff919-dcf7-44a5-954a-fe0988bd0904", "CountryId": "c1572ba9-4f35-4361-b257-2992f8d42375", "AppointmentId": "7bd31012-954d-4bc9-8d33-336f6a8f3b09", "DoctorId": "6489834c-d6ba-4c0e-af25-f7d4b9565906", "LocationId": "447cef38-1c9a-4512-8336-fe6a8f907314", "DateRangeFrom": "2025-09-18T14:58:56.3632409-04:00", "DateRangeTo": "2025-09-18T14:58:56.3632409-04: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": "2025-09-18T14:58:56.3632409-04: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>7bd31012-954d-4bc9-8d33-336f6a8f3b09</AppointmentId> <AppointmentRequestId>c9f317fd-347d-41d6-953c-2d553dbc1fd2</AppointmentRequestId> <AppointmentRequestReasonId>2e4ff919-dcf7-44a5-954a-fe0988bd0904</AppointmentRequestReasonId> <City>sample string 28</City> <ContactPrefixId>20</ContactPrefixId> <ContactSuffixId>24</ContactSuffixId> <CountryId>c1572ba9-4f35-4361-b257-2992f8d42375</CountryId> <DateOfBirth>2025-09-18T14:58:56.3632409-04:00</DateOfBirth> <DateRangeFrom>2025-09-18T14:58:56.3632409-04:00</DateRangeFrom> <DateRangeTo>2025-09-18T14:58:56.3632409-04:00</DateRangeTo> <DoctorId>6489834c-d6ba-4c0e-af25-f7d4b9565906</DoctorId> <FirstName>sample string 21</FirstName> <FridaySelected>true</FridaySelected> <LastName>sample string 22</LastName> <LocationId>447cef38-1c9a-4512-8336-fe6a8f907314</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>cfa1e168-d987-4ff7-bbfc-d0d6a2610525</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>