Jump to

• Request
• Response

Create details of all candidate PII data

post

/hcmRestApi/resources/11.13.18.05/recruitingCandidatePIIData

Request

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

• CandidateNumber: string
  Candidate Number in the recruiting candidate PII data.
• CandidateToken: string
  Candidate Token in the recruiting candidate PII data.
• ClientReferenceKey: string
  Client reference key in the recruiting candidate PII data.
• DateOfBirth: string (date)
  Date of birth in the recruiting candidate PII data.
• ExpirationDate: string (date)
  Expiration date in the recruiting candidate PII data.
• IssueDate: string (date)
  Issue date in the recruiting candidate PII data.
• LegislationCode: string
  Legislation code in the recruiting candidate PII data.
• NationalIdentifierNumber: string
  National identifier number in the recruiting candidate PII data.
• NationalIdentifierType: string
  National identifier type in the recruiting candidate PII data.
• PartnerId: string
  Partner ID in the recruiting candidate PII data.
• PlaceOfIssue: string
  Place of issue in the recruiting candidate PII data.
• RequisitionNumber: string
  Requisition number in the recruiting candidate PII data.

{
    "type":"object",
    "properties":{
        "ClientReferenceKey":{
            "type":"string",
            "description":"Client reference key in the recruiting candidate PII data.",
            "nullable":true
        },
        "DateOfBirth":{
            "type":"string",
            "description":"Date of birth in the recruiting candidate PII data.",
            "format":"date",
            "nullable":true
        },
        "CandidateNumber":{
            "type":"string",
            "description":"Candidate Number in the recruiting candidate PII data.",
            "nullable":true
        },
        "LegislationCode":{
            "type":"string",
            "description":"Legislation code in the recruiting candidate PII data.",
            "nullable":true
        },
        "NationalIdentifierNumber":{
            "type":"string",
            "description":"National identifier number in the recruiting candidate PII data.",
            "nullable":true
        },
        "PartnerId":{
            "type":"string",
            "description":"Partner ID in the recruiting candidate PII data.",
            "nullable":true
        },
        "IssueDate":{
            "type":"string",
            "description":"Issue date in the recruiting candidate PII data.",
            "format":"date",
            "nullable":true
        },
        "RequisitionNumber":{
            "type":"string",
            "description":"Requisition number in the recruiting candidate PII data.",
            "nullable":true
        },
        "PlaceOfIssue":{
            "type":"string",
            "description":"Place of issue in the recruiting candidate PII data.",
            "nullable":true
        },
        "ExpirationDate":{
            "type":"string",
            "description":"Expiration date in the recruiting candidate PII data.",
            "format":"date",
            "nullable":true
        },
        "NationalIdentifierType":{
            "type":"string",
            "description":"National identifier type in the recruiting candidate PII data.",
            "nullable":true
        },
        "CandidateToken":{
            "type":"string",
            "description":"Candidate Token in the recruiting candidate PII data.",
            "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 : recruitingCandidatePIIData-item-response

Type: object

Show Source

• CandidateNumber: string
  Candidate Number in the recruiting candidate PII data.
• CandidateToken: string
  Candidate Token in the recruiting candidate PII data.
• ClientReferenceKey: string
  Client reference key in the recruiting candidate PII data.
• DateOfBirth: string (date)
  Date of birth in the recruiting candidate PII data.
• ExpirationDate: string (date)
  Expiration date in the recruiting candidate PII data.
• IssueDate: string (date)
  Issue date in the recruiting candidate PII data.
• LegislationCode: string
  Legislation code in the recruiting candidate PII data.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NationalIdentifierNumber: string
  National identifier number in the recruiting candidate PII data.
• NationalIdentifierType: string
  National identifier type in the recruiting candidate PII data.
• PartnerId: string
  Partner ID in the recruiting candidate PII data.
• PlaceOfIssue: string
  Place of issue in the recruiting candidate PII data.
• RequisitionNumber: string
  Requisition number in the recruiting candidate PII data.

{
    "type":"object",
    "properties":{
        "ClientReferenceKey":{
            "type":"string",
            "description":"Client reference key in the recruiting candidate PII data.",
            "nullable":true,
            "x-queryable":true
        },
        "DateOfBirth":{
            "type":"string",
            "description":"Date of birth in the recruiting candidate PII data.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CandidateNumber":{
            "type":"string",
            "description":"Candidate Number in the recruiting candidate PII data.",
            "nullable":true,
            "x-queryable":true
        },
        "LegislationCode":{
            "type":"string",
            "description":"Legislation code in the recruiting candidate PII data.",
            "nullable":true,
            "x-queryable":true
        },
        "NationalIdentifierNumber":{
            "type":"string",
            "description":"National identifier number in the recruiting candidate PII data.",
            "nullable":true,
            "x-queryable":true
        },
        "PartnerId":{
            "type":"string",
            "description":"Partner ID in the recruiting candidate PII data.",
            "nullable":true,
            "x-queryable":true
        },
        "IssueDate":{
            "type":"string",
            "description":"Issue date in the recruiting candidate PII data.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "RequisitionNumber":{
            "type":"string",
            "description":"Requisition number in the recruiting candidate PII data.",
            "nullable":true,
            "x-queryable":true
        },
        "PlaceOfIssue":{
            "type":"string",
            "description":"Place of issue in the recruiting candidate PII data.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpirationDate":{
            "type":"string",
            "description":"Expiration date in the recruiting candidate PII data.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "NationalIdentifierType":{
            "type":"string",
            "description":"National identifier type in the recruiting candidate PII data.",
            "nullable":true,
            "x-queryable":true
        },
        "CandidateToken":{
            "type":"string",
            "description":"Candidate Token in the recruiting candidate PII data.",
            "nullable":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."
        }
    }
}

Back to Top