Получения списка шаблонов договоров
Вызов метода API возвращает список шаблонов договоров.
Для вызова метода передать X-Login и X-Password в Headers запроса.
Сервер возвращает список шаблонов в JSON формате.
Запрос
GET https://business.selfwork.ru/selfemployed/business/v1/documents/templates
Query Parameters
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| page | int32 | Нет | Номер страницы, отсчёт с 1. Действует только вместе с pageSize |
| pageSize | int32 | Нет | Размер страницы. Без него метод вернёт весь список одним ответом |
Headers
| Name | Type | Description |
|---|---|---|
| X-Login* | string | Логин пользователя |
| X-Password* | string | Пароль пользователя |
Пример
- cURL
curl -X GET "https://business.selfwork.ru/selfemployed/business/v1/documents/templates" \
-H "X-Login: your_login_here" \
-H "X-Password: your_password_here" \
-H "Content-Type: application/json"
Ответы
- 200: OK - Запрос выполнен успешно
- 401: Unauthorized - Не валидные авторизационные данные
- 500: Internal Server Error - Системная ошибка
[
{
"isDefault": true,
"id": 15,
"idLegal": 31,
"name": "First template",
"dateCreate": "2022-09-15 11:16:27",
"content": 135486
}
]
{
"errorCode": 1,
"message": "Access denied"
}
{
"errorCode": 100,
"message": "Internal server error"
}
Описание полей ответа
Успешное выполнение метода
| Ключ | Описание |
|---|---|
| isDefault | Является ли шаблон по умолчанию |
| id | Идентификатор шаблона |
| idLegal | Идентификатор агента |
| name | Название шаблона |
| dateCreate | Дата создания договора |
| content | Содержимое шаблона |
Системная ошибка
| Ключ | Описание |
|---|---|
| errorCode | Код ошибки, возвращенный сервером |
| message | Сообщение сервера, описывающее ошибку |