Skip to content

api-accounts.ru.md

Latest commit

 

History

History
87 lines (53 loc) · 2.61 KB

api-accounts.ru.md

File metadata and controls

87 lines (53 loc) · 2.61 KB
Raw

Учётные записи (Accounts)

Класс Comindware\Tracker\API\Service\AccountService.

Получение аватар

Метод API: POST /Api/Account/Avatar

public function AccountService::getAvatars(array $accounts): FileStruct[]

Список параметров

  • $accounts — Массив учётных записей, чьи аватары надо получить. Элементами массива могут быть идентификаторы или экземпляры Account (можно смешивать в одном запросе оба типа).

Возвращаемые значения

Массив FileStruct — аватары указанных учётных записей.

Ошибки

Исключения, вбрасываемые Client::sendRequest.

Comindware\Tracker\API\Exception\UnexpectedValueException если сервер вернул неожиданное значение.

Пример

// $api — instance of Comindware\Tracker\API\Api
$files = $api->accounts()->getAvatars(['account.123', 'account.456']);

Получение всех учётных записей

Метод API: GET /Api/Account

public function AccountService::getAll(): Account[]

Возвращаемые значения

Массив Account — учётные записи.

Ошибки

Исключения, вбрасываемые Client::sendRequest.

Comindware\Tracker\API\Exception\UnexpectedValueException если сервер вернул неожиданное значение.

Пример

// $api — instance of Comindware\Tracker\API\Api
$accounts = $api->accounts()->getAll();

Получение учётной записи

Метод API: GET /Api/Account/{id}

public function AccountService::get(string $id): Account

Список параметров

  • $id — Идентификатор учётной записи.

Возвращаемые значения

Account — запрошенная учётная запись.

Ошибки

Исключения, вбрасываемые Client::sendRequest.

Comindware\Tracker\API\Exception\UnexpectedValueException если сервер вернул неожиданное значение.

Пример

// $api — instance of Comindware\Tracker\API\Api
$account = $api->accounts()->get('account.123');