Skip to main content

Get appointment booking rule

GET 
/api/diary/bookingrule

Retrieves an appointment booking rule by siteId and visitTypeId.

Response sample

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "bookingDuration": 0,
  "bookingRuleOptions": [{
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "bookingQuestionOptionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "bookingQuestionOptionDescriptor": "string" }],
  "bookingRuleExclusions": [{
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "remoteId": "string",
    "bookingRuleExclusionType": 1 }],
  "bookingRuleDurationOverrides": [{
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "bookingDuration": 0,
    "matchSlotDuration": true,
    "bookingDurationOverrideType": 1,
    "remoteId": "string" }],
  "bookingRuleMatchingEntities": [{
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "remoteDoctorId": "string",
    "remoteVisitTypeId": "string" }],
  "type": "string",
  "links": {
    "additionalProp1": {},
    "additionalProp2": {},
    "additionalProp3": {}}
}

Request​

Responses​

Success: Request accepted.