1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Contacts
  4. Sales Account Resources

Get all sales team members

get

/crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/SalesTeamMember

Request

Path Parameters
  • The alternate key identifier for the contact 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. Inactive records can't be updated.
Query Parameters
  • 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>
  • 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).
  • 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
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • PrimaryKey: Finds a sales team member by the specified team member identifier.
      Finder Variables:
      • TeamMemberId; integer; The surrogate primary key for the member of the sales account resource team.
    • SalesAccountIdAndResourceIdAltKey: Finds sales team members by unique identifier for account and resource.
      Finder Variables:
      • ResourceId; integer; The unique identifier of the resource.
      • SalesProfileId; integer; The unique identifier of the sale profile of the resource.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • 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
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • LockAssignmentFlag; boolean; 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. The default value is False. When a sales account team member is added manually, this flag is defaulted to `Y'.
    • MemberFunctionCode; string; 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.
    • PartyId; integer; The unique identifier of the party.
    • PartyNumber; string; The unique identification number for the party.
    • PartySourceSystem; string; The name of external source system of the account, contact or household with which the address is associated. Part of alternate key for the account, contact or household record (along with PartyourceSystemReferenceValue). One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact or household record with which the address is associated. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems.
    • PartySourceSystemReferenceValue; string; The unique identifier from external source system for the account, contact or household with which the address is associated. Part of alternate key (along with PartySourceSystem). One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact or household record with which the address is associated.
    • ResourceEmailAddress; string; The e-mail address of the resource.
    • ResourcePartyNumber; string; The alternate key identifier of the resource that this team member belongs to.
    • TeamMemberId; integer; The unique identifier of the sales team member.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : contacts-SalesTeamMember
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : contacts-SalesTeamMember-item-response
Type: object
Show Source
  • 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.
  • Title: Assignment Type
    Maximum Length: 30
    Default Value: MANUAL
    The code indicating how the resource is assigned to the sales account team. A list of accepted values is defined in the lookup ZCA_ASSIGNMENT_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.
  • 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.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the sales team member record.
  • Title: Creation Date
    Read Only: true
    The date and time when the sale team member record was created.
  • Title: Currency Conversion Rate Type
    Maximum Length: 30
    The currency conversion rate type associated with the sales team member. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
  • Title: Currency Code
    Maximum Length: 15
    The 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 value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
  • Title: Archived Date
    Date on which this sales team member is no longer active.
  • Title: Last Updated Date
    Read Only: true
    The date when the sales team member record was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the sales team member record.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The session login associated to the user who last updated the sales team member record.
  • Links
  • 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. The default value is False. When a sales account team member is added manually, this flag is defaulted to `Y'.
  • 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.
  • The number used to implement locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.
  • Title: Owner
    Default Value: false
    Indicates whether the contact is the owner of the contract.
  • The unique identifier of the party.
  • The unique identification number for the party.
  • The name of external source system of the account, contact or household with which the address is associated. Part of alternate key for the account, contact or household record (along with PartyourceSystemReferenceValue). One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact or household record with which the address is associated. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems.
  • The unique identifier from external source system for the account, contact or household with which the address is associated. Part of alternate key (along with PartySourceSystem). One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact or household record with which the address is associated.
  • Title: Resource Email
    The e-mail address of the resource.
  • Title: Resource ID
    The unique identifier of the household resource.
  • Title: Resource Name
    Read Only: true
    The name of the sales team member.
  • Read Only: true
    The name of the organization that the sales team member belongs to.
  • Title: Resource Party Number
    The alternate key identifier of the resource that this team member belongs to.
  • Title: Phone
    Read Only: true
    The primary phone number of the sales team member.
  • Title: Role
    Read Only: true
    The names of the roles assigned to the sales team member.
  • Title: Sales Account ID
    The unique identifier of the sales profile of the resource.
  • Title: Start Date
    Date on which this sales team member becomes active.
  • Title: Sales Account Resource ID
    The unique identifier of the sales team member.
  • 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.
Back to Top

Examples

The following example shows how to get all sales team members by submitting a get request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contacts/CDRM_2515/child/SalesTeamMember/

Example of Response Body

The following shows an example of the response body in JSON format.

{
    "items": [
        {
            "TeamMemberId": 300100057102254,
            "SalesProfileId": 100100003205750,
            "ResourceId": 100010032752785,
            "MemberFunctionCode": null,
            "AccessLevelCode": "300",
            "LockAssignmentFlag": true,
            "AssignmentTypeCode": "MANUAL",
            "ResourcePartyNumber": "100010032752785",
            "ResourceEmailAddress": "smith.jones@oracle.com",
            
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    ...
}
Back to Top