Списки фирм

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

get /scrolls/v1/firms

Модель и примеры
Консоль

Запрос

Пример запроса

CURL
1C

curl 'https://api.ati.su/scrolls/v1/firms' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("GET", "https://api.ati.su", "/scrolls/v1/firms");

Ответ

200 Success

Модель
Пример

[{...}]

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

}

401 Unauthorized

Модель
Пример

{...}

error: string

reason: string

}

402 Client Error

Модель
Пример

{...}

error: string

reason: string

}

403 Forbidden

Модель
Пример

{...}

error: string

reason: string

}

404 Not Found

Модель
Пример

{...}

error: string

reason: string

}

500 Server Error

Модель
Пример

{...}

error: string

reason: string

}

504 Server Error

Модель
Пример

{...}

error: string

reason: string

}

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

post /scrolls/v1/firms/ids

Модель и примеры
Консоль

Запрос

Модель

[uuid]

Пример запроса

CURL
1C

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

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("POST", "https://api.ati.su", "/scrolls/v1/firms/ids", "[""3fa85f64-5717-4562-b3fc-2c963f66afa6""]");

Ответ

200 Success

Модель
Пример

[{...}]

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

}

401 Unauthorized

Модель
Пример

{...}

error: string

reason: string

}

402 Client Error

Модель
Пример

{...}

error: string

reason: string

}

403 Forbidden

Модель
Пример

{...}

error: string

reason: string

}

404 Not Found

Модель
Пример

{...}

error: string

reason: string

}

500 Server Error

Модель
Пример

{...}

error: string

reason: string

}

504 Server Error

Модель
Пример

{...}

error: string

reason: string

}

Метод добавления списка фирм

post /scrolls/v1/firms

Модель и примеры
Консоль

Запрос

Модель

{...}

ati_id: string

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

contact_id: int32

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

description: string

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

emoji: string

Эмодзи (html-entity)

fixed: boolean

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

personal: boolean

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

type: enum

[0, 1, 2]

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

}

Пример запроса

CURL
1C

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}'

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("POST", "https://api.ati.su", "/scrolls/v1/firms", "{""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

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

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

}

401 Unauthorized

Модель
Пример

{...}

error: string

reason: string

}

402 Client Error

Модель
Пример

{...}

error: string

reason: string

}

403 Forbidden

Модель
Пример

{...}

error: string

reason: string

}

404 Not Found

Модель
Пример

{...}

error: string

reason: string

}

500 Server Error

Модель
Пример

{...}

error: string

reason: string

}

504 Server Error

Модель
Пример

{...}

error: string

reason: string

}

Метод изменения списка фирм

put /scrolls/v1/firms

Модель и примеры
Консоль

Запрос

Модель

{...}

ati_id: string

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

contact_id: int32

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

description: string

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

emoji: string

Эмодзи (html-entity)

fixed: boolean

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

personal: boolean

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

type: enum

[0, 1, 2]

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

}

Пример запроса

CURL
1C

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}'

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("PUT", "https://api.ati.su", "/scrolls/v1/firms", "{""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

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

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

}

401 Unauthorized

Модель
Пример

{...}

error: string

reason: string

}

402 Client Error

Модель
Пример

{...}

error: string

reason: string

}

403 Forbidden

Модель
Пример

{...}

error: string

reason: string

}

404 Not Found

Модель
Пример

{...}

error: string

reason: string

}

500 Server Error

Модель
Пример

{...}

error: string

reason: string

}

504 Server Error

Модель
Пример

{...}

error: string

reason: string

}

Метод удаляет список заданной фирмы

delete /scrolls/v1/firms/{listId}

Модель и примеры
Консоль

Запрос

Пример запроса

CURL
1C

curl 'https://api.ati.su/scrolls/v1/firms/{listId}' \
  -X 'DELETE' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("DELETE", "https://api.ati.su", "/scrolls/v1/firms/{listId}");

Ответ

200 Success

Модель
Пример

null

400 Bad Request

Модель
Пример

{...}

error: string

reason: string

}

401 Unauthorized

Модель
Пример

{...}

error: string

reason: string

}

402 Client Error

Модель
Пример

{...}

error: string

reason: string

}

403 Forbidden

Модель
Пример

{...}

error: string

reason: string

}

404 Not Found

Модель
Пример

{...}

error: string

reason: string

}

500 Server Error

Модель
Пример

{...}

error: string

reason: string

}

504 Server Error

Модель
Пример

{...}

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
1C

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"}]'

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("POST", "https://api.ati.su", "/scrolls/v1/firms/elements", "[{""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 - такой элемент уже есть в этом списке

value:{...}

ati_id: string

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

firm_name: string

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

id: uuid

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

list_id: uuid

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

owner_ati_id: string

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

}

}]

400 Bad Request

Модель
Пример

{...}

error: string

reason: string

}

401 Unauthorized

Модель
Пример

{...}

error: string

reason: string

}

402 Client Error

Модель
Пример

{...}

error: string

reason: string

}

403 Forbidden

Модель
Пример

{...}

error: string

reason: string

}

404 Not Found

Модель
Пример

{...}

error: string

reason: string

}

500 Server Error

Модель
Пример

{...}

error: string

reason: string

}

504 Server Error

Модель
Пример

{...}

error: string

reason: string

}

Метод удаления элементов из списков по их идентификаторам

delete /scrolls/v1/firms/elements

Модель и примеры
Консоль

Запрос

Модель

[uuid]

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

Пример запроса

CURL
1C

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

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("DELETE", "https://api.ati.su", "/scrolls/v1/firms/elements", "[""3fa85f64-5717-4562-b3fc-2c963f66afa6""]");

Ответ

200 Success

Модель
Пример

[{...}]

status: int32

value: uuid

Значение

}]

400 Bad Request

Модель
Пример

{...}

error: string

reason: string

}

401 Unauthorized

Модель
Пример

{...}

error: string

reason: string

}

402 Client Error

Модель
Пример

{...}

error: string

reason: string

}

403 Forbidden

Модель
Пример

{...}

error: string

reason: string

}

404 Not Found

Модель
Пример

{...}

error: string

reason: string

}

500 Server Error

Модель
Пример

{...}

error: string

reason: string

}

504 Server Error

Модель
Пример

{...}

error: string

reason: string

}