GET api/Transactions?fromCreateDate={fromCreateDate}&toCreateDate={toCreateDate}&setReadFlag={setReadFlag}&transactionStatusNr={transactionStatusNr}&listingNumber={listingNumber}&transactionID={transactionID}
Get all transactions matching search parameters. If the read flag of a transaction has been set previously, and the transaction did not change, then it will be excluded from the results.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| fromCreateDate |
Search from transaction create date |
date |
Required |
| toCreateDate |
Search to transaction create date |
date |
Required |
| setReadFlag |
Set to true to set the read flag for all transactions returned |
boolean |
Required |
| transactionStatusNr |
Optional: Current transaction status nr. 1=Conditional, 2=Unconditional, 3=Registered, 4=FallenOver |
integer |
None. |
| listingNumber |
Optional: Property listing number (exact string match) |
string |
None. |
| transactionID |
Optional: HTrack Transaction unique identifier |
globally unique identifier |
None. |
Body Parameters
None.
Response Information
Resource Description
TransactionsResponse
TransactionsResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| ClassVer |
Class version |
integer |
None. |
| TransactionCount |
Number of transactions in list |
integer |
None. |
| Transactions |
List of transactions |
DataTable |
None. |
Response Formats
application/json, text/json
Sample:
{
"ClassVer": 1,
"TransactionCount": 1,
"Transactions": null
}
application/xml, text/xml
Sample:
<TransactionsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HSTS.API.Models"> <TransactionCount>1</TransactionCount> <Transactions i:nil="true" /> </TransactionsResponse>