L’inscription d’un invité et son code QR (lien reçu par 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

Lit l’inscription désignée par le jeton du lien qu’un invité reçoit une fois sa place confirmée : son status et, tant qu’elle est confirmée, le token du QR à présenter à l’entrée. Ne modifie rien. Le lien fonctionne jusqu’à la fin de l’événement — 12 h après sa fin, ou un jour après le début d’un événement sans date de fin — d’après l’événement tel qu’il est au moment où le lien est utilisé : un événement reporté le conserve donc. Une inscription annulée ou remboursée reçoit en réponse son état, sans QR. La note de la personne ne fait jamais partie de cette réponse.

Paramètres

Paramètres de requête

locale

La langue dans laquelle lire le contenu de l’association (it, en). Par défaut : la langue du membre lui-même (jeton de membre), puis Accept-Language, puis celle de l’association. Chaque texte est la traduction de l’association quand elle en a écrit une pour une langue qu’elle a activée, son texte italien sinon : le locale de la réponse dit laquelle a été servie pour le titre, locales lesquelles existent. Une valeur non prise en charge est ignorée

string

Corps de la requête^obligatoire

Type de médiaapplication/json

object

token

obligatoire

string

Exemple^généré

{
  "token": "example"
}

Réponses

200

L’inscription

Type de médiaapplication/json

object

id

string format : uuid

status

string

Valeurs autorisées : 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

Comment payer la contribution, tant que l’inscription est réservée

string

nullable

note

Texte libre écrit par la personne. Non transmis (null) aux clients tiers quand l’association a déclaré traiter des catégories particulières de données

string

nullable

created_at

string format : date-time

token

Le contenu du QR de l’inscription (vmt_…), inscriptions confirmées seulement

string

nullable

Exemple

{
  "status": "reserved"
}

400

Le lien est invalide ou a expiré (invalid_token)

404

Introuvable

Type de médiaapplication/problem+json

object

type

obligatoire

string format : uri

title

obligatoire

string

status

obligatoire

integer

detail

string

code

obligatoire

string

request_id

string

errors

Array<object>

object

field

string

code

string

message

string

Exemple^généré

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

429

Limite de débit atteinte

Type de médiaapplication/problem+json

object

type

obligatoire

string format : uri

title

obligatoire

string

status

obligatoire

integer

detail

string

code

obligatoire

string

request_id

string

errors

Array<object>

object

field

string

code

string

message

string

Exemple^généré

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

500

Erreur interne

Type de médiaapplication/problem+json

object

type

obligatoire

string format : uri

title

obligatoire

string

status

obligatoire

integer

detail

string

code

obligatoire

string

request_id

string

errors

Array<object>

object

field

string

code

string

message

string

Exemple^généré

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