Employee Citizenship Records

GET {{base_url}}/employee/:Employee/citizenship

NOTE: If you have the Accounting and/or Resource Planning modules installed, then you can access citizenship information.

Use this endpoint to retrieve all citizenship records associated with an employee in the Employees hub.

HEADERS

KeyDatatypeRequiredDescription
Content-TypestringRequired.

The type of content supported by the API endpoint. | | Authorization | string | | Required.

The type of authorization supported by the API endpoint. |

RESPONSES

status: OK

[{"RecordID":"9a3ecad77cf24e89ae644775f36941c4","Employee":"00001","CitizenshipType":"CAN","Country":"CA","Expiration":"2020-12-30T00:00:00.000","CountryDescription":"Canada","CitizenshipTypeDescription":"Canadian Citizen"},{"RecordID":"AFBA38259B2C47369CFC86A5CA7461D0","Employee":"00001","CitizenshipType":"US","Country":"NF","Expiration":"","CountryDescription":"Norfolk Island","CitizenshipTypeDescription":"US Citizen"},{"RecordID":"d25ee170564648908f539020e411f9c0","Employee":"00001","CitizenshipType":"US","Country":"CA","Expiration":"2023-12-30T00:00:00.000","CountryDescription":"Canada","CitizenshipTypeDescription":"US Citizen"}]