GET api/Agents?agentStatusNr={agentStatusNr}&branchID={branchID}&agentID={agentID}&agentNumber={agentNumber}&agentPropDataId={agentPropDataId}

Get all agents matching search parameters.

Request Information

URI Parameters

Name	Description	Type	Additional information
agentStatusNr	Optional: Current agent status nr. 1=Active, 2=Inactive	integer	None.
branchID	Optional: HTrack Branch unique identifier. This will list all agents associated with a branch.	globally unique identifier	None.
agentID	Optional: HTrack Agent unique identifier	globally unique identifier	None.
agentNumber	Optional: H1 Agent number	integer	None.
agentPropDataId	Optional: PropData agent identifier	integer	None.

Body Parameters

None.

Response Information

Resource Description

AgentsResponse

Name	Description	Type	Additional information
ClassVer	Class version	integer	None.
AgentCount	Number of agents in list	integer	None.
Agents	List of agents	DataTable	None.

Response Formats

application/json, text/json

Sample:

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

application/xml, text/xml

Sample:

<AgentsResponse 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" />
</AgentsResponse>