API Dokumentation

Allgemeines

Die API kann verwendet werden, um der eigenen Community zusätzliche Möglichkeiten zu bieten, mit Events zu interagieren oder Informationen anzuzeigen. Teile gerne deine Ideen, vielleicht können auch andere davon profitieren.

Die aktuelle API Version ist v1. Breaking changes führen zu einer Anhebung der Versionsnummer. Dies enthält unter anderem Änderungen der Rückgabewerte existierender Felder oder entfernen eines beliebigen Teils der API. Zusätzliche Rückgabefelder oder neue Anfrage-Parameter führen nicht zu einem Versionswechsel. Änderungen an den Endpunkten sind den Changelogs zu entnehmen.

Die meisten Endpunkte benötigen eine Authentifizierung über API-Schlüssel. Diese können derzeit nicht selbst konfiguriert werden, Kontaktaufnahme mit Alf ist erforderlich.

In allen Anfragen bitte den Header user-agent mitschicken. Diese Daten werden nur zur Aufrechterhaltung des Betriebes verwendet, wozu auch die Kontaktaufnahme bei Problemen gehören kann. Eine Weitergabe an Dritte erfolgt nicht.

Dokumentation

Swagger UI Dokumentation

https://slotbot.de/backend/swagger-ui/index.html

Events

Everything related to events

All events between two dates

Search for events in a specific time frame of up to 30 days.

GEThttps://slotbot.de/backend/slotbot/api/v1/events

Authorization

API Auth Token (ROLE_READ)API Auth Token (ROLE_READ_PUBLIC)

Query parameters

Response

200400

OK

Body

*/*

idinteger (int64)

hiddenboolean

name*string

dateTime*string (date-time)

creator*string

eventType*EventTypeApiDto (object)

descriptionstring

missionTypestring

missionLengthstring

pictureUrlstring

Example: "https://example.net/example.png"

Pattern: |\s*(https?|attachment)://\S+\s*

detailsarray of MinimalEventFieldIdDto (object)

reserveParticipatingboolean

squadListarray of SquadApiIdDto (object)

Request

JavaScriptCurlPython

const response = await fetch('https://slotbot.de/backend/slotbot/api/v1/events?start=text&end=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

[
  {
    "hidden": false,
    "name": "text",
    "dateTime": "2024-11-21T10:14:12.405Z",
    "creator": "text",
    "eventType": {
      "name": "text",
      "color": "text"
    },
    "description": "text",
    "missionType": "text",
    "missionLength": "text",
    "pictureUrl": "https://example.net/example.png",
    "details": [
      {
        "title": "text",
        "text": "text"
      }
    ],
    "reserveParticipating": false,
    "squadList": [
      {
        "name": "text",
        "reservedForGuildId": "text",
        "slotList": [
          {
            "name": "text",
            "reservedForGuildId": "text",
            "userId": "text",
            "replacementText": "text"
          }
        ]
      }
    ]
  }
]

Create an event

POSThttps://slotbot.de/backend/slotbot/api/v1/events

Authorization

API Auth Token (ROLE_WRITE)

Body

application/json

name*string

dateTime*string (date-time)

creator*string

eventType*EventTypeApiDto (object)

descriptionstring

missionTypestring

missionLengthstring

pictureUrlstring

Example: "https://example.net/example.png"

Pattern: |\s*(https?|attachment)://\S+\s*

reserveParticipatingboolean

hiddenboolean

Allows everyone interested to see the event in the calendar.

shareableboolean

Allows other groups to add this event ot their calendar and add participants through it.

detailsarray of MinimalEventFieldDto (object)

Up to 23 additional details about an event.

squadListarray of SquadApiDto (object)

Response

200400403

OK

Body

*/*

idinteger (int64)

hiddenboolean

name*string

dateTime*string (date-time)

creator*string

eventType*EventTypeApiDto (object)

descriptionstring

missionTypestring

missionLengthstring

pictureUrlstring

Example: "https://example.net/example.png"

Pattern: |\s*(https?|attachment)://\S+\s*

detailsarray of MinimalEventFieldIdDto (object)

reserveParticipatingboolean

squadListarray of SquadApiIdDto (object)

Request

JavaScriptCurlPython

const response = await fetch('https://slotbot.de/backend/slotbot/api/v1/events', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "creator": "text",
      "dateTime": "2024-11-21T10:14:12.405Z",
      "eventType": {
        "color": "text",
        "name": "text"
      },
      "name": "text"
    }),
});
const data = await response.json();

Response

200400

{
  "hidden": false,
  "name": "text",
  "dateTime": "2024-11-21T10:14:12.405Z",
  "creator": "text",
  "eventType": {
    "name": "text",
    "color": "text"
  },
  "description": "text",
  "missionType": "text",
  "missionLength": "text",
  "pictureUrl": "https://example.net/example.png",
  "details": [
    {
      "title": "text",
      "text": "text"
    }
  ],
  "reserveParticipating": false,
  "squadList": [
    {
      "name": "text",
      "reservedForGuildId": "text",
      "slotList": [
        {
          "name": "text",
          "reservedForGuildId": "text",
          "userId": "text",
          "replacementText": "text"
        }
      ]
    }
  ]
}

GEThttps://slotbot.de/backend/slotbot/api/v1/events/{id}

Authorization

API Auth Token (ROLE_READ)API Auth Token (ROLE_READ_PUBLIC)

Path parameters

id*integer (int64)

Response

200404

OK

Body

*/*

idinteger (int64)

hiddenboolean

name*string

dateTime*string (date-time)

creator*string

eventType*EventTypeApiDto (object)

descriptionstring

missionTypestring

missionLengthstring

pictureUrlstring

Example: "https://example.net/example.png"

Pattern: |\s*(https?|attachment)://\S+\s*

detailsarray of MinimalEventFieldIdDto (object)

reserveParticipatingboolean

squadListarray of SquadApiIdDto (object)

Request

JavaScriptCurlPython

const response = await fetch('https://slotbot.de/backend/slotbot/api/v1/events/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200404

{
  "hidden": false,
  "name": "text",
  "dateTime": "2024-11-21T10:14:12.405Z",
  "creator": "text",
  "eventType": {
    "name": "text",
    "color": "text"
  },
  "description": "text",
  "missionType": "text",
  "missionLength": "text",
  "pictureUrl": "https://example.net/example.png",
  "details": [
    {
      "title": "text",
      "text": "text"
    }
  ],
  "reserveParticipating": false,
  "squadList": [
    {
      "name": "text",
      "reservedForGuildId": "text",
      "slotList": [
        {
          "name": "text",
          "reservedForGuildId": "text",
          "userId": "text",
          "replacementText": "text"
        }
      ]
    }
  ]
}

Slots

Everything related to slots in events

Slot or unslot a user in an event

POSThttps://slotbot.de/backend/slotbot/api/v1/events/{id}/slot/{slotNumber}

Authorization

API Auth Token (ROLE_WRITE)

Path parameters

id*integer (int64)

slotNumber*integer (int32)

Body

application/json

string (discord-snowflake)

Slot this user or, if empty, unslot this slot.

Response

200400403404

OK

Body

*/*

idinteger (int64)

hiddenboolean

name*string

dateTime*string (date-time)

creator*string

eventType*EventTypeApiDto (object)

descriptionstring

missionTypestring

missionLengthstring

pictureUrlstring

Example: "https://example.net/example.png"

Pattern: |\s*(https?|attachment)://\S+\s*

detailsarray of MinimalEventFieldIdDto (object)

reserveParticipatingboolean

squadListarray of SquadApiIdDto (object)

Request

JavaScriptCurlPython

const response = await fetch('https://slotbot.de/backend/slotbot/api/v1/events/{id}/slot/{slotNumber}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify("text"),
});
const data = await response.json();

Response

200400404

{
  "hidden": false,
  "name": "text",
  "dateTime": "2024-11-21T10:14:12.405Z",
  "creator": "text",
  "eventType": {
    "name": "text",
    "color": "text"
  },
  "description": "text",
  "missionType": "text",
  "missionLength": "text",
  "pictureUrl": "https://example.net/example.png",
  "details": [
    {
      "title": "text",
      "text": "text"
    }
  ],
  "reserveParticipating": false,
  "squadList": [
    {
      "name": "text",
      "reservedForGuildId": "text",
      "slotList": [
        {
          "name": "text",
          "reservedForGuildId": "text",
          "userId": "text",
          "replacementText": "text"
        }
      ]
    }
  ]
}

Block a slot in an event

Blocks a slot from being slotted. If a block already exists, it can be used to overwrite the displayed text. If none is specified, the default is "Gesperrt".

POSThttps://slotbot.de/backend/slotbot/api/v1/events/{id}/slot/{slotNumber}/block

Authorization

API Auth Token (ROLE_WRITE)

Path parameters

id*integer (int64)

slotNumber*integer (int32)

Body

application/json

string

Response

200400403404

OK

Body

*/*

idinteger (int64)

hiddenboolean

name*string

dateTime*string (date-time)

creator*string

eventType*EventTypeApiDto (object)

descriptionstring

missionTypestring

missionLengthstring

pictureUrlstring

Example: "https://example.net/example.png"

Pattern: |\s*(https?|attachment)://\S+\s*

detailsarray of MinimalEventFieldIdDto (object)

reserveParticipatingboolean

squadListarray of SquadApiIdDto (object)

Request

JavaScriptCurlPython

const response = await fetch('https://slotbot.de/backend/slotbot/api/v1/events/{id}/slot/{slotNumber}/block', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify("text"),
});
const data = await response.json();

Response

200400404

{
  "hidden": false,
  "name": "text",
  "dateTime": "2024-11-21T10:14:12.405Z",
  "creator": "text",
  "eventType": {
    "name": "text",
    "color": "text"
  },
  "description": "text",
  "missionType": "text",
  "missionLength": "text",
  "pictureUrl": "https://example.net/example.png",
  "details": [
    {
      "title": "text",
      "text": "text"
    }
  ],
  "reserveParticipating": false,
  "squadList": [
    {
      "name": "text",
      "reservedForGuildId": "text",
      "slotList": [
        {
          "name": "text",
          "reservedForGuildId": "text",
          "userId": "text",
          "replacementText": "text"
        }
      ]
    }
  ]
}

Status

Server Status

Ping

Check if the server is responsive.

GEThttps://slotbot.de/backend/slotbot/api/v1/status

Response

200

OK

Request

JavaScriptCurlPython

const response = await fetch('https://slotbot.de/backend/slotbot/api/v1/status', {
    method: 'GET',
    headers: {},
});
const data = await response.json();