Zum Inhalt springen
Vimine für Entwickler
DE

Das angemeldete Mitglied zu einer Veranstaltung anmelden

POST
/v1/events/{slug}/registrations
curl --request POST \
  --url https://api.vimine.network/v1/events/example/registrations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "registration_type": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "note": "example", "quantity": 1, "locale": "example" }'

Kostenlose Art: 201 mit status: confirmed und dem QR-token. Kostenpflichtige Art: 201 mit status: reserved, dem Betrag und den payment_instructions des Vereins; die Anmeldung wird bestätigt, wenn der Verein den Beitrag erfasst (Stripe Checkout kommt mit Phase L3). 422 not_eligible trägt die Gründe (siehe Teilnahmeberechtigung).

Autorisierungen

Abschnitt betitelt „Autorisierungen“

Parameter

Abschnitt betitelt „Parameter“

Pfadparameter

Abschnitt betitelt „Pfadparameter“
slug
erforderlich
string

Anfrage-Bodyerforderlich

Abschnitt betitelt „Anfrage-Bodyerforderlich“
Medientypapplication/json
object
registration_type
erforderlich
string Format: uuid
note
string
nullable <= 2000 Zeichen
quantity
integer
>= 1
locale

Die Sprache, in der die Anmeldung vorgenommen wurde (it, en): die Sprache der E-Mails an einen Gast und die Ersatzsprache für ein Mitglied, das nie eine gewählt hat. Standard: Accept-Language

string
nullable
Beispielerzeugt
{
  "registration_type": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "note": "example",
  "quantity": 1,
  "locale": "example"
}

Antworten

Abschnitt betitelt „Antworten“

201

Abschnitt betitelt „201“

Angemeldet

Medientypapplication/json
object
id
string Format: uuid
status
string
Erlaubte Werte: reserved confirmed cancelled refunded
event
object
id
string
slug
string
title
string
starts_at
string Format: date-time
ends_at
string Format: date-time
nullable
timezone
string
status
string
location
string
nullable
registration_type
object
uid
string
cod
string
name
string
amount
number
currency
string
quantity
integer
reserved_until
string Format: date-time
nullable
checked_in_at
string Format: date-time
nullable
cancelled_at
string Format: date-time
nullable
cancel_reason
string
nullable
can_cancel
boolean
payment
object
status
string
amount
number
currency
string
method
string
paid_at
string Format: date-time
payment_instructions

Wie der Beitrag zu zahlen ist, solange reserviert

string
nullable
note

Freier Text, den die Person geschrieben hat. Für Clients von Drittanbietern zurückgehalten (null), wenn der Verein erklärt hat, dass er besondere Kategorien von Daten verarbeitet

string
nullable
created_at
string Format: date-time
token

Der QR-Inhalt der Anmeldung (vmt_…), nur bei bestätigten Anmeldungen

string
nullable
Beispiel
{
  "status": "reserved"
}

400

Abschnitt betitelt „400“

Ungültige Anfrage

Medientypapplication/problem+json
object
type
erforderlich
string Format: uri
title
erforderlich
string
status
erforderlich
integer
detail
string
code
erforderlich
string
request_id
string
errors
Array<object>
object
field
string
code
string
message
string
Beispielerzeugt
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "field": "example",
      "code": "example",
      "message": "example"
    }
  ]
}

401

Abschnitt betitelt „401“

Fehlende oder ungültige Zugangsdaten

Medientypapplication/problem+json
object
type
erforderlich
string Format: uri
title
erforderlich
string
status
erforderlich
integer
detail
string
code
erforderlich
string
request_id
string
errors
Array<object>
object
field
string
code
string
message
string
Beispielerzeugt
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "field": "example",
      "code": "example",
      "message": "example"
    }
  ]
}

403

Abschnitt betitelt „403“

Nicht erlaubt

Medientypapplication/problem+json
object
type
erforderlich
string Format: uri
title
erforderlich
string
status
erforderlich
integer
detail
string
code
erforderlich
string
request_id
string
errors
Array<object>
object
field
string
code
string
message
string
Beispielerzeugt
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "field": "example",
      "code": "example",
      "message": "example"
    }
  ]
}

404

Abschnitt betitelt „404“

Nicht gefunden

Medientypapplication/problem+json
object
type
erforderlich
string Format: uri
title
erforderlich
string
status
erforderlich
integer
detail
string
code
erforderlich
string
request_id
string
errors
Array<object>
object
field
string
code
string
message
string
Beispielerzeugt
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "field": "example",
      "code": "example",
      "message": "example"
    }
  ]
}

422

Abschnitt betitelt „422“

Nicht teilnahmeberechtigt (reasons) oder unbekannte Anmeldeart

429

Abschnitt betitelt „429“

Ratenlimit überschritten

Medientypapplication/problem+json
object
type
erforderlich
string Format: uri
title
erforderlich
string
status
erforderlich
integer
detail
string
code
erforderlich
string
request_id
string
errors
Array<object>
object
field
string
code
string
message
string
Beispielerzeugt
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "field": "example",
      "code": "example",
      "message": "example"
    }
  ]
}

500

Abschnitt betitelt „500“

Interner Fehler

Medientypapplication/problem+json
object
type
erforderlich
string Format: uri
title
erforderlich
string
status
erforderlich
integer
detail
string
code
erforderlich
string
request_id
string
errors
Array<object>
object
field
string
code
string
message
string
Beispielerzeugt
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "field": "example",
      "code": "example",
      "message": "example"
    }
  ]
}