An association's public profile: branding, membership types, in-force statuto

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

Available for associations that enabled public enrollment or API access. The statuto is public by law (RUNTS).

Parameters

Path Parameters

slug

required

Public enrollment slug of the association

string

Query Parameters

locale

The language to read the association’s copy in (it, en); default Accept-Language, then the association’s. locale in the answer says what was served, locales what the association offers. The statuto is a legal record: it is never translated

string

Responses

200

Public profile

application/json

object

locale

The language this answer is written in

string

locales

The languages the association offers: its own, plus those it enabled

Array<string>

aps

required

object

slug

string

name

string

picture_url

string

nullable

citta

string

nullable

provincia

string

nullable

website

The association’s own website (http or https), or null when it gave none

string format: uri

nullable

enroll_enabled

boolean

accepting_requests

Whether a membership request would be taken now: enrolment on, a member more fits the plan, the association ready to collect requests, and its public door open.

boolean

invitation_only

True while Vimine registers people by invitation only (the private beta) and this association takes only the people it invited: accepting_requests is then false, and POST /v1/enroll answers 403 not_available.

boolean

sandbox

True for a sandbox: the test copy of an association that test clients work on, with synthetic members only. It never sends e-mail, takes no payments and is never in the Network.

boolean

admission

How the association admits its members, so that an applicant can be told up front what to expect. model: board — the request waits for a decision of the association’s board, and any fee is paid after it; provisional — admitted at once, ratified by the board later; automatic — active as soon as the conditions are met. delay_hours: the hours between admission and a USABLE card (0 = at once): the membership is active from admission, the card counts at the door only afterwards (see valid_from).

object

model

string

Allowed values: board provisional automatic

delay_hours

integer

<= 168

approval_required

Kept for compatibility: true when admission.model is board. Read admission instead.

boolean

member_address

Whether the association collects its members’ address — of every member or of nobody. none: do not ask (an address sent anyway is not stored); optional; required: enrolment answers 422 without one.

string

Allowed values: none optional required

payment_instructions

How to pay the fee, as the association words it

string

nullable

activity_sectors

The activities of general interest the association carries out (Italian Third Sector Code, art. 5): cod is the letter of the article, description its Italian wording; one is marked as prevalent.

Array<object>

object

cod

string

description

string

prevalent

boolean

registry

Present when the association is registered in the RUNTS (the Italian national register of Third Sector entities), as checked by the platform against the official public lists; null otherwise. Never typed by the association.

object

section

Section of the register

string

nullable

Allowed values: APS ODV EF IS RA SOMS ALTRI

number

Repertory number

string

nullable

registered_on

string format: date

nullable

checked_on

Date of the official list the check ran against

string format: date

nullable

membership_types

required

Array<object>

object

uid

string format: uuid

cod

string

name

string

description

string

nullable

quota_amount

number

nullable

currency

string

expiry_model

string

Allowed values: solar_year rolling_12 rolling_24 prorated_solar custom

network_eligible

boolean

statuto

required

One of:

object
null

object

aps

object

slug

string

name

string

title

required

string

version

required

integer

approved_on

string format: date

nullable

sha256

Of the uploaded document, when there is one

string

nullable

content_md

The text as registered; empty when only a document was uploaded

string

content_html

required

string

document_url

The uploaded document, a link valid for 15 minutes

string

nullable

privacy_notice

One of:

object
null

object

uid

required

string format: uuid

version

required

integer

locale

required

string

title

string

sha256

string

nullable

effective_from

string format: date-time

nullable

Example

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

400

Invalid request

application/problem+json

object

type

required

string format: uri

title

required

string

status

required

integer

detail

string

code

required

string

request_id

string

errors

Array<object>

object

field

string

code

string

message

string

Example^generated

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

404

Not found

application/problem+json

object

type

required

string format: uri

title

required

string

status

required

integer

detail

string

code

required

string

request_id

string

errors

Array<object>

object

field

string

code

string

message

string

Example^generated

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

429

Rate limited

application/problem+json

object

type

required

string format: uri

title

required

string

status

required

integer

detail

string

code

required

string

request_id

string

errors

Array<object>

object

field

string

code

string

message

string

Example^generated

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

500

Internal error

application/problem+json

object

type

required

string format: uri

title

required

string

status

required

integer

detail

string

code

required

string

request_id

string

errors

Array<object>

object

field

string

code

string

message

string

Example^generated

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

An association's public profile: branding, membership types, in-force statuto

Parameters

Path Parameters

Query Parameters

Responses

200

Example

400

Examplegenerated

404

Examplegenerated

429

Examplegenerated

500

Examplegenerated

Example^generated

Example^generated

Example^generated

Example^generated