Employees

Register innehållande samtliga anställda i företaget.

 

Field

 

In response

 

POST

 

PUT

 

Validation POST / PUT

 

Filter

 

Numeric

<,>,between

Sort

 

 id

X

 

 

 

X

X

 role_id

X

X

X

  • optional

 

 

X

 deleted

X

 

 

 

X

 

X

 phone

X

X

X

  • optional

  • string

 

 

X

 mobile

X

X

X

  • optional

  • string

 

 

X

 workphone

X

X

X

  • optional

  • string

 

 

X

 email

X

X

X

  • required

  • email

 

 

X

 address

X

X

X

  • optional

  • string

 

 

X

 co_address

X

X

X

  • optional

  • string

 

 

X

 city

X

X

X

  • optional

  • string

 

 

X

 salary_hourlyrate

X

X

X

  • optional

  • numeric

 

 

X

 status

X

 

 

 Optional

0 Inactive
1 Active

 

 

X

 criminal_records

X

X

X

  • optional

  • string

  • in:

    • not_applied

    • applied

    • ok

    • not_ok

       

 

 

X

 car

X

X

X

  • optional

  • string

  • in:

    • CAR

    • NO_CAR

    • CAR_WITH_TOWBAR

 

 

X

 experience

X

X

X

  • nullable

  • string

 

 

X

 number

X

X

X

  • nullable

  • string

 

 

X

 employeecontract_id

X

X

X

  • optional

  • integer

 

 

X

 type_of_employment

X

X

X

  • optional

  • string

  • in:

    • hour

    • apployment

    • trial

    • season

    • vik

 

 

X

 payslip_email

X

X

X

  • optional

  • boolean

 

 

X

contract_date

X

 

 

  • string
   

 

latest_appraisal_date

X

 

 

  • string
     

medical_certificate_date

X

   
  • string
     

employer_support_date

X

   
  • string
     

 first_name

X

X

X

  • required

  • string

 

X

 last_name

X

X

X

  • required

  • string

 

X

 personal_number

X

X

X

  • nullable

  • string

 

 

X

 postal_code

X

X

X

  • nullable

  • string

 

 X

X

 employee_startdate

X

X

X

  • nullable

  • date

 

 

X

 employee_enddate

X

X

X

  • nullable

  • date

 

 

X

 driver_licenses

X

X

X

  • nullable

  • date

 

 

 

 salary_taxrate

 

X

X

  • nullable

  • integer

 

 

 

 occupation

 

X

X

  • nullable

  • integer

  • max:100

 

 

 

 full_time

 

X

X

  • nullable

  • boolean

 

 

 

 hours_per_week

 

X

X

  • nullable

  • integer

 

 

 

 base_contract

  • name

  • occupation

  • salary_hourlyrate

  • salary_monthlyrate

  • experience

  • extra

  • overtime

  • deleted

  • contracttype

  • amf

X

 

 

 

 

 

 

 services

  • id

X

 

 

 

X

filter[service_id]={value1},{valueN}

Not used in FindBy

 X

 

 tags

  • id

X

 

 

 

X

filter[tags_included]={value1},{valueN} for whereIn

filter[tags_excluded]={value1},{valueN} for whereNotIn

Not used in FindBy

 

 

 workarea_id

 

 

 

 

X

filter[workarea_id]={value1},{valueN}

Not used in FindBy

 X

 

 

Additional endpoints

Endpoint

 

Method

 

Field

 

Validation

 

 Relate workarea to employee

 POST

 workarea_id

  • required

  • array

 employee_id

  • required

  • integer

  • exists: employees,id

 Remove related workarea from employee

 DELETE

 workarea_id

  • required

  • integer

 employee_id

  • required

  • integer

 Get related workareas

 GET

 id

 

 name

 

 description

 

 deleted

 

 Set primary workarea to employee

 PUT

 query_param: employees/{employeeId}/workareas/{workareaId}/set

 

 Unset primary wokrarea from employee

 PUT

query_param: employees/{employeeId}/workareas/{workareaId}/unset

 

 Relate service to employee

 POST

 service_id

  • required

  • array

 employee_id

  • required

  • integer

  • exists: employees,id

 Remove related service from employee

 DELETE

 service_id

  • required

  • integer

 employee_id

  • required

  • integer

 Get employees without tags

 GET

 Mapped employee collection

 

 (similar to employees/filter[tags_excluded]={tagId})

 

 Get employees with tags

 GET

 Mapped employee collection

 

 (similar to employees/filter[tags_included]={tagId})

 

 Employee Workarea managers - Client

 GET

client_id

Returns a list of employees that are linked by workareas in clients adress(es)

  •  required

 Employee Workarea managers - Workarea

 GET

workarea_id

Returns a list of employees linked to the workarea.

  •  required

 

Postman

 

© TimeWave AB