API Enrollment

Con esta API puede obtener inscribir usuarios existentes en cursos específicos.

En caso de querer saber si un usuario se encuentra inscripto, puede utilizar API User y API Course.

Nota: Las inscripciones quedarán como pendientes hasta que se hagan efectivas por el alumno.


Endpoint

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

Argumentos

  • token str: Token de utilización de la API. (Obtener aquí)
  • user int: Id del usuario.
  • course int: Id del curso.

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)
  • 304: Inscripción pendiente (application/json)
  • 302: Inscripción existente (application/json)
  • 201: Inscripción creada (application/json)

Ejemplo

Inscripción de un alumno

El siguiente ejemplo le permite inscribir a un alumno en un curso.

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

Request

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

Response

  • Headers: Content Type: application/json
En caso de que se agregue la inscripción:
  • Code: 201
  • Body:
    {
        "response": "Pending Enrollment Added"
    }
En caso de que el alumno ya esté inscripto:
  • Code: 302
  • Body:
    {
        "response": "Enrollment already exists"
    }
En caso de que la inscripción esté pendiente:
  • Code: 304
  • Body:
    {
        "response": "Enrollment pending"
    }