GET api/loyaltyprograms/{id}

Request Information

URI Parameters

Name	Description	Type	Additional information
id		integer	Required

Body Parameters

None.

Response Information

Resource Description

LoyaltyProgram

Name	Type	Additional information
Id	integer	None.
PropertyId	integer	None.
ProgramCode	string	None.
ProgramName	string	None.
IsActive	boolean	None.
EvaluationPeriodType	LoyaltyEvaluationPeriodTypes	None.
EvaluationPeriodValue	integer	None.
RedeemablePointsExpireInMonths	integer	None.
DefaultPointsPerEuro	decimal number	None.
DefaultEarnMultiplier	decimal number	None.
PointsRoundingMode	NumberRoundingModes	None.
Tiers	Collection of LoyaltyTier	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "PropertyId": 1,
  "ProgramCode": "sample string 2",
  "ProgramName": "sample string 3",
  "IsActive": true,
  "EvaluationPeriodType": 0,
  "EvaluationPeriodValue": 1,
  "RedeemablePointsExpireInMonths": 1,
  "DefaultPointsPerEuro": 5.0,
  "DefaultEarnMultiplier": 6.0,
  "PointsRoundingMode": 0,
  "Tiers": [
    {
      "Id": 1,
      "LoyaltyProgramId": 2,
      "TierName": "sample string 3",
      "TierCode": "sample string 4",
      "TierRank": 5,
      "PointsThreshold": 6.0,
      "EarnMultiplier": 7.0
    },
    {
      "Id": 1,
      "LoyaltyProgramId": 2,
      "TierName": "sample string 3",
      "TierCode": "sample string 4",
      "TierRank": 5,
      "PointsThreshold": 6.0,
      "EarnMultiplier": 7.0
    }
  ]
}

application/xml, text/xml

Sample:

<LoyaltyProgram xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Atlantis.Web.Api.Models">
  <DefaultEarnMultiplier>6</DefaultEarnMultiplier>
  <DefaultPointsPerEuro>5</DefaultPointsPerEuro>
  <EvaluationPeriodType>NoType</EvaluationPeriodType>
  <EvaluationPeriodValue>1</EvaluationPeriodValue>
  <Id>1</Id>
  <IsActive>true</IsActive>
  <PointsRoundingMode>None</PointsRoundingMode>
  <ProgramCode>sample string 2</ProgramCode>
  <ProgramName>sample string 3</ProgramName>
  <PropertyId>1</PropertyId>
  <RedeemablePointsExpireInMonths>1</RedeemablePointsExpireInMonths>
  <Tiers>
    <LoyaltyTier>
      <EarnMultiplier>7</EarnMultiplier>
      <Id>1</Id>
      <LoyaltyProgramId>2</LoyaltyProgramId>
      <PointsThreshold>6</PointsThreshold>
      <TierCode>sample string 4</TierCode>
      <TierName>sample string 3</TierName>
      <TierRank>5</TierRank>
    </LoyaltyTier>
    <LoyaltyTier>
      <EarnMultiplier>7</EarnMultiplier>
      <Id>1</Id>
      <LoyaltyProgramId>2</LoyaltyProgramId>
      <PointsThreshold>6</PointsThreshold>
      <TierCode>sample string 4</TierCode>
      <TierName>sample string 3</TierName>
      <TierRank>5</TierRank>
    </LoyaltyTier>
  </Tiers>
</LoyaltyProgram>