---
# System prepended metadata

title: '[208011] Отримання даних міст з довідника (v.1)'

---

УКР | [ENG](https://hackmd.io/LZsuqpBMR-iPJcnBKS7DmA)

# [208011] Отримання даних міст з довідника (v.1)

:::info
Застосування версії запитів "Оплата комунальних послуг (v.1)" чи "Оплата комунальних послуг (v.2)" визначається на етапі інтеграції.
:::

## Запит

*Опис атрибутів "Partner", "KeyAES" та "Sign" див. у розділі ["Загальна інформація по підключенню (API)"](https://hackmd.io/g3cItPVFStez0ql3Xj-2TA).*


### Структура "Data"

Структура "Data" для даної операції формується з наступних параметрів:

:::info
<details>
<summary>Формування структури "Data" (визначаються на етапі інтеграції)</summary>
<br>

~~~
{
    "dictionary": "",
    "parentid": "",
    "Transaction": {
        "TransactionID": "",
        "TerminalID": "",
        "DateTime": ""
    }
}
~~~
</details>
:::


|Параметр|Обов'яз-ковість|Тип|Опис|Приклад|
|:----:|:----:|:----:|----|:----:|
| `dictionary` | Так | Рядок | Передається значення, дані якого необхідно отримати з довідника: `city` - назви міст. |`city`|
| `parentid` | Так | Рядок | Фрагмент назви міста. |`Дол`|
|`Transaction`|Так|Структура|Структура, що передає дані про транзакцію. Див. розділ ["Структура "Transaction"](https://hackmd.io/g3cItPVFStez0ql3Xj-2TA#2-Data).|Див. нижче.|


## Відповідь

*Загальна інформація по формуванню структури відповіді наведена у розділі [“Загальна інформація по підключенню (API)”](https://hackmd.io/g3cItPVFStez0ql3Xj-2TA?both#%D0%A1%D1%82%D1%80%D1%83%D0%BA%D1%82%D1%83%D1%80%D0%B0-%D0%B2%D1%96%D0%B4%D0%BF%D0%BE%D0%B2%D1%96%D0%B4%D1%96).*

### Структура "Data"

Структура "Data" відповіді формується з наступних параметрів:

| Параметр | Обов’яз-ковість | Тип | Опис | Приклад |
|:-:|:-:|:-:|-|:-:|
| `result`^1^ | Так | Масив | Масив структур, що передає дані по запитаному місту. |Див. приклад нижче.|


^1^ Параметри масиву **"result"**:

| Параметр | Обов’яз-ковість | Тип | Опис | Приклад |
|:-:|:-:|:-:|-|:-:|
| `kommuna_area` | Так | Рядок | Район міста. |`Обухівський`|
| `kommuna_sity` | Так | Рядок | Повна назва міста. |`Долина`|
| `kommuna_state` | Так | Ціле | Область міста. |`Київська область`|
| `sity_id` | Так | Рядок | Унікальний ідентифікатор міста з довідника.  |`27314002`|


### Приклади відповідей

:::success
<details>
<summary>Операція проведена успішно</summary>
<br>

~~~md
{
  "Code": 200,
  "Message": "Adress find",
  "Data": {
    "OperationDate": "2023-02-21T15:54:42.129914+02:00",
    "OperationID": 9488897,
    "OperationStatus": 10,
    "result": [
      {
        "kommuna_area": "Обухівський",
        "kommuna_sity": "Долина",
        "kommuna_state": "Київська область",
        "sity_id": "27314002"
      }
    ]
  },
  "KeyAES": "",
  "Sign": ""
}
~~~
</details>
:::

:::success
<details>
<summary>Помилка виконання операції</summary>
<br>

~~~md
{
  "Code": 200,
  "Message": "done",
  "Data": {
    "OperationID": 111,
    "OperationStatus": 21,
    "Reason": 3
  },
  "KeyAES": "",
  "Sign": ""
}
~~~
</details>
:::


## Тестові дані

:::info
![](https://i.imgur.com/gtxKB22.png)

Для тестування даного запиту застосовуйте параметри **Тестового Партнера**. 
Див. деталі підключення у розділі: ["Параметри підключення Тестового Партнера"](https://hackmd.io/kGejjgk0QaiwfpoZFnTadA).


<details>
<summary>Тестовий запит</summary>
<br>

~~~md
{
  "Partner": {
    "PartnerToken": "72a8ddb8-9145-4a41-af1a-8c48ecaa4be1",
    "OperationType": 208011
  },
  "Data": "{\"dictionary\":\"city\",\"parentid\":\"Мик\",\"Transaction\":{\"TransactionID\":\"0c5328f5-bda9-4376-b6a0-ca544fcb73fc\",\"TerminalID\":\"1\",\"DateTime\":\"20230221120524\"}}",
  "KeyAES": "",
  "Sign": ""
}
~~~
</details>

<details>
<summary>Очікувана відповідь</summary>
<br>

~~~md

~~~
</details>
:::


## Пов'язані запити

[[20801] Отримання даних довідника](https://hackmd.io/Xndoh9TxRPSMk1V1pPhXUQ)
[[20802] Отримання даних заборгованості](https://hackmd.io/fkcB0yBhTuKW7SEYbCV0zw)
[[10108] Погашення заборгованості](https://hackmd.io/f8cr3qN-QU27s2pAyU39bQ)


## Довідкові матеріали 

Опис загальних параметрів системи XPAY див. у розділі ["Довідкові матеріали"](https://hackmd.io/aBE7H5cfQ-iqaN3SnwaQ-w): коди типів операцій, типи платіжних методів, коди статусів обробки операцій, відомості та помилки, що повертаються у відповіді та ін.


## Cлужба підтримки XPAY
<details>
<summary>Контакти</summary>
</br>

Телефон: +38 (096) 099 20 59
email: info@xpay.com.ua
Telegram: @xpaysupportbot
</details>
</br>

:::info
**Навігація по API:**

:bookmark_tabs: [XPAY API Зміст](/Mj2ZqCVpSq6A6Jzm6ladlw)
:arrow_left: [Загальна інформація по підключенню (API)](https://hackmd.io/g3cItPVFStez0ql3Xj-2TA)

<details>
<summary>Служба підтримки XPAY</summary>
</br>

Телефон: +38 093 891 92 00
Email: info@xpay.com.ua
Telegram: @xpaysupportbot
</details>