O perfil público de uma associação: identidade visual, tipos de carteirinha, statuto em 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

Disponível para as associações que ativaram a adesão pública ou o acesso à API. O statuto é público por lei (RUNTS).

Parâmetros

Parâmetros de caminho

slug

obrigatório

Slug público de adesão da associação

string

Parâmetros de consulta

locale

O idioma em que ler os textos da associação (it, en); padrão: Accept-Language, depois o da associação. locale na resposta diz o que foi servido, locales o que a associação oferece. O statuto é um ato jurídico: nunca é traduzido

string

Respostas

200

Perfil público

application/json

object

locale

O idioma em que esta resposta está escrita

string

locales

Os idiomas que a associação oferece: o seu, mais os que ela ativou

Array<string>

aps

obrigatório

object

slug

string

name

string

picture_url

string

nullable

citta

string

nullable

provincia

string

nullable

enroll_enabled

boolean

accepting_requests

Se um pedido de adesão seria recebido agora: adesão ativada, espaço no plano para mais um associado, a associação pronta para receber pedidos e a sua porta pública aberta.

boolean

invitation_only

É true enquanto o Vimine só cadastra pessoas por convite (o beta privado) e esta associação só recebe as pessoas que convidou: accepting_requests então é false, e POST /v1/enroll responde 403 not_available.

boolean

sandbox

É true para um sandbox: a cópia de teste de uma associação, na qual os clientes de teste trabalham, só com associados sintéticos. Nunca envia e-mails, não recebe pagamentos e nunca está no Network.

boolean

admission

Como a associação admite os seus associados, para que se possa dizer de antemão a quem pede o que esperar. model: board — o pedido aguarda uma decisão da diretoria da associação, e uma eventual taxa é paga depois dela; provisional — admitido na hora, ratificado depois pela diretoria; automatic — ativa assim que as condições são cumpridas. delay_hours: as horas entre a admissão e uma carteirinha UTILIZÁVEL (0 = na hora): a adesão fica ativa a partir da admissão, a carteirinha só vale na entrada depois (veja valid_from).

object

model

string

Valores permitidos: board provisional automatic

delay_hours

integer

<= 168

approval_required

Mantido por compatibilidade: true quando admission.model é board. Leia admission em vez dele.

boolean

member_address

Se a associação coleta o endereço dos seus associados — de todos ou de nenhum. none: não pergunte (um address enviado mesmo assim não é guardado); optional; required: sem ele, a adesão responde 422.

string

Valores permitidos: none optional required

payment_instructions

Como pagar a taxa, nas palavras da associação

string

nullable

activity_sectors

As atividades de interesse geral que a associação realiza (Código do Terceiro Setor italiano, art. 5): cod é a letra do artigo, description o seu texto em italiano; uma delas é marcada como predominante.

Array<object>

object

cod

string

description

string

prevalent

boolean

registry

Presente quando a associação está inscrita no RUNTS (o registro nacional italiano das entidades do Terceiro Setor), conforme verificado pela plataforma nas listas públicas oficiais; null nos outros casos. Nunca digitado pela associação.

object

section

Seção do registro

string

nullable

Valores permitidos: APS ODV EF IS RA SOMS ALTRI

number

Número de repertório

string

nullable

registered_on

string formato: date

nullable

checked_on

Data da lista oficial usada na verificação

string formato: date

nullable

membership_types

obrigatório

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

obrigatório

Exatamente um de:

object
null

object

aps

object

slug

string

name

string

title

obrigatório

string

version

obrigatório

integer

approved_on

string formato: date

nullable

sha256

Do documento enviado, quando houver um

string

nullable

content_md

O texto como registrado; vazio quando só um documento foi enviado

string

content_html

obrigatório

string

document_url

O documento enviado, um link válido por 15 minutos

string

nullable

privacy_notice

Exatamente um de:

object
null

object

uid

obrigatório

string formato: uuid

version

obrigatório

integer

locale

obrigatório

string

title

string

sha256

string

nullable

effective_from

string formato: date-time

nullable

Exemplo

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

400

Requisição inválida

application/problem+json

object

type

obrigatório

string formato: uri

title

obrigatório

string

status

obrigatório

integer

detail

string

code

obrigatório

string

request_id

string

errors

Array<object>

object

field

string

code

string

message

string

Exemplo^gerado

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

404

Não encontrado

application/problem+json

object

type

obrigatório

string formato: uri

title

obrigatório

string

status

obrigatório

integer

detail

string

code

obrigatório

string

request_id

string

errors

Array<object>

object

field

string

code

string

message

string

Exemplo^gerado

{
  "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 requisições excedido

application/problem+json

object

type

obrigatório

string formato: uri

title

obrigatório

string

status

obrigatório

integer

detail

string

code

obrigatório

string

request_id

string

errors

Array<object>

object

field

string

code

string

message

string

Exemplo^gerado

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

500

Erro interno

application/problem+json

object

type

obrigatório

string formato: uri

title

obrigatório

string

status

obrigatório

integer

detail

string

code

obrigatório

string

request_id

string

errors

Array<object>

object

field

string

code

string

message

string

Exemplo^gerado

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

O perfil público de uma associação: identidade visual, tipos de carteirinha, statuto em vigor

Parâmetros

Parâmetros de caminho

Parâmetros de consulta

Respostas

200

Exemplo

400

Exemplogerado

404

Exemplogerado

429

Exemplogerado

500

Exemplogerado

Exemplo^gerado

Exemplo^gerado

Exemplo^gerado

Exemplo^gerado