WorkPlacePerson

Manage work place persons, which represent the association between people and work places.
You can create, update, delete, and search for work place persons with advanced filtering and pagination.

Version

2.0.0

OpenAPI version

3.0.0

Operations

index

POST

/v2/work-place-person/index

Returns a paginated and filterable list of work place persons.
Use POST to allow complex filters via JSON payload.

Request Body

Parameters for searching work place persons

object

filter

object

office_work_place_person_id

The unique identifier for the office work place person.

string format: uuid

time_spent_measure

The measure for the time spent at the office work place.

string

nullable

unit_of_measure_id

The unique identifier for the unit of measure.

string format: uuid

nullable

office_work_place_id

The unique identifier for the office work place.

string format: uuid

person_office_id

The unique identifier for the person’s office.

string format: uuid

office_id

The unique identifier for the office.

string format: uuid

project_id

The unique identifier for the project.

string format: uuid

work_place_code

The code for the office work place.

string

work_place_name

The name of the office work place.

string

person_id

The unique identifier for the person.

string format: uuid

person_code

The code for the person.

string

person_first_name

The first name of the person.

string

person_last_name

The last name of the person.

string

person_is_employee

Indicates if the person is an employee.

boolean

person_is_external

Indicates if the person is external to the organization.

boolean

unit_of_measure_code

The code for the unit of measure.

string

unit_of_measure_name

The name of the unit of measure.

string

project_name

The name of the project.

string

project_type

The type of the project.

string

office_name

The name of the office.

string

office_code

The code for the office.

string

owned_active

Indicates if the office work place person is owned and active.

boolean

parent_active

Indicates if the parent office work place person is active.

boolean

per-page

integer

default: 100 >= 1

page

integer

default: 1 >= 1

sort

The field of the model to sort the list for, use a minus to revert the sort. Es -name is to require the sort in reverse order

string

history

The field establishes whether to also include historized elements that are no longer active in the results. If you leave this parameter empty the response returns only actual entries.

boolean

Example

{
  "filter": {
    "work_place_name": "Work place 1"
  },
  "per-page": 100,
  "page": 1,
  "sort": "name"
}

Responses

200

List of work place persons

Array<object>

object

office_work_place_person_id

The unique identifier for the office work place person.

string format: uuid

time_spent_measure

The measure for the time spent at the office work place.

string

nullable

unit_of_measure_id

The unique identifier for the unit of measure.

string format: uuid

nullable

office_work_place_id

The unique identifier for the office work place.

string format: uuid

person_office_id

The unique identifier for the person’s office.

string format: uuid

office_id

The unique identifier for the office.

string format: uuid

project_id

The unique identifier for the project.

string format: uuid

work_place_code

The code for the office work place.

string

work_place_name

The name of the office work place.

string

person_id

The unique identifier for the person.

string format: uuid

person_code

The code for the person.

string

person_first_name

The first name of the person.

string

person_last_name

The last name of the person.

string

person_is_employee

Indicates if the person is an employee.

boolean

person_is_external

Indicates if the person is external to the organization.

boolean

unit_of_measure_code

The code for the unit of measure.

string

unit_of_measure_name

The name of the unit of measure.

string

project_name

The name of the project.

string

project_type

The type of the project.

string

office_name

The name of the office.

string

office_code

The code for the office.

string

owned_active

Indicates if the office work place person is owned and active.

boolean

parent_active

Indicates if the parent office work place person is active.

boolean

Example

{
  "office_work_place_person_id": "wpp-1",
  "office_work_place_id": "wp-1",
  "person_office_id": "po-1",
  "work_place_name": "Work place 1",
  "person_first_name": "Mario",
  "person_last_name": "Rossi",
  "office_id": "off-1",
  "office_name": "Main Office"
}

Headers

X-Pagination-Current-Page

integer

Current page

X-Pagination-Page-Count

integer

Total number of pages

X-Pagination-Per-Page

integer

Number of items per page

X-Pagination-Total-Count

integer

Total number of items

view

GET

/v2/work-place-person/view/{id}

Retrieve a work place person by its unique ID.

Path Parameters

id

required

string format: uuid

ID of the work place person to retrieve

Responses

200

Work place person found

object

office_work_place_person_id

The unique identifier for the office work place person.

string format: uuid

time_spent_measure

The measure for the time spent at the office work place.

string

nullable

unit_of_measure_id

The unique identifier for the unit of measure.

string format: uuid

nullable

office_work_place_id

The unique identifier for the office work place.

string format: uuid

person_office_id

The unique identifier for the person’s office.

string format: uuid

office_id

The unique identifier for the office.

string format: uuid

project_id

The unique identifier for the project.

string format: uuid

work_place_code

The code for the office work place.

string

work_place_name

The name of the office work place.

string

person_id

The unique identifier for the person.

string format: uuid

person_code

The code for the person.

string

person_first_name

The first name of the person.

string

person_last_name

The last name of the person.

string

person_is_employee

Indicates if the person is an employee.

boolean

person_is_external

Indicates if the person is external to the organization.

boolean

unit_of_measure_code

The code for the unit of measure.

string

unit_of_measure_name

The name of the unit of measure.

string

project_name

The name of the project.

string

project_type

The type of the project.

string

office_name

The name of the office.

string

office_code

The code for the office.

string

owned_active

Indicates if the office work place person is owned and active.

boolean

parent_active

Indicates if the parent office work place person is active.

boolean

Example

{
  "office_work_place_person_id": "wpp-1",
  "office_work_place_id": "wp-1",
  "person_office_id": "po-1",
  "work_place_name": "Work place 1",
  "person_first_name": "Mario",
  "person_last_name": "Rossi",
  "office_id": "off-1",
  "office_name": "Main Office"
}

404

Work place person not found