Die Anmeldung eines Gasts und ihr QR-Code (Link aus der E-Mail)

POST

/v1/registrations/view

curl --request POST \
  --url https://api.vimine.network/v1/registrations/view \
  --header 'Content-Type: application/json' \
  --data '{ "token": "example" }'

• Vimine API

Liest die Anmeldung, die das Token im Link nennt, den ein Gast erhält, sobald sein Platz bestätigt ist: ihren status und, solange sie bestätigt ist, das QR-token, das am Einlass vorzuzeigen ist. Ändert nichts. Der Link funktioniert, bis die Veranstaltung vorbei ist — 12 h nach ihrem Ende oder einen Tag nach dem Beginn einer Veranstaltung ohne Ende —, und zwar nach dem Stand der Veranstaltung, wenn der Link verwendet wird; eine verschobene Veranstaltung behält ihn also. Eine stornierte oder erstattete Anmeldung wird mit ihrem Status und ohne QR-Code beantwortet. Die note der Person ist nie Teil dieser Antwort.

Parameter

Query-Parameter

locale

Die Sprache, in der die Texte des Vereins gelesen werden (it, en). Standard: die eigene Sprache des Mitglieds (Mitglieder-Token), dann Accept-Language, dann die des Vereins. Jeder Text ist die Übersetzung des Vereins, wenn er eine für eine von ihm aktivierte Sprache geschrieben hat, sonst sein italienischer Text: locale in der Antwort sagt, welche für den Titel geliefert wurde, locales, welche es gibt. Ein nicht unterstützter Wert wird ignoriert

string

Anfrage-Body^erforderlich

Medientypapplication/json

object

token

erforderlich

string

Beispiel^erzeugt

{
  "token": "example"
}

Antworten

200

Die Anmeldung

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

Der Link ist ungültig oder abgelaufen (invalid_token)

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

Beispiel^erzeugt

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "field": "example",
      "code": "example",
      "message": "example"
    }
  ]
}

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

Beispiel^erzeugt

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "field": "example",
      "code": "example",
      "message": "example"
    }
  ]
}

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

Beispiel^erzeugt

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "field": "example",
      "code": "example",
      "message": "example"
    }
  ]
}