Newer Version Available

This content describes an older version of this product. View Latest

ScheduleBroadcastAppointment

Represents appointments that schedulers broadcast to resources using a schedule broadcast. This object is available in API version 60.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Fields

Field Details
Address
Type
address
Properties
Filter, Nillable
Description
The address of the appointment where the home visit is performed.
AppointmentReferenceId
Type
reference
Properties
Create, Filter, Group, Sort, Update
Description
The appointment associated with the schedule broadcast appointment.
This field is a polymorphic relationship field.
Relationship Name
AppointmentReference
Relationship Type
Lookup
Refers To
ServiceAppointment, Visit
City
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The city of the appointment address.
Country
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The country of the appointment address.
EndDateTime
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The end date and time of the appointment.
GeocodeAccuracy
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The level of accuracy of a location’s geographical coordinates compared with its physical address. A geocoding service typically provides this value based on the address’s latitude and longitude coordinates.
Possible values are:
  • Address
  • Block
  • City
  • County
  • ExtendedZip—Extended Zip
  • NearAddress—Near Address
  • Neighborhood
  • State
  • Street
  • Unknown
  • Zip
IsAccepted
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether a care resource has accepted the appointment (true) or not (false).
The default value is false.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The date and time when the record was last referenced.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The date and time when the record was last viewed.
Latitude
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
Used with Longitude to specify the precise geolocation of the address.
Longitude
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
Used with Latitude to specify the precise geolocation of the address.
Name
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
The name of the record.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
The owner of the record.
This field is a polymorphic relationship field.
Relationship Name
Owner
Relationship Type
Lookup
Refers To
Group, User
PostalCode
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The postal code of the appointment address.
ScheduleBroadcastId
Type
reference
Properties
Create, Filter, Group, Sort, Update
Description
The schedule broadcast associated with the schedule broadcast appointment.
This field is a relationship field.
Relationship Name
ScheduleBroadcast
Relationship Type
Lookup
Refers To
ScheduleBroadcast
StartDateTime
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The start date and time of the appointment.
State
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The state of the appointment address.
Street
Type
textarea
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The street of the appointment address.
WorkTypeId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The work type associated with the schedule broadcast appointment.
This field is a relationship field.
Relationship Name
WorkType
Relationship Type
Lookup
Refers To
WorkType

Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

ScheduleBroadcastAppointmentChangeEvent
Change events are available for the object.
ScheduleBroadcastAppointmentFeed
Feed tracking is available for the object.
ScheduleBroadcastAppointmentHistory
History is available for tracked fields of the object.
ScheduleBroadcastAppointmentShare
Sharing is available for the object.