Описание процесса предварительной записи

Для совершения конечной цели – записи в МФЦ и получения талона необходимо последовательно вызвать ряд методов, которые позволят получить данные (ids – идентификатор подразделения, tipw – тип окна, data – дата, на которую записываемся, time – время, на которое записываемся и idUsl – идентификатор группы услуг, на которую мы записываемся), необходимые для вызова метода получения талона.

1) Необходимо вызвать метод для получения списка групп услуг (параметр idUsl). Важно – нас интересуют только те группы услуг, которые по иерархии находятся в самом низу структуры. Выбрав нужную группу услуг, переходим к п. 2. Используем метод «Дерево групп услуг» (/rest-api/service/gr-usl-tree).

2) Далее получаем список типов окон, доступных для записи и подразделения, в которых они доступны (параметр ids). Выбираем тип окна (tipw) и по нему отсеиваем подразделения для дальнейшей выборки. Используем метод «Список окон приёма и типов окон для записи в ЭО» (/rest-api/que/available-groups).

3) На этом этапе, зная идентификатор (ids) можно вызвать метод для вывода списка с названиями и адресами подразделений, ранее отсеянных по типу доступных окон. Выбрав нужное подразделение переходим к п. 4. Используем метод «Список подразделений» (/rest-api/subdivision/list).

4) Зная параметр ids можно вызвать метод для получения списка группы окон с их типами, которые доступны в указанном по этому параметру подразделении. Если в данном подразделении есть соответствующий тип окна (tipw) и группа услуг (idUsl), выбранная ещё в п. 1, то можно переходить к п. 5. Используем метод «Предварительная запись (Список групп услуг)» (/rest-api/record/service).

5) На этом пункте необходимо вызвать метод для получения доступных для выбранного ранее подразделения ближайших дат для записи. Если метод вернул даты и время, то выбрав необходимое значение можно переходить к п.6. Используем метод «Предварительная запись (выборка дат и времён)» (/rest-api/record/getdatetime).

6) Необходимо вызвать метод для предварительной записи, заполнив необходимые параметры, указав помимо ids, tipw, idUsl, также ФИО, СНИЛС или телефон (желательно указывать хотя бы ещё один параметр кроме ФИО для точной идентификации). Если запись прошла успешно, то метод вернёт информацию номером талона. Используем метод «Предварительная запись. Получение талона» (/rest-api/record/preliminary).

Также существует метод для удаления ранее записанного талона по его идентификатору записи и ФИО заявителя (метода «Талоны (список)» (/rest-api/ticket/list)). Кроме того есть метод для просмотра всех талонов заявителя (метод «Талоны (удалить талон)» (/rest-api/ticket/del)).

API Методы

Во всех методах api используется тип авторизации Basic Auth. Логин и пароль можно получить, обратившись к специалистам тех. поддержки, адрес_портала – demo-portal.azovkomeks.ru

Дерево групп услуг

Описание: метод вернёт список групп услуг сохраняя иерархию вложенности групп.

Адрес запроса: http://адрес_портала/rest-api/service/gr-usl-tree

Метод GET

Параметры запроса: без параметров.

Параметры ответа:

Успешный ответ

Параметр	Тип	Описание	Пример
	json object (объект)	Информация по одной группе услуг
id	int	Идентификатор группы услуг	195
naz	string	Название группы услуг	«Поддержка малоимущих»
idp	int	Идентификатор родительской группы услуг	41
npp	int	Порядковый номер	1

[
    {
        "id": 18,
        "naz": "ТЕСТОВАЯ ГРУППА",
        "idp": null,
        "npp": 0
    },
    {
        "id": 20,
        "naz": "Росреестр",
        "idp": null,
        "npp": 1
    }
]

Ответ, содержащий ошибки

Параметр	Тип	Описание	Пример
name	string
message	string	Текст ошибки	«Запись на этот вид услуги только в МФЦ!»

{
    "name": "Not found",
    "message": "Запись на этот вид услуги только в МФЦ! "
}

Список подразделений

Описание: метод вернёт информацию по каждому подразделению.

Адрес запроса: http://адрес_портала/rest-api/subdivision/list

Метод GET

Параметры запроса: без параметров.

Параметры ответа:

Успешный ответ

Параметр	Тип	Описание	Пример
response	json object (объект)	Результат
withoutParams	json object (объект)	Результат
main	json object (объект)	Информация о главном подразделении (в него не производится предзапись и нет ids)
podr	json object (массив)	Массив, содержащий информацию о всех подчинённых главному подразделениях
	json object (объект)	Информация о подразделении МФЦ
-//-	-//-	-//-	-//-
ids	int	Идентификатор подразделения	1
struct_naz	string	Название подразделения	«Отделение ГУ «МФЦ ДЕМО Центральный»
adr	string	Адрес подразделения МФЦ	«346780, Ростовская обл, г Азов, ул Московская, д. 11»
-//-	-//-	-//-	-//-

{
    "response": {
        "withoutParams": {
            "main": {
                "fioruk": "СЕДЫХ ВИТАЛИЙ ИГОРЕВИЧ",
                "tel": "",
                "email": "",
                "naz": "Главный офис",
                "naz_s": "Главный офис",
                "struct_naz": null,
                "struct_naz_s": null,
                "adr": "664002, Иркутская обл, г Иркутск, ул Мира, д. 2б",
                "ids": "",
                "tags": [],
                "urlisp": "",
                "lev": "",
                "population": "2 121 322",
                "map": null,
                "window": [],
                "info": {
                    "dat_open": null,
                    "total_area": null,
                    "waiting_area": null,
                    "area_cons_recept": null,
                    "usl_count": 0
                },
                "win_schema": "",
                "deactive": "",
                "inschema": "",
                "queue": "",
                "service": {
                    "federal": null,
                    "regional": null,
                    "municipal": null,
                    "other": null
                },
                "code_mkgu": null,
                "additional_information": ""
            },
            "podr": [
                {
                    "fioruk": "СЕДЫХ ВИТАЛИЙ ИГОРЕВИЧ",
                    "tel": "",
                    "email": "",
                    "naz": "УМФЦ",
                    "naz_s": "УМФЦ",
                    "struct_naz": "УМФЦ                                                                                                ",
                    "struct_naz_s": "УМФЦ ",
                    "adr": "344003, Ростовская обл, г Ростов-на-Дону, пр-кт Ворошиловский,  101",
                    "ids": "19",
                    "tags": [],
                    "urlisp": "",
                    "lev": "2",
                    "population": "2 121 322",
                    "map": null,
                    "window": [
                        {
                            "name": "Выдача документов",
                            "kol": null
                        },
                        {
                            "name": "Прием документов",
                            "kol": null
                        },
                        {
                            "name": "Консультация",
                            "kol": null
                        }
                    ],
                    "info": {
                        "dat_open": null,
                        "total_area": null,
                        "waiting_area": null,
                        "area_cons_recept": null,
                        "usl_count": 0
                    },
                    "win_schema": "",
                    "deactive": "0",
                    "inschema": "0",
                    "queue": "",
                    "service": {
                        "federal": null,
                        "regional": null,
                        "municipal": null,
                        "other": null
                    },
                    "code_mkgu": "",
                    "additional_information": ""
                },
                {
                    "fioruk": "СЕДЫХ ВИТАЛИЙ ИГОРЕВИЧ",
                    "tel": "",
                    "email": "",
                    "naz": "Отделение ГУ «МФЦ ДЕМО Центральный»",
                    "naz_s": "Отделение ГУ «МФЦ ДЕМО Центральный»",
                    "struct_naz": "Отделение ГУ «МФЦ ДЕМО Центральный»                                                    ",
                    "struct_naz_s": "Отделение ГУ «МФЦ ДЕМО Центральный»",
                    "adr": "346780, Ростовская обл, г Азов, ул Московская, д. 11",
                    "ids": "1",
                    "tags": [],
                    "urlisp": "",
                    "lev": "2",
                    "population": "2 121 322",
                    "map": null,
                    "window": [
                        { "name": "Выдача документов",
                            "kol": null
                        },
                        {
                            "name": "Прием документов",
                            "kol": null
                        },
                        {
                            "name": "Консультация",
                            "kol": null
                        }
                    ],
                    "info": {
                        "dat_open": null,
                        "total_area": null,
                        "waiting_area": null,
                        "area_cons_recept": null,
                        "usl_count": 0
                    },
                    "win_schema": "",
                    "deactive": "0",
                    "inschema": "0",
                    "queue": "1",
                    "service": {
                        "federal": null,
                        "regional": null,
                        "municipal": null,
                        "other": null
                    },
                    "code_mkgu": "",
                    "additional_information": ""
                }
            ]
        }
    }
}

Ответ, содержащий ошибки

Параметр	Тип	Описание	Пример
name	string
message	string	Текст ошибки	«Неверный синтаксис»

{
    "name": "Not found",
    "message": "Неверный синтаксис"
}

Список окон приёма и типов окон для записи в ЭО

Описание: метод вернёт список типов окон приёма для в каждом подразделении.

Адрес запроса: http://адрес_портала /rest-api/que/available-groups

Метод GET

Параметры запроса: без параметров.

Параметры ответа:

Успешный ответ

Параметр	Тип	Описание	Пример
response	json object (объект)	Результат
office	json object (массив)	Список подразделений МФЦ с доступными в них типами окон
	json object (объект)	Офис МФЦ
grw	json object (массив)	Массив типов окон в подразделении МФЦ
	json object (объект)	Описание типа окна
name	string	Название типа окна	«Консультация»
tipw	int	Идентификатор типа окна	1
ids	int	Идентификатор подразделения МФЦ	1

{
    "response": {
        "office": [
            {
                "grw": [
                    {
                        "name": "консультации",
                        "tipw": 1
                    },
                    {
                        "name": "операционисты",
                        "tipw": 2
                    },
                    {
                        "name": "окна выдачи",
                        "tipw": 6
                    }
                ],
                "ids": 1
            }
        ]
    }
}

Ответ, содержащий ошибки

Параметр	Тип	Описание	Пример
name	string
message	string	Текст ошибки	«Неверный синтаксис»

{
    "name": "Not found",
    "message": "Неверный синтаксис"
}

Предварительная запись (Список групп услуг)

Описание: метод вернёт список групп услуг в конкретном подразделении с разбивкой по группам окон.

Адрес запроса: http://адрес_портала/rest-api/record/service

Метод GET

Параметры запроса:

Параметр	Тип	Обязательный	Описание	Пример
ids	int	Да	Идентификатор подразделения МФЦ	1

Параметры ответа:

Успешный ответ

Параметр	Тип	Описание	Пример
response	json object (объект)	Результат
data	json object (объект)	Объект, свойствами которого являются идентификаторы групп окон
«идентификатор группы окон»	json object (объект)	Описание группы окон
name	string	Название группы окон	«консультации»
tipw	int	Идентификатор типа окна	1
gr_id	int	Идентификатор группы окон	69
usl	json object (массив)	Список групп услуг, который входит в данную группу окон
	json object (объект)	Описание группы услуг
naz_usl	string	Название группы услуг	«ТЕСТОВАЯ ГРУППА»
nazkr	string	Краткое название группы услуг	«ТЕСТОВАЯ ГРУППА»
naz_full	string	Полное название группы услуг	«ТЕСТОВАЯ ГРУППА»
idUsl	int	Идентификатор группы услуг	18

{
    "response": {
        "data": {
            "69": {
                "name": "консультации",
                "tipw": 1,
                "gr_id": 69,
                "usl": [
                    {
                        "naz_usl": "ТЕСТОВАЯ ГРУППА",
                        "nazkr": "ТЕСТОВАЯ ГРУППА",
                        "naz_full": "ТЕСТОВАЯ ГРУППА",
                        "idUsl": 18
                    },
                    {
                        "naz_usl": "ПФР и ФСС",
                        "nazkr": "ПФР и ФСС",
                        "naz_full": "ПФР и ФСС",
                        "idUsl": 21
                    }
                ]
            }
        }
    }
}

Ответ, содержащий ошибки

Параметр	Тип	Описание	Пример
response	json object (объект)	Результат
error	string	Текст ошибки	«Нет предварительной записи у подразделения»

{
    "response": {
        "error": "Нет предварительной записи у подразделения"
    }
}

Предварительная запись (выборка дат и времён)

Описание: метод вернёт список дат и времени, доступных для записи в конкретном подразделении для конкретной группы услуг и типа окна.

Адрес запроса: http://адрес_портала/rest-api/record/getdatetime

Метод GET

Параметры запроса:

Параметр	Тип	Обязательный	Описание	Пример
ids	int	Да	Идентификатор подразделения МФЦ	1
tipw	int	Да	Идентификатор типа окна	1
idUsl	int	Да	Идентификатор группы услуг	21
flagPortal	int	Нет (по умолчанию 5)	Источник записи (1 — Оператор МФЦ, 2 — Информационный киоск, 3 — Портал МФЦ, 4 — Портал gosuslugi.ru, 5 — Мобильное приложение, 6 — Робот МФЦ, 7 — Оператор колл-центра, 8 — Телеграм бот, 9 - ВКонтакте)	5

Параметры ответа:

Успешный ответ

Параметр	Тип	Описание	Пример
response	json object (объект)	Результат
withoutParams	json object (объект)	Объект, свойствами которого являются даты, доступные для записи в формате дд.мм.гггг
«дата»	json object (массив)	Массив доступного для записи времени
«время»	string	Доступное для записи время в формате чч:мм	«08:30»

{
    "response": {
        "withoutParams": {
            "31.10.2024": [
                "08:30",
                "08:45",
                "09:00",
                "09:15",
                "09:30",
                "09:45",
                "10:00",
                "10:15",
                "10:30",
                "10:45",
                "11:00",
                "11:15",
                "11:30",
                "11:45",
                "12:00",
                "12:15",
                "13:30",
                "13:45",
                "14:00",
                "14:15",
                "14:30",
                "14:45",
                "15:00",
                "15:15",
                "15:30",
                "15:45",
                "16:00",
                "16:15",
                "16:30",
                "16:45",
                "17:00",
                "17:15"
            ]
        }
    }
}

Ответ, содержащий ошибки

Параметр	Тип	Описание	Пример
name	string
message	string	Текст ошибки	«Запись на этот вид услуги только в МФЦ!»

{
    "name": "Not found",
    "message": "Запись на этот вид услуги только в МФЦ! "
}

Предварительная запись. Получение талона

Описание: метод запишет заявителя на указанную дату и время и вернёт идентификатор и номер талона.

Адрес запроса: http://адрес_портала/rest-api/record/preliminary

Метод GET

Параметры запроса:

Параметр	Тип	Обязательный	Описание	Пример
ids	int	Да	Идентификатор подразделения МФЦ	1
tipw	int	Да	Идентификатор типа окна	1
idUsl	int	Да	Идентификатор группы услуг	21
flagPortal	int	Нет (по умолчанию 5)	Источник записи (1 — Оператор МФЦ, 2 — Информационный киоск, 3 — Портал МФЦ, 4 — Портал gosuslugi.ru, 5 — Мобильное приложение, 6 — Робот МФЦ, 7 — Оператор колл-центра, 8 — Телеграм бот, 9 - ВКонтакте)	5
dat	string	Да	Дата, на которую производится запись в формате дд.мм.гггг	«31.10.2024»
time	string	Да	Время, на которое производится запись в формате чч:мм	«08:30»
fio	string	Да	ФИО, на которые производится запись. Если не указан дополнительно телефон или СНИЛС, то заявитель записывается по фамилии	«Иванов Иван Иванович»
phone	string	Нет	Моб. телефон заявителя. Если указан телефон и ФИО, но не указан СНИЛС, то заявитель ищется в БД по комбинации ФИО + телефон (формат +79999999999 или 79999999999)	«+79591036854»
snils	string	Нет	СНИЛС заявителя. Если указан, то заявитель ищется в БД по совпадению СНИЛС (формат 000-000-000 00)	«220-282-375 21»
kolslot	int	Нет (по умолчанию 1)	Кол-во занимаемых слотов	1
dop_talon_field	object	Нет	Доп. поле, которое будет отображаться на талоне у оператора	{ «usl»: 44 }

Параметры ответа:

Успешный ответ

Параметр	Тип	Описание	Пример
response	json object (объект)	Результат
data	json object (объект)	Результат
ins_id	json object (массив)	Идентификатор добавленного талона	«167»
npp	string	Номер талона	«П2»
err	string	Текст ошибки	null

{
    "response": {
        "data": {
            "ins_id": "167",
            "npp": "П2",
            "err": null
        }
    }
}

Ответ, содержащий ошибки

Параметр	Тип	Описание	Пример
response	json object (объект)	Результат
err	string	Текст ошибки	«Уже занято»

{
    "response": {
        "error": "Уже занято"
    }
}

Талоны (удалить талон)

Описание: метод удаляет запись о талоне из таблицы.

Адрес запроса: http://адрес_портала/rest-api/ticket/del

Метод GET

Параметры запроса:

Параметр	Тип	Обязательный	Описание	Пример
fio	string	Да	ФИО, на которые был записан талон	«Дегтярь Ирина Сергеевна»
idTicket	int	Да	Идентификатор записи	167

Параметры ответа:

Успешный ответ

Параметр	Тип	Описание	Пример
response	json object (объект)	Результат
request	string	Результат	«success»

{
    "response": {
        "request": "success"
    }
}

Ответ, содержащий ошибки

Параметр	Тип	Описание	Пример
response	json object (объект)	Результат
error	string	Текст ошибки	«Талон не найден»

{
    "response": {
        "error": "Талон не найден"
    }
}

Талоны (список)

Описание: метод вернёт список талонов заявителя.

Адрес запроса: http://адрес_портала/rest-api/ticket/list

Метод GET

Параметры запроса:

Параметр	Тип	Обязательный	Описание	Пример
fio	string	Да	ФИО, на которые был записан талон	«Дегтярь Ирина Сергеевна»
snils	string	Нет	СНИЛС заявителя в формате 000-000-000 00
phone	string	Нет	Моб. телефон заявителя в формате +79999999999	79591036854

Параметры ответа:

Успешный ответ

Параметр	Тип	Описание	Пример
response	json object (объект)	Результат
list	json object (массив)	Массив талонов заявителя
id	int	Идентификатор записи	179
npp	string	Номер талона	«П3»
receiptDate	string	Дата и время, на которые выдан талон	«01.11.2024 15:30:00»
recordingDate	string	Дат и время записи	«31.10.2024 02:06:32»
nameUsl	string	Название группы услуг	«ПФР и ФСС»
nazQue	string	Название очереди	«Консультация»
fio	string	ФИО заявителя	«Дегтярь Ирина Сергеевна»
subDivision	string	Название подразделения, в которое записан заявитель	«Отделение ГУ «МФЦ ДЕМО Центральный»»
subDivisionAddress	string	Адрес подразделения записи	«346780, Ростовская обл, г Азов, ул Московская, д. 11»
idq	int	Идентификатор эл. очереди	1
ids	int	Идентификатор подразделения МФЦ, в которое записаны	1
idUslGr	int	Идентификатор группы услуг	21
dop_talon_field	string	Дополнительные поля в талоне для отображения оператору	null

{
    "response": {
        "list": [
            {
                "id": 179,
                "npp": "П3",
                "receiptDate": "01.11.2024 15:30:00",
                "recordingDate": "31.10.2024 02:06:32",
                "nameUsl": "ПФР и ФСС",
                "nazQue": "Консультация",
                "fio": "Дегтярь Ирина Сергеевна",
                "subDivision": "Отделение ГУ «МФЦ ДЕМО Центральный»",
                "subDivisionAddress": "346780, Ростовская обл, г Азов, ул Московская, д. 11",
                "idq": 1,
                 "ids": 1,
                "idUslGr": 21,
                "dop_talon_field": null
            }
        ]
    }
}

Ответ, содержащий ошибки

Параметр	Тип	Описание	Пример
response	json object (объект)	Результат
error	string	Текст ошибки	«Талоны не найдены»

{
    "response": {
        "error": "Талоны не найдены"
    }
}