Get Package Rates
Returns the Rates for all the Components on a Package
Request Profile Table
Element | @Attribute |
Description/Contents |
GetPackageRates_RQ |
Root element of message. |
PackageID |
ID of the Package to return Rates for |
Agent |
Element representing an agent.
To specify an agent you can just provide either the ID, or the GUID. If both are
provided ResLink will make a check to see if the GUID and ID match in the database
and will error if they don't. If left blank will return use direct to consumer settings. |
@ID (optional) |
The Agent ID. |
@GUID (optional) |
The Agent GUID. |
Scenario:
You want to retrieve the rates for Package #4 for the Test Agent.
Example message:
<?xml version="1.0" encoding="utf-8"?>
<GetPackageRates_RQ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<PackageID>4</PackageID>
<Agent ID="1" GUID="TEST" />
</GetPackageTypes_RS>
Response Profile Table
Element | @Attribute |
Description/Contents |
GetPackageRates_RS |
Root element of message. |
Rates |
Collection of ComponentRates objects |
ComponentRate |
Element representing a Rate for a Component |
@ComponentID |
ID of the Component |
@RackRate |
Sell Price of the Component on this Package |
@Commission |
Commission value of the Component on this Package |
@Currency |
Currency Code |
Example message:
<?xml version="1.0" encoding="utf-8"?>
<GetPackageRates_RS xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<Rates xmlns="ResLink">
<ComponentRate PaxCount="1" RackRate="0.00" Commission="0.00" Currency="AUD" ComponentID="20" />
<ComponentRate PaxCount="1" RackRate="369" Commission="66.42" Currency="AUD" ComponentID="76" />
<ComponentRate PaxCount="1" RackRate="369" Commission="66.42" Currency="AUD" ComponentID="77" />
<ComponentRate PaxCount="1" RackRate="369" Commission="66.42" Currency="AUD" ComponentID="79" />
<ComponentRate PaxCount="1" RackRate="369" Commission="66.42" Currency="AUD" ComponentID="80" />
</Rates>
<Status Code="0" xmlns="ResLink" />
<TimeStamp xmlns="ResLink">2011-06-11T12:22:30.0277394+10:00</TimeStamp>
<Errors xmlns="ResLink" />
<Warnings xmlns="ResLink" />
</GetPackageRates_RS>