Il profilo pubblico di un'associazione: grafica, tipi di tessera, statuto in vigore

GET

/v1/aps/{slug}

const url = 'https://api.vimine.network/v1/aps/example';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

Disponibile per le associazioni che hanno attivato il tesseramento pubblico o l’accesso via API. Lo statuto è pubblico per legge (RUNTS).

Parametri

Parametri di percorso

slug

obbligatorio

Slug dell’associazione per il tesseramento pubblico

string

Parametri di query

locale

La lingua in cui leggere i testi dell’associazione (it, en); predefinita: Accept-Language, poi quella dell’associazione. locale nella risposta dice quale lingua è stata servita, locales quali offre l’associazione. Lo statuto è un documento legale: non viene mai tradotto

string

Risposte

200

Profilo pubblico

application/json

object

locale

La lingua in cui è scritta questa risposta

string

locales

Le lingue che l’associazione offre: la sua, più quelle che ha abilitato

Array<string>

aps

obbligatorio

object

slug

string

name

string

picture_url

string

nullable

citta

string

nullable

provincia

string

nullable

website

Il sito web dell’associazione (http o https), o null se non ne ha indicato uno

string formato: uri

nullable

enroll_enabled

boolean

accepting_requests

Se una richiesta di tesseramento verrebbe accolta adesso: tesseramento attivo, posto nel piano per un socio in più, l’associazione pronta a raccogliere richieste e la sua porta pubblica aperta.

boolean

invitation_only

Vale true finché su Vimine ci si registra solo su invito (la beta privata) e questa associazione accoglie solo le persone che ha invitato: allora accepting_requests è false e POST /v1/enroll risponde 403 not_available.

boolean

sandbox

Vale true per una sandbox: la copia di prova di un’associazione su cui lavorano i client di test, con soli soci sintetici. Non invia mai e-mail, non incassa pagamenti e non fa mai parte del circuito.

boolean

admission

Come l’associazione ammette i soci, per dire subito a chi fa domanda cosa aspettarsi. model: board — la domanda attende una decisione del consiglio dell’associazione, e l’eventuale quota si versa dopo; provisional — ammesso subito, ratificato dal consiglio più tardi; automatic — attiva appena le condizioni sono soddisfatte. delay_hours: le ore tra l’ammissione e una tessera UTILIZZABILE (0 = subito): l’adesione è attiva dall’ammissione, la tessera vale alla porta solo dopo (vedi valid_from).

object

model

string

Valori ammessi: board provisional automatic

delay_hours

integer

<= 168

approval_required

Resta per compatibilità: vale true quando admission.model è board. Leggi invece admission.

boolean

member_address

Se l’associazione raccoglie l’indirizzo dei soci — di tutti o di nessuno. none: non chiederlo (un address inviato comunque non viene conservato); optional; required: senza indirizzo l’iscrizione risponde 422.

string

Valori ammessi: none optional required

payment_instructions

Come versare la quota, con le parole dell’associazione

string

nullable

activity_sectors

Le attività di interesse generale che l’associazione svolge (Codice del Terzo settore, art. 5): cod è la lettera dell’articolo, description la sua formulazione in italiano; una è indicata come prevalente.

Array<object>

object

cod

string

description

string

prevalent

boolean

registry

Presente quando l’associazione è iscritta al RUNTS (il Registro unico nazionale del Terzo settore), secondo il controllo della piattaforma sugli elenchi pubblici ufficiali; null altrimenti. Mai inserito a mano dall’associazione.

object

section

Sezione del registro

string

nullable

Valori ammessi: APS ODV EF IS RA SOMS ALTRI

number

Numero di repertorio

string

nullable

registered_on

string formato: date

nullable

checked_on

Data dell’elenco ufficiale su cui è stato fatto il controllo

string formato: date

nullable

membership_types

obbligatorio

Array<object>

object

uid

string formato: uuid

cod

string

name

string

description

string

nullable

quota_amount

number

nullable

currency

string

expiry_model

string

Valori ammessi: solar_year rolling_12 rolling_24 prorated_solar custom

network_eligible

boolean

statuto

obbligatorio

Esattamente uno tra:

object
null

object

aps

object

slug

string

name

string

title

obbligatorio

string

version

obbligatorio

integer

approved_on

string formato: date

nullable

sha256

Del documento caricato, quando c’è

string

nullable

content_md

Il testo come registrato; vuoto quando è stato caricato solo un documento

string

content_html

obbligatorio

string

document_url

Il documento caricato, un link valido 15 minuti

string

nullable

privacy_notice

Esattamente uno tra:

object
null

object

uid

obbligatorio

string formato: uuid

version

obbligatorio

integer

locale

obbligatorio

string

title

string

sha256

string

nullable

effective_from

string formato: date-time

nullable

Esempio

{
  "aps": {
    "admission": {
      "model": "board"
    },
    "member_address": "none",
    "registry": {
      "section": "APS"
    }
  },
  "membership_types": [
    {
      "expiry_model": "solar_year"
    }
  ]
}

400

Richiesta non valida

application/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

Esempio^generato

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

404

Non trovato

application/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

Esempio^generato

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

429

Troppe richieste

application/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

Esempio^generato

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

500

Errore interno

application/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

Esempio^generato

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

Il profilo pubblico di un'associazione: grafica, tipi di tessera, statuto in vigore

Parametri

Parametri di percorso

Parametri di query

Risposte

200

Esempio

400

Esempiogenerato

404

Esempiogenerato

429

Esempiogenerato

500

Esempiogenerato

Esempio^generato

Esempio^generato

Esempio^generato

Esempio^generato