Перейти к основному содержимому

Примеры запросов

Примеры HTTP-запросов находятся по пути:
/bin/examples/request

1. Работа с заявками (Swagger → «Заявки»)

  • Создание заявки
  • Создание групповой заявки
  • Аннулирование заявки
  • Изменение данных посещения
  • Получение статуса заявки
  • Получение ПИН-кода заявки

2. Работа с отчётами

Получение данных отчёта по ID

POST /api/v4/report/{reportId}/{pageSize}/{pageNumber}
Параметры:
  pageSize   – количество записей на странице
  pageNumber – номер страницы (начинается с 0)

3. Работа с людьми

Получение информации о людях по фильтру

POST /api/v4/person/search/{pageSize}/{pageNumber}
Параметры:
  pageSize   – размер страницы
  pageNumber – номер страницы (начинается с 0)

Доступные фильтры (можно комбинировать):

  • по фамилии (по вхождению)
  • по наличию активных пропусков
  • по фамилии + наличию активных пропусков

Пример тела запроса (фильтр по фамилии «Петров»):

{
  "operator": "like",
  "key": "surname",
  "val": "Петров",
  "valType": "string",
  "operands": []
}
  1. Создание Встречающего

Если нужный Встречающий не найден в системе, его можно создать автоматически в процессе оформления заявки.

Для этого в теле запроса Заявки необходимо передать флаг "createMissingMeetingPerson": true, а в объекте "meetingPerson" обязательно указать ФИО встречающего и ID его категории.

{

"visitStartDateTime": null,

"visitEndDateTime": null,

"visitor": {

"lastName": "Иванов",

"firstName": "Иван",

"middleName": "Иванович"

},

"meetingPerson": {

"lastName": "Сидоров",

"firstName": "Алексей",

"middleName": "Петрович",

"category": {

"label":"Сотрудники"

}

},

"createMissingMeetingPerson": true

}

После выполнения запроса в системе будет создан новый пользователь с указанными ФИО и категорией. При необходимости структуру объекта "meetingPerson" можно расширить другими персональными данными встречающего в соответствии со схемой в Swagger.

  1. Пример фильтров по отчетам по заявкам
fieldIdПример фильтра
id{"operator": "eq", "key": "id", "val": "019e4f0e-4937-7360-bfba-71eb7b7752a7", "valType": "string"}
visitors.surname{"operator": "eq", "key": "visitors.surname", "val": "Иванов", "valType": "string"}
visitors.name{"operator": "eq", "key": "visitors.name", "val": "Иван", "valType": "string"}
visitors.middlename{"operator": "eq", "key": "visitors.middlename", "val": "Иванович", "valType": "string"}
visitors.id{"operator": "eq", "key": "visitors.id", "val": "019e4f12-5a7f-7bd1-bfc4-f6365440688f", "valType": "string"}
purposeOfVisit{"operator": "eq", "key": "purposeOfVisit", "val": "Собеседование", "valType": "string"}
meetingPerson.surname{"operator": "eq", "key": "meetingPerson.surname", "val": "Администратор", "valType": "string"}
meetingPerson.name{"operator": "eq", "key": "meetingPerson.name", "val": "Петр", "valType": "string"}
meetingPerson.middlename{"operator": "eq", "key": "meetingPerson.middlename", "val": "Петрович", "valType": "string"}
visitors.nationality.shortInfo{"operator": "eq", "key": "visitors.nationality.shortInfo", "val": "AL", "valType": "string"}
visitors_p_documents_p_docType_p_label{"operator": "eq", "key": "visitors.documents.docType.label", "val": "Паспорт", "valType": "string"}
v_issuePassDateTime{"operator": "between", "key": "v_issuePassDateTime", "val": "2026-06-01T00:00:00.000Z,2026-06-30T23:59:59.999Z", "valType": "date"}
visitors_p_documents_p_validTill{"operator": "between", "key": "visitors.documents.validTill", "val": "2026-01-01T00:00:00.000Z,2027-12-31T23:59:59.999Z", "valType": "date"}
visitors_p_documents_p_documentNumber{"operator": "eq", "key": "visitors.documents.documentNumber", "val": "1111 111111", "valType": "string"}
visitors_p_documents_p_nationality_p_shortInfo{"operator": "eq", "key": "visitors.documents.nationality.shortInfo", "val": "AL", "valType": "string"}
visitors_p_documents_p_nationality_p_label{"operator": "eq", "key": "visitors.documents.nationality.label", "val": "Албания", "valType": "string"}
visitors_p_documents_p_issuedByName{"operator": "eq", "key": "visitors.documents.issuedByName", "val": "Морской порт", "valType": "string"}
visitors_p_documents_p_dateOfIssue{"operator": "between", "key": "visitors.documents.dateOfIssue", "val": "2026-06-09T21:00:00.000Z,2027-11-10T13:59:00.000Z", "valType": "date"}