协会的公开资料：品牌形象、会员卡类型、现行章程

GET

/v1/aps/{slug}

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

• Vimine API

适用于开通了公开入会或 API 访问的协会。章程依法公开（RUNTS）。

参数

路径参数

slug

必填

协会的公开入会 slug

string

查询参数

locale

读取协会文案所用的语言（it、en）；默认依次采用 Accept-Language、协会的语言。响应中的 locale 说明实际返回的语言，locales 说明协会提供的语言。章程是法律文书：永远不会被翻译

string

响应

200

公开资料

媒体类型application/json

object

locale

本响应所用的语言

string

locales

协会提供的语言：其自身的语言，加上其启用的语言

Array<string>

aps

必填

object

slug

string

name

string

picture_url

string

可为 null

citta

string

可为 null

provincia

string

可为 null

enroll_enabled

boolean

accepting_requests

此刻是否会受理入会申请：入会已开启、套餐还能再容纳一位会员、协会已准备好收集申请，且其公开入口处于开放状态。

boolean

invitation_only

当 Vimine 只凭邀请登记个人（内测），且本协会只接纳其邀请的人时为 true：此时 accepting_requests 为 false，POST /v1/enroll 返回 403 not_available。

boolean

sandbox

沙盒时为 true：即测试客户端所操作的协会测试副本，只有虚构会员。它从不发送电子邮件，不收取任何付款，也绝不属于 Vimine 网络。

boolean

admission

协会如何接纳会员，以便事先告知申请人会发生什么。model：board——申请等待协会理事会作出决定，任何会费都在决定之后缴纳；provisional——立即临时入会，之后由理事会追认；automatic——条件一满足即生效。delay_hours：从获准入会到会员卡真正可以使用之间的小时数（0 = 立即）：会员资格自获准入会起生效，会员卡要在此之后才在入场时算数（参见 valid_from）。

object

model

string

允许的值： board provisional automatic

delay_hours

integer

<= 168

approval_required

为兼容而保留：当 admission.model 为 board 时为 true。请改为读取 admission。

boolean

member_address

协会是否收集会员的地址——要么收集每位会员的地址，要么谁的都不收集。none：不要询问（即使发送了 address 也不会保存）；optional；required：没有地址时，入会返回 422。

string

允许的值： none optional required

payment_instructions

如何缴纳会费，采用协会自己的表述

string

可为 null

activity_sectors

协会开展的公共利益活动（意大利《第三部门法典》第 5 条）：cod 是该条中的字母编号，description 是其意大利语表述；其中一项被标记为主要活动。

Array<object>

object

cod

string

description

string

prevalent

boolean

registry

当协会已在 RUNTS（意大利全国第三部门机构登记册）登记时提供，由平台根据官方公开名单核实；否则为 null。绝不由协会自行填写。

object

section

登记册分区

string

可为 null

允许的值： APS ODV EF IS RA SOMS ALTRI

number

登记编号

string

可为 null

registered_on

string 格式： date

可为 null

checked_on

核实所依据的官方名单的日期

string 格式： date

可为 null

membership_types

必填

Array<object>

object

uid

string 格式： uuid

cod

string

name

string

description

string

可为 null

quota_amount

number

可为 null

currency

string

expiry_model

string

允许的值： solar_year rolling_12 rolling_24 prorated_solar custom

network_eligible

boolean

statuto

必填

恰好匹配其一：

object

object

aps

object

slug

string

name

string

title

必填

string

version

必填

integer

approved_on

string 格式： date

可为 null

sha256

对应上传的文件（如有）

string

可为 null

content_md

登记时的文本；只上传了文件时为空

string

content_html

必填

string

document_url

上传的文件，有效期 15 分钟的链接

string

可为 null

null

null

privacy_notice

恰好匹配其一：

object

object

uid

必填

string 格式： uuid

version

必填

integer

locale

必填

string

title

string

sha256

string

可为 null

effective_from

string 格式： date-time

可为 null

null

null

示例

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

400

请求无效

媒体类型application/problem+json

object

type

必填

string 格式： uri

title

必填

string

status

必填

integer

detail

string

code

必填

string

request_id

string

errors

Array<object>

object

field

string

code

string

message

string

示例^自动生成

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

404

未找到

媒体类型application/problem+json

object

type

必填

string 格式： uri

title

必填

string

status

必填

integer

detail

string

code

必填

string

request_id

string

errors

Array<object>

object

field

string

code

string

message

string

示例^自动生成

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

429

已触发速率限制

媒体类型application/problem+json

object

type

必填

string 格式： uri

title

必填

string

status

必填

integer

detail

string

code

必填

string

request_id

string

errors

Array<object>

object

field

string

code

string

message

string

示例^自动生成

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

500

内部错误

媒体类型application/problem+json

object

type

必填

string 格式： uri

title

必填

string

status

必填

integer

detail

string

code

必填

string

request_id

string

errors

Array<object>

object

field

string

code

string

message

string

示例^自动生成

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