Skip to content
Мои токены Поддержка
Авторизоваться
Для подтверждения действия введите пароль
Чтобы продолжить, введите пароль для пользователя

Списки фирм

Метод получения списков фирмы
get /scrolls/v1/firms
Запрос
Пример запроса
curl 'https://api.ati.su/scrolls/v1/firms' \
-X 'GET' \
-H 'Authorization: Bearer {authorizationToken}' \
-H 'Content-Type: application/json'
Ответ
200 Success
Модель
[{...}]
ati_id: string

Идентификатор фирмы

contact_id: int32

Идентификатор контакта фирмы

description: string

Описание списка фирм

emoji: string

Эмодзи (html-entity)

fixed: boolean
id: uuid

Идентификатор списка фирм

name: string

Название списка фирм

personal: boolean

Персональный ли список фирм

type: enum
[0, 1, 2]

Тип списка фирм

}]
Пример
[...]
{...}
"ati_id":"string",
"contact_id":0,
"description":"string",
"elements":[...],
{...}
"ati_id":"string",
"firm_name":"string",
"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"list_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"owner_ati_id":"string"
}
],
"emoji":"string",
"fixed":false,
"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name":"string",
"personal":false,
"type":0
}
]
400 Bad Request
Модель
{...}
error: string
reason: string
}
Пример
{...}
"error":"string",
"reason":"string"
}
401 Unauthorized
Модель
{...}
error: string
reason: string
}
Пример
{...}
"error":"string",
"reason":"string"
}
402 Client Error
Модель
{...}
error: string
reason: string
}
Пример
{...}
"error":"string",
"reason":"string"
}
403 Forbidden
Модель
{...}
error: string
reason: string
}
Пример
{...}
"error":"string",
"reason":"string"
}
404 Not Found
Модель
{...}
error: string
reason: string
}
Пример
{...}
"error":"string",
"reason":"string"
}
500 Server Error
Модель
{...}
error: string
reason: string
}
Пример
{...}
"error":"string",
"reason":"string"
}
504 Server Error
Модель
{...}
error: string
reason: string
}
Пример
{...}
"error":"string",
"reason":"string"
}
Метод получения списков фирмы по идентификаторам списокв
post /scrolls/v1/firms/ids
Запрос
Модель
[uuid]
Пример запроса
curl 'https://api.ati.su/scrolls/v1/firms/ids' \
-X 'POST' \
-H 'Authorization: Bearer {authorizationToken}' \
-H 'Content-Type: application/json' \
--data-raw '["3fa85f64-5717-4562-b3fc-2c963f66afa6"]'
Ответ
200 Success
Модель
[{...}]
ati_id: string

Идентификатор фирмы

contact_id: int32

Идентификатор контакта фирмы

description: string

Описание списка фирм

emoji: string

Эмодзи (html-entity)

fixed: boolean
id: uuid

Идентификатор списка фирм

name: string

Название списка фирм

personal: boolean

Персональный ли список фирм

type: enum
[0, 1, 2]

Тип списка фирм

}]
Пример
[...]
{...}
"ati_id":"string",
"contact_id":0,
"description":"string",
"elements":[...],
{...}
"ati_id":"string",
"firm_name":"string",
"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"list_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"owner_ati_id":"string"
}
],
"emoji":"string",
"fixed":false,
"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name":"string",
"personal":false,
"type":0
}
]
400 Bad Request
Модель
{...}
error: string
reason: string
}
Пример
{...}
"error":"string",
"reason":"string"
}
401 Unauthorized
Модель
{...}
error: string
reason: string
}
Пример
{...}
"error":"string",
"reason":"string"
}
402 Client Error
Модель
{...}
error: string
reason: string
}
Пример
{...}
"error":"string",
"reason":"string"
}
403 Forbidden
Модель
{...}
error: string
reason: string
}
Пример
{...}
"error":"string",
"reason":"string"
}
404 Not Found
Модель
{...}
error: string
reason: string
}
Пример
{...}
"error":"string",
"reason":"string"
}
500 Server Error
Модель
{...}
error: string
reason: string
}
Пример
{...}
"error":"string",
"reason":"string"
}
504 Server Error
Модель
{...}
error: string
reason: string
}
Пример
{...}
"error":"string",
"reason":"string"
}
Метод добавления списка фирм
post /scrolls/v1/firms
Запрос
Модель
{...}
ati_id: string

Идентификатор фирмы

contact_id: int32

Идентификатор контакта фирмы

description: string

Описание списка фирм

emoji: string

Эмодзи (html-entity)

fixed: boolean
name: string

Название списка фирм

personal: boolean

Персональный ли список фирм

type: enum
[0, 1, 2]

Тип списка фирм

}
Пример запроса
curl 'https://api.ati.su/scrolls/v1/firms' \
-X 'POST' \
-H 'Authorization: Bearer {authorizationToken}' \
-H 'Content-Type: application/json' \
--data-raw '{"ati_id":"string","contact_id":0,"description":"string","emoji":"string","fixed":false,"name":"string","personal":false,"type":0}'
Ответ
200 Success
Модель
{...}
ati_id: string

Идентификатор фирмы

contact_id: int32

Идентификатор контакта фирмы

description: string

Описание списка фирм

emoji: string

Эмодзи (html-entity)

fixed: boolean
id: uuid

Идентификатор списка фирм

name: string

Название списка фирм

personal: boolean

Персональный ли список фирм

type: enum
[0, 1, 2]

Тип списка фирм

}
Пример
{...}
"ati_id":"string",
"contact_id":0,
"description":"string",
"elements":[...],
{...}
"ati_id":"string",
"firm_name":"string",
"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"list_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"owner_ati_id":"string"
}
],
"emoji":"string",
"fixed":false,
"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name":"string",
"personal":false,
"type":0
}
400 Bad Request
Модель
{...}
error: string
reason: string
}
Пример
{...}
"error":"string",
"reason":"string"
}
401 Unauthorized
Модель
{...}
error: string
reason: string
}
Пример
{...}
"error":"string",
"reason":"string"
}
402 Client Error
Модель
{...}
error: string
reason: string
}
Пример
{...}
"error":"string",
"reason":"string"
}
403 Forbidden
Модель
{...}
error: string
reason: string
}
Пример
{...}
"error":"string",
"reason":"string"
}
404 Not Found
Модель
{...}
error: string
reason: string
}
Пример
{...}
"error":"string",
"reason":"string"
}
500 Server Error
Модель
{...}
error: string
reason: string
}
Пример
{...}
"error":"string",
"reason":"string"
}
504 Server Error
Модель
{...}
error: string
reason: string
}
Пример
{...}
"error":"string",
"reason":"string"
}
Метод изменения списка фирм
put /scrolls/v1/firms
Запрос
Модель
{...}
ati_id: string

Идентификатор фирмы

contact_id: int32

Идентификатор контакта фирмы

description: string

Описание списка фирм

emoji: string

Эмодзи (html-entity)

fixed: boolean
name: string

Название списка фирм

personal: boolean

Персональный ли список фирм

type: enum
[0, 1, 2]

Тип списка фирм

}
Пример запроса
curl 'https://api.ati.su/scrolls/v1/firms' \
-X 'PUT' \
-H 'Authorization: Bearer {authorizationToken}' \
-H 'Content-Type: application/json' \
--data-raw '{"ati_id":"string","contact_id":0,"description":"string","emoji":"string","fixed":false,"name":"string","personal":false,"type":0}'
Ответ
200 Success
Модель
{...}
ati_id: string

Идентификатор фирмы

contact_id: int32

Идентификатор контакта фирмы

description: string

Описание списка фирм

emoji: string

Эмодзи (html-entity)

fixed: boolean
id: uuid

Идентификатор списка фирм

name: string

Название списка фирм

personal: boolean

Персональный ли список фирм

type: enum
[0, 1, 2]

Тип списка фирм

}
Пример
{...}
"ati_id":"string",
"contact_id":0,
"description":"string",
"elements":[...],
{...}
"ati_id":"string",
"firm_name":"string",
"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"list_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"owner_ati_id":"string"
}
],
"emoji":"string",
"fixed":false,
"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name":"string",
"personal":false,
"type":0
}
400 Bad Request
Модель
{...}
error: string
reason: string
}
Пример
{...}
"error":"string",
"reason":"string"
}
401 Unauthorized
Модель
{...}
error: string
reason: string
}
Пример
{...}
"error":"string",
"reason":"string"
}
402 Client Error
Модель
{...}
error: string
reason: string
}
Пример
{...}
"error":"string",
"reason":"string"
}
403 Forbidden
Модель
{...}
error: string
reason: string
}
Пример
{...}
"error":"string",
"reason":"string"
}
404 Not Found
Модель
{...}
error: string
reason: string
}
Пример
{...}
"error":"string",
"reason":"string"
}
500 Server Error
Модель
{...}
error: string
reason: string
}
Пример
{...}
"error":"string",
"reason":"string"
}
504 Server Error
Модель
{...}
error: string
reason: string
}
Пример
{...}
"error":"string",
"reason":"string"
}
Метод удаляет список заданной фирмы
delete /scrolls/v1/firms/{listId}
Запрос
Пример запроса
curl 'https://api.ati.su/scrolls/v1/firms/{listId}' \
-X 'DELETE' \
-H 'Authorization: Bearer {authorizationToken}' \
-H 'Content-Type: application/json'
Ответ
200 Success
Модель
null
Пример
null
400 Bad Request
Модель
{...}
error: string
reason: string
}
Пример
{...}
"error":"string",
"reason":"string"
}
401 Unauthorized
Модель
{...}
error: string
reason: string
}
Пример
{...}
"error":"string",
"reason":"string"
}
402 Client Error
Модель
{...}
error: string
reason: string
}
Пример
{...}
"error":"string",
"reason":"string"
}
403 Forbidden
Модель
{...}
error: string
reason: string
}
Пример
{...}
"error":"string",
"reason":"string"
}
404 Not Found
Модель
{...}
error: string
reason: string
}
Пример
{...}
"error":"string",
"reason":"string"
}
500 Server Error
Модель
{...}
error: string
reason: string
}
Пример
{...}
"error":"string",
"reason":"string"
}
504 Server Error
Модель
{...}
error: string
reason: string
}
Пример
{...}
"error":"string",
"reason":"string"
}
Метод добавления элементов в список фирм
post /scrolls/v1/firms/elements
Запрос
Модель
[{...}]

"Элементы списка

ati_id: string

Идентификатор фирмы

firm_name: string

Название фирмы

id: uuid

Идентификатор элемента списка фирм

list_id: uuid

Идентификатор списка фирм

owner_ati_id: string

Идентификатор фирмы владельца списка

}]
Пример запроса
curl 'https://api.ati.su/scrolls/v1/firms/elements' \
-X 'POST' \
-H 'Authorization: Bearer {authorizationToken}' \
-H 'Content-Type: application/json' \
--data-raw '[{"ati_id":"string","firm_name":"string","id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","list_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","owner_ati_id":"string"}]'
Ответ
200 Success
Модель
[{...}]
status: int32

Статус: 0 - успешно; 2 - у вас нет прав на редактирование этого персонального списка, владелец другой контакт вашей фирмы; 4 - такой список не найден; 6 - такой элемент уже есть в этом списке

}]
Пример
[...]
{...}
"status":0,
"value":{...}
"ati_id":"string",
"firm_name":"string",
"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"list_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"owner_ati_id":"string"
}
}
]
400 Bad Request
Модель
{...}
error: string
reason: string
}
Пример
{...}
"error":"string",
"reason":"string"
}
401 Unauthorized
Модель
{...}
error: string
reason: string
}
Пример
{...}
"error":"string",
"reason":"string"
}
402 Client Error
Модель
{...}
error: string
reason: string
}
Пример
{...}
"error":"string",
"reason":"string"
}
403 Forbidden
Модель
{...}
error: string
reason: string
}
Пример
{...}
"error":"string",
"reason":"string"
}
404 Not Found
Модель
{...}
error: string
reason: string
}
Пример
{...}
"error":"string",
"reason":"string"
}
500 Server Error
Модель
{...}
error: string
reason: string
}
Пример
{...}
"error":"string",
"reason":"string"
}
504 Server Error
Модель
{...}
error: string
reason: string
}
Пример
{...}
"error":"string",
"reason":"string"
}
Метод удаления элементов из списков по их идентификаторам
delete /scrolls/v1/firms/elements
Запрос
Модель
[uuid]

Идентификаторы элементов

Пример запроса
curl 'https://api.ati.su/scrolls/v1/firms/elements' \
-X 'DELETE' \
-H 'Authorization: Bearer {authorizationToken}' \
-H 'Content-Type: application/json' \
--data-raw '["3fa85f64-5717-4562-b3fc-2c963f66afa6"]'
Ответ
200 Success
Модель
[{...}]
status: int32

Статус: 0 - успешно; 2 - у вас нет прав на редактирование этого персонального списка, владелец другой контакт вашей фирмы; 4 - такой список не найден; 6 - такой элемент уже есть в этом списке

value: uuid

Значение

}]
Пример
[...]
{...}
"status":0,
"value":"3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
]
400 Bad Request
Модель
{...}
error: string
reason: string
}
Пример
{...}
"error":"string",
"reason":"string"
}
401 Unauthorized
Модель
{...}
error: string
reason: string
}
Пример
{...}
"error":"string",
"reason":"string"
}
402 Client Error
Модель
{...}
error: string
reason: string
}
Пример
{...}
"error":"string",
"reason":"string"
}
403 Forbidden
Модель
{...}
error: string
reason: string
}
Пример
{...}
"error":"string",
"reason":"string"
}
404 Not Found
Модель
{...}
error: string
reason: string
}
Пример
{...}
"error":"string",
"reason":"string"
}
500 Server Error
Модель
{...}
error: string
reason: string
}
Пример
{...}
"error":"string",
"reason":"string"
}
504 Server Error
Модель
{...}
error: string
reason: string
}
Пример
{...}
"error":"string",
"reason":"string"
}