POST api/Agent/AgentsReport

Get Agent Hierarchy

Request Information

URI Parameters

None.

Body Parameters

AgentFilterInputModel
NameDescriptionTypeAdditional information
Limit

No of records to be retrieved

integer

None.

Offset

Page number

integer

None.

SortParam

Gets or sets the sort option.

integer

None.

OfficerIDs

Gets or sets multiple agents selected in the agent tree list

Collection of string

None.

AgentName

Gets or sets the name of the agent.

string

None.

AgentNumber

Gets or sets the AgentNumber of the agency.

string

None.

ID

Hold id

string

None.

ProductName

Product name

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Limit": 1,
  "Offset": 2,
  "SortParam": 3,
  "OfficerIDs": [
    "sample string 1",
    "sample string 2"
  ],
  "AgentName": "sample string 4",
  "AgentNumber": "sample string 5",
  "ID": "sample string 6",
  "ProductName": "sample string 7"
}

application/xml, text/xml

Sample:
<AgentFilterInputModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GBG.AS.AgentPortal.API.Areas.Agents.Models">
  <AgentName>sample string 4</AgentName>
  <AgentNumber>sample string 5</AgentNumber>
  <ID>sample string 6</ID>
  <Limit>1</Limit>
  <OfficerIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </OfficerIDs>
  <Offset>2</Offset>
  <ProductName>sample string 7</ProductName>
  <SortParam>3</SortParam>
</AgentFilterInputModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Instance of the hierarchy details

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.