Jump to

• Request
• Response

Get a lead team memeber not supported

get

/crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/MklLeadTeam/{LeadTeamId}

Request

Path Parameters

• LeadTeamId(required): integer(int64)
  The unique identifier of the lead team.
• leadsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Sales Leads resource and used to uniquely identify an instance of Sales Leads. The client should not generate the hash key value. Instead, the client should query on the Sales Leads collection resource in order to navigate to a specific instance of Sales Leads to get the hash key.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : leads-MklLeadTeam-item-response

Type: object

Show Source

• AccessLevelCode: string
  Title: Access

  Read Only: true

  Maximum Length: 30

  Default Value: FULL

  The access level granted to the lead team member, manager, and administrator of the organizations in the resource hierarchy.
• AddedOnDateTime: string (date-time)
  Title: Join Date

  The create date and time for the lead team member based either on the date the resource was added to the lead resource or the date the territory was added to lead territory.
• City: string
  Title: City

  Read Only: true

  Maximum Length: 60

  The city of the resource.
• ConflictId: integer (int64)
  Read Only: true

  Default Value: 1

  The conflict identifier.
• Country: string
  Title: Country

  Read Only: true

  Maximum Length: 2

  The country code of the resource.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user identifier of the user who created the lead team member.
• CreationDate: string (date-time)
  Read Only: true

  The create date and time of the lead team member.
• EmailAddress: string
  Title: Primary Email

  Read Only: true

  Maximum Length: 320

  The email address of the resource.
• FormattedPhoneNumber: string
  Title: Primary Phone

  Read Only: true

  The formatted phone number of the resource.
• FunctionalRole: string
  Title: Function

  Read Only: true

  Maximum Length: 30

  The code of the function or role of the lead team member.
• FunctionCode: string
  Title: Function

  Read Only: true

  Maximum Length: 30

  The code of the function or role of the lead team member.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the lead team was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the lead team.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the lead team.
• LeadId: integer (int64)
  The unique identifier of the lead.
• LeadNumber: string
  Title: Lead Number

  Read Only: true

  Maximum Length: 30

  The alternate unique identifier of the lead.
• LeadResourceId: integer
  Read Only: true

  The unique identifier of the lead resource.
• LeadTeamId: integer (int64)
  The unique identifier of the lead team.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OwnerFlag: boolean
  Read Only: true

  Indicates whether the lead team member is the owner of the lead.
• PartyId: integer (int64)
  Title: Party ID

  Read Only: true

  The unique identifier of the party.
• PartyName: string
  Title: Name

  Read Only: true

  Maximum Length: 360

  The name of the resource.
• PartyNumber: string
  Title: Registry ID

  Read Only: true

  Maximum Length: 30

  The alternate identifier of the resource.
• PrimaryFlag: boolean
  Read Only: true

  Maximum Length: 1

  Default Value: false

  Indicates whether the lead team member is the owner of the lead.
• PrimaryPhoneNumber: string
  Read Only: true

  Maximum Length: 40

  Primary formatted phone number for the resource.
• PrimaryPhonePurpose: string
  Title: Role

  Read Only: true

  Maximum Length: 30

  Primary purpose of the phone for the resource.
• ResourceId: integer (int64)
  Resource party identifier of the lead team member.
• ResourceRoleName: string
  Read Only: true

  Maximum Length: 255

  The role name of the resource.
• State: string
  Title: State

  Read Only: true

  Maximum Length: 60

  The state of the resource.
• TerritoryFunctionCode: string
  Title: Territory Function

  Read Only: true

  Maximum Length: 30

  The code of the business function of the territory.
• TerritoryName: string
  Title: Territory Name

  Read Only: true

  Maximum Length: 60

  The name of the territory.
• TerritoryNumber: string
  Title: Number

  Read Only: true

  Maximum Length: 30

  The number of the territory.
• TerritoryOwnerFlag: boolean
  Read Only: true

  Indicates whether the lead team member is the territory owner.
• TerritoryVersionId: number
  Version identifier of the territory for the resource that got assigned to the lead through territory-based assignment.
• TypeCode: string
  Title: Type

  Read Only: true

  Maximum Length: 30

  Default Value: PRIME

  The code of the type of the territory.

{
    "type":"object",
    "properties":{
        "AccessLevelCode":{
            "title":"Access",
            "maxLength":30,
            "type":"string",
            "description":"The access level granted to the lead team member, manager, and administrator of the organizations in the resource hierarchy.",
            "nullable":false,
            "readOnly":true,
            "default":"FULL",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AddedOnDateTime":{
            "title":"Join Date",
            "type":"string",
            "description":"The create date and time for the lead team member based either on the date the resource was added to the lead resource or the date the territory was added to lead territory.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "City":{
            "title":"City",
            "maxLength":60,
            "type":"string",
            "description":"The city of the resource.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.City",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"City"
            },
            "x-queryable":true
        },
        "ConflictId":{
            "type":"integer",
            "description":"The conflict identifier.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "default":1,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":2,
            "type":"string",
            "description":"The country code of the resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user identifier of the user who created the lead team member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The create date and time of the lead team member.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Primary Email",
            "maxLength":320,
            "type":"string",
            "description":"The email address of the resource.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "FormattedPhoneNumber":{
            "title":"Primary Phone",
            "type":"string",
            "description":"The formatted phone number of the resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "FunctionCode":{
            "title":"Function",
            "maxLength":30,
            "type":"string",
            "description":"The code of the function or role of the lead team member.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "FunctionalRole":{
            "title":"Function",
            "maxLength":30,
            "type":"string",
            "description":"The code of the function or role of the lead team member.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the lead team was last updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the lead team.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the lead team.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LeadId":{
            "type":"integer",
            "description":"The unique identifier of the lead.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LeadNumber":{
            "title":"Lead Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate unique identifier of the lead.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LeadResourceId":{
            "type":"integer",
            "description":"The unique identifier of the lead resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LeadTeamId":{
            "type":"integer",
            "description":"The unique identifier of the lead team.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OwnerFlag":{
            "type":"boolean",
            "description":"Indicates whether the lead team member is the owner of the lead.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "OwnerId"
                ]
            }
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier of the party.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartyName":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyNumber":{
            "title":"Registry ID",
            "maxLength":30,
            "type":"string",
            "description":"The alternate identifier of the resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the lead team member is the owner of the lead.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "PrimaryPhoneNumber":{
            "maxLength":40,
            "type":"string",
            "description":"Primary formatted phone number for the resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryPhonePurpose":{
            "title":"Role",
            "maxLength":30,
            "type":"string",
            "description":"Primary purpose of the phone for the resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceId":{
            "type":"integer",
            "description":"Resource party identifier of the lead team member.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResourceRoleName":{
            "maxLength":255,
            "type":"string",
            "description":"The role name of the resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "State":{
            "title":"State",
            "maxLength":60,
            "type":"string",
            "description":"The state of the resource.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.State",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"State"
            },
            "x-queryable":true
        },
        "TerritoryFunctionCode":{
            "title":"Territory Function",
            "maxLength":30,
            "type":"string",
            "description":"The code of the business function of the territory.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TerritoryName":{
            "title":"Territory Name",
            "maxLength":60,
            "type":"string",
            "description":"The name of the territory.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TerritoryNumber":{
            "title":"Number",
            "maxLength":30,
            "type":"string",
            "description":"The number of the territory.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TerritoryOwnerFlag":{
            "type":"boolean",
            "description":"Indicates whether the lead team member is the territory owner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "TerritoryOwnerResourceId"
                ]
            }
        },
        "TerritoryVersionId":{
            "type":"number",
            "description":"Version identifier of the territory for the resource that got assigned to the lead through territory-based assignment.",
            "nullable":true,
            "x-queryable":true
        },
        "TypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The code of the type of the territory.",
            "nullable":false,
            "readOnly":true,
            "default":"PRIME",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

AccessLevelLOVViewAccessor

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DMKL_ACCESS_LEVEL

The lookups resource is used to view standard lookup codes.

FunctionalRoleLOVViewAccessor

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DZCA_RESOURCE_FUNCTION

The lookups resource is used to view standard lookup codes.

TeamMemberFunctionLOVViewAccessor

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsEnabledFinder%3BBindLookupType%3DMOT_TEAM_MEMBER_FUNCTION

The lookups resource is used to view standard lookup codes.

TerritoryFunctionLOVViewAccessor

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_MOT_TERRITORY_FUNCTION

The lookups resource is used to view standard lookup codes.

TerritoryTypeLOVViewAccessor

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DMOT_TERRITORY_TYPE

The lookups resource is used to view standard lookup codes.

Back to Top