Home

Описание web-api платформы СОКОЛ

Шаблон строки запросов http://site.root.url/api/v1/…

Пользователи(Users)

Тип запроса	Шаблон url	Описание
GET	/api/v1/user/list/	Возвращает список пользователей
GET	/api/v1/user/[id]/	Возвращает описание пользователя по идентификатору id
POST	/api/v1/user/[id]/	Изменяет пользователя с идентификатором id. Параметры пользователя передаются в параметрах запроса. Если id не указывается то создаётся новый пользователь
DELETE	/api/v1/user/[id]/	Удаляет пользователя с идентификатором id

Подразделения Departments

Тип запроса	Шаблон url	Описание
GET	/api/v1/department/list/	Возвращает список подразделений
GET	/api/v1/department/[id]/	Возвращает описание подразделения по идентификатору id
POST	/api/v1/department/[id]/	Изменяет подразделения с идентификатором id. Параметры подразделения передаются в параметрах запроса. Если id не указывается то создаётся новое подразделение
DELETE	/api/v1/department/[id]/	Удаляет подразделение с идентификатором id

Типы запросов(RequestType)

Тип запроса	Шаблон url	Описание
GET	/api/v1/reqType/list/	Возвращает список типов запросов
GET	/api/v1/reqType/[id]/	Возвращает описание типа запросов по идентификатору id
POST	/api/v1/reqType/[id]/	Изменяет тип запроса с идентификатором id. Параметры типа запроса передаются в параметрах запроса. Если id не указывается то создаётся новый тип запроса
DELETE	/api/v1/reqType/[id]/	Удаляет тип запроса с идентификатором id

Запросы (Requests)

Тип запроса	Шаблон url	Описание
GET	/api/v1/request/list/	Возвращает список запросов
GET	/api/v1/request/[id]/	Возвращает описание запроса по идентификатору id
POST	/api/v1/request/[id]/	Изменяет запрос с идентификатором id.Параметры запроса передаются в параметрах http запроса. Если id не указывается то создаётся новый тип запроса.
DELETE	/api/v1/request/[id]/	Удаляет запрос с идентификатором id