Skip to content
Vimine for developers
EN

Register the signed-in member for an event

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" }'

Free type: 201 with status: confirmed and the QR token. Paid type: 201 with status: reserved, the amount and the association’s payment_instructions; the registration is confirmed when the association records the contribution (Stripe Checkout arrives with Phase L3). 422 not_eligible carries the reasons (see eligibility).

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
slug
required
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
registration_type
required
string format: uuid
note
string
nullable <= 2000 characters
quantity
integer
>= 1
locale

The language the registration was made in (it, en): the language of the mails to a guest, and the fallback for a member who never chose one. Defaults to Accept-Language

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

Responses

Section titled “Responses”

201

Section titled “201”

Registered

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”

Invalid request

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"
    }
  ]
}

401

Section titled “401”

Missing or invalid credentials

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"
    }
  ]
}

403

Section titled “403”

Not allowed

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"
    }
  ]
}

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"
    }
  ]
}

422

Section titled “422”

Not eligible (reasons) or unknown registration type

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"
    }
  ]
}