LLSR API - Gift Card API Specification and Examples

Reading

The current balance of a given gift card or season pass can be read from the balance node. The following example shows how the /giftCard/[cardNumber]/balance endpoint is used to achieve this:

GET /giftCard/H4E62548/balance HTTP/1.1
Host: api.skilouise.com

In this example, a query on the balance endpoint might generate the following JSON-encoded result:

{
  "balance":0
}

If the card number being queried does not exist then the following JSON-encoded result might be generated:

{
  "error":{
    "message":"Card number invalid"
  }
}

Publishing

Unavailable.

Updating

Unavailable.

Deleting

Unavailable.

Reading

The member ID associated with a given gift card or season pass can be read from the member node. The following example shows how the /giftCard/[cardNumber]/member endpoint is used to achieve this:

GET /giftCard/H4E62548/member HTTP/1.1
Host: api.skilouise.com

In this example, a query on the member endpoint might generate the following JSON-encoded result:

{
  "memberID":123456
}

If the card number being queried is not associated with a member profile, a null memberID is returned:

{
  "memberID":null
}

If the card number being queried does not existi, or is not associated with a member profile, then the following JSON-encoded result might be generated:

{
  "error":{
    "message":"Gift card info could not be retrieved"
  }
}

Publishing

Unavailable.

Updating

Unavailable.

Deleting

Unavailable.

Reading

The registration details of a given gift card can be queried using the registration node. The following examples shows how the /giftCard/[cardNumber]/registration endpoint is used to achieve this:

GET /giftCard/3030000000000000/registration HTTP/1.1
Host: api.skilouise.com

If the given gift card is registered, but is not associated with a member profile, then the following is an example of the JSON-encoded result that may be generated:

{
  "registered":"true",
  "hasLinkedMember":"false",
  "user":{
    "firstName":"John",
    "lastName":"Doe",
    "passPhrase":"[email protected]"
  }
}

If a valid authentication token is not provided, the result will only include the registered and hasLinkedMember parameters; i.e.:

{
  "registered":"true"
  "hasLinkedMember":"false",
}

If the given gift card is unregistered, but is associated with a member profile, then the following JSON-encoded result is generated:

{
  "registered":"false"
  "hasLinkedMember":"true",
}

Publishing

A given gift card can be registered from the registration node. The following example shows how the /giftCard/[cardNumber]/registration endpoint is used to achieve this:

POST /giftCard/3030000000000000/registration HTTP/1.1
Host: api.skilouise.com

[email protected]&passPhrase=itsasecret

In this example, the gift card 3030000000000000 is registered to John Doe <[email protected]> with the passphrase 'itsasecret'.

If successful, the following JSON-encoded result is generated:

{
  "success":"true"
}

If the email address provided does fails validation, the following JSON-encoded result might be generated:

{
  "error":{
    "message":"Invalid email address"
  }
}

If the passphrase provided does not meet the minimum complexity requirements, the following JSON-encoded result might be generated:

{
  "error":{
    "message":"Password does not meet complexity requirements"
  }
}

If the card number requested for registration has already been registered, then the following JSON-encoded result might be generated:

{
  "error":{
    "message":"Card already registered"
  }
}

If the card number requested for registration does not exist then the following JSON-encoded result might be generated:

{
  "error":{
    "message":"Card number invalid"
  }
}

Updating

Unavailable.

Deleting

Unavailable.

Reading

Unavailable.

Publishing

A new authentication token can be generated from the token node. The following example shows how the /giftCard/[cardNumber]/token endpoint is used to achieve this:

POST /giftCard/H4E62548/token HTTP/1.1
Host: api.skilouise.com

passPhrase=itsasecret

In this example, a new authentication token is generated for the pass "H4E62548".

If successful, the following JSON-encoded result is generated:

{
  "token":"12345678-9012-3456-7890-123456789012"
  "expiry":2020-01-01T09:00:00-06:00"
}

This token can be used to make requests to the /giftCard/[cardNumber]/topup endpoint on or before the specified expiry date.

If the card number requested for the topup does not exist then the following JSON-encoded result might be generated:

{
  "error":{
    "message":"Card number invalid"
  }
}

If the passphrase provided does not match the passphrase on file, the following JSON-encoded result might be generated:

{
  "error":{
    "message":"Incorrect passphrase"
  }
}

Updating

Unavailable.

Deleting

Unavailable.

Reading

Unavailable.

Publishing

The current balance of a given gift card or season pass can be increased from the topup node. The following example shows how the /giftCard/[cardNumber]/topup endpoint is used to achieve this:

POST /giftCard/H4E62548/topup HTTP/1.1
Host: api.skilouise.com

amount=1.99&transNumber=123456789

In this example, the pass "H4E62548" is topped up with $1.99 of gift card credit.

If the card number requested for the topup does not exist then the following JSON-encoded result might be generated:

{
  "error":{
    "message":"Card number invalid"
  }
}

If the transNumber provided for the topup does not meet the requirements stated above under "Parameters", the following JSON-encoded result might be generated:

{
  "error":{
    "message":"Payment reference number invalid"
  }
}

Updating

Unavailable.

Deleting

Unavailable.