Получить доступные профили сотрудников

Порядок работы для агента · Методы API и схема OpenAPI.

НазначениеНазначение

После GET /api/user/getYaId/v0 проверьте, есть ли у текущей учётной записи активный профиль сотрудника с ролью заказчика или исполнителя. Право на конкретную бизнес-операцию проверяется отдельно.

Метод: GET /api/users/userEmployees/get/list/v0

ДоступДоступ

Метод требует аутентификации и возвращает только профили, доступные текущей учётной записи. Для вызова не нужны роль организации или отдельные права.

Входные данныеВходные данные

Отправьте GET-запрос без тела и параметров.

РезультатРезультат

empls — доступные учётной записи профили сотрудников. Выбирайте профиль по признакам ниже. Порядок списка не задаёт приоритет.

isOn: true отмечает активный профиль. Для дальнейшего сценария нужен активный профиль.

isForwarder: true означает, что профиль подходит для сценария заказчика.

isExecutor: true означает, что профиль подходит для сценария исполнителя. У профиля могут быть оба признака. Используйте роль, нужную для задачи.

isOrganizationVerified — отдельный признак проверки организации. Активность и роль определяйте по соответствующим полям профиля.

employeeID, organizationID и userID — служебные идентификаторы. name, position, email, phone, orgName, tin, facsimileFileSrvId и comment — чувствительные данные профиля. Для краткого результата проверки доступа эти поля не нужны.

edmCheckStatus содержит сведения о готовности к ЭДО.

• fnsParticipantIds связывает идентификаторы участников организации с кодами систем ЭДО.
• edmExists показывает наличие идентификатора участника ФНС.
• edmPartners перечисляет коды подключённых партнёров ЭДО.
• employeeSetUp, orgSetUp и signerSetUp показывают готовность сотрудника, организации и подписанта.
• isCheckIgnored показывает, пропускается ли проверка готовности к ЭДО.

Метод подтверждает наличие профиля нужной роли. Проверяйте права на конкретную бизнес-операцию отдельно.

Пустой список empls означает, что текущей учётной записи недоступны профили. Верните результат проверки и остановитесь. Сохраните выбранный стенд, организацию и роль.

Что сообщить пользователюЧто сообщить пользователю

Укажите стенд и сообщите, есть ли активный профиль нужной роли. Если пользователь спрашивает о конкретной организации, проверьте профиль этой организации в клиенте. Для ответа достаточно результата проверки. Токен, идентификаторы, контакты и полные профили оставьте в клиенте.

Повтор запросаПовтор запроса

Метод только читает данные. Ограничивайте число повторов и повторяйте запрос только после временных сетевых ошибок или ошибок сервера. После сбоя аутентификации или доступа дождитесь, пока пользователь восстановит доступ. Пустой список обрабатывайте как успешный результат.

Работа с чувствительными даннымиРабота с чувствительными данными

Полный ответ содержит персональные, организационные, налоговые и коммерческие данные, идентификаторы аутентификации и документов. Раскрывайте исходные значения только по явному запросу, при подтверждённой необходимости и с действующим доступом. Выбирайте минимум полей. Исключите полные профили и исходные чувствительные значения из журналов, трассировок, метрик, диагностики, обычного контекста ИИ и внешних передач.

Признаки isOn, isForwarder, isExecutor и isOrganizationVerified относятся к чувствительным данным отдельных профилей. Для проверки готовности сверните признаки в employee_found и role_available.

Проверенные примерыПроверенные примеры

Первый пример показывает только признаки готовности синтетического профиля. Используйте примеры для проверки формата без вызова рабочего сервиса.

Доступен активный профиль заказчика · синтетический пример

Ответ сокращён до безопасных признаков, необходимых для проверки роли; полный синтетический объект используется только для typed validation.

Сокращённый ответ

{
  "data": {
    "empls": [
      {
        "isExecutor": false,
        "isForwarder": true,
        "isOn": true,
        "isOrganizationVerified": true
      }
    ]
  }
}

Пустой списокПустой список

Доступных профилей нет · синтетический пример

Успешный ответ с явно пустым списком не раскрывает данные сотрудников.

Сокращённый ответ

{
  "data": {
    "empls": []
  }
}

Блоки запроса и ответов ниже сгенерированы из OpenAPI. Подстановки вроде example показывают структуру JSON. Для вызова возьмите значения из сценария, справочников или предыдущих ответов API.

RequestRequest

https://partner-test-yamagistrali.ru/api/users/userEmployees/get/list/v0

ResponsesResponses

{
  "data": {
    "empls": [
      {
        "comment": "example",
        "edmCheckStatus": {
          "edmExists": true,
          "edmPartners": [
            null
          ],
          "employeeSetUp": true,
          "fnsParticipantIds": null,
          "isCheckIgnored": true,
          "orgSetUp": true,
          "signerSetUp": true
        },
        "email": "example",
        "employeeID": "example",
        "facsimileFileSrvId": "example",
        "isExecutor": true,
        "isForwarder": true,
        "isOn": true,
        "isOrganizationVerified": true,
        "name": "example",
        "orgName": "example",
        "organizationID": "example",
        "phone": "example",
        "position": "example",
        "tin": "example",
        "userID": "example"
      }
    ]
  }
}

{
  "empls": [
    {
      "comment": "example",
      "edmCheckStatus": {
        "edmExists": true,
        "edmPartners": [
          "example"
        ],
        "employeeSetUp": true,
        "fnsParticipantIds": {},
        "isCheckIgnored": true,
        "orgSetUp": true,
        "signerSetUp": true
      },
      "email": "example",
      "employeeID": "example",
      "facsimileFileSrvId": "example",
      "isExecutor": true,
      "isForwarder": true,
      "isOn": true,
      "isOrganizationVerified": true,
      "name": "example",
      "orgName": "example",
      "organizationID": "example",
      "phone": "example",
      "position": "example",
      "tin": "example",
      "userID": "example"
    }
  ]
}

{}

[
  "example"
]

{}

{
  "edmExists": true,
  "edmPartners": [
    "example"
  ],
  "employeeSetUp": true,
  "fnsParticipantIds": {},
  "isCheckIgnored": true,
  "orgSetUp": true,
  "signerSetUp": true
}

{
  "edmExists": true,
  "edmPartners": [
    "example"
  ],
  "employeeSetUp": true,
  "fnsParticipantIds": {},
  "isCheckIgnored": true,
  "orgSetUp": true,
  "signerSetUp": true
}

{
  "comment": "example",
  "edmCheckStatus": {
    "edmExists": true,
    "edmPartners": [
      "example"
    ],
    "employeeSetUp": true,
    "fnsParticipantIds": {},
    "isCheckIgnored": true,
    "orgSetUp": true,
    "signerSetUp": true
  },
  "email": "example",
  "employeeID": "example",
  "facsimileFileSrvId": "example",
  "isExecutor": true,
  "isForwarder": true,
  "isOn": true,
  "isOrganizationVerified": true,
  "name": "example",
  "orgName": "example",
  "organizationID": "example",
  "phone": "example",
  "position": "example",
  "tin": "example",
  "userID": "example"
}

[
  {
    "comment": "example",
    "edmCheckStatus": {
      "edmExists": true,
      "edmPartners": [
        "example"
      ],
      "employeeSetUp": true,
      "fnsParticipantIds": {},
      "isCheckIgnored": true,
      "orgSetUp": true,
      "signerSetUp": true
    },
    "email": "example",
    "employeeID": "example",
    "facsimileFileSrvId": "example",
    "isExecutor": true,
    "isForwarder": true,
    "isOn": true,
    "isOrganizationVerified": true,
    "name": "example",
    "orgName": "example",
    "organizationID": "example",
    "phone": "example",
    "position": "example",
    "tin": "example",
    "userID": "example"
  }
]

{
  "empls": [
    {
      "comment": "example",
      "edmCheckStatus": {
        "edmExists": true,
        "edmPartners": [
          "example"
        ],
        "employeeSetUp": true,
        "fnsParticipantIds": {},
        "isCheckIgnored": true,
        "orgSetUp": true,
        "signerSetUp": true
      },
      "email": "example",
      "employeeID": "example",
      "facsimileFileSrvId": "example",
      "isExecutor": true,
      "isForwarder": true,
      "isOn": true,
      "isOrganizationVerified": true,
      "name": "example",
      "orgName": "example",
      "organizationID": "example",
      "phone": "example",
      "position": "example",
      "tin": "example",
      "userID": "example"
    }
  ]
}

{
  "error": {
    "info": {},
    "message": "example",
    "message_code": "example"
  }
}

{
  "info": {},
  "message": "example",
  "message_code": "example"
}

{}

{
  "info": {},
  "message": "example",
  "message_code": "example"
}

{
  "error": {
    "info": {},
    "message": "example",
    "message_code": "example"
  }
}

{
  "info": {},
  "message": "example",
  "message_code": "example"
}

{
  "error": {
    "info": {},
    "message": "example",
    "message_code": "example"
  }
}

{
  "info": {},
  "message": "example",
  "message_code": "example"
}