GET contract
API情報
| HTTPメソッド | API名 | パス | 目的 |
|---|---|---|---|
| GET | contract | /r/[APIVersion]/[ServiceCode]/contract.json |
契約情報の一覧取得 |
APIバージョン:20190625
個別パラメータ
URL
| パラメータ | 必須 | タイプ | 説明 | 例 |
|---|---|---|---|---|
| APIVersion | 〇 | String | APIバージョン | 20190625 |
| ServiceCode | 〇 | String | 契約情報の一覧を取得する対象のサービスコード | yemXXXXXXXX |
HTTPリクエストボディ
- なし
レスポンス
| パラメータ | タイプ | 説明 | 例 |
|---|---|---|---|
| APIResult.AssociatedServiceContracts | Array | 連携しているサービス一覧 | 配列 |
| APIResult.AssociatedServiceContracts.ServiceName | String | 連携しているサービス名 | IIJプライベートバックボーンサービス、IIJマネージドファイアウォールサービス |
| APIResult.AssociatedServiceContracts.Label | String | 連携しているサービスのラベル | 文字列 |
| APIResult.AssociatedServiceContracts.ServiceCode | String | 連携しているサービスのサービスコード | mtxXXXXXXXX、yfXXXXXXXX |
| APIResult.OptionDeviceContracts | Array | トンネル機器オプションの契約情報一覧 | 配列 |
| APIResult.OptionDeviceContracts.Type | String | トンネル機器オプションのタイプ | タイプ1 |
| APIResult.OptionDeviceContracts.ServiceName | String | トンネル機器オプションのサービス名 | トンネル機器オプション |
| APIResult.OptionDeviceContracts.Label | String | トンネル機器オプションのラベル | 文字列 |
| APIResult.OptionDeviceContracts.ChildServiceCode | String | トンネル機器オプションのサービスコード | yevXXXXXXXX |
| APIResult.ProductContracts | Array | 子サービス契約情報一覧 | 配列 |
| APIResult.ProductContracts.Options | Array | 子サービスのオプション一覧 | 配列 |
| APIResult.ProductContracts.ServiceName | String | 子サービスのサービス名 | アンチウイルス：Cylance、IT資産管理、IT資産管理/CE、アンチウイルス：Cylance/SBC方式仮想デスクトップ、IT資産管理/S、IT資産管理モバイル、IT資産保護 |
| APIResult.ProductContracts.Account | Object | 子サービスの契約アカウントの情報 | オブジェクト |
| APIResult.ProductContracts.Account.Range | String | 子サービスの契約アカウントレンジ | 101～500 |
| APIResult.ProductContracts.Account.Range(Windows) | String | 子サービスの契約アカウントレンジ(Windows) ※IT資産管理のみ |
101～500 |
| APIResult.ProductContracts.Account.Range(Mac) | String | 子サービスの契約アカウントレンジ(Mac) ※IT資産管理のみ |
101～500 |
| APIResult.ProductContracts.Account.Num(Windows) | String | 子サービスの契約アカウント数(Windows) ※IT資産管理、IT資産管理/CEのみ |
300 |
| APIResult.ProductContracts.Account.Num(Basic) | String | 子サービスの契約アカウント数(Basic) ※IT資産管理モバイルのみ |
100 |
| APIResult.ProductContracts.Account.Num(LiteA) | String | 子サービスの契約アカウント数(LiteA) ※IT資産管理モバイルのみ |
100 |
| APIResult.ProductContracts.Account.Num(LiteB) | String | 子サービスの契約アカウント数(LiteB) ※IT資産管理モバイルのみ |
100 |
| APIResult.ProductContracts.Account.Num(SBC) | String | 子サービスの契約アカウント数(SBC) ※IT資産管理/Sのみ |
100 |
| APIResult.ProductContracts.Account.Num(Session) | String | 子サービスの契約アカウント数(Session) ※アンチウイルス：Cylance/SBC方式仮想デスクトップのみ |
100 |
| APIResult.ProductContracts.Account.Num | String | 子サービスの契約アカウント数 | 300 |
| APIResult.ProductContracts.Account.Num(Mac) | String | 子サービスの契約アカウント数(Mac) ※IT資産管理、IT資産管理/CEのみ |
300 |
| APIResult.ProductContracts.Label | String | 子サービスのラベル | 文字列 |
| APIResult.ProductContracts.ChildServiceCode | String | 子サービスのサービスコード | yecXXXXXXXX、yelXXXXXXXX、yeoXXXXXXXX、yedXXXXXXXX、yexXXXXXXXX、yeaXXXXXXXX、yegXXXXXXXX |
| APIResult.Label | String | 親サービスのラベル | 文字列 |
| APIResult.ServiceCode | String | 親サービスのサービスコード | yemXXXXXXXX |
エラーコード
- このAPIに関する個別エラーはありません。
- 共通エラーコードはエラーレスポンスを参照してください。
制限
- なし
サンプル
リクエスト
GET /r/[APIVersion]/contract.json HTTP/1.1 Host: ep.api.iij.jp x-iijapi-Expire: 2019-06-06T09:52:01Z x-iijapi-SignatureMethod: [SignatureMethod] x-iijapi-SignatureVersion: [SignatureVersion] Authorization:IIJAPI [AccessKeyId]:[Signature]
レスポンス
{ |
"APIResult": { |
"AssociatedServiceContracts": [ |
{ |
"ServiceName": "IIJプライベートバックボーンサービス", |
"Label": "xxxxx", |
"ServiceCode": "mtxXXXXXXXX" |
} |
], |
"OptionDeviceContracts": [ |
{ |
"Type": "タイプ1", |
"ServiceName": "トンネル機器オプション", |
"Label": "", |
"ChildServiceCode": "yevXXXXXXXX" |
} |
], |
"ProductContracts": [ |
{ |
"Options": [], |
"ServiceName": "アンチウイルス：Cylance", |
"Account": { |
"Range": "xxx～xxx", |
"Num": xxx |
}, |
"Label": "xxxxx", |
"ChildServiceCode": "yecXXXXXXXX" |
}, |
{ |
"Options": [ |
"Webアクセス管理", |
"デバイス制御", |
"メール管理", |
"アプリID監査" |
], |
"ServiceName": "IT資産管理", |
"Account": { |
"Range": "xxx～xxx", |
"Num": xxx |
}, |
"Label": "", |
"ChildServiceCode": "yelXXXXXXXX" |
} |
], |
"Label": "xxxxx", |
"ServiceCode": "yemXXXXXXXX", |
"RequestId": "xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx" |
} |
} |