Jump to

• Request
• Response

Update a candidate national identifier

patch

/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/nationalIdentifiers/{NationalIdentifierId}

Request

Path Parameters

• CandidateNumber(required): string
  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=
• NationalIdentifierId(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=

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

• ExpirationDate: string (date)
  Title: Expiration Date

  Expiration date of the candidate national identifier.
• IssueDate: string (date)
  Title: Issue Date

  Issue date of the candidate national identifier.
• NationalIdentifierNumber: string
  Title: National ID

  Maximum Length: 30

  National identifier number of the candidate national identifier.
• NationalIdentifierType: string
  Title: National ID Type

  Maximum Length: 30

  National identifier type of the candidate national identifier.
• PlaceOfIssue: string
  Title: Place of Issue

  Maximum Length: 30

  Place of issue of the candidate national identifier.

{
    "type":"object",
    "properties":{
        "IssueDate":{
            "title":"Issue Date",
            "type":"string",
            "description":"Issue date of the candidate national identifier.",
            "format":"date",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "NationalIdentifierType":{
            "title":"National ID Type",
            "maxLength":"30",
            "type":"string",
            "description":"National identifier type of the candidate national identifier.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "dependencies":[
                    "LegislationCode"
                ]
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Expiration date of the candidate national identifier.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "NationalIdentifierNumber":{
            "title":"National ID",
            "maxLength":"30",
            "type":"string",
            "description":"National identifier number of the candidate national identifier.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "PlaceOfIssue":{
            "title":"Place of Issue",
            "maxLength":"30",
            "type":"string",
            "description":"Place of issue of the candidate national identifier.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":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 : recruitingJobSiteCandidates-nationalIdentifiers-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  Person who created the candidate national identifier.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Creation date of the candidate national identifier.
• ExpirationDate: string (date)
  Title: Expiration Date

  Expiration date of the candidate national identifier.
• IssueDate: string (date)
  Title: Issue Date

  Issue date of the candidate national identifier.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  Last update date of the candidate national identifier.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  Person who last updated the candidate national identifier.
• LegislationCode: string
  Title: Country

  Maximum Length: 30

  Legislation code of the candidate national identifier.
• LegislationName: string
  Title: Country

  Read Only: true

  Maximum Length: 80

  Legislation name of the candidate 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

  National identifier ID of the candidate national identifier.
• NationalIdentifierNumber: string
  Title: National ID

  Maximum Length: 30

  National identifier number of the candidate national identifier.
• NationalIdentifierType: string
  Title: National ID Type

  Maximum Length: 30

  National identifier type of the candidate national identifier.
• NationalIdentifierTypeMeaning: string
  Title: National ID Type

  Read Only: true

  Maximum Length: 80

  National identifier type meaning of the candidate national identifier.
• PlaceOfIssue: string
  Title: Place of Issue

  Maximum Length: 30

  Place of issue of the candidate national identifier.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"Person who last updated the candidate national identifier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "NationalIdentifierId":{
            "title":"National Identifier ID",
            "type":"integer",
            "description":"National identifier ID of the candidate national identifier.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            }
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Creation date of the candidate national identifier.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"Person who created the candidate national identifier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "LegislationCode":{
            "title":"Country",
            "maxLength":"30",
            "type":"string",
            "description":"Legislation code of the candidate national identifier.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "NationalIdentifierNumber":{
            "title":"National ID",
            "maxLength":"30",
            "type":"string",
            "description":"National identifier number of the candidate national identifier.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "IssueDate":{
            "title":"Issue Date",
            "type":"string",
            "description":"Issue date of the candidate national identifier.",
            "format":"date",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "NationalIdentifierTypeMeaning":{
            "title":"National ID Type",
            "maxLength":"80",
            "type":"string",
            "description":"National identifier type meaning of the candidate national identifier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PlaceOfIssue":{
            "title":"Place of Issue",
            "maxLength":"30",
            "type":"string",
            "description":"Place of issue of the candidate national identifier.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Expiration date of the candidate national identifier.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "NationalIdentifierType":{
            "title":"National ID Type",
            "maxLength":"30",
            "type":"string",
            "description":"National identifier type of the candidate national identifier.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "dependencies":[
                    "LegislationCode"
                ]
            },
            "x-queryable":true
        },
        "LegislationName":{
            "title":"Country",
            "maxLength":"80",
            "type":"string",
            "description":"Legislation name of the candidate national identifier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Last update date of the candidate national identifier.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":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

legislationCodesLov

Operation: /hcmRestApi/resources/11.13.18.05/hcmCountriesLov

The following properties are defined on the LOV link relation:

• Source Attribute: LegislationCode; Target Attribute: TerritoryCode
• Display Attribute: TerritoryCode, CountryName

nationalIdentifierTypesLov

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LegislationCodeFinder%3BLookupCode%3D{NationalIdentifierType}%2CLookupType%3DPER_NATIONAL_IDENTIFIER_TYPE%2CLegislationCode%3D{LegislationCode}

The following properties are defined on the LOV link relation:

• Source Attribute: NationalIdentifierType; Target Attribute: LookupCode
• Display Attribute: Meaning

Back to Top