Documentação técnica para LMS - Pesquisa de usuários

Neste tópico, descreve-se o método de pesquisa de usuários na plataforma EAD, com parâmetros recebidos e saída de cada um deles.

1. Método

core_user_get_users

2. Parâmetros

Parâmetro	Descrição
criteria[0][key]	Chave de pesquisa. Valores permitidos: - email - username - firstname - lastname
criteria[0][value]	Valor a ser pesquisado. Informar o valor a ser pesquisado na respectiva chave de pesquisa.

Atenção
Deve ser utilizada a estrutura de chave/valor. Ou seja, na ordem. O parâmetro de chave, e posteriormente, o valor a ser pesquisado. Se for uma combinação, informar a próxima chave, e o valor. Veja no exemplo da url para que fique mais claro.

3. Exemplo de chamada via URL

http://moodle.edusoft.net/webservice/rest/server.php?wstoken=b79adc6effd3eb52cc362ed1fa7eccc0&wsfunction=core_user_get_users&moodlewsrestformat=json&criteria[0][key]=firstname&criteria[0][value]=Anna+Laura+Felizardo+Magre+de

4. Exemplo de retorno de sucesso

{
  "users": [
    {
      "id": 56218,
      "username": "[email protected]",
      "firstname": "Anna Laura Felizardo de",
      "lastname": "Amorim",
      "fullname": "Anna Laura Felizardo de Amorim",
      "email": "[email protected]",
      "department": "",
      "idnumber": "116157",
      "firstaccess": 0,
      "lastaccess": 0,
      "auth": "ws",
      "suspended": true,
      "confirmed": true,
      "lang": "pt_br",
      "theme": "",
      "timezone": "99",
      "mailformat": 1,
      "profileimageurlsmall": "http://moodle.edusoft.net/theme/image.php/_s/boost/core/1614655522427/u/f2",
      "profileimageurl": "http://moodle.edusoft.net/theme/image.php/_s/boost/core/161462244427/u/f1"
    }
  ],
  "warnings": []
}

Dos dados retornados acima, tratamos apenas os seguintes (os demais são ignorados):

id: Código EAD da pessoa
username: Usuário da pessoa
fullname: Nome completo da pessoa
email: E-mail da pessoa

5. Exemplo de retorno de erro

{
    "exception": "invalid_parameter_exception",
    "errorcode": "invalidparameter",
    "message": "Valor inválido de parâmetro detectado",
    "debuginfo": "Missing required key in single structure: criteria"
}

6. Exemplo de chamada no PostMan

08. Pesquisa de usuários (Sincronização de pessoas) - core_user_get_users

Ainda há dúvidas? Se você preferir retire suas dúvidas com o nosso suporte, clique aqui e abra um chamado para atendimento.

Voltar