Get all customer classifications
get
/crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/CustomerClassification
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.
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 -
finder: string
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 household using unique identifier for the customer classification assignment.
Finder Variables:- CodeAssignmentId; integer; The unique identifier of the classification code assignment.
- PrimaryKey: Finds a household using unique identifier for the customer classification assignment.
-
limit: integer
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.
-
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 -
offset: integer
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.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
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
-
q: string
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; The code indicating the classification category. For example, High Technology, Customer, or Telecom.
- CodeAssignmentId; integer; The unique identifier for the customer classification assignment.
- ConflictId; integer; The unique identifier of the conflict for the classification record. 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 with which the classification is associated.
- PartyNumber; string; The unique alternate identifier of the account, contact, or household with which the classification is associated.
- 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; Indicates 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.
-
totalResults: boolean
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
-
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 TopResponse
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-CustomerClassification
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : households-CustomerClassification-item-response
Type:
Show Source
object
-
ClassCategory: string
Title:
Classification Category
Maximum Length:30
The name of the classification category. -
ClassCode: string
Title:
Classification Code
Maximum Length:30
The code indicating the classification category. For example, High Technology, Customer, or Telecom. -
CodeAssignmentId: integer
(int64)
Title:
Code Assignment ID
Read Only:true
The unique identifier for the customer classification assignment. -
ConflictId: integer
(int64)
Read Only:
true
Default Value:0
The unique identifier of the conflict for the classification record. This number is used by mobile or portable applications that consume the web service. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreatedByModule: string
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. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
EndDateActive: string
(date)
Title:
End Date
The date from which the classification code is no longer valid. -
IsAuxClassificationFlag: boolean
Title:
Auxiliary Classification Status
Read Only:true
Indicates whether the classification category is an user-defined group classification category. The default value is false. -
IsIndustryFlag: boolean
Title:
Industry Type Status
Read Only:true
Indicates whether the classification category is an industry group classification category. The default value is false. -
IsOrgTypeFlag: boolean
Title:
Organization Type Status
Read Only:true
Indicates whether the classification category is an organization type classification category. The default value is false. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date 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 of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PartyId: integer
(int64)
Title:
Party ID
The unique Identifier of the account, contact or household with which the classification is associated. -
PartyNumber: string
Title:
Party Number
Maximum Length:30
The unique alternate identifier of the account, contact, or household with which the classification is associated. -
PartySourceSystem: string
Title:
Party Source System
The name of the external source system of the account, contact, or household with which the classification is associated. -
PartySourceSystemReferenceValue: string
Title:
Party Source System Reference Value
Identifier from external source system for the account, contact or household with which the classification is associated. -
PartyType: string
Title:
Party Type
Read Only:true
Maximum Length:30
Indicates the type of the party, such as account, contact, or household. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Default Value:false
Indicates if the customer classification is the primary classification. The default value is false. -
SourceSystem: string
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. -
SourceSystemReferenceValue: string
Title:
Source System Reference Value
The unique identifier for the customer classification in the external source. -
StartDateActive: string
(date)
Title:
Start Date
The date on which the customer classification was created. -
Status: string
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.
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.