Appointment Insights Result Properties

AppointmentInsightsResult contains the following properties.

  • blockedSlots

    The total number of potential blocked slots returned by the getAppointmentInsights method.

  • blockingRules

    Array of blocking rules with the rule name and number of slots

  • horizonStartDate

    The horizon start date as calculated and used by the operation.

  • horizonEndDate

    The horizon end date as calculated and used by the operation.

  • operationTimeStamp

    The time the operation was executed in Coordinated Universal Time (UTC).

  • policyId

    The default policy ID or the policy ID provided in the request.

  • resourcesEvaluated

    The total number of service resources loaded by fetch data and evaluated by the getAppointmentInsights method.

  • serviceAppointmentId

    The ID of the service appointment used for the request.

  • serviceTerritoryId

    The service territory associated with the service appointment. If there is no territory for the service appointment, keep this field empty. This property is optional.