UOM-APIの凡例(レスポンス)

UOM-APIのレスポンス説明では以下のとおり表記します。

XML表記(Query形式のみ)
<SampleApiResponse>
	<Param1>abcdefg</Param1>
	<Param2>
		<ParamA>pqr</ParamA>
		<ParamB>xyz</ParamB>
	</Param2>
	<Param3>
		<ParamC>123</ParamC>
	</Param3>
	<Param3>
		<ParamC>987</ParamC>
	</Param3>
</SampleApiResponse>
JSON表記
{
	"SampleApiResponse": {
		"Param1": "abcdefg",
		"Param2": {
			"ParamA": "pqr",
			"ParamB": "xyz"
		},
		"Param3": [ 
			{"ParamC": "123"},
			{"ParamC": "987"}
		]
	}
}
フィールドタイプ意味
SampleApiResponse.Param1String単純な値
SampleApiResponse.Param2Object内部に複数の値を含む連想配列
SampleApiResponse.Param2.ParamAString構造体に含まれる単純な値
SampleApiResponse.Param2.ParamBString構造体に含まれる単純な値
SampleApiResponse.Param3Array内部に複数の値を含む単純配列
SampleApiResponse.Param3.ParamCString配列に含まれる単純な値
  • 構造化されたフィールドのキーは、表中ではそれぞれのキーを「.(ドット)」で連結して表します。
  • UOM-APIでは値に型はありません。すべて文字列として取り扱います。