LLSR API - Tri Area Hotlist (HL) port docs and examples.
This document explains the simple use of the hotlist port, its methods and limitations.
Connecting to the API
The code below will create a PHP soap client object that contains all of the HL-API methods.
$client = new
SoapClient('https://api.skilouise.com/HL-API.php?WSDL',array('trace'
=> true,'exceptions' => false));
Full details of HL-API, its methods and responses can be found by viewing the WSDL file here.
Getting the Tri Area hotlist
To collect a copy of the current hotlist use the code below.
$response = $client->getHotlist($apiKey, $password, false)
The code above will return all entries on the hotlist with codes != 0. To limit the listing you can add send a date time stamp ( Y-m-d H:i:s ) in place of the false value. This will cause the API to return only result after the given date and time.
To limit the result of the listing further see the getPassHotlist method below.
The getHotlist method will return an object with the following values
- result : boolean true if the process completed else false
- count : int the number of entries returned in the list
- hotlist : string a Json encoded array containing the hotlist entries. This will be an empty array if no count or result is false.
Getting the hotlist for a single pass
$response = $client->getPassHotlist($apiKey, $password,
$passNumber)
The getpassHotList method returns only the hotlist entries for $passNumber. $passnumber can be a ticket number or season pass number.
The above code will return an object with the following vaules
- result : boolean true if the process completed else false
- count : int the number of entries returned in the list
- hotlist : string a Json encoded array containing the hotlist entries. This will be an empty array if no count or result is false.
Adding a pass/ticket to the hotlist
The code example below shows how to add a pass or ticket to the tri area hotlist. This method returns a simple boolean True or False as its result.
$response = $client->addHotlist($apiKey, $password, $ticket,
$code, $until, $resort, $by, $comment)
The $apiKey and password are required as always, $ticket is the bar code from the ticket or pass to be hotlisted, $code is the hotlist code to set (see below), $until to the date that the hotlist should remain in effect, $resort is the short code for your resort ( see below), $by is the name of the person/employee adding the hotlist, $comment should contain any notes needed. Only $comment is optional and should not contain any HTML for formatting tags.
Only tri area tickets and passes from tri area resorts will be accepted in to this hotlist.
Only the following short resort values will be accepted:
- For Lake Louise use LL
- For Sunshine use SV
- For Norquay use NQ
- For The Ski Hub use SH
This is a list of accepted hotlist codes and what they represent
- 0 - ACTIVE
- 13 - PASS EXPIRED
- 21 - REFUNDED PASS
- 22 - REISSUED PASS
- 51 - HL-DISMISSAL
- 52 - HL-FRIENDLY
- 53 - HL-LOST
- 54 - HL-MISCONDUCT
- 55 - HL-REFUND
- 56 - HL-STOLEN
- 57 - HL-FORGOT SP
- 58 - HL-QUIT
- 59 - WINNER-KEEP TICKET
- 60 - USED LAST YEAR
- 61 - HL-SICK
- 62 - HL-NOT VALID AT LL
- 65 - HL-CALL RCMP
- 70 - REFUNDED
- 90 - DTL-CAPTURE CARD
- 91 - DTL-UNPAID BALANCE
- 92 - DTL- CC PROBLEM
- 93 - DTL-CC LOST
- 94 - DTL-NO VALID EMAIL
- 95 - HL-SEASON OVER
- 96 - HL - SEE HR
- 97 - HL - WCB NO SKI!