属性情報一覧取得API

概要

登録されている属性を一覧で返却します。

URL

https://${POPINFO_HOST}/mapi/3.0/segment/

メソッド

GET

結果タイプ

複数を返却する

リクエストパラメータ

なし

レスポンスパラメータ

レスポンスボディーのresultsには、以下キーを含むobjectの配列が返却されます。

キー名	説明
key	以下キーを持つobject id (数値: 属性キーID) label (文字列: 属性キー名「性別」など) is_multiple (真偽値: 選択タイプ (false: 択一、 true: 複数選択)) is_editable (真偽値: 変更可能かどうか)
values	以下キーを持つobjectの配列 id (数値: 属性ID) label (文字列: 属性名「男性」など) is_current (真偽値: 現在利用中かどうか) is_initial (真偽値: 択一選択タイプの属性において、フォームレンダリング時に初期選択されているかどうか) is_current (真偽値: ユーザー登録時に強制セットされるかどうか)

リクエストのサンプル

(リクエストボディー無し)

レスポンスのサンプル

{
    "status": "OK", 
    "result": [
        {
            "values": [
                {
                    "is_initial": false, 
                    "is_current": true, 
                    "id": 101, 
                    "is_coerced": false, 
                    "label": "女性"
                }, 
                {
                    "is_initial": false, 
                    "is_current": true, 
                    "id": 102, 
                    "is_coerced": false, 
                    "label": "男性"
                }
            ], 
            "key": {
                "is_multiple": true, 
                "is_editable": false, 
                "id": 100, 
                "label": "性別"
            }
        }, 
        {
            "values": [
                {
                    "is_initial": false, 
                    "is_current": true, 
                    "id": 2180, 
                    "is_coerced": false, 
                    "label": "りんご"
                }, 
                {
                    "is_initial": false, 
                    "is_current": true, 
                    "id": 2181, 
                    "is_coerced": false, 
                    "label": "バナナ"
                }
            ], 
            "key": {
                "is_multiple": true, 
                "is_editable": false, 
                "id": 1002, 
                "label": "好きな食べ物"
            }
        }
    ]
}