El perfil público de una asociación: imagen, tipos de carné, estatuto en vigor

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 para las asociaciones que han activado la inscripción pública o el acceso a la API. El estatuto es público por ley (RUNTS).

Parámetros

Parámetros de ruta

slug

obligatorio

Slug de inscripción pública de la asociación

string

Parámetros de consulta

locale

El idioma en el que leer los textos de la asociación (it, en); por defecto, Accept-Language y, después, el de la asociación. locale en la respuesta dice qué se ha servido; locales, lo que ofrece la asociación. El estatuto es un acto jurídico: nunca se traduce

string

Respuestas

200

Perfil público

application/json

object

locale

El idioma en el que está escrita esta respuesta

string

locales

Los idiomas que ofrece la asociación: el suyo, más los que ha activado

Array<string>

aps

obligatorio

object

slug

string

name

string

picture_url

string

nullable

citta

string

nullable

provincia

string

nullable

enroll_enabled

boolean

accepting_requests

Si ahora se aceptaría una solicitud de inscripción: la inscripción activada, sitio en el plan para un socio más, la asociación lista para recoger solicitudes y su puerta pública abierta.

boolean

invitation_only

Es true mientras Vimine registra a las personas solo por invitación (la beta privada) y esta asociación solo admite a las personas que ha invitado: accepting_requests es entonces false, y POST /v1/enroll responde 403 not_available.

boolean

sandbox

Es true en un sandbox: la copia de prueba de una asociación sobre la que trabajan los clientes de prueba, solo con socios sintéticos. Nunca envía correos, no acepta pagos y nunca forma parte del Network.

boolean

admission

Cómo admite la asociación a sus socios, para poder decir de antemano a quien solicita qué esperar. model: board — la solicitud espera una decisión de la junta directiva de la asociación, y la posible cuota se paga después; provisional — admitido enseguida, ratificado más tarde por la junta directiva; automatic — activo en cuanto se cumplen las condiciones. delay_hours: las horas entre la admisión y un carné QUE SE PUEDE USAR (0 = de inmediato): la inscripción está activa desde la admisión, el carné vale en la entrada solo después (consulta valid_from).

object

model

string

Valores permitidos: board provisional automatic

delay_hours

integer

<= 168

approval_required

Se mantiene por compatibilidad: true cuando admission.model es board. Lee admission en su lugar.

boolean

member_address

Si la asociación recoge la dirección de sus socios — de todos o de ninguno. none: no la pidas (un address enviado de todas formas no se guarda); optional; required: la inscripción responde 422 sin ella.

string

Valores permitidos: none optional required

payment_instructions

Cómo pagar la cuota, tal como lo expresa la asociación

string

nullable

activity_sectors

Las actividades de interés general que lleva a cabo la asociación (Código del Tercer Sector italiano, art. 5): cod es la letra del artículo, description su texto en italiano; una está marcada como principal.

Array<object>

object

cod

string

description

string

prevalent

boolean

registry

Presente cuando la asociación está inscrita en el RUNTS (el registro nacional italiano de las entidades del Tercer Sector), según la comprobación de la plataforma con las listas públicas oficiales; null en los demás casos. Nunca lo escribe la asociación.

object

section

Sección del registro

string

nullable

Valores permitidos: APS ODV EF IS RA SOMS ALTRI

number

Número de repertorio

string

nullable

registered_on

string formato: date

nullable

checked_on

Fecha de la lista oficial con la que se hizo la comprobación

string formato: date

nullable

membership_types

obligatorio

Array<object>

object

uid

string formato: uuid

cod

string

name

string

description

string

nullable

quota_amount

number

nullable

currency

string

expiry_model

string

Valores permitidos: solar_year rolling_12 rolling_24 prorated_solar custom

network_eligible

boolean

statuto

obligatorio

Uno de:

object
null

object

aps

object

slug

string

name

string

title

obligatorio

string

version

obligatorio

integer

approved_on

string formato: date

nullable

sha256

Del documento subido, cuando lo hay

string

nullable

content_md

El texto tal como se registró; vacío cuando solo se subió un documento

string

content_html

obligatorio

string

document_url

El documento subido, un enlace válido durante 15 minutos

string

nullable

privacy_notice

Uno de:

object
null

object

uid

obligatorio

string formato: uuid

version

obligatorio

integer

locale

obligatorio

string

title

string

sha256

string

nullable

effective_from

string formato: date-time

nullable

Ejemplo

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

400

Petición no válida

application/problem+json

object

type

obligatorio

string formato: uri

title

obligatorio

string

status

obligatorio

integer

detail

string

code

obligatorio

string

request_id

string

errors

Array<object>

object

field

string

code

string

message

string

Ejemplo^generado

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

404

No encontrado

application/problem+json

object

type

obligatorio

string formato: uri

title

obligatorio

string

status

obligatorio

integer

detail

string

code

obligatorio

string

request_id

string

errors

Array<object>

object

field

string

code

string

message

string

Ejemplo^generado

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

429

Límite de frecuencia superado

application/problem+json

object

type

obligatorio

string formato: uri

title

obligatorio

string

status

obligatorio

integer

detail

string

code

obligatorio

string

request_id

string

errors

Array<object>

object

field

string

code

string

message

string

Ejemplo^generado

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

500

Error interno

application/problem+json

object

type

obligatorio

string formato: uri

title

obligatorio

string

status

obligatorio

integer

detail

string

code

obligatorio

string

request_id

string

errors

Array<object>

object

field

string

code

string

message

string

Ejemplo^generado

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

El perfil público de una asociación: imagen, tipos de carné, estatuto en vigor

Parámetros

Parámetros de ruta

Parámetros de consulta

Respuestas

200

Ejemplo

400

Ejemplogenerado

404

Ejemplogenerado

429

Ejemplogenerado

500

Ejemplogenerado

Ejemplo^generado

Ejemplo^generado

Ejemplo^generado

Ejemplo^generado