Skip to main content

Contract List v2

リクエスト

GET https://api.dmdata.jp/v2/contract

契約中、未契約の情報リスト。

APIに必要な権限

  • contract.list

レスポンス

APIは常にJSONを返答します。

status: ok

成功時に次のような内容を返答します。

{
"responseId": "2c343ee3f1007df5",
"responseTime": "2021-04-01T00:00:00.000Z",
"status": "ok",
"items": [
{
"id": 92,
"planId": 1,
"planName": "地震・津波関連",
"classification": "telegram.earthquake",
"price": {
"day": 15,
"month": 350
},
"start": "2021-01-01T01:01:00.000Z",
"isValid": true,
"connectionCounts": 1
}
]
}
フィールド出現説明
responseIdいつもString
API処理ID
responseTimeいつもISO8601Time
API処理時刻
statusいつもString
成功時は ok、失敗時(エラー)は error
itemsいつもArray<Object>
アイテムリスト
items[].idいつもInteger|Null
契約ID
items[].planIdいつもInteger
プランID
items[].planNameいつもString
プラン名
items[].classificationsいつもString
受け取れる配信区分
items[].priceいつもObject
価格
items[].price.dayいつもInteger
1日当たりの価格(円)
items[].price.monthいつもInteger
月当たり最大の価格(円)
items[].startいつもISO8601Time|Null
契約開始日時
items[].isValidいつもBoolean
有効かどうか示す。true なら有効
items[].connectionCountsいつもInteger
この契約でWebSocketに接続できる数が増える量

status: error

APIは各種エラーを次の通り返答します。

{
"responseId": "66d23c0cede77d82",
"responseTime": "2021-04-01T00:00:00.000Z",
"status": "error",
"error": {
"message": "...",
"code": 400
}
}
フィールド出現説明
errorいつもObject
エラー情報。
error.messageいつもString
エラーメッセージ、標準エラーおよび別表参照。
error.codeいつもInteger
HTTPステータスコード。

標準エラーを出力します。