Division

Division is top-level element of orgstructure.

Attribute	Type	Description	Nullable
id	Integer	Identifier	false
active	Boolean	Division availability for users	false
name	String	Division name	false
dirs	List of user object	User objects for division directors	true
regionsCount	Integer	Number regions that are included in the division	false
shopsCount	Integer	Number shop that are included in the division	false

Example:

{
  "id": 28,
  "name": "West",
  "active": true,
  "dirs": [
    {
      "id": 2149,
      "active": true,
      "login": "samplemail@example.com",
      "firstName": "John",
      "lastName": "Doe",
      "position": "Division manager",
      "level": "DIVISION",
      "businessDirId": 1004,
      "lang": "en_EN",
      "invited": true,
      "inviteAccepted": true,
      "inviteAcceptedAt": "2022-10-14T12:04:07.600564"
    }
  ],
  "regionsCount": 6,
  "shopsCount": 51
}

Usages:

Get divisions

Additional division fields#

Additional division object fields

Attribute	Type	Description	Nullable
dirsWithBusinessDirs	List of user object	User objects for division directors with business direction object	true
regions	List of user object	Simple region objects associated with the division	true

Example:

{
  "id": 60,
  "name": "USA, Central New York",
  "active": true,
  "dirs": [
    {
      "id": 2280,
      "active": true,
      "login": "samplemail@example.com",
      "firstName": "Jon",
      "lastName": "Doe",
      "position": "Manager",
      "email": "samplemail@example.com",
      "level": "DIVISION",
      "businessDirId": 1001,
      "businessDir": {
        "id": 1001,
        "name": "Operations",
        "createTask": true,
        "system": true,
        "geoCheckStart": "accept",
        "geoCheckFinish": "accept",
        "observeMyShopTask": true
      },
      "ldapLogin": "samplemail@example.com",
      "lang": "en_EN",
      "voximplantLogin": "samplemail@example.com"
    }
  ],
  "regions": [
    {
      "id": 74,
      "name": "Madison",
      "active": true,
      "divisionId": 60,
      "shopsCount": 6
    },
    {
      "id": 75,
      "name": "Cayuga",
      "active": true,
      "divisionId": 60,
      "shopsCount": 2
    }
  ],
  "regionsCount": 2,
  "shopsCount": 8
}

Usages:

Get division by id