Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

External

Post events from external sources (e.g., Vectare).

post
/api/v1/External/events
Authorizations
AuthorizationstringRequired

Type "Bearer" followed by a space and a token.

Bodyobject · EventRequestDto[]
organisationIdinteger · int32Required
idstring · min: 1Required
sourcestring · enumRequiredPossible values:
namestring · min: 1Required
startDateTimestring · date-timeRequired
endDateTimestring · date-timeRequired
Responses
200

OK

No content
post/api/v1/External/events
POST /api/v1/External/events HTTP/1.1
Host: publicapi-eu.schoolsbuddy.net
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 265

[
  {
    "organisationId": 1,
    "id": "text",
    "source": "Vectare",
    "name": "text",
    "startDateTime": "2026-01-01T00:00:00.000Z",
    "endDateTime": "2026-01-01T00:00:00.000Z",
    "participants": [
      {
        "misId": "text",
        "attendanceNote": "text",
        "attendeeStatus": "NotExpected",
        "registerStatus": "Unset"
      }
    ]
  }
]
No content

Update or create events from external sources (e.g., Vectare). This endpoint performs an upsert operation - updates existing events or creates new ones if they don't exist.

put
/api/v1/External/events
Authorizations
AuthorizationstringRequired

Type "Bearer" followed by a space and a token.

Bodyobject · EventRequestDto[]
organisationIdinteger · int32Required
idstring · min: 1Required
sourcestring · enumRequiredPossible values:
namestring · min: 1Required
startDateTimestring · date-timeRequired
endDateTimestring · date-timeRequired
Responses
200

OK

No content
put/api/v1/External/events
PUT /api/v1/External/events HTTP/1.1
Host: publicapi-eu.schoolsbuddy.net
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 265

[
  {
    "organisationId": 1,
    "id": "text",
    "source": "Vectare",
    "name": "text",
    "startDateTime": "2026-01-01T00:00:00.000Z",
    "endDateTime": "2026-01-01T00:00:00.000Z",
    "participants": [
      {
        "misId": "text",
        "attendanceNote": "text",
        "attendeeStatus": "NotExpected",
        "registerStatus": "Unset"
      }
    ]
  }
]
No content
PreviousEvents
NextGroup

Last updated