概要
このAPIは、操作可能な契約一覧を取得するためのものです。ユーザがアクセスできる本サービスの契約情報を返します。
API情報
| 項目 |
内容 |
| メソッド |
GET |
| URL |
https://api.isa.iij.jp/v1/contracts |
| 対応スコープ |
isa_read |
| 対応バージョン |
v1 |
| 権限管理ロール |
管理者 |
| リクエストパラメータ |
なし |
| リクエストボディ |
なし |
レスポンス情報
| パラメータ |
説明 |
例 |
| id |
サービスコードに対するUUID。サービスコードに対して内部的に一意に割り当てられたもの |
xxx-xxx-xxx-xxx |
| service_code |
サービスコード |
isa12345678 |
| contracts |
ISAコードに紐づく子コード群 |
{ … } |
エラーレスポンス
固有のエラーはありません。
サンプルリクエスト
GET /v1/contracts HTTP/1.1 |
Host: api.isa.iij.jp |
Authorization: Bearer [token] |
Content-Type: application/json; charset=UTF-8 |
サンプルレスポンス
{ |
"request_id": "xxx", |
"results": [ |
{ |
"id": "xxx", |
"service_code": "isa12345678", |
"contracts": [ |
{ |
… |
}, |
{ |
… |
} |
] |
} |
] |
} |