Jump to

• Request
• Response

Update a candidate citizenship

patch

/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/citizenships/{CitizenshipId}

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=
• CitizenshipId(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: 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

• CitizenshipStatus: string
  Title: Citizenship Status

  Maximum Length: 30

  Status of the candidate citizenship.
• FromDate: string (date)
  Title: From Date

  From date of the candidate citizenship.
• ToDate: string (date)
  Title: To Date

  To date of the candidate citizenship.

{
    "type":"object",
    "properties":{
        "FromDate":{
            "title":"From Date",
            "type":"string",
            "description":"From date of the candidate citizenship.",
            "format":"date",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ToDate":{
            "title":"To Date",
            "type":"string",
            "description":"To date of the candidate citizenship.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "CitizenshipStatus":{
            "title":"Citizenship Status",
            "maxLength":30,
            "type":"string",
            "description":"Status of the candidate citizenship.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "dependencies":[
                    "Citizenship"
                ]
            }
        }
    }
}

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-citizenships-item-response

Type: object

Show Source

• Citizenship: string
  Title: Citizenship

  Maximum Length: 30

  Legislation code of the candidate citizenship.
• CitizenshipId: integer (int64)
  Title: Citizenship ID

  Read Only: true

  Identifier assigned to each candidate citizenship.
• CitizenshipMeaning: string
  Title: Citizenship

  Read Only: true

  Maximum Length: 80

  Meaning of the legislation code for the candidate citizenship.
• CitizenshipStatus: string
  Title: Citizenship Status

  Maximum Length: 30

  Status of the candidate citizenship.
• CitizenshipStatusMeaning: string
  Title: Citizenship Status

  Read Only: true

  Maximum Length: 80

  Meaning of the status of the candidate citizenship.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  User who created the candidate citizenship.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Creation date of the candidate citizenship.
• FromDate: string (date)
  Title: From Date

  From date of the candidate citizenship.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  Date the candidate citizenship was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  User who last updated the candidate citizenship.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ToDate: string (date)
  Title: To Date

  To date of the candidate citizenship.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the candidate citizenship.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Creation date of the candidate citizenship.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"User who created the candidate citizenship.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "CitizenshipStatusMeaning":{
            "title":"Citizenship Status",
            "maxLength":80,
            "type":"string",
            "description":"Meaning of the status of the candidate citizenship.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Citizenship":{
            "title":"Citizenship",
            "maxLength":30,
            "type":"string",
            "description":"Legislation code of the candidate citizenship.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FromDate":{
            "title":"From Date",
            "type":"string",
            "description":"From date of the candidate citizenship.",
            "format":"date",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ToDate":{
            "title":"To Date",
            "type":"string",
            "description":"To date of the candidate citizenship.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CitizenshipStatus":{
            "title":"Citizenship Status",
            "maxLength":30,
            "type":"string",
            "description":"Status of the candidate citizenship.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "dependencies":[
                    "Citizenship"
                ]
            },
            "x-queryable":true
        },
        "CitizenshipMeaning":{
            "title":"Citizenship",
            "maxLength":80,
            "type":"string",
            "description":"Meaning of the legislation code for the candidate citizenship.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CitizenshipId":{
            "title":"Citizenship ID",
            "type":"integer",
            "description":"Identifier assigned to each candidate citizenship.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date the candidate citizenship was last updated.",
            "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

citizenshipLov

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupCode%3D{Citizenship}%2CLookupType%3DNATIONALITY

The following properties are defined on the LOV link relation:

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

citizenshipStatusLov

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LegislationCodeFinder%3BLookupCode%3D{CitizenshipStatus}%2CLookupType%3DPER_CITIZENSHIP_STATUS%2CLegislationCode%3D{Citizenship}

The following properties are defined on the LOV link relation:

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

Back to Top