Create a customer classification
post
/crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/CustomerClassification
Request
Path Parameters
-
PartyNumber(required): string
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.
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.
-
Upsert-Mode:
When set to true, the server will perform an Upsert operation instead of a Create. In an Upsert operation the server attempts to find an existing resource that matches the payload. If found, the server updates the existing resource instead of creating a new one. If not found, or when set to false (the default), a Create is performed.
Supported Media Types
- application/json
The following table describes the body parameters in the request for this task.
Root Schema : schema
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 of the customer. For example, High Technology, Customer, or Telecom. -
CreatedByModule: string
Title:
Created by Module
Maximum Length:30
The application module that created the customer classification. 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. -
EndDateActive: string
(date)
Title:
End Date
The date from which the classification code is no longer valid. -
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
The unique identifier from external source system for the account, contact or household with which the classification is associated. -
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.
Response
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 : contacts-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 of the customer. 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. 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. 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
The unique 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
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.