負担割合情報取得API

co-pay/select

POST

{ 
    "userId": "0000000004",
    "selectMonth": "2022-08"
}

レスポンス

ボディ

パラメータ名	物理パラメータ	配列内パラメータ	型	必須	文字桁数	文字種/形式	仕様
利用者ID	userId		String	○	10
名前	userName		String	○
名前フリガナ （半角カナ）	kanaName		String	○
対象月	selectMonth		String	○		YYYY-MM
負担割合情報	co-payData		[array]				リクエスト月に有効な負担割合情報が存在しない場合は省略されます
負担割合交付日		issueDate	String			YYYY-MM-DD
被保険者番号		insuredNumber	String		10
保険者番号		isurerNumber	String		6
保険者名称		isurerName	String
負担割合期間開始日		sdate	String			YYYY-MM-DD
負担割合期間終了日		edate	String			YYYY-MM-DD
負担割合		rate	String				文字列「１割負担」「２割負担」「３割負担」いずれかで返却されます

有効な負担割合証の取得に成功した際のサンプルデータ

{
    "userId": "0000000004",
    "userName": "利用者4",
    "kanaName": "ﾘﾖｳｼｬｱｱｴ",
    "selectMonth": "2022-08",
    "co-payData": [
        {
            "issueDate": "2020-01-01",
            "insuredNumber": "1111111114",
            "isurerNumber": "221028",
            "isurerName": "静岡市駿河区",
            "sdate": "2022-07-01",
            "edate": "2022-08-15",
            "rate": "２割負担"
        },
        {
            "issueDate": "2020-01-01",
            "insuredNumber": "1111111114",
            "isurerNumber": "221028",
            "isurerName": "静岡市駿河区",
            "sdate": "2022-08-16",
            "edate": "2022-09-30",
            "rate": "１割負担"
        }
    ]
}

エラーレスポンス

エラーレスポンスを参照してください。