3.5.1 GetTenants (テナント情報の一覧を取得）

テナント情報の一覧を取得します。

リクエストパラメーター

パラメーター名	項目	項目説明
[version]	説明	課金APIのバージョンID
	型	string ASCII
	設定内容	"1.0"を指定してください。省略した場合は最新のバージョンで動作します
action	説明	実行する課金APIの名称
	型	string ASCII
	設定内容	固定。"GetTenants"を指定してください。
[searchTenantName]	説明	取得するテナント名
	型	string ASCII
	設定内容	指定したテナントの情報を取得します。指定された場合は、verboseの指定は常にtrueになります。省略した場合は、すべてのテナントの情報を取得します。複数指定することができます。複数指定した場合、指定した全テナントの詳細情報を取得します。複数指定した場合、deleteDateを同時に指定できません。
[deleteDate]	説明	テナントの削除日
	型	string ASCII
	設定内容	yyyy-MM-ddTHH:mm:ss.SSSZ 省略した場合、テナント削除日が設定されていないテナントの情報を取得します。
[deleteTenant]	説明	テナントの一覧に削除済みテナントを含めるかどうかを指定
	型	string ASCII
	設定内容	以下のどちらかを指定します。 true：含める false：含めない省略した場合はfalseとなります。
[verbose]	説明	テナントの詳細情報を含めるかどうかを指定
	型	string ASCII
	設定内容	以下のどちらかを指定します。 true：含める false：含めない省略した場合はfalseとなります。

レスポンス

《ステータスコード》

正常に終了した場合に"200 OK"を返します。

《XML》

<?xml version="1.0" encoding="UTF-8"?>
<GetTenantsResponse>
 <responseMessage>[メッセージ]</responseMessage>
 <responseStatus>[ステータス]</responseStatus>
 <version>[バージョン]</version>
 <tenants>
  <tenant>
   <tenantName>[テナント名]</tenantName>
   <displayName>[表示名]</displayName>
   <cutOffDate>[締め日]</cutOffDate>
   <postCutOffDate>[次回締め日]</postCutOffDate>
   <latestCutOffDate>[最終締め日]</latestCutOffDate>
   <accountingMailAddress>[利用料金の送付先メールアドレス]</accountingMailAddress>
   <registerDate>[テナントが作成された日時]</registerDate>
   <deleteDate>[テナントが削除された日時]</deleteDate>
  </tenant>
 </tenants>
</GetTenantsResponse>

《要素》

要素名	項目	項目説明
GetTenantsResponse	説明	レスポンスの情報を持つ要素
	型	なし
	出現回数	1
responseMessage	説明	メッセージ。リクエストが正しく処理されたかどうかを表します。メッセージの詳細については、「メッセージ集」の「第5章 AAPIで始まるメッセージ」を参照してください。
	型	string UTF-8
	出現回数	1
responseStatus	説明	ステータス。リクエストが正常に処理されたかどうかを表します。正常に処理された場合は "SUCCESS" が返却されます。それ以外の場合はエラーコードが返却されます。エラーコードの詳細については、「付録B レスポンスステータス・エラーコード一覧（課金API）」を参照してください。
	型	string ASCII
	出現回数	1
version	説明	APIのバージョン
	型	string ASCII
	出現回数	1
tenents	説明	テナント一覧のレスポンス情報を持つ要素。
	型	なし
	出現回数	1
tenant	説明	テナント情報の一式
	型	なし
	出現回数	0以上
tenantName	説明	テナント名
	型	string ASCII
	出現回数	tenantの数分(それぞれに対して1)
displayName	説明	表示名
	型	string ASCII
	出現回数	tenantの数分(それぞれに対して1)
cutOffDate	説明	締め日。 verbose=true時だけ出力されます。
	型	decimal
	出現回数	tenantの数分(それぞれに対して0または1)
postCutOffDate	説明	次回締め日。 verbose=true時だけ出力されます。
	型	decimal
	出現回数	tenantの数分(それぞれに対して0または1)
latestCutOffDate	説明	最終締め日。 verbose=true時だけ出力されます。
	型	decimal
	出現回数	tenantの数分(それぞれに対して0または1)
accountingMailAddress	説明	利用料金の送付先メールアドレス。 verbose=true時だけ出力されます。
	型	string ASCII
	出現回数	tenantの数分(それぞれに対して0または1)
registerDate	説明	テナントが作成された日時。 verbose=true時だけ出力されます。
	型	string date
	出現回数	tenantの数分(それぞれに対して0または1)
deleteDate	説明	テナントが削除された日時
	型	string date
	出現回数	tenantの数分(それぞれに対して1)

サンプルレスポンス

<?xml version="1.0" encoding="UTF-8"?>
<GetTenantsResponse>
 <responseMessage>PAPI00000 Process completed.</responseMessage>
 <responseStatus>SUCCESS</responseStatus>
 <version>1.0</version>
 <tenants>
  <tenant>
   <tenantName>Tenant1</tenantName>
   <displayName>tenant1</displayName>
   <cutOffDate>25</cutOffDate>
   <postCutOffDate>2012-02-25</postCutOffDate>
   <latestCutOffDate>2012-01-25</latestCutOffDate>
   <accountingMailAddress>tenant1@example.com</accountingMailAddress>
   <registerDate>2011-01-01T10:30:00.000+0900</registerDate>
   <deleteDate></deleteDate>
  </tenant>
  <tenant>
   <tenantName>Tenant2</tenantName>
   <displayName>tenant2</displayName>
   <cutOffDate>31</cutOffDate>
   <postCutOffDate>2012-02-29</postCutOffDate>
   <latestCutOffDate>2012-01-25</latestCutOffDate>
   <accountingMailAddress>tenant2@exmaple.com</accountingMailAddress>
   <registerDate>2011-07-18T10:30:00.000+0900</registerDate>
   <deleteDate></deleteDate>
  </tenant>
 <tenants>
</GetTenantsResponse>