GET activities Id

GET
/activities/{id}

Authorization

Bearer
headerAuthorizationBearer <token>

Paste your JWT token here

Path Parameters

id*integer

The unique identifier of the activity to retrieve.

Formatint32

Response Body

OK

application/json
  1. response

Represents the response DTO for an activity, containing all relevant information about the activity, including its properties and related entities such as enrollments and specification questions. The ActivityResponseDTO is used to transfer comprehensive activity data from the server to the client when retrieving activity information, allowing for a complete representation of the activity's details, enrollment status, and associated specification questions in the response payload.

id*integer

The unique identifier of an activity, assigned incrementally.

Formatint32
name*string

The name of the activity.

price*number

The price of the activity.

Formatdouble
posterPath?|

The Path where the poster for the activity is stored, if any.

posterFileName?|

The filename of the poster for the activity, if any.

dutchDescription*string

A dutch description or arbitrary length, explaining everything there is to know about the activity.

englishDescription*string

An english description or arbitrary length, explaining everything there is to know about the activity.

dateTimeStart*string

The date and time at which the activity will start.

Formatdate-time
dateTimeEnd*string

The date and time at which the activity will end.

Formatdate-time
unenrollmentDeadline?|

The deadline for unenrollment from the activity.

Formatdate-time
enrollmentDeadline?|

The deadline for enrollment from the activity.

Formatdate-time
enrollOpenDate?|

The date and time at which the activity will be open for enrolling.

Formatdate-time
location*string

The location where the activity will take place.

participantLimit?|

The maximum number of participants for the activity.

Formatint32
organizerId?|

The unique identifier of the organizer group.

Formatint32
showInKoala*boolean

Whether the activity is shown in Koala.

showOnWebsite*boolean

Whether the activity is shown on the website.

isEnrollable*boolean

Whether the activity is open for enrollment.

areParticipantsVisible*boolean

Whether the participants are visible to each other.

isAdultOnly*boolean

Whether the activity is 18+ only.

allowedAudience?TargetAudience

Represents the target audience for an activity, allowing for the specification of which groups of members are eligible to participate in a given activity. The TargetAudience enum defines various audience options, such as FirstYears, SecondYears, ThirdYearsAndAbove, and Masters, which can be combined using bitwise operations to create more specific audience groups. This entity is used to manage and enforce eligibility criteria for activities based on the academic standing of members, ensuring that activities are appropriately targeted and accessible to the intended audience within the system.

Formatint32
Value in"None""FirstYears""SecondYears""ThirdYearsAndAbove""Masters""Gratie""ActiveMembers""Begunstigers""All"
isWeeklyDrinks*boolean

Whether the activity belongs to the weekly drinks or not.

vatRate?|

The VAT rate applicable to the activity.

Formatint32
glAccountId?|

The general ledger account associated with this activity for financial tracking. Dutch: Grootboekrekening

costCenterId?|

The cost center associated with this activity for financial tracking. Dutch: Kostenplaats

costUnitId?|

The cost unit associated with this activity for financial tracking. Dutch: Kostendrager

enrollments*array<>

The members enrolled in this activity.

specificationQuestions*array<>

An extra specification question for the activity.

paymentDeadline?|

The payment deadline for the activity.

Formatdate-time
isOpenForPayment?|

Whether the activity is open for payment.

curl -X GET 'https://example.com/activities/0'
{  "id": 0,  "name": "string",  "price": 0.1,  "posterPath": "string",  "posterFileName": "string",  "dutchDescription": "string",  "englishDescription": "string",  "dateTimeStart": "2019-08-24T14:15:22Z",  "dateTimeEnd": "2019-08-24T14:15:22Z",  "unenrollmentDeadline": "2019-08-24T14:15:22Z",  "enrollmentDeadline": "2019-08-24T14:15:22Z",  "enrollOpenDate": "2019-08-24T14:15:22Z",  "location": "string",  "participantLimit": 0,  "organizerId": 0,  "showInKoala": true,  "showOnWebsite": true,  "isEnrollable": true,  "areParticipantsVisible": true,  "isAdultOnly": true,  "allowedAudience": "None",  "isWeeklyDrinks": true,  "vatRate": 0,  "glAccountId": "string",  "costCenterId": "string",  "costUnitId": "string",  "enrollments": [    {      "isOnWaitingList": true,      "registeredOn": "2019-08-24T14:15:22Z",      "member": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "studentNumber": "string",        "firstName": "string",        "lastName": "string",        "email": "user@example.com",        "phoneNumber": "string",        "street": "string",        "houseNumber": "string",        "postalCode": "string",        "city": "string",        "dateOfBirth": "2019-08-24T14:15:22Z",        "parentPhoneNumber": "string",        "notes": "string",        "registeredOn": "2019-08-24T14:15:22Z",        "preferredLanguage": "NL",        "studyEnrollments": [          {            "id": 0,            "memberId": "92983ab9-49c8-444b-85ae-6e40402cf72e",            "memberName": "string",            "studyId": 0,            "studyTitle": "string",            "studyType": "Bachelor",            "enrollmentDate": "2019-08-24T14:15:22Z",            "completionDate": "2019-08-24T14:15:22Z",            "status": "Enrolled"          }        ],        "groupMemberships": [          {            "id": 0,            "memberId": "92983ab9-49c8-444b-85ae-6e40402cf72e",            "memberName": "string",            "groupId": 0,            "groupName": "string",            "groupType": "Committee",            "membershipYear": 0,            "roleAliasId": 0,            "roleAliasName": "string"          }        ],        "gratie": true,        "lidVanVerdienste": true,        "ereLid": true,        "begunstiger": true,        "suspended": true,        "profilePicturePath": "string"      },      "specificationAnswers": [        {          "questionId": 0,          "answerId": 0,          "answer": "string",          "isPublic": true        }      ],      "price": 0,      "activity": {}    }  ],  "specificationQuestions": [    {      "questionDutch": "string",      "questionEnglish": "string",      "type": "String",      "isMandatory": true,      "isPublic": true,      "options": [        "string"      ],      "closeOnUnenrollmentDeadline": true,      "id": 0    }  ],  "paymentDeadline": "2019-08-24T14:15:22Z",  "isOpenForPayment": true}