Get Money Direct Agent
Request Profile Table
Element | @Attribute |
Description/Contents |
GetMDAgent_RQ |
Root element of message. |
Market Code |
Client Market Code |
Client Type |
Indicates the Client Type:
- A - Agent Client Type
- B - All Client Types
- S - Supplier Client Type
|
Client Code |
Money Direct Client Code ( optional) |
Client Name |
Client Name |
Postcode |
Client Postcode (optional) |
State |
Client State (optional) |
Country |
Client Country ( optional) |
Scenario:
You want to retrieve agent info. The Market Code is "AU", the Client Type is "B" and the Client Name is "Test".
Example message:
<?xml version="1.0" encoding="utf-8"?>
<GetAgent_RQ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<MarketCode xmlns="ResLink">AU</MarketCode>
<ClientType xmlns="ResLink">'B' - All client types</ClientType>
<ClientCode xmlns="ResLink"/>
<ClientName xmlns="ResLink">Test</ClientName>
<Postcode xmlns="ResLink"/>
<State xmlns="ResLink"/>
<Country xmlns="ResLink"/>
</GetMDAgent_RQ>
Response Profile Table
Element | @Attribute |
Description/Contents |
GetAgent_RS |
Root element of message. |
Agent |
Element indicating an agent. |
Code |
Money Direct Agent Code |
Name |
Name. |
Address1 |
First address line. |
Address2 |
Second address line. |
Address3 |
Third address line. |
State |
State. |
Country |
Country. |
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 found, Market Code is required. The market code in the request message is empty. |
2 |
Agent could not be found, Name is required. The name in the request message is empty. |
3 |
Agent could not be found, Client Type is required. Valid values are [A,B,S]. The client type in the request message is empty. |
4 |
Agent could not be found, Market Code contains too many characters. The market code in the request message contains more than 4 charcaters. |
5 |
Agent could not be found, Client Code contains too many charcaters. The client code in the request message contains more than 8 characters. |
6 |
Agent could not be found, Client Name contains too many characters. The client name in the request message contains more than 20 characters. |
7 |
Agent could not be found, Postcode contains too many characters. The postcode in the request message contains more than 10 characters. |
8 |
Agent could not be found, State contains too many characters. The state in the request message contains more than 3 characters. |
8 |
Agent could not be found, Country contains too many characters. The state in the request message contains more than 2 characters. |
|
Example message:
<?xml version="1.0" encoding="utf-8"?>
<GetMDAgent_RS xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<MDAgent xmlns="ResLink">
<Code>126</Code>
<Name>Test Agent</Name>
<Address1>Unit 6</Address1>
<Address2>27 South Pine Rd</Address2>
<Address3>Brendale</Address3>
<State>QLD</State>
<Country>AUS</Country>
</MDAgent>
<TimeStamp xmlns="ResLink">2007-10-19T16:54:08.122064+10:00</TimeStamp>
<Errors xmlns="ResLink" />
<Warnings xmlns="ResLink" />
</GetMDAgent_RS>