Vereinsantrag
HandbuchDeveloperVereinsantrag.online
HandbuchDeveloperVereinsantrag.online
  1. Cancellations
  • Welcome to the developer portal
  • Get your token
  • Rate-Limiting
  • API-Reference
    • Authentication
      • AuthenticationService
        • /auth/login
        • /auth/refresh
        • /auth/manage/info
        • /auth/manage/info
    • Information about your club
      • Club
        • Gets the information of the club.
        • Changes the information of the club.
        • Gets the logo of the club.
        • Changes the logo of the club.
      • Department
        • Retrieves all departments for the current club.
        • Creates a new department.
        • Retrieves a specific department by its ID.
        • Deletes a specific department by its ID.
        • Modifies an existing department.
        • Retrieves the settings for the departments.
        • Updates the settings for the departments.
      • Forms
        • Retrieves the membership form for the club.
        • Modifies the membership form for the club.
        • Retrieves the cancellation form for the club.
        • Modifies the cancellation form for the club.
      • Membership
        • Retrieves all memberships for the current club.
        • Creates a new membership.
        • Retrieves a specific membership by its ID.
        • Deletes a specific membership by its ID.
        • Modifies an existing membership.
      • CustomField
        • Retrieves all custom fields for the current club.
        • Creates a new custom field.
        • Retrieves a specific custom field by its internal name.
        • Deletes a specific custom field by its internal name.
        • Modifies an existing custom field.
    • Submits
      • Cancellations
        • Get cancellation by id
          GET
        • Delete cancellation
          DELETE
        • Create new cancellation
          POST
        • Get cancellation PDF
          GET
        • Get cancellation CSV
          GET
        • Confirm cancellation
          POST
      • Changes
        • Create a new change request
        • Get change request by ID
        • Delete change request
        • Get change request PDF
        • Get change request CSV
        • Confirm change request
      • Memberships
        • Creates a new membership application
        • Retrieves a membership application
        • Deletes a membership application
        • Exports a membership application as PDF
        • Exports a membership application as CSV
        • Confirms a membership application
      • Submits
        • Retrieves all submissions.
        • Accepts a submission.
        • Denies a submission.
    • Reporting
      • Dashboard
        • Gets the count of new memberships.
        • Gets the count of new changes.
        • Gets the count of new cancellations.
        • Gets the membership chart data.
  1. Cancellations

Create new cancellation

POST
https://api.vereinsantrag.de/v1/submits/cancellations
Cancellations
Creates a new cancellation request
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.vereinsantrag.de/v1/submits/cancellations' \
--header 'Content-Type: application/json' \
--data-raw ''
Response Response Example
201 - Example 1
{
  "eMail": "user@example.com",
  "firstname": "string",
  "lastname": "string",
  "birthday": "2019-08-24",
  "city": "string",
  "signature": "string",
  "mode": "All",
  "familyMembers": [
    {
      "firstname": "string",
      "lastname": "string",
      "birthday": "2019-08-24",
      "gender": "Woman",
      "departmentIds": [
        "string"
      ]
    }
  ],
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "dateCreate": "2019-08-24T14:15:22Z"
}

Request

Body Params application/json
eMail
string <email>
required
E-Mail of the member
>= 1 characters<= 200 characters
firstname
string 
required
First name of the member
>= 1 characters<= 200 characters
lastname
string 
required
Last name of the member
>= 1 characters<= 200 characters
birthday
string <date>
required
Birthday of the member
city
string 
required
City of the member
>= 1 characters<= 200 characters
signature
string  | null 
optional
Signature of the member as Base64 image (JPEG)
mode
enum<string> 
required
Allowed values:
AllOnlyFamiliyMembers
familyMembers
array[object (FamiliySubmit) {5}]  | null 
optional
List of additional members to be canceled
firstname
string 
required
First name of the member
>= 1 characters<= 200 characters
lastname
string 
required
Last name of the member
>= 1 characters<= 200 characters
birthday
string <date>
required
Birthday of the member
gender
enum<string> 
required
Allowed values:
WomanMenDivers
departmentIds
array[string] | null 
optional
Desired departments (Id reference)
If not specified, the applicant's department will be adopted
Examples

Responses

🟢201Created
text/plain
Created
Body
eMail
string <email>
required
E-Mail of the member
>= 1 characters<= 200 characters
firstname
string 
required
First name of the member
>= 1 characters<= 200 characters
lastname
string 
required
Last name of the member
>= 1 characters<= 200 characters
birthday
string <date>
required
Birthday of the member
city
string 
required
City of the member
>= 1 characters<= 200 characters
signature
string  | null 
optional
Signature of the member as Base64 image (JPEG)
mode
enum<string> 
required
Allowed values:
AllOnlyFamiliyMembers
familyMembers
array[object (FamiliySubmit) {5}]  | null 
optional
List of additional members to be canceled
firstname
string 
required
First name of the member
>= 1 characters<= 200 characters
lastname
string 
required
Last name of the member
>= 1 characters<= 200 characters
birthday
string <date>
required
Birthday of the member
gender
enum<string> 
required
Allowed values:
WomanMenDivers
departmentIds
array[string] | null 
optional
Desired departments (Id reference)
If not specified, the applicant's department will be adopted
id
string <uuid>
optional
Unique identifier of the cancellation request
dateCreate
string <date-time>
optional
The date of creation of the cancellation request
🟠400Bad Request
🔴500Server Error
Previous
Delete cancellation
Next
Get cancellation PDF
Built with