Le profil public d’une association : identité visuelle, types d’adhésion, statuto en vigueur

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

Disponible pour les associations qui ont activé l’adhésion publique ou l’accès à l’API. Le statuto est public en vertu de la loi (RUNTS).

Paramètres

Paramètres de chemin

slug

obligatoire

Slug d’adhésion publique de l’association

string

Paramètres de requête

locale

La langue dans laquelle lire le contenu de l’association (it, en) ; par défaut Accept-Language, puis celle de l’association. locale dans la réponse dit ce qui a été servi, locales ce que l’association propose. Le statuto est un acte juridique : il n’est jamais traduit

string

Réponses

200

Profil public

application/json

object

locale

La langue dans laquelle cette réponse est écrite

string

locales

Les langues que l’association propose : la sienne, plus celles qu’elle a activées

Array<string>

aps

obligatoire

object

slug

string

name

string

picture_url

string

nullable

citta

string

nullable

provincia

string

nullable

enroll_enabled

boolean

accepting_requests

Indique si une demande d’adhésion serait prise en ce moment : l’adhésion activée, la place pour un membre de plus dans la formule, l’association prête à recevoir des demandes et sa porte publique ouverte.

boolean

invitation_only

Vaut true tant que Vimine n’enregistre les personnes que sur invitation (la bêta privée) et que cette association ne prend que les personnes qu’elle a invitées : accepting_requests vaut alors false, et POST /v1/enroll répond 403 not_available.

boolean

sandbox

Vaut true pour une sandbox : la copie de test d’une association sur laquelle travaillent les clients de test, avec des membres synthétiques seulement. Elle n’envoie jamais d’e-mail, ne reçoit aucun paiement et n’est jamais dans le Network.

boolean

admission

Comment l’association admet ses membres, pour que l’on puisse dire d’emblée à la personne qui demande à adhérer ce qui l’attend. model : board — la demande attend une décision du conseil de l’association, et l’éventuelle cotisation est payée après ; provisional — admis tout de suite, ratifié plus tard par le conseil ; automatic — active dès que les conditions sont remplies. delay_hours : les heures entre l’admission et une carte UTILISABLE (0 = tout de suite) : l’adhésion est active dès l’admission, la carte ne fait foi à l’entrée qu’ensuite (voir valid_from).

object

model

string

Valeurs autorisées : board provisional automatic

delay_hours

integer

<= 168

approval_required

Conservé pour la compatibilité : vaut true quand admission.model vaut board. Lisez plutôt admission.

boolean

member_address

Indique si l’association recueille l’adresse de ses membres — de tous ou d’aucun. none : ne la demandez pas (une address envoyée malgré tout n’est pas conservée) ; optional ; required : l’adhésion répond 422 sans adresse.

string

Valeurs autorisées : none optional required

payment_instructions

Comment payer la cotisation, dans les mots de l’association

string

nullable

activity_sectors

Les activités d’intérêt général que l’association exerce (Code du tiers secteur italien, art. 5) : cod est la lettre de l’article, description son libellé italien ; l’une d’elles est marquée comme prépondérante.

Array<object>

object

cod

string

description

string

prevalent

boolean

registry

Présent quand l’association est inscrite au RUNTS (le registre national italien des entités du tiers secteur), d’après la vérification faite par la plateforme sur les listes publiques officielles ; null sinon. Jamais saisi par l’association.

object

section

Section du registre

string

nullable

Valeurs autorisées : APS ODV EF IS RA SOMS ALTRI

number

Numéro de répertoire

string

nullable

registered_on

string format : date

nullable

checked_on

Date de la liste officielle utilisée pour la vérification

string format : date

nullable

membership_types

obligatoire

Array<object>

object

uid

string format : uuid

cod

string

name

string

description

string

nullable

quota_amount

number

nullable

currency

string

expiry_model

string

Valeurs autorisées : solar_year rolling_12 rolling_24 prorated_solar custom

network_eligible

boolean

statuto

obligatoire

Exactement un parmi :

object
null

object

aps

object

slug

string

name

string

title

obligatoire

string

version

obligatoire

integer

approved_on

string format : date

nullable

sha256

Du document téléversé, quand il y en a un

string

nullable

content_md

Le texte tel qu’il a été enregistré ; vide quand seul un document a été téléversé

string

content_html

obligatoire

string

document_url

Le document téléversé, un lien valable 15 minutes

string

nullable

privacy_notice

Exactement un parmi :

object
null

object

uid

obligatoire

string format : uuid

version

obligatoire

integer

locale

obligatoire

string

title

string

sha256

string

nullable

effective_from

string format : date-time

nullable

Exemple

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

400

Requête invalide

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

Introuvable

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

429

Limite de débit atteinte

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

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

Le profil public d’une association : identité visuelle, types d’adhésion, statuto en vigueur

Paramètres

Paramètres de chemin

Paramètres de requête

Réponses

200

Exemple

400

Exemplegénéré

404

Exemplegénéré

429

Exemplegénéré

500

Exemplegénéré

Exemple^généré

Exemple^généré

Exemple^généré

Exemple^généré