POST api/appointments/{Id}/share

Request Information

URI Parameters

NameDescriptionTypeAdditional information
Id

string

Required

Body Parameters

BookQueueSharingInputModel
NameDescriptionTypeAdditional information
UserId

string

None.

Request Formats

application/json, text/json

Sample:
{
  "UserId": "sample string 1"
}

application/xml, text/xml

Sample:
<BookQueueSharingInputModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HyperQB.Property.API.Models">
  <UserId>sample string 1</UserId>
</BookQueueSharingInputModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AppointmentSlotOutputModel
NameDescriptionTypeAdditional information
Id

string

None.

ConsultationType

string

None.

QueuingCount

string

None.

EstimationTime

string

None.

Remark

string

None.

PractitionerId

string

None.

PractitionerName

string

None.

Speciality

string

None.

BookingTime

string

None.

AppointmentStartDate

string

None.

AppointmentEndDate

string

None.

Duration

string

None.

Status

string

None.

StatusColor

string

None.

ConsultationDiagnosis

string

None.

ConsultationDoctorSuggestion

string

None.

IsActive

boolean

None.

IsAppointment

boolean

None.

ConsultationURL

string

None.

MedicalCertURL

string

None.

ReferralLetterURL

string

None.

RejectReason

string

None.

PatientName

string

None.

PatientDOB

string

None.

Gender

string

None.

PatientAllergicRecord

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": "sample string 1",
  "ConsultationType": "sample string 2",
  "QueuingCount": "sample string 3",
  "EstimationTime": "sample string 4",
  "Remark": "sample string 5",
  "PractitionerId": "sample string 6",
  "PractitionerName": "sample string 7",
  "Speciality": "sample string 8",
  "BookingTime": "sample string 9",
  "AppointmentStartDate": "sample string 10",
  "AppointmentEndDate": "sample string 11",
  "Duration": "sample string 12",
  "Status": "sample string 13",
  "StatusColor": "sample string 14",
  "ConsultationDiagnosis": "sample string 15",
  "ConsultationDoctorSuggestion": "sample string 16",
  "IsActive": true,
  "IsAppointment": true,
  "ConsultationURL": "sample string 19",
  "MedicalCertURL": "sample string 20",
  "ReferralLetterURL": "sample string 21",
  "RejectReason": "sample string 22",
  "PatientName": "sample string 23",
  "PatientDOB": "sample string 24",
  "Gender": "sample string 25",
  "PatientAllergicRecord": "sample string 26"
}

application/xml, text/xml

Sample:
<AppointmentSlotOutputModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HyperQB.Property.API.Models">
  <AppointmentEndDate>sample string 11</AppointmentEndDate>
  <AppointmentStartDate>sample string 10</AppointmentStartDate>
  <BookingTime>sample string 9</BookingTime>
  <ConsultationDiagnosis>sample string 15</ConsultationDiagnosis>
  <ConsultationDoctorSuggestion>sample string 16</ConsultationDoctorSuggestion>
  <ConsultationType>sample string 2</ConsultationType>
  <ConsultationURL>sample string 19</ConsultationURL>
  <Duration>sample string 12</Duration>
  <EstimationTime>sample string 4</EstimationTime>
  <Gender>sample string 25</Gender>
  <Id>sample string 1</Id>
  <IsActive>true</IsActive>
  <IsAppointment>true</IsAppointment>
  <MedicalCertURL>sample string 20</MedicalCertURL>
  <PatientAllergicRecord>sample string 26</PatientAllergicRecord>
  <PatientDOB>sample string 24</PatientDOB>
  <PatientName>sample string 23</PatientName>
  <PractitionerId>sample string 6</PractitionerId>
  <PractitionerName>sample string 7</PractitionerName>
  <QueuingCount>sample string 3</QueuingCount>
  <ReferralLetterURL>sample string 21</ReferralLetterURL>
  <RejectReason>sample string 22</RejectReason>
  <Remark>sample string 5</Remark>
  <Speciality>sample string 8</Speciality>
  <Status>sample string 13</Status>
  <StatusColor>sample string 14</StatusColor>
</AppointmentSlotOutputModel>