3.5.1 GetTenants (Get a List of Tenant Information)

Get a list of tenant information.

Request parameters

Parameter name	Item	Item description
[version]	Description	Version ID of the accounting API
	Type	string
	Value	Fixed. Specify "1.0". The latest version is used if this is omitted.
action	Description	The name of the accounting API to be executed.
	Type	string
	Value	Fixed. Specify "GetTenants".
[searchTenantName]	Description	Acquired tenant name.
	Type	string
	Value	Retrieve information for the specified tenant. If this is specified, "true" will always be specified for "verbose". If this is omitted, information is retrieved for all tenants. Multiple can be specified. Detailed information for all specified tenants is retrieved if multiple are specified. If multiple are specified, deleteDate cannot be specified.
[deleteDate]	Description	The day of delete tenant.
	Type	string
	Value	yyyy-MM-dd THH:mm:ss.SSSZ For example, use 2012-04-01T00:00:00.000+0900 for the 12:00 A.M. and 00.000 seconds on April 1, 2012 in timezone UTC+9:00. If this is omitted, the default value is the information of tenant with unset the delete date.
[deletedTenant]	Description	This element indicates whether the include dereted tenant with list of tenant.
	Type	string
	Value	Specify one of the following: - true: include - false: exclude If this parameter is omitted, the default value is "false".
[verbose]	Description	This element indicates whether the include detail informaton of tenant.
	Type	string
	Value	Specify one of the following: - true: include - false: exclude If this parameter is omitted, the default value is "false".

Response

The API returns "200 OK" if it terminates normally.

<XML>

<?xml version="1.0" encoding="UTF-8"?>
<GetTenantsResponse>
 <responseMessage>[Message]</responseMessage>
 <responseStatus>[Status]</responseStatus>
 <version>[Version]</version>
 <tenants>
  <tenant>
   <tenantName>[Tenant name]</tenantName>
   <displayName>[Display name]</displayName>
   <cutOffDate>[Cut-off date]</cutOffDate>
   <postCutOffDate>[Next cut-off date]</postCutOffDate>
   <latestCutOffDate>[Latest cut-off date]</latestCutOffDate>
   <accountingMailAddress>[Email address to send the usage accounts]</accountingMailAddress>
   <registerDate>[The time and date of register the tenant]</registerDate>
   <deleteDate>[The time and date of delete the tenant]</deleteDate>
  </tenant>
 </tenants>
</GetTenantsResponse>

Element name	Item	Item description
GetTenantsResponse	Description	Element holding the response information.
	Type	None
	Number of occurrences	1
responseMessage	Description	Message. This element indicates whether the request has been processed correctly. Refer to "Chapter 5 Messages Starting with AAPI" in the "Messages" for message details.
	Type	string
	Number of occurrences	1
responseStatus	Description	Status. This element indicates whether the request has been processed normally. "SUCCESS" is returned if the request is processed normally. Otherwise, an error code is returned. Refer to "Appendix B List of Response Status Error Codes(Accounting APIs)" for information on error codes.
	Type	string
	Number of occurrences	1
version	Description	The version of the API.
	Type	string
	Number of occurrences	1
tenants	Description	Element holding the response information for the list of tenant information.
	Type	None
	Number of occurrences	1
tenant	Description	Set of additional list of tenant information.
	Type	None
	Number of occurrences	0 or more
tenantName	Description	Tenant name.
	Type	string
	Number of occurrences	As many as there are tenant elements (1 element for each tenant element).
displayName	Description	Display name.
	Type	string
	Number of occurrences	As many as there are tenant elements (1 element for each tenant element).
cutOffDate	Description	Cut-off date. Output only when verbose=true is specified.
	Type	decimal
	Number of occurrences	As many as there are tenant elements (0 or 1 elements for each tenant element).
postCutOffDate	Description	Next cut-off date. Output only when verbose=true is specified.
	Type	decimal
	Number of occurrences	As many as there are tenant elements (0 or 1 elements for each tenant element).
latestCutOffDate	Description	Latest cut-off date. Output only when verbose=true is specified.
	Type	decimal
	Number of occurrences	As many as there are tenant elements (0 or 1 elements for each tenant element).
accountingMailAddress	Description	Email address to send the usage accounts. Output only when verbose=true is specified.
	Type	string
	Number of occurrences	As many as there are tenant elements (0 or 1 elements for each tenant element).
registerDate	Description	The time and date of register the tenant. Output only when verbose=true is specified.
	Type	string
	Number of occurrences	As many as there are tenant elements (0 or 1 elements for each tenant element).
deleteDate	Description	The time and date of delete the tenant.
	Type	string
	Number of occurrences	As many as there are tenant elements (1 elements for each tenant element).

Sample response

<?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>