Account
Controller for user account actions, including authentication and authorization
| API | Description |
|---|---|
| POST api/Account/SignIn |
Sign in to authenticate. If successful, an OAuth 2.0 authorization (JWT) token is generated returned which is required by all other end points. The token must be placed after the word "bearer " in the Authorization key of the header for all subsequent actions. See https://oauth.net/2/ |
| POST api/Account/SignOut |
The user session is invalidated - future attempts to sign in with same bearer token will fail. |
| POST api/Account/KeepAlive |
Refresh the current session to prevent time-out (Most Recently Used Time is updated). Maximum period between successive KeepAlive actions is configurable. |
Agents
Controller for HTrack agents endpoints
| API | Description |
|---|---|
| GET api/Agents/{agentID} |
Retrieve an agent matching the {agentID}, if found. |
| GET api/Agents/BranchSales?reportPeriodTypeNr={reportPeriodTypeNr}&branchID={branchID}&branchPropDataId={branchPropDataId}&agentStatusNr={agentStatusNr}&testGoBackMonths={testGoBackMonths} |
Get agent sales data per branch. |
| GET api/Agents/FranchiseSales?reportPeriodTypeNr={reportPeriodTypeNr}&franchiseID={franchiseID}&franchisePropDataId={franchisePropDataId}&agentStatusNr={agentStatusNr}&testGoBackMonths={testGoBackMonths} |
Get agent sales data per franchise. |
| GET api/Agents?agentStatusNr={agentStatusNr}&branchID={branchID}&agentID={agentID}&agentNumber={agentNumber}&agentPropDataId={agentPropDataId} |
Get all agents matching search parameters. |
Transactions
Controller for HTrack transactions endpoints
| API | Description |
|---|---|
| GET api/Transactions/{transactionID} |
Retrieve a transaction matching the {transactionID}, if found. The read flag does not apply (will always return the transaction). |
| 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. |
| 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. |
| GET api/Transactions/Sellers?fromCreateDate={fromCreateDate}&toCreateDate={toCreateDate}&setReadFlag={setReadFlag}&transactionStatusNr={transactionStatusNr}&listingNumber={listingNumber}&transactionID={transactionID} |
Get all transactions sellers matching search parameters, with contact details. If the read flag for the transaction seller has been set previously, and the transaction agent information did not change, then it will be excluded from the results. |
| GET api/Transactions/Stats |
Get basic statistics on transaction counts. |
| POST api/Transactions/ResetReadFlags?fromCreateDate={fromCreateDate}&toCreateDate={toCreateDate} |
Reset the read flags for all transactions and transaction agents in the date range. |
| 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. |
Branches
Controller for HTrack branch endpoints
| API | Description |
|---|---|
| GET api/Branches/{branchID} |
Retrieve a branch matching the {branchID}, if found. |
| GET api/Branches?branchStatusNr={branchStatusNr}&branchID={branchID}&branchNumber={branchNumber}&branchPropDataId={branchPropDataId} |
Get all branches matching search parameters. |