Page History

Опис запиту GetServiceCentersByService()

Цей запит використовується для отримання списку сервісних центрів, які надають вказану послугу в заданому часовому інтервалі.

URL https://{HOST}/api/servicehub/GetServiceCentersByService

Метод

POST

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

Запит має включати тіло з п'яти параметрами:

• authToken (Guid): Токен аутентифікації, який підтверджує, що користувач має право доступу до API.
• serviceId (int): Ідентифікатор послуги.
• serviceTypeId (array of int): Масив ідентифікаторів типів послуг.
• from (datetime): Початкова дата і час.
• to (datetime): Кінцева дата і час.
• languageId (int): Ідентифікатор мови, якою користувач хоче отримати дані.

Примітка: from та to повинні бути в межах одного дня і не можуть бути меншими за поточний час.

Тіло запиту

{
    "authToken": "11111111-abcd-dead-beef-0123456789",
    "serviceId": 220,
    "serviceTypeId": [1],
    "from": "2024-01-26T00:00:00",
    "to": "2024-01-26T12:00:00",
    "languageId": 1
}

Приклад запиту з використанням curl

curl -X POST https://{HOST}/api/servicehub/GetServiceCentersByService \
    -H "Content-Type: application/json" \
    -d '{
        "authToken": "11111111-abcd-dead-beef-0123456789",
        "serviceId": 220,
        "serviceTypeId": [1],
        "from": "2024-01-26T00:00:00",
        "to": "2024-01-26T12:00:00",
        "languageId": 1
    }'

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

Успішна відповідь поверне JSON об'єкт зі списком сервісних центрів та інформацією про результат виконання. Приклад структури відповіді:

{
    "ServiceCenterList": [
        {
            "ServiceCenterId": 37,
            "ServiceCenterName": "Буський міський відділ ДРАЦ",
            "OrganisationId": 9,
            "OrganisationName": "Будинок Нерухомості"
        }
    ],
    "ReturnInfo": {
        "ReturnCode": 0,
        "ReturnSubcode": 0,
        "ReturnMessage": "OK"
    }
}

Опис полів відповіді

Логіка обробки запиту

Вміст параметрів serviceId, from, і to:

• N (serviceId) та from, to (datetime): Повертає всі СЦ, де доступна попередня реєстрація послуги N в інтервалі від from до to.
• N (serviceId) та NULL (from), to (datetime): Повертає всі СЦ, де доступна попередня реєстрація послуги N в інтервалі від початку дня до to.
• N (serviceId) та from (datetime), NULL (to): Повертає всі СЦ, де доступна попередня реєстрація послуги N в інтервалі від from до кінця дня.
• N (serviceId) та NULL (from, to): Повертає всі СЦ, де доступна попередня реєстрація послуги N на протязі наступного дня.
• NULL (serviceId) та from, to (datetime): Повертає всі СЦ, де доступна попередня реєстрація в інтервалі від from до to.
• NULL (serviceId) та NULL (from), to (datetime): Повертає всі СЦ, де доступна попередня реєстрація в інтервалі від початку дня до to.
• NULL (serviceId) та from (datetime), NULL (to): Повертає всі СЦ, де доступна попередня реєстрація в інтервалі від from до кінця дня.
• NULL (serviceId) та NULL (from, to): Повертає всі СЦ, де доступна попередня реєстрація на протязі наступного дня.

Опис запиту GetAllGroups()

Цей запит отримує список всіх груп послуг для вказаного сервісного центру і організації.

URL https://{HOST}/api/servicehub/GetAllGroups

Метод

POST

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

Запит має включати тіло з чотирьох параметрів:

• authToken (Guid): Токен аутентифікації.
• organisationId (int): Ідентифікатор організації.
• serviceCenterId (int): Ідентифікатор сервісного центру.
• languageId (int): Ідентифікатор мови.

Тіло запиту

{
    "authToken": "11111111-abcd-dead-beef-0123456789",
    "organisationId": 2,
    "serviceCenterId": 1,
    "languageId": 1
}

Приклад запиту з використанням curl

curl -X POST https://{HOST}/api/servicehub/GetAllGroups \
    -H "Content-Type: application/json" \
    -d '{
        "authToken": "11111111-abcd-dead-beef-0123456789",
        "organisationId": 2,
        "serviceCenterId": 1,
        "languageId": 1
    }'

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

Успішна відповідь поверне JSON об'єкт зі списком груп послуг та інформацією про результат виконання. Приклад структури відповіді:

{
    "GroupList": [
        {
            "GroupId": 204,
            "ParentGroupId": 0,
            "Description": "ID картка та закордонний паспорт",
            "OrderWeight": 4
        },
        {
            "GroupId": 230,
            "ParentGroupId": 0,
            "Description": "Отримати готовий документ",
            "OrderWeight": 902
        }
    ],
    "ReturnInfo": {
        "ReturnCode": 0,
        "ReturnSubcode": 0,
        "ReturnMessage": "OK"
    }
}

Опис полів відповіді

Опис запиту GetGroupsByParentId()

Цей запит повертає список груп послуг для вказаної батьківської групи.

URL https://{HOST}/api/servicehub/GetGroupsByParentId

Метод

POST

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

Запит має включати тіло з п'яти параметрами:

• authToken (Guid): Токен аутентифікації.
• organisationId (int): Ідентифікатор організації.
• serviceCenterId (int): Ідентифікатор сервісного центру.
• parentGroupId (int): Ідентифікатор батьківської групи.
• languageId (int): Ідентифікатор мови.

Тіло запиту

{
    "authToken": "11111111-abcd-dead-beef-0123456789",
    "organisationId": 2,
    "serviceCenterId": 1,
    "parentGroupId": 0,
    "languageId": 1
}

Приклад запиту з використанням curl

curl -X POST https://{HOST}/api/servicehub/GetGroupsByParentId \
    -H "Content-Type: application/json" \
    -d '{
        "authToken": "11111111-abcd-dead-beef-0123456789",
        "organisationId": 2,
        "serviceCenterId": 1,
        "parentGroupId": 0,
        "languageId": 1
    }'

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

Успішна відповідь поверне JSON об'єкт зі списком груп послуг та інформацією про результат виконання. Приклад структури відповіді:

{
    "GroupList": [
        {
            "GroupId": 204,
            "ParentGroupId": 0,
            "Description": "ID картка та закордонний паспорт",
            "OrderWeight": 4
        },
        {
            "GroupId": 230,
            "ParentGroupId": 0,
            "Description": "Отримати готовий документ",
            "OrderWeight": 902
        }
    ],
    "ReturnInfo": {
        "ReturnCode": 0,
        "ReturnSubcode": 0,
        "ReturnMessage": "OK"
    }
}

Опис полів відповіді

Опис запиту GetAllServices()

Цей запит отримує список всіх послуг для вказаного сервісного центру і організації.

URL https://{HOST}/api/servicehub/GetAllServices

Метод

POST

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

Запит має включати тіло з чотирьох параметрів:

• authToken (Guid): Токен аутентифікації.
• organisationId (int): Ідентифікатор організації.
• serviceCenterId (int): Ідентифікатор сервісного центру.
• languageId (int): Ідентифікатор мови.

Тіло запиту

{
    "authToken": "11111111-abcd-dead-beef-0123456789",
    "organisationId": 2,
    "serviceCenterId": 1,
    "languageId": 1
}

Приклад запиту з використанням curl

curl -X POST https://{HOST}/api/servicehub/GetAllServices \
    -H "Content-Type: application/json" \
    -d '{
        "authToken": "11111111-abcd-dead-beef-0123456789",
        "organisationId": 2,
        "serviceCenterId": 1,
        "languageId": 1
    }'

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

Успішна відповідь поверне JSON об'єкт зі списком послуг та інформацією про результат виконання. Приклад структури відповіді:

{
    "ServiceList": [
        {
            "ServiceId": 870,
            "GroupId": 204,
            "Description": "Подати документи щодо оформлення ID картки та закордонного паспортa",
            "OrderWeight": 835
        },
        {
            "ServiceId": 872,
            "GroupId": 0,
            "Description": "Отримати готовий документ (крім id картки та закордонного паспорту)",
            "OrderWeight": 837
        }
    ],
    "ReturnInfo": {
        "ReturnCode": 0,
        "ReturnSubcode": 0,
        "ReturnMessage": "OK"
    }
}

Опис полів відповіді

Опис запиту GetServicesByGroupId()

Цей запит отримує список послуг для вказаної групи послуг.

URL https://{HOST}/api/servicehub/GetServicesByGroupId

Метод

POST

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

Запит має включати тіло з чотирьох параметрів:

• authToken (Guid): Токен аутентифікації.
• organisationId (int): Ідентифікатор організації.
• serviceCenterId (int): Ідентифікатор сервісного центру.
• groupId (int): Ідентифікатор групи послуг.
• languageId (int): Ідентифікатор мови.

Тіло запиту

{
    "authToken": "11111111-abcd-dead-beef-0123456789",
    "organisationId": 2,
    "serviceCenterId": 1,
    "groupId": 204,
    "languageId": 1
}

Приклад запиту з використанням curl

curl -X POST https://{HOST}/api/servicehub/GetServicesByGroupId \
    -H "Content-Type: application/json" \
    -d '{
        "authToken": "11111111-abcd-dead-beef-0123456789",
        "organisationId": 2,
        "serviceCenterId": 1,
        "groupId": 204,
        "languageId": 1
    }'

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

Успішна відповідь поверне JSON об'єкт зі списком послуг та інформацією про результат виконання. Приклад структури відповіді:

{
    "ServiceList": [
        {
            "ServiceId": 870,
            "GroupId": 204,
            "Description": "Подати документи щодо оформлення ID картки та закордонного паспортa",
            "OrderWeight": 835
        }
    ],
    "ReturnInfo": {
        "ReturnCode": 0,
        "ReturnSubcode": 0,
        "ReturnMessage": "OK"
    }
}

Опис полів відповіді

Опис запиту GetServicesByServiceCenter()

Цей запит отримує перелік послуг, які надаються вказаним сервісним центром/центрами.

URL

plaintext

https://{HOST}/api/servicehub/GetServicesByServiceCenter

Метод

POST

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

Запит має включати тіло з п'яти параметрів:

• authToken (Guid): Токен аутентифікації.
• serviceCenterId (int): Ідентифікатор сервісного центру.
• serviceTypeId (int[]): Перелік ідентифікаторів типів послуг.
• from (datetime): Початкова дата.
• to (datetime): Кінцева дата.
• languageId (int): Ідентифікатор мови.

Тіло запиту

{
    "authToken": "11111111-abcd-dead-beef-0123456789",
    "serviceCenterId": 1,
    "serviceTypeId": [1, 2],
    "from": "2024-07-15 00:00:00",
    "to": "2024-07-20 00:00:00",
    "languageId": 1
}

Приклад запиту з використанням curl

curl -X POST https://{HOST}/api/servicehub/GetServicesByServiceCenter \
    -H "Content-Type: application/json" \
    -d '{
        "authToken": "11111111-abcd-dead-beef-0123456789",
        "serviceCenterId": 1,
        "serviceTypeId": [1, 2],
        "from": "2024-07-15 00:00:00",
        "to": "2024-07-20 00:00:00",
        "languageId": 1
    }'

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

Успішна відповідь поверне JSON об'єкт зі списком послуг та інформацією про результат виконання. Приклад структури відповіді:

{
    "ServiceList": [
        {
            "OrganisationId": 1,
            "ServiceCenterId": 1,
            "ServiceId": 8,
            "UniqueServiceId": 1358,
            "ServiceName": "замена паспорта",
            "ServiceTypeId": [1, 2]
        },
        {
            "OrganisationId": 2,
            "ServiceCenterId": 5,
            "ServiceId": 68,
            "UniqueServiceId": 336,
            "ServiceName": "ееееемалятко",
            "ServiceTypeId": [1, 2]
        }
    ],
    "ReturnInfo": {
        "ReturnCode": 0,
        "ReturnSubcode": 0,
        "ReturnMessage": "OK"
    }
}

Опис полів відповіді

Логіка обробки запиту