Courses endpoint

Collaborators and members of the Hip Hop Xpress have been teaching Hip-Hop inspired courses in formal and informal setting for years. This endpoint serves to provide basic information about these courses.

Guide

• The Course object
  • Attributes
• Endpoints
  • Overview
  • Usage

The Course object

Each course object holds data in JSON format. All attributes are required in POST requests, but not in PUT requests. Below is an example Course object:

{
  "id": 0,
  "name": "Ghetto Genius Motorsports at the Don Moyer Boys & Girls Club",
  "description": [
    "Ghetto Genius (GG), a culture and engineering start-up, used the..."
  ],
  "images": [
    {
      "url": "https://publish.illinois.edu/.../MotorSportsClub.jpg",
      "caption": "Students designing and building RC cars",
    },
    {
      "url": "https://publish.illinois.edu/.../CourseLogo.jpg",
      "caption": "A course logo of the GG Motorsports Course",
    },
  ],
  "startDate": "Fall 2016",
  "endDate": "Fall 2016",
}

Attributes

Name	Type	Restrictions	Description
id	number	must be unique non-zero integer, cannot be updated once created	unique identifier for course
name	string	must be non-empty	name of course
description	Array of string	must be non-empty	short description/summary of the course
startDate	string	must be 4 characters or more	the date the course started
endDate	string or null	must be 4 characters or more	the date the course ended, or null if the course is ongoing
images	Array of Image objects	all objects must be an image object, array can be empty	images associated with the course

The Course 'Image' object

Image description for images array in the course object. Each field is required when creating new images.

{
  "url": "https://publish.illinois.edu/.../MotorSportsClub.jpg",
  "caption": ""
}

Attributes

Name	Type	Restrictions	Description
url	string	must be a valid URL	points to image of course
caption	string	none, can be empty	briefly describes the image

Endpoints

Overview

A quick overview of all endpoints related to our courses:

   POST /v1/courses
    GET /v1/courses

    GET /v1/courses/:id
    PUT /v1/courses/:id
 DELETE /v1/courses/:id

   POST /v1/courses/:id/description
    GET /v1/courses/:id/description

   POST /v1/courses/:id/images
    GET /v1/courses/:id/images

Usage

All use cases for the courses endpoints are listed below.

Collection wide:

• Create course: POST /v1/courses
• Retrieve all courses: GET /v1/courses

Course specific:

• Retrieve a course: GET /v1/courses/:id
• Update a course: PUT /v1/courses/:id
• Delete a course: DELETE /v1/courses/:id

Course data specific:

• Add text to course description: POST /v1/courses/:id/description
• Retrieve course description: GET /v1/courses/:id/description

View the error documentation for what to expect if your request fails.

---

Create course

POST /v1/courses

Creates a course by including a course object (JSON) in the request body. All fields are required, and the id must be a unique, non-negative integer.

Parameters

A valid course object (JSON) with correct attributes

Returns

The course object as added in the database

---

Retrieve all courses

GET /v1/courses

Retrieves the data for all courses

Parameters

None

Returns

An array of all course objects

---

Retrieve course

GET /v1/courses/:id

Retrieves a specific course through its id, with :id being the desired course's id field.

Parameters

None

Returns

The course object with specified id

---

Update course

PUT /v1/courses/:id

Updates specific attributes of a course object with id

Parameters

An object containing only the attributes needing change, and their updated values. For example, if you need to change the startDate attribute, you only need to include the startDate field in your request: {"startDate": "some new date"}. However, any updated attributes must follow the attribute restrictions.

Returns

The updated course object

---

Delete course

DELETE /v1/courses/:id

Deletes a specific course from the database by its id

Parameters

None

Returns

The course object that was deleted

---

Add members

POST /v1/courses/:id/members

Adds members to a specific course by sending your request with the members in the request body.

Parameters

Either a single member (as a string) or an array of member (string) in the request body

Returns

The updated members array

---

Retrieve members

GET /v1/courses/:id/members

Retrieves all the members for a specific course by its id

Parameters

None

Returns

The members array of course with specified id

---

Add to description

POST /v1/courses/:id/description

Adds text to a course's description by including the desired text in the request body.

Parameters

Either a single string or an array of strings in the request body

Returns

The updated description (array of strings)

---

Retrieve description

GET /v1/courses/:id/description

Retrieves all the text in a specific course's description

Parameters

None

Returns

The description (array of strings)

---

Add images

POST /v1/courses/:id/images

Adds images to a specific course by including the image objects in your request body.

Parameters

Either a single image object or an array of image objects in the request body. All attributes are required for each image object.

Returns

The updated images array

---

Retrieve images

GET /v1/courses/:id/images

Retrieves all the images for a specified course by id

Parameters

None

Returns

The images array of course with specified id

Back to top