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

Списки направлений (гео списки)

Метод получения списка Гео списков пользователя
get /scrolls/v1/geo
Запрос
Пример запроса
curl 'https://api.ati.su/scrolls/v1/geo' \
-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

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

is_global: boolean

Глобальный ли список

name: string

Название списка

personal: boolean

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

type: int32

Тип списка

}]
Пример
[...]
{...}
"ati_id":"string",
"contact_id":0,
"description":"string",
"elements":[...],
{...}
"city_id":0,
"city_name":"string",
"country_id":0,
"country_name":"string",
"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"list_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"owner_ati_id":"string",
"region_id":0,
"region_name":"string"
}
],
"emoji":"string",
"fixed":false,
"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"is_global":false,
"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"
}
Метод получения Гео списка по идентификатору
get /scrolls/v1/geo/{listId}
Запрос
Пример запроса
curl 'https://api.ati.su/scrolls/v1/geo/{listId}' \
-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

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

is_global: boolean

Глобальный ли список

name: string

Название списка

personal: boolean

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

type: int32

Тип списка

}
Пример
{...}
"ati_id":"string",
"contact_id":0,
"description":"string",
"elements":[...],
{...}
"city_id":0,
"city_name":"string",
"country_id":0,
"country_name":"string",
"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"list_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"owner_ati_id":"string",
"region_id":0,
"region_name":"string"
}
],
"emoji":"string",
"fixed":false,
"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"is_global":false,
"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/geo/ids
Запрос
Модель
[uuid]

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

Пример запроса
curl 'https://api.ati.su/scrolls/v1/geo/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

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

is_global: boolean

Глобальный ли список

name: string

Название списка

personal: boolean

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

type: int32

Тип списка

}]
Пример
[...]
{...}
"ati_id":"string",
"contact_id":0,
"description":"string",
"elements":[...],
{...}
"city_id":0,
"city_name":"string",
"country_id":0,
"country_name":"string",
"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"list_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"owner_ati_id":"string",
"region_id":0,
"region_name":"string"
}
],
"emoji":"string",
"fixed":false,
"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"is_global":false,
"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/geo
Запрос
Модель
{...}
ati_id: string

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

contact_id: int32

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

description: string

Описание списка

emoji: string

Эмодзи (html-entity)

fixed: boolean
id: uuid

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

is_global: boolean

Глобальный ли список

name: string

Название списка

personal: boolean

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

type: int32

Тип списка

}
Пример запроса
curl 'https://api.ati.su/scrolls/v1/geo' \
-X 'POST' \
-H 'Authorization: Bearer {authorizationToken}' \
-H 'Content-Type: application/json' \
--data-raw '{"ati_id":"string","contact_id":0,"description":"string","elements":[{"city_id":0,"city_name":"string","country_id":0,"country_name":"string","id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","list_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","owner_ati_id":"string","region_id":0,"region_name":"string"}],"emoji":"string","fixed":false,"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","is_global":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

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

is_global: boolean

Глобальный ли список

name: string

Название списка

personal: boolean

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

type: int32

Тип списка

}
Пример
{...}
"ati_id":"string",
"contact_id":0,
"description":"string",
"elements":[...],
{...}
"city_id":0,
"city_name":"string",
"country_id":0,
"country_name":"string",
"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"list_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"owner_ati_id":"string",
"region_id":0,
"region_name":"string"
}
],
"emoji":"string",
"fixed":false,
"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"is_global":false,
"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/geo
Запрос
Модель
{...}
ati_id: string

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

contact_id: int32

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

description: string

Описание списка

emoji: string

Эмодзи (html-entity)

fixed: boolean
id: uuid

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

is_global: boolean

Глобальный ли список

name: string

Название списка

personal: boolean

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

type: int32

Тип списка

}
Пример запроса
curl 'https://api.ati.su/scrolls/v1/geo' \
-X 'PUT' \
-H 'Authorization: Bearer {authorizationToken}' \
-H 'Content-Type: application/json' \
--data-raw '{"ati_id":"string","contact_id":0,"description":"string","elements":[{"city_id":0,"city_name":"string","country_id":0,"country_name":"string","id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","list_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","owner_ati_id":"string","region_id":0,"region_name":"string"}],"emoji":"string","fixed":false,"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","is_global":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

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

is_global: boolean

Глобальный ли список

name: string

Название списка

personal: boolean

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

type: int32

Тип списка

}
Пример
{...}
"ati_id":"string",
"contact_id":0,
"description":"string",
"elements":[...],
{...}
"city_id":0,
"city_name":"string",
"country_id":0,
"country_name":"string",
"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"list_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"owner_ati_id":"string",
"region_id":0,
"region_name":"string"
}
],
"emoji":"string",
"fixed":false,
"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"is_global":false,
"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/geo/{listId}
Запрос
Пример запроса
curl 'https://api.ati.su/scrolls/v1/geo/{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/geo/elements
Запрос
Модель
[{...}]

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

city_id: int32

Идентификатор города

city_name: string

Название города

country_id: int32

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

country_name: string

Название страны

id: uuid

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

list_id: uuid

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

owner_ati_id: string
region_id: int32

Идентификатор региона

region_name: string

Название региона

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

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

}]
Пример
[...]
{...}
"status":0,
"value":{...}
"city_id":0,
"city_name":"string",
"country_id":0,
"country_name":"string",
"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"list_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"owner_ati_id":"string",
"region_id":0,
"region_name":"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/geo/elements
Запрос
Модель
[uuid]

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

Пример запроса
curl 'https://api.ati.su/scrolls/v1/geo/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"
}