POST activities

POST
/activities

Authorization

Bearer
headerAuthorizationBearer <token>

Paste your JWT token here

Request Body

multipart/form-data
  1. body

Represents the DTO for creating a new activity, containing all necessary information for defining an activity, including its properties and associated specification questions. The PostActivityDTO is used to transfer data from the client to the server when creating a new activity, ensuring that all required information is provided and validated appropriately for the creation process.

Name*string

The name of the activity.

Length0 <= length <= 120
Price?number

The price of the activity.

Formatdouble
Poster?unknown

The poster file for the activity, which can be uploaded when creating or updating an activity. The Poster property is of type IFormFile, allowing for the handling of file uploads in ASP.NET Core. This property is used to manage the visual representation of the activity, as the poster can be displayed on the website or in the Koala app to attract participants and provide information about the activity. When a poster is uploaded, it can be stored on the server and associated with the activity, enabling better organization and presentation of activities within the system.

DutchDescription*string

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

Length0 <= length <= 2000
EnglishDescription*string

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

Length0 <= length <= 2000
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?string

The deadline for unenrollment from the activity.

Formatdate-time
EnrollmentDeadline?string

The deadline for enrollment from the activity.

Formatdate-time
EnrollOpenDate?string

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.

Length0 <= length <= 200
ParticipantLimit?integer

The maximum number of participants for the activity.

Formatint32
OrganizerId?integer

The unique identifier of the organizer group.

Formatint32
SpecificationQuestionsJson?string

A JSON string representing the specification questions associated with the activity. This property is used to capture the details of the specification questions in a structured format, allowing for easy serialization and deserialization when creating or updating an activity. The JSON string can contain an array of specification question objects, each with its own properties such as question text, question type, and possible answers. This approach allows for flexibility in managing the specification questions while ensuring that they are properly associated with the activity in the system.

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.

IsWeeklyDrinks*boolean

Whether the activity belongs to the weekly drinks or not.

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"
VatRate?integer

The VAT rate applicable to the activity.

Formatint32
GLAccountId?string

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

CostCenterId?string

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

CostUnitId?string

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

PaymentDeadline?string

The payment deadline for the activity.

Formatdate-time

Response Body

Created

application/json
  1. response

Represents an activity that members can enroll in. An activity has various properties such as name, price, description, location, and enrollment deadlines. It also has relationships with other entities such as enrollments and specification questions. This entity is used to manage and organize activities within the system, allowing members to view and enroll in activities based on their preferences and eligibility.

id?integer

The unique identifier of an activity, assigned incrementally.

Formatint32
name*string

The name of the activity.

Length0 <= length <= 120
price?number

The price of the activity.

Formatdouble
posterFileName?|

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

posterPath?|

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

dutchDescription?string

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

Length0 <= length <= 2000
englishDescription?string

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

Length0 <= length <= 2000
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.

Length0 <= length <= 200
participantLimit?|

The maximum number of participants for the activity.

Formatint32
organizerId?|

The unique identifier of the organizer group.

Formatint32
organizer?

Represents a Group within the organization. A Group can be a Committee, Working Group, or Dispute group. Each Group has a unique identifier, a name, an active status, and can have multiple members associated with it through GroupMemberships. The Group entity also includes properties for the type of group and default financial information such as GL account and cost center. This entity is used to manage and organize different groups within the system, allowing for better collaboration and communication among members.

specificationQuestions?array<>

An extra specification question for the activity.

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.

isWeeklyDrinks?boolean

Whether the activity belongs to the weekly drinks or not.

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"
isOpenForPayment?boolean

Whether the activity is open for payment.

vatRate?|

The VAT rate applicable to the activity.

Formatint32
enrollments?array<>

The members enrolled in this activity.

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

paymentDeadline*string

The payment deadline for the activity.

Formatdate-time
curl -X POST 'https://example.com/activities' \  -F 'Name=string' \  -F 'DutchDescription=string' \  -F 'EnglishDescription=string' \  -F 'DateTimeStart=2019-08-24T14:15:22Z' \  -F 'DateTimeEnd=2019-08-24T14:15:22Z' \  -F 'Location=string' \  -F 'ShowInKoala=true' \  -F 'ShowOnWebsite=true' \  -F 'IsEnrollable=true' \  -F 'AreParticipantsVisible=true' \  -F 'IsAdultOnly=true' \  -F 'IsWeeklyDrinks=true'
{  "id": 0,  "name": "string",  "price": 0.1,  "posterFileName": "string",  "posterPath": "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,  "organizer": {    "id": 0,    "name": "string",    "active": true,    "groupMemberships": [      {        "id": 0,        "memberId": "92983ab9-49c8-444b-85ae-6e40402cf72e",        "member": {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "authSystemUserId": "21acf037-4cf7-4197-964d-bb28bd02794e",          "calendarId": "9869a533-1db4-43d9-aed3-3d63324120f5",          "activationEmailSentAt": "2019-08-24T14:15:22Z",          "studyStatusMailSentAt": "2019-08-24T14:15:22Z",          "outstandingPaymentMailSentAt": "2019-08-24T14:15:22Z",          "studentNumber": "string",          "firstName": "string",          "lastName": "string",          "email": "string",          "phoneNumber": "string",          "parentPhoneNumber": "string",          "street": "string",          "houseNumber": "string",          "postalCode": "string",          "city": "string",          "dateOfBirth": "2019-08-24T14:15:22Z",          "notes": "string",          "registeredOn": "2019-08-24T14:15:22Z",          "studyEnrollments": [            {              "id": 0,              "memberId": "92983ab9-49c8-444b-85ae-6e40402cf72e",              "member": {},              "studyId": 0,              "study": {                "id": 0,                "title": "string",                "nominalDurationYears": 0,                "type": "Bachelor",                "active": true,                "enrollments": [                  {}                ]              },              "enrollmentDate": "2019-08-24T14:15:22Z",              "completionDate": "2019-08-24T14:15:22Z",              "status": "Enrolled"            }          ],          "enrollments": [            {              "activityId": 0,              "activity": {},              "memberId": "92983ab9-49c8-444b-85ae-6e40402cf72e",              "member": {},              "price": 0.1,              "specificationAnswers": [                {                  "id": 0,                  "specificationQuestionId": 0,                  "memberId": "92983ab9-49c8-444b-85ae-6e40402cf72e",                  "member": {},                  "answer": "string",                  "question": {                    "id": 0,                    "activityId": 0,                    "questionDutch": "string",                    "questionEnglish": "string",                    "type": "String",                    "isMandatory": true,                    "isPublic": true,                    "activity": {},                    "answers": [                      {}                    ],                    "options": "string",                    "closeOnUnenrollmentDeadline": true                  },                  "enrollment": {}                }              ],              "registeredOn": "2019-08-24T14:15:22Z",              "isOnWaitingList": true            }          ],          "groupMemberships": [            {}          ],          "preferredLanguage": "NL",          "gratie": true,          "lidVanVerdienste": true,          "ereLid": true,          "begunstiger": true,          "suspended": true,          "isDeleted": true,          "announcements": [            {              "id": 0,              "titleDutch": "string",              "titleEnglish": "string",              "contentDutch": "string",              "contentEnglish": "string",              "createdAt": "2019-08-24T14:15:22Z",              "createdById": "e13e432a-5323-4484-a91d-b5969bc564d9",              "createdBy": {}            }          ],          "profilePicturePath": "string",          "profilePictureFileName": "string"        },        "groupId": 0,        "group": {},        "membershipYear": 0,        "roleAliasId": 0,        "roleAlias": {          "id": 0,          "roleId": 0,          "role": {            "id": 0,            "name": "string"          },          "name": "string"        }      }    ],    "type": "Committee",    "defaultGLAccount": "string",    "defaultCostCenter": "string",    "defaultCostUnit": "string",    "groupPicturePath": "string",    "groupPictureFileName": "string"  },  "specificationQuestions": [    {      "id": 0,      "activityId": 0,      "questionDutch": "string",      "questionEnglish": "string",      "type": "String",      "isMandatory": true,      "isPublic": true,      "activity": {},      "answers": [        {          "id": 0,          "specificationQuestionId": 0,          "memberId": "92983ab9-49c8-444b-85ae-6e40402cf72e",          "member": {            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",            "authSystemUserId": "21acf037-4cf7-4197-964d-bb28bd02794e",            "calendarId": "9869a533-1db4-43d9-aed3-3d63324120f5",            "activationEmailSentAt": "2019-08-24T14:15:22Z",            "studyStatusMailSentAt": "2019-08-24T14:15:22Z",            "outstandingPaymentMailSentAt": "2019-08-24T14:15:22Z",            "studentNumber": "string",            "firstName": "string",            "lastName": "string",            "email": "string",            "phoneNumber": "string",            "parentPhoneNumber": "string",            "street": "string",            "houseNumber": "string",            "postalCode": "string",            "city": "string",            "dateOfBirth": "2019-08-24T14:15:22Z",            "notes": "string",            "registeredOn": "2019-08-24T14:15:22Z",            "studyEnrollments": [              {                "id": 0,                "memberId": "92983ab9-49c8-444b-85ae-6e40402cf72e",                "member": {},                "studyId": 0,                "study": {                  "id": 0,                  "title": "string",                  "nominalDurationYears": 0,                  "type": "Bachelor",                  "active": true,                  "enrollments": [                    {}                  ]                },                "enrollmentDate": "2019-08-24T14:15:22Z",                "completionDate": "2019-08-24T14:15:22Z",                "status": "Enrolled"              }            ],            "enrollments": [              {                "activityId": 0,                "activity": {},                "memberId": "92983ab9-49c8-444b-85ae-6e40402cf72e",                "member": {},                "price": 0.1,                "specificationAnswers": [                  {}                ],                "registeredOn": "2019-08-24T14:15:22Z",                "isOnWaitingList": true              }            ],            "groupMemberships": [              {                "id": 0,                "memberId": "92983ab9-49c8-444b-85ae-6e40402cf72e",                "member": {},                "groupId": 0,                "group": {                  "id": 0,                  "name": "string",                  "active": true,                  "groupMemberships": [                    {}                  ],                  "type": "Committee",                  "defaultGLAccount": "string",                  "defaultCostCenter": "string",                  "defaultCostUnit": "string",                  "groupPicturePath": "string",                  "groupPictureFileName": "string"                },                "membershipYear": 0,                "roleAliasId": 0,                "roleAlias": {                  "id": 0,                  "roleId": 0,                  "role": {                    "id": 0,                    "name": "string"                  },                  "name": "string"                }              }            ],            "preferredLanguage": "NL",            "gratie": true,            "lidVanVerdienste": true,            "ereLid": true,            "begunstiger": true,            "suspended": true,            "isDeleted": true,            "announcements": [              {                "id": 0,                "titleDutch": "string",                "titleEnglish": "string",                "contentDutch": "string",                "contentEnglish": "string",                "createdAt": "2019-08-24T14:15:22Z",                "createdById": "e13e432a-5323-4484-a91d-b5969bc564d9",                "createdBy": {}              }            ],            "profilePicturePath": "string",            "profilePictureFileName": "string"          },          "answer": "string",          "question": {},          "enrollment": {            "activityId": 0,            "activity": {},            "memberId": "92983ab9-49c8-444b-85ae-6e40402cf72e",            "member": {              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",              "authSystemUserId": "21acf037-4cf7-4197-964d-bb28bd02794e",              "calendarId": "9869a533-1db4-43d9-aed3-3d63324120f5",              "activationEmailSentAt": "2019-08-24T14:15:22Z",              "studyStatusMailSentAt": "2019-08-24T14:15:22Z",              "outstandingPaymentMailSentAt": "2019-08-24T14:15:22Z",              "studentNumber": "string",              "firstName": "string",              "lastName": "string",              "email": "string",              "phoneNumber": "string",              "parentPhoneNumber": "string",              "street": "string",              "houseNumber": "string",              "postalCode": "string",              "city": "string",              "dateOfBirth": "2019-08-24T14:15:22Z",              "notes": "string",              "registeredOn": "2019-08-24T14:15:22Z",              "studyEnrollments": [                {                  "id": 0,                  "memberId": "92983ab9-49c8-444b-85ae-6e40402cf72e",                  "member": {},                  "studyId": 0,                  "study": {                    "id": 0,                    "title": "string",                    "nominalDurationYears": 0,                    "type": "Bachelor",                    "active": true,                    "enrollments": [                      {}                    ]                  },                  "enrollmentDate": "2019-08-24T14:15:22Z",                  "completionDate": "2019-08-24T14:15:22Z",                  "status": "Enrolled"                }              ],              "enrollments": [                {}              ],              "groupMemberships": [                {                  "id": 0,                  "memberId": "92983ab9-49c8-444b-85ae-6e40402cf72e",                  "member": {},                  "groupId": 0,                  "group": {                    "id": 0,                    "name": "string",                    "active": true,                    "groupMemberships": [                      {}                    ],                    "type": "Committee",                    "defaultGLAccount": "string",                    "defaultCostCenter": "string",                    "defaultCostUnit": "string",                    "groupPicturePath": "string",                    "groupPictureFileName": "string"                  },                  "membershipYear": 0,                  "roleAliasId": 0,                  "roleAlias": {                    "id": 0,                    "roleId": 0,                    "role": {                      "id": 0,                      "name": "string"                    },                    "name": "string"                  }                }              ],              "preferredLanguage": "NL",              "gratie": true,              "lidVanVerdienste": true,              "ereLid": true,              "begunstiger": true,              "suspended": true,              "isDeleted": true,              "announcements": [                {                  "id": 0,                  "titleDutch": "string",                  "titleEnglish": "string",                  "contentDutch": "string",                  "contentEnglish": "string",                  "createdAt": "2019-08-24T14:15:22Z",                  "createdById": "e13e432a-5323-4484-a91d-b5969bc564d9",                  "createdBy": {}                }              ],              "profilePicturePath": "string",              "profilePictureFileName": "string"            },            "price": 0.1,            "specificationAnswers": [              {}            ],            "registeredOn": "2019-08-24T14:15:22Z",            "isOnWaitingList": true          }        }      ],      "options": "string",      "closeOnUnenrollmentDeadline": true    }  ],  "showInKoala": true,  "showOnWebsite": true,  "isEnrollable": true,  "areParticipantsVisible": true,  "isAdultOnly": true,  "isWeeklyDrinks": true,  "allowedAudience": "None",  "isOpenForPayment": true,  "vatRate": 0,  "enrollments": [    {      "activityId": 0,      "activity": {},      "memberId": "92983ab9-49c8-444b-85ae-6e40402cf72e",      "member": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "authSystemUserId": "21acf037-4cf7-4197-964d-bb28bd02794e",        "calendarId": "9869a533-1db4-43d9-aed3-3d63324120f5",        "activationEmailSentAt": "2019-08-24T14:15:22Z",        "studyStatusMailSentAt": "2019-08-24T14:15:22Z",        "outstandingPaymentMailSentAt": "2019-08-24T14:15:22Z",        "studentNumber": "string",        "firstName": "string",        "lastName": "string",        "email": "string",        "phoneNumber": "string",        "parentPhoneNumber": "string",        "street": "string",        "houseNumber": "string",        "postalCode": "string",        "city": "string",        "dateOfBirth": "2019-08-24T14:15:22Z",        "notes": "string",        "registeredOn": "2019-08-24T14:15:22Z",        "studyEnrollments": [          {            "id": 0,            "memberId": "92983ab9-49c8-444b-85ae-6e40402cf72e",            "member": {},            "studyId": 0,            "study": {              "id": 0,              "title": "string",              "nominalDurationYears": 0,              "type": "Bachelor",              "active": true,              "enrollments": [                {}              ]            },            "enrollmentDate": "2019-08-24T14:15:22Z",            "completionDate": "2019-08-24T14:15:22Z",            "status": "Enrolled"          }        ],        "enrollments": [          {}        ],        "groupMemberships": [          {            "id": 0,            "memberId": "92983ab9-49c8-444b-85ae-6e40402cf72e",            "member": {},            "groupId": 0,            "group": {              "id": 0,              "name": "string",              "active": true,              "groupMemberships": [                {}              ],              "type": "Committee",              "defaultGLAccount": "string",              "defaultCostCenter": "string",              "defaultCostUnit": "string",              "groupPicturePath": "string",              "groupPictureFileName": "string"            },            "membershipYear": 0,            "roleAliasId": 0,            "roleAlias": {              "id": 0,              "roleId": 0,              "role": {                "id": 0,                "name": "string"              },              "name": "string"            }          }        ],        "preferredLanguage": "NL",        "gratie": true,        "lidVanVerdienste": true,        "ereLid": true,        "begunstiger": true,        "suspended": true,        "isDeleted": true,        "announcements": [          {            "id": 0,            "titleDutch": "string",            "titleEnglish": "string",            "contentDutch": "string",            "contentEnglish": "string",            "createdAt": "2019-08-24T14:15:22Z",            "createdById": "e13e432a-5323-4484-a91d-b5969bc564d9",            "createdBy": {}          }        ],        "profilePicturePath": "string",        "profilePictureFileName": "string"      },      "price": 0.1,      "specificationAnswers": [        {          "id": 0,          "specificationQuestionId": 0,          "memberId": "92983ab9-49c8-444b-85ae-6e40402cf72e",          "member": {            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",            "authSystemUserId": "21acf037-4cf7-4197-964d-bb28bd02794e",            "calendarId": "9869a533-1db4-43d9-aed3-3d63324120f5",            "activationEmailSentAt": "2019-08-24T14:15:22Z",            "studyStatusMailSentAt": "2019-08-24T14:15:22Z",            "outstandingPaymentMailSentAt": "2019-08-24T14:15:22Z",            "studentNumber": "string",            "firstName": "string",            "lastName": "string",            "email": "string",            "phoneNumber": "string",            "parentPhoneNumber": "string",            "street": "string",            "houseNumber": "string",            "postalCode": "string",            "city": "string",            "dateOfBirth": "2019-08-24T14:15:22Z",            "notes": "string",            "registeredOn": "2019-08-24T14:15:22Z",            "studyEnrollments": [              {                "id": 0,                "memberId": "92983ab9-49c8-444b-85ae-6e40402cf72e",                "member": {},                "studyId": 0,                "study": {                  "id": 0,                  "title": "string",                  "nominalDurationYears": 0,                  "type": "Bachelor",                  "active": true,                  "enrollments": [                    {}                  ]                },                "enrollmentDate": "2019-08-24T14:15:22Z",                "completionDate": "2019-08-24T14:15:22Z",                "status": "Enrolled"              }            ],            "enrollments": [              {}            ],            "groupMemberships": [              {                "id": 0,                "memberId": "92983ab9-49c8-444b-85ae-6e40402cf72e",                "member": {},                "groupId": 0,                "group": {                  "id": 0,                  "name": "string",                  "active": true,                  "groupMemberships": [                    {}                  ],                  "type": "Committee",                  "defaultGLAccount": "string",                  "defaultCostCenter": "string",                  "defaultCostUnit": "string",                  "groupPicturePath": "string",                  "groupPictureFileName": "string"                },                "membershipYear": 0,                "roleAliasId": 0,                "roleAlias": {                  "id": 0,                  "roleId": 0,                  "role": {                    "id": 0,                    "name": "string"                  },                  "name": "string"                }              }            ],            "preferredLanguage": "NL",            "gratie": true,            "lidVanVerdienste": true,            "ereLid": true,            "begunstiger": true,            "suspended": true,            "isDeleted": true,            "announcements": [              {                "id": 0,                "titleDutch": "string",                "titleEnglish": "string",                "contentDutch": "string",                "contentEnglish": "string",                "createdAt": "2019-08-24T14:15:22Z",                "createdById": "e13e432a-5323-4484-a91d-b5969bc564d9",                "createdBy": {}              }            ],            "profilePicturePath": "string",            "profilePictureFileName": "string"          },          "answer": "string",          "question": {            "id": 0,            "activityId": 0,            "questionDutch": "string",            "questionEnglish": "string",            "type": "String",            "isMandatory": true,            "isPublic": true,            "activity": {},            "answers": [              {}            ],            "options": "string",            "closeOnUnenrollmentDeadline": true          },          "enrollment": {}        }      ],      "registeredOn": "2019-08-24T14:15:22Z",      "isOnWaitingList": true    }  ],  "glAccountId": "string",  "costCenterId": "string",  "costUnitId": "string",  "paymentDeadline": "2019-08-24T14:15:22Z"}