Reference data

Get HDO regions

Changed on

The regions a distributor splits its HDO commands by. Empty when its commands are not region-specific.

get/api/v1/reference/distributors/{distributor}/regions

Request

  • Base URL
    https://api.partner.cubee.cz
  • URL
    https://api.partner.cubee.cz/api/v1/reference/distributors/{distributor}/regions
  • Auth
    none required

Path parameters

distributorstring required

Distributor code — CEZ, PRE or EGD.

Response

OK

idstring uuid

Unique identifier of the type (region).

keystring nullable

Stable key of the type (region) — use as distribution.lowTariffRegion.

namestring nullable

Display name of the type (region).

sortIndexinteger nullable

Optional ordering index for display.

Example response

[
  {
    "id": "d4f6b8c0-4e5a-4b9c-1d2e-3f4a5b6c7d8e",
    "key": "STRED",
    "name": "Střed",
    "sortIndex": 1
  }
]

Changes