Respon_sum API documentation version v1

Welcome to Responsum! I built this project for my professor to use in a class of 135 students. It is able to perform live quizzing or assesment questions and can done in person or remote. The benefit of Responsum incldues a searchable, pageable, and orderable database of all the questions and answers. For me as a student, this helps a lot with studying for exams and focusing on specific topics I plan to work on.

Try clicking on the GET, PUT, POST, DELETE Colored Buttons!

version: required(v1)

/students

Collection of all registered students.

/students post

post

Create a new student.

Request
Response

Body

Media type: application/json

Type: json

Content:

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema",
  "id": "http://jsonschema.net",
  "properties": {
    "name": {
      "type": "string"
    },
    "email": {
      "type": "string"
    },
    "studentNumber": {
      "type": "string"
    },
    "institution": {
      "type": "string"
    }
  },
  "required": ["name", "email", "studentNumber", "institution"],
  "additionalProperties": false
}

HTTP status code 200

Body

Media type: application/json

Type:

{
  "$type": "object",
  "$schema": "http://json-schema.org/draft-07/schema",
  "id": "http://jsonschema.net",
  "properties": {
    "id": {
      "type": "string"
    }
  },
  "additionalProperties": false
}

/students/{studentId} get put delete

get

Get information about a student.

put

Update a student's information.

delete

Delete a student account.

Get information about a student.

Request
Response

URI Parameters

studentId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: json

Content:

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema",
  "id": "http://jsonschema.net",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "email": {
      "type": "string"
    },
    "studentNumber": {
      "type": "string"
    },
    "institution": {
      "type": "string"
    },
    "performance": {
      "$ref": "stats.json"
    }
  },
  "required": ["id", "name", "studentNumber", "institution", "performance"],
  "additionalProperties": false
}

Update a student's information.

Request

URI Parameters

studentId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema",
  "id": "http://jsonschema.net",
  "properties": {
    "name": {
      "type": "string"
    },
    "email": {
      "type": "string"
    },
    "studentNumber": {
      "type": "string"
    },
    "institution": {
      "type": "string"
    }
  },
  "required": ["name", "email", "studentNumber", "institution"],
  "additionalProperties": false
}

/students/{studentId}/responses get

A list of all the responses the student has ever made.

get

Get the paginated list of responses made by the student. If ordering by "correct" or "wrong", responses matching the criteria will be placed at the top. Then, they will be sorted by type of response in one batch. Within each batch, they will be sorted by recency.

Request

URI Parameters

studentId: required(string)

Query Parameters

offset: (integer - default: 0)
Skip over a number of elements by specifying an offset value for the query.
Example:
```
20
```
limit: (integer - default: 10)
Limit the number of elements on the response.
Example:
```
80
```
orderBy: (one of recency, correct, wrong - default: recency)
Order by field
order: (one of desc, asc - default: desc)
Order

Body

Media type: application/json

Type:

{
  "type": "array",
  "$schema": "http://json-schema.org/draft-07/schema",
  "id": "http://jsonschema.net",
  "items": {
    "$ref": "response-retrieve.json"
  }
}

/students/{studentId}/current-classes get

A list of active classes in which the student is currently registered.

get

Get the paginated list of classes in which the student is currently registered. The classes are sorted descending by date joined.

Request

URI Parameters

studentId: required(string)

Query Parameters

offset: (integer - default: 0)
Skip over a number of elements by specifying an offset value for the query.
Example:
```
20
```
limit: (integer - default: 10)
Limit the number of elements on the response.
Example:
```
80
```

Body

Media type: application/json

Type:

{
  "type": "array",
  "$schema": "http://json-schema.org/draft-07/schema",
  "id": "http://jsonschema.net",
  "items": {
    "$ref": "class-retrieve.json"
  }
}

/students/{studentId}/past-classes get

A list of inactive classes in which the student was previously registered.

get

Get the paginated list of classes in which the student was previously registered. The classes are sorted descending by date joined.

Request

URI Parameters

studentId: required(string)

Query Parameters

offset: (integer - default: 0)
Skip over a number of elements by specifying an offset value for the query.
Example:
```
20
```
limit: (integer - default: 10)
Limit the number of elements on the response.
Example:
```
80
```

Body

Media type: application/json

Type:

{
  "type": "array",
  "$schema": "http://json-schema.org/draft-07/schema",
  "id": "http://jsonschema.net",
  "items": {
    "$ref": "class-retrieve.json"
  }
}

/instructors

Collection of all registered instructors.

/instructors post

post

Create a new instructor.

Request
Response

Body

Media type: application/json

Type: json

Content:

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema",
  "id": "http://jsonschema.net",
  "properties": {
    "name": {
      "type": "string"
    },
    "email": {
      "type": "string"
    },
    "institution": {
      "type": "string"
    }
  },
  "required": ["name", "email", "institution"],
  "additionalProperties": false
}

HTTP status code 200

Body

Media type: application/json

Type:

{
  "$type": "object",
  "$schema": "http://json-schema.org/draft-07/schema",
  "id": "http://jsonschema.net",
  "properties": {
    "id": {
      "type": "string"
    }
  },
  "additionalProperties": false
}

/instructors/{instructorId} get put delete

get

Get information about an instructor.

put

Update an instructor's information.

delete

Delete an instructor account.

Update an instructor's information.

Request

URI Parameters

instructorId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema",
  "id": "http://jsonschema.net",
  "properties": {
    "name": {
      "type": "string"
    },
    "email": {
      "type": "string"
    },
    "institution": {
      "type": "string"
    }
  },
  "required": ["name", "email", "institution"],
  "additionalProperties": false
}

/instructors/{instructorId}/questions get

A list of all questions the instructor has ever asked.

get

Get the paginated and searchable list of questions asked by the instructor.

Request
Response

URI Parameters

instructorId: required(string)

Query Parameters

offset: (integer - default: 0)
Skip over a number of elements by specifying an offset value for the query.
Example:
```
20
```
limit: (integer - default: 10)
Limit the number of elements on the response.
Example:
```
80
```
orderBy: (one of recency, correctPercent, incorrectPercent, unrespondedPercent - default: <>)
Order by field
order: (one of desc, asc - default: desc)
Order
query: (string)
Query to search for. Searches in question and correct answer texts.

HTTP status code 200

/instructors/{instructorId}/current-classes get

A list of all active classes currently owned by the instructor.

get

Get the paginated list of classes currently active. The classes are sorted descending by date joined.

Request

URI Parameters

instructorId: required(string)

Query Parameters

offset: (integer - default: 0)
Skip over a number of elements by specifying an offset value for the query.
Example:
```
20
```
limit: (integer - default: 10)
Limit the number of elements on the response.
Example:
```
80
```

Body

Media type: application/json

Type:

{
  "type": "array",
  "$schema": "http://json-schema.org/draft-07/schema",
  "id": "http://jsonschema.net",
  "items": {
    "$ref": "class-retrieve.json"
  }
}

/instructors/{instructorId}/past-classes get

A list of all inactive classes previously owned by the instructor.

get

Get the paginated list of classes previously owned by the instructor. The classes are sorted descending by date joined.

Request

URI Parameters

instructorId: required(string)

Query Parameters

offset: (integer - default: 0)
Skip over a number of elements by specifying an offset value for the query.
Example:
```
20
```
limit: (integer - default: 10)
Limit the number of elements on the response.
Example:
```
80
```

Body

Media type: application/json

Type:

{
  "type": "array",
  "$schema": "http://json-schema.org/draft-07/schema",
  "id": "http://jsonschema.net",
  "items": {
    "$ref": "class-retrieve.json"
  }
}

/classes

Collection of all classes, active and inactive.

/classes get post

get

Get the pageable and searchable list of all classes, ordered by date.

post

Create a new class.

Get the pageable and searchable list of all classes, ordered by date.

Request
Response

Query Parameters

active: (boolean)
Specifies whether to filter active classes. If true, filter for active classes; if false, filter for inactive classes; if not specified, do not filter.
institution: (string)
Institution for which to filter results. Must match, suggested. Drop down, can type for auto.
searchText: (string)
Text to search for in class data. Matches class names.
offset: (integer - default: 0)
Skip over a number of elements by specifying an offset value for the query.
Example:
```
20
```
limit: (integer - default: 10)
Limit the number of elements on the response.
Example:
```
80
```

HTTP status code 200

Create a new class.

Request
Response

Body

Media type: application/json

Type: json

Content:

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema",
  "id": "http://jsonschema.net",
  "properties": {
    "name": {
      "type": "string"
    },
    "active": {
      "type": "boolean"
    },
    "institution": {
      "type": "string"
    },
    "instructorIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "minItems": 1
    }
  },
  "required": ["name", "active", "instructorIds"],
  "additionalProperties": false
}

HTTP status code 200

Body

Media type: application/json

Type:

{
  "$type": "object",
  "$schema": "http://json-schema.org/draft-07/schema",
  "id": "http://jsonschema.net",
  "properties": {
    "id": {
      "type": "string"
    }
  },
  "additionalProperties": false
}

/classes/{classId} get put delete

get

Get information about a class.

put

Update a class's information.

delete

Delete a class.

Update a class's information.

Request

URI Parameters

classId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema",
  "id": "http://jsonschema.net",
  "properties": {
    "name": {
      "type": "string"
    },
    "active": {
      "type": "boolean"
    },
    "institution": {
      "type": "string"
    },
    "instructorIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "minItems": 1
    }
  },
  "required": ["name", "active", "instructorIds"],
  "additionalProperties": false
}

/classes/{classId}/active get put

get

Get whether the class is currently active.

put

Set a class as active or inactive. Setting as inactive will move the class to "past classes" in all lists of current and past classes, and will disable creating questions or responses. Setting as active will set it back.

Request

URI Parameters

classId: required(string)

Body

Media type: application/json

Type:

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema",
  "id": "http://jsonschema.net",
  "properties": {
    "active": {
      "type": "boolean"
    }
  },
  "required": ["active"],
  "additionalProperties": false
}

/classes/{classId}/students get

get

Get a pageable list of all students in the class, ordered alphabetically by name.

Request
Response

URI Parameters

classId: required(string)

Query Parameters

offset: (integer - default: 0)
Skip over a number of elements by specifying an offset value for the query.
Example:
```
20
```
limit: (integer - default: 10)
Limit the number of elements on the response.
Example:
```
80
```

HTTP status code 200

/classes/{classId}/responses get

A list of all responses to questions in the class.

get

Get all the responses for a class

Request
Response

URI Parameters

classId: required(string)

Query Parameters

offset: (integer - default: 0)
Skip over a number of elements by specifying an offset value for the query.
Example:
```
20
```
limit: (integer - default: 10)
Limit the number of elements on the response.
Example:
```
80
```
orderBy: (one of recency, correct, incorrect - default: recency)
Order by field
order: (one of desc, asc - default: desc)
Order
query: (string)
Query to search for. Searches in question texts, answer texts, and short answer responses.

HTTP status code 200

/classes/{classId}/questions get post

The collection of all questions in the class.

get

Get a pageable and searchable list of all questions in the class.

post

Create a question for a class.

Get a pageable and searchable list of all questions in the class.

Request
Response

URI Parameters

classId: required(string)

Query Parameters

viewableByStudents: (boolean)
Specifies whether to filter for questions viewable by students. Controlled by instructor after asking question. If true, filter for questions marked viewable by students; if false, filter for questions not marked viewable by students; if not present, don't filter at all. (In future) - will return an error if viewableByStudents is not present or false and this request is done by a student account.
offset: (integer - default: 0)
Skip over a number of elements by specifying an offset value for the query.
Example:
```
20
```
limit: (integer - default: 10)
Limit the number of elements on the response.
Example:
```
80
```
query: (string)
Query to search for. Searches in question texts and answer texts.

HTTP status code 200

Create a question for a class.

Request

URI Parameters

classId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema",
  "id": "http://jsonschema.net",
  "properties": {
    "questionText": {
      "type": "string"
    }
  },
  "oneOf": [
    {
      "properties": {
        "type": {
          "type": "string",
          "const": "multiple-choice"
        },
        "numAnswers": {
          "type": "integer",
          "minimum": 0
        },
        "correctAnswer": {
          "type": "integer",
          "minimum": 0
        },
        "answerTexts": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "required": ["type", "numAnswers"]
    },
    {
      "properties": {
        "type": {
          "type": "string",
          "const": "short-answer"
        },
        "correctAnswer": {
          "type": "string"
        }
      },
      "required": ["type"]
    }
  ],
  "additionalProperties": false
}

/classes/{classId}/questions/{questionId} get put delete

get

Get information about a question for a class.

put

Modify a question's information.

delete

Modify a question's information.

Request

URI Parameters

classId: required(string)
questionId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema",
  "id": "http://jsonschema.net",
  "properties": {
    "questionText": {
      "type": "string"
    }
  },
  "oneOf": [
    {
      "properties": {
        "type": {
          "type": "string",
          "const": "multiple-choice"
        },
        "numAnswers": {
          "type": "integer",
          "minimum": 0
        },
        "correctAnswer": {
          "type": "integer",
          "minimum": 0
        },
        "answerTexts": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "required": ["type", "numAnswers"]
    },
    {
      "properties": {
        "type": {
          "type": "string",
          "const": "short-answer"
        },
        "correctAnswer": {
          "type": "string"
        }
      },
      "required": ["type"]
    }
  ],
  "additionalProperties": false
}

/classes/{classId}/questions/{questionId}/viewable-by-students get put

get

Get whether a question is viewable by students.

put

Set whether a question is viewable by students.

Request

URI Parameters

classId: required(string)
questionId: required(string)

Body

Media type: application/json

Type:

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema",
  "id": "http://jsonschema.net",
  "properties": {
    "viewableByStudents": {
      "type": "boolean"
    }
  },
  "required": "viewableByStudents",
  "additionalProperties": false
}

/classes/{classId}/questions/{questionId}/responses get

A list of all responses to this question.

get

Get the list of all responses to a question.

Request
Response

URI Parameters

classId: required(string)
questionId: required(string)

Query Parameters

offset: (integer - default: 0)
Skip over a number of elements by specifying an offset value for the query.
Example:
```
20
```
limit: (integer - default: 10)
Limit the number of elements on the response.
Example:
```
80
```
orderBy: (one of recency, correct, incorrect - default: correct)
Order by field
order: (one of desc, asc - default: desc)
Order

HTTP status code 200

/classes/{classId}/questions/{questionId}/responses/{studentId} get put delete

The response by a specific student to this question.

get

Get the response made by a student to this question.

put

Create or change a student's response to this question

delete

Delete a student's reponse to this question.

Create or change a student's response to this question

Request

URI Parameters

classId: required(string)
questionId: required(string)
studentId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema",
  "id" : "http://jsonschema.net",
  "properties": {
    "timestamp": {
      "type": "string",
      "format": "date-time"
    }
  },
  "oneOf": [
    {
      "properties": {
        "answerNumber": {
          "type": "integer",
          "minimum": 0
        }
      }
    },
    {
      "properties": {
        "answerText": {
          "type": "string"
        }
      }
    }
  ]
}

Respon_sum API documentation version v1

/students

post /students

Body

HTTP status code 200

Body

get /students/{studentId}

URI Parameters

HTTP status code 200

Body

put /students/{studentId}

URI Parameters

Body

delete /students/{studentId}

URI Parameters

get /students/{studentId}/responses

URI Parameters

Query Parameters

Body

get /students/{studentId}/current-classes

URI Parameters

Query Parameters

Body

get /students/{studentId}/past-classes

URI Parameters

Query Parameters

Body

/instructors

post /instructors

Body

HTTP status code 200

Body

get /instructors/{instructorId}

URI Parameters

HTTP status code 200

put /instructors/{instructorId}

URI Parameters

Body

delete /instructors/{instructorId}

URI Parameters

get /instructors/{instructorId}/questions

URI Parameters

Query Parameters

HTTP status code 200

get /instructors/{instructorId}/current-classes

URI Parameters

Query Parameters

Body

get /instructors/{instructorId}/past-classes

URI Parameters

Query Parameters

Body

/classes

get /classes

Query Parameters

HTTP status code 200

post /classes

Body

HTTP status code 200

Body

get /classes/{classId}

URI Parameters

HTTP status code 200

put /classes/{classId}

URI Parameters

Body

delete /classes/{classId}

URI Parameters

get /classes/{classId}/active

URI Parameters

HTTP status code 200

put /classes/{classId}/active

URI Parameters

Body

get /classes/{classId}/instructors

URI Parameters

HTTP status code 200

put /classes/{classId}/instructors/{instructorId}

URI Parameters

delete /classes/{classId}/instructors/{instructorId}