Lista de usuarios asociados a un grupo

Última revisión: 15 Sep 2022

Se parte del siguiente caso de uso:

  • Propietario del grupo: solo disponible para usuarios del grupo autorizado para el API que solicita el servicio.
Descripción
SERVICIO USER LIST GROUPCODE
URL /api/v3/users/group/{groupCode}
SEGURIDAD
METHOD GET
RESPONSE 200: HTTP status code 200/OK – Solicitud recibida.

Response content type: application/json
Donde encontrarás una lista del objeto USERLIST.

    [
     {
       "code": "string",
       "email": "string",
       "name": "string",
       "surname": "string",
       "mobile": "string"
     }
    ]

Respuestas alternativas en caso de fallo: se devolverán HTTP status codes distintos de 200/OK. En ese caso siempre se devolverá un JSON que describe el problema:

    {
      "code": "string",
      "type": "string",
      "message": "string",
      "trace" : "string"
    }

Código de Errores asociados a este método:

Respuesta correcta:

[
    {
      "code": "string",
      "email": "string",
      "name": "string",
      "surname": "string",
      "mobile": "string"
    }
]

Respuesta para groupCode que no exista:

{
    "code": 307,
    "type": "Error",
    "message": "Group not found with specified code",
    "trace": "b54dc0f7-1862-40a9-882d-70dd6554ecc2"
}

Respuesta para credenciales del API incorrectas:

{
    "code": 401,
    "type": "ERROR",
    "message": "Invalid credentials",
    "trace": "30ec3b02-dd0a-4768-8c92-b7660057f5ff"
}

Respuesta para consultas sobre grupos que SÍ EXISTEN pero no están asociados al GRUPO sobre los que el API que hace la consulta esté autorizada:

{
    "code": 91,
    "type": "Error",
    "message": "Sorry, the application does not have access rights to the requested resource",
    "trace": "0714703a-c35e-4852-884c-3bf9163fa887"
}

results matching ""

    No results matching ""