Get Packages
Request Profile Table
| Element | @Attribute |
Description/Contents |
| GetPackages_RQ |
Root element of message. |
| @LastDateCalled (optional) |
DateTimeStamp of previous call to GetPackages. Will return only Packages that have
been modified after this date (not yet implemented). |
| PackageTypes (optional) |
Element representing a list of package types. If you omit package types, all packages will be retrieved. |
| PackageType |
Element representing a package type. |
| @ID |
The ID of the package type. |
@Description
(optional) |
The description of the package type. This is ignored. |
| 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 all the packages that go under the package type "Package". It's ID is "PAC".
Example message:
<?xml version="1.0" encoding="utf-8"?>
<GetPackages_RQ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<PackageTypes xmlns="ResLink">
<PackageType ID="PAC" />
</PackageTypes>
<Agent xmlns="ResLink" />
</GetPackages_RQ>
Response Profile Table
| Element | @Attribute |
Description/Contents |
| GetPackages_RS |
Root element of message. |
| Packages |
Element indicating a list of packages. |
| Package |
Element indicating a package. |
| @ID |
The ID of the package. |
| @Description |
The description of the package. |
| PackageType |
Element indicating the package type for the package above. |
| @ID |
The ID of the package type. |
| @Description |
The description of the package type. |
Example message:
<?xml version="1.0" encoding="utf-8"?>
<GetPackages_RS xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<Packages xmlns="ResLink">
<Package ID="2" Description="Budget Package">
<PackageType ID="PAC" Description="Package" />
</Package>
<Package ID="5" Description="Classic Sail">
<PackageType ID="PAC" Description="Package" />
</Package>
</Packages>
<TimeStamp xmlns="ResLink">2008-05-01T16:41:56.3942567+10:00</TimeStamp>
<Errors xmlns="ResLink" />
<Warnings xmlns="ResLink" />
</GetPackages_RS>