Create a sales team member
post
/crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/SalesTeamMember
Request
Path Parameters
-
PartyNumber(required): string
The unique primary identifier for the household party. The profile option HZ_GENERATE_PARTY_NUMBER controls whether the attribute value can be system generated or user-provided during create. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Profile Options task.
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.
-
Upsert-Mode:
When set to true, the server will perform an Upsert operation instead of a Create. In an Upsert operation the server attempts to find an existing resource that matches the payload. If found, the server updates the existing resource instead of creating a new one. If not found, or when set to false (the default), a Create is performed.
Supported Media Types
- application/json
The following table describes the body parameters in the request for this task.
Root Schema : schema
Type:
Show Source
object
-
AccessLevelCode: string
Title:
Access
Maximum Length:30
The code indicating the level of access granted to the resource as well as managers of the organizations. The possible values are defined in the ZCA_ACCESS_LEVEL lookup. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task. -
AssignmentTypeCode: string
Title:
Assignment Type
Maximum Length:30
Default Value:MANUAL
The code indicating how the resource is assigned to the sales account team. The possible values are contained in the ZCA_ASSIGNMENT_TYPE lookup. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
The corporate currency code associated with the sales team member. 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. -
CurcyConvRateType: string
Title:
Currency Conversion Rate Type
Maximum Length:30
The currency conversion rate type associated with the address. A list of valid values is 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
Title:
Currency Code
Maximum Length:15
The currency code associated with the sales team member of the household object. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
EndDateActive: string
(date)
Title:
Archived Date
The date when the resource is dissociated from the sales account. -
LockAssignmentFlag: boolean
Title:
Locked
Maximum Length:1
Default Value:false
Indicates if the automatic territory assignment can be set. If the value is True, then the automatic territory assignment cannot remove the sales account team resource. When a sales account team member is added manually, this flag is defaulted to `Y'. -
MemberFunctionCode: string
Title:
Function
Maximum Length:30
The code indicating the role of a sales team member in the resource team such as Integrator, Executive Sponsor, and Technical Account Manager. A list of accepted values is defined in the lookup FND_LOOKUPS. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
ObjectVersionNumber: integer
(int32)
The number used to implement optimistic locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
-
OwnerFlag: boolean
Title:
Owner
Default Value:false
Indicates whether the resource is the owner. -
PartyId: integer
The unique identifier of the associated party record for sales team member record.
-
PartyNumber: string
The public identifier of the associated party record.
-
PartySourceSystem: string
The name of external source system of the associated party record.
-
PartySourceSystemReferenceValue: string
The unique identifier from external source system of the associated party record.
-
ResourceEmailAddress: string
Title:
Resource Email
The email address of the resource. -
ResourceId: integer
(int64)
Title:
Resource ID
The unique identifier of the household resource. -
ResourcePartyNumber: string
Title:
Resource Party Number
The alternate key identifier of the resource that this team member belongs to. -
SalesProfileId: integer
(int64)
Title:
Sales Account ID
The unique identifier for the sales account. -
StartDateActive: string
(date)
Title:
Start Date
The date on which the resource is associated with a sales account. -
TeamMemberId: integer
(int64)
Title:
Sales Account Resource ID
The unique identifier of the member of the sales accounts resource team. -
UserLastUpdateDate: string
(date-time)
Title:
User Last Update Date
The date and time when the record was last updated. This value is different from LAST_UPDATE_DATE if the update originally happened in a different database.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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 : households-SalesTeamMember-item-response
Type:
Show Source
object
-
AccessLevelCode: string
Title:
Access
Maximum Length:30
The code indicating the level of access granted to the resource as well as managers of the organizations. The possible values are defined in the ZCA_ACCESS_LEVEL lookup. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task. -
AssignmentTypeCode: string
Title:
Assignment Type
Maximum Length:30
Default Value:MANUAL
The code indicating how the resource is assigned to the sales account team. The possible values are contained in the ZCA_ASSIGNMENT_TYPE lookup. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
The corporate currency code associated with the sales team member. 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. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the record was created. -
CurcyConvRateType: string
Title:
Currency Conversion Rate Type
Maximum Length:30
The currency conversion rate type associated with the address. A list of valid values is 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
Title:
Currency Code
Maximum Length:15
The currency code associated with the sales team member of the household object. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
EndDateActive: string
(date)
Title:
Archived Date
The date when the resource is dissociated from the sales account. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login details 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
Maximum Length:1
Default Value:false
Indicates if the automatic territory assignment can be set. If the value is True, then the automatic territory assignment cannot remove the sales account team resource. When a sales account team member is added manually, this flag is defaulted to `Y'. -
MemberFunctionCode: string
Title:
Function
Maximum Length:30
The code indicating the role of a sales team member in the resource team such as Integrator, Executive Sponsor, and Technical Account Manager. A list of accepted values is defined in the lookup FND_LOOKUPS. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
ObjectVersionNumber: integer
(int32)
The number used to implement optimistic locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
-
OwnerFlag: boolean
Title:
Owner
Default Value:false
Indicates whether the resource is the owner. -
PartyId: integer
The unique identifier of the associated party record for sales team member record.
-
PartyNumber: string
The public identifier of the associated party record.
-
PartySourceSystem: string
The name of external source system of the associated party record.
-
PartySourceSystemReferenceValue: string
The unique identifier from external source system of the associated party record.
-
ResourceEmailAddress: string
Title:
Resource Email
The email address of the resource. -
ResourceId: integer
(int64)
Title:
Resource ID
The unique identifier of the household resource. -
ResourceName: string
Title:
Resource Name
Read Only:true
The name of the sales team member. -
ResourceOrgName: string
Read Only:
true
The name of the organization that the sales team member belongs to. -
ResourcePartyNumber: string
Title:
Resource Party Number
The alternate key identifier of the resource that this team member belongs to. -
ResourcePhoneNumber: string
Title:
Phone
Read Only:true
The primary phone number of the sales team member. -
ResourceRoleName: string
Title:
Role
Read Only:true
The names of the roles assigned to the sales team member. -
SalesProfileId: integer
(int64)
Title:
Sales Account ID
The unique identifier for the sales account. -
StartDateActive: string
(date)
Title:
Start Date
The date on which the resource is associated with a sales account. -
TeamMemberId: integer
(int64)
Title:
Sales Account Resource ID
The unique identifier of the member of the sales accounts resource team. -
UserLastUpdateDate: string
(date-time)
Title:
User Last Update Date
The date and time when the record was last updated. This value is different from LAST_UPDATE_DATE if the update originally happened in a different database.
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
- AccessLevelLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DZCA_ACCESS_LEVEL%2CLookupCode%3D{AccessLevelCode}
The list of values for the access level that determine the type of access granted, such as Edit or Full.
The following properties are defined on the LOV link relation:- Source Attribute: AccessLevelCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- MemberFunctionLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DZCA_RESOURCE_FUNCTION
The list of values indicating the role of a sales team member in the resource team such as Integrator, Executive Sponsor, and Technical Account Manager.
The following properties are defined on the LOV link relation:- Source Attribute: MemberFunctionCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- RatedCurrencies
-
The list of values for the corporate currency code, such as US Dollar or Indian Rupee.
The following properties are defined on the LOV link relation:- Source Attribute: CurrencyCode; Target Attribute: CurrencyCode
- Display Attribute: CurrencyCode