Activities

Gets a paginated list of activities configured for the calling organisation(s)

get

/api/v1/Activities

Authorizations

AuthorizationstringRequired

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

Query parameters

PageNumberinteger · int32 · min: 1 · max: 2147483647Optional

PageSizeinteger · int32 · min: 1 · max: 2000Optional

OrganisationIdsinteger · int32[]Optional

Responses

200

OK

application/json

isSuccessbooleanOptional

errorsstring[] · nullableOptional

messageTranslationParametersany · nullableOptional

pageNumberinteger · int32Optional

pageSizeinteger · int32Optional

firstPagestring · uri · nullableOptional

lastPagestring · uri · nullableOptional

totalPagesinteger · int32Optional

totalRecordsinteger · int32Optional

nextPagestring · uri · nullableOptional

previousPagestring · uri · nullableOptional

baseUristring · uri · nullableOptional

400

Bad Request

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

get/api/v1/Activities

GET /api/v1/Activities HTTP/1.1
Host: publicapi-eu.schoolsbuddy.net
Authorization: YOUR_API_KEY
Accept: */*

{
  "isSuccess": true,
  "errors": [
    "text"
  ],
  "messageTranslationParameters": null,
  "data": [
    {
      "id": 1,
      "organisationId": 1,
      "sortPrefix": 1,
      "name": "text",
      "isForAllGroups": true,
      "isSport": true,
      "isTrip": true,
      "isOther": true
    }
  ],
  "pageNumber": 1,
  "pageSize": 1,
  "firstPage": "https://example.com",
  "lastPage": "https://example.com",
  "totalPages": 1,
  "totalRecords": 1,
  "nextPage": "https://example.com",
  "previousPage": "https://example.com",
  "baseUri": "https://example.com",
  "searchParameters": [
    {
      "key": "text",
      "value": "text"
    }
  ]
}

Gets a single activity by id

get

/api/v1/Activities/{id}

Authorizations

AuthorizationstringRequired

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

Path parameters

idinteger · int32Required

The activity id

Query parameters

organisationIdinteger · int32Optional

The organisation to look the activity up in — required when the client has access to multiple organisations

Responses

200

OK

application/json

idinteger · int32Optional

organisationIdinteger · int32Optional

sortPrefixinteger · int32Optional

namestring · nullableOptional

isForAllGroupsbooleanOptional

isSportbooleanOptional

isTripbooleanOptional

isOtherbooleanOptional

400

Bad Request

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

get/api/v1/Activities/{id}

GET /api/v1/Activities/{id} HTTP/1.1
Host: publicapi-eu.schoolsbuddy.net
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": 1,
  "organisationId": 1,
  "sortPrefix": 1,
  "name": "text",
  "isForAllGroups": true,
  "isSport": true,
  "isTrip": true,
  "isOther": true
}