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

Метод получения списка Гео списков пользователя

get

/scrolls/v1/geo

CURL

Копировать

Пример ответа

Ответ

200 Success

Развернуть все Свернуть все

Пример

Модель

[...]

{...}

"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

}

]

[{...}]

ati_id: string

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

contact_id: int32

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

description: string

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

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

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

}]

emoji: string

Эмодзи (html-entity)

fixed: boolean

id: uuid

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

is_global: boolean

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

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

personal: boolean

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

type: int32

Тип списка

}]

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}

listId

uuid

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

CURL

Копировать

Пример ответа

Ответ

200 Success

Развернуть все Свернуть все

Пример

Модель

{...}

"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

}

{...}

ati_id: string

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

contact_id: int32

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

description: string

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

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

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

}]

emoji: string

Эмодзи (html-entity)

fixed: boolean

id: uuid

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

is_global: boolean

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

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

personal: boolean

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

type: int32

Тип списка

}

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

Развернуть все Свернуть все

body

array

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

[uuid]

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

CURL

Копировать

Пример ответа

Ответ

200 Success

Развернуть все Свернуть все

Пример

Модель

[...]

{...}

"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

}

]

[{...}]

ati_id: string

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

contact_id: int32

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

description: string

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

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

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

}]

emoji: string

Эмодзи (html-entity)

fixed: boolean

id: uuid

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

is_global: boolean

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

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

personal: boolean

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

type: int32

Тип списка

}]

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

Развернуть все Свернуть все

body

object

{...}

ati_id: string

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

contact_id: int32

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

description: string

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

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

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

}]

emoji: string

Эмодзи (html-entity)

fixed: boolean

id: uuid

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

is_global: boolean

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

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

personal: boolean

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

type: int32

Тип списка

}

CURL

Копировать

Пример ответа

Ответ

200 Success

Развернуть все Свернуть все

Пример

Модель

{...}

"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

}

{...}

ati_id: string

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

contact_id: int32

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

description: string

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

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

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

}]

emoji: string

Эмодзи (html-entity)

fixed: boolean

id: uuid

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

is_global: boolean

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

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

personal: boolean

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

type: int32

Тип списка

}

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

Развернуть все Свернуть все

body

object

{...}

ati_id: string

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

contact_id: int32

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

description: string

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

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

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

}]

emoji: string

Эмодзи (html-entity)

fixed: boolean

id: uuid

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

is_global: boolean

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

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

personal: boolean

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

type: int32

Тип списка

}

CURL

Копировать

Пример ответа

Ответ

200 Success

Развернуть все Свернуть все

Пример

Модель

{...}

"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

}

{...}

ati_id: string

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

contact_id: int32

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

description: string

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

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

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

}]

emoji: string

Эмодзи (html-entity)

fixed: boolean

id: uuid

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

is_global: boolean

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

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

personal: boolean

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

type: int32

Тип списка

}

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}

listId

uuid

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

CURL

Копировать

Пример ответа

Ответ

200 Success

Развернуть все Свернуть все

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

Развернуть все Свернуть все

body

array

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

[{...}]

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

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

Копировать

Пример ответа

Ответ

200 Success

Развернуть все Свернуть все

Пример

Модель

[...]

{...}

"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"

}

]

[{...}]

status: int32

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

value:{...}

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

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

}

}]

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

Развернуть все Свернуть все

body

array

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

[uuid]

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

CURL

Копировать

Пример ответа

Ответ

200 Success

Развернуть все Свернуть все

Пример

Модель

[...]

{...}

"status":0,

"value":"3fa85f64-5717-4562-b3fc-2c963f66afa6"

}

]

[{...}]

status: int32

value: uuid

Значение

}]

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

}

Загрузка...

Развернуть все Свернуть все

Загрузка...