POST api/AppointmentRequests
Creates a new appointment requests.
Request Information
URI Parameters
None.
Body Parameters
Model used to retrieve or set information about an appointment.
AppointmentRequestModelName | Description | Type | Additional information |
---|---|---|---|
AccountNumber |
URL name of the practice for which the appointment is requested (Required). |
string |
None. |
AppointmentRequestId |
Unique ID of appointment request. |
globally unique identifier |
None. |
AppointmentId |
Unique ID of appointment. |
globally unique identifier |
None. |
PatientId |
Unique ID of patient. |
globally unique identifier |
None. |
LocationId |
Unique ID of location (Required). |
globally unique identifier |
None. |
NewPatient |
Indicates whether new patient or not. |
boolean |
None. |
HasEyeExamAtThisLocation |
Indication if examination is at the given location. |
boolean |
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. |
DoctorId |
Unique ID of doctor. |
globally unique identifier |
None. |
Comments |
Comments for the appointment request. |
string |
None. |
RequestedDate |
Requested Date of the appointment request. |
date |
None. |
PatientEmailAddress |
Email address of patient. |
string |
None. |
PhoneNumberIsMobile |
Indicates if the phone number can be used to receive text messages. |
boolean |
None. |
PhoneNumber |
Phone number of the patient. |
string |
None. |
CountryId |
Unique ID of country. |
globally unique identifier |
None. |
AppointmentRequestReasonId |
Unique ID of appointment request reason (Required). |
globally unique identifier |
None. |
AnotherPerson |
Indicates if the appointment request is being created for another person that is not a relative of the current patient. |
boolean |
None. |
FirstName |
First name of the person (Required). |
string |
None. |
MiddleName |
Middle name of the person. |
string |
None. |
LastName |
Last name of the person (Required). |
string |
None. |
DateOfBirth |
Date of birth of the person (Required). |
date |
None. |
PatientSexId |
Patient's sex ID of the model in the portal. |
integer |
None. |
Username |
If the person requesting the appointment wants to create an account in the portal, send the username in this property. |
string |
None. |
Password |
If the person requesting the appointment wants to create an account in the portal, send the passwod in this property. |
string |
None. |
TermsOfUseAccepted |
Indicates if user has accepted the terms of use. |
boolean |
None. |
Request Formats
application/json, text/json
{ "AccountNumber": "sample string 1", "AppointmentRequestId": "a26fae47-e52b-4b96-8914-b31b7ad13cc4", "AppointmentId": "d6d540e0-858b-4efa-a6de-d0dfb2e022d6", "PatientId": "214255be-9b54-4aa1-bab4-948e0bdb7023", "LocationId": "c5a3138a-26b4-4c58-95b9-1ff78884c392", "NewPatient": true, "HasEyeExamAtThisLocation": true, "VisionInsuranceCarrier": "sample string 6", "VisionGroupNumber": "sample string 7", "VisionPolicyNumber": "sample string 8", "MedicalInsuranceCarrier": "sample string 9", "MedicalGroupNumber": "sample string 10", "MedicalPolicyNumber": "sample string 11", "DoctorId": "de3f1c83-169a-4f3d-824f-41b18e031852", "Comments": "sample string 12", "RequestedDate": "2024-04-20T13:22:10.7801797-04:00", "PatientEmailAddress": "sample string 14", "PhoneNumberIsMobile": true, "PhoneNumber": "sample string 16", "CountryId": "9b6ab6ad-c460-4fd9-8f47-72bb722bc4eb", "AppointmentRequestReasonId": "2df38460-a5b0-437a-aec6-9fba5af6536a", "AnotherPerson": true, "FirstName": "sample string 19", "MiddleName": "sample string 20", "LastName": "sample string 21", "DateOfBirth": "2024-04-20T13:22:10.7801797-04:00", "PatientSexId": 1, "Username": "sample string 23", "Password": "sample string 24", "TermsOfUseAccepted": true }
application/xml, text/xml
<AppointmentRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Mobile.Api.Models.AppointmentRequests"> <AccountNumber>sample string 1</AccountNumber> <AnotherPerson>true</AnotherPerson> <AppointmentId>d6d540e0-858b-4efa-a6de-d0dfb2e022d6</AppointmentId> <AppointmentRequestId>a26fae47-e52b-4b96-8914-b31b7ad13cc4</AppointmentRequestId> <AppointmentRequestReasonId>2df38460-a5b0-437a-aec6-9fba5af6536a</AppointmentRequestReasonId> <Comments>sample string 12</Comments> <CountryId>9b6ab6ad-c460-4fd9-8f47-72bb722bc4eb</CountryId> <DateOfBirth>2024-04-20T13:22:10.7801797-04:00</DateOfBirth> <DoctorId>de3f1c83-169a-4f3d-824f-41b18e031852</DoctorId> <FirstName>sample string 19</FirstName> <HasEyeExamAtThisLocation>true</HasEyeExamAtThisLocation> <LastName>sample string 21</LastName> <LocationId>c5a3138a-26b4-4c58-95b9-1ff78884c392</LocationId> <MedicalGroupNumber>sample string 10</MedicalGroupNumber> <MedicalInsuranceCarrier>sample string 9</MedicalInsuranceCarrier> <MedicalPolicyNumber>sample string 11</MedicalPolicyNumber> <MiddleName>sample string 20</MiddleName> <NewPatient>true</NewPatient> <Password>sample string 24</Password> <PatientEmailAddress>sample string 14</PatientEmailAddress> <PatientId>214255be-9b54-4aa1-bab4-948e0bdb7023</PatientId> <PatientSexId>1</PatientSexId> <PhoneNumber>sample string 16</PhoneNumber> <PhoneNumberIsMobile>true</PhoneNumberIsMobile> <RequestedDate>2024-04-20T13:22:10.7801797-04:00</RequestedDate> <TermsOfUseAccepted>true</TermsOfUseAccepted> <Username>sample string 23</Username> <VisionGroupNumber>sample string 7</VisionGroupNumber> <VisionInsuranceCarrier>sample string 6</VisionInsuranceCarrier> <VisionPolicyNumber>sample string 8</VisionPolicyNumber> </AppointmentRequestModel>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
AppointmentRequestModelName | Description | Type | Additional information |
---|---|---|---|
AccountNumber |
URL name of the practice for which the appointment is requested (Required). |
string |
None. |
AppointmentRequestId |
Unique ID of appointment request. |
globally unique identifier |
None. |
AppointmentId |
Unique ID of appointment. |
globally unique identifier |
None. |
PatientId |
Unique ID of patient. |
globally unique identifier |
None. |
LocationId |
Unique ID of location (Required). |
globally unique identifier |
None. |
NewPatient |
Indicates whether new patient or not. |
boolean |
None. |
HasEyeExamAtThisLocation |
Indication if examination is at the given location. |
boolean |
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. |
DoctorId |
Unique ID of doctor. |
globally unique identifier |
None. |
Comments |
Comments for the appointment request. |
string |
None. |
RequestedDate |
Requested Date of the appointment request. |
date |
None. |
PatientEmailAddress |
Email address of patient. |
string |
None. |
PhoneNumberIsMobile |
Indicates if the phone number can be used to receive text messages. |
boolean |
None. |
PhoneNumber |
Phone number of the patient. |
string |
None. |
CountryId |
Unique ID of country. |
globally unique identifier |
None. |
AppointmentRequestReasonId |
Unique ID of appointment request reason (Required). |
globally unique identifier |
None. |
AnotherPerson |
Indicates if the appointment request is being created for another person that is not a relative of the current patient. |
boolean |
None. |
FirstName |
First name of the person (Required). |
string |
None. |
MiddleName |
Middle name of the person. |
string |
None. |
LastName |
Last name of the person (Required). |
string |
None. |
DateOfBirth |
Date of birth of the person (Required). |
date |
None. |
PatientSexId |
Patient's sex ID of the model in the portal. |
integer |
None. |
Username |
If the person requesting the appointment wants to create an account in the portal, send the username in this property. |
string |
None. |
Password |
If the person requesting the appointment wants to create an account in the portal, send the passwod in this property. |
string |
None. |
TermsOfUseAccepted |
Indicates if user has accepted the terms of use. |
boolean |
None. |
Response Formats
application/json, text/json
{ "AccountNumber": "sample string 1", "AppointmentRequestId": "e5f2e17c-02a7-46c5-be2d-538e48a06fe4", "AppointmentId": "e58b7f7b-2a92-479f-bd90-d4c1d112599a", "PatientId": "7e743312-83fb-4a7c-aeac-1744b22f49f4", "LocationId": "f8479172-c936-49cd-9c20-f03eba8d57dd", "NewPatient": true, "HasEyeExamAtThisLocation": true, "VisionInsuranceCarrier": "sample string 6", "VisionGroupNumber": "sample string 7", "VisionPolicyNumber": "sample string 8", "MedicalInsuranceCarrier": "sample string 9", "MedicalGroupNumber": "sample string 10", "MedicalPolicyNumber": "sample string 11", "DoctorId": "7546fd8d-9a3c-4208-8e15-a45457d22c41", "Comments": "sample string 12", "RequestedDate": "2024-04-20T13:22:10.7958255-04:00", "PatientEmailAddress": "sample string 14", "PhoneNumberIsMobile": true, "PhoneNumber": "sample string 16", "CountryId": "f8ed091e-d48c-4660-990d-181af2fd3077", "AppointmentRequestReasonId": "ba3503a0-d3b8-4bae-83f3-bee2a22acf17", "AnotherPerson": true, "FirstName": "sample string 19", "MiddleName": "sample string 20", "LastName": "sample string 21", "DateOfBirth": "2024-04-20T13:22:10.7958255-04:00", "PatientSexId": 1, "Username": "sample string 23", "Password": "sample string 24", "TermsOfUseAccepted": true }
application/xml, text/xml
<AppointmentRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Mobile.Api.Models.AppointmentRequests"> <AccountNumber>sample string 1</AccountNumber> <AnotherPerson>true</AnotherPerson> <AppointmentId>e58b7f7b-2a92-479f-bd90-d4c1d112599a</AppointmentId> <AppointmentRequestId>e5f2e17c-02a7-46c5-be2d-538e48a06fe4</AppointmentRequestId> <AppointmentRequestReasonId>ba3503a0-d3b8-4bae-83f3-bee2a22acf17</AppointmentRequestReasonId> <Comments>sample string 12</Comments> <CountryId>f8ed091e-d48c-4660-990d-181af2fd3077</CountryId> <DateOfBirth>2024-04-20T13:22:10.7958255-04:00</DateOfBirth> <DoctorId>7546fd8d-9a3c-4208-8e15-a45457d22c41</DoctorId> <FirstName>sample string 19</FirstName> <HasEyeExamAtThisLocation>true</HasEyeExamAtThisLocation> <LastName>sample string 21</LastName> <LocationId>f8479172-c936-49cd-9c20-f03eba8d57dd</LocationId> <MedicalGroupNumber>sample string 10</MedicalGroupNumber> <MedicalInsuranceCarrier>sample string 9</MedicalInsuranceCarrier> <MedicalPolicyNumber>sample string 11</MedicalPolicyNumber> <MiddleName>sample string 20</MiddleName> <NewPatient>true</NewPatient> <Password>sample string 24</Password> <PatientEmailAddress>sample string 14</PatientEmailAddress> <PatientId>7e743312-83fb-4a7c-aeac-1744b22f49f4</PatientId> <PatientSexId>1</PatientSexId> <PhoneNumber>sample string 16</PhoneNumber> <PhoneNumberIsMobile>true</PhoneNumberIsMobile> <RequestedDate>2024-04-20T13:22:10.7958255-04:00</RequestedDate> <TermsOfUseAccepted>true</TermsOfUseAccepted> <Username>sample string 23</Username> <VisionGroupNumber>sample string 7</VisionGroupNumber> <VisionInsuranceCarrier>sample string 6</VisionInsuranceCarrier> <VisionPolicyNumber>sample string 8</VisionPolicyNumber> </AppointmentRequestModel>