Get Package Detail

Request Profile Table

Element \| @Attribute	Description/Contents
GetPackageDetail_RQ	Root element of message.
PackageID (optional)	Element indicating a Package ID. If you omit the package ID, all package details will be retrieved.
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 package detail where the package id is 2.

Example message:

<?xml version="1.0" encoding="utf-8"?>
<GetPackageDetail_RQ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<PackageID xmlns="ResLink">2</PackageID>
<Agent xmlns="ResLink" />
</GetPackageDetail_RQ>

Response Profile Table

Element | @Attribute

Description/Contents

GetPackageDetail_RS

Root element of message.

PackageDetails

Collection of PackageDetail nodes

PackageDetail

Element indicating package node

@ID

Package ID

@Name

Package Name

Description

Detailed Package description

PackageTemplates

Collection of PackageTemplate objects

PackageTemplate

Element representing a Package Template

@ID

Package Template ID

@Description

Package Template Description

@DefaultComponentID

ID of the Default Component for the Package Template

Components

Collection of Operator Voucher Components

OpVoucherComponent

Element representing an Operator Voucher Component

@ID

Operator Voucher Component ID

@Description

Operator Voucher Component Description

@VoucherType

Voucher Type. Should be "OP"

Images

Collection of Images for the Package

Image

Element representing a single Image

@Description

Text description of the Image

@Url

Url of the Image

Featured Product Image Url

TermsAndConditions

Component Terms and Conditions

BonusPoints

Collection of Bonus Point objects

BonusPoints

Element representing a single instance of a Bonus Points available for the current package

@Name

Name of Bonus Points

@Description

Text description of Bonus Points

@Type

Type of Bonus Points

Value	Description
x	Points multiplier. The total points for this package should be calculated as the standard points multiplied by the bonus points value
#	Points amount. The total points for this package should be calculated as the standard points plus the bonus points value

@Value

Bonus Points Value, see @Type above for more details

@DateFrom

Start date of the Bonus Points

@DateTo

Finish date of the Bonus Points

@Weight

If there are overlapping Bonus Point items for a given date the item with the largest Weight value should be used.

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	Get Package Detail request successful.
1	Invalid Package ID

Example message:

<?xml version="1.0" encoding="utf-16"?>
<GetPackageDetail_RS xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <PackageDetails xmlns="ResLink">
    <PackageDetail ID="2" Name="Awesome Package ">
      <Description>some html description</Description>
      <PackageTemplates>
        <PackageTemplate ID="3" Description="Sailing" DefaultComponentID="68">
          <Components>
            <OpVoucherComponent ID="68" Description="Hammer 2d1n Multi Share QSS" VoucherType="OP" SupplierName="Explore Whitsundays PKG" />
            <OpVoucherComponent ID="138" Description="Siska 2d1n Multi Share SF" VoucherType="OP" SupplierName="Explore Whitsundays" />
          </Components>
        </PackageTemplate>
        <PackageTemplate ID="4" Description="Fraser Island" DefaultComponentID="24">
          <Components>
            <OpVoucherComponent ID="24" Description="3D2N Cool Dingo Guided Fraser Tour - Dbl/Tw Lodge Accom" VoucherType="OP" SupplierName="Kingfisher Resort Fraser Is" />
          </Components>
        </PackageTemplate>
      </PackageTemplates>
      <Images>
        <Image Description="Description goes here" Url="http://cwc.co/images/banner_ProCharter.png" />
      </Images>
      <Tags>
        <Tag Tag="airlie beach" Group="australia" Category="T03" />
        <Tag Tag="package" Group="" Category="T02" />
        <Tag Tag="*special*" Category="T04" />
      </Tags>
      <Featured Featured="false" Description="" Url="" />
      <TermsAndConditions>some html <b>terms and conditions</b></TermsAndConditions>
      <BonusPoints>
        <BonusPoint Name="Bonus 10" Description="10 Bonus Points" Type="#" Value="10" DateFrom="2011-01-01T00:00:00" DateTo="2011-02-01T00:00:00" Weight="5" />
        <BonusPoint Name="Double Points" Description="Double Your Points for Australia Day" Type="x" Value="2" DateFrom="2011-01-26T00:00:00" DateTo="2011-01-27T00:00:00" Weight="10" />
      </BonusPoints>
    </PackageDetail>
  </PackageDetails>
  <Status Code="0" xmlns="ResLink" />
  <TimeStamp xmlns="ResLink">2011-01-04T11:17:46.234375+10:00</TimeStamp>
  <Errors xmlns="ResLink" />
  <Warnings xmlns="ResLink" />
</GetPackageDetail_RS>