GET api/Branches?branchStatusNr={branchStatusNr}&branchID={branchID}&branchNumber={branchNumber}&branchPropDataId={branchPropDataId}

Get all branches matching search parameters.

Request Information

URI Parameters

Name	Description	Type	Additional information
branchStatusNr	Optional: Current branch status nr. 1=Active, 2=Inactive	integer	None.
branchID	Optional: HTrack branch unique identifier	globally unique identifier	None.
branchNumber	Optional: H1 branch number	integer	None.
branchPropDataId	Optional: PropData branch identifier	integer	None.

Body Parameters

None.

Response Information

Resource Description

BranchesResponse

Name	Description	Type	Additional information
ClassVer	Class version	integer	None.
BranchCount	Number of branches in list	integer	None.
Branches	List of branches	DataTable	None.

Response Formats

application/json, text/json

Sample:

{
  "ClassVer": 1,
  "BranchCount": 1,
  "Branches": null
}

application/xml, text/xml

Sample:

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