Region

Region is middle-level element of orgstructure.

Attribute	Type	Description	Nullable
id	Integer	Identifier	false
active	Boolean	Region avalibility for users	false
divisionId	Integer	Identifier of division	false
name	String	Region name	false
division	Division object	Division object that have of region	false
dirs	List of users object	List of user objects that are included in the region	true
divisionName	String	Name of division	false
shopsCount	Integer	Number shop that are included in the region	false

Example:

{
  "id": 66,
  "name": "Test region",
  "divisionId": 28,
  "active": true,
  "division": {
    "id": 28,
    "name": "Division 1",
    "active": true,
    "regionsCount": 6,
    "shopsCount": 51
  },
  "dirs": [
    {
      "id": 1697,
      "active": true,
      "login": "samplemail@example.com",
      "firstName": "Jhon",
      "lastName": "Doe",
      "position": "Region manager",
      "level": "REGION",
      "businessDirId": 1001,
      "lang": "en_EN",
      "invited": false
    }
  ],
  "divisionName": "Division 1",
  "shopsCount": 8
}

Usages:

Get regions

Additional region fields#

Additional region object fields

Attribute	Type	Description	Nullable
shops	List of shop object	Shop objects who associated with the region	true

Example:

{
  "id": 66,
  "name": "Test region",
  "divisionId": 28,
  "active": true,
  "division": {
    "id": 28,
    "name": "Division 1",
    "active": true,
    "regionsCount": 6,
    "shopsCount": 51
  },
  "dirs": [
    {
      "id": 1697,
      "active": true,
      "login": "samplemail@example.com",
      "firstName": "Jhon",
      "lastName": "Doe",
      "position": "Region manager",
      "level": "REGION",
      "businessDirId": 1001,
      "lang": "en_EN",
      "invited": false
    }
  ],
  "divisionName": "Division 1",
  "shopsCount": 8
}

Usages:

Get regions