Endpoint

• URL: api/v2/course.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 curso, en caso de no estar presente devuelve la lista de cursos.
• users bool: Incluir usuarios del curso (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 curso (application/json)

Ejemplos

Obtención de la lista de cursos

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

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

Request

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

Response

• Headers: Content Type: application/json
• Body:

  [
      {
          "id": 1,
          "course": "course-v1:CampusVirtualX+AV007+2018_T1",
          "name": "Introducción Construcción en Seco",
          "organization": "CampusVirtualX",
          "link": "https://edx.campusvirtu....07+20018_T1",
          "image": "https://edx-studio.campusvirt....RUCCION_EN_SECO_v2png.png",
          "since": "2019-07-03 13:03:34",
          "visible": 1
      },
          ...
      {
          "id": 2,
          "course": "course-v1:CampusVirtualX+AV013+2019_T1",
          "name": "Etapa Virtual - Formación en género y abordaje de violencias",
          "organization": "CampusVirtualX",
          "link": "https://edx.campusvirtu....13+2019_T1",
          "image": "https://edx.campusvirt....ENERAL.jpg",
          "since": "2019-07-03 13:03:34",
          "visible": 1
      }
  ]

Obtención de los datos del curso

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

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

Request

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

Response

• Headers: Content Type: application/json
• Body:

  {
      "id": 9,
      "course": "course-v1:CampusVirtualX+AV005+2018_T1",
      "name": "Curso Introducción de Peluquería",
      "organization": "CampusVirtualX",
      "link": "https://edx.campusvirtu....13+2019_T1",
      "image": "https://edx.campusvirt....ENERAL.jpg",
      "since": "2019-07-03 13:03:34",
      "visible": 1
  }

Obtención de los datos del curso c/usuarios

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

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

Request

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

Response

• Headers: Content Type: application/json
• Body:

  {
      "id": 9,
      "course": "course-v1:CampusVirtualX+AV005+2018_T1",
      "name": "Curso Introducci\u00f3n de Peluquer\u00eda",
      "organization": "CampusVirtualX",
      "link": "https://edx.campusvirtu....13+2019_T1",
      "image": "https://edx.campusvirt....ENERAL.jpg",
      "since": "2019-07-03 13:03:34",
      "visible": 1,
      "users": [
          7,
          13,
          83,
          85,
          ....
          8469,
          8473,
          8485
      ]
  }