Get Agents

Request Profile Table

Element \| @Attribute	Description/Contents
GetAgents_RQ	Root element of message.

Scenario:

You want to retrieve all active agents.

Example message:

<?xml version="1.0" encoding="utf-8"?>
<GetAgents_RQ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
</GetAgent_RQs>

Response Profile Table

Element \| @Attribute	Description/Contents
GetAgents_RS	Root element of message.
Agents	Collection of Agent objects
Agent	Element indicating an agent.
ID	Agent's ID.
GUID	Agent's GUID
Name	Name
Address1	First address line
Address2	Second address line
Address3	Third address line
State	State
Country	Country
Email	Email address
MoneyDirectCode	Money Direct Client Code
ECN	eNett ECN
DepositType	Deposit Type F - Paid in Full to Agent D - Deposit Paid to Agent N - No Deposit Paid to Agent
Active	Active flag
ResourcePermissions	Collection of Resource Permission objects.
ResourcePermission	Object representing a Resource that the agent has access to (via the Availability Service)
@ID	ID of the Resource
@Name	Name of the Resource
PackagePermissions	Collection of Package Permission objects.
PackagePermission	Object representing a Package that the agent has access to (via the Package Service)
@ID	ID of the Package
@Name	Name of the Package
ComponentPermissions	Collection of Component Permission objects.
ComponentPermission	Object representing an Addon Component that the agent has access to (via the Package Service)
@ID	ID of the Component
@Name	Name of the Component

Example message:

<?xml version="1.0" encoding="utf-8"?>
<GetAgents_RS xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Agents>
    <Agent>
      <ID>1499</ID>
      <GUID>TEST</GUID>
      <Name>Test Agent</Name>
      <Address1>Shop 1</Address1>
      <Address2>15 Some St</Address2>
      <Address3>Brisbane</Address3>
      <State>QLD</State>
      <PostCode>4000</PostCode>
      <Country>AUS</Country>
      <Email>test@example.org</Email>
      <MoneyDirectCode>TEST</MoneyDirectCode>
      <ECN>123</ECN>
      <DepositType>F</DepositType>
      <Active>True</Active>
      <ResourcePermissions>
        <Permission ID="85" Name="Boomerang 2d/2n" />
        <Permission ID="97" Name="British Defender 2d/2n" />
      </ResourcePermissions>
      <PackagePermissions>
        <Permission ID="28" Name="Flexi Accommodation" />
        <Permission ID="30" Name="Best of Brazil" />
      </PackagePermissions>
      <ComponentPermissions>
        <Permission ID="65" Name="Twin Room" />
      </ComponentPermissions>
    </Agent>
    <Agent>
      <ID>1500</ID>
      <GUID>TEST2</GUID>
      <Name>Test Agent 2</Name>
      <Address1>Shop 2</Address1>
      <Address2>2 Some St</Address2>
      <Address3>Brisbane</Address3>
      <State>QLD</State>
      <PostCode>4000</PostCode>
      <Country>AUS</Country>
      <Email>test@example.org</Email>
      <MoneyDirectCode></MoneyDirectCode>
      <ECN></ECN>
      <DepositType>D</DepositType>
      <Active>True</Active>
      <ResourcePermissions>
        <Permission ID="85" Name="Boomerang 2d/2n" />
        <Permission ID="97" Name="British Defender 2d/2n" />
      </ResourcePermissions>
      <PackagePermissions>
        <Permission ID="28" Name="Flexi Accommodation" />
        <Permission ID="30" Name="Best of Brazil" />
      </PackagePermissions>
      <ComponentPermissions>
        <Permission ID="65" Name="Twin Room" />
      </ComponentPermissions>
    </Agent>
  </Agents>
  <TimeStamp xmlns="ResLink">2007-10-19T16:54:08.122064+10:00</TimeStamp>
  <Errors xmlns="ResLink" />
  <Warnings xmlns="ResLink" />
</GetAgents_RS>