API User

    Con esta API puede obtener los metadatos y los listados de usuarios.

    Endpoint

    • URL: api/v2/user.php
    • Necesita iniciar sesión: Si
    • Métodos: GET

    Argumentos

    • token str: Token de utilización de la API. (Obtener aquí)
    • id int: Id del usuario, en caso de no estar presente devuelve la lista de usuarios.

    Devuelve

    • 503: Sistema en matenimiento (application/json)
    • 405: Método inválido (application/json)
    • 404: Curso no encontrado (application/json)
    • 400: Argumentos inválidos (application/json)
    • 200: Datos del usuario (application/json)

    Ejemplos

    Obtención de la lista de usuarios

    El siguiente ejemplo le permite recibir la lista de usuarios completa.

    Nota: Solo tendrá acceso a los usuarios que fueron autorizados para su token.

    Nota 2: Los token correspondiente a usuarios en modo admin no podrán ver la lista de usuarios completa (solo aplica a los administradores globales de sitio).

    Request

    • Request: GET api/v2/user.php
    • Arguments:
      • token → 56bc8.....673b4

    Response

    • Headers: Content Type: application/json
    • Body:
      [
    404,
    572,
    ...
    8443,
    8487
]

    Obtención de los datos del usuario

    El siguiente ejemplo le permite recibir los datos de un usuario específico.

    Nota: Solo tendrá acceso a los usuarios que fueron autorizados para su token

    Request

    • Request: GET api/v2/user.php
    • Arguments:
      • token → 56bc8.....673b4
      • id → 7

    Response

    • Headers: Content Type: application/json
    • Body:
      {
    "data": {
        "id": 7,
        "username": "fede",
        "name": "Federico Vera",
        "email": "********",
        "enrollments": 19,
        "certificates": 1,
        "update": "2019-08-22 07:49:47",
        "verified": 1,
        "first": "Federico Luis",
        "last": "Vera",
        "organization": "Campus Virtual - UNC"
    },
    "enrollments": [
        {
            "name": "Aprendo Ajedrez en la UNC",
            "link": "https://edx.campusvi....001+2018_T1",
            "id": 4,
            "date": "2018-04-20 00:00:00",
            "mode": "honor",
            "certificate": 1,
            "grade": 0.7,
            "uuid": "56bc8607e8e345848d74190641a673b4"
        },
        ....
        {
            "name": "2° Edición - Formación en género y abordaje de violencias",
            "link": "https://edx.campusvi....001