AutomaticApplicationTest
申請系APIの疎通テスト用APIで、リクエスト内容のチェック、データ登録は行いません。
HTTPメソッド | Action | 名称 |
---|---|---|
GET または POST | AutomaticApplicationTest | 自動申請APIテスト |
1: リクエストパラメータ
なし
2: レスポンス
正常終了
フィールド | タイプ | 意味 | 備考 | |
---|---|---|---|---|
StatusCode | String | ステータスコード | 成功時 200が返却されます | |
Result | − | 結果 | ||
RequestId | String | リクエストID | APIリクエストごとに割り当てられる一意なIDです | |
Param | String | メッセージ | ||
ResultCode | String | 結果コード | 以下が返却されます
|
異常終了
なし
3: エラーメッセージ
なし
4:警告メッセージ
なし
5:制限
なし
6:サンプル(REST形式)
config.rb
## ## 個別設定 ## # API のキー設定 IIJAPI_ACCESS_KEY = "1234567890ABCDEFGHIJ" IIJAPI_SECRET_KEY = "1234567890ABCDEFGHIJabcdefghijklmnopqr+1" ## ## API の基本設定 ## # API の ENDPOINT 設定 IIJAPI_ENDPOINT = https://uom.api.iij.jp IIJAPI_SSL_NO_VERIFY = true # API バージョンの設定 APIVERSION = "20150912" # Content-Type の設定 CONTENTTYPEVALUE = "application/json; charset=utf-8" # 自動申請APIテスト # 以下の内容は、適宜修正してください。 ACTION = "AutomaticApplicationTest" PARAMS = '{ }'
レスポンス(XML)
<?xml version="1.0" encoding="UTF-8"?> <methodResponse xmlns:ex="http://ws.apache.org/xmlrpc/namespaces/extensions"> <params> <param> <value> <struct> <member> <name>StatusCode</name> <value>200</value> </member> <member> <name>Result</name> <value> <struct> <member> <name>RequestId</name> <value>xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx</value> </member> <member> <name>Param</name> <value>null</value> </member> <member> <name>ResultCode</name> <value>0</value> </member> </struct> </value> </member> </struct> </value> </param> </params> </methodResponse>
レスポンス(JSON)
正常終了 { "AutomaticApplicationTestResponse": { "StatusCode":"200", "Result": { "RequestId":"xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx", "Param":"null", "ResultCode":"0" } } }