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": "f53486b1-191c-4f25-baf0-bc6f6f272936",
"AppointmentRequestId": "2facf46e-444d-4ce8-8686-eaa0f02ba8fd",
"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": "129aa710-2129-4b1a-8194-7d6beaf2d2d5",
"CountryId": "6e3d2dd4-79e2-4296-aacf-2f17fd496411",
"AppointmentId": "c304036f-8483-44b6-bfcf-baee4e032b6c",
"DoctorId": "e5704d1e-6030-4d24-a4e3-a84a76886c32",
"LocationId": "6b9f1c6a-9207-4286-a6ee-8858a4ed4752",
"DateRangeFrom": "2021-06-21T02:40:14.9203157-04:00",
"DateRangeTo": "2021-06-21T02:40:14.9203157-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": "2021-06-21T02:40:14.9203157-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>c304036f-8483-44b6-bfcf-baee4e032b6c</AppointmentId> <AppointmentRequestId>2facf46e-444d-4ce8-8686-eaa0f02ba8fd</AppointmentRequestId> <AppointmentRequestReasonId>129aa710-2129-4b1a-8194-7d6beaf2d2d5</AppointmentRequestReasonId> <City>sample string 28</City> <ContactPrefixId>20</ContactPrefixId> <ContactSuffixId>24</ContactSuffixId> <CountryId>6e3d2dd4-79e2-4296-aacf-2f17fd496411</CountryId> <DateOfBirth>2021-06-21T02:40:14.9203157-04:00</DateOfBirth> <DateRangeFrom>2021-06-21T02:40:14.9203157-04:00</DateRangeFrom> <DateRangeTo>2021-06-21T02:40:14.9203157-04:00</DateRangeTo> <DoctorId>e5704d1e-6030-4d24-a4e3-a84a76886c32</DoctorId> <FirstName>sample string 21</FirstName> <FridaySelected>true</FridaySelected> <LastName>sample string 22</LastName> <LocationId>6b9f1c6a-9207-4286-a6ee-8858a4ed4752</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>f53486b1-191c-4f25-baf0-bc6f6f272936</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": "8713656c-e5ff-4d40-a93d-5b4423294239",
"AppointmentRequestId": "e61e740e-1601-4401-9798-93566ebb4c41",
"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": "3c56d4d6-f8ab-43de-86ca-3898850fd029",
"CountryId": "cec00a36-8428-4e10-aa27-68f5bba31bc9",
"AppointmentId": "5ac1fc1b-cc1f-4380-87bc-ed8e05397582",
"DoctorId": "3ed34546-faa6-420f-9463-2d6c6d966d30",
"LocationId": "a71f0571-d9f5-41fb-880f-d6a83bac6997",
"DateRangeFrom": "2021-06-21T02:40:14.9515603-04:00",
"DateRangeTo": "2021-06-21T02:40:14.9515603-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": "2021-06-21T02:40:14.9515603-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>5ac1fc1b-cc1f-4380-87bc-ed8e05397582</AppointmentId> <AppointmentRequestId>e61e740e-1601-4401-9798-93566ebb4c41</AppointmentRequestId> <AppointmentRequestReasonId>3c56d4d6-f8ab-43de-86ca-3898850fd029</AppointmentRequestReasonId> <City>sample string 28</City> <ContactPrefixId>20</ContactPrefixId> <ContactSuffixId>24</ContactSuffixId> <CountryId>cec00a36-8428-4e10-aa27-68f5bba31bc9</CountryId> <DateOfBirth>2021-06-21T02:40:14.9515603-04:00</DateOfBirth> <DateRangeFrom>2021-06-21T02:40:14.9515603-04:00</DateRangeFrom> <DateRangeTo>2021-06-21T02:40:14.9515603-04:00</DateRangeTo> <DoctorId>3ed34546-faa6-420f-9463-2d6c6d966d30</DoctorId> <FirstName>sample string 21</FirstName> <FridaySelected>true</FridaySelected> <LastName>sample string 22</LastName> <LocationId>a71f0571-d9f5-41fb-880f-d6a83bac6997</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>8713656c-e5ff-4d40-a93d-5b4423294239</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>