Vereinsantrag

Get cancellation by id

GET

https://api.vereinsantrag.de/v1/submits/cancellations/{id}

Cancellations

Retrieves a specific cancellation request by its unique identifier

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.vereinsantrag.de/v1/submits/cancellations/'

Response Example

200 - 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

Path Params

string <uuid>

required

Responses

🟢200OK

text/plain

Body

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

string <uuid>

optional

Unique identifier of the cancellation request

dateCreate

string <date-time>

optional

The date of creation of the cancellation request

🟠404Record Not Found

🔴500Server Error

Modifies an existing custom field.

Delete cancellation