/user/{user_id}/employment_contract/start

Start employment contract history for a user

Base URL

https://<tenant>.dieagenturverwaltung.de/api/v2

Required Security

ApiKeyAuth (Authorization: Session Token)

Produces

application/json

Request

Path Parameters

Name	Type	Required	Description
user_id	integer	Yes	User ID, can be 'me' for the current user

Body Parameters

Name	Type	Required	Description
request	employment_contract.startRequest	Yes	Employment contract start data

Parameter Models

Inspect object parameters and nested model references without loading the full Swagger file in the browser.

requestBody parameteremployment_contract.startRequest

contract_end

integer

No description.

contract_start

integer

No description.

employee_since

integer

No description.

trail_period_end

integer

No description.

cURL

curl -X PUT 'https://<tenant>.dieagenturverwaltung.de/api/v2/user/123/employment_contract/start' \
  -H 'Accept: application/json' \
  -H 'Authorization: Session Token' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "contract_end": 123,
  "contract_start": 123,
  "employee_since": 123,
  "trail_period_end": 123
}'

Request Body (application/json)

{
  "contract_end": 123,
  "contract_start": 123,
  "employee_since": 123,
  "trail_period_end": 123
}

Responses

200OK

array<app.EmploymentContract>application/json

Example

[
  {
    "absence_additional_contingents": [
      {...}
    ],
    "absence_contingents": [
      {...}
    ],
    "annual_vacation": "string",
    "date_created": 123,
    "date_from": 123,
    "date_modified": 123,
    "date_trial_period_expiration": 123,
    "date_until": 123,
    "date_vacation_expiration": "string",
    "hourly_rate": 123.45,
    "id": 123,
    "is_placeholder": true,
    "office_location_id": 123,
    "position": "string",
    "regular_attendance": {...},
    "special_vacation": "string",
    "type": "none",
    "user_id": 123,
    "user_id_superior": 123
  }
]

400Bad Request

rest_errors.Errorapplication/json

Example

{
  "code": 123,
  "extras": {...},
  "message": "string",
  "status_code": 123
}

401Unauthorized

rest_errors.Errorapplication/json

Example

{
  "code": 123,
  "extras": {...},
  "message": "string",
  "status_code": 123
}

403Forbidden

rest_errors.Errorapplication/json

Example

{
  "code": 123,
  "extras": {...},
  "message": "string",
  "status_code": 123
}

500Internal Server Error

rest_errors.Errorapplication/json

Example

{
  "code": 123,
  "extras": {...},
  "message": "string",
  "status_code": 123
}