API Reference: REST Data Elements

QueryBatch

The message body type for the TMS QueryBatch operation.

Parameter Description Data Type
QueryBatchParameters The batch query details. Required. Object
PagingParameters Defines the parameters for the service to use for paging large datasets. Object

 


 

QueryRejectedDetail

The message body type for the TMS QueryRejectedDetail operation.

Parameter Description Data Type
QueryRejectedParameters Non-service class specific query parameters for QueryRejectedDetail and QueryRejectedSummary. Required. Object
PagingParameters Defines the parameters for the service to use for paging large datasets. Object

 


 

QueryRejectedSummary

The message body type for the TMS QueryRejectedSummary< operation.

Parameter Description Data Type
QueryRejectedParameters Non-service class specific query parameters for QueryRejectedDetai and QueryRejectedSummary. Required. Object
PagingParameters Defines the parameters for the service to use for paging large datasets. Object

 


 

QueryTransactionsDetail

  The message body type for the TMS QueryTransactionsDetail operation.

Parameter Description Data Type
QueryTransactionsParameters Query parameters.

Note: When TransactionTenderData is supplied, no other parameters are valid for the query.
Object
TransactionDetailFormat Indicates the format for the complete serialized transactions—CWSTransaction or SerializedCWS. Enum
IncludeRelated Indicates whether transactions related to the resulting transaction should also be included. Boolean
PagingParameters Defines the parameters for the service to use for paging large datasets. Object

Note: If using QueryType = 'OR' in QueryTransactionsParameters, the DateRange specified must be within the last 90 days or a fault is thrown. Regardless of how DateRange is specified, only the matching transactionId's within the last 90 days are returned.

 


 

QueryTransactionsFamilies

The message body type for the TMS QueryTransactionsFamilies operation.

Parameter Description Data Type
QueryTransactionsParameters Query parameters.

Note: When TransactionTenderData is supplied, no other parameters are valid for the query.
Object
PagingParameters Defines the parameters for the service to use for paging large datasets. Object

 


 

QueryTransactionsSummary

The message body type for the TMS QueryTransactionsSummary operation.

Parameter Description Data Type
QueryTransactionsParameters Query parameters.

Note: When TransactionTenderData is supplied, no other parameters are valid for the query.
Object
IncludeRelated Indicates whether transactions related to the resulting transaction should also be included. Boolean
PagingParameters Defines the parameters for the service to use for paging large datasets. Object

Comments