Back to Index

Overview

The LookUpController provides REST endpoints for retrieving a list of values used for dropdown selections.

Endpoints

GET /employee/position

Retrieves a list of employee positions.

Request Headers

Name Description

Authorization

Bearer token to authenticate the request

Response

Returns the following fields:

Path Type Description

[].id

Number

The ID of the position. This is an internal identifier and is not to be used.

[].label

String

The label of the position. This is a human-readable value used for display in UIs.

[].value

String

The value of the position. This is a machine-readable value used for storing in the database.

[].sortOrder

Number

The sort order of the position. This is used to determine the order in which the positions are displayed in UIs.

Example Request

$ curl 'http://localhost:8080/employee/position' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxIiwiZW1haWxfdmVyaWZpZWQiOmZhbHNlLCJyb2xlcyI6WyJBRE1JTiJdLCJpc3MiOiJ0ZXN0LWlzc3VlciIsImdpdmVuX25hbWUiOiJDYWxlbiIsIm1pZGRsZV9uYW1lIjoiTWlkZGxlIiwicGljdHVyZSI6Imh0dHA6Ly9leGFtcGxlLmNvbS9waWMuanBnIiwiYXVkIjoidGVzdC1hdWRpZW5jZSIsIm5hbWUiOiJDYWxlbiBMZWdhenBpIiwicGhvbmVfbnVtYmVyIjoiKzYzOTEyMzQ1Njc4OSIsImV4cCI6MTc0ODA4ODc2NiwiZmFtaWx5X25hbWUiOiJMZWdhenBpIiwiZW1haWwiOiJjYWxlbkBvcmFuZ2VhbmRicm9uemUuY29tIn0.I3G8y3SiCfFOHaflgjfs2MY2F7G76eV0bkmk0LNEyZ0'

Example Response

[{"id":1,"label":"Engineer","value":"ENGINEER","sortOrder":300}]

GET /employee/overtime-eligibility

Retrieves a list of employee overtime eligibility statuses.

Request Headers

Name Description

Authorization

Bearer token to authenticate the request

Response

Returns the following fields:

Path Type Description

[].id

Number

The ID of the overtime eligibility. This is an internal identifier and is not to be used.

[].label

String

The label of the overtime eligibility. This is a human-readable value used for display in UIs.

[].value

String

The value of the overtime eligibility. This is a machine-readable value used for storing in the database.

[].sortOrder

Number

The sort order of the overtime eligibility. This is used to determine the order in which the positions are displayed in UIs.

Example Request

$ curl 'http://localhost:8080/employee/overtime-eligibility' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxIiwiZW1haWxfdmVyaWZpZWQiOmZhbHNlLCJyb2xlcyI6WyJBRE1JTiJdLCJpc3MiOiJ0ZXN0LWlzc3VlciIsImdpdmVuX25hbWUiOiJDYWxlbiIsIm1pZGRsZV9uYW1lIjoiTWlkZGxlIiwicGljdHVyZSI6Imh0dHA6Ly9leGFtcGxlLmNvbS9waWMuanBnIiwiYXVkIjoidGVzdC1hdWRpZW5jZSIsIm5hbWUiOiJDYWxlbiBMZWdhenBpIiwicGhvbmVfbnVtYmVyIjoiKzYzOTEyMzQ1Njc4OSIsImV4cCI6MTc0ODA4ODc2NiwiZmFtaWx5X25hbWUiOiJMZWdhenBpIiwiZW1haWwiOiJjYWxlbkBvcmFuZ2VhbmRicm9uemUuY29tIn0.I3G8y3SiCfFOHaflgjfs2MY2F7G76eV0bkmk0LNEyZ0'

Example Response

[{"id":7,"label":"with Pay","value":"WITH_PAY","sortOrder":100}]

GET /employee/employment-type

Retrieves a list of employment types.

Request Headers

Name Description

Authorization

Bearer token to authenticate the request

Response

Returns the following fields:

Path Type Description

[].id

Number

The ID of the employment type. This is an internal identifier and is not to be used.

[].label

String

The label of the employment type. This is a human-readable value used for display in UIs.

[].value

String

The value of the employment type. This is a machine-readable value used for storing in the database.

[].sortOrder

Number

The sort order of the employment type. This is used to determine the order in which the positions are displayed in UIs.

Example Request

$ curl 'http://localhost:8080/employee/employment-type' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxIiwiZW1haWxfdmVyaWZpZWQiOmZhbHNlLCJyb2xlcyI6WyJBRE1JTiJdLCJpc3MiOiJ0ZXN0LWlzc3VlciIsImdpdmVuX25hbWUiOiJDYWxlbiIsIm1pZGRsZV9uYW1lIjoiTWlkZGxlIiwicGljdHVyZSI6Imh0dHA6Ly9leGFtcGxlLmNvbS9waWMuanBnIiwiYXVkIjoidGVzdC1hdWRpZW5jZSIsIm5hbWUiOiJDYWxlbiBMZWdhenBpIiwicGhvbmVfbnVtYmVyIjoiKzYzOTEyMzQ1Njc4OSIsImV4cCI6MTc0ODA4ODc2NiwiZmFtaWx5X25hbWUiOiJMZWdhenBpIiwiZW1haWwiOiJjYWxlbkBvcmFuZ2VhbmRicm9uemUuY29tIn0.I3G8y3SiCfFOHaflgjfs2MY2F7G76eV0bkmk0LNEyZ0'

Example Response

[{"id":10,"label":"Full-Time","value":"REGULAR","sortOrder":100}]

GET /employee/employee-level

Retrieves a list of employee levels.

Request Headers

Name Description

Authorization

Bearer token to authenticate the request

Response

Returns the following fields:

Path Type Description

[].id

Number

The ID of the employment level. This is an internal identifier and is not to be used.

[].label

String

The label of the employment level. This is a human-readable value used for display in UIs.

[].value

String

The value of the employment level. This is a machine-readable value used for storing in the database.

[].sortOrder

Number

The sort order of the employment level. This is used to determine the order in which the positions are displayed in UIs.

Example Request

$ curl 'http://localhost:8080/employee/employee-level' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxIiwiZW1haWxfdmVyaWZpZWQiOmZhbHNlLCJyb2xlcyI6WyJBRE1JTiJdLCJpc3MiOiJ0ZXN0LWlzc3VlciIsImdpdmVuX25hbWUiOiJDYWxlbiIsIm1pZGRsZV9uYW1lIjoiTWlkZGxlIiwicGljdHVyZSI6Imh0dHA6Ly9leGFtcGxlLmNvbS9waWMuanBnIiwiYXVkIjoidGVzdC1hdWRpZW5jZSIsIm5hbWUiOiJDYWxlbiBMZWdhenBpIiwicGhvbmVfbnVtYmVyIjoiKzYzOTEyMzQ1Njc4OSIsImV4cCI6MTc0ODA4ODc2NiwiZmFtaWx5X25hbWUiOiJMZWdhenBpIiwiZW1haWwiOiJjYWxlbkBvcmFuZ2VhbmRicm9uemUuY29tIn0.I3G8y3SiCfFOHaflgjfs2MY2F7G76eV0bkmk0LNEyZ0'

Example Response

[{"id":12,"label":"Associate","value":"ASSOCIATE","sortOrder":100}]