Pidgeon
  1. Courses
Pidgeon
  • Courses
    • Projects
      • Submission
        • Get submission by ID
        • Get all submissions for an existing project
        • Create a new submission for an existing project
        • Get submitted file of an existing submission
        • Delete an existing submission
        • Get all submissions from a group from a project
        • (removed) Get structure feedback of an existing submission
        • (removed) Get docker feedback for an existing submission
      • Get all projects for an existing course
      • Get all projects of a user
      • Get project by ID
      • Create a new project for an existing course
      • Update an existing project
      • Update an existing project
      • Get all groups of a project
      • Delete an existing project
      • Update the tests for an existing project
      • Update the tests for an existing project
      • Update the tests for an existing project
      • Get all tests for an existing project
      • Delete the tests of a project
      • Upload extra test files
      • Delete extra test files
      • Get extra test files
    • Group_clusters
      • Groups
        • Create a new group
        • Get group by ID
        • Update an existing group
        • Update an existing group
        • Update project score for an existing group
        • Delete project score for an existing group
        • Update project score for an existing group
        • Create project score for an existing group
        • Get project score for an existing group
        • Delete a member from an existing group
        • Delete the logged in user from a group
        • Add a member to an existing group
        • Add the logged in user to a group
        • Get all members of an existing group
        • (removed) Delete an existing group
      • Get all group clusters from an existing course
      • Create a new group cluster
      • Get a group cluster by ID
      • Update an existing group cluster
      • Fill groups in group clusters by providing a map of groupids with lists of userids
      • Update an existing group cluster
      • Delete an existing group cluster
    • Get user courses
      GET
    • Create a new course
      POST
    • Update an existing course
      PUT
    • Update an existing course
      PATCH
    • Get course by ID
      GET
    • Delete an existing course
      DELETE
    • Join course with a key
      POST
    • Get course information for joining course with key
      GET
    • Join course without a key
      POST
    • Get course information for joining course without key
      GET
    • Leave an existing course
      DELETE
    • Delete a member from an existing course
      DELETE
    • Add a member to an existing course
      POST
    • Update a member of an existing course
      PATCH
    • Get all members of an existing course
      GET
    • Get the join link for a course
      GET
    • Generate a new join link for a course
      PUT
    • Remove the joinKey from the joinLink of a course
      DELETE
    • Copy a course
      POST
    • Get grades for an existing course
      GET
    • (removed) Add a logged in member to an existing course
      POST
    • (removed) Get all your grades from a course
      GET
  • Users
    • Get user by ID
      GET
    • Get the logged in user
      GET
    • Search users by email, name and surname
      GET
    • Update user
      PUT
    • Update user
      PATCH
  1. Courses

Get course information for joining course with key

Developing
GET
/courses/{courseId}/join/{courseKey}

Request

Path Params

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
curl --location --request GET 'https://prod.your-api-server.com/courses//join/'

Responses

🟢200Success
application/json
Body

Example
{
    "courseId": "string",
    "name": "string",
    "description": "string",
    "year": 0,
    "teacher": {
        "name": "string",
        "surname": "string",
        "url": "string"
    },
    "assistants": [
        {
            "name": "string",
            "surname": "string",
            "url": "string"
        }
    ],
    "memberUrl": "string",
    "joinUrl": "string",
    "joinKey": "string",
    "archivedAt": "string",
    "createdAt": "string"
}
Modified at over 1 year ago
Previous
Join course with a key
Next
Join course without a key
Built with