POST announcements

POST
/announcements

Authorization

Bearer
headerAuthorizationBearer <token>

Paste your JWT token here

Request Body

The data transfer object containing the announcement data.

application/json
  1. body

Defines Data Transfer Object (DTO) for posting announcements, containing the necessary information for creating a new announcement, including its title and content. The PostAnnouncementDTO is used to transfer data from the client to the server when creating a new announcement, ensuring that all required information is provided and validated appropriately for the creation process.

titleDutch*string

The Dutch title of the announcement.

Length0 <= length <= 100
titleEnglish*string

The English title of the announcement.

Length0 <= length <= 100
contentDutch*string

The Dutch content of the announcement.

Length0 <= length <= 1000
contentEnglish*string

The English content of the announcement.

Length0 <= length <= 1000

Response Body

Created

application/json
  1. response

Represents an announcement that can be created by members. An announcement has a title, content, and information about when it was created and who created it. This entity is used to manage and display announcements within the system, allowing members to stay informed about important updates, events, or news related to the organization or community.

id?integer

The unique identifier of the announcement, assigned incrementally.

Formatint32
titleDutch*string

The Dutch title of the announcement.

Length0 <= length <= 100
titleEnglish*string

The English title of the announcement.

Length0 <= length <= 100
contentDutch*string

The Dutch content of the announcement.

Length0 <= length <= 1000
contentEnglish*string

The English content of the announcement.

Length0 <= length <= 1000
createdAt?string

The date and time when the announcement was created.

Formatdate-time
createdById?string

The member id who created the announcement.

Formatuuid
createdBy?

Represents a member of the organization. A member has various properties such as personal information, contact details, registration date, and relationships with other entities such as enrollments, group memberships, and announcements. This entity is used to manage and organize members within the system, allowing for better communication, access control, and personalized experiences based on member preferences and attributes.

curl -X POST 'https://example.com/announcements' \  -H 'Content-Type: application/json' \  -d '{  "titleDutch": "string",  "titleEnglish": "string",  "contentDutch": "string",  "contentEnglish": "string"}'
{  "id": 0,  "titleDutch": "string",  "titleEnglish": "string",  "contentDutch": "string",  "contentEnglish": "string",  "createdAt": "2019-08-24T14:15:22Z",  "createdById": "e13e432a-5323-4484-a91d-b5969bc564d9",  "createdBy": {    "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": {          "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": {},                "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": {},                  "answer": "string",                  "question": {},                  "enrollment": {}                }              ],              "options": "string",              "closeOnUnenrollmentDeadline": true            }          ],          "showInKoala": true,          "showOnWebsite": true,          "isEnrollable": true,          "areParticipantsVisible": true,          "isAdultOnly": true,          "isWeeklyDrinks": true,          "allowedAudience": "None",          "isOpenForPayment": true,          "vatRate": 0,          "enrollments": [            {}          ],          "glAccountId": "string",          "costCenterId": "string",          "costUnitId": "string",          "paymentDeadline": "2019-08-24T14:15:22Z"        },        "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": {                "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": {},                      "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": [                  {}                ],                "showInKoala": true,                "showOnWebsite": true,                "isEnrollable": true,                "areParticipantsVisible": true,                "isAdultOnly": true,                "isWeeklyDrinks": true,                "allowedAudience": "None",                "isOpenForPayment": true,                "vatRate": 0,                "enrollments": [                  {}                ],                "glAccountId": "string",                "costCenterId": "string",                "costUnitId": "string",                "paymentDeadline": "2019-08-24T14:15:22Z"              },              "answers": [                {}              ],              "options": "string",              "closeOnUnenrollmentDeadline": true            },            "enrollment": {}          }        ],        "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": [      {}    ],    "profilePicturePath": "string",    "profilePictureFileName": "string"  }}