EmployeeCallOuts

Operations

GET/EmployeeCallOutsPUT/EmployeeCallOutsPOST/EmployeeCallOutsPATCH/EmployeeCallOutsGET/EmployeeCallOuts/countGET/EmployeeCallOuts/findOneGET/EmployeeCallOuts/{id}PUT/EmployeeCallOuts/{id}DELETE/EmployeeCallOuts/{id}HEAD/EmployeeCallOuts/{id}PATCH/EmployeeCallOuts/{id}GET/EmployeeCallOuts/{id}/employeeGET/EmployeeCallOuts/{id}/existsGET/EmployeeCallOuts/{id}/plantGET/EmployeeCallOuts/{id}/timeCategoryGET/EmployeeCallOuts/{id}/userPOST/EmployeeCallOuts/replaceOrCreatePOST/EmployeeCallOuts/{id}/replacePOST/EmployeeCallOuts/updatePOST/EmployeeCallOuts/{id}/sendNotification

---

GET /EmployeeCallOuts

GET

/EmployeeCallOuts

GET /EmployeeCallOuts

Parameters

Query Parameters

filter

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

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

/EmployeeCallOuts

Playground

Variables

Key

Value

filter

Samples

cURL

JavaScript

PHP

Python

---

PUT /EmployeeCallOuts

PUT

/EmployeeCallOuts

PUT /EmployeeCallOuts

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

/EmployeeCallOuts

Playground

Body

Samples

cURL

JavaScript

PHP

Python

---

POST /EmployeeCallOuts

POST

/EmployeeCallOuts

POST /EmployeeCallOuts

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

/EmployeeCallOuts

Playground

Body

Samples

cURL

JavaScript

PHP

Python

---

PATCH /EmployeeCallOuts

PATCH

/EmployeeCallOuts

PATCH /EmployeeCallOuts

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"

}

PATCH

/EmployeeCallOuts

Playground

Body

Samples

cURL

JavaScript

PHP

Python

---

GET /EmployeeCallOuts/count

GET

/EmployeeCallOuts/count

GET /EmployeeCallOuts/count

Parameters

Query Parameters

where

Criteria to match model instances

Typestring

Format"JSON"

Responses

Request was successful

Content-Type

application/json

{

"count": 0

}

GET

/EmployeeCallOuts/count

Playground

Variables

Key

Value

where

Samples

cURL

JavaScript

PHP

Python

---

GET /EmployeeCallOuts/findOne

GET

/EmployeeCallOuts/findOne

GET /EmployeeCallOuts/findOne

Parameters

Query Parameters

filter

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

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

/EmployeeCallOuts/findOne

Playground

Variables

Key

Value

filter

Samples

cURL

JavaScript

PHP

Python

---

GET /EmployeeCallOuts/{id}

GET

/EmployeeCallOuts/{id}

GET /EmployeeCallOuts/{id}

Parameters

Path Parameters

id*

Model id

Typestring

Required

Query Parameters

filter

Filter defining fields and include

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

/EmployeeCallOuts/{id}

Playground

Variables

Key

Value

id*

filter

Samples

cURL

JavaScript

PHP

Python

---

PUT /EmployeeCallOuts/{id}

PUT

/EmployeeCallOuts/{id}

PUT /EmployeeCallOuts/{id}

Parameters

Path Parameters

id*

Model 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

/EmployeeCallOuts/{id}

Playground

Variables

Key

Value

id*

Body

Samples

cURL

JavaScript

PHP

Python

---

DELETE /EmployeeCallOuts/{id}

DELETE

/EmployeeCallOuts/{id}

DELETE /EmployeeCallOuts/{id}

Parameters

Path Parameters

id*

Model id

Typestring

Required

Responses

Request was successful

Content-Type

application/json

{

}

DELETE

/EmployeeCallOuts/{id}

Playground

Variables

Key

Value

id*

Samples

cURL

JavaScript

PHP

Python

---

HEAD /EmployeeCallOuts/{id}

HEAD

/EmployeeCallOuts/{id}

HEAD /EmployeeCallOuts/{id}

Parameters

Path Parameters

id*

Model id

Typestring

Required

Responses

Request was successful

Content-Type

application/json

{

"exists": true

}

HEAD

/EmployeeCallOuts/{id}

Playground

Variables

Key

Value

id*

Samples

cURL

JavaScript

PHP

Python

---

PATCH /EmployeeCallOuts/{id}

PATCH

/EmployeeCallOuts/{id}

PATCH /EmployeeCallOuts/{id}

Parameters

Path Parameters

id*

Model 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"

}

PATCH

/EmployeeCallOuts/{id}

Playground

Variables

Key

Value

id*

Body

Samples

cURL

JavaScript

PHP

Python

---

GET /EmployeeCallOuts/{id}/employee

GET

/EmployeeCallOuts/{id}/employee

GET /EmployeeCallOuts/{id}/employee

Parameters

Path Parameters

id*

PersistedModel id

Typestring

Required

Query Parameters

refresh

Typeboolean

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

/EmployeeCallOuts/{id}/employee

Playground

Variables

Key

Value

id*

refresh

Samples

cURL

JavaScript

PHP

Python

---

GET /EmployeeCallOuts/{id}/exists

GET

/EmployeeCallOuts/{id}/exists

GET /EmployeeCallOuts/{id}/exists

Parameters

Path Parameters

id*

Model id

Typestring

Required

Responses

Request was successful

Content-Type

application/json

{

"exists": true

}

GET

/EmployeeCallOuts/{id}/exists

Playground

Variables

Key

Value

id*

Samples

cURL

JavaScript

PHP

Python

---

GET /EmployeeCallOuts/{id}/plant

GET

/EmployeeCallOuts/{id}/plant

GET /EmployeeCallOuts/{id}/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

/EmployeeCallOuts/{id}/plant

Playground

Variables

Key

Value

id*

refresh

Samples

cURL

JavaScript

PHP

Python

---

GET /EmployeeCallOuts/{id}/timeCategory

GET

/EmployeeCallOuts/{id}/timeCategory

GET /EmployeeCallOuts/{id}/timeCategory

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

/EmployeeCallOuts/{id}/timeCategory

Playground

Variables

Key

Value

id*

refresh

Samples

cURL

JavaScript

PHP

Python

---

GET /EmployeeCallOuts/{id}/user

GET

/EmployeeCallOuts/{id}/user

GET /EmployeeCallOuts/{id}/user

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

/EmployeeCallOuts/{id}/user

Playground

Variables

Key

Value

id*

refresh

Samples

cURL

JavaScript

PHP

Python

---

POST /EmployeeCallOuts/replaceOrCreate

POST

/EmployeeCallOuts/replaceOrCreate

POST /EmployeeCallOuts/replaceOrCreate

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

/EmployeeCallOuts/replaceOrCreate

Playground

Body

Samples

cURL

JavaScript

PHP

Python

---

POST /EmployeeCallOuts/{id}/replace

POST

/EmployeeCallOuts/{id}/replace

POST /EmployeeCallOuts/{id}/replace

Parameters

Path Parameters

id*

Model 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

/EmployeeCallOuts/{id}/replace

Playground

Variables

Key

Value

id*

Body

Samples

cURL

JavaScript

PHP

Python

---

POST /EmployeeCallOuts/update

POST

/EmployeeCallOuts/update

POST /EmployeeCallOuts/update

Parameters

Query Parameters

where

Criteria to match model instances

Typestring

Format"JSON"

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

{

}

POST

/EmployeeCallOuts/update

Playground

Variables

Key

Value

where

Body

Samples

cURL

JavaScript

PHP

Python

---

POST /EmployeeCallOuts/{id}/sendNotification

POST

/EmployeeCallOuts/{id}/sendNotification

POST /EmployeeCallOuts/{id}/sendNotification

Parameters

Path Parameters

id*

PersistedModel id

Typestring

Required

Request Body

application/x-www-form-urlencoded

object

Notification Type

Valid values"sms""email"

Default"sms"

Notification Note

Callout related data

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"

}

POST

/EmployeeCallOuts/{id}/sendNotification

Playground

Variables

Key

Value

id*

Body

type

note

relatedData

Samples

cURL

JavaScript

PHP

Python

---