Employee import
Import employees from an external system to be added to the personnel ticket system
Import a new employee
Headers
ET-Client-NameEntur Client Header.
It is required that all consumers identify themselves by using this header.
Entur will deploy strict rate-limiting policies on API-consumers who do not identify with a header and reserves the right to block unidentified consumers.
The structure of ET-Client-Name should be: <company>-<application>.
X-Correlation-IdCorrelation id
Import a new employee › Request Body
employeeNoEmployee number
companyIdThe company the employee is employed by
employmentTypeIdThe type of employment
dateOfBirthWhen the employee was born
ssnThe employee's social security number. 5 digits.
firstNameThe employee's first name
surnameThe employee's surname
addressLineThe employee's postal address
postalCodeThe postal code for the employee's address
hireStartDateWhen the employee was hired
employmentPercentageEmployment percentage
isDeletedWhether the employee has been marked for deletion. Default false
abstainFromTicketWhether a ticket should be created. Default false
payTypePay type - see the codes in the API documentation
hireEndDateWhen the employee left the company
hireEndCauseWhy the employee left the company
disabilityGradeThe employee's degree of disability. Default 0.
disabilityFromDateWhen the employee's disability was granted
employmentPercentageDateDate for registered employment percentage
paidPercentageThe pay level. This is calculated based on the employment percentage and the type of employment. Typically holds the same value as employment percentage, unless special circumstances apply
leaveFromDateWhen the employee starts a leave
idIf present, this will perform an update of the employee
workPlaceIdWorkplace id
preferredProductIdDeprecated. Use separate endpoint categories.
sendTicketToPrivateAddressNot used. Won't be saved.
jobDescriptionNot used. Won't be saved.
disabilityProofRegisteredDeprecated. Use separate endpoint for disability proofs.
disabilityProofRegisteredDateUse separate endpoint for disability proofs
paidPercentageDateNot used. Won't be saved.
isOnWaitPayNot used. Won't be saved.
waitPayDateNot used. Won't be saved.
isFeePaidDeprecated. Use separate endpoint for yearlyFees.
noteDeprecated. Not used.
Import a new employee › Responses
OK
idThe id of the imported employee
employeeNoEmployee number
companyIdThe company the employee is employed by
firstNameThe employee's first name
surnameThe employee's surname
employmentTypeIdThe type of employment
dateOfBirthWhen the employee was born
ssnThe employee's social security number
addressLineThe employee's postal address
The postal data for the employee's address
abstainFromTicketWhether a ticket should be created
hireStartDateWhen the employee was hired
payTypePay type - see the codes in the API documentation
hireEndDateWhen the employee left the company
hireEndCauseWhy the employee left the company
disabilityGradeThe employee's degree of disability. Default 0.
disabilityFromDateWhen the employee's disability was granted
employmentPercentageEmployment percentage
employmentPercentageDateDate for registered employment percentage
paidPercentageThe pay level. This is calculated based on the employment percentage and the type of employment. Typically holds the same value as employment percentage, unless special circumstances apply
leaveFromDateWhen the employee starts a leave
noteAny additional information
isDeletedWhether the employee has been marked for deletion
lastUpdateWhen the imported employee was last updated
sourceLastUpdateThe source for the last update
createdAtThe date of creation.
createdByThe source for the first creation
workPlaceIdUnused
preferredProductIdDeprecated. Use separate endpoint categories.
sendTicketToPrivateAddressUnused
jobDescriptionUnused
disabilityProofRegisteredDeprecated. Use separate endpoint for disability proofs.
disabilityProofRegisteredDateUnused
paidPercentageDateUnused
isOnWaitPayUnused
waitPayDateUnused
isFeePaidDeprecated. Use separate endpoint for yearlyFees. Whether the ticket fee has been paid, if applicable
Set the status of the yearly fee
Set the status of the yearly fee for the given employee for the given year. This endpoint will trigger generation of ticket rights.
path Parameters
employeeIdyearHeaders
ET-Client-NameEntur Client Header.
It is required that all consumers identify themselves by using this header.
Entur will deploy strict rate-limiting policies on API-consumers who do not identify with a header and reserves the right to block unidentified consumers.
The structure of ET-Client-Name should be: <company>-<application>.
X-Correlation-IdCorrelation id
Set the status of the yearly fee › Request Body
isPaidWhether this yearly fee has been paid
Set the status of the yearly fee › Responses
OK
yearThe year this fee is valid
isPaidWhether this yearly fee has been paid
Set registration status of the disability proof
Set registration status of the disability proof for the given employee for the given year
path Parameters
employeeIdyearHeaders
ET-Client-NameEntur Client Header.
It is required that all consumers identify themselves by using this header.
Entur will deploy strict rate-limiting policies on API-consumers who do not identify with a header and reserves the right to block unidentified consumers.
The structure of ET-Client-Name should be: <company>-<application>.
X-Correlation-IdCorrelation id
Set registration status of the disability proof › Request Body
isRegisteredWhether proof of disability has been registered
Set registration status of the disability proof › Responses
OK
yearThe year this information is valid for
isRegisteredWhether a disability proof has been registered this year
Import multiple employees via csv
Import multiple employees via csv. Will return a list of the actually changed elements. This list may be empty if all uploaded values were already in the database.If any birth date or ssn is invalid, nothing will be imported, and an error message listing invalid dates and ssn will be returned
query Parameters
importForCompanyIf provided, will parse the csv file based on the format provided by the company. Use employeeNoPrefix from the relevant company. The the company has no specific format registered, the standard format will be used.
Headers
ET-Client-NameEntur Client Header.
It is required that all consumers identify themselves by using this header.
Entur will deploy strict rate-limiting policies on API-consumers who do not identify with a header and reserves the right to block unidentified consumers.
The structure of ET-Client-Name should be: <company>-<application>.
X-Correlation-IdCorrelation id
Import multiple employees via csv › Request Body
importFileA csv formatted file with employees to import. Use the properties as described by the relevant format. Default is $ref: #/definitions/ImportedEmployeeRequest.
Import multiple employees via csv › Responses
OK
idThe id of the imported employee
employeeNoEmployee number
companyIdThe company the employee is employed by
firstNameThe employee's first name
surnameThe employee's surname
employmentTypeIdThe type of employment
dateOfBirthWhen the employee was born
ssnThe employee's social security number
addressLineThe employee's postal address
The postal data for the employee's address
abstainFromTicketWhether a ticket should be created
hireStartDateWhen the employee was hired
payTypePay type - see the codes in the API documentation
hireEndDateWhen the employee left the company
hireEndCauseWhy the employee left the company
disabilityGradeThe employee's degree of disability. Default 0.
disabilityFromDateWhen the employee's disability was granted
employmentPercentageEmployment percentage
employmentPercentageDateDate for registered employment percentage
paidPercentageThe pay level. This is calculated based on the employment percentage and the type of employment. Typically holds the same value as employment percentage, unless special circumstances apply
leaveFromDateWhen the employee starts a leave
noteAny additional information
isDeletedWhether the employee has been marked for deletion
lastUpdateWhen the imported employee was last updated
sourceLastUpdateThe source for the last update
createdAtThe date of creation.
createdByThe source for the first creation
workPlaceIdUnused
preferredProductIdDeprecated. Use separate endpoint categories.
sendTicketToPrivateAddressUnused
jobDescriptionUnused
disabilityProofRegisteredDeprecated. Use separate endpoint for disability proofs.
disabilityProofRegisteredDateUnused
paidPercentageDateUnused
isOnWaitPayUnused
waitPayDateUnused
isFeePaidDeprecated. Use separate endpoint for yearlyFees. Whether the ticket fee has been paid, if applicable
Get imported employee
path Parameters
importedEmployeeIdHeaders
ET-Client-NameEntur Client Header.
It is required that all consumers identify themselves by using this header.
Entur will deploy strict rate-limiting policies on API-consumers who do not identify with a header and reserves the right to block unidentified consumers.
The structure of ET-Client-Name should be: <company>-<application>.
X-Correlation-IdCorrelation id
Get imported employee › Responses
OK
idThe id of the imported employee
employeeNoEmployee number
companyIdThe company the employee is employed by
firstNameThe employee's first name
surnameThe employee's surname
employmentTypeIdThe type of employment
dateOfBirthWhen the employee was born
ssnThe employee's social security number
addressLineThe employee's postal address
The postal data for the employee's address
abstainFromTicketWhether a ticket should be created
hireStartDateWhen the employee was hired
payTypePay type - see the codes in the API documentation
hireEndDateWhen the employee left the company
hireEndCauseWhy the employee left the company
disabilityGradeThe employee's degree of disability. Default 0.
disabilityFromDateWhen the employee's disability was granted
employmentPercentageEmployment percentage
employmentPercentageDateDate for registered employment percentage
paidPercentageThe pay level. This is calculated based on the employment percentage and the type of employment. Typically holds the same value as employment percentage, unless special circumstances apply
leaveFromDateWhen the employee starts a leave
noteAny additional information
isDeletedWhether the employee has been marked for deletion
lastUpdateWhen the imported employee was last updated
sourceLastUpdateThe source for the last update
createdAtThe date of creation.
createdByThe source for the first creation
workPlaceIdUnused
preferredProductIdDeprecated. Use separate endpoint categories.
sendTicketToPrivateAddressUnused
jobDescriptionUnused
disabilityProofRegisteredDeprecated. Use separate endpoint for disability proofs.
disabilityProofRegisteredDateUnused
paidPercentageDateUnused
isOnWaitPayUnused
waitPayDateUnused
isFeePaidDeprecated. Use separate endpoint for yearlyFees. Whether the ticket fee has been paid, if applicable
Patch a previously imported employee
path Parameters
importedEmployeeIdHeaders
ET-Client-NameEntur Client Header.
It is required that all consumers identify themselves by using this header.
Entur will deploy strict rate-limiting policies on API-consumers who do not identify with a header and reserves the right to block unidentified consumers.
The structure of ET-Client-Name should be: <company>-<application>.
X-Correlation-IdCorrelation id
Patch a previously imported employee › Request Body
employeeNoEmployee number
companyIdCompany Id
employmentTypeIdType of employment
employmentPercentageEmployment percentage
isDeletedWhether the employee has been marked for deletion. Default false
dateOfBirthWhen the employee was born
ssnBirthdate-number og D-number, 5 digits
firstNameThe employee's first name
surnameThe employee's surname
addressLineThe employee's address line
postalCodeThe postal code for the employee's address
preferredProductIdThe employee's product
abstainFromTicketWhether a ticket should be created
hireStartDateWhen the employee was hired
payTypePay type - see the codes in the API documentation
hireEndDateWhen the employee left the company
hireEndCauseWhy the employee left the company
disabilityGradeThe employee's degree of disability. Default 0.
disabilityFromDateWhen the employee's disability was granted
employmentPercentageDateDate for registered employment percentage
paidPercentageThe pay level. This is calculated based on the employment percentage and the type of employment. Typically holds the same value as employment percentage, unless special circumstances apply
leaveFromDateWhen the employee starts a leave
Patch a previously imported employee › Responses
OK
idThe id of the imported employee
employeeNoEmployee number
companyIdThe company the employee is employed by
firstNameThe employee's first name
surnameThe employee's surname
employmentTypeIdThe type of employment
dateOfBirthWhen the employee was born
ssnThe employee's social security number
addressLineThe employee's postal address
The postal data for the employee's address
abstainFromTicketWhether a ticket should be created
hireStartDateWhen the employee was hired
payTypePay type - see the codes in the API documentation
hireEndDateWhen the employee left the company
hireEndCauseWhy the employee left the company
disabilityGradeThe employee's degree of disability. Default 0.
disabilityFromDateWhen the employee's disability was granted
employmentPercentageEmployment percentage
employmentPercentageDateDate for registered employment percentage
paidPercentageThe pay level. This is calculated based on the employment percentage and the type of employment. Typically holds the same value as employment percentage, unless special circumstances apply
leaveFromDateWhen the employee starts a leave
noteAny additional information
isDeletedWhether the employee has been marked for deletion
lastUpdateWhen the imported employee was last updated
sourceLastUpdateThe source for the last update
createdAtThe date of creation.
createdByThe source for the first creation
workPlaceIdUnused
preferredProductIdDeprecated. Use separate endpoint categories.
sendTicketToPrivateAddressUnused
jobDescriptionUnused
disabilityProofRegisteredDeprecated. Use separate endpoint for disability proofs.
disabilityProofRegisteredDateUnused
paidPercentageDateUnused
isOnWaitPayUnused
waitPayDateUnused
isFeePaidDeprecated. Use separate endpoint for yearlyFees. Whether the ticket fee has been paid, if applicable