1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Accounts
  4. Aux Classifications

Get all customer classifications

get

/crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/CustomerClassification

Request

Path Parameters
  • 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
  • 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 customer classification with the primary key information.
      Finder Variables:
      • CodeAssignmentId; integer; The unique identifier for the customer classification assignment.
  • 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:
    • ClassCategory; string; The name of the classification category.
    • ClassCode; string; A valid classification code corresponding to the classification category.
    • ClassCodeMeaning; string; A valid classification code meaning corresponding to the classification code.
    • CodeAssignmentId; integer; The unique identifier for the customer classification assignment.
    • ConflictId; integer; The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service.
    • CreatedBy; string; The user who created the record.
    • CreatedByModule; string; The application module that created the customer classification record. Defaulted to value 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 record was created.
    • EndDateActive; string; The date from which the classification code is no longer valid.
    • IsAuxClassificationFlag; boolean; Indicates whether the classification category is an user-defined group classification category. The default value is false.
    • IsIndustryFlag; boolean; Indicates whether the classification category is an industry group classification category. The default value is false.
    • IsOrgTypeFlag; boolean; Indicates whether the classification category is an organization type classification category. The default value is false.
    • LastUpdateDate; string; The date when the record was last updated.
    • LastUpdateLogin; string; The login of the user who last updated the record.
    • LastUpdatedBy; string; The user who last updated the record.
    • PartyId; integer; The unique Identifier of the account, contact or household to which the classification is associated.
    • PartyNumber; string; The unique alternate identifier of the account, contact, or household to which the classification is associated. Inactive records can't be updated.
    • PartySourceSystem; string; The name of the external source system of the account, contact, or household with which the classification is associated.
    • PartySourceSystemReferenceValue; string; Identifier from external source system for the account, contact or household with which the classification is associated.
    • PartyType; string; The type of the party, such as account, contact, or household.
    • PrimaryFlag; boolean; Indicates if the customer classification is the primary classification. The default value is false.
    • SourceSystem; string; The name of external source system where the customer classification is imported from. The values are configured in Setup and Maintenance work area, Manage Trading Community Source Systems task.
    • SourceSystemReferenceValue; string; The unique identifier for the customer classification in the external source.
    • StartDateActive; string; The date on which the customer classification was created.
    • Status; string; Indicates if the code assignment is active or inactive. The code assignment is active if the value is A, and inactive if the value is I.
  • 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 : accounts-CustomerClassification
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : accounts-CustomerClassification-item-response
Type: object
Show Source
  • Title: Classification Category
    Maximum Length: 30
    The name of the classification category.
  • Title: Classification Code
    Maximum Length: 30
    A valid classification code corresponding to the classification category.
  • Title: Classification Code Meaning
    Read Only: true
    Maximum Length: 80
    A valid classification code meaning corresponding to the classification code.
  • Title: Code Assignment ID
    Read Only: true
    The unique identifier for the customer classification assignment.
  • Read Only: true
    Default Value: 0
    The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the record.
  • Title: Created by Module
    Maximum Length: 30
    The application module that created the customer classification record. Defaulted to value 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.
  • Title: Creation Date
    Read Only: true
    The date when the record was created.
  • Title: End Date
    The date from which the classification code is no longer valid.
  • Title: Auxiliary Classification Status
    Read Only: true
    Indicates whether the classification category is an user-defined group classification category. The default value is false.
  • Title: Industry Type Status
    Read Only: true
    Indicates whether the classification category is an industry group classification category. The default value is false.
  • Title: Organization Type Status
    Read Only: true
    Indicates whether the classification category is an organization type classification category. The default value is false.
  • Title: Last Updated Date
    Read Only: true
    The date when the record was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the record.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The login of the user who last updated the record.
  • Links
  • Title: Party ID
    The unique Identifier of the account, contact or household to which the classification is associated.
  • Title: Party Number
    Maximum Length: 30
    The unique alternate identifier of the account, contact, or household to which the classification is associated. Inactive records can't be updated.
  • Title: Party Source System
    The name of the external source system of the account, contact, or household with which the classification is associated.
  • Title: Party Source System Reference Value
    Identifier from external source system for the account, contact or household with which the classification is associated.
  • Title: Party Type
    Read Only: true
    Maximum Length: 30
    The type of the party, such as account, contact, or household.
  • Title: Primary
    Maximum Length: 1
    Default Value: false
    Indicates if the customer classification is the primary classification. The default value is false.
  • Title: Source System
    The name of external source system where the customer classification is imported from. The values are configured in Setup and Maintenance work area, Manage Trading Community Source Systems task.
  • Title: Source System Reference Value
    The unique identifier for the customer classification in the external source.
  • Title: Start Date
    The date on which the customer classification was created.
  • Title: Status
    Maximum Length: 1
    Default Value: A
    Indicates if the code assignment is active or inactive. The code assignment is active if the value is A, and inactive if the value is I.
Back to Top

Examples

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

Example of Response Body

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

{
  "items": [
    {
      "PartyId": 300100091050713,
      "PartyNumber": "CDRM_517466",
      "PartySourceSystem": null,
      "PartySourceSystemReferenceValue": null,
      "CodeAssignmentId": 300100091102292,
      "ClassCategory": "ORGANIZATION_TYPE",
      "ClassCode": "A: Commercial",
      "StartDateActive": "2016-07-27",
      "EndDateActive": "4712-12-31",
      "CreatedBy": "SALES_ADMIN",
      "CreatedByModule": "HZ_WS",
      "CreationDate": "2016-07-27T02:30:26-07:00",
      "LastUpdateDate": "2016-07-27T02:30:26-07:00",
      "LastUpdateLogin": "3882C39353CC51E4E053B80AF40A2F43",
      "LastUpdatedBy": "SALES_ADMIN",
      "Status": "A",
      "PrimaryFlag": true,
      "IsAuxClassificationFlag": "false",
      "IsOrgTypeFlag": "true",
      "IsIndustryFlag": "false",
      "PartyType": "ORGANIZATION",
      "SourceSystem": null,
      "SourceSystemReferenceValue": null,
      "links": [
        {
          "rel": "self",
          "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accounts/CDRM_517466/child/CustomerClassification/300100091102292",
          "name": "CustomerClassification",
          "kind": "item",
          "properties": {
            "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000027372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C547970654964787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000C78"
          }
        },
        {
          "rel": "canonical",
          "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accounts/CDRM_517466/child/CustomerClassification/300100091102292",
          "name": "CustomerClassification",
          "kind": "item"
        },
        {
          "rel": "parent",
          "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accounts/CDRM_517466",
          "name": "accounts",
          "kind": "item"
        }
      ]
    }
  ],
  "count": 1,
  "hasMore": false,
  "limit": 25,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accounts/CDRM_517466/child/CustomerClassification",
      "name": "CustomerClassification",
      "kind": "collection"
    }
  ]
}
Back to Top