L'iscrizione di un ospite e il suo codice QR (dal link nell'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

Legge l’iscrizione indicata dal token nel link che un ospite riceve quando il suo posto è confermato: il suo status e, finché è confermata, il token del QR da mostrare all’ingresso. Non cambia nulla. Il link funziona fino alla fine dell’evento — 12 h dopo la sua fine, o un giorno dopo l’inizio di un evento senza un orario di fine — secondo l’evento com’è quando il link viene usato, quindi un evento spostato lo conserva. A un’iscrizione annullata o rimborsata si risponde con il suo stato e senza QR. La note della persona non fa mai parte di questa risposta.

Parametri

Parametri di query

locale

La lingua in cui leggere i testi dell’associazione (it, en). Predefinita: la lingua del socio (con un token del socio), poi Accept-Language, poi quella dell’associazione. Ogni testo è la traduzione dell’associazione quando ne ha scritta una per una lingua che ha abilitato, altrimenti il suo testo italiano: locale nella risposta dice quale lingua è stata servita per il titolo, locales quali esistono. Un valore non supportato viene ignorato

string

Corpo della richiesta^obbligatorio

Tipo di contenutoapplication/json

object

token

obbligatorio

string

Esempio^generato

{
  "token": "example"
}

Risposte

200

L’iscrizione

Tipo di contenutoapplication/json

object

id

string formato: uuid

status

string

Valori ammessi: reserved confirmed cancelled refunded

event

object

id

string

slug

string

title

string

starts_at

string formato: date-time

ends_at

string formato: 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 formato: date-time

nullable

checked_in_at

string formato: date-time

nullable

cancelled_at

string formato: date-time

nullable

cancel_reason

string

nullable

can_cancel

boolean

payment

object

status

string

amount

number

currency

string

method

string

paid_at

string formato: date-time

payment_instructions

Come versare il contributo finché l’iscrizione è riservata

string

nullable

note

Testo libero scritto dalla persona. Nascosto (null) ai client di terze parti quando l’associazione ha dichiarato di trattare categorie particolari di dati

string

nullable

created_at

string formato: date-time

token

Il contenuto del QR dell’iscrizione (vmt_…), solo per le iscrizioni confermate

string

nullable

Esempio

{
  "status": "reserved"
}

400

Il link non è valido o è scaduto (invalid_token)

404

Non trovato

Tipo di contenutoapplication/problem+json

object

type

obbligatorio

string formato: uri

title

obbligatorio

string

status

obbligatorio

integer

detail

string

code

obbligatorio

string

request_id

string

errors

Array<object>

object

field

string

code

string

message

string

Esempio^generato

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

429

Troppe richieste

Tipo di contenutoapplication/problem+json

object

type

obbligatorio

string formato: uri

title

obbligatorio

string

status

obbligatorio

integer

detail

string

code

obbligatorio

string

request_id

string

errors

Array<object>

object

field

string

code

string

message

string

Esempio^generato

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

500

Errore interno

Tipo di contenutoapplication/problem+json

object

type

obbligatorio

string formato: uri

title

obbligatorio

string

status

obbligatorio

integer

detail

string

code

obbligatorio

string

request_id

string

errors

Array<object>

object

field

string

code

string

message

string

Esempio^generato

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