Перейти к основному контенту

Список агентов

POST /agent/list HTTP/1.1
{
  "Body": {
    "Params": {
      "name":"agent",
      "columns": ["nowBalance", "credit", "rnn", "lastPaymentDate", "balancePlusSub", "blocked", "idParent", "namePrint", "leader", "email", "phone", "bbik", "bAccount", "contract", "ownerType"]
    }
  }
}
  • idAgent - Идентификатор агента, под которым будет поиск агентов. Необязательное поле, по умолчанию берется авторизованный агент.
  • subOn - 1 - включить или 0 - не включать в список субагентов. Необязательное поле. По умолчанию 0. Будет удалено в будущих обновлениях. Рекомендуется использовать тег sub.
  • sub - 0 - только агент, 1 - только субагенты всех уровней, 2 - все, агент и субагенты всех уровней, 3 - только субагенты (следующего от агента уровня), 4 - агент и субагенты (следующего от агента уровня). Необязательное поле.
  • name - Наименование агента. Для поиска агента по имени или его части. Необязательное поле. Если параметра нет, то вернутся все агенты.
  • rnn - РНН агента. Для поиска агента по РНН. Необязательное поле. Если параметра нет, то вернутся все агенты.
  • address - Адрес агента. Для поиска агента по адресу или его части. Необязательное поле. Если параметра нет, то вернутся все агенты.
  • idAgentSearch - Идентификатор агента. Для поиска агента по номеру. Необязательное поле. Если параметра нет, то вернутся все агенты.
  • idTerminal - Идентификатор терминала. Для поиска агента по терминалу. Необязательное поле. 
  • login - Логин пользователя. Для поиска агента по логину пользователя. Можно указать часть логина. Необязательное поле. 
  • cellPhone - Телефон пользователя. Для поиска агента по телефону пользователя. Можно указать часть телефона. Необязательное поле.
  • columns - массив с перечислением дополнительных полей для каждого агента. Необязательное поле. Если параметра нет, то вернется только idAgent,agentName,parentName,agentAddress.

Доступны следующие значения для columns:

  • nowBalance - текущий баланс;
  • credit - кредитный лимит;
  • rnn - рнн;
  • bin - ИИН/БИН;
  • blocked - если 1 - агент заблокирован, нет или 0 - нормальный агент;
  • lastPaymentDate - дата последнего платежа (использовать только если действительно нужно - запрос будет работать дольше);
  • balancePlusSub - "баланс включая субагентов" (рассчитывается как "баланс агента" + sum(NowBalance + Credit) по всей ветке дерева субагентов) (использовать только если действительно нужно - запрос будет работать дольше);
  • idParent - идентификатор агента родителя;
  • namePrint - Наименование агента для бух. документов;
  • leader - ФИО первого руководителя;
  • created - Дата регистрации, Дата создания агента в ПС;
  • email - E-mail субагента;
  • phone - Контактный телефон;
  • bbik - Банковские реквизиты, БИК банка;
  • bAccount - Банковские реквизиты, счет в банке;
  • contract - номер и дата договора субагента;
  • ownerType - Юридическая форма, Форма собственности: 0 - ИП, 1 - ТОО;
  • isSystem - агент системный - 1 или нет - 0.
 

Ответ:

{
  "Code": 0,
  "Message": "Success",
  "QueryData": [
    {
      "Rows": [
        {
          "idAgent": 314,
          "agentName": "TestAgent TOO",
          "parentName": "Тестовые агенты",
          "agentAddress": "ул.Чкалова 48, оф.324",
          "credit": 6100001.0000,
          "rnn": "123456789123",
          "blocked": 0,
          "lastPaymentDate": "20200612130927",
          "balancePlusSub": -441515033.8743,
          "idParent": 1914,
          "namePrint": "TestAgent Товарищество с Ограниченной Ответственностью",
          "leader": "leader",
          "email": "test@gmail.com",
          "phone": "+7 (7152) 52-08-93",
          "bbik": "bik",
          "bAccount": "bank number",
          "contract": "Серия 1234",
          "ownerType": 1
        },
        {
          "idAgent": 7862,
          "agentName": "Test Jassefi Agent ТОО",
          "parentName": "TestAgent TOO",
          "agentAddress": "111",
          "nowBalance": 0.0000,
          "credit": 100000.0000,
          "balancePlusSub": 0.0000,
          "idParent": 314,
          "namePrint": "Test Jassefi Agent ТОО",
          "bbik": "HHHHHHHH"
        }
      ]
    }
  ]
}