Skip to content
Hanami

Get course settings

GET
/api/v1/courses/{courseId}/settings

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
courseId
required
integer
>= 1
Example
123

Responses

Section titled “Responses”

200

Section titled “200”

Current course settings

Media typeapplication/json
CourseSettingsDocumentV1
object
revision
required
integer
schemaVersion
required
integer
courseId
required
integer
slug
required
string
name
required
string
languages
required
Array<string>
highlightLanguages
required
Array<string>
courseConfigUrl
string | null
templates
required
CourseTemplateSettings
object
automaticExtensions
required
boolean
extensions
required
Array<string>
excludedPathSegments
required
Array<string>
listed
required
boolean
visibleTagSlugs
required
Array<string>
graders
required
Array<object>
CourseGrader
object
userId
required
integer
languages
required
Array<string>
feedbackTags
Array<string>
gradingTags
Array<string>
manualGradingExercises
required
Array<integer>
tags
required
Array<object>
CourseTag
object
slug
required
string
name
required
string
description
required
string
color
required
string
fontWhite
required
boolean
ltiLoginUrl
string | null
Example
{
  "revision": 4,
  "schemaVersion": 1,
  "courseId": 123,
  "slug": "programming-1",
  "name": "Programming 1",
  "languages": [
    "en",
    "fi"
  ],
  "highlightLanguages": [
    "kotlin",
    "python"
  ],
  "courseConfigUrl": "https://plus.example.edu/courses/123/configure/",
  "templates": {
    "automaticExtensions": true,
    "extensions": [],
    "excludedPathSegments": [
      ".git",
      "build",
      "node_modules"
    ]
  },
  "listed": true,
  "visibleTagSlugs": [
    "english"
  ],
  "graders": [
    {
      "userId": 456,
      "languages": [
        "en"
      ],
      "feedbackTags": [
        "english"
      ],
      "gradingTags": [
        "group-a"
      ]
    }
  ],
  "manualGradingExercises": [
    10001
  ],
  "tags": [
    {
      "slug": "english",
      "name": "English",
      "description": "Feedback in English",
      "color": "#2563eb",
      "fontWhite": true
    },
    {
      "slug": "group-a",
      "name": "Group A",
      "description": "Assigned to group A",
      "color": "#f59e0b",
      "fontWhite": false
    }
  ],
  "ltiLoginUrl": "https://hanami.example.edu/lti/launch/123"
}

Headers

Section titled “Headers”
ETag
required
string
Example
"4"
X-Request-ID
required
string

Correlation identifier

Example
9cb32531-bab4-4e8e-8887-30dd0d170945

400

Section titled “400”

Bad Request

Media typeapplication/json
ApiErrorEnvelopeV1
object
error
required
ApiErrorV1
object
code
required
string
message
required
string
requestId
required
string
issues
Array<object>
ApiIssueV1
object
path
required
string
code
required
string
message
required
string
Example
{
  "error": {
    "code": "validation_failed",
    "message": "Request validation failed",
    "requestId": "9cb32531-bab4-4e8e-8887-30dd0d170945",
    "issues": [
      {
        "path": "$.visibleTagSlugs",
        "code": "invalid_value",
        "message": "visible tag is unknown"
      }
    ]
  }
}

Headers

Section titled “Headers”
X-Request-ID
required
string

Correlation identifier

Example
9cb32531-bab4-4e8e-8887-30dd0d170945

401

Section titled “401”

Unauthorized

Media typeapplication/json
ApiErrorEnvelopeV1
object
error
required
ApiErrorV1
object
code
required
string
message
required
string
requestId
required
string
issues
Array<object>
ApiIssueV1
object
path
required
string
code
required
string
message
required
string
Example
{
  "error": {
    "code": "invalid_token",
    "message": "Authentication failed",
    "requestId": "9cb32531-bab4-4e8e-8887-30dd0d170945",
    "issues": []
  }
}

Headers

Section titled “Headers”
X-Request-ID
required
string

Correlation identifier

Example
9cb32531-bab4-4e8e-8887-30dd0d170945

403

Section titled “403”

Forbidden

Media typeapplication/json
ApiErrorEnvelopeV1
object
error
required
ApiErrorV1
object
code
required
string
message
required
string
requestId
required
string
issues
Array<object>
ApiIssueV1
object
path
required
string
code
required
string
message
required
string
Example
{
  "error": {
    "code": "forbidden",
    "message": "Teacher access is required",
    "requestId": "9cb32531-bab4-4e8e-8887-30dd0d170945",
    "issues": []
  }
}

Headers

Section titled “Headers”
X-Request-ID
required
string

Correlation identifier

Example
9cb32531-bab4-4e8e-8887-30dd0d170945

404

Section titled “404”

Not Found

Media typeapplication/json
ApiErrorEnvelopeV1
object
error
required
ApiErrorV1
object
code
required
string
message
required
string
requestId
required
string
issues
Array<object>
ApiIssueV1
object
path
required
string
code
required
string
message
required
string
Example
{
  "error": {
    "code": "not_found",
    "message": "Course was not found",
    "requestId": "9cb32531-bab4-4e8e-8887-30dd0d170945",
    "issues": []
  }
}

Headers

Section titled “Headers”
X-Request-ID
required
string

Correlation identifier

Example
9cb32531-bab4-4e8e-8887-30dd0d170945

500

Section titled “500”

Internal Server Error

Media typeapplication/json
ApiErrorEnvelopeV1
object
error
required
ApiErrorV1
object
code
required
string
message
required
string
requestId
required
string
issues
Array<object>
ApiIssueV1
object
path
required
string
code
required
string
message
required
string
Example
{
  "error": {
    "code": "internal",
    "message": "Internal server error",
    "requestId": "9cb32531-bab4-4e8e-8887-30dd0d170945",
    "issues": []
  }
}

Headers

Section titled “Headers”
X-Request-ID
required
string

Correlation identifier

Example
9cb32531-bab4-4e8e-8887-30dd0d170945

502

Section titled “502”

Bad Gateway

Media typeapplication/json
ApiErrorEnvelopeV1
object
error
required
ApiErrorV1
object
code
required
string
message
required
string
requestId
required
string
issues
Array<object>
ApiIssueV1
object
path
required
string
code
required
string
message
required
string
Example
{
  "error": {
    "code": "aplus_unavailable",
    "message": "A+ is unavailable",
    "requestId": "9cb32531-bab4-4e8e-8887-30dd0d170945",
    "issues": []
  }
}

Headers

Section titled “Headers”
X-Request-ID
required
string

Correlation identifier

Example
9cb32531-bab4-4e8e-8887-30dd0d170945