Region

Create region#

Creates new region.

POST
/orgstruct/regions

Request body:

Attribute	Type	Description	Nullable
externalId	String	Region external id	false
name	String	Region name	false
divisionId	String	Division associated with the region	false
active	String	Region availability for users	false
divisionExternalId	String	Division external id	false

Response

Returns Region object

Examples

curl --request POST https://api.qvalon.com/v1/orgstruct/regions \
--header 'Authorization: Bearer <your_token>' \
--header 'Content-Type: application/json' \
-d '{"name":"Test region","divisionId":28,"active":true}'

200 OK

{
  "id": 66,
  "name": "Test region",
  "divisionId": 35,
  "shopsCount": 0,
  "active": true
}

Update region#

Update existing region by id.

PUT
/orgstruct/regions/{id}

Request body:

Attribute	Type	Description	Nullable
externalId	String	Region external id	false
name	String	Region name	false
divisionId	String	Division associated with the region	false
active	String	Region availability for users	false
divisionExternalId	String	Division external id	false

Response

Returns Region object

Examples

curl --request PUT https://api.qvalon.com/v1/orgstruct/regions/66 \
--header 'Authorization: Bearer <your_token>' \
--header 'Content-Type: application/json' \
-d '{"name":"Test region update","divisionId":28,"active":true}'

200 OK

{
  "id": 66,
  "name": "Test region update",
  "divisionId": 28,
  "active": true,
  "shopsCount": 0
}

List regions#

Returns a list of Region objects

Available fields to add in object see here

GET
/orgstruct/regions

Request parameters:

Request Parameter	Type	Description	Required
ids	List of integers	Filter regions by specified ids (comma-separated)	false
nameLike	String	Find regions by name	true
shopIds	List of integers	Find region by shopIds	false
divisionIds	List of integers	Find regions by division ids	false
active	Boolean	Get only active regions	false
fields	List of String (comma-separated)	Add additional fields to response object	false
userId	Integer	Find regions by user Id	false
businessDirId	Integer	Find regions by businessDir Id	false
shopId	Integer	Find regions by shop Id	false
searchString	String	Find regions by name or division name or manager of regions first or last name	false
withDirs	Boolean	Get regions where appointed are manager	false

Examples

curl https://api.qvalon.com/v1/orgstruct/regions \
--header 'Authorization: Bearer <your_token>'

200 OK

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

Get region by id#

Return Region object

GET
/orgstruct/regions/{id}

Examples

curl https://api.qvalon.com/v1/orgstruct/regions/66 \
--header 'Authorization: Bearer <your_token>'

200 OK

{
  "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": "Elena",
      "lastName": "Savina",
      "position": "Region manager",
      "level": "REGION",
      "businessDirId": 1001,
      "lang": "en_EN",
      "invited": false
    }
  ],
  "divisionName": "Division 1",
  "shopsCount": 8
}