RecurringVisitSchedulingInput Class

Contains the input for scheduling recurring home visits, including the default address, work type configurations, recurrence series, resource assignment setting, and time zone.

Namespace 

healthcloudext

RecurringVisitSchedulingInput Properties 

The following are properties for RecurringVisitSchedulingInput.

  • isAutoAssignCareResource

    Indicates whether Field Service assigns a resource to the service appointments. When false, the service appointments are created and left unassigned. A null value behaves as true.

  • schedulingPolicyId

    ID of the scheduling policy for the request. This value is required. An individual series can override it.

  • serviceTerritoryId

    ID of the service territory for the request. This value is required. An individual series can override it.

  • timeZoneId

    IANA time zone ID used to interpret series start dates and time slots. If this value is omitted, the running user’s time zone is used.

  • visitAddress

    Request-level visit address. A series uses this address when the series does not specify its own address.

  • visitRecurrenceDetails

    Recurring series that make up this scheduling request. Each series defines its own recurrence rule, time slots, and optional overrides.

  • visitWorkTypes

    Request-level work type configurations. The request can include up to five configurations. A series can override fields for a work type.

isAutoAssignCareResource 

Indicates whether Field Service assigns a resource to the service appointments. When false, the service appointments are created and left unassigned. A null value behaves as true.

Signature 

@AuraEnabled global Boolean isAutoAssignCareResource {get; set;}

Property Value 

Type: Boolean

schedulingPolicyId 

ID of the scheduling policy for the request. This value is required. An individual series can override it.

Signature 

@AuraEnabled global String schedulingPolicyId {get; set;}

Property Value 

Type: String

serviceTerritoryId 

ID of the service territory for the request. This value is required. An individual series can override it.

Signature 

@AuraEnabled global String serviceTerritoryId {get; set;}

Property Value 

Type: String

timeZoneId 

IANA time zone ID used to interpret series start dates and time slots. If this value is omitted, the running user’s time zone is used.

Signature 

@AuraEnabled global String timeZoneId {get; set;}

Property Value 

Type: String

visitAddress 

Request-level visit address. A series uses this address when the series does not specify its own address.

Signature 

@AuraEnabled global healthcloudext.VisitAddress visitAddress {get; set;}

Property Value 

Type: healthcloudext.VisitAddress

visitRecurrenceDetails 

Recurring series that make up this scheduling request. Each series defines its own recurrence rule, time slots, and optional overrides.

Signature 

@AuraEnabled global List<healthcloudext.VisitRecurrenceDetails> visitRecurrenceDetails {get; set;}

Property Value 

Type: List<healthcloudext.VisitRecurrenceDetails>

visitWorkTypes 

Request-level work type configurations. The request can include up to five configurations. A series can override fields for a work type.

Signature 

@AuraEnabled global List<healthcloudext.VisitWorkType> visitWorkTypes {get; set;}

Property Value 

Type: List<healthcloudext.VisitWorkType>