API выдачи талонов на центральном сервере СУО Enter 3.3.7.0 (и выше) v1¶
Общие сведения¶
API работает по протоколу HTTP на порту, сконфигурированном для службы центрального сервера СУО (по умолчанию 82).
Запросы к API выполняются через HTTP-методы GET/POST.
Тело ответа имеет формат JSON, кодировку UTF-8.
- Доступ к API возможен в двух случаях:
Запрос выполняется с HTTP-заголовком Token, в котором указывается токен вашей системы, выданный вам администратором центрального сервера СУО. Если токен некорректный, сервер вернет ответ с HTTP-статусом 401 Unauthorized.
Запрос (без заголовка Token). Если в конфигурации СУО отключена возможность выполнять запросы без заголовка Token, сервер вернет ответ с HTTP-статусом 401 Unauthorized.
Формат ответа об ошибке
- Ответ об ошибке приходит с HTTP-статусом 4xx или 5xx в теле ответа приходит объект ErrorResponse.
Ответ с HTTP-статусом 4xx означает, что, вероятно, проблема на стороне интегратора или клиента.
Ответ с HTTP-статусом 5xx означает, что проблема произошла не по вине клиента или интегратора, и нужно обратится к владельцам системы с текстом ошибки.
Примечание
Если приходит UserMessage, то его обязательно нужно показать клиенту, если его нет, можно сказать общим планом, что что-то пошло не так. Если приходит Message, значит интегратору нужно обратить на него внимание, если его нет, то никак не нужно реагировать
ErrorResponse {
"UserMessage": string, // cообщение для пользователя
"Message": string // cообщение для интеграторов
}
Пример ответа на непринятый запрос
POST /api/1/ticketregistration/login/userTest HTTP/1.1
Token: a0adba90-b8a7-4fcd-9f73-787ae2eed727
Content-Length: 0
Host: center.suo.club:82
HTTP/1.1 401 Unauthorized
Content-Length: 138
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: *
Date: Fri, 07 Jun 2019 10:01:21 GMT
{
"UserMessage": null,
"Message": "Внешняя система с токеном a0adba90-b8a7-4fcd-9f73-787ae2eed727 не найдена."
}
GET /api/1/config/servers¶
Возвращает список филиалов центрального сервера СУО.
Формат ответа
[
{
"Id": Guid, // идентификатор филиала
"Name": string, // короткое название в конфигурации
"IsConnected": bool, // подключен ли филиал к центральному серверу
"WrongProtocol": bool, // подключен ли филиал к центральному серверу c некорректным номером протокола. Если true, то взаимодействовать с таким филиалом нельзя
"OrganizationName": string, // наименование организации
"OrganizationFullName": string, // полное наименование организации
"OrganizationAddress": string, // адрес организации
}
]
Пример запроса
http://center.suo.club:82/api/1/config/servers
Пример ответа
Развернуть
[
{
"Id": "51943aec-de2b-2bb8-d6aa-889ab434d9ca",
"Name": "30 лет Победы",
"IsConnected": false,
"WrongProtocol": false,
"OrganizationName": "Тюменский филиал №3 ГАУ ТО \"МФЦ\"",
"OrganizationFullName": "Тюменский филиал №3 ГАУ ТО \"МФЦ\"",
"OrganizationAddress": "Тюменская обл., г. Тюмень, ул. 30 лет Победы, 95, корпус 2"
},
{
"Id": "80c42d23-f32a-d57f-61eb-8292129f4ba7",
"Name": "Армизонское",
"IsConnected": false,
"WrongProtocol": false,
"OrganizationName": "Армизонский филиал ГАУ ТО \"МФЦ\"",
"OrganizationFullName": "Армизонский филиал ГАУ ТО \"МФЦ\"",
"OrganizationAddress": "Тюменская обл., с. Армизонское, ул. Ленина, 5"
},
{
"Id": "1991f64a-df2a-7995-a2ae-07d4f0b004de",
"Name": "Аромашево",
"IsConnected": false,
"WrongProtocol": false,
"OrganizationName": "Аромашевский филиал ГАУ ТО \"МФЦ\"",
"OrganizationFullName": "Аромашевский филиал ГАУ ТО \"МФЦ\"",
"OrganizationAddress": "Тюменская обл., с. Аромашево, ул. Ленина, 166"
},
{
"Id": "b085aff9-5a47-5c15-f7a4-5a7f1392fea0",
"Name": "Бердюжье",
"IsConnected": false,
"WrongProtocol": false,
"OrganizationName": "Бердюжский филиал ГАУ ТО \"МФЦ\"",
"OrganizationFullName": "Бердюжский филиал ГАУ ТО \"МФЦ\"",
"OrganizationAddress": "Тюменская обл., с. Бердюжье, ул. Ленина, 27а"
},
{
"Id": "78e721bb-c691-7d58-1db5-97882ad01310",
"Name": "Водопроводная",
"IsConnected": false,
"WrongProtocol": false,
"OrganizationName": "ГАУ ТО \"МФЦ\"",
"OrganizationFullName": "ГАУ ТО \"МФЦ\"",
"OrganizationAddress": "Тюменская обл., г. Тюмень, ул. Водопроводная, 12"
},
{
"Id": "2a5cc6b9-a6e8-cd50-29d9-4378e4233912",
"Name": "Исетское",
"IsConnected": false,
"WrongProtocol": false,
"OrganizationName": "Исетский филиал ГАУ ТО \"МФЦ\"",
"OrganizationFullName": "Исетский филиал ГАУ ТО \"МФЦ\"",
"OrganizationAddress": "Тюменская обл., с. Исетское, ул. Механизаторов, 23, стр. 3"
},
{
"Id": "6402a0d8-f5ba-de52-3f95-a87282ec3e63",
"Name": "Ишим",
"IsConnected": false,
"WrongProtocol": false,
"OrganizationName": "Ишимский филиал ГАУ ТО \"МФЦ\"",
"OrganizationFullName": "Ишимский филиал ГАУ ТО \"МФЦ\"",
"OrganizationAddress": "Тюменская обл., г. Ишим, ул. Карла Маркса, 57"
},
{
"Id": "9e6bbd29-37b4-3bf2-e43a-a0b0f252bbdf",
"Name": "Казанское",
"IsConnected": false,
"WrongProtocol": false,
"OrganizationName": "Казанский филиал ГАУ ТО \"МФЦ\"",
"OrganizationFullName": "Казанский филиал ГАУ ТО \"МФЦ\"",
"OrganizationAddress": "Тюменская обл., с. Казанское, ул. Ленина, 12"
},
{
"Id": "d00965d4-9b55-8a99-1e48-97ed543e47da",
"Name": "М.Горького",
"IsConnected": false,
"WrongProtocol": false,
"OrganizationName": "Дополнительный офис приема и выдачи документов (ул. Максима Горького)",
"OrganizationFullName": "Дополнительный офис приема и выдачи документов (ул. Максима Горького)",
"OrganizationAddress": "Тюменская обл., г. Тюмень, ул. Максима Горького, 74, 76"
},
{
"Id": "6b8dffbb-e0d7-19c4-5df5-94044bb6533b",
"Name": "Нижняя Тавда",
"IsConnected": false,
"WrongProtocol": false,
"OrganizationName": "Нижнетавдинский филиал ГАУ ТО \"МФЦ\"",
"OrganizationFullName": "Нижнетавдинский филиал ГАУ ТО \"МФЦ\"",
"OrganizationAddress": "Тюменская обл., с. Нижняя Тавда, ул. Ульянова, 5"
},
{
"Id": "b69f83f1-083c-e786-e611-23fe556420ed",
"Name": "Омутинское",
"IsConnected": false,
"WrongProtocol": false,
"OrganizationName": "Омутинский филиал ГАУ ТО МФЦ",
"OrganizationFullName": "Омутинский филиал ГАУ ТО МФЦ",
"OrganizationAddress": "Тюменская обл., с. Омутинское, ул. Терешковой, 7"
},
{
"Id": "7696b070-0b80-0cb2-30a7-c3d136c17cba",
"Name": "Сладково",
"IsConnected": false,
"WrongProtocol": false,
"OrganizationName": "Сладковский филиал ГАУ ТО \"МФЦ\"",
"OrganizationFullName": "Сладковский филиал ГАУ ТО \"МФЦ\"",
"OrganizationAddress": "Тюменская обл., с. Сладково, ул. Пушкина, 6, стр. 2"
},
{
"Id": "5c4eb635-d6d1-8efe-dc23-4621f6e24d2f",
"Name": "Тобольск",
"IsConnected": false,
"WrongProtocol": false,
"OrganizationName": "Тобольский филиал ГАУ ТО \"МФЦ\"",
"OrganizationFullName": "Тобольский филиал ГАУ ТО \"МФЦ\"",
"OrganizationAddress": "г. Тобольск, 8-ой микрорайон, дом №32"
},
{
"Id": "16644012-4b10-f2ed-dbba-1b353f59b74f",
"Name": "Щербакова",
"IsConnected": true,
"WrongProtocol": false,
"OrganizationName": "Тюменский филиал №1 ГАУ ТО \"МФЦ\"",
"OrganizationFullName": "Тюменский филиал №1 ГАУ ТО \"МФЦ\"",
"OrganizationAddress": "Тюменская обл., г. Тюмень, ул. Щербакова, д. 98/3"
},
{
"Id": "e15c3f44-0538-9f78-56ff-4771b07d175d",
"Name": "Этаж 1",
"IsConnected": false,
"WrongProtocol": false,
"OrganizationName": "-",
"OrganizationFullName": "",
"OrganizationAddress": "-"
},
{
"Id": "fed76fbb-6a76-2171-61d8-2403663572ae",
"Name": "Этаж 2",
"IsConnected": false,
"WrongProtocol": false,
"OrganizationName": "-",
"OrganizationFullName": null,
"OrganizationAddress": "-"
},
{
"Id": "8074eddd-c64c-3e18-74de-fc79b224a8ed",
"Name": "Этаж 3",
"IsConnected": false,
"WrongProtocol": false,
"OrganizationName": "-",
"OrganizationFullName": null,
"OrganizationAddress": "-"
},
{
"Id": "1cdea4f5-7be1-853f-1869-83f094be32c7",
"Name": "Юргинское",
"IsConnected": false,
"WrongProtocol": false,
"OrganizationName": "Юргинский филиал ГАУ ТО \"МФЦ\"",
"OrganizationFullName": "Юргинский филиал ГАУ ТО \"МФЦ\"",
"OrganizationAddress": "Тюменская обл., с. Юргинское, ул. Восточная, 38"
},
{
"Id": "ba73bcfd-fad9-6fea-939b-09ef35b71e1c",
"Name": "Ямская",
"IsConnected": false,
"WrongProtocol": false,
"OrganizationName": "Тюменский филиал №2 ГАУ ТО \"МФЦ\"",
"OrganizationFullName": "Тюменский филиал №2 ГАУ ТО \"МФЦ\"",
"OrganizationAddress": "Тюменская обл., г. Тюмень, ул. Ямская, д. 57"
}
]
POST /api/1/ticketregistration/login/{userIdentity}¶
Возвращает токен авторизации пользователя. В качестве идентификатора пользователя может быть передана любая строка(идентификатор посетителя).
Заголовки
Token (опциональный) - идентификатор внешней системы
Параметры
userIdentity - идентификатор пользователя(посетителя), для которого будет выполняться регистрация талона и управление ранее созданными талонами по всем филиалам
Формат ответа
string – токен авторизации
Пример запроса
POST /api/1/ticketregistration/login/userTest HTTP/1.1
Token: c0adba90-b8a7-4fcd-9f73-787ae2eed726
Content-Length: 0
Host: center.suo.club:82
Пример ответа
«5ad1f058-969e-49ab-9014-0c9e59068969»
POST /api/1/ticketregistration/{serverId}/book/{date}/{time}¶
Предварительная запись на получение услуги.
Заголовки
Token (опциональный) - идентификатор внешней системы
Authorization (опциональный) - токен авторизации
Content-Type - application/json
Параметры
serverId - идентификатор филиала из метода /api/1/config/servers
date - дата предварительной записи в формате «дд.мм.гггг»
time - время предварительной записи в формате «чч:мм»
menuLinkId - идентификатор элемента меню (услуги), на который необходимо записаться
multiplier (опциональный) - значение множителя – количество дел по услуге, на которое необходимо записаться. Запрашивается у посетителя в соответствии с настройками в меню. По умолчанию – 1
dataFields (опциональный) - данные о посетителе. Запрашиваются в соответствии с настройками в меню
confirm (опциональный) - подтвердить ли запись без дополнительного запроса. Неподтвержденные талоны удаляются через 60 минут после создания (false – по умолчанию)
Рекомендуется передавать токен авторизации, полученный в методе /api/1/ticketregistration/login – в этом случае талон будет привязан к пользователю.
Формат ответа
объект типа TicketSummary
Пример запроса
POST /api/1/ticketregistration/78e721bb-c691-7d58-1db5-97882ad01310/book/27.5.2019/18:30 HTTP/1.1
Authorization: 161e44c1-89a1-472a-aa1f-bd6b40297961
Token: c0adba90-b8a7-4fcd-9f73-787ae2eed726
Content-Length: 149
Host: center.suo.club:82
Content-Type: application/json
{
menuLinkId:"ac7d72fc-bf48-eef7-f4a1-c8416b885dcb",
dataFields:[
{
Value:"2018-00001",
FieldId:"42306bde-dd5b-65d7-d48d-03eba7a095e6"
}
],
confirm:false
}
Пример ответа
HTTP/1.1 200 OK
Content-Length: 800
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: *
Date: Mon, 27 May 2019 05:07:55 GMT
Развернуть
{
"Id": "df318b9a-a70f-4ea4-8275-c6ad95ae1e8e",
"FullNumber": "",
"PinCode": null,
"State": 0,
"Products": [
{
"Id": "7cd8db92-0401-42d2-ae9c-ef13161b63e6",
"Name": "Выдача результата ВУ",
"State": 0,
"StartTime": "2019-05-27T18:30:00",
"CanActivateNow": false,
"IsPending": true
},
{
"Id": "6c2c5576-8458-4fb2-81cd-72a5987392a7",
"Name": "Выдача результата оказания услуги",
"State": 0,
"StartTime": "2019-05-27T18:30:00",
"CanActivateNow": false,
"IsPending": true
},
{
"Id": "4170a15f-8cd1-45b0-8302-bb3c55fd1553",
"Name": "Выдача результата оказания услуг (ЕГРП и ГКН) (М76)",
"State": 0,
"StartTime": "2019-05-27T18:30:00",
"CanActivateNow": false,
"IsPending": true
}
],
"ServerId": "78e721bb-c691-7d58-1db5-97882ad01310",
"ActivationAvailability": {
"State": 2,
"ErrorMessage": "Талон записан не на сегодня"
},
"ShowQuestionBeforeActivation": false
}
POST /api/1/ticketregistration/tickets/{ticketId}/book/{date}/{time}¶
Предварительная запись на получение услуги. Услуга добавляется в существующий неподтвержденный талон, который становится мультиталоном, т. к. содержит более 1 услуги. Предварительная запись на несколько услуг в мультиталоне может быть на один день, т. е. нельзя записаться на разные дни в рамках одного мультиталона. При взятии мультиталона следует сперва набрать услуги без подтверждения, а затем подтвердить весь мультиталон.
Заголовки
Token (опциональный) - идентификатор внешней системы
Authorization (опциональный) - токен авторизации
Content-Type - application/json
Параметры
ticketId - идентификатор талона из метода /api/1/ticketregistration/{serverId}/book
date - дата предполагаемой предварительной записи в формате «дд.мм.гггг»
time - время предварительной записи в формате «чч:мм»
menuLinkId - идентификатор элемента меню (услугиили или маршрута), на который необходимо записаться
multiplier (опциональный) - значение множителя – количество дел по услуге, на которое необходимо записаться. Запрашивается у посетителя в соответствии с настройками в меню. По умолчанию – 1
dataFields (опциональный) - данные о посетителе. Запрашиваются в соответствии с настройками в меню
confirm (опциональный) - подтвердить ли запись без дополнительного запроса. Неподтвержденные талоны удаляются через 60 минут после создания
Рекомендуется передавать токен авторизации, полученный в методе /api/1/ticketregistration/login – в этом случае талон будет привязан к пользователю.
Формат ответа
объект типа TicketSummary
Пример запроса
POST /api/1/ticketregistration/tickets/df318b9a-a70f-4ea4-8275-c6ad95ae1e8e/book/27.5.2019/18:45 HTTP/1.1
Authorization: 161e44c1-89a1-472a-aa1f-bd6b40297961
Token: c0adba90-b8a7-4fcd-9f73-787ae2eed726
Content-Length: 149
Host: center.suo.club:82
Content-Type: application/json
{
menuLinkId:"ac7d72fc-bf48-eef7-f4a1-c8416b885dcb",
dataFields:[
{
Value:"2018-00001",
FieldId:"42306bde-dd5b-65d7-d48d-03eba7a095e6"
}
],
confirm:false
}
Пример ответа
HTTP/1.1 200 OK
Content-Length: 1411
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: *
Date: Mon, 27 May 2019 05:31:41 GMT
Развернуть
{
"Id": "df318b9a-a70f-4ea4-8275-c6ad95ae1e8e",
"FullNumber": "",
"PinCode": null,
"State": 0,
"Products": [
{
"Id": "7cd8db92-0401-42d2-ae9c-ef13161b63e6",
"Name": "Выдача результата ВУ",
"State": 0,
"StartTime": "2019-05-27T18:30:00",
"CanActivateNow": false,
"IsPending": true
},
{
"Id": "6c2c5576-8458-4fb2-81cd-72a5987392a7",
"Name": "Выдача результата оказания услуги",
"State": 0,
"StartTime": "2019-05-27T18:30:00",
"CanActivateNow": false,
"IsPending": true
},
{
"Id": "4170a15f-8cd1-45b0-8302-bb3c55fd1553",
"Name": "Выдача результата оказания услуг (ЕГРП и ГКН) (М76)",
"State": 0,
"StartTime": "2019-05-27T18:30:00",
"CanActivateNow": false,
"IsPending": true
},
{
"Id": "e58d210e-c4b3-46ca-87ef-07294891b3d9",
"Name": "Выдача результата ВУ",
"State": 0,
"StartTime": "2019-05-27T18:45:00",
"CanActivateNow": false,
"IsPending": true
},
{
"Id": "279acee1-d31f-419d-9faf-64660682c0e4",
"Name": "Выдача результата оказания услуги",
"State": 0,
"StartTime": "2019-05-27T18:45:00",
"CanActivateNow": false,
"IsPending": true
},
{
"Id": "cabfd33e-1f7f-4da9-b04c-33367aabeea5",
"Name": "Выдача результата оказания услуг (ЕГРП и ГКН) (М76)",
"State": 0,
"StartTime": "2019-05-27T18:45:00",
"CanActivateNow": false,
"IsPending": true
}
],
"ServerId": "78e721bb-c691-7d58-1db5-97882ad01310",
"ActivationAvailability": {
"State": 2,
"ErrorMessage": "Талон записан не на сегодня"
},
"ShowQuestionBeforeActivation": false
}
POST /api/1/ticketregistration/{serverId}/alive¶
Выдача талона в живую очередь.
Заголовки
Token (опциональный) - идентификатор внешней системы
Authorization (опциональный) - токен авторизации
Content-Type - application/json
Параметры
serverId - идентификатор филиала из метода /api/1/config/servers
menuLinkId - идентификатор элемента меню (услугиили или маршрута), на который необходимо записаться
multiplier (опциональный) - значение множителя – количество дел по услуге, на которое необходимо записаться. Запрашивается у посетителя в соответствии с настройками в меню. По умолчанию – 1
dataFields (опциональный) - данные о посетителе. Запрашиваются в соответствии с настройками в меню
confirm (опциональный) - подтвердить ли запись без дополнительного запроса. Неподтвержденные талоны удаляются через 60 минут после создания
Рекомендуется передавать токен авторизации, полученный в методе /api/1/ticketregistration/login – в этом случае талон будет привязан к пользователю.
Формат ответа
объект типа TicketSummary
Пример запроса
POST /api/1/ticketregistration/78e721bb-c691-7d58-1db5-97882ad01310/alive HTTP/1.1
Authorization: 161e44c1-89a1-472a-aa1f-bd6b40297961
Token: c0adba90-b8a7-4fcd-9f73-787ae2eed726
Content-Length: 149
Host: center.suo.club:82
Content-Type: application/json
{
menuLinkId:"ac7d72fc-bf48-eef7-f4a1-c8416b885dcb",
dataFields:[
{
Value:"2018-00001",
FieldId:"42306bde-dd5b-65d7-d48d-03eba7a095e6"
}
],
confirm:false
}
Пример ответа
HTTP/1.1 200 OK
Content-Length: 827
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: *
Date: Mon, 27 May 2019 05:36:39 GMT
Развернуть
{
"Id": "6b35b9a4-8521-444a-bbc3-80e3a02b0e37",
"FullNumber": "",
"PinCode": null,
"State": 0,
"Products": [
{
"Id": "f69a0ba7-2816-412a-aeeb-a9858df44ce9",
"Name": "Выдача результата ВУ",
"State": 0,
"StartTime": "2019-05-27T10:36:39.6104166",
"CanActivateNow": false,
"IsPending": false
},
{
"Id": "1b4cd7c4-9ae1-4c62-8cf8-bd53d0901271",
"Name": "Выдача результата оказания услуги",
"State": 0,
"StartTime": "2019-05-27T10:36:39.6104166",
"CanActivateNow": false,
"IsPending": false
},
{
"Id": "01f806ee-cb03-4761-b9e8-825dff3a83d1",
"Name": "Выдача результата оказания услуг (ЕГРП и ГКН) (М76)",
"State": 0,
"StartTime": "2019-05-27T10:36:39.6104166",
"CanActivateNow": false,
"IsPending": false
}
],
"ServerId": "78e721bb-c691-7d58-1db5-97882ad01310",
"ShowQuestionBeforeActivation": false
}
POST /api/1/ticketregistration/tickets/{ticketId}/addAlive¶
Выдача талона в живую очередь.
Заголовки
Token (опциональный) - идентификатор внешней системы
Authorization - токен авторизации
Content-Type - application/json
Параметры
ticketId - идентификатор талона
menuLinkId - идентификатор элемента меню (услугиили или маршрута), на который необходимо записаться
multiplier (опциональный) - значение множителя – количество дел по услуге, на которое необходимо записаться. Запрашивается у посетителя в соответствии с настройками в меню. По умолчанию – 1
dataFields (опциональный) - данные о посетителе. Запрашиваются в соответствии с настройками в меню
confirm (опциональный) - подтвердить ли запись без дополнительного запроса. Неподтвержденные талоны удаляются через 60 минут после создания
Формат ответа
объект типа TicketSummary
Пример запроса
POST /api/1/ticketregistration/tickets/6b35b9a4-8521-444a-bbc3-80e3a02b0e37/addAlive HTTP/1.1
Authorization: 161e44c1-89a1-472a-aa1f-bd6b40297961
Token: c0adba90-b8a7-4fcd-9f73-787ae2eed726
Content-Length: 149
Host: center.suo.club:82
Content-Type: application/json
{
menuLinkId:"ac7d72fc-bf48-eef7-f4a1-c8416b885dcb",
dataFields:[
{
Value:"2018-00001",
FieldId:"42306bde-dd5b-65d7-d48d-03eba7a095e6"
}
],
confirm:false
}
Пример ответа
HTTP/1.1 200 OK
Content-Length: 1465
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: *
Date: Mon, 27 May 2019 06:04:03 GMT
Развернуть
{
"Id": "6b35b9a4-8521-444a-bbc3-80e3a02b0e37",
"FullNumber": "",
"PinCode": null,
"State": 0,
"Products": [
{
"Id": "f69a0ba7-2816-412a-aeeb-a9858df44ce9",
"Name": "Выдача результата ВУ",
"State": 0,
"StartTime": "2019-05-27T10:36:39.6104166",
"CanActivateNow": false,
"IsPending": false
},
{
"Id": "1b4cd7c4-9ae1-4c62-8cf8-bd53d0901271",
"Name": "Выдача результата оказания услуги",
"State": 0,
"StartTime": "2019-05-27T10:36:39.6104166",
"CanActivateNow": false,
"IsPending": false
},
{
"Id": "01f806ee-cb03-4761-b9e8-825dff3a83d1",
"Name": "Выдача результата оказания услуг (ЕГРП и ГКН) (М76)",
"State": 0,
"StartTime": "2019-05-27T10:36:39.6104166",
"CanActivateNow": false,
"IsPending": false
},
{
"Id": "147c6d53-c4a4-4226-ae0b-d8fb4f3bc5a8",
"Name": "Выдача результата ВУ",
"State": 0,
"StartTime": "2019-05-27T11:04:02.9399904",
"CanActivateNow": false,
"IsPending": false
},
{
"Id": "da5c735f-29fb-472c-9014-4554d00c1b74",
"Name": "Выдача результата оказания услуги",
"State": 0,
"StartTime": "2019-05-27T11:04:02.9399904",
"CanActivateNow": false,
"IsPending": false
},
{
"Id": "c343559b-32f8-4c8d-82d3-d65170262ec6",
"Name": "Выдача результата оказания услуг (ЕГРП и ГКН) (М76)",
"State": 0,
"StartTime": "2019-05-27T11:04:02.9399904",
"CanActivateNow": false,
"IsPending": false
}
],
"ServerId": "78e721bb-c691-7d58-1db5-97882ad01310",
"ShowQuestionBeforeActivation": false
}
POST /api/1/ticketregistration/tickets/{ticketId}/confirm¶
Предварительная запись на получение услуги.
Заголовки
Token (опциональный) - идентификатор внешней системы
Authorization - токен авторизации
Параметры
ticketId - идентификатор талона предварительной записи
Формат ответа
объект типа TicketSummary
Пример запроса
POST /api/1/ticketregistration/tickets/6b35b9a4-8521-444a-bbc3-80e3a02b0e37/confirm HTTP/1.1
Authorization: 161e44c1-89a1-472a-aa1f-bd6b40297961
Token: c0adba90-b8a7-4fcd-9f73-787ae2eed726
Content-Length: 0
Host: center.suo.club:82
Пример ответа
HTTP/1.1 200 OK
Content-Length: 1474
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: *
Date: Mon, 27 May 2019 06:08:41 GMT
Развернуть
{
"Id": "6b35b9a4-8521-444a-bbc3-80e3a02b0e37",
"FullNumber": "M23",
"PinCode": "606387",
"State": 1,
"Products": [
{
"Id": "f69a0ba7-2816-412a-aeeb-a9858df44ce9",
"Name": "Выдача результата ВУ",
"State": 16,
"StartTime": "2019-05-27T11:08:41.464462",
"CanActivateNow": false,
"IsPending": false
},
{
"Id": "1b4cd7c4-9ae1-4c62-8cf8-bd53d0901271",
"Name": "Выдача результата оказания услуги",
"State": 15,
"StartTime": "2019-05-27T11:08:41.464462",
"CanActivateNow": false,
"IsPending": false
},
{
"Id": "01f806ee-cb03-4761-b9e8-825dff3a83d1",
"Name": "Выдача результата оказания услуг (ЕГРП и ГКН) (М76)",
"State": 15,
"StartTime": "2019-05-27T10:36:39.6104166",
"CanActivateNow": false,
"IsPending": false
},
{
"Id": "147c6d53-c4a4-4226-ae0b-d8fb4f3bc5a8",
"Name": "Выдача результата ВУ",
"State": 16,
"StartTime": "2019-05-27T11:08:41.464462",
"CanActivateNow": false,
"IsPending": false
},
{
"Id": "da5c735f-29fb-472c-9014-4554d00c1b74",
"Name": "Выдача результата оказания услуги",
"State": 15,
"StartTime": "2019-05-27T11:08:41.464462",
"CanActivateNow": false,
"IsPending": false
},
{
"Id": "c343559b-32f8-4c8d-82d3-d65170262ec6",
"Name": "Выдача результата оказания услуг (ЕГРП и ГКН) (М76)",
"State": 15,
"StartTime": "2019-05-27T11:04:02.9399904",
"CanActivateNow": false,
"IsPending": false
}
],
"ServerId": "78e721bb-c691-7d58-1db5-97882ad01310",
"ShowQuestionBeforeActivation": false
}
GET /api/1/ticketregistration/tickets?offset={offset}&limit={limit}¶
Возвращает список талонов для аутентифицированного пользователя упорядоченых по времени создания.
Заголовки
Token (опциональный) - идентификатор внешней системы
Authorization - токен авторизации
Параметры
offset (опциональный) - смещение с начала списка
limit (опциональный) - максимальное количество возвращаемых талонов
Формат ответа
{
AllCount: int // общее количество талонов пользователя,
Items: TicketSummary[] // список запрошенных талонов пользователя
}
Пример запроса
GET /api/1/ticketregistration/tickets?offset=2&limit=2 HTTP/1.1
Authorization: 0b1ac6aa-2c7c-4cfc-92d7-d2ab1b5805bb
Token: c0adba90-b8a7-4fcd-9f73-787ae2eed726
Host: center.suo.club:82
Пример ответа
HTTP/1.1 200 OK
Content-Length: 2897
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Date: Tue, 28 May 2019 05:46:54 GMT
Развернуть
{
"Items": [
{
"Id": "6b35b9a4-8521-444a-bbc3-80e3a02b0e37",
"FullNumber": "M23",
"PinCode": "606387",
"State": 3,
"Products": [
{
"Id": "01f806ee-cb03-4761-b9e8-825dff3a83d1",
"Name": "Выдача результата оказания услуг (ЕГРП и ГКН) (М76)",
"State": 10,
"StartTime": "2019-05-27T10:36:39.61",
"CanActivateNow": false,
"IsPending": false
},
{
"Id": "c343559b-32f8-4c8d-82d3-d65170262ec6",
"Name": "Выдача результата оказания услуг (ЕГРП и ГКН) (М76)",
"State": 10,
"StartTime": "2019-05-27T11:04:02.94",
"CanActivateNow": false,
"IsPending": false
},
{
"Id": "f69a0ba7-2816-412a-aeeb-a9858df44ce9",
"Name": "Выдача результата ВУ",
"State": 9,
"StartTime": "2019-05-27T11:08:41.463",
"CanActivateNow": false,
"IsPending": false
},
{
"Id": "1b4cd7c4-9ae1-4c62-8cf8-bd53d0901271",
"Name": "Выдача результата оказания услуги",
"State": 10,
"StartTime": "2019-05-27T11:08:41.463",
"CanActivateNow": false,
"IsPending": false
},
{
"Id": "da5c735f-29fb-472c-9014-4554d00c1b74",
"Name": "Выдача результата оказания услуги",
"State": 10,
"StartTime": "2019-05-27T11:08:41.463",
"CanActivateNow": false,
"IsPending": false
},
{
"Id": "147c6d53-c4a4-4226-ae0b-d8fb4f3bc5a8",
"Name": "Выдача результата ВУ",
"State": 9,
"StartTime": "2019-05-27T11:08:41.463",
"CanActivateNow": false,
"IsPending": false
}
],
"ServerId": "78e721bb-c691-7d58-1db5-97882ad01310",
"ShowQuestionBeforeActivation": false
},
{
"Id": "df318b9a-a70f-4ea4-8275-c6ad95ae1e8e",
"FullNumber": "M25",
"PinCode": "773202",
"State": 3,
"Products": [
{
"Id": "6c2c5576-8458-4fb2-81cd-72a5987392a7",
"Name": "Выдача результата оказания услуги",
"State": 10,
"StartTime": "2019-05-27T18:30:00",
"CanActivateNow": false,
"IsPending": true
},
{
"Id": "4170a15f-8cd1-45b0-8302-bb3c55fd1553",
"Name": "Выдача результата оказания услуг (ЕГРП и ГКН) (М76)",
"State": 10,
"StartTime": "2019-05-27T18:30:00",
"CanActivateNow": false,
"IsPending": true
},
{
"Id": "7cd8db92-0401-42d2-ae9c-ef13161b63e6",
"Name": "Выдача результата ВУ",
"State": 10,
"StartTime": "2019-05-27T18:30:00",
"CanActivateNow": false,
"IsPending": true
},
{
"Id": "e58d210e-c4b3-46ca-87ef-07294891b3d9",
"Name": "Выдача результата ВУ",
"State": 10,
"StartTime": "2019-05-27T18:45:00",
"CanActivateNow": false,
"IsPending": true
},
{
"Id": "cabfd33e-1f7f-4da9-b04c-33367aabeea5",
"Name": "Выдача результата оказания услуг (ЕГРП и ГКН) (М76)",
"State": 10,
"StartTime": "2019-05-27T18:45:00",
"CanActivateNow": false,
"IsPending": true
},
{
"Id": "279acee1-d31f-419d-9faf-64660682c0e4",
"Name": "Выдача результата оказания услуги",
"State": 10,
"StartTime": "2019-05-27T18:45:00",
"CanActivateNow": false,
"IsPending": true
}
],
"ServerId": "78e721bb-c691-7d58-1db5-97882ad01310",
"ShowQuestionBeforeActivation": false
}
],
"AllCount": 5
}
GET /api/1/ticketregistration/tickets/{ticketId}¶
Получение информации о талоне.
Если талон привязан к пользователю, требуется передать токен авторизации пользователя, полученный в методе login.
Заголовки
Token (опциональный) - идентификатор внешней системы
Authorization - токен авторизации
Параметры
ticketId - идентификатор талона предварительной записи
Формат ответа
объект типа TicketSummary
Пример запроса
GET /api/1/ticketregistration/tickets/df318b9a-a70f-4ea4-8275-c6ad95ae1e8e HTTP/1.1
Authorization: 161e44c1-89a1-472a-aa1f-bd6b40297961
Token: c0adba90-b8a7-4fcd-9f73-787ae2eed726
Host: center.suo.club:82
Пример ответа
HTTP/1.1 200 OK
Content-Length: 1420
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Date: Mon, 27 May 2019 06:39:17 GMT
Развернуть
{
"Id": "df318b9a-a70f-4ea4-8275-c6ad95ae1e8e",
"FullNumber": "M25",
"PinCode": "773202",
"State": 1,
"Products": [
{
"Id": "7cd8db92-0401-42d2-ae9c-ef13161b63e6",
"Name": "Выдача результата ВУ",
"State": 13,
"StartTime": "2019-05-27T18:30:00",
"CanActivateNow": true,
"IsPending": true
},
{
"Id": "6c2c5576-8458-4fb2-81cd-72a5987392a7",
"Name": "Выдача результата оказания услуги",
"State": 13,
"StartTime": "2019-05-27T18:30:00",
"CanActivateNow": true,
"IsPending": true
},
{
"Id": "4170a15f-8cd1-45b0-8302-bb3c55fd1553",
"Name": "Выдача результата оказания услуг (ЕГРП и ГКН) (М76)",
"State": 15,
"StartTime": "2019-05-27T18:30:00",
"CanActivateNow": false,
"IsPending": true
},
{
"Id": "e58d210e-c4b3-46ca-87ef-07294891b3d9",
"Name": "Выдача результата ВУ",
"State": 13,
"StartTime": "2019-05-27T18:45:00",
"CanActivateNow": true,
"IsPending": true
},
{
"Id": "279acee1-d31f-419d-9faf-64660682c0e4",
"Name": "Выдача результата оказания услуги",
"State": 13,
"StartTime": "2019-05-27T18:45:00",
"CanActivateNow": true,
"IsPending": true
},
{
"Id": "cabfd33e-1f7f-4da9-b04c-33367aabeea5",
"Name": "Выдача результата оказания услуг (ЕГРП и ГКН) (М76)",
"State": 15,
"StartTime": "2019-05-27T18:45:00",
"CanActivateNow": false,
"IsPending": true
}
],
"ServerId": "78e721bb-c691-7d58-1db5-97882ad01310",
"ShowQuestionBeforeActivation": false
}
GET /api/1/ticketregistration/tickets/{ticketId}/info¶
Получение информации о талоне.
Если талон привязан к пользователю, требуется передать токен авторизации пользователя, полученный в методе login.
Заголовки
Token (опциональный) - идентификатор внешней системы
Authorization - токен авторизации
Параметры
ticketId - идентификатор талона предварительной записи
Пример запроса
GET /api/1/ticketregistration/tickets/df318b9a-a70f-4ea4-8275-c6ad95ae1e8e/info HTTP/1.1
Authorization: 161e44c1-89a1-472a-aa1f-bd6b40297961
Token: c0adba90-b8a7-4fcd-9f73-787ae2eed726
Host: center.suo.club:82
Формат ответа
{
Id:Guid // Идентификатор талона,
Created:DateTime // Дата и время создания талона,
PinCode:string // Пин-код талона,
FullNumber:string // Полный номер талона,
State:int // состояние услуги в талоне из перечисления TicketState,
ServerId:Guid // Идентификатор филиала,
Products:[
{
Id:Guid // Идентификатор услуги в талоне,
Created:DateTime // Дата и время добавления услуги в талон,
StartTime:DateTime // Для талона по записи время записи, для талона живой очереди время подтверждения талона,
IsPending:Bool // True:Услуга по записи, False: живая очередь
ProductId:Guid // Идентификатор услуги,
ProductName:string // Название услуги в момент выдачи(после переименования в системе, здесь будет старое название),
ProductIntegrationId:string // Идентификатор услуги из настроек внешней системы,
State:int // состояние услуги в талоне из перечисления TicketProductState,
DataFields:[{
Id:Guid // Идентификатор данных,
Name:string // Наименования поля доп. сведений,
FieldId:Guid // Идентификатор поля доп. сведений,
Value:string // Значение поля доп. сведений
}]
}],
}
Пример ответа
HTTP/1.1 200 OK
Content-Length: 2113
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Date: Mon, 27 May 2019 06:41:40 GMT
Развернуть
{
"Id": "df318b9a-a70f-4ea4-8275-c6ad95ae1e8e",
"Created": "2019-05-27T10:07:55.133",
"PinCode": "773202",
"FullNumber": "M25",
"State": 1,
"Products": [
{
"Id": "6c2c5576-8458-4fb2-81cd-72a5987392a7",
"Created": "2019-05-27T10:07:55.133",
"StartTime": "2019-05-27T18:30:00",
"IsPending": true,
"ProductId": "51177858-3a6f-4d07-86e7-deb8043bce9a",
"ProductName": "Выдача результата оказания услуги",
"ProductIntegrationId": null,
"State": 13,
"DataFields": []
},
{
"Id": "4170a15f-8cd1-45b0-8302-bb3c55fd1553",
"Created": "2019-05-27T10:07:55.133",
"StartTime": "2019-05-27T18:30:00",
"IsPending": true,
"ProductId": "e3320978-1dd1-45d5-9105-695ddfac918c",
"ProductName": "Выдача результата оказания услуг (ЕГРП и ГКН) (М76)",
"ProductIntegrationId": null,
"State": 15,
"DataFields": []
},
{
"Id": "7cd8db92-0401-42d2-ae9c-ef13161b63e6",
"Created": "2019-05-27T10:07:55.133",
"StartTime": "2019-05-27T18:30:00",
"IsPending": true,
"ProductId": "6418acd0-46b8-03e7-9f3f-d0f54c3b799e",
"ProductName": "Выдача результата ВУ",
"ProductIntegrationId": null,
"State": 13,
"DataFields": []
},
{
"Id": "279acee1-d31f-419d-9faf-64660682c0e4",
"Created": "2019-05-27T10:31:41.667",
"StartTime": "2019-05-27T18:45:00",
"IsPending": true,
"ProductId": "51177858-3a6f-4d07-86e7-deb8043bce9a",
"ProductName": "Выдача результата оказания услуги",
"ProductIntegrationId": null,
"State": 13,
"DataFields": []
},
{
"Id": "cabfd33e-1f7f-4da9-b04c-33367aabeea5",
"Created": "2019-05-27T10:31:41.667",
"StartTime": "2019-05-27T18:45:00",
"IsPending": true,
"ProductId": "e3320978-1dd1-45d5-9105-695ddfac918c",
"ProductName": "Выдача результата оказания услуг (ЕГРП и ГКН) (М76)",
"ProductIntegrationId": null,
"State": 15,
"DataFields": []
},
{
"Id": "e58d210e-c4b3-46ca-87ef-07294891b3d9",
"Created": "2019-05-27T10:31:41.667",
"StartTime": "2019-05-27T18:45:00",
"IsPending": true,
"ProductId": "6418acd0-46b8-03e7-9f3f-d0f54c3b799e",
"ProductName": "Выдача результата ВУ",
"ProductIntegrationId": null,
"State": 13,
"DataFields": []
}
],
"ServerId": "78e721bb-c691-7d58-1db5-97882ad01310"
}
GET /api/1/ticketregistration/{serverId}/tickets/ticketByPinCode/{pinCode}¶
Получение информации о талоне.
Заголовки
Token (опциональный) - идентификатор внешней системы
Параметры
serverId - идентификатор филиала, на которм будет искаться талон
pinCode - идентификатор талона предварительной записи
Формат ответа
объект типа TicketSummary
Пример запроса
GET /api/1/ticketregistration/tickets/ticketByPinCode/773202 HTTP/1.1
Authorization: 161e44c1-89a1-472a-aa1f-bd6b40297961
Token: c0adba90-b8a7-4fcd-9f73-787ae2eed726
Host: center.suo.club:82
Пример ответа
HTTP/1.1 200 OK
Content-Length: 1420
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Date: Mon, 27 May 2019 06:39:17 GMT
Развернуть
{
"Id": "df318b9a-a70f-4ea4-8275-c6ad95ae1e8e",
"FullNumber": "M25",
"PinCode": "773202",
"State": 1,
"Products": [
{
"Id": "7cd8db92-0401-42d2-ae9c-ef13161b63e6",
"Name": "Выдача результата ВУ",
"State": 13,
"StartTime": "2019-05-27T18:30:00",
"CanActivateNow": true,
"IsPending": true
},
{
"Id": "6c2c5576-8458-4fb2-81cd-72a5987392a7",
"Name": "Выдача результата оказания услуги",
"State": 13,
"StartTime": "2019-05-27T18:30:00",
"CanActivateNow": true,
"IsPending": true
},
{
"Id": "4170a15f-8cd1-45b0-8302-bb3c55fd1553",
"Name": "Выдача результата оказания услуг (ЕГРП и ГКН) (М76)",
"State": 15,
"StartTime": "2019-05-27T18:30:00",
"CanActivateNow": false,
"IsPending": true
},
{
"Id": "e58d210e-c4b3-46ca-87ef-07294891b3d9",
"Name": "Выдача результата ВУ",
"State": 13,
"StartTime": "2019-05-27T18:45:00",
"CanActivateNow": true,
"IsPending": true
},
{
"Id": "279acee1-d31f-419d-9faf-64660682c0e4",
"Name": "Выдача результата оказания услуги",
"State": 13,
"StartTime": "2019-05-27T18:45:00",
"CanActivateNow": true,
"IsPending": true
},
{
"Id": "cabfd33e-1f7f-4da9-b04c-33367aabeea5",
"Name": "Выдача результата оказания услуг (ЕГРП и ГКН) (М76)",
"State": 15,
"StartTime": "2019-05-27T18:45:00",
"CanActivateNow": false,
"IsPending": true
}
],
"ServerId": "78e721bb-c691-7d58-1db5-97882ad01310",
"ShowQuestionBeforeActivation": false
}
POST /api/1/ticketregistration/tickets/{ticketId}/cancel¶
Отмена талона.
Если талон привязан к пользователю, требуется передать токен авторизации пользователя, полученный в методе login.
Заголовки
Token (опциональный) - идентификатор внешней системы
Authorization - токен авторизации
Параметры
ticketId - идентификатор талона
Формат ответа
объект типа TicketSummary
Пример запроса
POST /api/1/ticketregistration/tickets/df318b9a-a70f-4ea4-8275-c6ad95ae1e8e/cancel HTTP/1.1
Authorization: 161e44c1-89a1-472a-aa1f-bd6b40297961
Token: c0adba90-b8a7-4fcd-9f73-787ae2eed726
Content-Length: 0
Host: center.suo.club:82
Пример ответа
HTTP/1.1 200 OK
Content-Length: 1424
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: *
Date: Mon, 27 May 2019 06:51:58 GMT
Развернуть
{
"Id": "df318b9a-a70f-4ea4-8275-c6ad95ae1e8e",
"FullNumber": "M25",
"PinCode": "773202",
"State": 3,
"Products": [
{
"Id": "7cd8db92-0401-42d2-ae9c-ef13161b63e6",
"Name": "Выдача результата ВУ",
"State": 10,
"StartTime": "2019-05-27T18:30:00",
"CanActivateNow": false,
"IsPending": true
},
{
"Id": "6c2c5576-8458-4fb2-81cd-72a5987392a7",
"Name": "Выдача результата оказания услуги",
"State": 10,
"StartTime": "2019-05-27T18:30:00",
"CanActivateNow": false,
"IsPending": true
},
{
"Id": "4170a15f-8cd1-45b0-8302-bb3c55fd1553",
"Name": "Выдача результата оказания услуг (ЕГРП и ГКН) (М76)",
"State": 10,
"StartTime": "2019-05-27T18:30:00",
"CanActivateNow": false,
"IsPending": true
},
{
"Id": "e58d210e-c4b3-46ca-87ef-07294891b3d9",
"Name": "Выдача результата ВУ",
"State": 10,
"StartTime": "2019-05-27T18:45:00",
"CanActivateNow": false,
"IsPending": true
},
{
"Id": "279acee1-d31f-419d-9faf-64660682c0e4",
"Name": "Выдача результата оказания услуги",
"State": 10,
"StartTime": "2019-05-27T18:45:00",
"CanActivateNow": false,
"IsPending": true
},
{
"Id": "cabfd33e-1f7f-4da9-b04c-33367aabeea5",
"Name": "Выдача результата оказания услуг (ЕГРП и ГКН) (М76)",
"State": 10,
"StartTime": "2019-05-27T18:45:00",
"CanActivateNow": false,
"IsPending": true
}
],
"ServerId": "78e721bb-c691-7d58-1db5-97882ad01310",
"ShowQuestionBeforeActivation": false
}
POST /api/1/ticketregistration/ticketproducts/{ticketProductId}/cancel¶
Отмена услуги в талоне.
Если талон привязан к пользователю, требуется передать токен авторизации пользователя, полученный в методе login.
Заголовки
Token (опциональный) - идентификатор внешней системы
Authorization - токен авторизации
Параметры
ticketProductId - идентификатор услуги в талоне
Формат ответа
объект типа TicketSummary
Пример запроса
POST /api/1/ticketregistration/ticketproducts/a327b6b8-0ed6-4673-a834-b7e3ee0d5c4f/cancel HTTP/1.1
Authorization: 161e44c1-89a1-472a-aa1f-bd6b40297961
Token: c0adba90-b8a7-4fcd-9f73-787ae2eed726
Content-Length: 0
Host: center.suo.club:82
Пример ответа
HTTP/1.1 200 OK
Content-Length: 800
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: *
Date: Mon, 27 May 2019 06:56:59 GMT
Развернуть
{
"Id": "9394eb55-d9cf-4505-b957-00031f4a56ce",
"FullNumber": "",
"PinCode": null,
"State": 3,
"Products": [
{
"Id": "a327b6b8-0ed6-4673-a834-b7e3ee0d5c4f",
"Name": "Выдача результата ВУ",
"State": 1,
"StartTime": "2019-05-27T18:30:00",
"CanActivateNow": false,
"IsPending": true
},
{
"Id": "e16845f6-2d12-42bc-a3ad-1caf0532fb13",
"Name": "Выдача результата оказания услуги",
"State": 1,
"StartTime": "2019-05-27T18:30:00",
"CanActivateNow": false,
"IsPending": true
},
{
"Id": "b36b4335-4bf9-408b-8cd0-bd7d5047353e",
"Name": "Выдача результата оказания услуг (ЕГРП и ГКН) (М76)",
"State": 1,
"StartTime": "2019-05-27T18:30:00",
"CanActivateNow": false,
"IsPending": true
}
],
"ServerId": "78e721bb-c691-7d58-1db5-97882ad01310",
"ShowQuestionBeforeActivation": false
}
POST /api/1/ticketregistration/tickets/{ticketId}/activate?inviteAsLive={inviteAsLive}&denyEarlyActivation={denyEarlyActivation}¶
Активация талона предварительной записи.
Активировать можно только талон, привязаный к пользователю. При вызове метода активации требуется передать токен авторизации пользователя, полученный в методе login.
Заголовки
Token (опциональный) - идентификатор внешней системы
Authorization - токен авторизации
Параметры
ticketId - идентификатор талона по записи
inviteAsLive (опциональный) - ответ пользователя на вопрос «Хотите ли вы, чтобы вас пригласили заранее, если будет возможность?». Если вопрос не задавался, можно передать любое значение. По умолчанию false
denyEarlyActivation (опциональный) - включает проверку на раннию активацию (как это делается в терминале). По умолчанию false
Формат ответа
объект типа TicketSummary
Пример запроса
POST /api/1/ticketregistration/tickets/1d34af10-62cf-4315-a828-01dc8de3a53a/activate HTTP/1.1
Authorization: 161e44c1-89a1-472a-aa1f-bd6b40297961
Token: c0adba90-b8a7-4fcd-9f73-787ae2eed726
Content-Length: 0
Host: center.suo.club:82
Пример ответа
HTTP/1.1 200 OK
Content-Length: 808
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Access-Control-Allow-Origin: *
Date: Mon, 27 May 2019 07:02:25 GMT
Развернуть
{
"Id": "1d34af10-62cf-4315-a828-01dc8de3a53a",
"FullNumber": "M27",
"PinCode": "777668",
"State": 1,
"Products": [
{
"Id": "4d27c128-00fe-47d7-b11a-c6db51d52041",
"Name": "Выдача результата ВУ",
"State": 2,
"StartTime": "2019-05-27T18:30:00",
"CanActivateNow": false,
"IsPending": true
},
{
"Id": "1682a524-9dd0-43f4-94c5-3fb79be809c1",
"Name": "Выдача результата оказания услуги",
"State": 2,
"StartTime": "2019-05-27T18:30:00",
"CanActivateNow": false,
"IsPending": true
},
{
"Id": "ba5f88f1-f6ed-445c-9f34-ca7010756156",
"Name": "Выдача результата оказания услуг (ЕГРП и ГКН) (М76)",
"State": 15,
"StartTime": "2019-05-27T18:30:00",
"CanActivateNow": false,
"IsPending": true
}
],
"ServerId": "78e721bb-c691-7d58-1db5-97882ad01310",
"ShowQuestionBeforeActivation": false
}
GET /api/1/ticketregistration/tickets/{ticketId}/ticketpng?scale={scale}¶
Получение талона в виде изображения для печати.
Если талон привязан к пользователю, требуется передать токен авторизации пользователя, полученный в методе login.
Заголовки
Token (опциональный) - идентификатор внешней системы
Authorization - токен авторизации
Параметры
ticketId - идентификатор талона по записи
scale (опциональный) - коэффициент масштабирования изображения от 0.01 до 30. По умолчанию 1 (96 dpi, для отображения на экране)
Формат ответа
изображение в формате PNG
Пример запроса
GET /api/1/ticketregistration/tickets/1d34af10-62cf-4315-a828-01dc8de3a53a/ticketpng HTTP/1.1
Authorization: 161e44c1-89a1-472a-aa1f-bd6b40297961
Token: c0adba90-b8a7-4fcd-9f73-787ae2eed726
Host: center.suo.club:82
Пример ответа
Тип Multiplier¶
Информация о том, нужно ли запросить у посетителя множитель (количество дел) при взятии талона на эту услугу.
{
"Title": string, // заголовок поля для посетителя (обычно «Количество дел»)
"Limit": int, // максимальное значение множителя, которое может указать посетитель
}
Если у услуги присутствует свойство Multiplier, то после выбора услуги нужно запросить у посетителя множитель («Количество дел»). Допустимые значения – от 1 до Limit включительно. Указанное посетителем значение нужно использовать в методах получения дней и точек (слотов) предварительной записи, а также в методах взятия талона как параметр multiplier.
Если у услуги свойство Multiplier – null, множитель у посетителя запрашивать не нужно.
Когда посетитель берет талон на услугу и указывает несколько дел, то создается мульти-талон с указанным количеством услуг. Все услуги в талоне идут непрерывно друг за другом.
Тип Field¶
Поле дополнительных сведений о посетителе.
{
"Id": Guid, // идентификатор поля
"Name": string, // название поля (для посетителя)
"Type": int, // тип поля из перечисления FieldDataType
"Mask": string, // маска для ввода
"RegularExpression": string, // регулярное выражение, которому должно соответствовать вводимое посетителем значение поля
"IsNullable": bool, // является ли поле обязательным для заполнения
"TicketType": int, // тип талона из перечисления FieldTicketType
}
Тип TicketSummary¶
Талон.
{
"Id": Guid, // идентификатор талона
"FullNumber": string, // номер талона (префикс + номер)
"PinCode": string, // пин-код талона в формате 000000
"State": int, // состояние талона из перечисления TicketState
"Products": [ // услуги в талоне
{
"Id": Guid, // идентификатор услуги в талоне
"Product": Product,
"State": int, // состояние услуги в талоне из перечисления TicketProductState
"StartTime": string, // дата и время записи в формате «YYYY-MM-DDThh:mm:ss»,
"Fields": DataFieldSummary[], // поля доп. сведений
}
],
"ServerId": Guid, // идентификатор филиала
"ActivationAvailability": {
"State": ActivationAvailabilityState,
"ErrorMessage": string, // в случае, когда активация невозможна, здесь указана причина
"ShowQuestionBeforeActivation": bool // нужно ли при активации спросить посетителя «Пригласить вас заранее, если будет возможность?»
}
}
Перечисление FieldDataType¶
0 – целое число
1 – строка
2 – дробное число
3 – дата и время
4 – ссылка
5 – логический
7 – только цифры
8 – русский текст
9 – русский текст и цифры
10 – английский текст
11 – английский текст и цифры
Перечисление FieldTicketType¶
0 – живая очередь, предварительная запись
1 – предварительная запись
2 – живая очередь
Перечисление TicketState¶
0 – Новый талон, еще создаваемый в терминале
1 – Талон, владелец которого ожидает в очереди хотя бы по одной из услуг
2 – Талон, владелец которого приглашен или обслуживается по одной из услуг в талоне
3 – Талон, владелец которого не ожидает в очереди ни по одной из услуг
4 – Мультиталон, владелец которого обслужился по одной из услуг и еще не начал обслуживаться по остальным услугам у того же оператора (посетитель удерживается оператором, чтобы посетителя не вызвал кто-то другой)
Перечисление TicketProductState¶
0 – Зарезервирован
1 – Резерв отменен
2 – Предварительная запись
3 – В очереди
4 – Приглашен
5 – Обслуживается
6 – В персональной очереди
7 – Не явился
8 – Перенаправлен
9 – Обслужен (услуга оказана)
10 – Отменен
12 – Не явился, вызовут повторно
13 – Предварительная запись (не активирован)
14 – Отменен (не был активирован)
15 – Обслуживание еще недоступно
16 – Подтвержден
17 – Услуга не оказана
Перечисление TicketProductState¶
0 – Можно активировать
1 – Нельзя активировать, так как это талон в живую очередь
2 – Нельзя активировать, так как это талон не на сегодняшний день
3 – Нельзя активировать, так как талон не подтвержден
4 – Нельзя активировать по причине того, что талон не требует активацию
5 – Нельзя активировать, талон уже был активирован
6 – Нельзя активировать, так как не наступило время, за которое его можно активировать
7 – Нельзя активировать, так как вышло время активации
8 – Талон отменен
Варианты использования¶
С авторизацией посетителя¶
В данном случае СУО будет знать о всех талонах посетителя, а также будет возможность получить список талонов посетителя методом /api/1/ticketregistration/tickets?offset={offset}&limit={limit}.
Предупреждение
Посетитель – это посетитель, а не сотрудник организации.
Без авторизации посетителя¶
В данном случае СУО не будет знать о всех талонах посетителя, не будет возможности получить список талонов. В этом случае системе нужно самой запоминать идентификаторы талонов для дальнейшего взаимодействия.