Skip to content
Vimine for developers
EN

A guest’s registration and its QR code (link from the 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" }'

Reads the registration named by the token in the link a guest receives once their place is confirmed: its status and, while it is confirmed, the QR token to show at the door. Changes nothing. The link works until the event is over — 12 h after its end, or a day after the start of an event with no end — as the event stands when the link is used, so a postponed event keeps it. A cancelled or refunded registration is answered with its status and no QR. The person’s note is never part of this answer.

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
locale

The language to read the association’s copy in (it, en). Default: the member’s own language (member token), then Accept-Language, then the association’s. Each text is the association’s translation when it wrote one for a language it enabled, its Italian text otherwise: the answer’s locale says which was served for the title, locales which exist. An unsupported value is ignored

string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
token
required
string
Examplegenerated
{
  "token": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

The registration

Media typeapplication/json
object
id
string format: uuid
status
string
Allowed values: 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

How to pay the contribution while reserved

string
nullable
note

Free text the person wrote. Withheld (null) from third-party clients when the association declared it processes special categories of data

string
nullable
created_at
string format: date-time
token

The registration QR payload (vmt_…), confirmed registrations only

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

400

Section titled “400”

The link is invalid or has expired (invalid_token)

404

Section titled “404”

Not found

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
detail
string
code
required
string
request_id
string
errors
Array<object>
object
field
string
code
string
message
string
Examplegenerated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "field": "example",
      "code": "example",
      "message": "example"
    }
  ]
}

429

Section titled “429”

Rate limited

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
detail
string
code
required
string
request_id
string
errors
Array<object>
object
field
string
code
string
message
string
Examplegenerated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "field": "example",
      "code": "example",
      "message": "example"
    }
  ]
}

500

Section titled “500”

Internal error

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
detail
string
code
required
string
request_id
string
errors
Array<object>
object
field
string
code
string
message
string
Examplegenerated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "field": "example",
      "code": "example",
      "message": "example"
    }
  ]
}