Division

Operations

GET/divisionsGET/divisions/countGET/divisions/findOneGET/divisions/{id}GET/divisions/{id}/customerDefaultPermissionsGET/divisions/{id}/customerDefaultPermissions/inheritedGET/divisions/{id}/existsGET/divisions/{id}/getBranchPlantIdsGET/divisions/{id}/getDVIRFormatGET/divisions/{id}/getEmployeeTypesGET/divisions/{id}/getHolidaysGET/divisions/{id}/getSettingsGET/divisions/{id}/getTicketFormatsGET/divisions/{id}/getTicketSignatureSettingsGET/divisions/{id}/getTimeCategoriesGET/divisions/{id}/parentGET/divisions/{id}/plantsGET/divisions/{id}/plants/countGET/divisions/{id}/plants/{fk}GET/divisions/{id}/settingsGET/divisions/{id}/ticketFormatsGET/divisions/{id}/ticketFormats/countGET/divisions/{id}/ticketFormats/{fk}GET/divisions/{id}/timeRules

---

GET /divisions

GET

/divisions

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

"code": "string",

"externalId": "string",

"id": "string",

"parentId": "string",

"companyId": "string",

"createdAt": "string",

"updatedAt": "string"

}

]

GET

/divisions

Playground

Variables

Key

Value

filter

Samples

cURL

JavaScript

PHP

Python

---

GET /divisions/count

GET

/divisions/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

/divisions/count

Playground

Variables

Key

Value

where

Samples

cURL

JavaScript

PHP

Python

---

GET /divisions/findOne

GET

/divisions/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",

"code": "string",

"externalId": "string",

"id": "string",

"parentId": "string",

"companyId": "string",

"createdAt": "string",

"updatedAt": "string"

}

GET

/divisions/findOne

Playground

Variables

Key

Value

filter

Samples

cURL

JavaScript

PHP

Python

---

GET /divisions/{id}

GET

/divisions/{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",

"code": "string",

"externalId": "string",

"id": "string",

"parentId": "string",

"companyId": "string",

"createdAt": "string",

"updatedAt": "string"

}

GET

/divisions/{id}

Playground

Variables

Key

Value

id*

filter

Samples

cURL

JavaScript

PHP

Python

---

GET /divisions/{id}/customerDefaultPermissions

GET

/divisions/{id}/customerDefaultPermissions

Fetches hasOne relation customerDefaultPermissions.

Parameters

Path Parameters

id*

PersistedModel id

Typestring

Required

Query Parameters

refresh

Typeboolean

Responses

Request was successful

Content-Type

application/json

{

"allowAcceptRejectLoad": true,

"allowOrderRequest": true,

"allowViewBatchWeights": true,

"allowViewDriverNotes": true,

"allowViewPhotos": true,

"allowViewWaterDetails": true,

"id": "string",

"companyId": "string",

"divisionId": "string",

"createdAt": "string",

"updatedAt": "string"

}

GET

/divisions/{id}/customerDefaultPermissions

Playground

Variables

Key

Value

id*

refresh

Samples

cURL

JavaScript

PHP

Python

---

GET /divisions/{id}/customerDefaultPermissions/inherited

GET

/divisions/{id}/customerDefaultPermissions/inherited

Get customer default permissions. Returned permissions may come from one of parent divisions if they are not set for current division

Parameters

Path Parameters

id*

PersistedModel id

Typestring

Required

Responses

Request was successful

Content-Type

application/json

{

}

GET

/divisions/{id}/customerDefaultPermissions/inherited

Playground

Variables

Key

Value

id*

Samples

cURL

JavaScript

PHP

Python

---

GET /divisions/{id}/exists

GET

/divisions/{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

/divisions/{id}/exists

Playground

Variables

Key

Value

id*

Samples

cURL

JavaScript

PHP

Python

---

GET /divisions/{id}/getBranchPlantIds

GET

/divisions/{id}/getBranchPlantIds

Get ids of plants belonging to this division, it's parents and all descendants

Parameters

Path Parameters

id*

PersistedModel id

Typestring

Required

Responses

Request was successful

Content-Type

application/json

[

"string"

]

GET

/divisions/{id}/getBranchPlantIds

Playground

Variables

Key

Value

id*

Samples

cURL

JavaScript

PHP

Python

---

GET /divisions/{id}/getDVIRFormat

GET

/divisions/{id}/getDVIRFormat

Get form formats. Returned format may come from one of parent divisions if form format for current division does not exist

Parameters

Path Parameters

id*

PersistedModel id

Typestring

Required

Query Parameters

type*

Form format type

Typestring

Required

Responses

Request was successful

Content-Type

application/json

{

}

GET

/divisions/{id}/getDVIRFormat

Playground

Variables

Key

Value

id*

type*

Samples

cURL

JavaScript

PHP

Python

---

GET /divisions/{id}/getEmployeeTypes

GET

/divisions/{id}/getEmployeeTypes

Get employee types. Returned employee types may come from one of parent divisions if employee type for current division do not exist

Parameters

Path Parameters

id*

PersistedModel id

Typestring

Required

Query Parameters

filter

Query filter

Typestring

Responses

Request was successful

Content-Type

application/json

[

{

}

]

GET

/divisions/{id}/getEmployeeTypes

Playground

Variables

Key

Value

id*

filter

Samples

cURL

JavaScript

PHP

Python

---

GET /divisions/{id}/getHolidays

GET

/divisions/{id}/getHolidays

Get holidays. Returned holidays may come from one of parent divisions or from company if holiday for current division do not exist

Parameters

Path Parameters

id*

PersistedModel id

Typestring

Required

Query Parameters

filter

Holiday filter

Typestring

Responses

Request was successful

Content-Type

application/json

[

{

}

]

GET

/divisions/{id}/getHolidays

Playground

Variables

Key

Value

id*

filter

Samples

cURL

JavaScript

PHP

Python

---

GET /divisions/{id}/getSettings

GET

/divisions/{id}/getSettings

Get division settings. Returned settings may come from one of parent divisions or company configuration if settings for current division does not exist

Parameters

Path Parameters

id*

PersistedModel id

Typestring

Required

Responses

Request was successful

Content-Type

application/json

{

}

GET

/divisions/{id}/getSettings

Playground

Variables

Key

Value

id*

Samples

cURL

JavaScript

PHP

Python

---

GET /divisions/{id}/getTicketFormats

GET

/divisions/{id}/getTicketFormats

Get ticket formats. Returned formats may come from one of parent divisions or from company if ticket formats for current division do not exist

Parameters

Path Parameters

id*

PersistedModel id

Typestring

Required

Responses

Request was successful

Content-Type

application/json

{

}

GET

/divisions/{id}/getTicketFormats

Playground

Variables

Key

Value

id*

Samples

cURL

JavaScript

PHP

Python

---

GET /divisions/{id}/getTicketSignatureSettings

GET

/divisions/{id}/getTicketSignatureSettings

Get ticket signature settings. Returned settings may come from one of parent divisions or from company configuration if ticket signature settings for current division do not exist

Parameters

Path Parameters

id*

PersistedModel id

Typestring

Required

Responses

Request was successful

Content-Type

application/json

{

}

GET

/divisions/{id}/getTicketSignatureSettings

Playground

Variables

Key

Value

id*

Samples

cURL

JavaScript

PHP

Python

---

GET /divisions/{id}/getTimeCategories

GET

/divisions/{id}/getTimeCategories

Get time categories. Returned time categories may come from one of parent divisions or from company if time category for current division do not exist

Parameters

Path Parameters

id*

PersistedModel id

Typestring

Required

Query Parameters

filter

Time category filter

Typestring

Responses

Request was successful

Content-Type

application/json

[

{

}

]

GET

/divisions/{id}/getTimeCategories

Playground

Variables

Key

Value

id*

filter

Samples

cURL

JavaScript

PHP

Python

---

GET /divisions/{id}/parent

GET

/divisions/{id}/parent

Fetches belongsTo relation parent.

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

/divisions/{id}/parent

Playground

Variables

Key

Value

id*

refresh

Samples

cURL

JavaScript

PHP

Python

---

GET /divisions/{id}/plants

GET

/divisions/{id}/plants

Queries plants of Division.

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

/divisions/{id}/plants

Playground

Variables

Key

Value

id*

filter

Samples

cURL

JavaScript

PHP

Python

---

GET /divisions/{id}/plants/count

GET

/divisions/{id}/plants/count

Counts plants of Division.

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

/divisions/{id}/plants/count

Playground

Variables

Key

Value

id*

where

Samples

cURL

JavaScript

PHP

Python

---

GET /divisions/{id}/plants/{fk}

GET

/divisions/{id}/plants/{fk}

Find a related item by id for plants.

Parameters

Path Parameters

fk*

Foreign key for plants

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

/divisions/{id}/plants/{fk}

Playground

Variables

Key

Value

fk*

id*

Samples

cURL

JavaScript

PHP

Python

---

GET /divisions/{id}/settings

GET

/divisions/{id}/settings

Fetches hasOne relation settings.

Parameters

Path Parameters

id*

PersistedModel id

Typestring

Required

Query Parameters

refresh

Typeboolean

Responses

Request was successful

Content-Type

application/json

{

"companyLogo": "string",

"ticketLogo": "string",

"ticketAgreement": "string",

"allowBreaks": true,

"allowEndOfDayFlag": true,

"allowUnlimitedUTO": true,

"clockInAfterMarginInMinutes": 0,

"clockInBeforeMarginInMinutes": 0,

"clockInRequired": true,

"enableIntegratedPayroll": true,

"endOfDayTimer": 0,

"maxWorkingHours": 0,

"needsClockInVerification": true,

"allowLateClockIn": true,

"simpleClockIn": true,

"dvirRequired": true,

"dvirTimeLimit": 0,

"clockInPublicQROnly": true,

"pouringStatusRequired": true,

"unassignTruckOnClockOut": true,

"formEntryExpireAfterDays": 0,

"requirePlantDurationsOnTimeLogEntryApproval": true,

"dayStartsAt": 0,

"splitOvernightHoursInTimekeepingView": true,

"id": "string",

"companyId": "string",

"divisionId": "string",

"createdAt": "string",

"updatedAt": "string"

}

GET

/divisions/{id}/settings

Playground

Variables

Key

Value

id*

refresh

Samples

cURL

JavaScript

PHP

Python

---

GET /divisions/{id}/ticketFormats

GET

/divisions/{id}/ticketFormats

Queries ticketFormats of Division.

Parameters

Path Parameters

id*

PersistedModel id

Typestring

Required

Query Parameters

filter

Typestring

Responses

Request was successful

Content-Type

application/json

[

{

"template": "string",

"type": "print",

"externalId": "string",

"id": "string",

"companyId": "string",

"divisionId": "string",

"createdAt": "string",

"updatedAt": "string"

}

]

GET

/divisions/{id}/ticketFormats

Playground

Variables

Key

Value

id*

filter

Samples

cURL

JavaScript

PHP

Python

---

GET /divisions/{id}/ticketFormats/count

GET

/divisions/{id}/ticketFormats/count

Counts ticketFormats of Division.

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

/divisions/{id}/ticketFormats/count

Playground

Variables

Key

Value

id*

where

Samples

cURL

JavaScript

PHP

Python

---

GET /divisions/{id}/ticketFormats/{fk}

GET

/divisions/{id}/ticketFormats/{fk}

Find a related item by id for ticketFormats.

Parameters

Path Parameters

fk*

Foreign key for ticketFormats

Typestring

Required

id*

PersistedModel id

Typestring

Required

Responses

Request was successful

Content-Type

application/json

{

"template": "string",

"type": "print",

"externalId": "string",

"id": "string",

"companyId": "string",

"divisionId": "string",

"createdAt": "string",

"updatedAt": "string"

}

GET

/divisions/{id}/ticketFormats/{fk}

Playground

Variables

Key

Value

fk*

id*

Samples

cURL

JavaScript

PHP

Python

---

GET /divisions/{id}/timeRules

GET

/divisions/{id}/timeRules

Get time rules settings. Returned settings may come from one of parent divisions or from company configuration if timekeeping rules settings for current division do not exist

Parameters

Path Parameters

id*

PersistedModel id

Typestring

Required

Responses

Request was successful

Content-Type

application/json

{

}

GET

/divisions/{id}/timeRules

Playground

Variables

Key

Value

id*

Samples

cURL

JavaScript

PHP

Python

---