Получение Cписка сотрудников

Метод Get List of Managers позволяет получить список всех Сотрудников.

Список сотрудников может быть показан в рамках конкретной страницы. Для этого необходимо передать следующие аргументы:

  • номер страницы (page);
  • количество элементов на странице (per_page).

Список сотрудников может быть отсортирован по любому полю. Для сортировки списка менеджеров должны быть переданы следующие аргументы:

  • название поля для сортировки по нему (sorting[field]);
  • режим сортировки: по возрастанию или по убыванию (sorting[reversed]).

Список сотрудников может быть отфильтрован по:

  • дате создания (filters[created_at]);
  • дате обновления (filters[updated_at]);
  • статусу (filters[status]).
 GET /api/vendor/v1/managers.json?api_token={api_token}

Аргументы

Название

Тип параметра

Тип данных

Обязательный/ 
Опциональный

Описание

api_tokenquerystringОбязательныйAPI токен Сотрудника, выполняющего операцию (см. Просмотр и обновление информации о Сотруднике в ActivePlatform. Руководство по Панели управления Оператора).

page

query

integer

Опциональный

Возвращается список менеджеров по указанному номеру страницы.

per_page

query

integer

Опциональный

Установка числа элементов на странице.

sorting[field]

query

string

Опциональный

Сортировка списка по указанному полю.

sorting[reversed]

query

string

Опциональный

Установка режима сортировки: по возрастанию или по убывания:

  • true - список будет отсортирован по убыванию;
  • false - список будет отсортирован по возрастанию (используется по умолчанию).

filters[created_at]

query

date

Опциональный

Фильтрация списка по дате создания.

filters[updated_at]

query

date

Опциональный

Фильтрация списка по дате обновления.

filters[status]

query

string

Опциональный

Фильтрация списка по статусу.

Модель ответа

Название

Тип данных

Описание

id

integer

ID сотрудника.

status

string

Статус сотрудника: 

  • active - доступ в Панель управления Оператора разрешен; 
  • inactive - доступ в Панель управления Оператора заблокирован.

name

string

Имя сотрудника.

created_at

data

Дата и время создания сотрудника.

updated_at

data

Дата и время последнего изменения сотрудника.

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

 GET http://billing.activeplatform.com:80/api/vendor/v1/managers.json?api_token=654321

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

[
  {
    "id": 1,
    "status": "active",
    "name": "AK",
    "created_at": "2014-08-20T17:41:53.466+03:00",
    "updated_at": "2016-05-24T12:19:25.693+03:00"
  },
  {
    "id": 2000115,
    "status": "active",
    "name": "Anastasiya S",
    "created_at": "2014-12-01T15:32:46.202+03:00",
    "updated_at": "2015-08-17T14:39:54.611+03:00"
  }
]