Employee

Operations

GET/employeesGET/employees/countGET/employees/filterGET/employees/filterTypesGET/employees/findOneGET/employees/{id}GET/employees/{id}/accountPOST/employees/{id}/breakEndPOST/employees/{id}/breakStartGET/employees/{id}/callOutsPOST/employees/{id}/callOutsDELETE/employees/{id}/callOutsGET/employees/{id}/callOuts/countGET/employees/{id}/callOuts/{fk}PUT/employees/{id}/callOuts/{fk}DELETE/employees/{id}/callOuts/{fk}POST/employees/{id}/clockInPOST/employees/{id}/clockOutGET/employees/{id}/defaultTimeCategoryGET/employees/{id}/divisionGET/employees/{id}/employeeTypeGET/employees/{id}/existsGET/employees/{id}/logGET/employees/{id}/log/countGET/employees/{id}/log/{fk}GET/employees/{id}/managedPlantsGET/employees/{id}/managedPlants/countGET/employees/{id}/managedPlants/{fk}GET/employees/{id}/plantPOST/employees/{id}/signInPOST/employees/{id}/signOutGET/employees/{id}/timeCategoriesGET/employees/{id}/timeCategories/countGET/employees/{id}/timeCategories/{fk}GET/employees/{id}/timeOffsGET/employees/{id}/timeOffs/countGET/employees/{id}/timeOffs/{fk}GET/employees/{id}/timeOffsPerYearGET/employees/{id}/timeOffsPerYear/countGET/employees/{id}/timeOffsPerYear/{fk}GET/employees/{id}/truck

---

GET /employees

GET

/employees

Find all instances of the model matched by filter from the data source.

Parameters

Query Parameters

filter

Filter defining fields, where, include, order, offset, and limit

Typestring

Responses

Request was successful

Content-Type

application/json

[

{

"name": "string",

"number": "string",

"email": "string",

"phoneNumber": "string",

"type": "regular",

"clockInAllowedAt": "string",

"hireDate": "string",

"active": true,

"externalId": "string",

"receivesLateClockInNotifications": true,

"id": "string",

"companyId": "string",

"divisionId": "string",

"plantId": "string",

"truckId": "string",

"createdAt": "string",

"updatedAt": "string",

"typeId": "string",

"timeCategoryIds": [

"string"

],

"defaultTimeCategoryId": "string"

}

]

GET

/employees

Playground

Variables

Key

Value

filter

Samples

cURL

JavaScript

PHP

Python

---

GET /employees/count

GET

/employees/count

Count instances of the model matched by where from the data source.

Parameters

Query Parameters

where

Criteria to match model instances

Typestring

Responses

Request was successful

Content-Type

application/json

{

"count": 0

}

GET

/employees/count

Playground

Variables

Key

Value

where

Samples

cURL

JavaScript

PHP

Python

---

GET /employees/filter

GET

/employees/filter

Get filtered employees

Parameters

Query Parameters

keyword

Filter keyword

Typestring

type

Filter type

Typestring

Responses

Request was successful

Content-Type

application/json

[

{

}

]

GET

/employees/filter

Playground

Variables

Key

Value

keyword

type

Samples

cURL

JavaScript

PHP

Python

---

GET /employees/filterTypes

GET

/employees/filterTypes

Get available filter types

Responses

Request was successful

Content-Type

application/json

[

{

}

]

GET

/employees/filterTypes

Playground

Samples

cURL

JavaScript

PHP

Python

---

GET /employees/findOne

GET

/employees/findOne

Find first instance of the model matched by filter from the data source.

Parameters

Query Parameters

filter

Filter defining fields, where, include, order, offset, and limit

Typestring

Responses

Request was successful

Content-Type

application/json

{

"name": "string",

"number": "string",

"email": "string",

"phoneNumber": "string",

"type": "regular",

"clockInAllowedAt": "string",

"hireDate": "string",

"active": true,

"externalId": "string",

"receivesLateClockInNotifications": true,

"id": "string",

"companyId": "string",

"divisionId": "string",

"plantId": "string",

"truckId": "string",

"createdAt": "string",

"updatedAt": "string",

"typeId": "string",

"timeCategoryIds": [

"string"

],

"defaultTimeCategoryId": "string"

}

GET

/employees/findOne

Playground

Variables

Key

Value

filter

Samples

cURL

JavaScript

PHP

Python

---

GET /employees/{id}

GET

/employees/{id}

Find a model instance by {{id}} from the data source.

Parameters

Path Parameters

id*

Model id

Typestring

Required

Query Parameters

filter

Filter defining fields and include

Typestring

Responses

Request was successful

Content-Type

application/json

{

"name": "string",

"number": "string",

"email": "string",

"phoneNumber": "string",

"type": "regular",

"clockInAllowedAt": "string",

"hireDate": "string",

"active": true,

"externalId": "string",

"receivesLateClockInNotifications": true,

"id": "string",

"companyId": "string",

"divisionId": "string",

"plantId": "string",

"truckId": "string",

"createdAt": "string",

"updatedAt": "string",

"typeId": "string",

"timeCategoryIds": [

"string"

],

"defaultTimeCategoryId": "string"

}

GET

/employees/{id}

Playground

Variables

Key

Value

id*

filter

Samples

cURL

JavaScript

PHP

Python

---

GET /employees/{id}/account

GET

/employees/{id}/account

Fetches hasOne relation account.

Parameters

Path Parameters

id*

PersistedModel id

Typestring

Required

Query Parameters

refresh

Typeboolean

Responses

Request was successful

Content-Type

application/json

{

"type": "string",

"subType": "string",

"sysdyneId": "string",

"realm": "string",

"username": "string",

"credentials": {

},

"challenges": {

},

"email": "string",

"emailVerified": true,

"status": "string",

"created": "string",

"lastUpdated": "string",

"id": "string",

"createdAt": "string",

"updatedAt": "string",

"companyId": "string",

"divisionId": "string",

"employeeId": "string"

}

GET

/employees/{id}/account

Playground

Variables

Key

Value

id*

refresh

Samples

cURL

JavaScript

PHP

Python

---

POST /employees/{id}/breakEnd

POST

/employees/{id}/breakEnd

End Break

Parameters

Path Parameters

id*

PersistedModel id

Typestring

Required

Request Body

application/json

{

"end": "string"

}

Responses

Request was successful

POST

/employees/{id}/breakEnd

Playground

Variables

Key

Value

id*

Body

Samples

cURL

JavaScript

PHP

Python

---

POST /employees/{id}/breakStart

POST

/employees/{id}/breakStart

Start Break

Parameters

Path Parameters

id*

PersistedModel id

Typestring

Required

Request Body

application/json

{

"start": "string"

}

Responses

Request was successful

POST

/employees/{id}/breakStart

Playground

Variables

Key

Value

id*

Body

Samples

cURL

JavaScript

PHP

Python

---

GET /employees/{id}/callOuts

GET

/employees/{id}/callOuts

GET /employees/{id}/callOuts

Parameters

Path Parameters

id*

PersistedModel id

Typestring

Required

Query Parameters

filter

Typestring

Format"JSON"

Responses

Request was successful

Content-Type

application/json

[

{

"clockInAllowedAt": "string",

"note": "string",

"phoneNumber": 0,

"confirmed": false,

"reply": "string",

"id": "string",

"userId": "string",

"companyId": "string",

"plantId": "string",

"employeeId": "string",

"createdAt": "string",

"updatedAt": "string",

"timeCategoryId": "string"

}

]

GET

/employees/{id}/callOuts

Playground

Variables

Key

Value

id*

filter

Samples

cURL

JavaScript

PHP

Python

---

POST /employees/{id}/callOuts

POST

/employees/{id}/callOuts

POST /employees/{id}/callOuts

Parameters

Path Parameters

id*

PersistedModel id

Typestring

Required

Request Body

application/json

{

"clockInAllowedAt": "string",

"note": "string",

"phoneNumber": 0,

"confirmed": false,

"reply": "string",

"id": "string",

"userId": "string",

"companyId": "string",

"plantId": "string",

"employeeId": "string",

"createdAt": "string",

"updatedAt": "string",

"timeCategoryId": "string"

}

Responses

Request was successful

Content-Type

application/json

{

"clockInAllowedAt": "string",

"note": "string",

"phoneNumber": 0,

"confirmed": false,

"reply": "string",

"id": "string",

"userId": "string",

"companyId": "string",

"plantId": "string",

"employeeId": "string",

"createdAt": "string",

"updatedAt": "string",

"timeCategoryId": "string"

}

POST

/employees/{id}/callOuts

Playground

Variables

Key

Value

id*

Body

Samples

cURL

JavaScript

PHP

Python

---

DELETE /employees/{id}/callOuts

DELETE

/employees/{id}/callOuts

DELETE /employees/{id}/callOuts

Parameters

Path Parameters

id*

PersistedModel id

Typestring

Required

Responses

Request was successful

DELETE

/employees/{id}/callOuts

Playground

Variables

Key

Value

id*

Samples

cURL

JavaScript

PHP

Python

---

GET /employees/{id}/callOuts/count

GET

/employees/{id}/callOuts/count

GET /employees/{id}/callOuts/count

Parameters

Path Parameters

id*

PersistedModel id

Typestring

Required

Query Parameters

where

Criteria to match model instances

Typestring

Format"JSON"

Responses

Request was successful

Content-Type

application/json

{

"count": 0

}

GET

/employees/{id}/callOuts/count

Playground

Variables

Key

Value

id*

where

Samples

cURL

JavaScript

PHP

Python

---

GET /employees/{id}/callOuts/{fk}

GET

/employees/{id}/callOuts/{fk}

GET /employees/{id}/callOuts/{fk}

Parameters

Path Parameters

fk*

Foreign key for callOuts

Typestring

Required

id*

PersistedModel id

Typestring

Required

Responses

Request was successful

Content-Type

application/json

{

"clockInAllowedAt": "string",

"note": "string",

"phoneNumber": 0,

"confirmed": false,

"reply": "string",

"id": "string",

"userId": "string",

"companyId": "string",

"plantId": "string",

"employeeId": "string",

"createdAt": "string",

"updatedAt": "string",

"timeCategoryId": "string"

}

GET

/employees/{id}/callOuts/{fk}

Playground

Variables

Key

Value

fk*

id*

Samples

cURL

JavaScript

PHP

Python

---

PUT /employees/{id}/callOuts/{fk}

PUT

/employees/{id}/callOuts/{fk}

PUT /employees/{id}/callOuts/{fk}

Parameters

Path Parameters

fk*

Foreign key for callOuts

Typestring

Required

id*

PersistedModel id

Typestring

Required

Request Body

application/json

{

"clockInAllowedAt": "string",

"note": "string",

"phoneNumber": 0,

"confirmed": false,

"reply": "string",

"id": "string",

"userId": "string",

"companyId": "string",

"plantId": "string",

"employeeId": "string",

"createdAt": "string",

"updatedAt": "string",

"timeCategoryId": "string"

}

Responses

Request was successful

Content-Type

application/json

{

"clockInAllowedAt": "string",

"note": "string",

"phoneNumber": 0,

"confirmed": false,

"reply": "string",

"id": "string",

"userId": "string",

"companyId": "string",

"plantId": "string",

"employeeId": "string",

"createdAt": "string",

"updatedAt": "string",

"timeCategoryId": "string"

}

PUT

/employees/{id}/callOuts/{fk}

Playground

Variables

Key

Value

fk*

id*

Body

Samples

cURL

JavaScript

PHP

Python

---

DELETE /employees/{id}/callOuts/{fk}

DELETE

/employees/{id}/callOuts/{fk}

DELETE /employees/{id}/callOuts/{fk}

Parameters

Path Parameters

fk*

Foreign key for callOuts

Typestring

Required

id*

PersistedModel id

Typestring

Required

Responses

Request was successful

DELETE

/employees/{id}/callOuts/{fk}

Playground

Variables

Key

Value

fk*

id*

Samples

cURL

JavaScript

PHP

Python

---

POST /employees/{id}/clockIn

POST

/employees/{id}/clockIn

Clock in employee

Parameters

Path Parameters

id*

PersistedModel id

Typestring

Required

Request Body

application/json

{

"clockedInAt": "string",

"timeCategoryId": "string"

}

Responses

Request was successful

POST

/employees/{id}/clockIn

Playground

Variables

Key

Value

id*

Body

Samples

cURL

JavaScript

PHP

Python

---

POST /employees/{id}/clockOut

POST

/employees/{id}/clockOut

Clock out employee

Parameters

Path Parameters

id*

PersistedModel id

Typestring

Required

Request Body

application/json

{

"clockedOutAt": "string",

"clockOutDescription": "string"

}

Responses

Request was successful

POST

/employees/{id}/clockOut

Playground

Variables

Key

Value

id*

Body

Samples

cURL

JavaScript

PHP

Python

---

GET /employees/{id}/defaultTimeCategory

GET

/employees/{id}/defaultTimeCategory

Fetches belongsTo relation defaultTimeCategory.

Parameters

Path Parameters

id*

PersistedModel id

Typestring

Required

Query Parameters

refresh

Typeboolean

Responses

Request was successful

Content-Type

application/json

{

"name": "string",

"type": "tracked",

"code": "string",

"costCenter": "string",

"showInDriverAppInsights": true,

"id": "string",

"companyId": "string",

"divisionId": "string",

"createdAt": "string",

"updatedAt": "string"

}

GET

/employees/{id}/defaultTimeCategory

Playground

Variables

Key

Value

id*

refresh

Samples

cURL

JavaScript

PHP

Python

---

GET /employees/{id}/division

GET

/employees/{id}/division

Fetches belongsTo relation division.

Parameters

Path Parameters

id*

PersistedModel id

Typestring

Required

Query Parameters

refresh

Typeboolean

Responses

Request was successful

Content-Type

application/json

{

"name": "string",

"code": "string",

"externalId": "string",

"id": "string",

"parentId": "string",

"companyId": "string",

"createdAt": "string",

"updatedAt": "string"

}

GET

/employees/{id}/division

Playground

Variables

Key

Value

id*

refresh

Samples

cURL

JavaScript

PHP

Python

---

GET /employees/{id}/employeeType

GET

/employees/{id}/employeeType

Fetches belongsTo relation employeeType.

Parameters

Path Parameters

id*

PersistedModel id

Typestring

Required

Query Parameters

refresh

Typeboolean

Responses

Request was successful

Content-Type

application/json

{

"code": "string",

"name": "string",

"isDefault": false,

"maxWorkingHours": 18,

"needsClockInVerification": true,

"clockInBeforeMarginInMinutes": 5,

"clockInAfterMarginInMinutes": 10,

"allowLateClockIn": true,

"doAutoClockOut": false,

"id": "string",

"companyId": "string",

"divisionId": "string",

"timeRuleIds": [

"string"

],

"createdAt": "string",

"updatedAt": "string",

"timeCategoryIds": [

"string"

],

"defaultTimeCategoryId": "string"

}

GET

/employees/{id}/employeeType

Playground

Variables

Key

Value

id*

refresh

Samples

cURL

JavaScript

PHP

Python

---

GET /employees/{id}/exists

GET

/employees/{id}/exists

Check whether a model instance exists in the data source.

Parameters

Path Parameters

id*

Model id

Typestring

Required

Responses

Request was successful

Content-Type

application/json

{

"exists": true

}

GET

/employees/{id}/exists

Playground

Variables

Key

Value

id*

Samples

cURL

JavaScript

PHP

Python

---

GET /employees/{id}/log

GET

/employees/{id}/log

Queries log of Employee.

Parameters

Path Parameters

id*

PersistedModel id

Typestring

Required

Query Parameters

filter

Typestring

Responses

Request was successful

Content-Type

application/json

[

{

"status": "string",

"fullName": "string",

"workplace": "string",

"clockInLocation": "string",

"clockOutLocation": "string",

"clockedInAt": "string",

"clockedOutAt": "string",

"clockInDescription": "string",

"clockOutDescription": "string",

"employeeType": "regular",

"approvalStatus": 0,

"isHoliday": true,

"durations": {

},

"employeeId": "string",

"id": "string",

"userId": "string",

"companyId": "string",

"deviceId": "string",

"truckId": "string",

"metrics": {

"course": 0,

"speed": 0,

"metricsDate": "string",

"id": "string"

},

"createdAt": "string",

"updatedAt": "string",

"breaks": [

{

"status": "string",

"start": "string",

"end": "string",

"id": "string",

"createdAt": "string",

"updatedAt": "string"

}

],

"timeCategoryId": "string",

"plants": [

{

"durations": {

},

"id": "string",

"plantId": "string"

}

]

}

]

GET

/employees/{id}/log

Playground

Variables

Key

Value

id*

filter

Samples

cURL

JavaScript

PHP

Python

---

GET /employees/{id}/log/count

GET

/employees/{id}/log/count

Counts log of Employee.

Parameters

Path Parameters

id*

PersistedModel id

Typestring

Required

Query Parameters

where

Criteria to match model instances

Typestring

Responses

Request was successful

Content-Type

application/json

{

"count": 0

}

GET

/employees/{id}/log/count

Playground

Variables

Key

Value

id*

where

Samples

cURL

JavaScript

PHP

Python

---

GET /employees/{id}/log/{fk}

GET

/employees/{id}/log/{fk}

Find a related item by id for log.

Parameters

Path Parameters

fk*

Foreign key for log

Typestring

Required

id*

PersistedModel id

Typestring

Required

Responses

Request was successful

Content-Type

application/json

{

"status": "string",

"fullName": "string",

"workplace": "string",

"clockInLocation": "string",

"clockOutLocation": "string",

"clockedInAt": "string",

"clockedOutAt": "string",

"clockInDescription": "string",

"clockOutDescription": "string",

"employeeType": "regular",

"approvalStatus": 0,

"isHoliday": true,

"durations": {

},

"employeeId": "string",

"id": "string",

"userId": "string",

"companyId": "string",

"deviceId": "string",

"truckId": "string",

"metrics": {

"course": 0,

"speed": 0,

"metricsDate": "string",

"id": "string"

},

"createdAt": "string",

"updatedAt": "string",

"breaks": [

{

"status": "string",

"start": "string",

"end": "string",

"id": "string",

"createdAt": "string",

"updatedAt": "string"

}

],

"timeCategoryId": "string",

"plants": [

{

"durations": {

},

"id": "string",

"plantId": "string"

}

]

}

GET

/employees/{id}/log/{fk}

Playground

Variables

Key

Value

fk*

id*

Samples

cURL

JavaScript

PHP

Python

---

GET /employees/{id}/managedPlants

GET

/employees/{id}/managedPlants

Queries managedPlants of Employee.

Parameters

Path Parameters

id*

PersistedModel id

Typestring

Required

Query Parameters

filter

Typestring

Responses

Request was successful

Content-Type

application/json

[

{

"number": "string",

"description": "string",

"address": "string",

"region": {

},

"location": "string",

"radius": 100,

"dvirEmails": [

"string"

],

"timeZone": "string",

"id": "string",

"companyId": "string",

"createdAt": "string",

"updatedAt": "string",

"plantRegionId": "string",

"addressDetails": "string"

}

]

GET

/employees/{id}/managedPlants

Playground

Variables

Key

Value

id*

filter

Samples

cURL

JavaScript

PHP

Python

---

GET /employees/{id}/managedPlants/count

GET

/employees/{id}/managedPlants/count

Counts managedPlants of Employee.

Parameters

Path Parameters

id*

PersistedModel id

Typestring

Required

Query Parameters

where

Criteria to match model instances

Typestring

Responses

Request was successful

Content-Type

application/json

{

"count": 0

}

GET

/employees/{id}/managedPlants/count

Playground

Variables

Key

Value

id*

where

Samples

cURL

JavaScript

PHP

Python

---

GET /employees/{id}/managedPlants/{fk}

GET

/employees/{id}/managedPlants/{fk}

Find a related item by id for managedPlants.

Parameters

Path Parameters

fk*

Foreign key for managedPlants

Typestring

Required

id*

PersistedModel id

Typestring

Required

Responses

Request was successful

Content-Type

application/json

{

"number": "string",

"description": "string",

"address": "string",

"region": {

},

"location": "string",

"radius": 100,

"dvirEmails": [

"string"

],

"timeZone": "string",

"id": "string",

"companyId": "string",

"createdAt": "string",

"updatedAt": "string",

"plantRegionId": "string",

"addressDetails": "string"

}

GET

/employees/{id}/managedPlants/{fk}

Playground

Variables

Key

Value

fk*

id*

Samples

cURL

JavaScript

PHP

Python

---

GET /employees/{id}/plant

GET

/employees/{id}/plant

Fetches belongsTo relation plant.

Parameters

Path Parameters

id*

PersistedModel id

Typestring

Required

Query Parameters

refresh

Typeboolean

Responses

Request was successful

Content-Type

application/json

{

"number": "string",

"description": "string",

"address": "string",

"region": {

},

"location": "string",

"radius": 100,

"dvirEmails": [

"string"

],

"timeZone": "string",

"id": "string",

"companyId": "string",

"createdAt": "string",

"updatedAt": "string",

"plantRegionId": "string",

"addressDetails": "string"

}

GET

/employees/{id}/plant

Playground

Variables

Key

Value

id*

refresh

Samples

cURL

JavaScript

PHP

Python

---

POST /employees/{id}/signIn

POST

/employees/{id}/signIn

Sign in employee

Parameters

Path Parameters

id*

PersistedModel id

Typestring

Required

Request Body

application/json

{

"truckId": "string"

}

Responses

Request was successful

POST

/employees/{id}/signIn

Playground

Variables

Key

Value

id*

Body

Samples

cURL

JavaScript

PHP

Python

---

POST /employees/{id}/signOut

POST

/employees/{id}/signOut

Sign out employee

Parameters

Path Parameters

id*

PersistedModel id

Typestring

Required

Responses

Request was successful

POST

/employees/{id}/signOut

Playground

Variables

Key

Value

id*

Samples

cURL

JavaScript

PHP

Python

---

GET /employees/{id}/timeCategories

GET

/employees/{id}/timeCategories

Queries timeCategories of Employee.

Parameters

Path Parameters

id*

PersistedModel id

Typestring

Required

Query Parameters

filter

Typestring

Responses

Request was successful

Content-Type

application/json

[

{

"name": "string",

"type": "tracked",

"code": "string",

"costCenter": "string",

"showInDriverAppInsights": true,

"id": "string",

"companyId": "string",

"divisionId": "string",

"createdAt": "string",

"updatedAt": "string"

}

]

GET

/employees/{id}/timeCategories

Playground

Variables

Key

Value

id*

filter

Samples

cURL

JavaScript

PHP

Python

---

GET /employees/{id}/timeCategories/count

GET

/employees/{id}/timeCategories/count

Counts timeCategories of Employee.

Parameters

Path Parameters

id*

PersistedModel id

Typestring

Required

Query Parameters

where

Criteria to match model instances

Typestring

Responses

Request was successful

Content-Type

application/json

{

"count": 0

}

GET

/employees/{id}/timeCategories/count

Playground

Variables

Key

Value

id*

where

Samples

cURL

JavaScript

PHP

Python

---

GET /employees/{id}/timeCategories/{fk}

GET

/employees/{id}/timeCategories/{fk}

Find a related item by id for timeCategories.

Parameters

Path Parameters

fk*

Foreign key for timeCategories

Typestring

Required

id*

PersistedModel id

Typestring

Required

Responses

Request was successful

Content-Type

application/json

{

"name": "string",

"type": "tracked",

"code": "string",

"costCenter": "string",

"showInDriverAppInsights": true,

"id": "string",

"companyId": "string",

"divisionId": "string",

"createdAt": "string",

"updatedAt": "string"

}

GET

/employees/{id}/timeCategories/{fk}

Playground

Variables

Key

Value

fk*

id*

Samples

cURL

JavaScript

PHP

Python

---

GET /employees/{id}/timeOffs

GET

/employees/{id}/timeOffs

Queries timeOffs of Employee.

Parameters

Path Parameters

id*

PersistedModel id

Typestring

Required

Query Parameters

filter

Typestring

Responses

Request was successful

Content-Type

application/json

[

{

"category": "string",

"paid": true,

"active": true,

"duration": 8,

"date": "string",

"employeeType": "string",

"description": "string",

"id": "string",

"companyId": "string",

"employeeId": "string",

"createdAt": "string",

"updatedAt": "string",

"timeCategoryId": "string"

}

]

GET

/employees/{id}/timeOffs

Playground

Variables

Key

Value

id*

filter

Samples

cURL

JavaScript

PHP

Python

---

GET /employees/{id}/timeOffs/count

GET

/employees/{id}/timeOffs/count

Counts timeOffs of Employee.

Parameters

Path Parameters

id*

PersistedModel id

Typestring

Required

Query Parameters

where

Criteria to match model instances

Typestring

Responses

Request was successful

Content-Type

application/json

{

"count": 0

}

GET

/employees/{id}/timeOffs/count

Playground

Variables

Key

Value

id*

where

Samples

cURL

JavaScript

PHP

Python

---

GET /employees/{id}/timeOffs/{fk}

GET

/employees/{id}/timeOffs/{fk}

Find a related item by id for timeOffs.

Parameters

Path Parameters

fk*

Foreign key for timeOffs

Typestring

Required

id*

PersistedModel id

Typestring

Required

Responses

Request was successful

Content-Type

application/json

{

"category": "string",

"paid": true,

"active": true,

"duration": 8,

"date": "string",

"employeeType": "string",

"description": "string",

"id": "string",

"companyId": "string",

"employeeId": "string",

"createdAt": "string",

"updatedAt": "string",

"timeCategoryId": "string"

}

GET

/employees/{id}/timeOffs/{fk}

Playground

Variables

Key

Value

fk*

id*

Samples

cURL

JavaScript

PHP

Python

---

GET /employees/{id}/timeOffsPerYear

GET

/employees/{id}/timeOffsPerYear

Queries timeOffsPerYear of Employee.

Parameters

Path Parameters

id*

PersistedModel id

Typestring

Required

Query Parameters

filter

Typestring

Responses

Request was successful

Content-Type

application/json

[

{

"year": 0,

"paidAllowed": 0,

"paidUsed": 0,

"unpaidAllowed": 0,

"unpaidUsed": 0,

"allowUnlimitedUTO": true,

"id": "string",

"companyId": "string",

"employeeId": "string",

"createdAt": "string",

"updatedAt": "string",

"settings": [

{

"allowed": 0,

"used": 0,

"paid": true,

"timeCategoryId": "string"

}

]

}

]

GET

/employees/{id}/timeOffsPerYear

Playground

Variables

Key

Value

id*

filter

Samples

cURL

JavaScript

PHP

Python

---

GET /employees/{id}/timeOffsPerYear/count

GET

/employees/{id}/timeOffsPerYear/count

Counts timeOffsPerYear of Employee.

Parameters

Path Parameters

id*

PersistedModel id

Typestring

Required

Query Parameters

where

Criteria to match model instances

Typestring

Responses

Request was successful

Content-Type

application/json

{

"count": 0

}

GET

/employees/{id}/timeOffsPerYear/count

Playground

Variables

Key

Value

id*

where

Samples

cURL

JavaScript

PHP

Python

---

GET /employees/{id}/timeOffsPerYear/{fk}

GET

/employees/{id}/timeOffsPerYear/{fk}

Find a related item by id for timeOffsPerYear.

Parameters

Path Parameters

fk*

Foreign key for timeOffsPerYear

Typestring

Required

id*

PersistedModel id

Typestring

Required

Responses

Request was successful

Content-Type

application/json

{

"year": 0,

"paidAllowed": 0,

"paidUsed": 0,

"unpaidAllowed": 0,

"unpaidUsed": 0,

"allowUnlimitedUTO": true,

"id": "string",

"companyId": "string",

"employeeId": "string",

"createdAt": "string",

"updatedAt": "string",

"settings": [

{

"allowed": 0,

"used": 0,

"paid": true,

"timeCategoryId": "string"

}

]

}

GET

/employees/{id}/timeOffsPerYear/{fk}

Playground

Variables

Key

Value

fk*

id*

Samples

cURL

JavaScript

PHP

Python

---

GET /employees/{id}/truck

GET

/employees/{id}/truck

Fetches belongsTo relation truck.

Parameters

Path Parameters

id*

PersistedModel id

Typestring

Required

Query Parameters

refresh

Typeboolean

Responses

Request was successful

Content-Type

application/json

{

"number": "string",

"description": "string",

"location": "string",

"locationData": {

},

"inService": false,

"inYard": false,

"deadhead": "string",

"endOfDay": false,

"lastAccess": "string",

"externalId": "string",

"id": "string",

"companyId": "string",

"divisionId": "string",

"createdAt": "string",

"updatedAt": "string",

"plantId": "string",

"currentPlantId": "string",

"metrics": "string"

}

GET

/employees/{id}/truck

Playground

Variables

Key

Value

id*

refresh

Samples

cURL

JavaScript

PHP

Python

---