Jump to

• Request
• Response

Update a national identifier

patch

/fscmRestApi/resources/11.13.18.05/hedPersonProfiles/{PartyId}/child/nationalIdentifiers/{nationalIdentifiersUniqID}

Request

Path Parameters

• PartyId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• nationalIdentifiersUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the National Identifiers resource and used to uniquely identify an instance of National Identifiers. The client should not generate the hash key value. Instead, the client should query on the National Identifiers collection resource in order to navigate to a specific instance of National Identifiers to get the hash key.

Header Parameters

• Metadata-Context: string
  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: string
  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

• Authority: string
  Title: Authority

  Maximum Length: 100

  The authority who issues the person national identifier.
• ExpirationDate: string (date)
  Title: Expiration Date

  The expiration date of the person national identifier.
• IdentifierValue: string
  Title: ID Number

  Maximum Length: 30

  The identifier value of the person.
• IssueDate: string (date)
  Title: Issue Date

  The issue date of the person national identifier.
• Notes: string
  Title: Note

  Maximum Length: 240

  The additional notes for person national identifier.

{
    "type":"object",
    "properties":{
        "Authority":{
            "title":"Authority",
            "maxLength":100,
            "type":"string",
            "description":"The authority who issues the person national identifier.",
            "nullable":true
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the person national identifier.",
            "format":"date",
            "nullable":true
        },
        "IdentifierValue":{
            "title":"ID Number",
            "maxLength":30,
            "type":"string",
            "description":"The identifier value of the person.",
            "nullable":false
        },
        "IssueDate":{
            "title":"Issue Date",
            "type":"string",
            "description":"The issue date of the person national identifier.",
            "format":"date",
            "nullable":true
        },
        "Notes":{
            "title":"Note",
            "maxLength":240,
            "type":"string",
            "description":"The additional notes for person national identifier.",
            "nullable":true
        }
    }
}

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 : hedPersonProfiles-nationalIdentifiers-item-response

Type: object

Show Source

• Authority: string
  Title: Authority

  Maximum Length: 100

  The authority who issues the person national identifier.
• CountryCode: string
  Title: Country Code

  Maximum Length: 30

  The country code for national identifier of the person.
• CountryName: string
  Title: Country Name

  Read Only: true

  Maximum Length: 80

  The country name for national identifier of the person.
• ExpirationDate: string (date)
  Title: Expiration Date

  The expiration date of the person national identifier.
• IdentifierTypeCode: string
  Title: Identifier Type Code

  Maximum Length: 30

  The identifier type code for national identifier of the person.
• IdentifierTypeMeaning: string
  Title: Identifier Type

  Read Only: true

  Maximum Length: 60

  The meaning of identifier type code for national identifier of the person.
• IdentifierValue: string
  Title: ID Number

  Maximum Length: 30

  The identifier value of the person.
• IssueDate: string (date)
  Title: Issue Date

  The issue date of the person national identifier.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NationalIdentifierId: integer (int64)
  Title: National Identifier ID

  Read Only: true

  The unique identifier for the national identifier.
• Notes: string
  Title: Note

  Maximum Length: 240

  The additional notes for person national identifier.

{
    "type":"object",
    "properties":{
        "Authority":{
            "title":"Authority",
            "maxLength":100,
            "type":"string",
            "description":"The authority who issues the person national identifier.",
            "nullable":true,
            "x-queryable":true
        },
        "CountryCode":{
            "title":"Country Code",
            "maxLength":30,
            "type":"string",
            "description":"The country code for national identifier of the person.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CountryName":{
            "title":"Country Name",
            "maxLength":80,
            "type":"string",
            "description":"The country name for national identifier of the person.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the person national identifier.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "IdentifierTypeCode":{
            "title":"Identifier Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The identifier type code for national identifier of the person.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "IdentifierTypeMeaning":{
            "title":"Identifier Type",
            "maxLength":60,
            "type":"string",
            "description":"The meaning of identifier type code for national identifier of the person.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IdentifierValue":{
            "title":"ID Number",
            "maxLength":30,
            "type":"string",
            "description":"The identifier value of the person.",
            "nullable":false,
            "x-queryable":true
        },
        "IssueDate":{
            "title":"Issue Date",
            "type":"string",
            "description":"The issue date of the person national identifier.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "NationalIdentifierId":{
            "title":"National Identifier ID",
            "type":"integer",
            "description":"The unique identifier for the national identifier.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "Notes":{
            "title":"Note",
            "maxLength":240,
            "type":"string",
            "description":"The additional notes for person national identifier.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

NationalIdCountriesLOV

Operation: /fscmRestApi/resources/11.13.18.05/hedNationalIdentifierCountriesLOV

Parameters:

• finder: ActiveDataFinder%3BCountryCode%3D{CountryCode}

The following properties are defined on the LOV link relation:

• Source Attribute: CountryCode; Target Attribute: CountryCode
• Display Attribute: CountryName

NationalIdentifierTypeLOV

Operation: /fscmRestApi/resources/11.13.18.05/hedNationalIdentifierTypesLOV

Parameters:

• finder: ByCountryFinder%3BCountryCode%3D{CountryCode}%2CIdentifierTypeCode%3D{IdentifierTypeCode}

The following properties are defined on the LOV link relation:

• Source Attribute: IdentifierTypeCode; Target Attribute: IdentifierTypeCode
• Display Attribute: IdentifierTypeMeaning

Back to Top