POST api/Calendar/PatientAppointmentPost

Patient Book Appointment

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
EncounterTypeId	globally unique identifier	None.
EncounterTypeModeDurationId	globally unique identifier	None.
ProviderId	globally unique identifier	None.
UserId	globally unique identifier	Required
PatientId	globally unique identifier	None.
SpecialityId	globally unique identifier	None.
AppointmentOn	date	Required
SecondaryAppointmentOn	date	None.
Reason	string	Required String length: inclusive between 0 and 250
Note	string	String length: inclusive between 0 and 1000
ParentId	globally unique identifier	None.
ReferredParentId	globally unique identifier	None.
PaidAmount	decimal number	None.
AccountId	globally unique identifier	Required
ServiceId	globally unique identifier	None.
MethodId	integer	None.
IsCustomFormFlow	string	None.
DocIds	string	None.
Reasons	Collection of Reasons	None.

Request Formats

application/json, text/json

Sample:

{
  "EncounterTypeId": "60b8f24e-be54-481e-b568-21c460c3c39e",
  "EncounterTypeModeDurationId": "fc480d1b-e536-4ce5-832f-b11ee8d5c280",
  "ProviderId": "507b3875-548c-49d8-9717-900f27887fe1",
  "UserId": "f8fb0138-e0ad-4189-9bb7-493a85b012ab",
  "PatientId": "31eaa042-d9fc-420a-a5e6-946e41e03f3c",
  "SpecialityId": "9ef2758f-3626-4f2e-9426-0fad2d13409f",
  "AppointmentOn": "2025-06-06T16:17:35.6778623+00:00",
  "SecondaryAppointmentOn": "2025-06-06T16:17:35.6778623+00:00",
  "Reason": "sample string 3",
  "Note": "sample string 4",
  "ParentId": "66cf07fe-5b3e-4cc7-890f-de20377e17ce",
  "ReferredParentId": "4da74b95-3f0a-4882-871e-58357cd2d54a",
  "PaidAmount": 5.0,
  "AccountId": "ff4ab856-b937-4135-a0e6-bf032d539ef1",
  "ServiceId": "8d14b49e-ac19-48ad-8f3f-36098a5ff318",
  "MethodId": 1,
  "IsCustomFormFlow": "sample string 7",
  "DocIds": "sample string 8",
  "Reasons": [
    {
      "ReasonId": "4e7ea578-5268-4773-b248-38a2e83a375a"
    },
    {
      "ReasonId": "4e7ea578-5268-4773-b248-38a2e83a375a"
    }
  ]
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Schedule

Name	Type	Additional information
ID	globally unique identifier	None.
FacilityId	globally unique identifier	None.
ResourceID	globally unique identifier	None.
AppointmentTypeId	globally unique identifier	None.
PreferredPharmacyId	globally unique identifier	None.
EncounterTypeModeDurationId	globally unique identifier	None.
ServiceId	globally unique identifier	None.
FromUserType	character	None.
FromUserID	globally unique identifier	None.
UserId	globally unique identifier	None.
Title	string	None.
Reason	string	None.
CancelReason	string	None.
Type	string	None.
AppointmentOn	date	None.
SecondaryAppointmentOn	date	None.
FromDate	date	None.
Duration	integer	None.
Note	string	None.
ToDate	date	None.
StatusId	integer	None.
AppointmentCount	integer	None.
EncounterTypeModeId	integer	None.
RoomNo	string	None.
Option	string	None.
CallType	string	None.
CallRefId	string	None.
GuardianName	string	None.
Location	string	None.
SpecialityId	globally unique identifier	None.
ParentScheduleId	globally unique identifier	None.
DoctorId	globally unique identifier	None.
PaidDate	date	None.
AppointmentOnUTC	date	None.
SecondaryAppointmentOnUTC	date	None.
PaidAmount	decimal number	None.
AccountId	globally unique identifier	None.
GuardianId	globally unique identifier	None.
PatientReferralId	globally unique identifier	None.
ParentId	globally unique identifier	None.
PatientId	globally unique identifier	None.
IsGuardian	integer	None.
AppointmentModeId	integer	None.
ReferenceId	string	None.
VisitMode	string	None.
VisitCode	string	None.
Doctor	string	None.
MethodId	integer	None.
PayConceptId	integer	None.
PayMethodId	integer	None.
DocIds	Collection of string	None.
ReasonId	string	None.
DocId	string	None.
DoctorTimeZone	string	None.
PatientTimeZone	string	None.
PatientHummyurl	string	None.
DoctorOffset	integer	None.
PatientOffset	integer	None.
EncounterId	globally unique identifier	None.
DoctorZoneDate	string	None.
PrimaryPatient	string	None.
SessionId	string	None.
OldAppointmentOn	date	None.
OldAppointmentOnUTC	date	None.
OldSecondaryAppointmentOnUTC	date	None.
PortalType	string	None.
UserOffset	integer	None.
EncounterNo	string	None.
StatusName	string	None.
InsuranceName	string	None.
InsuranceId	globally unique identifier	None.
Patient	Patient	None.
EncounterType	EncounterType	None.
Resource	Resource	None.
Status	Status	None.
Facility	Facility	None.
Encounter	Encounter	None.
Member	Member	None.
Notification	Notification	None.
Speciality	Speciality	None.
ScheduleDetails	Collection of ScheduleDetail	None.
Members	Collection of Member	None.
customFormModel	Collection of CustomFormModel	None.
ModifiedBy	globally unique identifier	None.
ModifiedOn	date	None.
Modified	Member	None.

Response Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.