Newer Version Available

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

ServiceTerritoryMember

Represents a service resource who can be assigned to service appointments in a service territory in Field Service Lightning and Lightning Scheduler. This object is available in API version 38.0 and later.

Supported Calls

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

Special Access Rules

Field Service Lightning must be enabled.

Fields

Field Name Details
Address
Type
address
Properties
Filter
Description
The member’s address. You may want to list the related service resource’s address in this field.
City
Type
string
Properties
Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description
The city of the member’s address. Maximum length is 40 characters.
Country
Type
string
Properties
Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description
The country of the member’s address. Maximum length is 80 characters.
EffectiveEndDate
Type
date
Properties
Create, Filter, Nillable, Sort, Update
Description
The date when the service resource is no longer a member of the territory. If the resource will be working in the territory for the foreseeable future, leave this field blank. This field is mainly useful for indicating when a temporary relocation ends.
EffectiveStartDate
Type
date
Properties
Create, Filter, Sort, Update
Description
The date when the service resource becomes a member of the service territory.
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. Usually provided by a geocoding service based on the address’s latitude and longitude coordinates.

This field is available in the API only.

Note

LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The date when the territory member was last modified. Its label in the user interface is Last Modified Date.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The date when the territory member was last viewed.
Latitude
Type
double
Properties
Create, Defaulted on create, Filter, Nillable, Sort, Update
Description
Used with Longitude to specify the precise geolocation of the member’s address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places.

This field is available in the API only.

Note

Longitude
Type
double
Properties
Create, Defaulted on create, Filter, Nillable, Sort, Update
Description
Used with Latitude to specify the precise geolocation of the member’s address. Acceptable values are numbers between –180 and 180 with up to 15 decimal places.

This field is available in the API only.

Note

MemberNumber
Type
string
Properties
Autonumber, Defaulted on create, Filter, Sort
Description
(Read only) An auto-generated number identifying the service territory member.
OperatingHoursId
Type
reference
Properties
Create, Filter, Group, Sort, Nillable, Update
Description
The operating hours assigned to the service territory member. If no operating hours are specified, the member is assumed to use their parent service territory’s operating hours. If a member needs special operating hours, create them in Setup and select them in the Operating Hours lookup field on the member’s detail page.
PostalCode
Type
string
Properties
Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description
The postal code of the member’s address. Maximum length is 20 characters.
ServiceResourceId
Type
reference
Properties
Create, Filter, Group, Sort, Update
Description
The service resource assigned to the service territory.
ServiceTerritoryId
Type
reference
Properties
Create, Filter, Group, Sort
Description
The service territory that the service resource is assigned to.
State
Type
string
Properties
Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description
The state of the member’s address. Maximum length is 80 characters.
Street
Type
textarea
Properties
Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description
The street number and name of the member’s address.
TerritoryType
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Primary, Secondary, or Relocation.
  • The primary territory is typically the territory where the resource works most often—for example, near their home base. Service resources can only have one primary territory.
  • Secondary territories are territories where the resource can be assigned to appointments if needed. Service resources can have multiple secondary territories.
  • Relocation territories represent temporary moves for service resources. If you’re using the Field Service Lightning managed packages with the scheduling optimizer, resources with relocation territories are always assigned to services within their relocation territories during the specified relocation dates; if they don’t have a relocation territory, the primary territories are favored over the secondary.
For example, a service resource might have the following territories:
  • Primary territory: West Chicago
  • Secondary territories:
    • East Chicago
    • South Chicago
  • Relocation territory: Manhattan, for a three-month period

Usage

If you delete a service territory with members, the service resources who were members no longer have any connection to the territory.

Associated Objects

This object has the following associated objects. Unless noted, they are available in the same API version as this object.

ServiceTerritoryMemberFeed
Feed tracking is available for the object.
ServiceTerritoryMemberHistory
History is available for tracked fields of the object.