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": "bfcfa15f-1395-494d-833d-ad9076cc563d", "AppointmentRequestId": "0b206658-d54f-4e9a-a412-cfdb85ddae9f", "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": "bbc56005-8332-4ffa-bacc-79f0ee940d79", "CountryId": "50d3f106-6782-481c-bb3c-ce3cf2747c9e", "AppointmentId": "9f7ca881-c05a-4217-965d-8cfa20bff5f5", "DoctorId": "754bf3ef-10ce-47aa-9f5f-e8962a2ff972", "LocationId": "4c6d8751-6b3b-485a-8128-5837a256ae2e", "DateRangeFrom": "2024-03-28T05:59:45.8056653-04:00", "DateRangeTo": "2024-03-28T05:59:45.8056653-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": "2024-03-28T05:59:45.8056653-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>9f7ca881-c05a-4217-965d-8cfa20bff5f5</AppointmentId> <AppointmentRequestId>0b206658-d54f-4e9a-a412-cfdb85ddae9f</AppointmentRequestId> <AppointmentRequestReasonId>bbc56005-8332-4ffa-bacc-79f0ee940d79</AppointmentRequestReasonId> <City>sample string 28</City> <ContactPrefixId>20</ContactPrefixId> <ContactSuffixId>24</ContactSuffixId> <CountryId>50d3f106-6782-481c-bb3c-ce3cf2747c9e</CountryId> <DateOfBirth>2024-03-28T05:59:45.8056653-04:00</DateOfBirth> <DateRangeFrom>2024-03-28T05:59:45.8056653-04:00</DateRangeFrom> <DateRangeTo>2024-03-28T05:59:45.8056653-04:00</DateRangeTo> <DoctorId>754bf3ef-10ce-47aa-9f5f-e8962a2ff972</DoctorId> <FirstName>sample string 21</FirstName> <FridaySelected>true</FridaySelected> <LastName>sample string 22</LastName> <LocationId>4c6d8751-6b3b-485a-8128-5837a256ae2e</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>bfcfa15f-1395-494d-833d-ad9076cc563d</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": "21d6dd3d-454d-4002-b85d-22f87d23759e", "AppointmentRequestId": "4d44e4cb-302c-4a33-8477-6822ae273d7c", "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": "74b7761b-7eb5-41cf-abb4-369fe2529b1a", "CountryId": "0424162e-e3a0-4a14-a936-4fecd0fdbdf1", "AppointmentId": "e5f0e5bc-32bb-43a3-bd88-8b280a3da2f1", "DoctorId": "5f939ed9-631a-4aea-88b0-511b527d4034", "LocationId": "f736bdaa-1c07-4a3c-b6c9-895d605de840", "DateRangeFrom": "2024-03-28T05:59:45.836928-04:00", "DateRangeTo": "2024-03-28T05:59:45.836928-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": "2024-03-28T05:59:45.836928-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>e5f0e5bc-32bb-43a3-bd88-8b280a3da2f1</AppointmentId> <AppointmentRequestId>4d44e4cb-302c-4a33-8477-6822ae273d7c</AppointmentRequestId> <AppointmentRequestReasonId>74b7761b-7eb5-41cf-abb4-369fe2529b1a</AppointmentRequestReasonId> <City>sample string 28</City> <ContactPrefixId>20</ContactPrefixId> <ContactSuffixId>24</ContactSuffixId> <CountryId>0424162e-e3a0-4a14-a936-4fecd0fdbdf1</CountryId> <DateOfBirth>2024-03-28T05:59:45.836928-04:00</DateOfBirth> <DateRangeFrom>2024-03-28T05:59:45.836928-04:00</DateRangeFrom> <DateRangeTo>2024-03-28T05:59:45.836928-04:00</DateRangeTo> <DoctorId>5f939ed9-631a-4aea-88b0-511b527d4034</DoctorId> <FirstName>sample string 21</FirstName> <FridaySelected>true</FridaySelected> <LastName>sample string 22</LastName> <LocationId>f736bdaa-1c07-4a3c-b6c9-895d605de840</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>21d6dd3d-454d-4002-b85d-22f87d23759e</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>