Адреси та черги

Черги будинку

Ознайомтеся з параметрами запиту та форматом відповіді методу.

GET/api/v1/address-directory/streets/:id/queues

API-ключ - спільна квота облікового запису

Параметри URL та запиту

idstring - URLОбов'язковий: Ідентифікатор вулиці з результату пошуку.
housestring - queryОбов'язковий: Номер будинку.
buildingstring - query: Корпус.
slugstring - query: Ідентифікатор оператора.

Запит і відповідь

Потрібні id вулиці та параметр house; building і slug оператора необовʼязкові. Довідник може бути неповним.

Передайте API-ключ у заголовку Authorization. При 401 перевірте ключ; при 403 - підписку та доступність методу; при 429 враховуйте Retry-After.

Атрибути відповіді

assignmentsarray<object>

Доступні відповідності будинку.

Атрибути елемента масиву

idstring: Ідентифікатор відповідності будинку та черги.
supplier_slugstring: Ідентифікатор оператора.
supplier_namestring: Назва оператора.
queuestring: Назва черги.

Приклад запиту

curl --fail-with-body --max-time 10 \
  'https://alerts.energy/api/v1/address-directory/streets/000000000000000000000000/queues?house=1' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Приклад відповіді

Умовний скорочений приклад формату. Він не описує поточну ситуацію.

{
  "assignments": [
    {
      "id": "000000000000000000000000:0",
      "supplier_slug": "example-operator",
      "supplier_name": "Приклад оператора",
      "queue": "1.1"
    }
  ]
}