Invite-Application API (0.0.1)

Download OpenAPI specification:Download

This describes the REST interface to the invite-application API.

Design

The arcitectural design for this application can be found here

Retrieve an invite

Retrieves a single invite

query Parameters
id
required
string <uuid>

Invite ID

Responses

Response samples

Content type
application/json
{
  • "role": {},
  • "user": {
    },
  • "enddate": "2022-02-23 12:00",
  • "state": "accepted"
}

Sends an invite to a user

Request Body schema: application/json
required
object
required
object
enddate
required
string <date>

Responses

Request samples

Content type
application/json
{
  • "role": {},
  • "user": {
    },
  • "enddate": "2022-02-23 12:00"
}

Response samples

Content type
application/json
{
  • "role": {},
  • "user": {
    },
  • "enddate": "2022-02-23 12:00",
  • "state": "accepted"
}

Update an invite

Request Body schema: application/json
required
object
required
object
enddate
required
string <date>

Responses

Request samples

Content type
application/json
{
  • "role": {},
  • "user": {
    },
  • "enddate": "2022-02-23 12:00"
}

Response samples

Content type
application/json
{
  • "code": 401,
  • "message": "Unauthorized"
}

Revoke an invite

Deletes the invite specified by the id

query Parameters
id
required
string <uuid>

Invite ID

Responses

Response samples

Content type
application/json
{
  • "code": 401,
  • "message": "Unauthorized"
}

Get a role

Retrieves a single role

query Parameters
id
required
string <uuid>

Role ID

Responses

Response samples

Content type
application/json
{}

Create a Role

Request Body schema: application/json
name
required
string

A freeform role name. This should be the same as the role name in the application

required
object
required
object

Responses

Request samples

Content type
application/json
{
  • "name": "teacher",
  • "institution": {
    },
  • "application": {