Jump to

• Request
• Response

Update an additional identifier

patch

/crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/AdditionalIdentifier/{PartyIdentifierId}

Request

Path Parameters

• PartyIdentifierId(required): integer(int64)
  The unique identifier of the party.
• 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. 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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Country: string
  Title: Issuing Country

  Maximum Length: 2

  The country code of the additional identifier. Review the list of country codes using the Manage Geographies task.
• CreatedByModule: string
  Default Value: HZ_WS

  The application module that created this organization 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.
• Description: string
  Title: Description

  Maximum Length: 240

  The description of the additional identifier.
• ExpirationDate: string (date)
  Title: Expiration Date

  The date when the additional identifier will expire.
• IssueDate: string (date)
  Title: Issue Date

  The date when the additional identifier was issued.
• IssuingAuthorityName: string
  Title: Issuing Authority Name

  Maximum Length: 500

  The name of the issuing authority of the additional identifier.
• IssuingAuthorityPartyId: integer (int64)
  The unique identifier of the issuing authority party.
• PartyId: integer (int64)
  The unique identifier of the party.
• PartyIdentifierType: string
  Title: Identifier Type

  Maximum Length: 30

  The type of the party identifier.
• PartyIdentifierValue: string
  Title: Identifier Value

  Maximum Length: 60

  The value of the party identifier.
• PartyNumber: string
  The party number of the additional identifier.
• PartySourceSystem: string
  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.
• PartySourceSystemReferenceValue: string
  The identifier for the record from an external source system.
• SourceSystem: string
  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.
• SourceSystemReferenceValue: string
  The unique identifier of the relationship from external source system.
• StateProvince: string
  Title: Issuing State

  Maximum Length: 60

  Used for certain types of identifiers such as Passports or Driving licenses based on geography setup.
• StatusCode: string
  Maximum Length: 1

  Default Value: A

  The status code of the additional identifier.

{
    "type":"object",
    "properties":{
        "Description":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of the additional identifier.",
            "nullable":true,
            "x-queryable":false
        },
        "PartySourceSystem":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "StateProvince":{
            "title":"Issuing State",
            "maxLength":"60",
            "type":"string",
            "description":"Used for certain types of identifiers such as Passports or Driving licenses based on geography setup.",
            "nullable":true
        },
        "PartyIdentifierValue":{
            "title":"Identifier Value",
            "maxLength":"60",
            "type":"string",
            "description":"The value of the party identifier.",
            "nullable":false
        },
        "IssuingAuthorityName":{
            "title":"Issuing Authority Name",
            "maxLength":"500",
            "type":"string",
            "description":"The name of the issuing authority of the additional identifier.",
            "nullable":true
        },
        "IssueDate":{
            "title":"Issue Date",
            "type":"string",
            "description":"The date when the additional identifier was issued.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "IssuingAuthorityPartyId":{
            "type":"integer",
            "description":"The unique identifier of the issuing authority party.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "StatusCode":{
            "maxLength":"1",
            "type":"string",
            "description":"The status code of the additional identifier.",
            "nullable":false,
            "default":"A"
        },
        "SourceSystemReferenceValue":{
            "type":"string",
            "description":"The unique identifier of the relationship from external source system.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyIdentifierType":{
            "title":"Identifier Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the party identifier.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PartySourceSystemReferenceValue":{
            "type":"string",
            "description":"The identifier for the record from an external source system.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyNumber":{
            "type":"string",
            "description":"The party number of the additional identifier.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the party.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The date when the additional identifier will expire.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "Country":{
            "title":"Issuing Country",
            "maxLength":"2",
            "type":"string",
            "description":"The country code of the additional identifier. Review the list of country codes using the Manage Geographies task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CreatedByModule":{
            "type":"string",
            "description":"The application module that created this organization 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.",
            "nullable":true,
            "default":"HZ_WS"
        },
        "SourceSystem":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Back to Top

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.

Body ()

Root Schema : contacts-AdditionalIdentifier-item-response

Type: object

Show Source

• Country: string
  Title: Issuing Country

  Maximum Length: 2

  The country code of the additional identifier. Review the list of country codes using the Manage Geographies task.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the additional identifier.
• CreatedByModule: string
  Default Value: HZ_WS

  The application module that created this organization 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)
  Read Only: true

  The date when the additional identifier was created.
• Description: string
  Title: Description

  Maximum Length: 240

  The description of the additional identifier.
• ExpirationDate: string (date)
  Title: Expiration Date

  The date when the additional identifier will expire.
• IssueDate: string (date)
  Title: Issue Date

  The date when the additional identifier was issued.
• IssuingAuthorityName: string
  Title: Issuing Authority Name

  Maximum Length: 500

  The name of the issuing authority of the additional identifier.
• IssuingAuthorityPartyId: integer (int64)
  The unique identifier of the issuing authority party.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the additional identifier was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the additional identifier.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the additional identifier.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  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.
• PartyId: integer (int64)
  The unique identifier of the party.
• PartyIdentifierId: integer (int64)
  Read Only: true

  The unique identifier of the party.
• PartyIdentifierType: string
  Title: Identifier Type

  Maximum Length: 30

  The type of the party identifier.
• PartyIdentifierValue: string
  Title: Identifier Value

  Maximum Length: 60

  The value of the party identifier.
• PartyNumber: string
  The party number of the additional identifier.
• PartySourceSystem: string
  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.
• PartySourceSystemReferenceValue: string
  The identifier for the record from an external source system.
• SourceSystem: string
  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.
• SourceSystemReferenceValue: string
  The unique identifier of the relationship from external source system.
• StateProvince: string
  Title: Issuing State

  Maximum Length: 60

  Used for certain types of identifiers such as Passports or Driving licenses based on geography setup.
• StatusCode: string
  Maximum Length: 1

  Default Value: A

  The status code of the additional identifier.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the additional identifier was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of the additional identifier.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyIdentifierValue":{
            "title":"Identifier Value",
            "maxLength":"60",
            "type":"string",
            "description":"The value of the party identifier.",
            "nullable":false,
            "x-queryable":true
        },
        "IssuingAuthorityPartyId":{
            "type":"integer",
            "description":"The unique identifier of the issuing authority party.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":"1",
            "type":"string",
            "description":"The status code of the additional identifier.",
            "nullable":false,
            "default":"A",
            "x-queryable":true
        },
        "PartySourceSystemReferenceValue":{
            "type":"string",
            "description":"The identifier for the record from an external source system.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyIdentifierId":{
            "type":"integer",
            "description":"The unique identifier of the party.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CreatedByModule":{
            "type":"string",
            "description":"The application module that created this organization 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.",
            "nullable":true,
            "default":"HZ_WS",
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the additional identifier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the additional identifier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartySourceSystem":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "StateProvince":{
            "title":"Issuing State",
            "maxLength":"60",
            "type":"string",
            "description":"Used for certain types of identifiers such as Passports or Driving licenses based on geography setup.",
            "nullable":true,
            "x-queryable":true
        },
        "IssuingAuthorityName":{
            "title":"Issuing Authority Name",
            "maxLength":"500",
            "type":"string",
            "description":"The name of the issuing authority of the additional identifier.",
            "nullable":true,
            "x-queryable":true
        },
        "IssueDate":{
            "title":"Issue Date",
            "type":"string",
            "description":"The date when the additional identifier was issued.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "SourceSystemReferenceValue":{
            "type":"string",
            "description":"The unique identifier of the relationship from external source system.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyIdentifierType":{
            "title":"Identifier Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the party identifier.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PartyNumber":{
            "type":"string",
            "description":"The party number of the additional identifier.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the party.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The date when the additional identifier will expire.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "Country":{
            "title":"Issuing Country",
            "maxLength":"2",
            "type":"string",
            "description":"The country code of the additional identifier. Review the list of country codes using the Manage Geographies task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SourceSystem":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the additional identifier was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the additional identifier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

Countries

Operation: /crmRestApi/resources/11.13.18.05/fndTerritories

Parameters:

• finder: ObsoleteEnabledFlagFinder%3BBindObsoleteFlag%3DN%2CBindEnabledFlag%3DY

The territories resource is used to get a list of ISO standard territories.

PartyIdentifierTypes

Operation: /crmRestApi/resources/11.13.18.05/nameAndIdTypes

Parameters:

• finder: PartyIdentifierFinder

The name and types resource is used to view the additional name and ID types.

Back to Top