Das öffentliche Profil eines Vereins: Erscheinungsbild, Mitgliedsarten, geltendes Statuto

GET

/v1/aps/{slug}

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

• Vimine API

Verfügbar für Vereine, die den öffentlichen Beitritt oder den API-Zugang aktiviert haben. Das Statuto ist von Gesetzes wegen öffentlich (RUNTS).

Parameter

Pfadparameter

slug

erforderlich

Slug des Vereins für den öffentlichen Beitritt

string

Query-Parameter

locale

Die Sprache, in der die Texte des Vereins gelesen werden (it, en); Standard Accept-Language, dann die des Vereins. locale in der Antwort sagt, was geliefert wurde, locales, was der Verein anbietet. Das Statuto ist ein Rechtsakt: Es wird nie übersetzt

string

Antworten

200

Öffentliches Profil

Medientypapplication/json

object

locale

Die Sprache, in der diese Antwort geschrieben ist

string

locales

Die Sprachen, die der Verein anbietet: seine eigene und die, die er aktiviert hat

Array<string>

aps

erforderlich

object

slug

string

name

string

picture_url

string

nullable

citta

string

nullable

provincia

string

nullable

enroll_enabled

boolean

accepting_requests

Ob jetzt ein Beitrittsantrag entgegengenommen würde: Beitritt eingeschaltet, im Tarif Platz für ein weiteres Mitglied, der Verein bereit, Anträge zu empfangen, und sein öffentlicher Zugang offen.

boolean

invitation_only

True, solange Vimine Personen nur auf Einladung registriert (die private Beta) und dieser Verein nur die Personen aufnimmt, die er eingeladen hat: accepting_requests ist dann false, und POST /v1/enroll antwortet 403 not_available.

boolean

sandbox

True bei einer Sandbox: die Testkopie eines Vereins, mit der Test-Clients arbeiten, nur mit synthetischen Mitgliedern. Sie versendet nie E-Mails, nimmt keine Zahlungen an und ist nie Teil des Vimine-Netzwerks.

boolean

admission

Wie der Verein seine Mitglieder aufnimmt, damit man einer antragstellenden Person vorab sagen kann, was sie erwartet. model: board — der Antrag wartet auf eine Entscheidung des Vorstands des Vereins, und ein etwaiger Mitgliedsbeitrag wird danach gezahlt; provisional — sofort aufgenommen, später vom Vorstand bestätigt; automatic — aktiv, sobald die Bedingungen erfüllt sind. delay_hours: die Stunden zwischen der Aufnahme und einem NUTZBAREN Ausweis (0 = sofort): Die Mitgliedschaft ist ab der Aufnahme aktiv, der Ausweis gilt am Einlass erst danach (siehe valid_from).

object

model

string

Erlaubte Werte: board provisional automatic

delay_hours

integer

<= 168

approval_required

Aus Kompatibilitätsgründen beibehalten: true, wenn admission.model gleich board ist. Lesen Sie stattdessen admission.

boolean

member_address

Ob der Verein die Adresse seiner Mitglieder erfasst — von allen Mitgliedern oder von keinem. none: nicht fragen (eine trotzdem gesendete address wird nicht gespeichert); optional; required: Ohne Adresse antwortet der Beitritt mit 422.

string

Erlaubte Werte: none optional required

payment_instructions

Wie der Mitgliedsbeitrag zu zahlen ist, in den Worten des Vereins

string

nullable

activity_sectors

Die Tätigkeiten von allgemeinem Interesse, die der Verein ausübt (italienischer Kodex des Dritten Sektors, Art. 5): cod ist der Buchstabe des Artikels, description sein italienischer Wortlaut; eine ist als überwiegend gekennzeichnet.

Array<object>

object

cod

string

description

string

prevalent

boolean

registry

Vorhanden, wenn der Verein im RUNTS eingetragen ist (dem italienischen nationalen Register der Organisationen des Dritten Sektors), wie von der Plattform anhand der offiziellen öffentlichen Listen geprüft; sonst null. Nie vom Verein eingegeben.

object

section

Sektion des Registers

string

nullable

Erlaubte Werte: APS ODV EF IS RA SOMS ALTRI

number

Repertoriumsnummer

string

nullable

registered_on

string Format: date

nullable

checked_on

Datum der offiziellen Liste, anhand derer geprüft wurde

string Format: date

nullable

membership_types

erforderlich

Array<object>

object

uid

string Format: uuid

cod

string

name

string

description

string

nullable

quota_amount

number

nullable

currency

string

expiry_model

string

Erlaubte Werte: solar_year rolling_12 rolling_24 prorated_solar custom

network_eligible

boolean

statuto

erforderlich

Genau eines von:

object

object

aps

object

slug

string

name

string

title

erforderlich

string

version

erforderlich

integer

approved_on

string Format: date

nullable

sha256

Des hochgeladenen Dokuments, falls es eines gibt

string

nullable

content_md

Der Text wie hinterlegt; leer, wenn nur ein Dokument hochgeladen wurde

string

content_html

erforderlich

string

document_url

Das hochgeladene Dokument, ein Link, der 15 Minuten gültig ist

string

nullable

null

null

privacy_notice

Genau eines von:

object

object

uid

erforderlich

string Format: uuid

version

erforderlich

integer

locale

erforderlich

string

title

string

sha256

string

nullable

effective_from

string Format: date-time

nullable

null

null

Beispiel

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

400

Ungültige Anfrage

Medientypapplication/problem+json

object

type

erforderlich

string Format: uri

title

erforderlich

string

status

erforderlich

integer

detail

string

code

erforderlich

string

request_id

string

errors

Array<object>

object

field

string

code

string

message

string

Beispiel^erzeugt

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

404

Nicht gefunden

Medientypapplication/problem+json

object

type

erforderlich

string Format: uri

title

erforderlich

string

status

erforderlich

integer

detail

string

code

erforderlich

string

request_id

string

errors

Array<object>

object

field

string

code

string

message

string

Beispiel^erzeugt

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

429

Ratenlimit überschritten

Medientypapplication/problem+json

object

type

erforderlich

string Format: uri

title

erforderlich

string

status

erforderlich

integer

detail

string

code

erforderlich

string

request_id

string

errors

Array<object>

object

field

string

code

string

message

string

Beispiel^erzeugt

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

500

Interner Fehler

Medientypapplication/problem+json

object

type

erforderlich

string Format: uri

title

erforderlich

string

status

erforderlich

integer

detail

string

code

erforderlich

string

request_id

string

errors

Array<object>

object

field

string

code

string

message

string

Beispiel^erzeugt

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