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.

AppointmentRequestModel
NameDescriptionTypeAdditional 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

Sample: 
{
  "AccountNumber": "sample string 1",
  "AppointmentRequestId": "596193c4-30b8-45e8-9d4a-b7dfd24df956",
  "AppointmentId": "82829079-a611-446b-a274-328fbea0e7ac",
  "PatientId": "b8655cd3-6cc1-45b6-9b9e-b2c589c92441",
  "LocationId": "10ed06e0-9973-401c-a89d-1f607606eb2d",
  "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": "7fa22090-1ee3-4584-957b-4bd6c581e300",
  "Comments": "sample string 12",
  "RequestedDate": "2025-04-02T16:02:11.1362231-04:00",
  "PatientEmailAddress": "sample string 14",
  "PhoneNumberIsMobile": true,
  "PhoneNumber": "sample string 16",
  "CountryId": "0dff44fb-91fb-4780-907c-87e88e50e3b4",
  "AppointmentRequestReasonId": "b66ec7b6-425d-4971-a8e5-9d940a1f3709",
  "AnotherPerson": true,
  "FirstName": "sample string 19",
  "MiddleName": "sample string 20",
  "LastName": "sample string 21",
  "DateOfBirth": "2025-04-02T16:02:11.1362231-04:00",
  "PatientSexId": 1,
  "Username": "sample string 23",
  "Password": "sample string 24",
  "TermsOfUseAccepted": true
}

application/xml, text/xml

Sample: 
<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>82829079-a611-446b-a274-328fbea0e7ac</AppointmentId>
  <AppointmentRequestId>596193c4-30b8-45e8-9d4a-b7dfd24df956</AppointmentRequestId>
  <AppointmentRequestReasonId>b66ec7b6-425d-4971-a8e5-9d940a1f3709</AppointmentRequestReasonId>
  <Comments>sample string 12</Comments>
  <CountryId>0dff44fb-91fb-4780-907c-87e88e50e3b4</CountryId>
  <DateOfBirth>2025-04-02T16:02:11.1362231-04:00</DateOfBirth>
  <DoctorId>7fa22090-1ee3-4584-957b-4bd6c581e300</DoctorId>
  <FirstName>sample string 19</FirstName>
  <HasEyeExamAtThisLocation>true</HasEyeExamAtThisLocation>
  <LastName>sample string 21</LastName>
  <LocationId>10ed06e0-9973-401c-a89d-1f607606eb2d</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>b8655cd3-6cc1-45b6-9b9e-b2c589c92441</PatientId>
  <PatientSexId>1</PatientSexId>
  <PhoneNumber>sample string 16</PhoneNumber>
  <PhoneNumberIsMobile>true</PhoneNumberIsMobile>
  <RequestedDate>2025-04-02T16:02:11.1362231-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:

Sample not available.

Response Information

Resource Description

AppointmentRequestModel
NameDescriptionTypeAdditional 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

Sample: 
{
  "AccountNumber": "sample string 1",
  "AppointmentRequestId": "6469a75c-3d3c-468e-8cc2-a756589d711e",
  "AppointmentId": "fa635d1b-b832-41c1-b887-b5e707578a93",
  "PatientId": "9b28e914-e2f3-43d1-9491-b1317717e27b",
  "LocationId": "23fa1bde-b370-44b1-b072-c19761e2f786",
  "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": "2a822ed1-8e19-4a71-b625-d8647556a5f3",
  "Comments": "sample string 12",
  "RequestedDate": "2025-04-02T16:02:11.1518395-04:00",
  "PatientEmailAddress": "sample string 14",
  "PhoneNumberIsMobile": true,
  "PhoneNumber": "sample string 16",
  "CountryId": "76d32eda-239e-492c-be3a-25126f4283d8",
  "AppointmentRequestReasonId": "c528eb11-244b-4003-bfa1-e69d226be41c",
  "AnotherPerson": true,
  "FirstName": "sample string 19",
  "MiddleName": "sample string 20",
  "LastName": "sample string 21",
  "DateOfBirth": "2025-04-02T16:02:11.1518395-04:00",
  "PatientSexId": 1,
  "Username": "sample string 23",
  "Password": "sample string 24",
  "TermsOfUseAccepted": true
}

application/xml, text/xml

Sample: 
<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>fa635d1b-b832-41c1-b887-b5e707578a93</AppointmentId>
  <AppointmentRequestId>6469a75c-3d3c-468e-8cc2-a756589d711e</AppointmentRequestId>
  <AppointmentRequestReasonId>c528eb11-244b-4003-bfa1-e69d226be41c</AppointmentRequestReasonId>
  <Comments>sample string 12</Comments>
  <CountryId>76d32eda-239e-492c-be3a-25126f4283d8</CountryId>
  <DateOfBirth>2025-04-02T16:02:11.1518395-04:00</DateOfBirth>
  <DoctorId>2a822ed1-8e19-4a71-b625-d8647556a5f3</DoctorId>
  <FirstName>sample string 19</FirstName>
  <HasEyeExamAtThisLocation>true</HasEyeExamAtThisLocation>
  <LastName>sample string 21</LastName>
  <LocationId>23fa1bde-b370-44b1-b072-c19761e2f786</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>9b28e914-e2f3-43d1-9491-b1317717e27b</PatientId>
  <PatientSexId>1</PatientSexId>
  <PhoneNumber>sample string 16</PhoneNumber>
  <PhoneNumberIsMobile>true</PhoneNumberIsMobile>
  <RequestedDate>2025-04-02T16:02:11.1518395-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>