Jump to

• Request
• Response
• Examples

Get a sales team member

get

/crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/SalesTeamMember/{TeamMemberId}

Request

Path Parameters

• 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.
• TeamMemberId(required): integer(int64)
  The unique identifier of the member of the sales account resource team.

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 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 : accounts-SalesTeamMember-item-response

Type: object

Show Source

• AccessLevelCode: string
  Title: Access

  Maximum Length: 30

  The code indicating the type of access granted to the resource as well as the managers of the organizations. The possible values are contained in the ZCA_ACCESS_LEVEL lookup.
• 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 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.
• 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 the record was created.
• CurcyConvRateType: string
  Title: Currency Conversion Rate Type

  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
  Title: Currency Code

  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)
  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 on which 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. The default value is False. When a sales account team member is added manually, this flag is defaulted to `Y'.
• MemberFunctionCode: string
  Title: Function

  Maximum Length: 30

  The lookup code indicating a sales account resource's role on the resource team such as Integrator, Executive Sponsor and Technical Account Manager. The code lookup is stored in FND_LOOKUPS.
• ObjectVersionNumber: integer (int32)
  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.
• OwnerFlag: boolean
  Title: Owner

  Default Value: false

  Indicates whether the contact is the owner.
• PartyId: integer
  The unique identifier of the party.
• PartyNumber: string
  The party number. Inactive records can't be updated.
• 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 of the relationship from external source system.
• ResourceEmailAddress: string
  Title: Resource Email

  The e-mail address of the resource.
• ResourceId: integer (int64)
  Title: Resource ID

  The resource identifier.
• 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 unique public identifier of the resource record.
• ResourcePhoneNumber: string
  Title: Phone

  Read Only: true

  The primary phone number of the sales team member.
• ResourceRoleName: string
  Title: Role

  Read Only: true

  The roles assigned to the sales team member.
• SalesProfileId: integer (int64)
  Title: Sales Account ID

  The unique identifier of the sales account.
• StartDateActive: string (date)
  Title: Start Date

  The date when the resource is associated with the sales account.
• TeamMemberId: integer (int64)
  Title: Sales Account Resource ID

  The unique identifier of the member of the sales account resource team.
• UserLastUpdateDate: string (date-time)
  Title: User Last Update Date

  The date on which the record was last updated by a specific user.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ResourcePhoneNumber":{
            "title":"Phone",
            "type":"string",
            "description":"The primary phone number of the sales team member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AccessLevelCode":{
            "title":"Access",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the type of access granted to the resource as well as the managers of the organizations. The possible values are contained in the ZCA_ACCESS_LEVEL lookup.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ResourceName":{
            "title":"Resource Name",
            "type":"string",
            "description":"The name of the sales team member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "UserLastUpdateDate":{
            "title":"User Last Update Date",
            "type":"string",
            "description":"The date on which the record was last updated by a specific user.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "CurcyConvRateType":{
            "title":"Currency Conversion Rate Type",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "AssignmentTypeCode":{
            "title":"Assignment Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating how the resource is assigned to the sales account team. The possible values are contained in the ZCA_ASSIGNMENT_TYPE lookup.",
            "nullable":true,
            "default":"MANUAL",
            "x-queryable":false
        },
        "ResourceEmailAddress":{
            "title":"Resource Email",
            "type":"string",
            "description":"The e-mail address of the resource.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PartySourceSystemReferenceValue":{
            "type":"string",
            "description":"The unique identifier of the relationship from external source system.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "PartyData"
                ]
            },
            "x-queryable":true
        },
        "StartDateActive":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the resource is associated with the sales account.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "TeamMemberId":{
            "title":"Sales Account Resource ID",
            "type":"integer",
            "description":"The unique identifier of the member of the sales account resource team.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "ResourcePartyNumber":{
            "title":"Resource Party Number",
            "type":"string",
            "description":"The unique public identifier of the resource record.",
            "nullable":true,
            "x-queryable":true
        },
        "ResourceOrgName":{
            "type":"string",
            "description":"The name of the organization that  the sales team member belongs to.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "SalesProfileId":{
            "title":"Sales Account ID",
            "type":"integer",
            "description":"The unique identifier of the sales account.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "PartySourceSystem":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "PartyData"
                ]
            },
            "x-queryable":true
        },
        "OwnerFlag":{
            "title":"Owner",
            "type":"boolean",
            "description":"Indicates whether the contact is the owner.",
            "nullable":true,
            "default":false,
            "x-queryable":false
        },
        "ResourceRoleName":{
            "title":"Role",
            "type":"string",
            "description":"The roles assigned to the sales team member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EndDateActive":{
            "title":"Archived Date",
            "type":"string",
            "description":"The date when the resource is dissociated from the sales account.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "PartyNumber":{
            "type":"string",
            "description":"The party number. Inactive records can't be updated.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "PartyData"
                ]
            },
            "x-queryable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the party.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "PartyData"
                ]
            },
            "x-queryable":true
        },
        "ResourceId":{
            "title":"Resource ID",
            "type":"integer",
            "description":"The resource identifier.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "MemberFunctionCode":{
            "title":"Function",
            "maxLength":"30",
            "type":"string",
            "description":"The lookup code indicating a sales account resource's role on the resource team such as Integrator, Executive Sponsor and Technical Account Manager. The code lookup is stored in FND_LOOKUPS.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LockAssignmentFlag":{
            "title":"Locked",
            "maxLength":"1",
            "type":"boolean",
            "description":"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'.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date on which the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login details of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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

AccessLevelLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DZCA_ACCESS_LEVEL%2CLookupCode%3D{AccessLevelCode}

The list of values indicating the type of access granted to the resource as well as managers of the organizations, such as View only and Edit.

The following properties are defined on the LOV link relation:

• Source Attribute: AccessLevelCode; Target Attribute: LookupCode
• Display Attribute: Meaning

MemberFunctionLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DZCA_RESOURCE_FUNCTION

The list of values indicating a sales account resource's role on 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

RatedCurrencies

Operation: /crmRestApi/resources/11.13.18.05/ratedCurrencies

The list of values indicating the currency code used by the sales team member, such as USD and GBP.

The following properties are defined on the LOV link relation:

• Source Attribute: CurrencyCode; Target Attribute: CurrencyCode
• Display Attribute: CurrencyCode

Back to Top

Examples

The following example shows how to get a sales team member 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/accounts/ CDRM_336853/child/SalesTeamMember/300100018233318

Example of Response Body

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

{
  "TeamMemberId" : 300100046354524,
  "SalesProfileId" : 300100046354521,
  "ResourceId" : 100010025532672,
  "MemberFunctionCode" : null,
  "AccessLevelCode" : "300",
  "LockAssignmentFlag" : true,
  "AssignmentTypeCode" : "MANUAL",
  ...
}

Back to Top