Peopleware API (v1)

Documentation of JSON-based endpoints of Peopleware API. Within each listed endpoint, you can click on the green box named response, which contains 200 and a description, to see the fields in the API response. Furthermore, you can click on each endpoint on the top left corner, showing the HTTP request method, to see a full URL, which includes the selected endpoint. Beware that any endpoint will return a 404 response if no data can be found, e.g. when there is no data at the requested point in time.

Important

⚠️ We will soon be hosting a new API under api.peopleware.com. The current functionality is already available under legacy-api.peopleware.com.

To avoid disruption of your service please change the request URL in your code accordingly.

i.e.

From

https://api.peopleware.com/v1/planning_units/1001

to

https://legacy-api.peopleware.com/v1/planning_units/1001

Absences

Operations about absences

All Absences in a time range

Get absences in a time range from level plan or specified level.

Authorizations:

AccessToken

path Parameters

start_date

required

string

query Parameters

end_date	string
length	integer <int32>
level	string (level) Enum: "plan" "wishes" "alternative_wishes" "absence_wishes" "final" "time_recording" "correction" "acd" "availabilities" "on_call" "productivity" "backup" "backup_version_2" "backup_version_3" "overtime"
absence_types	string
display	string

Responses

Response samples

200

Content type

application/json

{"start_time": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"planning_unit_id": 0,
"employee_id": 0,
"activity_id": 0,
"activity_name": "string",
"activity_name_short": "string"
}

Absences of an employee

Get absences of an employee in a time range from level plan or specified level.

Authorizations:

AccessToken

path Parameters

employee_id required	integer <int32>
start_date required	string

query Parameters

end_date	string
length	integer <int32>
level	string (level) Enum: "plan" "wishes" "alternative_wishes" "absence_wishes" "final" "time_recording" "correction" "acd" "availabilities" "on_call" "productivity" "backup" "backup_version_2" "backup_version_3" "overtime"
absence_types	string
display	string

Responses

Response samples

200

Content type

application/json

{"start_time": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"planning_unit_id": 0,
"employee_id": 0,
"activity_id": 0,
"activity_name": "string",
"activity_name_short": "string"
}

Absences all planning unit members

Get absences of all planning unit members in a time range from level plan or specified level.

Authorizations:

AccessToken

path Parameters

planning_unit_id required	integer <int32>
start_date required	string

query Parameters

end_date	string
length	integer <int32>
level	string (level) Enum: "plan" "wishes" "alternative_wishes" "absence_wishes" "final" "time_recording" "correction" "acd" "availabilities" "on_call" "productivity" "backup" "backup_version_2" "backup_version_3" "overtime"
absence_types	string
display	string

Responses

Response samples

200

Content type

application/json

{"start_time": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"planning_unit_id": 0,
"employee_id": 0,
"activity_id": 0,
"activity_name": "string",
"activity_name_short": "string"
}

Accounts

Operations about accounts

All accounts

Get all accounts.

Authorizations:

AccessToken

query Parameters

display

string

Responses

Response samples

200

Content type

application/json

{"account_group_id": 0,
"account_category_id": 0,
"deleted": true,
"description": "string",
"account_id": 0,
"name": "string",
"cost_measure_id": 0,
"name_short": "string"
}

account by account ID

Get an account by ID.

Authorizations:

AccessToken

path Parameters

account_id

required

integer <int32>

query Parameters

display

string

Responses

Response samples

200

Content type

application/json

{"account_group_id": 0,
"account_category_id": 0,
"deleted": true,
"description": "string",
"account_id": 0,
"name": "string",
"cost_measure_id": 0,
"name_short": "string"
}

Subtotals for an account

Get subtotal values for a specific account. This returns account balances for each booking in the given date range.

Authorizations:

AccessToken

path Parameters

account_ids required	string
start_date required	string

query Parameters

end_date	string
length	integer <int32>
cost_center	string
planning_unit_id	integer <int32>
zeros	boolean
include_planning_units	boolean
include_source	boolean
with_most_recent	boolean
display	string

Responses

Response samples

200

Content type

application/json

{"account_id": 0,
"account_value": 0.1,
"cost_center_id": 0,
"employee_id": 0,
"time": "14:15:22Z",
"planning_unit_id": 0,
"source": "string"
}

Activities

Operations about activities

Write requirements for a specific planning unit and activity on a specific date

A staff requirements calculation is the process of determining the number of employees needed to handle a forecasted workload. Staff requirements is the input to the scheduling process. You cannot optimize schedules without staff requirements.

A staff requirement is the number of agents that need to be scheduled to meet the service levels during an interval of 15 minutes.

Example: To reach their service level (e.g. 80% of calls answered within 20 seconds), workforce planners need to calculate how many agents they need to schedule for each 15-minute interval at any given time. The number depends on the forecasted volume of calls and average handle time of each call.

You can use this endpoint to import the staff requirements for an activity in a planning unit on a particular day.

Prerequisites

To create or update a staff requirement for an activity, the activity must be part of a planning unit on the day you want to create the staff requirement.
You need to have write access for the planning unit and activity.

The Requirements resource

JSON request body

To create or update Staff Requirements for a specific activity, send an array of interval data in JSON format in the request body.

Example for a PUT request body:

{
  "data": [0.0, 0.0, 0.0, 0.0, 1.0, 3.5, /* ...  */ 10.0, 2.0, 0.0]
}

The Requirements object

Name	Type	Description
Data	Array of numbers	The array must either contain 96, 48, or 24 items, each representing an interval of 15 minutes, 30 minutes or 60 minutes, respectively. The interval times are interpreted in the timezone of the Planning Unit. Example: if the planning unit has a time zone offset of `+01:00`, the first interval describes the requirements from `00:00:00+01:00` to `00:15:00+01:00`

Authorizations:

AccessToken

path Parameters

planning_unit_id required	integer Specific Planning Unit ID
date required	string <date> Date of the requirements
activity_id required	integer Specific Activity ID

Request Body schema: application/json
required

required

Array of numbers or Array of numbers or Array of numbers

Responses

Request samples

Payload

Content type

application/json

{"data": [0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
]
}

Response samples

400

Content type

application/json

{"errors": [{"status": "string",
"title": "string",
"message": "string"
}
]
}

Planning Unit Activities by Date and Planning Unit ID

Get planning unit activities by date and planning unit ID

Authorizations:

AccessToken

path Parameters

planning_unit_id required	integer <int32>
start_date required	string

query Parameters

end_date	string
length	integer <int32>
display	string

Responses

Response samples

200

Content type

application/json

{"activity_id": 0,
"cost_center_id": 0,
"end_date": "2019-08-24",
"planning_unit_id": 0,
"start_date": "2019-08-24"
}

Skills for Activity by Activity ID

Get all skills for an activity by activity ID

Authorizations:

AccessToken

path Parameters

activity_id

required

integer <int32>

query Parameters

display

string

Responses

Response samples

200

Content type

application/json

{"activity_id": 0,
"activities_skill_id": 0,
"skill_id": 0,
"weight": 0
}

External Activities for Activity by Activity ID

Get all external activities for an activity by activity ID

Authorizations:

AccessToken

path Parameters

activity_id

required

integer <int32>

query Parameters

display

string

Responses

Response samples

200

Content type

application/json

{"activity_id": 0,
"classification": 0,
"external_activity_id": 0,
"external_system_id": 0,
"activities_external_id": 0
}

getV1ActivitiesId

Authorizations:

AccessToken

path Parameters

id

required

integer <int32>

Responses

getV1Activities

Authorizations:

AccessToken

Responses

Activity Externals

Operations about activity_externals

All External Activities

Get all external activities.

Authorizations:

AccessToken

query Parameters

display

string

Responses

Response samples

200

Content type

application/json

{"activity_id": 0,
"classification": 0,
"external_activity_id": 0,
"external_system_id": 0,
"activities_external_id": 0
}

Attributes

Operations about attributes

Get all attributes

Authorizations:

AccessToken

query Parameters

display

string

Responses

Response samples

200

Content type

application/json

{"assignable_to": ["employee"
],
"color": 0,
"deleted": true,
"value_range_fixed": true,
"attribute_id": 0,
"name": "string",
"type": "string"
}

Get one attribute

Authorizations:

AccessToken

path Parameters

attribute_id

required

integer <int32>

query Parameters

display

string

Responses

Response samples

200

Content type

application/json

{"assignable_to": ["employee"
],
"color": 0,
"deleted": true,
"value_range_fixed": true,
"attribute_id": 0,
"name": "string",
"type": "string"
}

Get attribute values

Get attribute values for employees or other resources at specific dates

Authorizations:

AccessToken

path Parameters

attribute_id required	integer <int32>
start_date required	string

query Parameters

end_date	string
type	string
length	integer <int32>
display	string

Responses

Response samples

200

Content type

application/json

{"attribute_id": 0,
"employee_id": 0,
"end_date": "2019-08-24",
"attribute_value_id": 0,
"priority": 0,
"start_date": "2019-08-24",
"value": "string"
}

Attribute Values

Attribute Values for a specific Employee

Get all Attribute Values for a specific Employee.

Request

GET https://legacy-api.peopleware.com/v1/employees/1008/attribute_values

Response

Status 200

{
  "data": [
    {
      "attribute_value_id": 1157,
      "employee_id": 1008,
      "attribute_id": 1002,
      "priority": 1,
      "value": 34,
      "start_date": "2022-12-01",
      "end_date": "2022-12-13"
    }
  ]
}

Authorizations:

AccessToken

path Parameters

employee_id

required

number

Specific Employee ID

Responses

Response samples

200
400

Content type

application/json

{"data": [{"attribute_value_id": 0,
"attribute_id": 0,
"start_date": "2019-08-24",
"end_date": "2019-08-24",
"priority": 0,
"value": "string",
"employee_id": 0
}
]
}

Create Employee Attribute Values

Request

POST https://legacy-api.peopleware.com/v1/employees/1008/attribute_values

{
  "data": {
    "employee_id": 1008,
    "attribute_id": 1001,
    "priority": 1,
    "value": 34,
    "type": "number",
    "start_date": "2022-12-01",
    "end_date": "2022-12-21"
  }
}

Note

The type in the payload can be one of the following: text, number, time, date or boolean

Response

Status 201

{
  "data": {
    "attribute_value_id": 1157,
    "employee_id": 1008,
    "attribute_id": 1001,
    "priority": 1,
    "value": 34,
    "start_date": "2022-12-01",
    "end_date": "2022-12-21"
  }
}

Authorizations:

AccessToken

path Parameters

employee_id

required

number

Specific Employee ID

Request Body schema: application/json
required

required

object non-empty

Responses

Request samples

Payload

Content type

application/json

{"data": {"attribute_id": 0,
"employee_id": 0,
"value": "string",
"type": "text",
"start_date": "2019-08-24",
"end_date": "2019-08-24",
"priority": 0
}
}

Response samples

201
400

Content type

application/json

{"data": {"attribute_value_id": 0,
"attribute_id": 0,
"start_date": "2019-08-24",
"end_date": "2019-08-24",
"priority": 0,
"value": "string",
"employee_id": 0
}
}

Update Employee Attribute Value

Request

PATCH https://legacy-api.peopleware.com/v1/employees/1008/attribute_values/1157

{
  "data": {
    "priority": 1,
    "value": 34,
    "start_date": "2022-12-01",
    "end_date": "2022-12-21"
  }
}

Note

The data type of the value field in the payload depends on the Attribute assigned to the Attribute Value being updated.

Response

Status 200

{
  "data": {
    "attribute_value_id": 1157,
    "employee_id": 1008,
    "attribute_id": 1001,
    "priority": 1,
    "value": 34,
    "start_date": "2022-12-01",
    "end_date": "2022-12-21"
  }
}

Authorizations:

AccessToken

path Parameters

employee_id required	number Specific Employee ID
attribute_value_id required	number Specific Attribute Value ID

Request Body schema: application/json
required

required

object non-empty

Responses

Request samples

Payload

Content type

application/json

{"data": {"value": "string",
"start_date": "2019-08-24",
"end_date": "2019-08-24",
"priority": 0
}
}

Response samples

200
400
404

Content type

application/json

{"data": {"attribute_value_id": 0,
"attribute_id": 0,
"start_date": "2019-08-24",
"end_date": "2019-08-24",
"priority": 0,
"value": "string",
"employee_id": 0
}
}

Delete Attribute Value

Request

DELETE https://legacy-api.peopleware.com/v1/employees/1008/attribute_values/1157

Response

Status 204

Authorizations:

AccessToken

path Parameters

employee_id required	number Specific Employee ID
attribute_value_id required	number Specific Attribute Value ID

Responses

Response samples

400
404

Content type

application/json

{"errors": [{"status": "string",
"title": "string",
"message": "string"
}
]
}

Get attribute values for one employee

Authorizations:

AccessToken

path Parameters

employee_id required	integer <int32>
start_date required	string

query Parameters

end_date	string
length	integer <int32>
display	string

Responses

Response samples

200

Content type

application/json

{"attribute_id": 0,
"employee_id": 0,
"end_date": "2019-08-24",
"attribute_value_id": 0,
"priority": 0,
"start_date": "2019-08-24",
"value": "string"
}

Availabilities

Availability slots

Write availabilities for one employee

Availabilities define at which times an employee can or cannot be scheduled. Availabilities ensure that the employee is only scheduled during their availability slot. If no availability is set for an employee, the employee is considered available at any time within your business hours.

Peopleware API allows you to create, update or delete Availabilities.

To update Availabilities, you have to include all Availability slots of a given day in the request. This will replace the current Availabilities for an employee on a specific day.

To delete a part of an employee's Availabilities, include the Availability slots that you don’t want to delete. To delete all Availabilities, specify an empty array.

Note: All timestamps are interpreted in the time zone of the planning unit that the employee belongs to.

Prerequisites

To create or update Availabilities, the employee must belong to the planning unit on this day. You need write permissions for the planning unit and the default present activity with ID 1.

The Availabilities resource

JSON request body

To create or update Availabilities for an employee, send all the Availability slots in JSON format in the request body.

Example of a PUT request body:

{
  "data": {
    "employee_id": 1234,
    "booking_date": "2022-08-12",
    "items": [
      {
        "planning_unit_id": 1001,
        "start_time": "2022-08-12T10:30:00Z",
        "end_time": "2022-08-12T15:00:00Z"
      },
      {
        "planning_unit_id": 1001,
        "start_time": "2022-08-12T15:30:00Z",
        "end_time": "2022-08-12T18:00:00Z"
      }
    ]
  }
}

Ensure that your input data is semantically correct. The server might reject time conflicts between the given availability slots or write them in an unintended way.

The Availabilities object

Name	Type	Description
employee_id	Integer	Unique identifier for the Employee
booking_date	String	The date that the Employee is scheduled to be available, e.g. "2023-12-02"
items	Array	An array of Availability slots

The Availability slot object

Name	Type	Description
planning_unit_id	Integer	Unique identifier for the planning unit where the Availabilities should be booked
start_time	String	Start time of the Availability slot
end_time	String	End time of the Availability slot

Successful PUT request

To check the updated availabilities, you can go to Plan > Schedules or Plan > Shift Center and select the availability level.

Authorizations:

AccessToken

Request Body schema: application/json
required

required

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"employee_id": 0,
"booking_date": "2019-08-24",
"items": [{"start_time": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"planning_unit_id": 0
}
]
}
}

Response samples

422

Content type

application/json

{"errors": [{"status": "string",
"title": "string",
"message": "string"
}
]
}

Contracts

Operations about contracts

Get Contract Assignments

Request

GET https://legacy-api.peopleware.com/v1/employees/1008/contracts/

Response

Status 200

{
  "data": [
    {
      "employees_contract_id": 1157,
      "employee_id": 1008,
      "contract_id": 1007,
      "start_date": "2022-12-01",
      "end_date": "2022-12-13"
    }
  ]
}

Authorizations:

AccessToken

path Parameters

employee_id

required

number

Specific Employee ID

Responses

Response samples

200
400

Content type

application/json

{"data": [{"employees_contract_id": 0,
"employee_id": 0,
"contract_id": 0,
"start_date": "2019-08-24",
"end_date": "2019-08-24"
}
]
}

Create Contract Assignment

Request

POST https://legacy-api.peopleware.com/v1/employees/1008/contracts

{
  "data": {
    "contract_id": 1007,
    "start_date": "2022-12-01",
    "end_date": "2022-12-21"
  }
}

Response

Status 201

{
  "data": {
    "employees_contract_id": 1001,
    "employee_id": 1008,
    "contract_id": 1007,
    "start_date": "2022-12-01",
    "end_date": "2022-12-21"
  }
}

Authorizations:

AccessToken

path Parameters

employee_id

required

number

Specific Employee ID

Request Body schema: application/json
required

required

object non-empty

Responses

Request samples

Payload

Content type

application/json

{"data": {"contract_id": 0,
"start_date": "2019-08-24",
"end_date": "2019-08-24"
}
}

Response samples

201
400

Content type

application/json

{"data": {"employees_contract_id": 0,
"employee_id": 0,
"contract_id": 0,
"start_date": "2019-08-24",
"end_date": "2019-08-24"
}
}

Update Contract Assignment

Request

PATCH https://legacy-api.peopleware.com/v1/employees/1008/contracts/1001

{
  "data": {
    "start_date": "2021-02-01"
  }
}

Response

Status 200

{
  "data": {
    "employees_contract_id": 1001,
    "employee_id": 1008,
    "contract_id": 1007,
    "start_date": "2021-02-01",
    "end_date": "2022-12-21"
  }
}

Authorizations:

AccessToken

path Parameters

employee_id required	number Specific Employee ID
employees_contract_id required	number Specific Employee Contract ID

Request Body schema: application/json
required

required

object non-empty

Responses

Request samples

Payload

Content type

application/json

{"data": {"contract_id": 0,
"start_date": "2019-08-24",
"end_date": "2019-08-24"
}
}

Response samples

200
400

Content type

application/json

{"data": {"employees_contract_id": 0,
"employee_id": 0,
"contract_id": 0,
"start_date": "2019-08-24",
"end_date": "2019-08-24"
}
}

Delete Contract Assignment

Delete the assigned Contract of an Employee

Request

DELETE https://legacy-api.peopleware.com/v1/employees/1008/contracts/1001

Response

Status 204

Authorizations:

AccessToken

path Parameters

employee_id required	number Specific Employee ID
employees_contract_id required	number Specific Employee Contract ID

Responses

Response samples

400
404

Content type

application/json

{"errors": [{"status": "string",
"title": "string",
"message": "string"
}
]
}

Employee Contracts by Date and Employee ID

Get employee contracts by date and employee ID

Authorizations:

AccessToken

path Parameters

employee_id required	integer <int32>
start_date required	string

query Parameters

end_date	string
length	integer <int32>
display	string

Responses

Response samples

200

Content type

application/json

{"contract_id": 0,
"employee_id": 0,
"end_date": "2019-08-24",
"start_date": "2019-08-24"
}

Employee Contracts by Date and Planning Unit ID

Get employee contracts by date and planning unit ID

Authorizations:

AccessToken

path Parameters

planning_unit_id required	integer <int32>
start_date required	string

query Parameters

end_date	string
length	integer <int32>
display	string

Responses

Response samples

200

Content type

application/json

{"contract_id": 0,
"employee_id": 0,
"end_date": "2019-08-24",
"start_date": "2019-08-24"
}

All Contracts

Get all contracts.

Authorizations:

AccessToken

query Parameters

display

string

Responses

Response samples

200

Content type

application/json

{"deleted": true,
"employment_type": "string",
"color": 0,
"contract_id": 0,
"name": "string",
"name_short": "string",
"working_amount": [{"per_day": [{"minimum": 0,
"target": 0,
"maximum": 0
}
],
"per_week": [{"minimum": 0,
"target": 0,
"maximum": 0
}
],
"per_month": [{"minimum": 0,
"target": 0,
"maximum": 0
}
],
"per_year": [{"minimum": 0,
"target": 0,
"maximum": 0
}
]
}
],
"working_hours": [{"monday": 0,
"tuesday": 0,
"wednesday": 0,
"thursday": 0,
"friday": 0,
"saturday": 0,
"sunday": 0
}
],
"working_days_per_week": 0.1
}

Contract by Contract ID

Get a contract by ID.

Authorizations:

AccessToken

path Parameters

contract_id

required

integer <int32>

query Parameters

display

string

Responses

Response samples

200

Content type

application/json

{"deleted": true,
"employment_type": "string",
"color": 0,
"contract_id": 0,
"name": "string",
"name_short": "string",
"working_amount": [{"per_day": [{"minimum": 0,
"target": 0,
"maximum": 0
}
],
"per_week": [{"minimum": 0,
"target": 0,
"maximum": 0
}
],
"per_month": [{"minimum": 0,
"target": 0,
"maximum": 0
}
],
"per_year": [{"minimum": 0,
"target": 0,
"maximum": 0
}
]
}
],
"working_hours": [{"monday": 0,
"tuesday": 0,
"wednesday": 0,
"thursday": 0,
"friday": 0,
"saturday": 0,
"sunday": 0
}
],
"working_days_per_week": 0.1
}

Current Addresses

Operations about employee_current_addresses

Employee's Current Address by Employee ID

Get current address for an employee by employee ID

Authorizations:

AccessToken

path Parameters

employee_id

required

integer <int32>

query Parameters

display

string

Responses

Response samples

200

Content type

application/json

{"city": "string",
"country": "string",
"email": "string",
"email_alt": "string",
"employee_id": 0,
"employees_address_id": 0,
"end_date": "2019-08-24",
"first_name": "string",
"last_name": "string",
"marital_status": "string",
"middle_name": "string",
"phone": "string",
"phone_alt": "string",
"start_date": "2019-08-24",
"street": "string",
"telefax": "string",
"title": "string",
"zipcode": "string"
}

Update employee's current address

Request

PATCH https://legacy-api.peopleware.com/v1/employee_current_addresses/1001

{
  "data": {
    "first_name": "John",
    "last_name": "Doe"
  }
}

Response

Status 200

{
  "data": {
    "employees_address_id": 1200,
    "employee_id": 1001,
    "start_date": "2022-01-01",
    "end_date": "4000-01-01",
    "title": "none",
    "first_name": "John",
    "middle_name": "",
    "last_name": "Doe",
    "street": "",
    "zipcode": "",
    "city": "",
    "phone": "",
    "phone_alt": "",
    "telefax": "",
    "email": "john@doe.com",
    "email_alt": "",
    "country": "USA",
    "marital_status": "unknown"
  }
}

Authorizations:

AccessToken

path Parameters

employee_id

required

number

Specific Employee ID

Request Body schema: application/json
required

required

object non-empty

Responses

Request samples

Payload

Content type

application/json

{"data": {"title": "none",
"first_name": "string",
"last_name": "string",
"email": "string",
"country": "string"
}
}

Response samples

200
400

Content type

application/json

{"data": {"employees_address_id": 0,
"employee_id": 0,
"title": "string",
"first_name": "string",
"last_name": "string",
"middle_name": "string",
"street": "string",
"zipcode": "string",
"city": "string",
"phone": "string",
"phone_alt": "string",
"telefax": "string",
"email": "string",
"email_alt": "string",
"marital_status": "string",
"country": "string",
"start_date": "2019-08-24",
"end_date": "2019-08-24"
}
}

All Employees' Current Address

Response object

Name	Type	Description
employees_address_id	Integer	The unique identifier of an Employee Address
employee_id	Integer	The unique identifier of the related Employee
start_date	String	ISO8601 formatted date
end_date	String	ISO8601 formatted date
title	String	Allowed values are: `none`, `company`, `mister`, `misses` or `miss`
middle_name	String	–
first_name	String	Is referring to the name of the Employee and first name of the User
last_name	String	Is referring to the name of the Employee and last name of the User
street	String	–
zipcode	String	–
city	String	–
phone	String	–
phone_alt	String	–
telefax	String	–
email	String	Is referring to the login e-mail of the User
email_alt	String	–
country	String	–
marital_status	String	Allowed values are: `unknown`, `single`, `married`, `widowed` or `divorced`

Authorizations:

AccessToken

query Parameters

display

string

Responses

Response samples

200

Content type

application/json

{"city": "string",
"country": "string",
"email": "string",
"email_alt": "string",
"employee_id": 0,
"employees_address_id": 0,
"end_date": "2019-08-24",
"first_name": "string",
"last_name": "string",
"marital_status": "string",
"middle_name": "string",
"phone": "string",
"phone_alt": "string",
"start_date": "2019-08-24",
"street": "string",
"telefax": "string",
"title": "string",
"zipcode": "string"
}

Curves

Operations about curves

All queues

Get all queues.

Authorizations:

AccessToken

query Parameters

display

string

Responses

Response samples

200

Content type

application/json

{"deleted": true,
"description": "string",
"events": [{"curve_event_type_id": 0,
"start_time": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z"
}
],
"formulas": [{"curve_value_type_id": 0,
"formula": "string"
}
],
"curve_id": 0,
"interval": 0,
"is_active": true,
"is_absence": true,
"name": "string",
"name_short": "string",
"parent_curve_id": 0,
"time_zone_id": 0
}

Queue by Queue ID

Get a queue by ID.

Authorizations:

AccessToken

path Parameters

curve_id

required

integer <int32>

query Parameters

display

string

Responses

Response samples

200

Content type

application/json

{"deleted": true,
"description": "string",
"events": [{"curve_event_type_id": 0,
"start_time": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z"
}
],
"formulas": [{"curve_value_type_id": 0,
"formula": "string"
}
],
"curve_id": 0,
"interval": 0,
"is_active": true,
"is_absence": true,
"name": "string",
"name_short": "string",
"parent_curve_id": 0,
"time_zone_id": 0
}

Queue Values by Date and Queue ID

Get queue values by date and queue ID

Authorizations:

AccessToken

path Parameters

curve_id required	integer <int32>
start_date required	string

query Parameters

end_date	string
length	integer <int32>
version_ids	string
zeros	boolean
display	string

Responses

Response samples

200

Content type

application/json

{"curve_event_type_id": 0,
"curve_id": 0,
"curve_value_type_id": 0,
"curve_version_id": 0,
"date": "2019-08-24",
"raster": 0,
"values": [0.1
]
}

Queue Values by Date, Queue ID and Queue Value Type ID

Get queue values by date, queue ID and queue value type ID

Authorizations:

AccessToken

path Parameters

curve_id required	integer <int32>
curve_value_type_id required	integer <int32>
start_date required	string

query Parameters

end_date	string
length	integer <int32>
version_ids	string
zeros	boolean
display	string

Responses

Response samples

200

Content type

application/json

{"curve_event_type_id": 0,
"curve_id": 0,
"curve_value_type_id": 0,
"curve_version_id": 0,
"date": "2019-08-24",
"raster": 0,
"values": [0.1
]
}

Detailed Queue Values by Date and Queue ID

Get detailed queue values by date and queue ID

Authorizations:

AccessToken

path Parameters

curve_id required	integer <int32>
start_date required	string

query Parameters

end_date	string
length	integer <int32>
version_ids	string
zeros	boolean
display	string

Responses

Response samples

200

Content type

application/json

{"curve_event_type_id": 0,
"curve_id": 0,
"curve_value_type_id": 0,
"curve_version_id": 0,
"date": "2019-08-24",
"interval_start": 0,
"interval_end": 0,
"value": 0.1
}

Detailed Queue Values by Date, Queue ID and Queue Value Type ID

Get detailed queue values by date, queue ID and queue value type ID

Authorizations:

AccessToken

path Parameters

curve_id required	integer <int32>
curve_value_type_id required	integer <int32>
start_date required	string

query Parameters

end_date	string
length	integer <int32>
version_ids	string
zeros	boolean
display	string

Responses

Response samples

200

Content type

application/json

{"curve_event_type_id": 0,
"curve_id": 0,
"curve_value_type_id": 0,
"curve_version_id": 0,
"date": "2019-08-24",
"interval_start": 0,
"interval_end": 0,
"value": 0.1
}

Curve Event Types

Operations about curve_event_types

All queue Event Types

Get all queue event types.

Authorizations:

AccessToken

query Parameters

display

string

Responses

Response samples

200

Content type

application/json

{"deleted": true,
"description": "string",
"factors": [0
],
"curve_event_type_id": 0,
"name": "string",
"name_short": "string"
}

Queue Event Type by Queue Event Type ID

Get a queue event type by ID.

Authorizations:

AccessToken

path Parameters

curve_event_type_id

required

integer <int32>

query Parameters

display

string

Responses

Response samples

200

Content type

application/json

{"deleted": true,
"description": "string",
"factors": [0
],
"curve_event_type_id": 0,
"name": "string",
"name_short": "string"
}

Curve Value Types

Operations about curve_value_types

All Queue Value Types

Get all queue value types.

Authorizations:

AccessToken

query Parameters

display

string

Responses

Response samples

200

Content type

application/json

{"aggregation_type": "string",
"deleted": true,
"description": "string",
"curve_value_type_id": 0,
"is_absence": true,
"name": "string",
"name_short": "string"
}

Queue Value Type by Queue Value Type ID

Get a queue value type by ID.

Authorizations:

AccessToken

path Parameters

curve_value_type_id

required

integer <int32>

query Parameters

display

string

Responses

Response samples

200

Content type

application/json

{"aggregation_type": "string",
"deleted": true,
"description": "string",
"curve_value_type_id": 0,
"is_absence": true,
"name": "string",
"name_short": "string"
}

Curve Versions

Operations about curve_versions

All Queue Versions

Get all queue versions.

Authorizations:

AccessToken

query Parameters

display

string

Responses

Response samples

200

Content type

application/json

{"deleted": true,
"description": "string",
"curve_version_id": 0,
"name": "string",
"name_short": "string"
}

Queue Version by Queue Version ID

Get a queue version by ID.

Authorizations:

AccessToken

path Parameters

curve_version_id

required

integer <int32>

query Parameters

display

string

Responses

Response samples

200

Content type

application/json

{"deleted": true,
"description": "string",
"curve_version_id": 0,
"name": "string",
"name_short": "string"
}

Day Models

Operations about day_models

All Day Models

Get all day models.

Authorizations:

AccessToken

query Parameters

display

string

Responses

Response samples

200

Content type

application/json

{"deleted": true,
"color": 0,
"contents": [{ }
],
"day_model_id": 0,
"name": "string",
"name_short": "string",
"type": "string"
}

Day Model by Day Model ID

Get a day model by ID.

Authorizations:

AccessToken

path Parameters

day_model_id

required

integer <int32>

query Parameters

display

string

Responses

Response samples

200

Content type

application/json

{"deleted": true,
"color": 0,
"contents": [{ }
],
"day_model_id": 0,
"name": "string",
"name_short": "string",
"type": "string"
}

Employees

Operations about employees

Employee's Current Address by Employee ID

Get current address for an employee by employee ID

Authorizations:

AccessToken

path Parameters

employee_id

required

integer <int32>

query Parameters

display

string

Responses

Response samples

200

Content type

application/json

{"city": "string",
"country": "string",
"email": "string",
"email_alt": "string",
"employee_id": 0,
"employees_address_id": 0,
"end_date": "2019-08-24",
"first_name": "string",
"last_name": "string",
"marital_status": "string",
"middle_name": "string",
"phone": "string",
"phone_alt": "string",
"start_date": "2019-08-24",
"street": "string",
"telefax": "string",
"title": "string",
"zipcode": "string"
}

Update employee's current address

Request

PATCH https://legacy-api.peopleware.com/v1/employee_current_addresses/1001

{
  "data": {
    "first_name": "John",
    "last_name": "Doe"
  }
}

Response

Status 200

{
  "data": {
    "employees_address_id": 1200,
    "employee_id": 1001,
    "start_date": "2022-01-01",
    "end_date": "4000-01-01",
    "title": "none",
    "first_name": "John",
    "middle_name": "",
    "last_name": "Doe",
    "street": "",
    "zipcode": "",
    "city": "",
    "phone": "",
    "phone_alt": "",
    "telefax": "",
    "email": "john@doe.com",
    "email_alt": "",
    "country": "USA",
    "marital_status": "unknown"
  }
}

Authorizations:

AccessToken

path Parameters

employee_id

required

number

Specific Employee ID

Request Body schema: application/json
required

required

object non-empty

Responses

Request samples

Payload

Content type

application/json

{"data": {"title": "none",
"first_name": "string",
"last_name": "string",
"email": "string",
"country": "string"
}
}

Response samples

200
400

Content type

application/json

{"data": {"employees_address_id": 0,
"employee_id": 0,
"title": "string",
"first_name": "string",
"last_name": "string",
"middle_name": "string",
"street": "string",
"zipcode": "string",
"city": "string",
"phone": "string",
"phone_alt": "string",
"telefax": "string",
"email": "string",
"email_alt": "string",
"marital_status": "string",
"country": "string",
"start_date": "2019-08-24",
"end_date": "2019-08-24"
}
}

Get Contract Assignments

Request

GET https://legacy-api.peopleware.com/v1/employees/1008/contracts/

Response

Status 200

{
  "data": [
    {
      "employees_contract_id": 1157,
      "employee_id": 1008,
      "contract_id": 1007,
      "start_date": "2022-12-01",
      "end_date": "2022-12-13"
    }
  ]
}

Authorizations:

AccessToken

path Parameters

employee_id

required

number

Specific Employee ID

Responses

Response samples

200
400

Content type

application/json

{"data": [{"employees_contract_id": 0,
"employee_id": 0,
"contract_id": 0,
"start_date": "2019-08-24",
"end_date": "2019-08-24"
}
]
}

Create Contract Assignment

Request

POST https://legacy-api.peopleware.com/v1/employees/1008/contracts

{
  "data": {
    "contract_id": 1007,
    "start_date": "2022-12-01",
    "end_date": "2022-12-21"
  }
}

Response

Status 201

{
  "data": {
    "employees_contract_id": 1001,
    "employee_id": 1008,
    "contract_id": 1007,
    "start_date": "2022-12-01",
    "end_date": "2022-12-21"
  }
}

Authorizations:

AccessToken

path Parameters

employee_id

required

number

Specific Employee ID

Request Body schema: application/json
required

required

object non-empty

Responses

Request samples

Payload

Content type

application/json

{"data": {"contract_id": 0,
"start_date": "2019-08-24",
"end_date": "2019-08-24"
}
}

Response samples

201
400

Content type

application/json

{"data": {"employees_contract_id": 0,
"employee_id": 0,
"contract_id": 0,
"start_date": "2019-08-24",
"end_date": "2019-08-24"
}
}

Update Contract Assignment

Request

PATCH https://legacy-api.peopleware.com/v1/employees/1008/contracts/1001

{
  "data": {
    "start_date": "2021-02-01"
  }
}

Response

Status 200

{
  "data": {
    "employees_contract_id": 1001,
    "employee_id": 1008,
    "contract_id": 1007,
    "start_date": "2021-02-01",
    "end_date": "2022-12-21"
  }
}

Authorizations:

AccessToken

path Parameters

employee_id required	number Specific Employee ID
employees_contract_id required	number Specific Employee Contract ID

Request Body schema: application/json
required

required

object non-empty

Responses

Request samples

Payload

Content type

application/json

{"data": {"contract_id": 0,
"start_date": "2019-08-24",
"end_date": "2019-08-24"
}
}

Response samples

200
400

Content type

application/json

{"data": {"employees_contract_id": 0,
"employee_id": 0,
"contract_id": 0,
"start_date": "2019-08-24",
"end_date": "2019-08-24"
}
}

Delete Contract Assignment

Delete the assigned Contract of an Employee

Request

DELETE https://legacy-api.peopleware.com/v1/employees/1008/contracts/1001

Response

Status 204

Authorizations:

AccessToken

path Parameters

employee_id required	number Specific Employee ID
employees_contract_id required	number Specific Employee Contract ID

Responses

Response samples

400
404

Content type

application/json

{"errors": [{"status": "string",
"title": "string",
"message": "string"
}
]
}

Get Employment Periods

Request

GET https://legacy-api.peopleware.com/v1/employees/1001/employment_periods

Response

Status 200

{
  "data": [
    {
      "employment_period_id": 1001,
      "employee_id": 1001,
      "start_date": "2023-01-01",
      "end_date": "2023-12-31"
    }
  ]
}

Authorizations:

AccessToken

path Parameters

employee_id

required

number

Specific Employee ID

Responses

Response samples

200
400

Content type

application/json

{"data": [{"employment_period_id": 0,
"employee_id": 0,
"start_date": "2019-08-24",
"end_date": "2019-08-24"
}
]
}

Create Employment Period

Request

POST https://legacy-api.peopleware.com/v1/employees/1001/employment_periods

{
  "data": {
    "start_date": "2023-01-01",
    "end_date": "2023-12-31"
  }
}

Response

Status 201

{
  "data": {
    "employment_period_id": 1001,
    "employee_id": 1001,
    "start_date": "2023-01-01",
    "end_date": "2023-12-31"
  }
}

Authorizations:

AccessToken

path Parameters

employee_id

required

number

Specific Employee ID

Request Body schema: application/json
required

required

object non-empty

Responses

Request samples

Payload

Content type

application/json

{"data": {"start_date": "2019-08-24",
"end_date": "2019-08-24"
}
}

Response samples

201
400

Content type

application/json

{"data": {"employment_period_id": 0,
"employee_id": 0,
"start_date": "2019-08-24",
"end_date": "2019-08-24"
}
}

Get specific Employment Period

Request

GET https://legacy-api.peopleware.com/v1/employees/1001/employment_periods/1001

Response

Status 200

{
  "data": {
    "employment_period_id": 1001,
    "employee_id": 1001,
    "start_date": "2023-01-01",
    "end_date": "2023-12-31"
  }
}

Authorizations:

AccessToken

path Parameters

employee_id required	number Specific Employee ID
employment_period_id required	number Specific Employment Period ID

Responses

Response samples

200
400
404

Content type

application/json

{"data": {"employment_period_id": 0,
"employee_id": 0,
"start_date": "2019-08-24",
"end_date": "2019-08-24"
}
}

Update Employment Period

Request

PATCH https://legacy-api.peopleware.com/v1/employees/1001/employment_periods/1001

{
  "data": {
    "start_date": "2023-02-01"
  }
}

Response

Status 200

{
  "data": {
    "employment_period_id": 1001,
    "employee_id": 1001,
    "start_date": "2023-02-01",
    "end_date": "2023-12-31"
  }
}

Authorizations:

AccessToken

path Parameters

employee_id required	number Specific Employee ID
employment_period_id required	number Specific Employment Period ID

Request Body schema: application/json
required

required

object non-empty

Responses

Request samples

Payload

Content type

application/json

{"data": {"start_date": "2019-08-24",
"end_date": "2019-08-24"
}
}

Response samples

200
400

Content type

application/json

{"data": {"employment_period_id": 0,
"employee_id": 0,
"start_date": "2019-08-24",
"end_date": "2019-08-24"
}
}

Delete specific Employment Period

Request

DELETE https://legacy-api.peopleware.com/v1/employees/1001/employment_periods/1001

Response

Status 204

Authorizations:

AccessToken

path Parameters

employee_id required	number Specific Employee ID
employment_period_id required	number Specific Employment Period ID

Responses

Response samples

400
404

Content type

application/json

{"errors": [{"status": "string",
"title": "string",
"message": "string"
}
]
}

Get Planning Unit Assignments

Request

GET https://legacy-api.peopleware.com/v1/employees/1008/planning_units

Response

Status 200

{
  "data": [
    {
      "employees_membership_id": 1157,
      "employee_id": 1008,
      "planning_unit_id": 1007,
      "start_date": "2022-12-01",
      "end_date": "2022-12-13",
      "priority": 1
    }
  ]
}

Authorizations:

AccessToken

path Parameters

employee_id

required

number

Specific Employee ID

Responses

Response samples

200
400

Content type

application/json

{"data": [{"employees_membership_id": 0,
"employee_id": 0,
"planning_unit_id": 0,
"start_date": "2019-08-24",
"end_date": "2019-08-24",
"priority": 0
}
]
}

Create Planning Unit Assignment

Request

POST https://legacy-api.peopleware.com/v1/employees/1008/planning_units

{
  "data": {
    "planning_unit_id": 1007,
    "start_date": "2022-12-01",
    "end_date": "2022-12-21"
  }
}

Response

Status 201

{
  "data": {
    "employees_membership_id": 1157,
    "employee_id": 1008,
    "planning_unit_id": 1007,
    "start_date": "2022-12-01",
    "end_date": "2022-12-13",
    "priority": 1
  }
}

Authorizations:

AccessToken

path Parameters

employee_id

required

number

Specific Employee ID

Request Body schema: application/json
required

required

object non-empty

Responses

Request samples

Payload

Content type

application/json

{"data": {"planning_unit_id": 0,
"start_date": "2019-08-24",
"end_date": "2019-08-24",
"priority": 0
}
}

Response samples

201
400

Content type

application/json

{"data": {"employees_membership_id": 0,
"employee_id": 0,
"planning_unit_id": 0,
"start_date": "2019-08-24",
"end_date": "2019-08-24",
"priority": 0
}
}

Update Planning Unit Assignment

Request

PATCH https://legacy-api.peopleware.com/v1/employees/1008/planning_units/1001

{
  "data": {
    "start_date": "2021-02-01",
    "priority": 2
  }
}

Response

Status 200

{
  "data": {
    "employees_membership_id": 1157,
    "employee_id": 1008,
    "planning_unit_id": 1007,
    "start_date": "2021-02-01",
    "end_date": "2022-12-13",
    "priority": 2
  }
}

Authorizations:

AccessToken

path Parameters

employee_id required	number Specific Employee ID
employees_membership_id required	number Specific Employee Membership ID

Request Body schema: application/json
required

required

object non-empty

Responses

Request samples

Payload

Content type

application/json

{"data": {"planning_unit_id": 0,
"start_date": "2019-08-24",
"end_date": "2019-08-24",
"priority": 0
}
}

Response samples

200
400

Content type

application/json

{"data": {"employees_membership_id": 0,
"employee_id": 0,
"planning_unit_id": 0,
"start_date": "2019-08-24",
"end_date": "2019-08-24",
"priority": 0
}
}

Delete Planning Unit Assignment

Request

DELETE https://legacy-api.peopleware.com/v1/employees/1008/planning_units/1001

Response

Status 204

Authorizations:

AccessToken

path Parameters

employee_id required	number Specific Employee ID
employees_membership_id required	number Specific Employee Membership ID

Responses

Response samples

400
404

Content type

application/json

{"errors": [{"status": "string",
"title": "string",
"message": "string"
}
]
}

Get Skill Level Assignments

Request

GET https://legacy-api.peopleware.com/v1/employees/1008/skill_levels

Response

Status 200

{
  "data": [
    {
      "employees_skill_level_id": 1157,
      "employee_id": 1008,
      "skill_id": 1002,
      "skill_level_id": 1003,
      "start_date": "2022-12-01",
      "end_date": "2022-12-13"
    }
  ]
}

Authorizations:

AccessToken

path Parameters

employee_id

required

number

Specific Employee ID

Responses

Response samples

200
400

Content type

application/json

{"data": [{"employees_skill_level_id": 0,
"employee_id": 0,
"skill_id": 0,
"skill_level_id": 0,
"start_date": "2019-08-24",
"end_date": "2019-08-24"
}
]
}

Create Skill Level Assignment

Request

POST https://legacy-api.peopleware.com/v1/employees/1008/skill_levels

{
  "data": {
    "skill_level_id": 1003,
    "start_date": "2022-12-01",
    "end_date": "2022-12-21"
  }
}

Response

Status 201

{
  "data": {
    "employees_skill_level_id": 1001,
    "employee_id": 1008,
    "skill_id": 1002,
    "skill_level_id": 1003,
    "start_date": "2022-12-01",
    "end_date": "2022-12-21"
  }
}

Authorizations:

AccessToken

path Parameters

employee_id

required

number

Specific Employee ID

Request Body schema: application/json
required

required

object non-empty

Responses

Request samples

Payload

Content type

application/json

{"data": {"skill_level_id": 0,
"start_date": "2019-08-24",
"end_date": "2019-08-24"
}
}

Response samples

201
400

Content type

application/json

{"data": {"employees_skill_level_id": 0,
"employee_id": 0,
"skill_id": 0,
"skill_level_id": 0,
"start_date": "2019-08-24",
"end_date": "2019-08-24"
}
}

Update Skill Level Assignment

Request

PATCH https://legacy-api.peopleware.com/v1/employees/1008/skill_levels/1001

{
  "data": {
    "start_date": "2021-02-01"
  }
}

Response

Status 200

{
  "data": {
    "employees_skill_level_id": 1001,
    "employee_id": 1008,
    "skill_id": 1002,
    "skill_level_id": 1003,
    "start_date": "2021-02-01",
    "end_date": "2022-12-21"
  }
}

Authorizations:

AccessToken

path Parameters

employee_id required	number Specific Employee ID
employees_skill_level_id required	number Specific Employee Skill Level ID

Request Body schema: application/json
required

required

object non-empty

Responses

Request samples

Payload

Content type

application/json

{"data": {"skill_level_id": 0,
"start_date": "2019-08-24",
"end_date": "2019-08-24"
}
}

Response samples

200
400

Content type

application/json

{"data": {"employees_skill_level_id": 0,
"employee_id": 0,
"skill_id": 0,
"skill_level_id": 0,
"start_date": "2019-08-24",
"end_date": "2019-08-24"
}
}

Delete Skill Level Assignment

Request

DELETE https://legacy-api.peopleware.com/v1/employees/1008/skill_levels/1001

Response

Status 204

Authorizations:

AccessToken

path Parameters

employee_id required	number Specific Employee ID
employees_skill_level_id required	number Specific Employee Skill Level ID

Responses

Response samples

400
404

Content type

application/json

{"errors": [{"status": "string",
"title": "string",
"message": "string"
}
]
}

Get Employee Selections

Request

GET https://legacy-api.peopleware.com/v1/employees/1001/selections

Response

Status 200

{
  "data": [
    {
      "selection_id": 1001,
      "employee_id": 1001,
      "start_date": "2022-01-01",
      "end_date": "2022-02-01"
    }
  ]
}

Authorizations:

AccessToken

path Parameters

employee_id

required

number

Specific Employee ID

Responses

Response samples

200
400

Content type

application/json

{"data": [{"selection_id": 0,
"employee_id": 0,
"start_date": "2019-08-24",
"end_date": "2019-08-24"
}
]
}

Create Employee Selection

Request

POST https://legacy-api.peopleware.com/v1/employees/1001/selections

{
  "data": {
    "selection_id": 1001,
    "start_date": "2022-05-01",
    "end_date": "2022-05-01"
  }
}

Response

Status 201

{
  "data": {
    "selection_id": 1001,
    "employee_id": 1001,
    "start_date": "2022-05-01",
    "end_date": "2022-05-01"
  }
}

Authorizations:

AccessToken

path Parameters

employee_id

required

number

Specific Employee ID

Request Body schema: application/json
required

required

object non-empty

Responses

Request samples

Payload

Content type

application/json

{"data": {"selection_id": 0,
"start_date": "2019-08-24",
"end_date": "2019-08-24"
}
}

Response samples

201
400

Content type

application/json

{"data": {"selection_id": 0,
"employee_id": 0,
"start_date": "2019-08-24",
"end_date": "2019-08-24"
}
}

Delete Employee Selection

Request

DELETE https://legacy-api.peopleware.com/v1/employees/1001/selections/1002?start_date=2022-05-01&end_date=2022-05-01

Response

Status 204

Authorizations:

AccessToken

path Parameters

employee_id required	number Specific Employee ID
selection_id required	number Specific Selection ID

query Parameters

start_date	string <date> Start Date
end_date	string <date> End Date

Responses

Response samples

400
404

Content type

application/json

{"errors": [{"status": "string",
"title": "string",
"message": "string"
}
]
}

Update Employee Selection

Request

PATCH https://legacy-api.peopleware.com/v1/employees/1001/selections/1001?start_date=2022-05-01&end_date=2022-05-01

{
  "data": {
    "selection_id": 1002
  }
}

Response

Status 200

{
  "data": {
    "selection_id": 1002,
    "employee_id": 1001,
    "start_date": "2022-05-01",
    "end_date": "2022-05-01"
  }
}

Note

The Selection ID in the payload must be different from the Selection ID in the URL.

Authorizations:

AccessToken

path Parameters

employee_id required	number Specific Employee ID
selection_id required	number Specific Selection ID

query Parameters

start_date	string <date> Start Date
end_date	string <date> End Date

Request Body schema: application/json
required

required

object non-empty

Responses

Request samples

Payload

Content type

application/json

{"data": {"selection_id": 0
}
}

Response samples

200
400

Content type

application/json

{"data": {"selection_id": 0,
"employee_id": 0,
"start_date": "2019-08-24",
"end_date": "2019-08-24"
}
}

Get all Attribute Values for a specific Employee.

Request

GET https://legacy-api.peopleware.com/v1/employees/1008/attribute_values

Response

Status 200

{
  "data": [
    {
      "attribute_value_id": 1157,
      "employee_id": 1008,
      "attribute_id": 1002,
      "priority": 1,
      "value": 34,
      "start_date": "2022-12-01",
      "end_date": "2022-12-13"
    }
  ]
}

Authorizations:

AccessToken

path Parameters

employee_id

required

number

Specific Employee ID

Responses

Response samples

200
400

Content type

application/json

{"data": [{"attribute_value_id": 0,
"attribute_id": 0,
"start_date": "2019-08-24",
"end_date": "2019-08-24",
"priority": 0,
"value": "string",
"employee_id": 0
}
]
}

Create Employee Attribute Values

Request

POST https://legacy-api.peopleware.com/v1/employees/1008/attribute_values

{
  "data": {
    "employee_id": 1008,
    "attribute_id": 1001,
    "priority": 1,
    "value": 34,
    "type": "number",
    "start_date": "2022-12-01",
    "end_date": "2022-12-21"
  }
}

Note

The type in the payload can be one of the following: text, number, time, date or boolean

Response

Status 201

{
  "data": {
    "attribute_value_id": 1157,
    "employee_id": 1008,
    "attribute_id": 1001,
    "priority": 1,
    "value": 34,
    "start_date": "2022-12-01",
    "end_date": "2022-12-21"
  }
}

Authorizations:

AccessToken

path Parameters

employee_id

required

number

Specific Employee ID

Request Body schema: application/json
required

required

object non-empty

Responses

Request samples

Payload

Content type

application/json

{"data": {"attribute_id": 0,
"employee_id": 0,
"value": "string",
"type": "text",
"start_date": "2019-08-24",
"end_date": "2019-08-24",
"priority": 0
}
}

Response samples

201
400

Content type

application/json

{"data": {"attribute_value_id": 0,
"attribute_id": 0,
"start_date": "2019-08-24",
"end_date": "2019-08-24",
"priority": 0,
"value": "string",
"employee_id": 0
}
}

Update Employee Attribute Value

Request

PATCH https://legacy-api.peopleware.com/v1/employees/1008/attribute_values/1157

{
  "data": {
    "priority": 1,
    "value": 34,
    "start_date": "2022-12-01",
    "end_date": "2022-12-21"
  }
}

Note

The data type of the value field in the payload depends on the Attribute assigned to the Attribute Value being updated.

Response

Status 200

{
  "data": {
    "attribute_value_id": 1157,
    "employee_id": 1008,
    "attribute_id": 1001,
    "priority": 1,
    "value": 34,
    "start_date": "2022-12-01",
    "end_date": "2022-12-21"
  }
}

Authorizations:

AccessToken

path Parameters

employee_id required	number Specific Employee ID
attribute_value_id required	number Specific Attribute Value ID

Request Body schema: application/json
required

required

object non-empty

Responses

Request samples

Payload

Content type

application/json

{"data": {"value": "string",
"start_date": "2019-08-24",
"end_date": "2019-08-24",
"priority": 0
}
}

Response samples

200
400
404

Content type

application/json

{"data": {"attribute_value_id": 0,
"attribute_id": 0,
"start_date": "2019-08-24",
"end_date": "2019-08-24",
"priority": 0,
"value": "string",
"employee_id": 0
}
}

Delete Attribute Value

Request

DELETE https://legacy-api.peopleware.com/v1/employees/1008/attribute_values/1157

Response

Status 204

Authorizations:

AccessToken

path Parameters

employee_id required	number Specific Employee ID
attribute_value_id required	number Specific Attribute Value ID

Responses

Response samples

400
404

Content type

application/json

{"errors": [{"status": "string",
"title": "string",
"message": "string"
}
]
}

Absences of an employee

Get absences of an employee in a time range from level plan or specified level.

Authorizations:

AccessToken

path Parameters

employee_id required	integer <int32>
start_date required	string

query Parameters

end_date	string
length	integer <int32>
level	string (level) Enum: "plan" "wishes" "alternative_wishes" "absence_wishes" "final" "time_recording" "correction" "acd" "availabilities" "on_call" "productivity" "backup" "backup_version_2" "backup_version_3" "overtime"
absence_types	string
display	string

Responses

Response samples

200

Content type

application/json

{"start_time": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"planning_unit_id": 0,
"employee_id": 0,
"activity_id": 0,
"activity_name": "string",
"activity_name_short": "string"
}

Adherence Scores by Date and Employee ID

Get adherence scores by date and employee ID

Authorizations:

AccessToken

path Parameters

employee_id required	integer <int32>
start_date required	string

query Parameters

end_date	string
length	integer <int32>
schedule_level	string (level) Enum: "plan" "wishes" "alternative_wishes" "absence_wishes" "final" "time_recording" "correction" "acd" "availabilities" "on_call" "productivity" "backup" "backup_version_2" "backup_version_3" "overtime"
actual_level	string (level) Enum: "plan" "wishes" "alternative_wishes" "absence_wishes" "final" "time_recording" "correction" "acd" "availabilities" "on_call" "productivity" "backup" "backup_version_2" "backup_version_3" "overtime"
zeros	boolean
display	string

Responses

Response samples

200

Content type

application/json

{"activity_type": "string",
"actual_time": 0,
"adherence_percentage": 0.1,
"conformance_percentage": 0.1,
"date": "2019-08-24",
"employee_id": 0,
"minutes_in_adherence": 0,
"minutes_out_adherence": 0,
"minutes_out_conformance": 0,
"scheduled_time": 0
}

Get attribute values for one employee

Authorizations:

AccessToken

path Parameters

employee_id required	integer <int32>
start_date required	string

query Parameters

end_date	string
length	integer <int32>
display	string

Responses

Response samples

200

Content type

application/json

{"attribute_id": 0,
"employee_id": 0,
"end_date": "2019-08-24",
"attribute_value_id": 0,
"priority": 0,
"start_date": "2019-08-24",
"value": "string"
}

Comments by Date and Employee ID

Get comments by date and employee ID

Authorizations:

AccessToken

path Parameters

employee_id required	integer <int32>
start_date required	string

query Parameters

end_date	string
length	integer <int32>
levels	string (levels) A comma separated list of levels. Allowed levels are: plan wishes alternative_wishes absence_wishes final time_recording correction acd availabilities on_call productivity backup backup_version_2 backup_version_3 overtime
display	string

Responses

Response samples

200

Content type

application/json

{"date": "2019-08-24",
"employee_id": 0,
"level": 1000,
"text": "string"
}

All Employees

Get all employees.

Authorizations:

AccessToken

query Parameters

include_userid	boolean
display	string

Responses

Response samples

200

Content type

application/json

{"birth_date": "2019-08-24",
"birth_place": "string",
"color": 0,
"current_identification": "string",
"deleted": true,
"employee_id": 0,
"first_name": "string",
"last_name": "string",
"personnel_number": "string",
"schedule_position": 0,
"automated_shift_assignment": true,
"user_id": 0
}

Employee by Employee ID

Get an employee by ID.

Authorizations:

AccessToken

path Parameters

employee_id

required

integer <int32>

query Parameters

include_userid	boolean
display	string

Responses

Response samples

200

Content type

application/json

{"birth_date": "2019-08-24",
"birth_place": "string",
"color": 0,
"current_identification": "string",
"deleted": true,
"employee_id": 0,
"first_name": "string",
"last_name": "string",
"personnel_number": "string",
"schedule_position": 0,
"automated_shift_assignment": true,
"user_id": 0
}

Employee Contracts by Date and Employee ID

Get employee contracts by date and employee ID

Authorizations:

AccessToken

path Parameters

employee_id required	integer <int32>
start_date required	string

query Parameters

end_date	string
length	integer <int32>
display	string

Responses

Response samples

200

Content type

application/json

{"contract_id": 0,
"employee_id": 0,
"end_date": "2019-08-24",
"start_date": "2019-08-24"
}

Current Employee's Employment Period by Employee ID

Get current employment period for an employee by employee ID

Authorizations:

AccessToken

path Parameters

employee_id

required

integer <int32>

query Parameters

display

string

Responses

Response samples

200

Content type

application/json

{"employee_id": 0,
"end_date": "2019-08-24",
"start_date": "2019-08-24"
}

Employee External Systems by Date and Employee ID

Get employee external systems by date and employee ID

Authorizations:

AccessToken

path Parameters

employee_id required	integer <int32>
start_date required	string

query Parameters

end_date	string
length	integer <int32>
display	string

Responses

Response samples

200

Content type

application/json

{"active": true,
"employee_id": 0,
"extension": 0,
"external_identification": 0,
"external_system_id": 0,
"end_date": "2019-08-24",
"start_date": "2019-08-24"
}

Employee Planning Units by Date and Employee ID

Get employee planning units by date and employee ID

Authorizations:

AccessToken

path Parameters

employee_id required	integer <int32>
start_date required	string

query Parameters

end_date	string
length	integer <int32>
display	string

Responses

Response samples

200

Content type

application/json

{"employee_id": 0,
"end_date": "2019-08-24",
"planning_unit_id": 0,
"priority": 0,
"start_date": "2019-08-24"
}

Employee Selections by Date and Employee ID

Get employee selections by date and employee ID

Authorizations:

AccessToken

path Parameters

employee_id required	integer <int32>
start_date required	string

query Parameters

end_date	string
length	integer <int32>
display	string

Responses

Response samples

200

Content type

application/json

{"selection_id": 0,
"employee_id": 0,
"end_date": "2019-08-24",
"start_date": "2019-08-24"
}

Employee Shift Sequences by Date and Employee ID

Get employee shift sequences by date and employee ID

Authorizations:

AccessToken

path Parameters

employee_id required	integer <int32>
start_date required	string

query Parameters

end_date	string
length	integer <int32>
display	string

Responses

Response samples

200

Content type

application/json

{"anchor_date": "2019-08-24",
"employee_id": 0,
"end_date": "2019-08-24",
"priority": 0,
"shift_sequence_id": 0,
"shift_sequence_row": 0,
"start_date": "2019-08-24"
}

Employee Skill Levels by Date and Employee ID

Get employee skill levels by date and employee ID

Authorizations:

AccessToken

path Parameters

employee_id required	integer <int32>
start_date required	string <date>

query Parameters

end_date	string
length	integer <int32>
display	string

Responses

Response samples

200

Content type

application/json

{"employee_id": 0,
"end_date": "2019-08-24",
"skill_id": 0,
"skill_level_id": 0,
"start_date": "2019-08-24"
}

Holiday Annuals by Year and Employee ID

Get holiday annuals by year and employee ID

Authorizations:

AccessToken

path Parameters

employee_id required	integer <int32>
year required	string

query Parameters

level	string (level) Enum: "plan" "wishes" "alternative_wishes" "absence_wishes" "final" "time_recording" "correction" "acd" "availabilities" "on_call" "productivity" "backup" "backup_version_2" "backup_version_3" "overtime"
display	string

Responses

Response samples

200

Content type

application/json

{"contract_id": 0,
"employee_id": 0,
"entitlement_in_hours": 0.1,
"scheduled_in_hours": 0.1,
"remaining_in_hours": 0.1,
"end_date": "2019-08-24",
"start_date": "2019-08-24",
"year": 0
}

Plan Data Requests by Date and Employee ID

Get plan data requests by date and employee ID

Authorizations:

AccessToken

path Parameters

employee_id required	integer <int32>
start_date required	string

query Parameters

end_date	string
length	integer <int32>
status	string Enum: "pending" "approved" "rejected"
display	string

Responses

Response samples

200

Content type

application/json

{"activity_id": 0,
"all_day": true,
"comment": "string",
"duration": 0.1,
"employee_id": 0,
"end_time": "2019-08-24",
"start_time": "2019-08-24",
"plan_data_request_id": 0,
"status": "string"
}

Schedules by Date and Employee ID

Get schedules by date and employee ID

Authorizations:

AccessToken

path Parameters

employee_id required	integer <int32>
start_date required	string

query Parameters

activity_types	string
activity_ids	string
levels	string (levels) A comma separated list of levels. Allowed levels are: plan wishes alternative_wishes absence_wishes final time_recording correction acd availabilities on_call productivity backup backup_version_2 backup_version_3 overtime
only_paid	boolean
with_unfinished	boolean
display	string

Responses

Response samples

200

Content type

application/json

{"booking_date": "2019-08-24",
"employee_id": 0,
"level": "plan",
"planning_unit_id": 0,
"schedule_blocks": [{"activity_id": 0,
"time_end": "2019-08-24T14:15:22Z",
"time_start": "2019-08-24T14:15:22Z",
"type": "string"
}
]
}

Pending Shift Exchanges by Date and Employee ID

Get pending shift exchanges by date and employee ID

Authorizations:

AccessToken

path Parameters

employee_id required	integer <int32>
start_date required	string

query Parameters

end_date	string
length	integer <int32>
display	string

Responses

Response samples

200

Content type

application/json

{"offer": [{"date": "2019-08-24",
"employee_id": 0,
"comment": "string"
}
],
"counter_offers": [{"date": "2019-08-24",
"employee_id": 0,
"comment": "string"
}
],
"available_offers": [{"date": "2019-08-24",
"employee_id": 0,
"comment": "string"
}
],
"counter_offers_received": [{"date": "2019-08-24",
"employee_id": 0,
"comment": "string"
}
],
"commitment": [{"shift_exchange_commitment_id": 0,
"date": "2019-08-24",
"cross_exchange_date": "2019-08-24",
"employee_id": 0,
"accepting_employee_id": 0,
"status": "string",
"modification_date": "2019-08-24"
}
]
}

All Employees from Planning Unit by Date and Planning Unit ID

Get all employees belonging to a planning unit by date and planning unit ID

Authorizations:

AccessToken

path Parameters

planning_unit_id required	integer <int32>
start_date required	string

query Parameters

end_date	string
length	integer <int32>
include_userid	boolean
display	string

Responses

Response samples

200

Content type

application/json

{"birth_date": "2019-08-24",
"birth_place": "string",
"color": 0,
"current_identification": "string",
"deleted": true,
"employee_id": 0,
"first_name": "string",
"last_name": "string",
"personnel_number": "string",
"schedule_position": 0,
"automated_shift_assignment": true,
"user_id": 0
}

All Employees' Current Address

Response object

Name	Type	Description
employees_address_id	Integer	The unique identifier of an Employee Address
employee_id	Integer	The unique identifier of the related Employee
start_date	String	ISO8601 formatted date
end_date	String	ISO8601 formatted date
title	String	Allowed values are: `none`, `company`, `mister`, `misses` or `miss`
middle_name	String	–
first_name	String	Is referring to the name of the Employee and first name of the User
last_name	String	Is referring to the name of the Employee and last name of the User
street	String	–
zipcode	String	–
city	String	–
phone	String	–
phone_alt	String	–
telefax	String	–
email	String	Is referring to the login e-mail of the User
email_alt	String	–
country	String	–
marital_status	String	Allowed values are: `unknown`, `single`, `married`, `widowed` or `divorced`

Authorizations:

AccessToken

query Parameters

display

string

Responses

Response samples

200

Content type

application/json

{"city": "string",
"country": "string",
"email": "string",
"email_alt": "string",
"employee_id": 0,
"employees_address_id": 0,
"end_date": "2019-08-24",
"first_name": "string",
"last_name": "string",
"marital_status": "string",
"middle_name": "string",
"phone": "string",
"phone_alt": "string",
"start_date": "2019-08-24",
"street": "string",
"telefax": "string",
"title": "string",
"zipcode": "string"
}

All Employees' Employment Periods

Get employment periods for all employees.

Authorizations:

AccessToken

query Parameters

display

string

Responses

Response samples

200

Content type

application/json

{"employee_id": 0,
"end_date": "2019-08-24",
"start_date": "2019-08-24"
}

Employee's Employment Periods by Employee ID

Get employment periods for an employee by employee ID

Authorizations:

AccessToken

path Parameters

employee_id

required

integer <int32>

query Parameters

display

string

Responses

Response samples

200

Content type

application/json

{"employee_id": 0,
"end_date": "2019-08-24",
"start_date": "2019-08-24"
}

Employee identification cards by date range

Get employee identification cards by date range

Authorizations:

AccessToken

path Parameters

start_date

required

string

query Parameters

end_date	string
length	integer <int32>
display	string

Responses

Response samples

200

Content type

application/json

{"identification_card_id": 0,
"employee_id": 0,
"identification": "string",
"start_date": "2019-08-24",
"end_date": "2019-08-24"
}

Employee Planning Units by Date

Get employee planning units by date

Authorizations:

AccessToken

path Parameters

start_date

required

string

query Parameters

employee_id	integer <int32>
end_date	string
length	integer <int32>
display	string

Responses

Response samples

200

Content type

application/json

{"employee_id": 0,
"end_date": "2019-08-24",
"planning_unit_id": 0,
"priority": 0,
"start_date": "2019-08-24"
}

Employee Selections by date

Get employee selections by date

Authorizations:

AccessToken

path Parameters

start_date

required

string

query Parameters

end_date	string
length	integer <int32>
display	string

Responses

Response samples

200

Content type

application/json

{"selection_id": 0,
"employee_id": 0,
"end_date": "2019-08-24",
"start_date": "2019-08-24"
}

Employment Periods

Employment Periods for specific Employee

Get Employment Periods

Request

GET https://legacy-api.peopleware.com/v1/employees/1001/employment_periods

Response

Status 200

{
  "data": [
    {
      "employment_period_id": 1001,
      "employee_id": 1001,
      "start_date": "2023-01-01",
      "end_date": "2023-12-31"
    }
  ]
}

Authorizations:

AccessToken

path Parameters

employee_id

required

number

Specific Employee ID

Responses

Response samples

200
400

Content type

application/json

{"data": [{"employment_period_id": 0,
"employee_id": 0,
"start_date": "2019-08-24",
"end_date": "2019-08-24"
}
]
}

Create Employment Period

Request

POST https://legacy-api.peopleware.com/v1/employees/1001/employment_periods

{
  "data": {
    "start_date": "2023-01-01",
    "end_date": "2023-12-31"
  }
}

Response

Status 201

{
  "data": {
    "employment_period_id": 1001,
    "employee_id": 1001,
    "start_date": "2023-01-01",
    "end_date": "2023-12-31"
  }
}

Authorizations:

AccessToken

path Parameters

employee_id

required

number

Specific Employee ID

Request Body schema: application/json
required

required

object non-empty

Responses

Request samples

Payload

Content type

application/json

{"data": {"start_date": "2019-08-24",
"end_date": "2019-08-24"
}
}

Response samples

201
400

Content type

application/json

{"data": {"employment_period_id": 0,
"employee_id": 0,
"start_date": "2019-08-24",
"end_date": "2019-08-24"
}
}

Get specific Employment Period

Request

GET https://legacy-api.peopleware.com/v1/employees/1001/employment_periods/1001

Response

Status 200

{
  "data": {
    "employment_period_id": 1001,
    "employee_id": 1001,
    "start_date": "2023-01-01",
    "end_date": "2023-12-31"
  }
}

Authorizations:

AccessToken

path Parameters

employee_id required	number Specific Employee ID
employment_period_id required	number Specific Employment Period ID

Responses

Response samples

200
400
404

Content type

application/json

{"data": {"employment_period_id": 0,
"employee_id": 0,
"start_date": "2019-08-24",
"end_date": "2019-08-24"
}
}

Update Employment Period

Request

PATCH https://legacy-api.peopleware.com/v1/employees/1001/employment_periods/1001

{
  "data": {
    "start_date": "2023-02-01"
  }
}

Response

Status 200

{
  "data": {
    "employment_period_id": 1001,
    "employee_id": 1001,
    "start_date": "2023-02-01",
    "end_date": "2023-12-31"
  }
}

Authorizations:

AccessToken

path Parameters

employee_id required	number Specific Employee ID
employment_period_id required	number Specific Employment Period ID

Request Body schema: application/json
required

required

object non-empty

Responses

Request samples

Payload

Content type

application/json

{"data": {"start_date": "2019-08-24",
"end_date": "2019-08-24"
}
}

Response samples

200
400

Content type

application/json

{"data": {"employment_period_id": 0,
"employee_id": 0,
"start_date": "2019-08-24",
"end_date": "2019-08-24"
}
}

Delete specific Employment Period

Request

DELETE https://legacy-api.peopleware.com/v1/employees/1001/employment_periods/1001

Response

Status 204

Authorizations:

AccessToken

path Parameters

employee_id required	number Specific Employee ID
employment_period_id required	number Specific Employment Period ID

Responses

Response samples

400
404

Content type

application/json

{"errors": [{"status": "string",
"title": "string",
"message": "string"
}
]
}

Current Employee's Employment Period by Employee ID

Get current employment period for an employee by employee ID

Authorizations:

AccessToken

path Parameters

employee_id

required

integer <int32>

query Parameters

display

string

Responses

Response samples

200

Content type

application/json

{"employee_id": 0,
"end_date": "2019-08-24",
"start_date": "2019-08-24"
}

All Employees' Employment Periods

Get employment periods for all employees.

Authorizations:

AccessToken

query Parameters

display

string

Responses

Response samples

200

Content type

application/json

{"employee_id": 0,
"end_date": "2019-08-24",
"start_date": "2019-08-24"
}

Employee's Employment Periods by Employee ID

Get employment periods for an employee by employee ID

Authorizations:

AccessToken

path Parameters

employee_id

required

integer <int32>

query Parameters

display

string

Responses

Response samples

200

Content type

application/json

{"employee_id": 0,
"end_date": "2019-08-24",
"start_date": "2019-08-24"
}

External Systems

Operations about external_systems

Employee External Systems by Date and Employee ID

Get employee external systems by date and employee ID

Authorizations:

AccessToken

path Parameters

employee_id required	integer <int32>
start_date required	string

query Parameters

end_date	string
length	integer <int32>
display	string

Responses

Response samples

200

Content type

application/json

{"active": true,
"employee_id": 0,
"extension": 0,
"external_identification": 0,
"external_system_id": 0,
"end_date": "2019-08-24",
"start_date": "2019-08-24"
}

Employee External Systems by Date and Planning Unit ID

Get employee external systems by date and planning unit ID

Authorizations:

AccessToken

path Parameters

planning_unit_id required	integer <int32>
start_date required	string

query Parameters

end_date	string
length	integer <int32>
display	string

Responses

Response samples

200

Content type

application/json

{"active": true,
"employee_id": 0,
"extension": 0,
"external_identification": 0,
"external_system_id": 0,
"end_date": "2019-08-24",
"start_date": "2019-08-24"
}

All External Systems

Get all external systems.

Authorizations:

AccessToken

query Parameters

display

string

Responses

Response samples

200

Content type

application/json

{"connect_string_1": "string",
"connect_string_2": "string",
"connect_string_3": "string",
"deleted": true,
"external_component_id": 0,
"external_system_id": 0,
"is_employee_link": true,
"is_phone_link": true,
"is_real_time_option": true,
"is_time_link": true,
"name": "string"
}

External System by External System ID

Get an external system by ID.

Authorizations:

AccessToken

path Parameters

external_system_id

required

integer <int32>

query Parameters

display

string

Responses

Response samples

200

Content type

application/json

{"connect_string_1": "string",
"connect_string_2": "string",
"connect_string_3": "string",
"deleted": true,
"external_component_id": 0,
"external_system_id": 0,
"is_employee_link": true,
"is_phone_link": true,
"is_real_time_option": true,
"is_time_link": true,
"name": "string"
}

Holidays

Operations about holidays

Holiday Annuals by Year and Planning Unit ID

Get holiday annuals by year and planning unit ID

Authorizations:

AccessToken

path Parameters

planning_unit_id required	integer <int32>
year required	string

query Parameters

level	string (level) Enum: "plan" "wishes" "alternative_wishes" "absence_wishes" "final" "time_recording" "correction" "acd" "availabilities" "on_call" "productivity" "backup" "backup_version_2" "backup_version_3" "overtime"
display	string

Responses

Response samples

200

Content type

application/json

{"contract_id": 0,
"employee_id": 0,
"entitlement_in_hours": 0.1,
"scheduled_in_hours": 0.1,
"remaining_in_hours": 0.1,
"end_date": "2019-08-24",
"start_date": "2019-08-24",
"year": 0
}

All Holidays

Get all holidays.

Authorizations:

AccessToken

query Parameters

display

string

Responses

Response samples

200

Content type

application/json

{"remaining": 0,
"employee_id": 0,
"entitlement": 0,
"holiday_id": 0,
"year": 0
}

Holiday by Holiday ID

Get a holiday by ID.

Authorizations:

AccessToken

path Parameters

holiday_id

required

integer <int32>

query Parameters

display

string

Responses

Response samples

200

Content type

application/json

{"remaining": 0,
"employee_id": 0,
"entitlement": 0,
"holiday_id": 0,
"year": 0
}

Holidays by Year.

Get all holidays of a year.

Authorizations:

AccessToken

path Parameters

year

required

string

query Parameters

employee_ids	string
planning_unit_id	integer <int32>
display	string

Responses

Response samples

200

Content type

application/json

{"remaining": 0,
"employee_id": 0,
"entitlement": 0,
"holiday_id": 0,
"year": 0
}

Identification Cards

Operations about employee_identification_cards

Employee identification cards by date range

Get employee identification cards by date range

Authorizations:

AccessToken

path Parameters

start_date

required

string

query Parameters

end_date	string
length	integer <int32>
display	string

Responses

Response samples

200

Content type

application/json

{"identification_card_id": 0,
"employee_id": 0,
"identification": "string",
"start_date": "2019-08-24",
"end_date": "2019-08-24"
}

Plan Data

Operations about plan_data

Write a new top-layer with given plan_data for one employee

Plan Data is the representation of a scheduled activity for an employee in a certain time frame. Multiple Plan Data items form a schedule.

Peopleware API allows you to create, update or delete schedules.

To update a schedule, you have to include all Plan Data items in the request. This will replace the current Plan Data items for an employee on a specific day.

To delete a parts of a schedule, include the Plan Data items that you don’t want to delete. To delete the whole schedule, specify an empty array.

Peopleware API supports writing activities with start and end time or full-day activities.

Note: All timestamps are interpreted in the time zone of the planning unit.

Prerequisites

To create or update a schedule, the employee must belong to the planning unit on this day. You need write permissions for the planning units and included activities.

The Plan Data resource

JSON request body

To create or update Plan Data for an employee, send all the Plan Data items in JSON format in the request body.

This is how the PUT request will look:

{
  "data": {
    "employee_id": 1234,
    "booking_date": "2022-08-12",
    "items": [
      {
        "type": "activity",
        "planning_unit_id": 1001,
        "activity_id": 1024,
        "start_time": "2022-08-12T10:30:00Z",
        "end_time": "2022-08-12T15:00:00Z"
      },
      {
        "type": "activity",
        "planning_unit_id": 1001,
        "activity_id": 1030,
        "start_time": "2022-08-12T15:30:00Z",
        "end_time": "2022-08-12T18:00:00Z"
      }
    ]
  }
}

Instead of multiple activities, you can also specify one full-day activity, which does not need to specify start and end times.

Ensure that your input data is semantically correct. The server might reject time conflicts between the given Plan Data items or write them in an unintended way.

The Plan Data object:

Name	Type	Description
employee_id	Integer	Unique identifier for the Employee
booking_date	String	The date that the Employee is scheduled to do the Activity, e.g. "2023-12-02"
items	Array	An array of Plan Data items
type	String	Type of the Plan Data item. Allowed values: 'activity', 'full_day_activity'
planning_unit_id	Integer	Unique identifier for the planning unit where the Plan Data item should be booked
activity_id	Integer	Unique identifier for the activity that the Plan Data item represents
start_time	String	Start time of the Plan Data item. Don't specify this for Plan Data items of type 'full_day_activity'
end_time	String	End time of the Plan Data item. Don't specify this for Plan Data items of type 'full_day_activity'

Successful PUT request

To check the updated schedule, you can go to Plan > Schedules or Plan > Shift Center.

Authorizations:

AccessToken

path Parameters

level

required

string

Enum: "plan" "wishes" "alternative_wishes" "absence_wishes" "final" "acd" "time_recording" "correction" "availabilities" "productivity" "backup" "backup_version_2" "backup_version_3"

Plan Data Level

Request Body schema: application/json
required

required

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"employee_id": 0,
"booking_date": "2019-08-24",
"items": [{"type": "activity",
"planning_unit_id": 0,
"activity_id": 0,
"start_time": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z"
}
]
}
}

Response samples

422

Content type

application/json

{"errors": [{"status": "string",
"title": "string",
"message": "string"
}
]
}

Plan Data by Level, Date and Activity IDs

Get plan data by level, date and activity IDs

Authorizations:

AccessToken

path Parameters

level required	string (level) Enum: "plan" "wishes" "alternative_wishes" "absence_wishes" "final" "time_recording" "correction" "acd" "availabilities" "on_call" "productivity" "backup" "backup_version_2" "backup_version_3" "overtime"
start_date required	string

query Parameters

end_date	string
length	integer <int32>
activity_ids	string
display	string

Responses

Response samples

200

Content type

application/json

{"employee_id": 0,
"personnel_number": "string",
"activity_id": 0,
"third_party_interface": "string",
"type": "string",
"start_date": "2019-08-24",
"start_time": "14:15:22Z",
"end_date": "2019-08-24",
"end_time": "14:15:22Z",
"duration": "14:15:22Z"
}

Plan Data Requests

Operations about plan_data_requests

Plan Data Requests by Date and Employee ID

Get plan data requests by date and employee ID

Authorizations:

AccessToken

path Parameters

employee_id required	integer <int32>
start_date required	string

query Parameters

end_date	string
length	integer <int32>
status	string Enum: "pending" "approved" "rejected"
display	string

Responses

Response samples

200

Content type

application/json

{"activity_id": 0,
"all_day": true,
"comment": "string",
"duration": 0.1,
"employee_id": 0,
"end_time": "2019-08-24",
"start_time": "2019-08-24",
"plan_data_request_id": 0,
"status": "string"
}

Plan Data Requests by Date and Planning Unit ID

Get plan data requests by date and planning unit ID

Authorizations:

AccessToken

path Parameters

planning_unit_id required	integer <int32>
start_date required	string

query Parameters

end_date	string
length	integer <int32>
status	string Enum: "pending" "approved" "rejected"
display	string

Responses

Response samples

200

Content type

application/json

{"activity_id": 0,
"all_day": true,
"comment": "string",
"duration": 0.1,
"employee_id": 0,
"end_time": "2019-08-24",
"start_time": "2019-08-24",
"plan_data_request_id": 0,
"status": "string"
}

Update a plan data request

Approves/Rejects a plan data request

Authorizations:

AccessToken

path Parameters

id

required

string

Request ID

Request Body schema: application/json
required

status required	string Enum: "approved" "rejected" approved/rejected
comment required	string or null Your comment

Responses

Request samples

Payload

Content type

application/json

{"status": "approved",
"comment": "string"
}

Planning Periods

Operations about planning_periods

Planning Periods by Date

Get planning periods and time-off periods by date.

By default, only planning periods are returned. To return only the time-off periods for a specific vacation or absence activity, add the activity ID as a parameter to your request.

Authorizations:

AccessToken

path Parameters

start_date

required

string

query Parameters

end_date	string
length	integer <int32>
activity_id	integer <int32>
display	string

Responses

Response samples

200

Content type

application/json

{"planning_period_id": 0,
"status": "string",
"planning_unit_id": 0,
"activity_id": 0,
"end_date": "2019-08-24",
"start_date": "2019-08-24"
}

Planning Units

Operations about planning_units

Get Planning Unit Assignments

Request

GET https://legacy-api.peopleware.com/v1/employees/1008/planning_units

Response

Status 200

{
  "data": [
    {
      "employees_membership_id": 1157,
      "employee_id": 1008,
      "planning_unit_id": 1007,
      "start_date": "2022-12-01",
      "end_date": "2022-12-13",
      "priority": 1
    }
  ]
}

Authorizations:

AccessToken

path Parameters

employee_id

required

number

Specific Employee ID

Responses

Response samples

200
400

Content type

application/json

{"data": [{"employees_membership_id": 0,
"employee_id": 0,
"planning_unit_id": 0,
"start_date": "2019-08-24",
"end_date": "2019-08-24",
"priority": 0
}
]
}

Create Planning Unit Assignment

Request

POST https://legacy-api.peopleware.com/v1/employees/1008/planning_units

{
  "data": {
    "planning_unit_id": 1007,
    "start_date": "2022-12-01",
    "end_date": "2022-12-21"
  }
}

Response

Status 201

{
  "data": {
    "employees_membership_id": 1157,
    "employee_id": 1008,
    "planning_unit_id": 1007,
    "start_date": "2022-12-01",
    "end_date": "2022-12-13",
    "priority": 1
  }
}

Authorizations:

AccessToken

path Parameters

employee_id

required

number

Specific Employee ID

Request Body schema: application/json
required

required

object non-empty

Responses

Request samples

Payload

Content type

application/json

{"data": {"planning_unit_id": 0,
"start_date": "2019-08-24",
"end_date": "2019-08-24",
"priority": 0
}
}

Response samples

201
400

Content type

application/json

{"data": {"employees_membership_id": 0,
"employee_id": 0,
"planning_unit_id": 0,
"start_date": "2019-08-24",
"end_date": "2019-08-24",
"priority": 0
}
}

Update Planning Unit Assignment

Request

PATCH https://legacy-api.peopleware.com/v1/employees/1008/planning_units/1001

{
  "data": {
    "start_date": "2021-02-01",
    "priority": 2
  }
}

Response

Status 200

{
  "data": {
    "employees_membership_id": 1157,
    "employee_id": 1008,
    "planning_unit_id": 1007,
    "start_date": "2021-02-01",
    "end_date": "2022-12-13",
    "priority": 2
  }
}

Authorizations:

AccessToken

path Parameters

employee_id required	number Specific Employee ID
employees_membership_id required	number Specific Employee Membership ID

Request Body schema: application/json
required

required

object non-empty

Responses

Request samples

Payload

Content type

application/json

{"data": {"planning_unit_id": 0,
"start_date": "2019-08-24",
"end_date": "2019-08-24",
"priority": 0
}
}

Response samples

200
400

Content type

application/json

{"data": {"employees_membership_id": 0,
"employee_id": 0,
"planning_unit_id": 0,
"start_date": "2019-08-24",
"end_date": "2019-08-24",
"priority": 0
}
}

Delete Planning Unit Assignment

Request

DELETE https://legacy-api.peopleware.com/v1/employees/1008/planning_units/1001

Response

Status 204

Authorizations:

AccessToken

path Parameters

employee_id required	number Specific Employee ID
employees_membership_id required	number Specific Employee Membership ID

Responses

Response samples

400
404

Content type

application/json

{"errors": [{"status": "string",
"title": "string",
"message": "string"
}
]
}

Write requirements for a specific planning unit and activity on a specific date

A staff requirements calculation is the process of determining the number of employees needed to handle a forecasted workload. Staff requirements is the input to the scheduling process. You cannot optimize schedules without staff requirements.

A staff requirement is the number of agents that need to be scheduled to meet the service levels during an interval of 15 minutes.

Example: To reach their service level (e.g. 80% of calls answered within 20 seconds), workforce planners need to calculate how many agents they need to schedule for each 15-minute interval at any given time. The number depends on the forecasted volume of calls and average handle time of each call.

You can use this endpoint to import the staff requirements for an activity in a planning unit on a particular day.

Prerequisites

To create or update a staff requirement for an activity, the activity must be part of a planning unit on the day you want to create the staff requirement.
You need to have write access for the planning unit and activity.

The Requirements resource

JSON request body

To create or update Staff Requirements for a specific activity, send an array of interval data in JSON format in the request body.

Example for a PUT request body:

{
  "data": [0.0, 0.0, 0.0, 0.0, 1.0, 3.5, /* ...  */ 10.0, 2.0, 0.0]
}

The Requirements object

Name	Type	Description
Data	Array of numbers	The array must either contain 96, 48, or 24 items, each representing an interval of 15 minutes, 30 minutes or 60 minutes, respectively. The interval times are interpreted in the timezone of the Planning Unit. Example: if the planning unit has a time zone offset of `+01:00`, the first interval describes the requirements from `00:00:00+01:00` to `00:15:00+01:00`

Authorizations:

AccessToken

path Parameters

planning_unit_id required	integer Specific Planning Unit ID
date required	string <date> Date of the requirements
activity_id required	integer Specific Activity ID

Request Body schema: application/json
required

required

Array of numbers or Array of numbers or Array of numbers

Responses

Request samples

Payload

Content type

application/json

{"data": [0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
]
}

Response samples

400

Content type

application/json

{"errors": [{"status": "string",
"title": "string",
"message": "string"
}
]
}

Employee Planning Units by Date and Employee ID

Get employee planning units by date and employee ID

Authorizations:

AccessToken

path Parameters

employee_id required	integer <int32>
start_date required	string

query Parameters

end_date	string
length	integer <int32>
display	string

Responses

Response samples

200

Content type

application/json

{"employee_id": 0,
"end_date": "2019-08-24",
"planning_unit_id": 0,
"priority": 0,
"start_date": "2019-08-24"
}

Absences all planning unit members

Get absences of all planning unit members in a time range from level plan or specified level.

Authorizations:

AccessToken

path Parameters

planning_unit_id required	integer <int32>
start_date required	string

query Parameters

end_date	string
length	integer <int32>
level	string (level) Enum: "plan" "wishes" "alternative_wishes" "absence_wishes" "final" "time_recording" "correction" "acd" "availabilities" "on_call" "productivity" "backup" "backup_version_2" "backup_version_3" "overtime"
absence_types	string
display	string

Responses

Response samples

200

Content type

application/json

{"start_time": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"planning_unit_id": 0,
"employee_id": 0,
"activity_id": 0,
"activity_name": "string",
"activity_name_short": "string"
}

Adherence Scores by Date and Planning Unit ID

Get adherence scores by date and planning unit ID

Authorizations:

AccessToken

path Parameters

planning_unit_id required	integer <int32>
start_date required	string

query Parameters

end_date	string
length	integer <int32>
schedule_level	string (level) Enum: "plan" "wishes" "alternative_wishes" "absence_wishes" "final" "time_recording" "correction" "acd" "availabilities" "on_call" "productivity" "backup" "backup_version_2" "backup_version_3" "overtime"
actual_level	string (level) Enum: "plan" "wishes" "alternative_wishes" "absence_wishes" "final" "time_recording" "correction" "acd" "availabilities" "on_call" "productivity" "backup" "backup_version_2" "backup_version_3" "overtime"
zeros	boolean
display	string

Responses

Response samples

200

Content type

application/json

{"activity_type": "string",
"actual_time": 0,
"adherence_percentage": 0.1,
"conformance_percentage": 0.1,
"date": "2019-08-24",
"employee_id": 0,
"minutes_in_adherence": 0,
"minutes_out_adherence": 0,
"minutes_out_conformance": 0,
"scheduled_time": 0
}

Comments by Date and Planning Unit ID

Get comments by date and planning unit ID

Authorizations:

AccessToken

path Parameters

planning_unit_id required	integer <int32>
start_date required	string

query Parameters

end_date	string
length	integer <int32>
levels	string (levels) A comma separated list of levels. Allowed levels are: plan wishes alternative_wishes absence_wishes final time_recording correction acd availabilities on_call productivity backup backup_version_2 backup_version_3 overtime
display	string

Responses

Response samples

200

Content type

application/json

{"date": "2019-08-24",
"employee_id": 0,
"level": 1000,
"text": "string"
}

All Employees from Planning Unit by Date and Planning Unit ID

Get all employees belonging to a planning unit by date and planning unit ID

Authorizations:

AccessToken

path Parameters

planning_unit_id required	integer <int32>
start_date required	string

query Parameters

end_date	string
length	integer <int32>
include_userid	boolean
display	string

Responses

Response samples

200

Content type

application/json

{"birth_date": "2019-08-24",
"birth_place": "string",
"color": 0,
"current_identification": "string",
"deleted": true,
"employee_id": 0,
"first_name": "string",
"last_name": "string",
"personnel_number": "string",
"schedule_position": 0,
"automated_shift_assignment": true,
"user_id": 0
}

Employee Contracts by Date and Planning Unit ID

Get employee contracts by date and planning unit ID

Authorizations:

AccessToken

path Parameters

planning_unit_id required	integer <int32>
start_date required	string

query Parameters

end_date	string
length	integer <int32>
display	string

Responses

Response samples

200

Content type

application/json

{"contract_id": 0,
"employee_id": 0,
"end_date": "2019-08-24",
"start_date": "2019-08-24"
}

Employee External Systems by Date and Planning Unit ID

Get employee external systems by date and planning unit ID

Authorizations:

AccessToken

path Parameters

planning_unit_id required	integer <int32>
start_date required	string

query Parameters

end_date	string
length	integer <int32>
display	string

Responses

Response samples

200

Content type

application/json

{"active": true,
"employee_id": 0,
"extension": 0,
"external_identification": 0,
"external_system_id": 0,
"end_date": "2019-08-24",
"start_date": "2019-08-24"
}

Employee Planning Units by Date and Planning Unit ID

Get employee planning units by date and planning unit ID

Authorizations:

AccessToken

path Parameters

planning_unit_id required	integer <int32>
start_date required	string

query Parameters

end_date	string
length	integer <int32>
display	string

Responses

Response samples

200

Content type

application/json

{"employee_id": 0,
"end_date": "2019-08-24",
"planning_unit_id": 0,
"priority": 0,
"start_date": "2019-08-24"
}

Employee Selections by Date and Planning Unit ID

Get employee selections by date and planning unit ID

Authorizations:

AccessToken

path Parameters

planning_unit_id required	integer <int32>
start_date required	string

query Parameters

end_date	string
length	integer <int32>
display	string

Responses

Response samples

200

Content type

application/json

{"selection_id": 0,
"employee_id": 0,
"end_date": "2019-08-24",
"start_date": "2019-08-24"
}

Employee Shift Sequences by Date and Planning Unit ID

Get employee shift sequences by date and planning unit ID

Authorizations:

AccessToken

path Parameters

planning_unit_id required	integer <int32>
start_date required	string

query Parameters

end_date	string
length	integer <int32>
display	string

Responses

Response samples

200

Content type

application/json

{"anchor_date": "2019-08-24",
"employee_id": 0,
"end_date": "2019-08-24",
"priority": 0,
"shift_sequence_id": 0,
"shift_sequence_row": 0,
"start_date": "2019-08-24"
}

Employee Skill Levels by Date and Planning Unit ID

Get employee skill levels by date and planning unit ID

Authorizations:

AccessToken

path Parameters

planning_unit_id required	integer <int32>
start_date required	string

query Parameters

end_date	string
length	integer <int32>
display	string

Responses

Response samples

200

Content type

application/json

{"employee_id": 0,
"end_date": "2019-08-24",
"skill_id": 0,
"skill_level_id": 0,
"start_date": "2019-08-24"
}

Holiday Annuals by Year and Planning Unit ID

Get holiday annuals by year and planning unit ID

Authorizations:

AccessToken

path Parameters

planning_unit_id required	integer <int32>
year required	string

query Parameters

level	string (level) Enum: "plan" "wishes" "alternative_wishes" "absence_wishes" "final" "time_recording" "correction" "acd" "availabilities" "on_call" "productivity" "backup" "backup_version_2" "backup_version_3" "overtime"
display	string

Responses

Response samples

200

Content type

application/json

{"contract_id": 0,
"employee_id": 0,
"entitlement_in_hours": 0.1,
"scheduled_in_hours": 0.1,
"remaining_in_hours": 0.1,
"end_date": "2019-08-24",
"start_date": "2019-08-24",
"year": 0
}

Plan Data Requests by Date and Planning Unit ID

Get plan data requests by date and planning unit ID

Authorizations:

AccessToken

path Parameters

planning_unit_id required	integer <int32>
start_date required	string

query Parameters

end_date	string
length	integer <int32>
status	string Enum: "pending" "approved" "rejected"
display	string

Responses

Response samples

200

Content type

application/json

{"activity_id": 0,
"all_day": true,
"comment": "string",
"duration": 0.1,
"employee_id": 0,
"end_time": "2019-08-24",
"start_time": "2019-08-24",
"plan_data_request_id": 0,
"status": "string"
}

All Planning Units

Get all planning units.

Authorizations:

AccessToken

query Parameters

display

string

Responses

Response samples

200

Content type

application/json

{"color": 0,
"deleted": true,
"planning_unit_id": 0,
"name": "string",
"name_short": "string",
"parent_planning_unit_id": 0,
"planning_raster": 0,
"time_zone_id": 0
}

Planning Unit by Planning Unit ID

Get a planning unit by ID.

Authorizations:

AccessToken

path Parameters

planning_unit_id

required

integer <int32>

query Parameters

display

string

Responses

Response samples

200

Content type

application/json

{"color": 0,
"deleted": true,
"planning_unit_id": 0,
"name": "string",
"name_short": "string",
"parent_planning_unit_id": 0,
"planning_raster": 0,
"time_zone_id": 0
}

Children Planning Units by Planning Unit ID

Get all children planning units by planning unit ID

Authorizations:

AccessToken

path Parameters

planning_unit_id

required

integer <int32>

query Parameters

display

string

Responses

Response samples

200

Content type

application/json

{"color": 0,
"deleted": true,
"planning_unit_id": 0,
"name": "string",
"name_short": "string",
"parent_planning_unit_id": 0,
"planning_raster": 0,
"time_zone_id": 0
}

Planning Unit Activities by Date and Planning Unit ID

Get planning unit activities by date and planning unit ID

Authorizations:

AccessToken

path Parameters

planning_unit_id required	integer <int32>
start_date required	string

query Parameters

end_date	string
length	integer <int32>
display	string

Responses

Response samples

200

Content type

application/json

{"activity_id": 0,
"cost_center_id": 0,
"end_date": "2019-08-24",
"planning_unit_id": 0,
"start_date": "2019-08-24"
}

Planning Unit Requirements by Date and Planning Unit ID

Get planning unit requirements by date and planning unit ID

Authorizations:

AccessToken

path Parameters

planning_unit_id required	integer <int32>
start_date required	string

query Parameters

end_date	string
length	integer <int32>
zeros	boolean
activity_ids	string
activity_types	string
display	string

Responses

Response samples

200

Content type

application/json

{"activity_id": 0,
"date": "2019-08-24",
"planning_unit_id": 0,
"raster": 0,
"values": [0.1
]
}

Schedules for employees of a Planning Unit

Get schedules for all employees of a given planning unit

Authorizations:

AccessToken

path Parameters

planning_unit_id required	integer <int32>
start_date required	string

query Parameters

activity_types	string
activity_ids	string
levels	string (levels) A comma separated list of levels. Allowed levels are: plan wishes alternative_wishes absence_wishes final time_recording correction acd availabilities on_call productivity backup backup_version_2 backup_version_3 overtime
only_paid	boolean
with_unfinished	boolean
filter_pu	string Enum: "true" "false" Return only plan data items that belong to the given planning unit
display	string

Responses

Response samples

200

Content type

application/json

{"booking_date": "2019-08-24",
"employee_id": 0,
"level": "plan",
"planning_unit_id": 0,
"schedule_blocks": [{"activity_id": 0,
"time_end": "2019-08-24T14:15:22Z",
"time_start": "2019-08-24T14:15:22Z",
"type": "string"
}
]
}

Pending Shift Exchanges by Date and Planning Unit ID

Get pending shift exchanges by date and planning unit ID

Authorizations:

AccessToken

path Parameters

planning_unit_id required	integer <int32>
start_date required	string

query Parameters

end_date	string
length	integer <int32>
display	string

Responses

Response samples

200

Content type

application/json

{"offer": [{"date": "2019-08-24",
"employee_id": 0,
"comment": "string"
}
],
"counter_offers": [{"date": "2019-08-24",
"employee_id": 0,
"comment": "string"
}
],
"available_offers": [{"date": "2019-08-24",
"employee_id": 0,
"comment": "string"
}
],
"counter_offers_received": [{"date": "2019-08-24",
"employee_id": 0,
"comment": "string"
}
],
"commitment": [{"shift_exchange_commitment_id": 0,
"date": "2019-08-24",
"cross_exchange_date": "2019-08-24",
"employee_id": 0,
"accepting_employee_id": 0,
"status": "string",
"modification_date": "2019-08-24"
}
]
}

Shift Requirements by Date and Planning Unit ID

Get shift requirements by date and planning unit ID

Authorizations:

AccessToken

path Parameters

planning_unit_id required	integer <int32>
start_date required	string

query Parameters

end_date	string
length	integer <int32>
display	string

Responses

Response samples

200

Content type

application/json

{"booking_date": "2019-08-24",
"day_model_id": 0,
"final_planned": 0,
"planned": 0,
"planning_unit_id": 0,
"requirement": 0,
"wishes": 0,
"start_time": "14:15:22Z",
"end_time": "14:15:22Z"
}

Planning Unit Staffing by Date and Planning Unit ID

Get planning unit staffing by date and planning unit ID

Authorizations:

AccessToken

path Parameters

planning_unit_id required	integer <int32>
start_date required	string

query Parameters

end_date	string
length	integer <int32>
zeros	boolean
activity_ids	string
activity_types	string
levels	string (levels) A comma separated list of levels. Allowed levels are: plan wishes alternative_wishes absence_wishes final time_recording correction acd availabilities on_call productivity backup backup_version_2 backup_version_3 overtime
display	string

Responses

Response samples

200

Content type

application/json

{"activity_id": 0,
"date": "2019-08-24",
"level": 1000,
"planning_unit_id": 0,
"raster": 0,
"values": [0.1
]
}

Employee Planning Units by Date

Get employee planning units by date

Authorizations:

AccessToken

path Parameters

start_date

required

string

query Parameters

employee_id	integer <int32>
end_date	string
length	integer <int32>
display	string

Responses

Response samples

200

Content type

application/json

{"employee_id": 0,
"end_date": "2019-08-24",
"planning_unit_id": 0,
"priority": 0,
"start_date": "2019-08-24"
}

Requirements

Staffing Requirements for an Activity on a Planning Unit

Write requirements for a specific planning unit and activity on a specific date

A staff requirements calculation is the process of determining the number of employees needed to handle a forecasted workload. Staff requirements is the input to the scheduling process. You cannot optimize schedules without staff requirements.

A staff requirement is the number of agents that need to be scheduled to meet the service levels during an interval of 15 minutes.

Example: To reach their service level (e.g. 80% of calls answered within 20 seconds), workforce planners need to calculate how many agents they need to schedule for each 15-minute interval at any given time. The number depends on the forecasted volume of calls and average handle time of each call.

You can use this endpoint to import the staff requirements for an activity in a planning unit on a particular day.

Prerequisites

To create or update a staff requirement for an activity, the activity must be part of a planning unit on the day you want to create the staff requirement.
You need to have write access for the planning unit and activity.

The Requirements resource

JSON request body

To create or update Staff Requirements for a specific activity, send an array of interval data in JSON format in the request body.

Example for a PUT request body:

{
  "data": [0.0, 0.0, 0.0, 0.0, 1.0, 3.5, /* ...  */ 10.0, 2.0, 0.0]
}

The Requirements object

Name	Type	Description
Data	Array of numbers	The array must either contain 96, 48, or 24 items, each representing an interval of 15 minutes, 30 minutes or 60 minutes, respectively. The interval times are interpreted in the timezone of the Planning Unit. Example: if the planning unit has a time zone offset of `+01:00`, the first interval describes the requirements from `00:00:00+01:00` to `00:15:00+01:00`

Authorizations:

AccessToken

path Parameters

planning_unit_id required	integer Specific Planning Unit ID
date required	string <date> Date of the requirements
activity_id required	integer Specific Activity ID

Request Body schema: application/json
required

required

Array of numbers or Array of numbers or Array of numbers

Responses

Request samples

Payload

Content type

application/json

{"data": [0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
]
}

Response samples

400

Content type

application/json

{"errors": [{"status": "string",
"title": "string",
"message": "string"
}
]
}

Planning Unit Requirements by Date and Planning Unit ID

Get planning unit requirements by date and planning unit ID

Authorizations:

AccessToken

path Parameters

planning_unit_id required	integer <int32>
start_date required	string

query Parameters

end_date	string
length	integer <int32>
zeros	boolean
activity_ids	string
activity_types	string
display	string

Responses

Response samples

200

Content type

application/json

{"activity_id": 0,
"date": "2019-08-24",
"planning_unit_id": 0,
"raster": 0,
"values": [0.1
]
}

Selections

Operations about selections

Get Employee Selections

Request

GET https://legacy-api.peopleware.com/v1/employees/1001/selections

Response

Status 200

{
  "data": [
    {
      "selection_id": 1001,
      "employee_id": 1001,
      "start_date": "2022-01-01",
      "end_date": "2022-02-01"
    }
  ]
}

Authorizations:

AccessToken

path Parameters

employee_id

required

number

Specific Employee ID

Responses

Response samples

200
400

Content type

application/json

{"data": [{"selection_id": 0,
"employee_id": 0,
"start_date": "2019-08-24",
"end_date": "2019-08-24"
}
]
}

Create Employee Selection

Request

POST https://legacy-api.peopleware.com/v1/employees/1001/selections

{
  "data": {
    "selection_id": 1001,
    "start_date": "2022-05-01",
    "end_date": "2022-05-01"
  }
}

Response

Status 201

{
  "data": {
    "selection_id": 1001,
    "employee_id": 1001,
    "start_date": "2022-05-01",
    "end_date": "2022-05-01"
  }
}

Authorizations:

AccessToken

path Parameters

employee_id

required

number

Specific Employee ID

Request Body schema: application/json
required

required

object non-empty

Responses

Request samples

Payload

Content type

application/json

{"data": {"selection_id": 0,
"start_date": "2019-08-24",
"end_date": "2019-08-24"
}
}

Response samples

201
400

Content type

application/json

{"data": {"selection_id": 0,
"employee_id": 0,
"start_date": "2019-08-24",
"end_date": "2019-08-24"
}
}

Delete Employee Selection

Request

DELETE https://legacy-api.peopleware.com/v1/employees/1001/selections/1002?start_date=2022-05-01&end_date=2022-05-01

Response

Status 204

Authorizations:

AccessToken

path Parameters

employee_id required	number Specific Employee ID
selection_id required	number Specific Selection ID

query Parameters

start_date	string <date> Start Date
end_date	string <date> End Date

Responses

Response samples

400
404

Content type

application/json

{"errors": [{"status": "string",
"title": "string",
"message": "string"
}
]
}

Update Employee Selection

Request

PATCH https://legacy-api.peopleware.com/v1/employees/1001/selections/1001?start_date=2022-05-01&end_date=2022-05-01

{
  "data": {
    "selection_id": 1002
  }
}

Response

Status 200

{
  "data": {
    "selection_id": 1002,
    "employee_id": 1001,
    "start_date": "2022-05-01",
    "end_date": "2022-05-01"
  }
}

Note

The Selection ID in the payload must be different from the Selection ID in the URL.

Authorizations:

AccessToken

path Parameters

employee_id required	number Specific Employee ID
selection_id required	number Specific Selection ID

query Parameters

start_date	string <date> Start Date
end_date	string <date> End Date

Request Body schema: application/json
required

required

object non-empty

Responses

Request samples

Payload

Content type

application/json

{"data": {"selection_id": 0
}
}

Response samples

200
400

Content type

application/json

{"data": {"selection_id": 0,
"employee_id": 0,
"start_date": "2019-08-24",
"end_date": "2019-08-24"
}
}

Employee Selections by Date and Employee ID

Get employee selections by date and employee ID

Authorizations:

AccessToken

path Parameters

employee_id required	integer <int32>
start_date required	string

query Parameters

end_date	string
length	integer <int32>
display	string

Responses

Response samples

200

Content type

application/json

{"selection_id": 0,
"employee_id": 0,
"end_date": "2019-08-24",
"start_date": "2019-08-24"
}

Employee Selections by Date and Planning Unit ID

Get employee selections by date and planning unit ID

Authorizations:

AccessToken

path Parameters

planning_unit_id required	integer <int32>
start_date required	string

query Parameters

end_date	string
length	integer <int32>
display	string

Responses

Response samples

200

Content type

application/json

{"selection_id": 0,
"employee_id": 0,
"end_date": "2019-08-24",
"start_date": "2019-08-24"
}

Employee Selections by date

Get employee selections by date

Authorizations:

AccessToken

path Parameters

start_date

required

string

query Parameters

end_date	string
length	integer <int32>
display	string

Responses

Response samples

200

Content type

application/json

{"selection_id": 0,
"employee_id": 0,
"end_date": "2019-08-24",
"start_date": "2019-08-24"
}

All Selections

Get all selections.

Authorizations:

AccessToken

query Parameters

display

string

Responses

Response samples

200

Content type

application/json

{"deleted": true,
"description": "string",
"selection_id": 0,
"name": "string",
"name_short": "string"
}

Selection by Selection ID

Get a selection by ID.

Authorizations:

AccessToken

path Parameters

selection_id

required

integer <int32>

query Parameters

display

string

Responses

Response samples

200

Content type

application/json

{"deleted": true,
"description": "string",
"selection_id": 0,
"name": "string",
"name_short": "string"
}

Shift Sequences

Operations about shift_sequences

All Shift Sequences

Get all shift sequences.

Authorizations:

AccessToken

query Parameters

display

string

Responses

Response samples

200

Content type

application/json

{"day_count": 0,
"deleted": true,
"shift_sequence_id": 0,
"name": "string",
"name_short": "string",
"row_count": 0
}

Shift Sequence by Shift Sequence ID

Get a shift sequence by ID.

Authorizations:

AccessToken

path Parameters

shift_sequence_id

required

integer <int32>

query Parameters

display

string

Responses

Response samples

200

Content type

application/json

{"day_count": 0,
"deleted": true,
"shift_sequence_id": 0,
"name": "string",
"name_short": "string",
"row_count": 0
}

Shift Sequences Data

Operations about shift_sequences_data

All Shift Sequence Data

Get all shift sequences data.

Authorizations:

AccessToken

query Parameters

display

string

Responses

Response samples

200

Content type

application/json

{"shift_sequence_rows": [{"day_model_ids": [0
]
}
],
"deleted": true,
"shift_sequences_data_id": 0,
"shift_sequence_id": 0,
"end_date": "2019-08-24",
"start_date": "2019-08-24"
}

Shift Sequence data by Shift Sequence ID

Get shift sequence data by Shift Sequence ID

Authorizations:

AccessToken

path Parameters

shift_sequence_id

required

integer <int32>

query Parameters

display

string

Responses

Response samples

200

Content type

application/json

{"shift_sequence_rows": [{"day_model_ids": [0
]
}
],
"deleted": true,
"shift_sequences_data_id": 0,
"shift_sequence_id": 0,
"end_date": "2019-08-24",
"start_date": "2019-08-24"
}

Shift Swaps

Data about shift swaps

Get shift swaps

Get list of shift swaps for specified parameters

Authorizations:

AccessToken

query Parameters

planning_unit_id required	integer ID of planning unit
selection_id	integer ID of selection
start_date required	string <date> Start date of requested period
end_date required	string <date> End date of requested period
status	string Enum: "pending" "executed" "rejected" "offerer_resigned" "acceptor_resigned" "deadline_missed" Status of shift swaps

Responses

Response samples

200

Content type

application/json

[{"id": 0,
"date": "2019-08-24",
"additional_date": "2019-08-24",
"employee_id": 0,
"accepting_employee_id": 0,
"status": "string",
"modification_date": "2019-08-24"
}
]

Skills

Operations about skills

Skills for Activity by Activity ID

Get all skills for an activity by activity ID

Authorizations:

AccessToken

path Parameters

activity_id

required

integer <int32>

query Parameters

display

string

Responses

Response samples

200

Content type

application/json

{"activity_id": 0,
"activities_skill_id": 0,
"skill_id": 0,
"weight": 0
}

getV1SkillsId

Authorizations:

AccessToken

path Parameters

id

required

integer <int32>

Responses

getV1Skills

Authorizations:

AccessToken

Responses

Skill Levels

Operations about skill_levels

Get Skill Level Assignments

Request

GET https://legacy-api.peopleware.com/v1/employees/1008/skill_levels

Response

Status 200

{
  "data": [
    {
      "employees_skill_level_id": 1157,
      "employee_id": 1008,
      "skill_id": 1002,
      "skill_level_id": 1003,
      "start_date": "2022-12-01",
      "end_date": "2022-12-13"
    }
  ]
}

Authorizations:

AccessToken

path Parameters

employee_id

required

number

Specific Employee ID

Responses

Response samples

200
400

Content type

application/json

{"data": [{"employees_skill_level_id": 0,
"employee_id": 0,
"skill_id": 0,
"skill_level_id": 0,
"start_date": "2019-08-24",
"end_date": "2019-08-24"
}
]
}

Create Skill Level Assignment

Request

POST https://legacy-api.peopleware.com/v1/employees/1008/skill_levels

{
  "data": {
    "skill_level_id": 1003,
    "start_date": "2022-12-01",
    "end_date": "2022-12-21"
  }
}

Response

Status 201

{
  "data": {
    "employees_skill_level_id": 1001,
    "employee_id": 1008,
    "skill_id": 1002,
    "skill_level_id": 1003,
    "start_date": "2022-12-01",
    "end_date": "2022-12-21"
  }
}

Authorizations:

AccessToken

path Parameters

employee_id

required

number

Specific Employee ID

Request Body schema: application/json
required

required

object non-empty

Responses

Request samples

Payload

Content type

application/json

{"data": {"skill_level_id": 0,
"start_date": "2019-08-24",
"end_date": "2019-08-24"
}
}

Response samples

201
400

Content type

application/json

{"data": {"employees_skill_level_id": 0,
"employee_id": 0,
"skill_id": 0,
"skill_level_id": 0,
"start_date": "2019-08-24",
"end_date": "2019-08-24"
}
}

Update Skill Level Assignment

Request

PATCH https://legacy-api.peopleware.com/v1/employees/1008/skill_levels/1001

{
  "data": {
    "start_date": "2021-02-01"
  }
}

Response

Status 200

{
  "data": {
    "employees_skill_level_id": 1001,
    "employee_id": 1008,
    "skill_id": 1002,
    "skill_level_id": 1003,
    "start_date": "2021-02-01",
    "end_date": "2022-12-21"
  }
}

Authorizations:

AccessToken

path Parameters

employee_id required	number Specific Employee ID
employees_skill_level_id required	number Specific Employee Skill Level ID

Request Body schema: application/json
required

required

object non-empty

Responses

Request samples

Payload

Content type

application/json

{"data": {"skill_level_id": 0,
"start_date": "2019-08-24",
"end_date": "2019-08-24"
}
}

Response samples

200
400

Content type

application/json

{"data": {"employees_skill_level_id": 0,
"employee_id": 0,
"skill_id": 0,
"skill_level_id": 0,
"start_date": "2019-08-24",
"end_date": "2019-08-24"
}
}

Delete Skill Level Assignment

Request

DELETE https://legacy-api.peopleware.com/v1/employees/1008/skill_levels/1001

Response

Status 204

Authorizations:

AccessToken

path Parameters

employee_id required	number Specific Employee ID
employees_skill_level_id required	number Specific Employee Skill Level ID

Responses

Response samples

400
404

Content type

application/json

{"errors": [{"status": "string",
"title": "string",
"message": "string"
}
]
}

Employee Skill Levels by Date and Employee ID

Get employee skill levels by date and employee ID

Authorizations:

AccessToken

path Parameters

employee_id required	integer <int32>
start_date required	string <date>

query Parameters

end_date	string
length	integer <int32>
display	string

Responses

Response samples

200

Content type

application/json

{"employee_id": 0,
"end_date": "2019-08-24",
"skill_id": 0,
"skill_level_id": 0,
"start_date": "2019-08-24"
}

Employee Skill Levels by Date and Planning Unit ID

Get employee skill levels by date and planning unit ID

Authorizations:

AccessToken

path Parameters

planning_unit_id required	integer <int32>
start_date required	string

query Parameters

end_date	string
length	integer <int32>
display	string

Responses

Response samples

200

Content type

application/json

{"employee_id": 0,
"end_date": "2019-08-24",
"skill_id": 0,
"skill_level_id": 0,
"start_date": "2019-08-24"
}

getV1SkillLevelsId

Authorizations:

AccessToken

path Parameters

id

required

integer <int32>

Responses

getV1SkillLevels

Authorizations:

AccessToken

Responses

Time Zones

Operations about time_zones

All Time Zones

Get all time zones.

Authorizations:

AccessToken

query Parameters

display

string

Responses

Response samples

200

Content type

application/json

{"daylight_saving_times": [{"start_date": "2019-08-24",
"end_date": "2019-08-24"
}
],
"description": "string",
"dst_utc_offset": 0,
"time_zone_id": 0,
"std_utc_offset": 0
}

Time Zone by Time Zone ID

Get a time zone by ID.

Authorizations:

AccessToken

path Parameters

time_zone_id

required

integer <int32>

query Parameters

display

string

Responses

Response samples

200

Content type

application/json

{"daylight_saving_times": [{"start_date": "2019-08-24",
"end_date": "2019-08-24"
}
],
"description": "string",
"dst_utc_offset": 0,
"time_zone_id": 0,
"std_utc_offset": 0
}

User Groups

Operations about user_groups

All User Groups

Get all user groups.

Authorizations:

AccessToken

query Parameters

display

string

Responses

Response samples

200

Content type

application/json

{"deleted": true,
"description": "string",
"user_group_id": 0,
"name": "string",
"name_short": "string",
"user_ids": [0
]
}

User Group by User Group ID

Get an user group by ID.

Authorizations:

AccessToken

path Parameters

user_group_id

required

integer <int32>

query Parameters

display

string

Responses

Response samples

200

Content type

application/json

{"deleted": true,
"description": "string",
"user_group_id": 0,
"name": "string",
"name_short": "string",
"user_ids": [0
]
}

Week Models

Operations about week_models

All Week Time Patterns

Get all week time patterns.

Authorizations:

AccessToken

query Parameters

display

string

Responses

Response samples

200

Content type

application/json

{"color": 0,
"deleted": true,
"description": "string",
"exception_days": 0,
"week_model_id": 0,
"name": "string",
"name_short": "string"
}

Week Time Patterns by Week Time Pattern ID

Get a week time pattern by ID.

Authorizations:

AccessToken

path Parameters

week_model_id

required

integer <int32>

query Parameters

display

string

Responses

Response samples

200

Content type

application/json

{"color": 0,
"deleted": true,
"description": "string",
"exception_days": 0,
"week_model_id": 0,
"name": "string",
"name_short": "string"
}

Work Time Models

Operations about work_time_models

All Work Time Pattern Models

Get all work time pattern models.

Authorizations:

AccessToken

query Parameters

display

string

Responses

Response samples

200

Content type

application/json

{"color": 0,
"deleted": true,
"description": "string",
"work_time_model_id": 0,
"name": "string",
"name_short": "string",
"rotation_type": "string",
"week_model_id": 0
}

Work Time Pattern Model by Work Time Pattern Model ID

Get a work time pattern model by ID.

Authorizations:

AccessToken

path Parameters

work_time_model_id

required

integer <int32>

query Parameters

display

string

Responses

Response samples

200

Content type

application/json

{"color": 0,
"deleted": true,
"description": "string",
"work_time_model_id": 0,
"name": "string",
"name_short": "string",
"rotation_type": "string",
"week_model_id": 0
}

Peopleware API (v1)

Important

Absences

All Absences in a time range

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Absences of an employee

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Absences all planning unit members

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Accounts

All accounts

Authorizations:

query Parameters

Responses

Response samples

account by account ID

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Subtotals for an account

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Activities

Write requirements for a specific planning unit and activity on a specific date

Prerequisites

The Requirements resource

JSON request body

The Requirements object

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Planning Unit Activities by Date and Planning Unit ID

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Skills for Activity by Activity ID

Authorizations:

path Parameters

query Parameters

Responses

Response samples

External Activities for Activity by Activity ID

Authorizations:

path Parameters

query Parameters

Responses

Response samples

getV1ActivitiesId

Authorizations:

path Parameters

Responses

getV1Activities

Authorizations:

Responses

Activity Externals

All External Activities

Authorizations:

query Parameters

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required