You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 13 Next »


Схема взаємодії Клієнта з Серверами черги

Схема взаимодействия Copy
 

Загальна інформація щодо роботи із запитами

Всі запити мають бути у форматі POST. Content-type:application/json

Запити:



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

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

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

Метод

'POST'

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

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

  • authToken (Guid): Токен аутентифікації, який підтверджує, що користувач має право доступу до API.
  • languageId (int): Ідентифікатор мови, якою користувач хоче отримати дані.

 Тіло запиту

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

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

 {
    "OrganisationList": [
        {
            "OrgTypeId": 1,
            "OrgTypeDescription": "ТОВАРИСТВО З ОБМЕЖЕНОЮ ВІДПОВІДАЛЬНІСТЮ",
            "Code": 240,
            "LocationId": 1,
            "GeoInfo": {
                "CityId": 47,
                "City": "Первомайське",
                "RegionId": 1,
                "Region": "АР Крим",
                "CountryId": 1,
                "Country": "Україна",
                "Address": "ул. Пушкина"
            },
            "OrganisationId": 1,
            "OrganisationName": "test"
        },
        {
            "OrgTypeId": 1,
            "OrgTypeDescription": "ТОВАРИСТВО З ОБМЕЖЕНОЮ ВІДПОВІДАЛЬНІСТЮ",
            "Code": 240,
            "LocationId": 1,
            "GeoInfo": {
                "CityId": 47,
                "City": "Первомайське",
                "RegionId": 1,
                "Region": "АР Крим",
                "CountryId": 1,
                "Country": "Україна",
                "Address": "ул. Пушкина"
            },
            "OrganisationId": 2,
            "OrganisationName": "Volia"
        }
    ],
    "ReturnInfo": {
        "ReturnCode": 0,
        "ReturnSubcode": 0,
        "ReturnMessage": "OK"
    }
}

 Опис полів

ВластивістьТип данихОбов'язковістьОпис
OrganisationIdint
ID організації
OrganisationNamestring
Назва організації
OrgTypeIdint
ID типу організації
OrgTypeDescriptionstring
Назва типу організації
Codeint
Код організації
LocationIdint
ID локації
GeoInfo.CityIdint
ID міста
GeoInfo.Citystring
Назва міста
GeoInfo.RegionIdint
ID региона (области)
GeoInfo.Regionstring
ID регіону (області)
GeoInfo.CountryIdint
ID країни
GeoInfo.Countrystring
Назва країни
GeoInfo.Addressstring
Адреса організації
ReturnInfoОбъект ReturnInfo
Інформація про результати виконання

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

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

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

URL

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

Метод

POST

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

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

  • authToken (Guid): Токен аутентифікації, який підтверджує, що користувач має право доступу до API.
  • organisationId (int): Ідентифікатор організації.
  • languageId (int): Ідентифікатор мови, якою користувач хоче отримати дані.

Тіло Запиту 

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

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

 {
    "ServiceCenterList": [
        {
            "ServiceCenterId": 1,
            "ServiceCenterName": "ЦНАП м. Києва",
            "GeoInfo": {
                "CityId": 472,
                "City": "Київ",
                "RegionId": 11,
                "Region": "Київ",
                "CountryId": 1,
                "Country": "Україна",
                "Address": "вул. Дніпровська набережна, 19-Б"
            },
            "OrganisationId": 3,
            "RegistrationDaysLimit": 60,
            "Sop": "2024-01-25T00:00:00"
        },
        {
            "ServiceCenterId": 2,
            "ServiceCenterName": "ЦНАП Подільської РДА",
            "GeoInfo": {
                "CityId": 472,
                "City": "Київ",
                "RegionId": 11,
                "Region": "Київ",
                "CountryId": 1,
                "Country": "Україна",
                "Address": "вул. Костянтинівська, 9/6"
            },
            "OrganisationId": 2,
            "RegistrationDaysLimit": 30,
            "Sop": "2024-01-25T00:00:00"
        }
    ],
    "ReturnInfo": {
        "ReturnCode": 0,
        "ReturnSubcode": 0,
        "ReturnMessage": "OK"
    }
}

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


ВластивістьТип данихОбов'язковістьОпис
ServiceCenterIdint ID сервісного центру
ServiceCenterNamestring
Назва сервісного центру
OrganisationIdint
ID організації
RegistrationDaysLimitint
Ліміт кількості днів для попередньої реєстрації
Sopdatetime
Дата, з якої дозволена попередня реєстрація
GeoInfo.CityIdint
ID міста
GeoInfo.Citystring
Назва міста
GeoInfo.RegionIdint
ID регіону (області)
GeoInfo.Regionstring
Назва регіону (області)
GeoInfo.CountryIdint
ID країни
GeoInfo.Countrystring
Назва країни
GeoInfo.Addressstring
Адреса організації
ReturnInfoоб'єкт ReturnInfo
Інформація про результати виконання
ReturnInfo.ReturnCodeint
Код результату
ReturnInfo.ReturnSubcodeint
Підкод результату
ReturnInfo.ReturnMessagestring
Повідомлення про результат

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

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

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

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

Метод

POST

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

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

  • authToken (Guid): Токен аутентифікації, який підтверджує, що користувач має право доступу до API.
  • languageId (int): Ідентифікатор мови, якою користувач хоче отримати дані.

Тіло запиту

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

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

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

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

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

{
    "CityList": [
        {
            "CityId": 404,
            "City": "Івано-Франківськ",
            "RegionId": 9,
            "Region": "Івано-Франківська область",
            "CountryId": 1,
            "Country": "Україна",
            "Address": ""
        },
        {
            "CityId": 349,
            "City": "Ужгород",
            "RegionId": 7,
            "Region": "Закарпатська область",
            "CountryId": 1,
            "Country": "Україна",
            "Address": ""
        }
    ],
    "ReturnInfo": {
        "ReturnCode": 0,
        "ReturnSubcode": 0,
        "ReturnMessage": "OK"
    }
}

Опис полів відповіді
ВластивістьТип данихОпис
CityIdintID міста
CitystringНазва міста
RegionIdintID регіону (області)
RegionstringНазва регіону (області)
CountryIdintID країни
CountrystringНазва країни
AddressstringАдреса організації
ReturnInfoоб'єкт ReturnInfoІнформація про результати виконання
ReturnInfo.ReturnCodeintКод результату
ReturnInfo.ReturnSubcodeintПідкод результату
ReturnInfo.ReturnMessagestringПовідомлення про результат

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

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

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

Метод

POST

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

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

  • authToken (Guid): Токен аутентифікації, який підтверджує, що користувач має право доступу до API.
  • cityId (int): Ідентифікатор міста.
  • languageId (int): Ідентифікатор мови, якою користувач хоче отримати дані.

Тіло запиту

{
    "authToken": "11111111-abcd-dead-beef-0123456789",
    "cityId": 549,
    "languageId": "1"
}


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

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


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

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

{
    "OrganisationList": [
        {
            "OrgTypeId": 31,
            "OrgTypeDescription": "ДЕРЖАВНА ОРГАНІЗАЦІЯ (УСТАНОВА, ЗАКЛАД)",
            "Code": 425,
            "LocationId": 1,
            "GeoInfo": {
                "CityId": 549,
                "City": "Буськ",
                "RegionId": 14,
                "Region": "Львівська область",
                "CountryId": 1,
                "Country": "Україна",
                "Address": ""
            },
            "OrganisationId": 9,
            "OrganisationName": "Державна реєстрація актів цивільного стану"
        }
    ],
    "ReturnInfo": {
        "ReturnCode": 0,
        "ReturnSubcode": 0,
        "ReturnMessage": "OK"
    }
}

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

ВластивістьТип данихОпис
OrganisationIdintID організації
OrganisationNamestringНазва організації
OrgTypeIdintID типу організації
OrgTypeDescriptionstringНазва типу організації
CodeintКод організації
LocationIdintID локації
GeoInfo.CityIdintID міста
GeoInfo.CitystringНазва міста
GeoInfo.RegionIdintID регіону (області)
GeoInfo.RegionstringНазва регіону (області)
GeoInfo.CountryIdintID країни
GeoInfo.CountrystringНазва країни
GeoInfo.AddressstringАдреса організації
ReturnInfoоб'єкт ReturnInfoІнформація про результати виконання
ReturnInfo.ReturnCodeintКод результату
ReturnInfo.ReturnSubcodeintПідкод результату
ReturnInfo.ReturnMessagestringПовідомлення про результат

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

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

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

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

Метод

POST

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

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

  • authToken (Guid): Токен аутентифікації, який підтверджує, що користувач має право доступу до API.
  • organisationId (int): Ідентифікатор організації.
  • cityId (int): Ідентифікатор міста.
  • languageId (int): Ідентифікатор мови, якою користувач хоче отримати дані.

Тіло запиту

{
    "authToken": "11111111-abcd-dead-beef-0123456789",
    "organisationId": 9,
    "cityId": 549,
    "languageId": "1"
}

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

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

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

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

{
    "ServiceCenterList": [
        {
            "ServiceCenterId": 37,
            "ServiceCenterName": "Буський міський відділ ДРАЦ",
            "GeoInfo": {
                "CityId": 549,
                "City": "Буськ",
                "RegionId": 14,
                "Region": "Львівська область",
                "CountryId": 1,
                "Country": "Україна",
                "Address": "вул. Петрушевича, 12"
            },
            "OrganisationId": 9,
            "RegistrationDaysLimit": 30,
            "Sop": "2024-01-26T00:00:00"
        }
    ],
    "ReturnInfo": {
        "ReturnCode": 0,
        "ReturnSubcode": 0,
        "ReturnMessage": "OK"
    }
}

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

ВластивістьТип данихОпис
ServiceCenterIdintID сервісного центру
ServiceCenterNamestringНазва сервісного центру
OrganisationIdintID організації
RegistrationDaysLimitintЛіміт кількості днів для попередньої реєстрації
SopdatetimeДата, з якої дозволена попередня реєстрація
GeoInfo.CityIdintID міста
GeoInfo.CitystringНазва міста
GeoInfo.RegionIdintID регіону (області)
GeoInfo.RegionstringНазва регіону (області)
GeoInfo.CountryIdintID країни
GeoInfo.CountrystringНазва країни
GeoInfo.AddressstringАдреса організації
ReturnInfoоб'єкт ReturnInfoІнформація про результати виконання
ReturnInfo.ReturnCodeintКод результату
ReturnInfo.ReturnSubcodeintПідкод результату
ReturnInfo.ReturnMessagestringПовідомлення про результат

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

Опис запиту 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"
    }
}


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

ВластивістьТип данихОпис
ServiceCenterIdintID сервісного центру
ServiceCenterNamestringНазва сервісного центру
OrganisationIdintID організації
OrganisationNamestringНазва організації
ReturnInfoоб'єкт ReturnInfoІнформація про результати виконання
ReturnInfo.ReturnCodeintКод результату
ReturnInfo.ReturnSubcodeintПідкод результату
ReturnInfo.ReturnMessagestringПовідомлення про результат

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

serviceIdfromtoЛогіка
Nyyyy-MM-dd hh:mmyyyy-MM-dd hh:mmПовертає всі СЦ, де доступна попередня реєстрація послуги N в інтервалі from ... to
NNULLyyyy-MM-dd hh:mmПовертає всі СЦ, де доступна попередня реєстрація послуги N в інтервалі yyyy-MM-dd ... to
Nyyyy-MM-dd hh:mmNULLПовертає всі СЦ, де доступна попередня реєстрація послуги N в інтервалі from ... yyyy-MM-dd 23:59:59
NNULLNULLПовертає всі СЦ, де доступна попередня реєстрація послуги N протягом завтрашнього дня
NULLyyyy-MM-dd hh:mmyyyy-MM-dd hh:mmПовертає всі СЦ, де доступна попередня реєстрація в інтервалі from ... to
NULLNULLyyyy-MM-dd hh:mmПовертає всі СЦ, де доступна попередня реєстрація в інтервалі yyyy-MM-dd ... to
NULLyyyy-MM-dd hh:mmNULLПовертає всі СЦ, де доступна попередня реєстрація в інтервалі from ... yyyy-MM-dd 23:59:59
NULLNULLNULLПовертає всі СЦ, де доступна попередня реєстрація протягом завтрашнього дня

Якщо є додаткові питання або потрібна допомога з іншими запитами, дай

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

Опис запиту 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"
    }
}

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

ВластивістьТип данихОпис
GroupIdintID групи
ParentGroupIdintID батьківської групи
DescriptionstringОпис групи
OrderWeightintВаговий коефіцієнт для сортування
ReturnInfoоб'єкт ReturnInfoІнформація про результати виконання
ReturnInfo.ReturnCodeintКод результату
ReturnInfo.ReturnSubcodeintПідкод результату
ReturnInfo.ReturnMessagestringПовідомлення про результат

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

Опис запиту 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"
    }
}

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

ВластивістьТип данихОпис
GroupIdintID групи
ParentGroupIdintID батьківської групи
DescriptionstringОпис групи
OrderWeightintВаговий коефіцієнт для сортування
ReturnInfoоб'єкт ReturnInfoІнформація про результати виконання
ReturnInfo.ReturnCodeintКод результату
ReturnInfo.ReturnSubcodeintПідкод результату
ReturnInfo.ReturnMessagestringПовідомлення про результат

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

Опис запиту 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"
    }
}

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

ВластивістьТип данихОпис
ServiceIdintID послуги
GroupIdintID групи, до якої належить послуга
DescriptionstringОпис послуги
OrderWeightintВаговий коефіцієнт для сортування
ReturnInfoоб'єкт ReturnInfoІнформація про результати виконання
ReturnInfo.ReturnCodeintКод результату
ReturnInfo.ReturnSubcodeintПідкод результату
ReturnInfo.ReturnMessagestringПовідомлення про результат

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

Опис запиту 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"
    }
}


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

ВластивістьТип данихОпис
ServiceIdintID послуги
GroupIdintID групи, до якої належить послуга
DescriptionstringОпис послуги
OrderWeightintВаговий коефіцієнт для сортування
ReturnInfoоб'єкт ReturnInfoІнформація про результати виконання
ReturnInfo.ReturnCodeintКод результату
ReturnInfo.ReturnSubcodeintПідкод результату
ReturnInfo.ReturnMessagestringПовідомлення про результат

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

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

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

URL 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"
    }
}


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

ВластивістьТип данихОпис
OrganisationIdintID організації
ServiceCenterIdintID сервісного центру
ServiceIdintID послуги
UniqueServiceIdintУнікальний ID послуги
ServiceNamestringНазва послуги
ServiceTypeIdint[]Перелік ID типів послуг
ReturnInfoоб'єкт ReturnInfoІнформація про результати виконання
ReturnInfo.ReturnCodeintКод результату
ReturnInfo.ReturnSubcodeintПідкод результату
ReturnInfo.ReturnMessagestringПовідомлення про результат

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

Сервісний ЦентрfromtoЛогіка
Nyyyy-MM-dd hh:mmyyyy-MM-dd hh:mmПовертає всі послуги для СЦ N, доступні для реєстрації в інтервалі from ... to
NNULLyyyy-MM-dd hh:mmПовертає всі послуги для СЦ N, доступні для реєстрації в інтервалі yyyy-MM-dd ... to
Nyyyy-MM-dd hh:mmNULLПовертає всі послуги для СЦ N, доступні для реєстрації в інтервалі from ... yyyy-MM-dd 23:59:59
NNULLNULLПовертає всі послуги для СЦ N, доступні для реєстрації на протязі завтрашнього дня
NULLyyyy-MM-dd hh:mmyyyy-MM-dd hh:mmПовертає всі послуги для всіх СЦ, на які підписаний клієнт, доступні для реєстрації в інтервалі from ... to
NULLNULLyyyy-MM-dd hh:mmПовертає всі послуги для всіх СЦ, на які підписаний клієнт, доступні для реєстрації в інтервалі yyyy-MM-dd ... to
NULLyyyy-MM-dd hh:mmNULLПовертає всі послуги для всіх СЦ, на які підписаний клієнт, доступні для реєстрації в інтервалі from ... yyyy-MM-dd 23:59:59
NULLNULLNULLПовертає всі послуги для всіх СЦ, на які підписаний клієнт, доступні для реєстрації на протязі завтрашнього дня

Примітка

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

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




  • No labels