協會的公開資料：品牌形象、會員卡類型、現行章程

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

上傳文件的 SHA-256（如有上傳文件）

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"
    }
  ]
}