Um evento público de uma associação, com a disponibilidade em tempo real por tipo de inscrição

GET

/v1/aps/{slug}/events/{event}

curl --request GET \
  --url https://api.vimine.network/v1/aps/example/events/example

• Vimine API

Parâmetros

Parâmetros de caminho

slug

obrigatório

string

event

obrigatório

O slug do evento

string

Parâmetros de consulta

locale

O idioma em que ler os textos da associação (it, en). Padrão: o idioma do próprio associado (token de associado), depois Accept-Language, depois o da associação. Cada texto é a tradução da associação quando ela escreveu uma para um idioma que ativou, senão o seu texto italiano: o locale da resposta diz qual foi servido para o título, locales quais existem. Um valor não suportado é ignorado

string

Respostas

200

Evento

Tipo de mídiaapplication/json

object

id

string formato: uuid

slug

string

locale

O idioma em que o title foi servido. Quando não é o que você pediu, a associação não tem tradução: você recebeu o texto italiano dela, não uma tradução automática

string

locales

Os idiomas em que este evento tem um título — o da própria associação sempre, mais os que ela ativou e escreveu

Array<string>

title

string

summary

string

nullable

description_md

Markdown; renderize-o você mesmo

string

nullable

starts_at

string formato: date-time

ends_at

string formato: date-time

nullable

timezone

string

status

string

Valores permitidos: published completed cancelled

visibility

string

Valores permitidos: members_only public

location

object

name

string

nullable

address

string

nullable

lat

number

nullable

lng

number

nullable

cover_url

string

nullable

gallery

Array<object>

object

url

string

alt

string

nullable

order

integer

links

Array<object>

object

label

string

url

string

registration

object

opens_at

string formato: date-time

nullable

closes_at

string formato: date-time

nullable

capacity

integer

nullable

remaining

integer

nullable

cancellation_hours

integer

registration_types

Array<object>

object

uid

string formato: uuid

cod

string

name

string

description

string

nullable

amount

0 = gratuito

number

currency

string

quantity

integer

nullable

remaining

Vagas restantes (nunca quem as ocupa)

integer

nullable

max_per_user

integer

requires_active_membership

boolean

open

boolean

reason

string

nullable

Valores permitidos: sold_out registration_not_open registration_closed

opens_at

string formato: date-time

nullable

closes_at

string formato: date-time

nullable

published_at

string formato: date-time

nullable

cancelled_at

string formato: date-time

nullable

cancel_reason

string

nullable

Exemplo

{
  "status": "published",
  "visibility": "members_only",
  "registration_types": [
    {
      "reason": "sold_out"
    }
  ]
}

400

Requisição inválida

Tipo de mídiaapplication/problem+json

object

type

obrigatório

string formato: uri

title

obrigatório

string

status

obrigatório

integer

detail

string

code

obrigatório

string

request_id

string

errors

Array<object>

object

field

string

code

string

message

string

Exemplo^gerado

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

404

Desconhecido, rascunho ou só para associados (leia-o com um token de associado)

429

Limite de requisições excedido

Tipo de mídiaapplication/problem+json

object

type

obrigatório

string formato: uri

title

obrigatório

string

status

obrigatório

integer

detail

string

code

obrigatório

string

request_id

string

errors

Array<object>

object

field

string

code

string

message

string

Exemplo^gerado

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

500

Erro interno

Tipo de mídiaapplication/problem+json

object

type

obrigatório

string formato: uri

title

obrigatório

string

status

obrigatório

integer

detail

string

code

obrigatório

string

request_id

string

errors

Array<object>

object

field

string

code

string

message

string

Exemplo^gerado

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