Methods

  • get - Get Details

Resource

{
    "addressTypes": [
        {
            "disabled": "boolean",
            "group": {
                "name": "string"
            },
            "selected": "boolean",
            "text": "string",
            "value": "string"
        }
    ],
    "allTags": [
        "string"
    ],
    "anniversaryDate": "date-time",
    "bouncedEmail": "boolean",
    "canDelete": "boolean",
    "canEdit": "boolean",
    "canEditProfileImage": "boolean",
    "dateOfBirth": "date-time",
    "editMode": "string",
    "email": "string",
    "endDate": "date-time",
    "externalId": "string",
    "externalReferenceId": "string",
    "fields": {
        "isAddressMandatory": "boolean",
        "isNameMandatory": "boolean",
        "showAnniversaryDate": "boolean",
        "showDateOfBirth": "boolean",
        "showGender": "boolean",
        "showPostalAddress": "boolean",
        "showPreferredName": "boolean",
        "showPreviousSurname": "boolean",
        "showStartDate": "boolean",
        "showTitle": "boolean"
    },
    "firstName": "string",
    "gender": "string",
    "hasConnectedDevices": "boolean",
    "hasProfileImage": "boolean",
    "hasSoleUser": "boolean",
    "homePhone": "string",
    "id": "int32",
    "irdDetailsCurrent": "boolean",
    "irdSettingsEnabled": "boolean",
    "isAnonymised": "boolean",
    "isOverseasPostalAddress": "boolean",
    "isOverseasResidentialAddress": "boolean",
    "isPostalAddressSameAsResidential": "boolean",
    "isTerminated": "boolean",
    "legalName": "string",
    "middleName": "string",
    "mobilePhone": "string",
    "newEmail": "string",
    "otherName": "string",
    "pendingEmailUpdate": "boolean",
    "postalAddressLine2": "string",
    "postalAddressLine3": "string",
    "postalAddressType": "string",
    "postalBlockNumber": "string",
    "postalCountry": "string",
    "postalCountryId": "string",
    "postalLevelNumber": "string",
    "postalPostcode": "string",
    "postalState": "string",
    "postalStreetAddress": "string",
    "postalStreetName": "string",
    "postalSuburb": "string",
    "postalSuburbId": "int32",
    "postalUnitNumber": "string",
    "previousSurname": "string",
    "residentialAddressLine2": "string",
    "residentialAddressLine3": "string",
    "residentialAddressType": "string",
    "residentialBlockNumber": "string",
    "residentialCountry": "string",
    "residentialCountryId": "string",
    "residentialLevelNumber": "string",
    "residentialPostcode": "string",
    "residentialState": "string",
    "residentialStreetAddress": "string",
    "residentialStreetName": "string",
    "residentialSuburb": "string",
    "residentialSuburbId": "int32",
    "residentialUnitNumber": "string",
    "source": "int32",
    "startDate": "date-time",
    "surname": "string",
    "tagsString": "string",
    "terminationDescription": "string",
    "terminationReason": "string",
    "terminationReasons": [
        {
            "text": "string",
            "value": "int64"
        }
    ],
    "timesheetSetting": "string",
    "timesheetsReadOnly": "boolean",
    "titleId": "int32",
    "titles": [
        {
            "description": "string",
            "id": "int32"
        }
    ],
    "workPhone": "string"
}

Properties

Name Type Description
addressTypes[] array
addressTypes[].disabled boolean Boolean
addressTypes[].group object SelectListGroup
addressTypes[].group.name string String
addressTypes[].selected boolean Boolean
addressTypes[].text string String
addressTypes[].value string String
allTags[] array of string
anniversaryDate date-time Nullable
bouncedEmail boolean Boolean
canDelete boolean Boolean
canEdit boolean Boolean
canEditProfileImage boolean Boolean
dateOfBirth date-time Nullable
editMode string EmployeeDetailsEditMode

Possible values are:

  • EmployeePortal
  • EmployeePortalReadOnly
  • BusinessPortal
email string String
endDate date-time Nullable
externalId string String
externalReferenceId string String
fields object EmployeeDetailsFields
fields.isAddressMandatory boolean Boolean
fields.isNameMandatory boolean Boolean
fields.showAnniversaryDate boolean Boolean
fields.showDateOfBirth boolean Boolean
fields.showGender boolean Boolean
fields.showPostalAddress boolean Boolean
fields.showPreferredName boolean Boolean
fields.showPreviousSurname boolean Boolean
fields.showStartDate boolean Boolean
fields.showTitle boolean Boolean
firstName string String
gender string String
hasConnectedDevices boolean Boolean
hasProfileImage boolean Boolean
hasSoleUser boolean Boolean
homePhone string String
id int32 Int32
irdDetailsCurrent boolean Boolean
irdSettingsEnabled boolean Boolean
isAnonymised boolean Boolean
isOverseasPostalAddress boolean Boolean
isOverseasResidentialAddress boolean Boolean
isPostalAddressSameAsResidential boolean Boolean
isTerminated boolean Boolean
legalName string String
middleName string String
mobilePhone string String
newEmail string String
otherName string String
pendingEmailUpdate boolean Boolean
postalAddressLine2 string String
postalAddressLine3 string String
postalAddressType string Nullable

Possible values are:

  • LocalAddress
  • ForeignAddress
  • LocalCareOfAddress
postalBlockNumber string String
postalCountry string String
postalCountryId string String
postalLevelNumber string String
postalPostcode string String
postalState string String
postalStreetAddress string String
postalStreetName string String
postalSuburb string String
postalSuburbId int32 Nullable
postalUnitNumber string String
previousSurname string String
residentialAddressLine2 string String
residentialAddressLine3 string String
residentialAddressType string Nullable

Possible values are:

  • LocalAddress
  • ForeignAddress
  • LocalCareOfAddress
residentialBlockNumber string String
residentialCountry string String
residentialCountryId string String
residentialLevelNumber string String
residentialPostcode string String
residentialState string String
residentialStreetAddress string String
residentialStreetName string String
residentialSuburb string String
residentialSuburbId int32 Nullable
residentialUnitNumber string String
source int32 Int32
startDate date-time Nullable
surname string String
tagsString string String
terminationDescription string String
terminationReason string TerminationReasonEnum

Possible values are:

  • VoluntaryCessation
  • IllHealth
  • Deceased
  • Redundancy
  • Dismissal
  • ContractCessation
  • Transfer
  • Other
terminationReasons[] array
terminationReasons[].text string String
terminationReasons[].value int64 Int64
timesheetSetting string EmployeeTimesheetSetting

Possible values are:

  • Disabled
  • Enabled
  • EnabledForExceptions
timesheetsReadOnly boolean Boolean
titleId int32 Nullable
titles[] array
titles[].description string String
titles[].id int32 Int32
workPhone string String