Transaction Reporting

QueryBatch

The QueryBatch operation queries the batch summary and returns Batch Status, DateTime, and a list of transactionIds in the batch.

Operation

List QueryBatch(string sessionToken, QueryBatchParameters queryBatchParameters, PagingParameters pagingParameters)

Parameters

Return Type

Exceptions

Back to the top
 

QueryTransactionsDetail

The QueryTransactionsDetail operation queries the specified transactions and returns both summary details and full transaction details as a serialized object. QueryTransactionsDetail contains the same search criteria and includeRelated functionality as QueryTransactionsSummary.

Parameters

Return Type

Exceptions

Code Snippets

public List QueryTransactionsDetail(string sessionToken, QueryTransactionsParameters queryTransactionsParameters, TransactionDetailFormat transactionDetailFormat,PagingParameters pagingParameters, Boolean includeRelated)
{
	using (var client = new TMSOperationsClient(ConfigurationManager.AppSettings["Bindings.MgmtSoap"]))
	{
		try
		{
			return client.QueryTransactionsDetail(sessionToken, queryTransactionsParameters, transactionDetailFormat, includeRelated, pagingParameters).ToList();
		}
		catch (FaultException ex)
		{
			SoapFaultHandler.HandleFaultException(ex); 
		}
	}
}

public function queryTransactionsDetail($queryTransactionParameters, $includeRelated, $transactionDetailFormat, $pagingParameters)
{
	if (! $this->signOn ())
		return false;

	// Build QueryTransactionsDetail
	$qtd = new QueryTransactionsDetail();
	$qtd->sessionToken = $this->session_token;
	$qtd->queryTransactionsParameters = $queryTransactionParameters;
	$qtd->includeRelated = $includeRelated;
	$qtd->transactionDetailFormat = $transactionDetailFormat;
	$qtd->pagingParameters = $pagingParameters;

	try
	{
		$response = $this->txnManagement->QueryTransactionsDetail($qtd)->QueryTransactionsDetailResult->TransactionDetail;
		//echo ($this->txnManagement->__getLastRequest ());
		return $response;
	}
	catch ( SoapFault $e )
	{
		echo 'SERVER ERROR: Error trying to QueryTransactionFamilies.
';
		echo ('
'.$this->txnManagement->__getLastRequestHeaders());
		echo ('
' . $this->txnManagement->__getLastRequest ());
		echo ('
' . $this->txnManagement->__getLastResponse ());
		$xmlFault = $this->txnManagement->__getLastResponse ();
		$errors = handleTxnFault ( $e, $xmlFault );
		echo $errors;
		exit ();
	}
}

Back to the top
 

QueryTransactionFamilies

The QueryTransactionFamilies operation returns family summary information and a list of TransactionIds that can be used to query for full transaction details.
 

Operation

List FamilyDetail QueryTransactionFamilies(string sessionToken, QueryTransactionsParameters queryTransactionsParameters, PagingParameters pagingParameters.)

Parameters

Return Type

Exceptions

Code Snippets

public List QueryTransactionFamilies(string sessionToken, QueryTransactionsParameters queryTransactionsParameters, PagingParameters pagingParameters)
{
	using (var client = new TMSOperationsClient(ConfigurationManager.AppSettings["Bindings.MgmtSoap"]))
	{
		try
		{
			return client.QueryTransactionFamilies(sessionToken, queryTransactionsParameters, pagingParameters).ToList();
		}
		catch (FaultException ex)
		{
			SoapFaultHandler.HandleFaultException(ex); 
		}
	}
}

public function queryTransactionFamilies($queryTransactionParameters, $includeRelated, $pagingParameters)
{
	if (! $this->signOn ())
		return false;

	// Build QueryTransactionsSummary
	$qtf = new QueryTransactionFamilies();
	$qtf->sessionToken = $this->session_token;
	$qtf->queryTransactionsParameters = $queryTransactionParameters;
	$qtf->includeRelated = $includeRelated;
	$qtf->pagingParameters = $pagingParameters;

	try
	{
		$response = $this->txnManagement->QueryTransactionFamilies($qtf)->QueryTransactionFamiliesResult;
		echo ($this->txnManagement->__getLastRequest ());
		return $response;
	}
	catch ( SoapFault $e )
	{
		echo 'SERVER ERROR: Error trying to QueryTransactionFamilies.
';
		echo ('
'.$this->txnManagement->__getLastRequestHeaders());
		echo ('
' . $this->txnManagement->__getLastRequest ());
		echo ('
' . $this->txnManagement->__getLastResponse ());
		$xmlFault = $this->txnManagement->__getLastResponse ();
		$errors = handleTxnFault ( $e, $xmlFault );
		echo $errors;
		exit ();
	}
}

Back to the top
 

QueryTransactionsSummary

The QueryTransactionsSummary operation queries the specified transactions and returns summary details related to one or more transactions matching specific search criteria. You can indicate if the response will include all related transactions (includeRelated = ‘true’). This returns all transactions matching specific search criteria and all transactions that have parent/child relationships with those matches.
 

Operation

ListSummaryDetail QueryTransactionsSummary(string sessionToken, QueryTransactionsParameters queryTransactionsParameters, bool includeRelated, PagingParameters pagingParameters)

Parameters

Return Type

Exceptions

Code Snippets

public List QueryTransactionsSummary(string sessionToken, QueryTransactionsParameters queryTransactionsParameters, PagingParameters pagingParameters, Boolean includeRelated)
{
	using (var client = new TMSOperationsClient(ConfigurationManager.AppSettings["Bindings.MgmtSoap"]))
	{
		try
		{
			return client.QueryTransactionsSummary(sessionToken, queryTransactionsParameters, includeRelated, pagingParameters).ToList();
		}
		catch (FaultException ex)
		{
			SoapFaultHandler.HandleFaultException(ex); 
		}
	}
}