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.

Name	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

Sample:

{
  "AccountNumber": "sample string 1",
  "AppointmentRequestId": "6132fab6-8ac2-4d4e-86fd-a722b33933c5",
  "AppointmentId": "3b8bae90-2dac-4c11-b6cc-91b8109f2368",
  "PatientId": "9c2ff2bf-1eb6-4521-af7d-971df2901349",
  "LocationId": "f9085a15-6704-49e1-92c6-acff759cac09",
  "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": "bf63e80e-f515-419d-b6db-ff0ed96e4a3f",
  "Comments": "sample string 12",
  "RequestedDate": "2021-03-05T09:22:42.8596415-05:00",
  "PatientEmailAddress": "sample string 14",
  "PhoneNumberIsMobile": true,
  "PhoneNumber": "sample string 16",
  "CountryId": "bf2905ee-3976-4bd0-a2c8-68bb258f907e",
  "AppointmentRequestReasonId": "1b125d6f-5898-45d6-ba43-8a8f41cef958",
  "AnotherPerson": true,
  "FirstName": "sample string 19",
  "MiddleName": "sample string 20",
  "LastName": "sample string 21",
  "DateOfBirth": "2021-03-05T09:22:42.8596415-05: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>3b8bae90-2dac-4c11-b6cc-91b8109f2368</AppointmentId>
  <AppointmentRequestId>6132fab6-8ac2-4d4e-86fd-a722b33933c5</AppointmentRequestId>
  <AppointmentRequestReasonId>1b125d6f-5898-45d6-ba43-8a8f41cef958</AppointmentRequestReasonId>
  <Comments>sample string 12</Comments>
  <CountryId>bf2905ee-3976-4bd0-a2c8-68bb258f907e</CountryId>
  <DateOfBirth>2021-03-05T09:22:42.8596415-05:00</DateOfBirth>
  <DoctorId>bf63e80e-f515-419d-b6db-ff0ed96e4a3f</DoctorId>
  <FirstName>sample string 19</FirstName>
  <HasEyeExamAtThisLocation>true</HasEyeExamAtThisLocation>
  <LastName>sample string 21</LastName>
  <LocationId>f9085a15-6704-49e1-92c6-acff759cac09</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>9c2ff2bf-1eb6-4521-af7d-971df2901349</PatientId>
  <PatientSexId>1</PatientSexId>
  <PhoneNumber>sample string 16</PhoneNumber>
  <PhoneNumberIsMobile>true</PhoneNumberIsMobile>
  <RequestedDate>2021-03-05T09:22:42.8596415-05: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

Name	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

Sample:

{
  "AccountNumber": "sample string 1",
  "AppointmentRequestId": "edc48be0-238a-4ccf-a255-878a42a8b7f3",
  "AppointmentId": "71cc2241-9a6d-4532-9adf-ce87d3b91ed6",
  "PatientId": "dc649732-e17a-4117-872b-e30c5fd3739b",
  "LocationId": "0a073aaa-7b0c-4d2f-8574-de535c094041",
  "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": "1cb72d65-f182-41eb-874e-ed909e9a3af9",
  "Comments": "sample string 12",
  "RequestedDate": "2021-03-05T09:22:42.8908635-05:00",
  "PatientEmailAddress": "sample string 14",
  "PhoneNumberIsMobile": true,
  "PhoneNumber": "sample string 16",
  "CountryId": "70b68b58-c173-4694-b194-110f7f9b05e9",
  "AppointmentRequestReasonId": "3ac8e9f7-82f2-4df0-9582-9bd2329e7312",
  "AnotherPerson": true,
  "FirstName": "sample string 19",
  "MiddleName": "sample string 20",
  "LastName": "sample string 21",
  "DateOfBirth": "2021-03-05T09:22:42.8908635-05: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>71cc2241-9a6d-4532-9adf-ce87d3b91ed6</AppointmentId>
  <AppointmentRequestId>edc48be0-238a-4ccf-a255-878a42a8b7f3</AppointmentRequestId>
  <AppointmentRequestReasonId>3ac8e9f7-82f2-4df0-9582-9bd2329e7312</AppointmentRequestReasonId>
  <Comments>sample string 12</Comments>
  <CountryId>70b68b58-c173-4694-b194-110f7f9b05e9</CountryId>
  <DateOfBirth>2021-03-05T09:22:42.8908635-05:00</DateOfBirth>
  <DoctorId>1cb72d65-f182-41eb-874e-ed909e9a3af9</DoctorId>
  <FirstName>sample string 19</FirstName>
  <HasEyeExamAtThisLocation>true</HasEyeExamAtThisLocation>
  <LastName>sample string 21</LastName>
  <LocationId>0a073aaa-7b0c-4d2f-8574-de535c094041</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>dc649732-e17a-4117-872b-e30c5fd3739b</PatientId>
  <PatientSexId>1</PatientSexId>
  <PhoneNumber>sample string 16</PhoneNumber>
  <PhoneNumberIsMobile>true</PhoneNumberIsMobile>
  <RequestedDate>2021-03-05T09:22:42.8908635-05: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>