Списки фирм

Метод получения списков фирмы

get

/scrolls/v1/firms

CURL

Копировать

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

Ответ

200 Success

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

Пример

Модель

[...]

{...}

"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

}

]

[{...}]

ati_id: string

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

contact_id: int32

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

description: string

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

elements:[{...}]

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

ati_id: string

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

firm_name: string

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

id: uuid

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

list_id: uuid

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

owner_ati_id: string

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

}]

emoji: string

Эмодзи (html-entity)

fixed: boolean

id: uuid

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

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

personal: boolean

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

type: enum

[0, 1, 2]

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

}]

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

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

                        array
                      
                      [
  "3fa85f64-5717-4562-b3fc-2c963f66afa6"
]

        [uuid]

CURL

Копировать

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

Ответ

200 Success

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

Пример

Модель

[...]

{...}

"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

}

]

[{...}]

ati_id: string

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

contact_id: int32

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

description: string

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

elements:[{...}]

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

ati_id: string

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

firm_name: string

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

id: uuid

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

list_id: uuid

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

owner_ati_id: string

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

}]

emoji: string

Эмодзи (html-entity)

fixed: boolean

id: uuid

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

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

personal: boolean

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

type: enum

[0, 1, 2]

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

}]

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

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

body

object

Список фирм

{...}

ati_id: string

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

contact_id: int32

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

description: string

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

emoji: string

Эмодзи (html-entity)

fixed: boolean

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

personal: boolean

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

type: enum

[0, 1, 2]

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

}

CURL

Копировать

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

Ответ

200 Success

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

Пример

Модель

{...}

"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

}

{...}

ati_id: string

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

contact_id: int32

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

description: string

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

elements:[{...}]

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

ati_id: string

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

firm_name: string

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

id: uuid

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

list_id: uuid

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

owner_ati_id: string

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

}]

emoji: string

Эмодзи (html-entity)

fixed: boolean

id: uuid

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

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

personal: boolean

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

type: enum

[0, 1, 2]

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

}

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

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

body

object

Список фирм

{...}

ati_id: string

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

contact_id: int32

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

description: string

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

emoji: string

Эмодзи (html-entity)

fixed: boolean

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

personal: boolean

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

type: enum

[0, 1, 2]

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

}

CURL

Копировать

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

Ответ

200 Success

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

Пример

Модель

{...}

"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

}

{...}

ati_id: string

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

contact_id: int32

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

description: string

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

elements:[{...}]

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

ati_id: string

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

firm_name: string

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

id: uuid

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

list_id: uuid

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

owner_ati_id: string

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

}]

emoji: string

Эмодзи (html-entity)

fixed: boolean

id: uuid

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

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

personal: boolean

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

type: enum

[0, 1, 2]

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

}

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}

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/firms/elements

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

body

array

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

[{...}]

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

ati_id: string

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

firm_name: string

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

id: uuid

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

list_id: uuid

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

owner_ati_id: string

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

}]

CURL

Копировать

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

Ответ

200 Success

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

Пример

Модель

[...]

{...}

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

}

]

[{...}]

status: int32

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

value:{...}

ati_id: string

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

firm_name: string

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

id: uuid

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

list_id: uuid

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

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

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

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

}

Загрузка...

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

Загрузка...