GetApplicationStatusList

「UOMポータル」の「サービス設定」から「設定履歴一覧」を確認するのと同様に、現在の設定状態や今までの設定を取得できます。

HTTPメソッドAction名称
POSTGetApplicationStatusList設定履歴一覧情報取得
1: リクエストパラメータ
パラメータタイプ必須意味最大文字数リクエスト例備考
ServiceCodeStringサービスコード15uom12345678ご契約のサービスコードを指定してください
MasterIdString設定者マスターID15SA9876543マスターIDを指定してください
ReceptionNumberString 受付番号13123

設定状態を確認したい設定の受付番号を指定してください。指定しない場合は今までの設定がすべて返却されます

Localeint表示言語10

下記のみ利用可能です

0:日本語

2: レスポンス
正常終了
フィールドタイプ意味備考
StatusCodeStringステータスコード成功時 200が返却されます
Result -結果 
RequestIdStringリクエストIDAPIリクエストごとに割り当てられる一意なIDです
ResultCodeString結果コード

以下が返却されます

0:成功

1:異常(入力チェックエラー)

2:異常(システムエラー)

ApplicationList Array設定リスト設定情報を格納したリストです
ReceptionNumberint受付番号

受付番号が返却されます

リクエストパラメーターで指定した場合は指定した受付番号です

(例)KUOM1303-0828

ApplicationStateString設定状態

以下が返却されます

10:受理待ち

20:受理

30:完了

ApplicationTypeString設定種別

以下が返却されます

10:監視ネットワーク設定

20:運用ノード設定

50:アラート通知/対応設定

ApplicantString設定者

設定を実施した担当者です

(例)iij-taro

ApplicationDateDateTime設定日時

形式:YYYY/MM/DD hh:mm:ss

(例)2014/04/23 10:00:00

AcceptanceDateDateTime受理日時

形式:YYYY/MM/DD hh:mm:ss

(例)2014/04/23 10:10:00

CompletionDateDateTime完了日時

形式:YYYY/MM/DD hh:mm:ss

(例)2014/04/23 10:20:00

異常終了
フィールドタイプ意味備考
Result 結果 
RequestIdStringリクエストIDAPIリクエストごとに割り当てられる一意なIDです
ErrorTypeStringエラータイプ異常終了となったエラータイプです
ErrorMessageStringエラーメッセージ異常終了となったエラーメッセージです

3: エラーメッセージ
エラーHTTP Status CodeErrorTypeErrorMessage説明

パラメータエラー

200UOMParameterErrorUOM parameter error occurred. Service code is a required field.サービスコードが不正

パラメータエラー

200UOMParameterErrorUOM parameter error occurred. MasterID is a required field.マスターIDが不正

パラメータエラー

200UOMParameterErrorUOM parameter error occurred. There is no MasterID.マスターIDが登録されていない

パラメータエラー

200UOMParameterError

UOM parameter error occurred. There is no UOM contract.

UOMの契約が存在しない
パラメータエラー200UOMParameterErrorUOM parameter error occurred. There is no monitoring contract.UOMの監視契約が存在しない
例外エラー200UOMParameterErrorUOM parameter error occurred. There is no operation contract.UOMの運用契約が存在しない
Webシステムエラー200UOMWebSystemErrorUOM Web System error occurred.その他のシステム障害
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"

# 設定履歴一覧情報取得
# 以下の内容は、適宜修正してください。
ACTION = "GetApplicationStatusList"
PARAMS = '{
	"ServiceCode" : "uom12345678",
	"MasterId" : "SA9876543",
	"ReceptionNumber" : "",
	"Locale" : "0"
}'
レスポンス(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></value>
								</member>
								<member>
									<name>ResultCode</name>
									<value>0</value>
								</member>
								<member>
									<name>ApplicationList</name>
									<value>
										<array>
											<data>
												<value>
													<struct>
														<member>
															<name>ReceptionNumber</name>
															<value>UUOM1303-0828</value>
														</member>
														<member>
														<name>ApplicationState</name>
															<value>00</value>
														</member>
														<member>
															<name>ApplicationType</name>
															<value>20</value>
														</member>
														<member>
															<name>Applicant</name>
															<value>iij-taro</value>
														</member>
														<member>
															<name>ApplicationDate</name>
															<value>2014/04/23 10:00:00</value>
														</member>
														<member>
															<name>AcceptanceDate</name>
															<value>2014/04/23 10:00:00</value>
														</member>
														<member>
															<name>CompletionDate</name>
															<value>2014/04/23 10:00:00</value>
														</member>
													</struct>
												</value>
												<value>
													<struct>
														<member>
															<name>ReceptionNumber</name>
															<value>AUOM1303-0828</value>
														</member>
														<member>
															<name>ApplicationState</name>
															<value>10</value>
														</member>
														<member>
															<name>ApplicationType</name>
															<value>50</value>
														</member>
														<member>
															<name>Applicant</name>
															<value>iij-taro</value>
														</member>
														<member>
															<name>ApplicationDate</name>
															<value>2014/04/23 10:00:00</value>
														</member>
														<member>
															<name>AcceptanceDate</name>
															<value>2014/04/23 10:00:00</value>
														</member>
														<member>
															<name>CompletionDate</name>
															<value>2014/04/23 10:00:00</value>
														</member>
													</struct>
												</value>
												<value>
													<struct>
														<member>
															<name>ReceptionNumber</name>
															<value>KUOM1303-0828</value>
														</member>
														<member>
															<name>ApplicationState</name>
															<value>20</value>
														</member>
														<member>
															<name>ApplicationType</name>
															<value>10</value>
															</member>
														<member>
															<name>Applicant</name>
															<value>iij-taro</value>
														</member>
														<member>
															<name>ApplicationDate</name>
															<value>2014/04/23 10:00:00</value>
														</member>
														<member>
															<name>AcceptanceDate</name>
															<value>2014/04/23 10:00:00</value>
														</member>
														<member>
															<name>CompletionDate</name>
															<value>2014/04/23 10:00:00</value>
														</member>
													</struct>
												</value>
											</data>
										</array>
									</value>
								</member>
							</struct>
						</value>
					</member>
				</struct>
			</value>
		</param>
	</params>
</methodResponse>

異常終了
<?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>400</value>
					</member>
					<member>
						<name>RequestId</name>
						<value>xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx</value>
					</member>
					<member>
						<name>ErrorType</name>
						<value>UOMParameterError</value>
					</member>
					<member>
						<name>ErrorMessage</name>
						<value>UOM parameter error occurred.Specified parameters there is a problem, you can not apply.</value>
					</member>
				</struct>
			</value>
		</param>
	</params>
</methodResponse>
レスポンス(JSON)
正常終了
{
	"GetApplicationStatusListResponse": {
		"StatusCode":"200",
		"Result":{
			"RequestId":"xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
			"ResultCode":"0",
			"ApplicationList":[
				{ "ReceptionNumber":"UUOM1303-0828",
				"ApplicationState":"30",
				"ApplicationType":"20",
				"Applicant":"iij-taro",
				"ApplicationDate":"2014/04/23 10:00:00",
				"AcceptanceDate":"2014/04/23 10:10:00",
				"CompletionDate":"2014/04/23 10:20:00" },
				{ "ReceptionNumber":"AUOM1303-0828",
				"ApplicationState":"10",
				"ApplicationType":"50",
				"Applicant":"iij-taro",
				"ApplicationDate":"2014/04/23 10:00:00",
				"AcceptanceDate":"2014/04/23 10:10:00",
				"CompletionDate":"2014/04/23 10:20:00"},
				{ "ReceptionNumber":"KUOM1303-0828",
				"ApplicationState":"20",
				"ApplicationType":"10",
				"Applicant":"iij-taro",
				"ApplicationDate":"2014/04/23 10:00:00",
				"AcceptanceDate":"2014/04/23 10:10:00",
				"CompletionDate":"2014/04/23 10:20:00"}
			]
		}
	}
}
異常終了
{
	"ErrorResponse": {
		"Result":{
			"RequestId":"xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
			"ErrorType":"UOMParameterError",
			"ErrorMessage":"UOM parameter error occurred.Specified parameters there is a problem, you can not apply."
		}
	}
}