Un événement public d’une association, avec la disponibilité en temps réel par type d’inscription

GET

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

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

• Vimine API

Paramètres

Paramètres de chemin

slug

obligatoire

string

event

obligatoire

Le slug de l’événement

string

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

Réponses

200

Événement

Type de médiaapplication/json

object

id

string format : uuid

slug

string

locale

La langue dans laquelle le title a été servi. Quand ce n’est pas celle que vous avez demandée, l’association n’a pas de traduction : vous avez reçu son texte italien, pas une traduction automatique

string

locales

Les langues dans lesquelles cet événement a un titre — toujours celle de l’association, plus celles qu’elle a activées et dans lesquelles elle l’a écrit

Array<string>

title

string

summary

string

nullable

description_md

Markdown ; faites-en le rendu vous-même

string

nullable

starts_at

string format : date-time

ends_at

string format : date-time

nullable

timezone

string

status

string

Valeurs autorisées : published completed cancelled

visibility

string

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

nullable

closes_at

string format : date-time

nullable

capacity

integer

nullable

remaining

integer

nullable

cancellation_hours

integer

registration_types

Array<object>

object

uid

string format : uuid

cod

string

name

string

description

string

nullable

amount

0 = gratuit

number

currency

string

quantity

integer

nullable

remaining

Places restantes (jamais qui les occupe)

integer

nullable

max_per_user

integer

requires_active_membership

boolean

open

boolean

reason

string

nullable

Valeurs autorisées : sold_out registration_not_open registration_closed

opens_at

string format : date-time

nullable

closes_at

string format : date-time

nullable

published_at

string format : date-time

nullable

cancelled_at

string format : date-time

nullable

cancel_reason

string

nullable

Exemple

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

400

Requête invalide

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

404

Inconnu, brouillon ou réservé aux membres (lisez-le avec un jeton de membre)

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