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

Get all transactions buyers matching search parameters, with contact details. If the read flag for the transaction buyer has been set previously, and the transaction agent information did not change, then it will be excluded from the results.

Request Information

URI Parameters

NameDescriptionTypeAdditional 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 buyers 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

TransactionsContactsResponse

TransactionContactsResponse
NameDescriptionTypeAdditional information
ClassVer

Class version

integer

None.

ContactRole

HTrack Transaction identifier

string

None.

ContactCount

Number of contacts in the list

integer

None.

Contacts

List of contacts of specified role (buyer / seller) associated with the transaction

DataTable

None.

Response Formats

application/json, text/json

Sample:
{
  "ClassVer": 1,
  "ContactRole": "sample string 1",
  "ContactCount": 2,
  "Contacts": null
}

application/xml, text/xml

Sample:
<TransactionContactsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HSTS.API.Models">
  <ContactCount>2</ContactCount>
  <ContactRole>sample string 1</ContactRole>
  <Contacts i:nil="true" />
</TransactionContactsResponse>