GET api/Transactions/Agents?fromCreateDate={fromCreateDate}&toCreateDate={toCreateDate}&setReadFlag={setReadFlag}&transactionStatusNr={transactionStatusNr}&listingNumber={listingNumber}&transactionID={transactionID}

Get all transactions agents matching search parameters, with roles and commission values in ZAR. If the read flag for the transaction agent has been set previously, and the transaction agent information 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 transaction agents 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

TransactionsAgentsResponse

TransactionAgentsResponse

Name	Description	Type	Additional information
ClassVer	Class version	integer	None.
AgentCount	HTrack Transaction identifier	integer	None.
Agents	List of agents associated with specified transaction	DataTable	None.

Response Formats

application/json, text/json

Sample:

{
  "ClassVer": 1,
  "AgentCount": 1,
  "Agents": null
}

application/xml, text/xml

Sample:

<TransactionAgentsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HSTS.API.Models">
  <AgentCount>1</AgentCount>
  <Agents i:nil="true" />
</TransactionAgentsResponse>