1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Hub Persons
  4. Additional Identifiers

Get all additional identifiers

get

/crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/AdditionalIdentifier

Request

Path Parameters
  • The unique alternate identifier for the person 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
  • 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 an additional identifier with the specified primary key.
      Finder Variables:
      • PartyIdentifierId; integer; The unique identifier of the additional identifier.
  • 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:
    • CreatedBy; string; The user who created the additional identifier.
    • CreatedByModule; string; The application module that created this organization record. The default value is HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. You can review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups.
    • CreationDate; string; The date when the additional identifier was created.
    • IssuingAuthorityName; string; The name of the issuing authority of the additional identifier.
    • IssuingAuthorityPartyId; integer; The unique identifier of the issuing authority party.
    • LastUpdateDate; string; The date when the additional identifier was last updated.
    • LastUpdateLogin; string; The login of the user who last updated the additional identifier.
    • LastUpdatedBy; string; The user who last updated the additional identifier.
    • PartyId; integer; The unique identifier of the party.
    • PartyIdentifierId; integer; The unique identifier of the party.
    • PartyIdentifierType; string; The type of party identifier.
    • PartyIdentifierValue; string; The value of the party identifier.
    • StateProvince; string; Used for certain types of identifiers such as Passports or Driving licenses based on geography setup.
    • StatusCode; string; The status code of the additional identifier.
  • 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 : hubPersons-AdditionalIdentifier
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : hubPersons-AdditionalIdentifier-item-response
Type: object
Show Source
  • Title: Issuing Country
    Maximum Length: 2
    The country code of the additional identifier. It is used to review the list of country codes using the Manage Geographies task.
  • Read Only: true
    Maximum Length: 64
    The user who created the additional identifier.
  • Default Value: HZ_WS
    The application module that created this organization record. The default value is HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. You can review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups.
  • Read Only: true
    The date when the additional identifier was created.
  • Title: Description
    Maximum Length: 240
    The description of the additional identifier.
  • Title: Expiration Date
    The date when the additional identifier will expire.
  • Title: Issue Date
    The date when the additional identifier was issued.
  • Title: Issuing Authority Name
    Maximum Length: 500
    The name of the issuing authority of the additional identifier.
  • The unique identifier of the issuing authority party.
  • Read Only: true
    The date when the additional identifier was last updated.
  • Read Only: true
    Maximum Length: 64
    The user who last updated the additional identifier.
  • Read Only: true
    Maximum Length: 32
    The login of the user who last updated the additional identifier.
  • Links
  • Read Only: true
    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.
  • The unique identifier of the party.
  • Read Only: true
    The unique identifier of the party.
  • Title: Identifier Type
    Maximum Length: 30
    The type of party identifier.
  • Title: Identifier Value
    Maximum Length: 60
    The value of the party identifier.
  • The party number. Inactive records can't be updated.
  • 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 identifier for the record from an external source system.
  • The name of external source system, which is defined by an admin as part of system setup. It is part of alternate key (along with SourceSystemReference), and is mandatory if PK or partyNumberBusinessKey is not passed in update.
  • The unique identifier of the relationship from external source system.
  • Title: Issuing State
    Maximum Length: 60
    Used for certain types of identifiers such as Passports or Driving licenses based on geography setup.
  • Maximum Length: 1
    Default Value: A
    The status code of the additional identifier.
Back to Top

Examples

The following example shows how to get all additional identifiers by submitting a get request on the REST resource using cURL.

cURL Command

curl --location 'https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hubPersons/CONTACT-1000/child/AdditionalIdentifier' -X GET

Example of Response Body

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

{
    "items": [
        {
            "PartyIdentifierId": 999990014075736,
            "PartyId": 2440,
            "PartyNumber": "CONTACT-1000",
            "PartySourceSystem": null,
            "PartySourceSystemReferenceValue": null,
            "Description": null,
            "PartyIdentifierType": "DRIVERS_LICENSE",
            "PartyIdentifierValue": "999990014075736",
            "IssueDate": null,
            "ExpirationDate": null,
            "IssuingAuthorityPartyId": null,
            "IssuingAuthorityName": null,
            "Country": null,
            "StatusCode": "A",
            "ObjectVersionNumber": 1,
            "SourceSystem": null,
            "SourceSystemReferenceValue": null,
            "CreatedBy": "-1",
            "CreatedByModule": "AMS",
            "CreationDate": "2008-09-08T15:29:27+00:00",
            "LastUpdateDate": "2008-09-08T15:29:27+00:00",
            "LastUpdateLogin": "-1",
            "LastUpdatedBy": "-1",
            "StateProvince": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hubPersons/CONTACT-1000/child/AdditionalIdentifier/999990014075736",
                    "name": "AdditionalIdentifier",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hubPersons/CONTACT-1000/child/AdditionalIdentifier/999990014075736",
                    "name": "AdditionalIdentifier",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hubPersons/CONTACT-1000",
                    "name": "hubPersons",
                    "kind": "item"
                }
            ]
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hubPersons/CONTACT-1000/child/AdditionalIdentifier",
            "name": "AdditionalIdentifier",
            "kind": "collection"
        }
    ]
}
Back to Top