Update a customer classification
patch
/crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/CustomerClassification/{CodeAssignmentId}
Request
Path Parameters
-
CodeAssignmentId(required): integer(int64)
The unique identifier for the customer classification assignment.
-
PartyNumber(required): string
The unique alternate identifier for the organization 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.
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
EndDateActive: string
(date)
Title:
End Date
The date on which the classification code is no longer valid. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Default Value:false
Indicator to show if the current code is the primary classification code. -
SourceSystem: string
Title:
Source System
The name of external source system for the class category denoted by a code, which is defined by an administrator as part of system setup. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify a class category. -
SourceSystemReferenceValue: string
Title:
Source System Reference Value
The unique identifier for the class category from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify a class category. -
Status: string
Title:
Status
Maximum Length:1
Default Value:A
Indicates whether the code assignment is active or inactive, such as A for active and I for inactive.
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.
Root Schema : hubOrganizations-CustomerClassification-item-response
Type:
Show Source
object
-
ClassCategory: string
Title:
Classification Category
Maximum Length:30
Name of the classification category. -
ClassCode: string
Title:
Classification Code
Maximum Length:30
A valid classification code corresponding to the classification category. -
ClassCodeMeaning: string
Title:
Classification Code Meaning
Read Only:true
Maximum Length:80
A valid classification code meaning corresponding to the classification code. -
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. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The name of the user who created the record. -
CreatedByModule: string
Title:
Created by Module
Maximum Length:30
The application or module that created the record. The default value is HZ_WS for all web service based creation. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Indicates the date and time when the record is created. -
EndDateActive: string
(date)
Title:
End Date
The date on which the classification code is no longer valid. -
IsAuxClassificationFlag: boolean
Title:
Auxiliary Classification Status
Read Only:true
Indicates whether the classification category is a custom group classification category. -
IsIndustryFlag: boolean
Title:
Industry Type Status
Read Only:true
Indicates whether the classification category is an industry group classification category. -
IsOrgTypeFlag: boolean
Title:
Organization Type Status
Read Only:true
Indicates whether the classification category is an organization type classification category. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Indicates the date and time 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
Indicates the session login associated to 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 account, contact, or household to which the classification category and classification code is associated. -
PartyNumber: string
Title:
Party Number
Maximum Length:30
The unique alternate identifier of the account, contact, or household to which the classification category and classification code is associated. Inactive records can't be updated. -
PartySourceSystem: string
Title:
Party Source System
The name of the external source system of the account, contact, or household with which the classification category and classification code is associated. -
PartySourceSystemReferenceValue: string
Title:
Party Source System Reference Value
The identifier from external source system for the account, contact, or household with which the classification category and classification code 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
Indicator to show if the current code is the primary classification code. -
SourceSystem: string
Title:
Source System
The name of external source system for the class category denoted by a code, which is defined by an administrator as part of system setup. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify a class category. -
SourceSystemReferenceValue: string
Title:
Source System Reference Value
The unique identifier for the class category from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify a class category. -
StartDateActive: string
(date)
Title:
Start Date
The date on which the classification becomes valid. -
Status: string
Title:
Status
Maximum Length:1
Default Value:A
Indicates whether the code assignment is active or inactive, such as A for active and I for inactive.
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.
Links
- ClassCodesVA
-
Operation: /crmRestApi/resources/11.13.18.05/classCodesParameters:
- finder:
ClassCategoryFinder%3BBindClassCategory%3D{ClassCategory}
The following properties are defined on the LOV link relation:- Source Attribute: ClassCode; Target Attribute: ClassCode
- Display Attribute: ClassCodeMeaning
- finder: