API Group

    Con esta API puede obtener los metadatos y los miembros de un determinado grupo.

    Endpoint

    • URL: api/v2/group.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 grupo, en caso de no estar presente devuelve la lista de grupos.
    • users bool: Incluir usuarios del grupo (no tiene efecto cuando id no está presente)

    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 grupo (application/json)

    Ejemplos

    Obtención de la lista de grupos

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

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

    Request

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

    Response

    • Headers: Content Type: application/json
    • Body:
      [
    {
        "id": "1",
        "name": "Universidad Nacional de Córdoba",
        "since": "2019-07-04 19:53:05",
        "visible": "1"
    },
    ....
    {
        "id": "22",
        "name": "Campus Virtual",
        "since": "2019-08-21 19:54:49",
        "visible": "1"
    }
]

    Obtención de los datos del grupo

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

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

    Request

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

    Response

    • Headers: Content Type: application/json
    • Body:
      {
    "id": "22",
    "name": "Campus Virtual",
    "since": "2019-08-21 19:54:49",
    "visible": "1"
}

    Obtención de los datos del grupo c/usuarios

    El siguiente ejemplo le permite recibir los datos de un grupo específico. Incluyendo la lista de usuarios.

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

    Request

    • Request: GET api/v2/group.php
    • Arguments:
      • token → 56bc8.....673b4
      • id → 22
      • users → true

    Response

    • Headers: Content Type: application/json
    • Body:
      {
    "id": 22,
    "name": "Campus Virtual",
    "since": "2019-08-21 19:54:49",
    "visible": 1,
    "users": [
        7,
        8,
        13,
        ....
        14,
        15
    ]
}