Salta ai contenuti
Vimine per sviluppatori
IT

Gli eventi pubblici di un'associazione

GET
/v1/aps/{slug}/events
curl --request GET \
  --url 'https://api.vimine.network/v1/aps/example/events?filter=upcoming'

Gli eventi pubblicati con visibility: public, dai più vicini (filter=upcoming predefinito; past, cancelled, all). Gli eventi riservati ai soci non sono elencati qui: leggili con un token del socio su GET /v1/events.

Parametri

Sezione intitolata “Parametri”

Parametri di percorso

Sezione intitolata “Parametri di percorso”
slug
obbligatorio

Slug pubblico dell’associazione

string

Parametri di query

Sezione intitolata “Parametri di query”
locale

La lingua in cui leggere i testi dell’associazione (it, en). Predefinita: la lingua del socio (con un token del socio), poi Accept-Language, poi quella dell’associazione. Ogni testo è la traduzione dell’associazione quando ne ha scritta una per una lingua che ha abilitato, altrimenti il suo testo italiano: locale nella risposta dice quale lingua è stata servita per il titolo, locales quali esistono. Un valore non supportato viene ignorato

string
filter
string
Valori ammessi: upcoming past cancelled all
from
string formato: date-time
to
string formato: date-time
limit
integer
>= 1 <= 200

Risposte

Sezione intitolata “Risposte”

200

Sezione intitolata “200”

Eventi

Tipo di contenutoapplication/json
object
items
Array<object>
object
id
string formato: uuid
slug
string
locale

La lingua in cui è stato servito il title. Quando non è quella che hai chiesto, l’associazione non ha una traduzione: hai ricevuto il suo testo italiano, non una traduzione automatica

string
locales

Le lingue in cui questo evento ha un titolo — sempre quella dell’associazione, più quelle che ha abilitato e in cui ha scritto

Array<string>
title
string
summary
string
nullable
description_md

Markdown; la resa è a cura tua

string
nullable
starts_at
string formato: date-time
ends_at
string formato: date-time
nullable
timezone
string
status
string
Valori ammessi: published completed cancelled
visibility
string
Valori ammessi: 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 = gratuita

number
currency
string
quantity
integer
nullable
remaining

Posti rimasti (mai chi li occupa)

integer
nullable
max_per_user
integer
requires_active_membership
boolean
open
boolean
reason
string
nullable
Valori ammessi: 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
Esempio
{
  "items": [
    {
      "status": "published",
      "visibility": "members_only",
      "registration_types": [
        {
          "reason": "sold_out"
        }
      ]
    }
  ]
}

400

Sezione intitolata “400”

Richiesta non valida

Tipo di contenutoapplication/problem+json
object
type
obbligatorio
string formato: uri
title
obbligatorio
string
status
obbligatorio
integer
detail
string
code
obbligatorio
string
request_id
string
errors
Array<object>
object
field
string
code
string
message
string
Esempiogenerato
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "field": "example",
      "code": "example",
      "message": "example"
    }
  ]
}

404

Sezione intitolata “404”

Non trovato

Tipo di contenutoapplication/problem+json
object
type
obbligatorio
string formato: uri
title
obbligatorio
string
status
obbligatorio
integer
detail
string
code
obbligatorio
string
request_id
string
errors
Array<object>
object
field
string
code
string
message
string
Esempiogenerato
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "field": "example",
      "code": "example",
      "message": "example"
    }
  ]
}

429

Sezione intitolata “429”

Troppe richieste

Tipo di contenutoapplication/problem+json
object
type
obbligatorio
string formato: uri
title
obbligatorio
string
status
obbligatorio
integer
detail
string
code
obbligatorio
string
request_id
string
errors
Array<object>
object
field
string
code
string
message
string
Esempiogenerato
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "field": "example",
      "code": "example",
      "message": "example"
    }
  ]
}

500

Sezione intitolata “500”

Errore interno

Tipo di contenutoapplication/problem+json
object
type
obbligatorio
string formato: uri
title
obbligatorio
string
status
obbligatorio
integer
detail
string
code
obbligatorio
string
request_id
string
errors
Array<object>
object
field
string
code
string
message
string
Esempiogenerato
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "field": "example",
      "code": "example",
      "message": "example"
    }
  ]
}