POST api/appointments

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ApptSlotId	string	None.
DisplayName	string	None.
IdentityType	string	None.
NRIC	string	None.
AllergicRecord	string	None.
PhoneNumber	string	None.
Remark	string	None.
DOB	date	None.
Age	integer	None.
Gender	string	None.
ImPatient	boolean	None.
Relationship	string	None.
SubAspnetuserId	string	None.
RelationshipId	integer	None.
Address	string	None.
Address2	string	None.
IsCalledByPractitioner	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "ApptSlotId": "sample string 1",
  "DisplayName": "sample string 2",
  "IdentityType": "sample string 3",
  "NRIC": "sample string 4",
  "AllergicRecord": "sample string 5",
  "PhoneNumber": "sample string 6",
  "Remark": "sample string 7",
  "DOB": "2025-04-04T13:17:06.5155537+08:00",
  "Age": 8,
  "Gender": "sample string 9",
  "ImPatient": true,
  "Relationship": "sample string 11",
  "SubAspnetuserId": "sample string 12",
  "RelationshipId": 1,
  "Address": "sample string 13",
  "Address2": "sample string 14",
  "IsCalledByPractitioner": true
}

application/xml, text/xml

Sample:

<AppointmentBookingInputModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HyperQB.Property.API.Models">
  <Address>sample string 13</Address>
  <Address2>sample string 14</Address2>
  <Age>8</Age>
  <AllergicRecord>sample string 5</AllergicRecord>
  <ApptSlotId>sample string 1</ApptSlotId>
  <DOB>2025-04-04T13:17:06.5155537+08:00</DOB>
  <DisplayName>sample string 2</DisplayName>
  <Gender>sample string 9</Gender>
  <IdentityType>sample string 3</IdentityType>
  <ImPatient>true</ImPatient>
  <IsCalledByPractitioner>true</IsCalledByPractitioner>
  <NRIC>sample string 4</NRIC>
  <PhoneNumber>sample string 6</PhoneNumber>
  <Relationship>sample string 11</Relationship>
  <RelationshipId>1</RelationshipId>
  <Remark>sample string 7</Remark>
  <SubAspnetuserId>sample string 12</SubAspnetuserId>
</AppointmentBookingInputModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AppointmentBookingOutputModel

Name	Type	Additional information
Result	string	None.
Id	string	None.
AppointmentScheduleId	integer	None.
AspnetuserId	string	None.
AppointmentStartDateTime	date	None.
AppointmentEndDateTime	date	None.
AppointmentStatus	string	None.
IsAppointment	boolean	None.
IsActive	boolean	None.
IsRequiredPayment	boolean	None.
PaymentURL	string	None.
PaymentReferenceNo	string	None.
PaymentAmount	decimal number	None.
PaymentTitle	string	None.
IsCorporate	boolean	None.
DisplayName	string	None.
PatientName	string	None.
DOB	string	None.
Gender	string	None.
AllergicRecord	string	None.
PatientBillingAddress	string	None.
PatientBillingAddress2	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Result": "sample string 1",
  "Id": "sample string 2",
  "AppointmentScheduleId": 3,
  "AspnetuserId": "sample string 4",
  "AppointmentStartDateTime": "2025-04-04T13:17:06.5624101+08:00",
  "AppointmentEndDateTime": "2025-04-04T13:17:06.5624101+08:00",
  "AppointmentStatus": "sample string 7",
  "IsAppointment": true,
  "IsActive": true,
  "IsRequiredPayment": true,
  "PaymentURL": "sample string 10",
  "PaymentReferenceNo": "sample string 11",
  "PaymentAmount": 12.0,
  "PaymentTitle": "sample string 13",
  "IsCorporate": true,
  "DisplayName": "sample string 15",
  "PatientName": "sample string 16",
  "DOB": "sample string 17",
  "Gender": "sample string 18",
  "AllergicRecord": "sample string 19",
  "PatientBillingAddress": "sample string 20",
  "PatientBillingAddress2": "sample string 21"
}

application/xml, text/xml

Sample:

<AppointmentBookingOutputModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HyperQB.Property.API.Models">
  <AllergicRecord>sample string 19</AllergicRecord>
  <AppointmentEndDateTime>2025-04-04T13:17:06.5624101+08:00</AppointmentEndDateTime>
  <AppointmentScheduleId>3</AppointmentScheduleId>
  <AppointmentStartDateTime>2025-04-04T13:17:06.5624101+08:00</AppointmentStartDateTime>
  <AppointmentStatus>sample string 7</AppointmentStatus>
  <AspnetuserId>sample string 4</AspnetuserId>
  <DOB>sample string 17</DOB>
  <DisplayName>sample string 15</DisplayName>
  <Gender>sample string 18</Gender>
  <Id>sample string 2</Id>
  <IsActive>true</IsActive>
  <IsAppointment>true</IsAppointment>
  <IsCorporate>true</IsCorporate>
  <IsRequiredPayment>true</IsRequiredPayment>
  <PatientBillingAddress>sample string 20</PatientBillingAddress>
  <PatientBillingAddress2>sample string 21</PatientBillingAddress2>
  <PatientName>sample string 16</PatientName>
  <PaymentAmount>12</PaymentAmount>
  <PaymentReferenceNo>sample string 11</PaymentReferenceNo>
  <PaymentTitle>sample string 13</PaymentTitle>
  <PaymentURL>sample string 10</PaymentURL>
  <Result>sample string 1</Result>
</AppointmentBookingOutputModel>