Show Package Node
Show Package Node
This node contains show registration package definitions. These nodes are contained within a ShowPackages container node.
Example:
<ShowPackage ShowPackageKey="792" Name="Free Basic Access" ExternalID="" FromDate="2010-01-01 08:00:00" ToDate="2010-02-20 17:00:00" IsAddOnPackage="0" IsPrivate="0" PackagePrecendence="0" DiscountMethod="0" BuiltInDiscountPct="0" BuiltInDiscountAmt="0.00" MinAddOnItems="0" MaxAddOnItems="0" />
Calling the API
The API is called via a secure HTTPS request. This HTTPS request may be a GET or POST operation. Each request must supply the authentication credentials assigned to the caller by Notified. Only requests with valid credentials will be processed. These credentials identify the caller and provide access only to a specific customer area.
The format of the call :https://api.onlinexperiences.com/scripts/Server.nxp?LASCmd=AI:4;F:APIUTILS!50565&APIUserAuthCode={YourAuthCode}&APIUserCredentials={YourCredentials}&ShowKey={ShowKey}&InfoTypeFilter={filter code list, in |OPTION|OPTION| format…}
Note: The format of the APAC Data Center is: https://api.apac.onlinexperiences.com.
Specific parameter ordering is unimportant, with the only restriction being that the first parameter MUST BE LASCmd=AI:4;F:APIUTILS!50565. All other parameters may appear in any sequence order.
|
Attribute |
Type |
Comment |
|---|---|---|
|
ShowPackageKey |
Integer |
The Notified show package key for this package. |
|
Name |
String |
The title of the registration package. |
|
ExternalID |
String |
External ID for this registration package. |
|
FromDateTime |
Date |
Effective starting availability date and time for this package. |
|
ToDateTime |
Date |
Effective ending availability date and time for this package. |
|
IsAddOnPackage |
Flag (0/1) |
Flag indicating whether this package is an add-on package to be purchased in addition to an existing package. |
|
IsPrivate |
Flag (0/1) |
Flag indicating whether this package is private and not visible to general registrants. |
|
PackagePrecendence |
Integer |
A value indicating the relationship of this package to other packages for upgrade purposes. |
|
DiscountMethod |
Integer |
Control indicating what type of discount to apply. A value of 0 indicates a discount percentage, while a value of one (1) indicates a flat discount amount. |
|
BuiltInDiscountPct |
Integer |
Percentage discount to be applied, as a whole number. |
|
BuiltInDiscountAmt |
Decimal |
The currency value of discount to be applied, in USD. |
|
MinAddOnItems |
Integer |
The minimum number of add-on items that must be selected to register with this package. |
|
MaxAddOnItems |
Integer |
The maximum number of add-on items that can be selected when registering with this package. |