Get an account team member - Not Supported
get
/crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/AccountTeam/{AccountTeamId}
Request
Path Parameters
-
AccountTeamId(required): integer(int64)
The unique key to identify the account team member.
-
PartyNumber(required): string
The unique alternate identifier for the account party. You can update the value if the profile option HZ_GENERATE_PARTY_NUMBER is set to True. The default value is a concatenation of the value specified in the profile option ZCA_PUID_PREFIX and a unique system generated sequence number. Inactive records can't be updated.
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:
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.
There's no request body for this operation.
Back to TopResponse
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.
Root Schema : accounts-AccountTeam-item-response
Type:
Show Source
object
-
AccessLevelCode: string
Title:
Access
Read Only:true
Maximum Length:30
The access level granted to the account team member, manager, and administrator of the organizations in the resource hierarchy. -
AccountTeamId: integer
(int64)
The unique key to identify the account team member.
-
AddedOnDateTime: string
(date-time)
Title:
Joining Date
The date when the account team member was created based on either the date the resource was added to the account resource or the date the territory was added to account territory. -
AssignmentTypeCode: string
Read Only:
true
Maximum Length:30
Indicates how the resource is added to the account team. For example, Ad-Hoc indicates that the resource is added manually or through rule-based assignment and Territory indicates that the resource is added through territory-based assignment. -
City: string
Title:
City
Read Only:true
Maximum Length:60
The city of the resource. -
CorpCurrencyCode: string
Read Only:
true
Maximum Length:15
The corporate currency code associated with the account. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
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 who created the account team member. -
CreationDate: string
(date-time)
Read Only:
true
The date when the record was created. -
CurcyConvRateType: string
Read Only:
true
Maximum Length:30
The currency conversion rate type. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
CurrencyCode: string
Read Only:
true
Maximum Length:15
The currency code. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
EndDateActive: string
(date)
Read Only:
true
The end date the account team member is active. -
ForecastParticipationCode: string
Title:
Enable Forecasting
Read Only:true
Maximum Length:30
Default Value:REVENUE
The forecast participation type of the territory. -
FunctionCode: string
Title:
Function
Read Only:true
Maximum Length:30
The code of the function or role of the territory team member. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the account team was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the account team record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LockAssignmentFlag: boolean
Title:
Locked
Read Only:true
Maximum Length:1
Indicates that the account team member cannot be removed from the team by automatic assignment. -
MemberFunctionCode: string
Title:
Function
Read Only:true
Maximum Length:30
The code of the account team member function. -
ObjectVersionNumber: integer
(int32)
Read Only:
true
The object version number. -
OwnerFlag: boolean
Read Only:
true
Indicates if the account team member is the owner of the account. -
PartyId: integer
(int64)
The unique identifier of the account.
-
PrimaryPhoneNumber: string
Title:
Primary Phone
Read Only:true
The primary formatted phone number for the resource. -
ResourceEmailAddress: string
Read Only:
true
Maximum Length:320
The e-mail address of the resource. -
ResourceId: integer
(int64)
The unique identifier of the resource party associated with the account team.
-
ResourceName: string
Title:
Name
Read Only:true
Maximum Length:360
The full name of the account team member. -
ResourcePartyNumber: string
Title:
Registry ID
Read Only:true
Maximum Length:30
The party number of the resource. -
ResourceRoleName: string
Read Only:
true
Maximum Length:255
The role of the resource associated with the account team.. -
SalesProfileId: integer
(int64)
The unique identifier of the sales account.
-
StartDateActive: string
(date)
Read Only:
true
The start date the account team member is active. -
State: string
Title:
State
Read Only:true
Maximum Length:60
The state of the resource. -
TeamMemberId: integer
(int64)
Read Only:
true
The unique identifier of the account 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 associated with the account team.. -
TerritoryNumber: string
Title:
Number
Read Only:true
Maximum Length:30
The number of the territory. -
TerritoryOwnerFlag: boolean
Read Only:
true
Indicates if the account team member is the territory owner. -
TerritoryVersionId: integer
The unique identifier of the territory version for the resource that got assigned to the account 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 associated with the account team. -
UserLastUpdateDate: string
(date-time)
Read Only:
true
The date and time the account team member was last updated.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- AccessLevelLOVViewAccessor
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DZCA_ACCESS_LEVEL
The list of values of access level.
The following properties are defined on the LOV link relation:- Source Attribute: AccessLevelCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- AssignmentTypeLOVViewAccessor
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DZCA_ASSIGNMENT_TYPE
The list of values indicating the assignment type.
The following properties are defined on the LOV link relation:- Source Attribute: AssignmentTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- MemberFunctionLOVViewAccessor
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DZCA_RESOURCE_FUNCTION
The list of values of team member function.
The following properties are defined on the LOV link relation:- Source Attribute: MemberFunctionCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- TeamMemberFunctionLOVViewAccessor
-
Parameters:
- finder:
LookupTypeIsEnabledFinder%3BBindLookupType%3DMOT_TEAM_MEMBER_FUNCTION
The list of values for the role or function of the resource associated with the territory, such as Legal or Salesperson.
The following properties are defined on the LOV link relation:- Source Attribute: FunctionCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- TerrFcastParticipationLOVViewAccessor
-
Parameters:
- finder:
LookupTypeFinder%3BBindLookupType%3DMOT_TERR_FCAST_PARTICIPATION
The list of values for forecast participation.
The following properties are defined on the LOV link relation:- Source Attribute: ForecastParticipationCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- TerritoryFunctionLOVViewAccessor
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_MOT_TERRITORY_FUNCTION
The list of values for the function of the territory, such as Primary or Sales Support.
The following properties are defined on the LOV link relation:- Source Attribute: TerritoryFunctionCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- TerritoryTypeLOVViewAccessor
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DMOT_TERRITORY_TYPE
The list of values for the territory type, such as PRIME or OVERLAY.
The following properties are defined on the LOV link relation:- Source Attribute: TypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder: