GET
/
v2
/
training-demands
curl --request GET \
  --url https://{account}-{sandboxName}.sandbox.{server}.luccasoftware.com/v2/training-demands
{
  "items": [
    {
      "id": 410,
      "training": {
        "id": 15,
        "title": "Angular (advanced)",
        "level": "Middle"
      },
      "provider": {
        "id": 9,
        "name": "Google",
        "url": "https://google.com"
      },
      "author": {
        "id": 416,
        "firstName": "John",
        "lastName": "Doe",
        "type": "Owner"
      },
      "owner": {
        "id": 416,
        "firstName": "John",
        "lastName": "Doe",
        "establishmentId": 1,
        "departmentId": 12,
        "picture": {
          "id": "a41832b8-9734-493c-9185-b5ccf50ec42b",
          "href": "https://example.ilucca.net/getFile.ashx?id=a41832b8-9734-493c-9185-b5ccf50ec42b"
        },
        "manager": {
          "id": 521,
          "firstName": "Matt",
          "lastName": "Bawss"
        }
      },
      "plan": {
        "id": 2,
        "name": "2024 Plan",
        "startOn": "2024-01-01"
      },
      "createdAt": "2023-01-01T09:34:43.6529455+00:00",
      "session": {
        "id": 169,
        "durationInHours": 21,
        "location": {
          "isOnSite": false,
          "isRemote": false,
          "address": ""
        }
      },
      "prioritization": {
        "id": 2,
        "name": "High",
        "level": "High",
        "lastModifiedAt": "2023-04-19T08:17:29.4241633+00:00"
      },
      "state": "Requested",
      "status": "PendingRegistration"
    }
  ],
  "count": 234,
  "prev": "~SGlnaA|LYJ77Z9Zqz|q6",
  "next": "!SGlnaA|A1kVrwDKrz|th"
}

Query Parameters

​
ownerId
integer

Identifier of the employee that should attend this training session.

Required range: x >= 1
​
sessionId
integer

Identifier of the training session

Required range: x >= 1
​
states
enum<string>[]

Only retrieve training-demands at one of the given states.

State the training-demand is in.

  • Invalid: Training-demand is invalid.
  • Requested: Training-demand was made, is valid and registration pending.
  • Registered: Employee was registered on a training-session for this training.
  • Realized: Employee attended the training-session he was registered on.
Available options:
Invalid,
Requested,
Registered,
Realized
​
trainingId
integer

Identifier of the training.

​
hasSession
boolean

A session is planned for this training. Omit this parameter in order to retrieve all training demands, whether a session is planned or not.

​
ownerDepartmentId
integer[]

Only retrieve training-demands for employeesthat currently belong to one of the liste of departments IDs.

​
ownerEstablishmentId
integer[]

Only retrieve training-demands for employeesthat currently have a work-contract with one of the listed establishment IDs.

​
priorizationLevel
integer[]

Only retrieve training-demands that were given one of the listed priority levels.

​
limit
integer
default:20

Pagination: number of items per page. @TODO: check maximum value

Required range: 0 <= x <= 100
​
page

Page to retrieve. Either the page index <int> or the page cursor <string>.

Required range: x >= 0
​
fields.root
enum<string>[]

Include the total number of items across all pages, as well as pointers to the previous and next pages.

Available options:
prev,
next,
count
​
sort
enum<string>[]

Sort items by one of their property. Syntax is:

<sort>                  ::= '-|+'? <property> ( ',' <property> )*
<property>              ::= <strictString> ( '.' <strictString> )*
<strictString>          ::= ( <char> | <digit> | '_' | '-' )+
Available options:
prioritization.level,
+prioritization.level,
-prioritization.level,
createdAt,
+createdAt,
-createdAt
Example:
["-prioritization.level", "+createdAt"]

Response

200
application/json
OK
​
items
object[]

The training-demand represents a training request for a given employee. It may be emitted from the employee or from management.

It is subject to a prioritization process, during which management gives it a priority level (high, medium, low) in regards to its conformance to business goals, compliance with safety rules, cost, etc...

Then HR admins analyze the training request and depending on the training managment policy and the budget accept or refuse the request. Accepting the request means adding the request to a training plan which contains training sessions.

The training-demand resource represents afdterward also the registration to a training session. When the training session is completed and the attendance has been entered by HR admins. The completed training is represented by the realized-training resource.

​
count
integer | null

Total number of items across all pages. You need to include ?fields.root=count to your request to retrieve this.

Required range: x >= 0
​
prev
string | null

Cursor to the previous page. You need to include ?fields.root=prev in order to retrieve this.

​
next
string | null

Cursor to the next page. You need to include ?fields.root=next in order to retrieve this.

Was this page helpful?