Vereinsantrag
HandbuchDeveloperVereinsantrag.online
HandbuchDeveloperVereinsantrag.online
  1. Club
  • 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.
          GET
        • Changes the information of the club.
          PUT
        • Gets the logo of the club.
          GET
        • Changes the logo of the club.
          PUT
      • 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
        • 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. Club

Changes the information of the club.

PUT
https://api.vereinsantrag.de/v1/club
Club
Returns the updated club information.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT 'https://api.vereinsantrag.de/v1/club' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "string",
    "lastname": "string",
    "firstname": "string",
    "zip": 10000,
    "city": "string",
    "street": "string",
    "domain": "string",
    "clubStatutesLink": "string",
    "eMail": "user@example.com",
    "phone": "string",
    "iban": "string",
    "bic": "string",
    "bank": "string",
    "creditorIdentificationNumber": "string"
}'
Response Response Example
200 - Example 1
{
    "name": "string",
    "lastname": "string",
    "firstname": "string",
    "zip": 10000,
    "city": "string",
    "street": "string",
    "domain": "string",
    "clubStatutesLink": "string",
    "eMail": "user@example.com",
    "phone": "string",
    "iban": "string",
    "bic": "string",
    "bank": "string",
    "creditorIdentificationNumber": "string",
    "dateCreate": "2019-08-24T14:15:22Z",
    "dateModified": "2019-08-24T14:15:22Z",
    "createdByName": "string",
    "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
    "modifiedByName": "string",
    "modifiedBy": "07ff0787-1af5-4fc4-9832-7aaeaa962a5e",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Request

Body Params application/json
Represents the information required to change club details.
name
string 
required
Gets or sets the name of the club.
>= 1 characters
lastname
string 
required
Gets or sets the last name of the chairman.
>= 1 characters
firstname
string 
required
Gets or sets the first name of the chairman.
>= 1 characters
zip
integer <int32>
required
Gets or sets the postal code of the club.
>= 10000<= 99999
city
string 
required
Gets or sets the city of the club.
>= 1 characters
street
string 
required
Gets or sets the street of the club.
>= 1 characters
domain
string  | null 
optional
Gets or sets the domain of the club.
clubStatutesLink
string 
required
Gets or sets the link to the club statutes.
>= 1 characters
eMail
string <email>
required
Gets or sets the email address of the club (for applications).
>= 1 characters
phone
string  | null 
optional
Gets or sets the phone number of the club.
iban
string 
required
Gets or sets the IBAN of the club.
>= 1 characters
bic
string 
required
Gets or sets the BIC of the club.
>= 1 characters
bank
string 
required
Gets or sets the bank name of the club.
>= 1 characters
creditorIdentificationNumber
string  | null 
optional
Gets or sets the creditor identification number of the club.
Examples

Responses

🟢200OK
text/plain
OK
Body
Represents detailed information about a club.
name
string 
required
Gets or sets the name of the club.
>= 1 characters
lastname
string 
required
Gets or sets the last name of the chairman.
>= 1 characters
firstname
string 
required
Gets or sets the first name of the chairman.
>= 1 characters
zip
integer <int32>
required
Gets or sets the postal code of the club.
>= 10000<= 99999
city
string 
required
Gets or sets the city of the club.
>= 1 characters
street
string 
required
Gets or sets the street of the club.
>= 1 characters
domain
string  | null 
optional
Gets or sets the domain of the club.
clubStatutesLink
string 
required
Gets or sets the link to the club statutes.
>= 1 characters
eMail
string <email>
required
Gets or sets the email address of the club (for applications).
>= 1 characters
phone
string  | null 
optional
Gets or sets the phone number of the club.
iban
string 
required
Gets or sets the IBAN of the club.
>= 1 characters
bic
string 
required
Gets or sets the BIC of the club.
>= 1 characters
bank
string 
required
Gets or sets the bank name of the club.
>= 1 characters
creditorIdentificationNumber
string  | null 
optional
Gets or sets the creditor identification number of the club.
dateCreate
string <date-time>
optional
Gets or sets the date the club was created.
dateModified
string <date-time>
optional
Gets or sets the date the club information was last modified.
createdByName
string  | null 
optional
Gets or sets the name of the user who created the club.
createdBy
string <uuid>
optional
Gets or sets the identifier of the user who created the club.
modifiedByName
string  | null 
optional
Gets or sets the name of the user who last modified the club information.
modifiedBy
string <uuid>
optional
Gets or sets the identifier of the user who last modified the club information.
id
string <uuid>
optional
Gets or sets the unique identifier of the club.
🟠404Record Not Found
Previous
Gets the information of the club.
Next
Gets the logo of the club.
Built with