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": "d7ef6789-1916-4403-b197-a60bb92736e1", "AppointmentId": "352d8a3b-4f86-4317-93e1-f4c963017c8a", "PatientId": "926c0328-e740-4a4b-8735-8b806358d17e", "LocationId": "f4fcefe8-56d5-490f-b56e-922ba618d79d", "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": "34a5d2d7-ce5d-45d3-bf7e-23d840c78a6f", "Comments": "sample string 12", "RequestedDate": "2025-07-01T04:53:39.278912-04:00", "PatientEmailAddress": "sample string 14", "PhoneNumberIsMobile": true, "PhoneNumber": "sample string 16", "CountryId": "52c819f4-5ece-4d23-b6b0-ec4d38bf6b8b", "AppointmentRequestReasonId": "e072b93b-2d8a-4335-8e3c-2537e97a216e", "AnotherPerson": true, "FirstName": "sample string 19", "MiddleName": "sample string 20", "LastName": "sample string 21", "DateOfBirth": "2025-07-01T04:53:39.278912-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>352d8a3b-4f86-4317-93e1-f4c963017c8a</AppointmentId> <AppointmentRequestId>d7ef6789-1916-4403-b197-a60bb92736e1</AppointmentRequestId> <AppointmentRequestReasonId>e072b93b-2d8a-4335-8e3c-2537e97a216e</AppointmentRequestReasonId> <Comments>sample string 12</Comments> <CountryId>52c819f4-5ece-4d23-b6b0-ec4d38bf6b8b</CountryId> <DateOfBirth>2025-07-01T04:53:39.278912-04:00</DateOfBirth> <DoctorId>34a5d2d7-ce5d-45d3-bf7e-23d840c78a6f</DoctorId> <FirstName>sample string 19</FirstName> <HasEyeExamAtThisLocation>true</HasEyeExamAtThisLocation> <LastName>sample string 21</LastName> <LocationId>f4fcefe8-56d5-490f-b56e-922ba618d79d</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>926c0328-e740-4a4b-8735-8b806358d17e</PatientId> <PatientSexId>1</PatientSexId> <PhoneNumber>sample string 16</PhoneNumber> <PhoneNumberIsMobile>true</PhoneNumberIsMobile> <RequestedDate>2025-07-01T04:53:39.278912-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": "f2314295-7ca3-4f1b-bb0e-5f79cbeb067f", "AppointmentId": "9fccf949-0b09-4d2a-ab59-d3f93cb6116c", "PatientId": "3a58b125-d7da-4177-b299-375a3d5d858b", "LocationId": "6cdf4057-d3b1-4383-8b7d-aaf267e7d89a", "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": "88df46a8-a418-4655-a368-9f4633766544", "Comments": "sample string 12", "RequestedDate": "2025-07-01T04:53:39.2945355-04:00", "PatientEmailAddress": "sample string 14", "PhoneNumberIsMobile": true, "PhoneNumber": "sample string 16", "CountryId": "820a9150-18aa-486d-9cef-283081a840fe", "AppointmentRequestReasonId": "e21fea2b-b658-447e-a818-67164c226d8e", "AnotherPerson": true, "FirstName": "sample string 19", "MiddleName": "sample string 20", "LastName": "sample string 21", "DateOfBirth": "2025-07-01T04:53:39.2945355-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>9fccf949-0b09-4d2a-ab59-d3f93cb6116c</AppointmentId> <AppointmentRequestId>f2314295-7ca3-4f1b-bb0e-5f79cbeb067f</AppointmentRequestId> <AppointmentRequestReasonId>e21fea2b-b658-447e-a818-67164c226d8e</AppointmentRequestReasonId> <Comments>sample string 12</Comments> <CountryId>820a9150-18aa-486d-9cef-283081a840fe</CountryId> <DateOfBirth>2025-07-01T04:53:39.2945355-04:00</DateOfBirth> <DoctorId>88df46a8-a418-4655-a368-9f4633766544</DoctorId> <FirstName>sample string 19</FirstName> <HasEyeExamAtThisLocation>true</HasEyeExamAtThisLocation> <LastName>sample string 21</LastName> <LocationId>6cdf4057-d3b1-4383-8b7d-aaf267e7d89a</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>3a58b125-d7da-4177-b299-375a3d5d858b</PatientId> <PatientSexId>1</PatientSexId> <PhoneNumber>sample string 16</PhoneNumber> <PhoneNumberIsMobile>true</PhoneNumberIsMobile> <RequestedDate>2025-07-01T04:53:39.2945355-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>