Vereinsantrag
HandbuchDeveloperVereinsantrag.online
HandbuchDeveloperVereinsantrag.online
  1. Memberships
  • Wilkommen zu Vereinsantrag 🎉
  • Registrierung und Vereinsdaten
  • Mitgliedschaften und Abteilungen
  • Formulare konfigurieren und veröffentlichen
  • Weitere Felder hinzufĂŒgen
  • Datenschutz
  • AntrĂ€ge online empfangen und verwalten
  • Developer
    • 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
          • Delete cancellation
          • Create new cancellation
          • Get cancellation PDF
          • Get cancellation CSV
          • Confirm cancellation
        • 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
            POST
          • Retrieves a membership application
            GET
          • Deletes a membership application
            DELETE
          • Exports a membership application as PDF
            GET
          • Exports a membership application as CSV
            GET
          • Confirms a membership application
            POST
        • 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. Memberships

Creates a new membership application

POST
https://api.vereinsantrag.de/v1/submits/Memberships
Memberships
Creates a new membership application with the provided membership data and returns the created membership application.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.vereinsantrag.de/v1/submits/Memberships' \
--header 'Content-Type: application/json' \
--data-raw '{
    "eMail": "user@example.com",
    "firstname": "string",
    "lastname": "string",
    "birthday": "2019-08-24",
    "city": "string",
    "signature": "string",
    "gender": "Woman",
    "zip": "string",
    "street": "string",
    "phone": "string",
    "paymentMethod": "Sepa",
    "iban": "string",
    "accountHolder": "string",
    "departmentIds": [
        "string"
    ],
    "membership": "b8ce8f5d-49a7-404e-a63d-be641c3bd8d7",
    "familyMembers": [
        {
            "firstname": "string",
            "lastname": "string",
            "birthday": "2019-08-24",
            "gender": "Woman",
            "departmentIds": [
                "string"
            ]
        }
    ],
    "customFields": {
        "property1": "string",
        "property2": "string"
    }
}'
Response Response Example
201 - Example 1
{
    "eMail": "user@example.com",
    "firstname": "string",
    "lastname": "string",
    "birthday": "2019-08-24",
    "city": "string",
    "signature": "string",
    "gender": "Woman",
    "zip": "string",
    "street": "string",
    "phone": "string",
    "paymentMethod": "Sepa",
    "iban": "string",
    "accountHolder": "string",
    "departmentIds": [
        "string"
    ],
    "membership": "b8ce8f5d-49a7-404e-a63d-be641c3bd8d7",
    "familyMembers": [
        {
            "firstname": "string",
            "lastname": "string",
            "birthday": "2019-08-24",
            "gender": "Woman",
            "departmentIds": [
                "string"
            ]
        }
    ],
    "customFields": {
        "property1": "string",
        "property2": "string"
    }
}

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)
gender
enum<string> 
required
Allowed values:
WomanMenDivers
zip
string 
required
Zip code of the member
>= 1 characters<= 10 characters
street
string 
required
Street of the member
>= 1 characters<= 200 characters
phone
string  | null 
optional
Phone number of the member
<= 200 characters
paymentMethod
enum<string> 
required
Allowed values:
SepaOnAccount
iban
string  | null 
optional
Iban of the member for the collection of the membership fee
<= 30 characters
accountHolder
string  | null 
optional
Account holder for the collection of the membership fee
<= 200 characters
departmentIds
array[string] | null 
optional
Desired departments (Id reference)
membership
string <uuid>
required
Name of the membership (Id reference)
familyMembers
array[object (FamiliySubmit) {5}]  | null 
optional
List of additional members
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
customFields
object  | null 
optional
Custom fields for additional information
Additional properties
string  | null 
optional
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)
gender
enum<string> 
required
Allowed values:
WomanMenDivers
zip
string 
required
Zip code of the member
>= 1 characters<= 10 characters
street
string 
required
Street of the member
>= 1 characters<= 200 characters
phone
string  | null 
optional
Phone number of the member
<= 200 characters
paymentMethod
enum<string> 
required
Allowed values:
SepaOnAccount
iban
string  | null 
optional
Iban of the member for the collection of the membership fee
<= 30 characters
accountHolder
string  | null 
optional
Account holder for the collection of the membership fee
<= 200 characters
departmentIds
array[string] | null 
optional
Desired departments (Id reference)
membership
string <uuid>
required
Name of the membership (Id reference)
familyMembers
array[object (FamiliySubmit) {5}]  | null 
optional
List of additional members
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
customFields
object  | null 
optional
Custom fields for additional information
Additional properties
string  | null 
optional
🟠400Bad Request
Previous
Confirm change request
Next
Retrieves a membership application
Built with