Division

Create division#

Creates a new division.

POST
/orgstruct/divisions

Request body:

Attribute	Type	Description	Nullable
externalId	String	Division external id	true
name	String	Division name	false
active	Boolean	Whether the division is active. Default `true`	true

Response

Returns Division object

Examples

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

200 OK

{
  "id": 37,
  "name": "USA",
  "active": true,
  "regionsCount": 0,
  "shopsCount": 0
}

Update division#

Updates an existing division by id.

PUT
/orgstruct/divisions/{id}

Request body:

Attribute	Type	Description	Nullable
externalId	String	Division external id	true
name	String	Division name	false
active	Boolean	Whether the division is active	false

Response

Returns Division object

Examples

curl --request PUT https://api.qvalon.com/v1/orgstruct/divisions/37 \
--header 'Authorization: Bearer <your_token>' \
--header 'Content-Type: application/json' \
-d '{"name":"USA","active":false}'

200 OK

{
  "id": 37,
  "name": "USA",
  "active": true,
  "regionsCount": 0,
  "shopsCount": 0
}

List divisions#

Returns a list of Division objects

GET
/orgstruct/divisions

Request parameters:

Request Parameter	Type	Description	Required
ids	List of integers	Filter divisions by specified ids (comma-separated)	false
nameLike	String	Find divisions by name	false
userId	Integer	Find divisions by userId	false
businessDirId	Integer	Find divisions by businessDirId	false
searchString	String	Find divisions by name or manager of division first or last name	false
shopId	Integer	Find divisions by shopId	false
active	Boolean	Get only active divisions	false
withDirs	Boolean	Deprecated, use `fields=dirs` instead. Get divisions where appointed are directors	false
fields	List of String (comma-separated)	Additional division fields to include in the response object. Available values: `dirs, dirsWithBusinessDirs, regions`. Default: `dirs`	false

Examples

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

200 OK

[
  {
    "id": 37,
    "name": "USA",
    "active": false,
    "dirs": [
      {
        "id": 2149,
        "active": true,
        "login": "samplemail@example.com",
        "firstName": "Jhon",
        "lastName": "Smitt",
        "position": "Division manager",
        "level": "DIVISION",
        "businessDirId": 1004,
        "lang": "en_EN",
        "invited": true,
        "inviteAccepted": true,
        "inviteAcceptedAt": "2022-10-14T12:04:07.600564"
      }
    ],
    "regionsCount": 0,
    "shopsCount": 0
  }
]

Get division by id#

Returns a Division object

Available fields to add in object see here

GET
/orgstruct/divisions/{id}

Request parameters:

Request Parameter	Type	Description	Required
fields	List of String (comma-separated)	Additional division fields to include in the response object. Available values: `dirs, dirsWithBusinessDirs, regions`. Default: `dirs`	false

Examples

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

200 OK

{
  "id": 37,
  "name": "USA",
  "active": false,
  "dirs": [
    {
      "id": 2149,
      "active": true,
      "login": "samplemail@example.com",
      "firstName": "Jhon",
      "lastName": "Smitt",
      "position": "Division manager",
      "level": "DIVISION",
      "businessDirId": 1004,
      "lang": "en_EN",
      "invited": true,
      "inviteAccepted": true,
      "inviteAcceptedAt": "2022-10-14T12:04:07.600564"
    }
  ],
  "regionsCount": 0,
  "shopsCount": 0
}