Add New WebRes Agent

Request Profile Table

Element \| @Attribute	Description/Contents
AddNewWebResAgent_RQ	Root element of message.
ParentID	Element indicating the ID of the parent agent. If this is omitted, the service will search according to what is specified in Parent GUID. Leave empty if no parent
ParentGUID	Element indicating the GUID of the parent agent.
Name	Name of the agent branch
ABN	Australian Business Number (ABN) of the agent
PrimaryContact	Element containing the primary contact details of the agent
Name	Contact Name
Position	Contact Position
Phone	Contact Phone number
Fax	Contact Fax number
Email	Contact Email address
Address1	First Address line
Address2	Second Address line
Address3	Third Address line
Postcode	Postcode
State_GUID	Agent's state as identified by ProCharter System Code GUID
Country_GUID	Agent's country as identified by ProCharter System Code GUID
WebSite	Agent's website
ExistingAgent	Indicates if the agent has an existing business relationship with the provider
Account Contact	Element containing the account contact details of the agent
Name	Contact Name
Position	Contact Position
Phone	Contact Phone number
Fax	Contact Fax number
Email	Contact Email address
PreferredDepositType	Indicates the preferred deposit type for the agent. Valid values are: F - Paid in Full to Agent D - Deposit Paid to Agent N - No Deposit Paid to Agent
Currency	Agent's three letter currency code. (ie AUD, NZD, etc)
WebResUsername	Preferred Username
WebResPassword	Preferred Password
Agent_GUID	Agent's ProCharter GUID as identified by ProCharter Agent/Supplier GUID
MoneyDirectUser	Indicates if the Agent is currently a Money Direct customer
MoneyDirectInfo	Indicates if the Agent would like to be sent information about Money Direct
AcceptedTermsAndConditions	Indicates if the Agent has accepted the terms and conditions of the provider
Notes	Miscellaneous Notes

Scenario:

You want to add a new pending agent.

Example message:

<?xml version="1.0" encoding="utf-8"?>
<AddNewWebResAgent_RQ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <ParentID xmlns="ResLink" />
  <ParentGUID xmlns="ResLink" />
  <Name xmlns="ResLink">New Agent</Name>
  <ABN xmlns="ResLink">99 999 999 999</ABN>
  <PrimaryContact xmlns="ResLink">
    <Name>Marvin Smith</Name>
    <Position>Team Leader</Position>
    <Phone>+61 7 9999 9999</Phone>
    <Fax>+61 7 8888 8888</Fax>
    <Email>marvin@newagent</Email></PrimaryContact>
  <BranchCount xmlns="ResLink">1</BranchCount>
  <Address1 xmlns="ResLink" />
  <Address2 xmlns="ResLink" />
  <Address3 xmlns="ResLink" />
  <Postcode xmlns="ResLink" />
  <Country_GUID xmlns="ResLink" />
  <State_GUID xmlns="ResLink" />
  <WebSite xmlns="ResLink" />
  <ExistingAgent xmlns="ResLink">true</ExistingAgent>
  <AccountContact xmlns="ResLink">
    <Name>Annie Jones</Name>
    <Position>Accounts</Position>
    <Phone>+61 7 9999 9998</Phone>
    <Fax>+61 7 8888 8888</Fax>
    <Email>annie@newagent</Email></AccountContact>
  <PreferredDepositType xmlns="ResLink">D</PreferredDepositType>
  <Currency xmlns="ResLink">AUD</Currency>
  <WebResUsername xmlns="ResLink">newagent</WebResUsername>
  <WebResPassword xmlns="ResLink">rocks</WebResPassword>
  <Agent_GUID xmlns="ResLink" />
  <MoneyDirectUser xmlns="ResLink">false</MoneyDirectUser>
  <MoneyDirectInformation xmlns="ResLink">true</MoneyDirectInformation>
  <AcceptedTermsAndConditions xmlns="ResLink">false</AcceptedTermsAndConditions>
  <Notes xmlns="ResLink">Added via ResLink Testbed</Notes>
</AddNewWebResAgent_RQ>

Response Profile Table

Element | @Attribute

Description/Contents

The WebRes Agent ID prefixed with 'WR'.

Status

Element indicating the return status of the transaction.

@Code

A numerical code for the status.

@Message

The message of the status. The messages (and corresponding codes) returned are:

Code	Message
0	Agent request successful.
1	Agent could not be added, Name is required. The agent name in the request message is empty
2	Agent could not be added, Primary Contact Name is required The primary contact name in the request message is empty.
3	Agent could not be added, Primary Contact Email is required The primary contact email in the request message is empty.
4	Agent could not be added, Account Contact Name is required The account contact name in the request message is empty
5	Agent could not be added, Preferred DepositType is required. Valid values are [F,D,N]. The preferred deposit type in the request message is empty OR invalid.
6	Agent could not be added, Currency is required The currency in the request message is empty
7	Agent could not be added, WebRes Username is required The WebRes username in the request message is empty
8	Agent could not be added, Validation Errors... If any values are incorrect or missing when required, this message will be raised. Individual validation errors will be listed in the error messages.

Example message:

<?xml version="1.0" encoding="utf-8"?>
<AddNewWebResAgent_RS xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <ID xmlns="ResLink">WR3</ID>
  <Status Code="0" xmlns="ResLink" />
  <TimeStamp xmlns="ResLink">2008-05-06T14:41:29.640625+10:00</TimeStamp>
  <Errors xmlns="ResLink" />
  <Warnings xmlns="ResLink" />
</AddNewWebResAgent_RS>