afv-library/skills/platform-data-and-tooling-api-context-get/assets/enterprise_api/ServiceTerritoryMember.json

{
  "sections": [
    "title",
    "description",
    "fields",
    "special_access_rules",
    "usage",
    "associated_objects",
    "wsdl_segment",
    "field_reference"
  ],
  "title": "ServiceTerritoryMember - Data API",
  "description": "Represents a service resource who can be assigned in a service territory in Field Service, Salesforce Scheduler, or Workforce Engagement. This object is available in API version 38.0 and later.",
  "fields_columns": [
    "type",
    "properties",
    "description",
    "relationship_name",
    "relationship_type",
    "refers_to"
  ],
  "fields": {
    "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": "datetime",
      "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": "datetime",
      "properties": "Create, Filter, Sort, Update",
      "description": "The date when the service resource becomes a member of the service territory."
    },
    "GeocodeAccuracy": {
      "type": "picklist",
      "properties": "Create, Defaulted on 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. Note: This field is available in the API only."
    },
    "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. Note: This field is available in the API only."
    },
    "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. Note: This field is available in the API only."
    },
    "MemberNumber": {
      "type": "string",
      "properties": "Autonumber, Defaulted on create, Filter, idLookup, 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. This is a relationship field.",
      "relationship_name": "OperatingHours",
      "relationship_type": "Lookup",
      "refers_to": "OperatingHours"
    },
    "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. This is a relationship field.",
      "relationship_name": "ServiceResource",
      "relationship_type": "Lookup",
      "refers_to": "ServiceResource"
    },
    "ServiceTerritoryId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Sort",
      "description": "The service territory that the service resource is assigned to. This is a relationship field.",
      "relationship_name": "ServiceTerritory",
      "relationship_type": "Lookup",
      "refers_to": "ServiceTerritory"
    },
    "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 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"
    },
    "TravelModeId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "ID of the TravelMode used for travel time calculations. The travel mode includes information about the type of transportation, such as a car or walking, whether a vehicle can take toll roads, and whether a vehicle is transporting hazardous materials. This field is a relationship field.",
      "relationship_name": "TravelMode",
      "relationship_type": "Lookup",
      "refers_to": "TravelMode"
    }
  },
  "special_access_rules": "Field Service or Workforce Engagement must be enabled.",
  "usage": "If you delete a service territory with members, the service resources who were members no longer have any connection to the territory.\n\nIf you delete a service territory with members, the service\n\t\t\tresources who were members no longer have any connection to the territory.",
  "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.\n\n- **ServiceTerritoryMemberChangeEvent (API version 48.0)**: Change events are available for the object.\n- **ServiceTerritoryMemberFeed**: Feed tracking is available for the object.\n- **ServiceTerritoryMemberHistory**: History is available for tracked fields of the object.",
  "wsdl_segment": "```xml\n<simpleType name=\"ID\">\n  <restriction base=\"xsd:string\">\n    <length value=\"18\"/>\n    <pattern value=\"[a-zA-Z0-9]{18}\"/>\n  </restriction>\n</simpleType>\n<simpleType name=\"QueryLocator\">\n  <restriction base=\"xsd:string\"/>\n</simpleType>\n<complexType name=\"QueryResult\">\n  <sequence>\n    <element name=\"done\" type=\"xsd:boolean\"/>\n    <element name=\"queryLocator\" type=\"tns:QueryLocator\" nillable=\"true\"/>\n    <element name=\"records\" type=\"ens:sObject\" nillable=\"true\" minOccurs=\"0\" maxOccurs=\"unbounded\"/>\n    <element name=\"size\" type=\"xsd:int\"/>\n  </sequence>\n</complexType>\n<complexType name=\"ServiceTerritoryMember\">\n  <complexContent>\n    <extension base=\"ens:sObject\">\n      <sequence>\n        <element name=\"Address\" nillable=\"true\" minOccurs=\"0\" type=\"tns:address\"/>\n        <element name=\"ApprovalSubmissions\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"ApprovalWorkItems\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"AttachedContentDocuments\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"City\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"CombinedAttachments\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"ContentDocumentLinks\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"Country\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"CreatedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n        <element name=\"CreatedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"CreatedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"EffectiveEndDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"EffectiveStartDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"FeedSubscriptionsForEntity\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"Feeds\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"FlowOrchestrationWorkItems\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"GeocodeAccuracy\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"GeolocationBasedActions\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"Histories\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"IsDeleted\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"LastModifiedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n        <element name=\"LastModifiedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"LastModifiedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"LastReferencedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"LastViewedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"Latitude\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:double\"/>\n        <element name=\"Longitude\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:double\"/>\n        <element name=\"MemberNumber\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"OperatingHours\" nillable=\"true\" minOccurs=\"0\" type=\"ens:OperatingHours\"/>\n        <element name=\"OperatingHoursId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"PostalCode\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"ProcessInstances\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"ProcessSteps\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"RecordActionHistories\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"RecordActions\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"ServiceResource\" nillable=\"true\" minOccurs=\"0\" type=\"ens:ServiceResource\"/>\n        <element name=\"ServiceResourceId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"ServiceTerritory\" nillable=\"true\" minOccurs=\"0\" type=\"ens:ServiceTerritory\"/>\n        <element name=\"ServiceTerritoryId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"State\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"Street\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"SystemModstamp\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"TerritoryType\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"TopicAssignments\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"TravelMode\" nillable=\"true\" minOccurs=\"0\" type=\"ens:TravelMode\"/>\n        <element name=\"TravelModeId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"UserRecordAccess\" nillable=\"true\" minOccurs=\"0\" type=\"ens:UserRecordAccess\"/>\n      </sequence>\n    </extension>\n  </complexContent>\n</complexType>\n<complexType name=\"address\">\n  <complexContent>\n    <extension base=\"tns:location\">\n      <sequence>\n        <element name=\"city\" type=\"xsd:string\" nillable=\"true\"/>\n        <element name=\"country\" type=\"xsd:string\" nillable=\"true\"/>\n        <element name=\"countryCode\" type=\"xsd:string\" nillable=\"true\"/>\n        <element name=\"geocodeAccuracy\" type=\"xsd:string\" nillable=\"true\"/>\n        <element name=\"postalCode\" type=\"xsd:string\" nillable=\"true\"/>\n        <element name=\"state\" type=\"xsd:string\" nillable=\"true\"/>\n        <element name=\"stateCode\" type=\"xsd:string\" nillable=\"true\"/>\n        <element name=\"street\" type=\"xsd:string\" nillable=\"true\"/>\n      </sequence>\n    </extension>\n  </complexContent>\n</complexType>\n<complexType name=\"location\">\n  <sequence>\n    <element name=\"latitude\" type=\"xsd:double\" nillable=\"true\"/>\n    <element name=\"longitude\" type=\"xsd:double\" nillable=\"true\"/>\n  </sequence>\n</complexType>\n```",
  "field_reference": {
    "Address": {
      "field_label": "Address",
      "type": "address"
    },
    "City": {
      "field_label": "City",
      "type": "string",
      "length": "40"
    },
    "Country": {
      "field_label": "Country",
      "type": "string",
      "length": "80"
    },
    "CreatedById": {
      "field_label": "Created By ID",
      "type": "reference",
      "length": "18"
    },
    "CreatedDate": {
      "field_label": "Created Date",
      "type": "datetime"
    },
    "CurrencyIsoCode": {
      "field_label": "Currency ISO Code",
      "type": "picklist",
      "length": "3"
    },
    "EffectiveEndDate": {
      "field_label": "End Date",
      "type": "datetime"
    },
    "EffectiveStartDate": {
      "field_label": "Start Date",
      "type": "datetime"
    },
    "GeocodeAccuracy": {
      "field_label": "Geocode Accuracy",
      "type": "picklist",
      "length": "40"
    },
    "Id": {
      "field_label": "Resource Territory ID",
      "type": "id",
      "length": "18"
    },
    "IsDeleted": {
      "field_label": "Deleted",
      "type": "boolean"
    },
    "LastModifiedById": {
      "field_label": "Last Modified By ID",
      "type": "reference",
      "length": "18"
    },
    "LastModifiedDate": {
      "field_label": "Last Modified Date",
      "type": "datetime"
    },
    "LastReferencedDate": {
      "field_label": "Last Referenced Date",
      "type": "datetime"
    },
    "LastViewedDate": {
      "field_label": "Last Viewed Date",
      "type": "datetime"
    },
    "Latitude": {
      "field_label": "Latitude",
      "type": "double",
      "precision": "18",
      "scale": "15"
    },
    "Longitude": {
      "field_label": "Longitude",
      "type": "double",
      "precision": "18",
      "scale": "15"
    },
    "MemberNumber": {
      "field_label": "Member Number",
      "type": "string",
      "length": "255"
    },
    "OperatingHoursId": {
      "field_label": "Operating Hour ID",
      "type": "reference",
      "length": "18"
    },
    "PostalCode": {
      "field_label": "Zip/Postal Code",
      "type": "string",
      "length": "20"
    },
    "Role": {
      "field_label": "Role",
      "type": "picklist",
      "length": "40"
    },
    "ServiceResourceId": {
      "field_label": "Resource ID",
      "type": "reference",
      "length": "18"
    },
    "ServiceTerritoryId": {
      "field_label": "Territory ID",
      "type": "reference",
      "length": "18"
    },
    "State": {
      "field_label": "State/Province",
      "type": "string",
      "length": "80"
    },
    "Street": {
      "field_label": "Address",
      "type": "textarea",
      "length": "255"
    },
    "SystemModstamp": {
      "field_label": "System Modstamp",
      "type": "datetime"
    },
    "TerritoryType": {
      "field_label": "Territory Type",
      "type": "picklist",
      "length": "255"
    },
    "TravelModeId": {
      "field_label": "Travel Mode ID",
      "type": "reference",
      "length": "18"
    }
  },
  "field_reference_columns": [
    "field_label",
    "type",
    "length",
    "precision",
    "scale"
  ]
}