POST loyalty/{cardNumber}

Request Information

URI Parameters

Name	Description	Type	Additional information
cardNumber		string	Required

Body Parameters

LoyaltyRequest

Name	Type	Additional information
company	string	None.
companyUsername	string	None.
companyPassword	string	None.
requestUser	string	None.
requestPassword	string	None.

Request Formats

application/json, text/json

Sample:

{
  "company": "sample string 1",
  "companyUsername": "sample string 2",
  "companyPassword": "sample string 3",
  "requestUser": "sample string 4",
  "requestPassword": "sample string 5"
}

application/xml, text/xml

Sample:

<LoyaltyRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Loyalty.Core.Contracts">
  <company>sample string 1</company>
  <companyPassword>sample string 3</companyPassword>
  <companyUsername>sample string 2</companyUsername>
  <requestPassword>sample string 5</requestPassword>
  <requestUser>sample string 4</requestUser>
</LoyaltyRequest>

Response Information

Resource Description

Collection of BonusPlan

Name	Type	Additional information
bonusPlanId	integer	None.
name	string	None.
status	string	None.
type	string	None.
metricType	integer	None.
description	string	None.
reward	string	None.
rewards	Collection of BonusPlanReward	None.
rewardThreshold	string	None.
credit	string	None.
attributes	Dictionary of string [key] and string [value]	None.
lifetimeRewardCount	integer	None.
expireDate	date	None.
memberExpireDate	date	None.
meritEndDay	date	None.
meritStartDay	date	None.
occasionType	integer	None.
occasionTypeName	string	None.
profileQualification	boolean	None.
rewardResetDate	date	None.
nextBirthdayReward	string	None.
startDate	date	None.
rewardPriority	string	None.
rewardProgramId	integer	None.
deferRewardSetting	boolean	None.
availableItems	Collection of BonusPlanItem	None.
purchasedItems	Collection of BonusPlanItem	None.
lastRewards	Collection of BonusPlanLastReward	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "bonusPlanId": 1,
    "name": "sample string 2",
    "status": "sample string 3",
    "type": "sample string 4",
    "metricType": 5,
    "description": "sample string 6",
    "reward": "sample string 7",
    "rewards": [
      {
        "programId": 1,
        "rewardId": 2,
        "name": "sample string 3",
        "expirationDate": "2024-11-07T04:34:40.0693327+00:00",
        "rewardType": 5,
        "rewardTypeName": "sample string 6"
      },
      {
        "programId": 1,
        "rewardId": 2,
        "name": "sample string 3",
        "expirationDate": "2024-11-07T04:34:40.0693327+00:00",
        "rewardType": 5,
        "rewardTypeName": "sample string 6"
      }
    ],
    "rewardThreshold": "sample string 8",
    "credit": "sample string 9",
    "attributes": {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    },
    "lifetimeRewardCount": 10,
    "expireDate": "2024-11-07T04:34:40.0693327+00:00",
    "memberExpireDate": "2024-11-07T04:34:40.0693327+00:00",
    "meritEndDay": "2024-11-07T04:34:40.0693327+00:00",
    "meritStartDay": "2024-11-07T04:34:40.0693327+00:00",
    "occasionType": 15,
    "occasionTypeName": "sample string 16",
    "profileQualification": true,
    "rewardResetDate": "2024-11-07T04:34:40.0693327+00:00",
    "nextBirthdayReward": "sample string 19",
    "startDate": "2024-11-07T04:34:40.0693327+00:00",
    "rewardPriority": "sample string 21",
    "rewardProgramId": 22,
    "deferRewardSetting": true,
    "availableItems": [
      {
        "itemId": 1,
        "name": "sample string 2"
      },
      {
        "itemId": 1,
        "name": "sample string 2"
      }
    ],
    "purchasedItems": [
      {
        "itemId": 1,
        "name": "sample string 2"
      },
      {
        "itemId": 1,
        "name": "sample string 2"
      }
    ],
    "lastRewards": [
      {
        "name": "sample string 1",
        "threshold": 2.1
      },
      {
        "name": "sample string 1",
        "threshold": 2.1
      }
    ]
  },
  {
    "bonusPlanId": 1,
    "name": "sample string 2",
    "status": "sample string 3",
    "type": "sample string 4",
    "metricType": 5,
    "description": "sample string 6",
    "reward": "sample string 7",
    "rewards": [
      {
        "programId": 1,
        "rewardId": 2,
        "name": "sample string 3",
        "expirationDate": "2024-11-07T04:34:40.0693327+00:00",
        "rewardType": 5,
        "rewardTypeName": "sample string 6"
      },
      {
        "programId": 1,
        "rewardId": 2,
        "name": "sample string 3",
        "expirationDate": "2024-11-07T04:34:40.0693327+00:00",
        "rewardType": 5,
        "rewardTypeName": "sample string 6"
      }
    ],
    "rewardThreshold": "sample string 8",
    "credit": "sample string 9",
    "attributes": {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    },
    "lifetimeRewardCount": 10,
    "expireDate": "2024-11-07T04:34:40.0693327+00:00",
    "memberExpireDate": "2024-11-07T04:34:40.0693327+00:00",
    "meritEndDay": "2024-11-07T04:34:40.0693327+00:00",
    "meritStartDay": "2024-11-07T04:34:40.0693327+00:00",
    "occasionType": 15,
    "occasionTypeName": "sample string 16",
    "profileQualification": true,
    "rewardResetDate": "2024-11-07T04:34:40.0693327+00:00",
    "nextBirthdayReward": "sample string 19",
    "startDate": "2024-11-07T04:34:40.0693327+00:00",
    "rewardPriority": "sample string 21",
    "rewardProgramId": 22,
    "deferRewardSetting": true,
    "availableItems": [
      {
        "itemId": 1,
        "name": "sample string 2"
      },
      {
        "itemId": 1,
        "name": "sample string 2"
      }
    ],
    "purchasedItems": [
      {
        "itemId": 1,
        "name": "sample string 2"
      },
      {
        "itemId": 1,
        "name": "sample string 2"
      }
    ],
    "lastRewards": [
      {
        "name": "sample string 1",
        "threshold": 2.1
      },
      {
        "name": "sample string 1",
        "threshold": 2.1
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfBonusPlan xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Loyalty.Core.Contracts">
  <BonusPlan>
    <attributes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value>sample string 2</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 3</d3p1:Key>
        <d3p1:Value>sample string 4</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </attributes>
    <availableItems>
      <BonusPlanItem>
        <itemId>1</itemId>
        <name>sample string 2</name>
      </BonusPlanItem>
      <BonusPlanItem>
        <itemId>1</itemId>
        <name>sample string 2</name>
      </BonusPlanItem>
    </availableItems>
    <bonusPlanId>1</bonusPlanId>
    <credit>sample string 9</credit>
    <deferRewardSetting>true</deferRewardSetting>
    <description>sample string 6</description>
    <expireDate>2024-11-07T04:34:40.0693327+00:00</expireDate>
    <lastRewards>
      <BonusPlanLastReward>
        <name>sample string 1</name>
        <threshold>2.1</threshold>
      </BonusPlanLastReward>
      <BonusPlanLastReward>
        <name>sample string 1</name>
        <threshold>2.1</threshold>
      </BonusPlanLastReward>
    </lastRewards>
    <lifetimeRewardCount>10</lifetimeRewardCount>
    <memberExpireDate>2024-11-07T04:34:40.0693327+00:00</memberExpireDate>
    <meritEndDay>2024-11-07T04:34:40.0693327+00:00</meritEndDay>
    <meritStartDay>2024-11-07T04:34:40.0693327+00:00</meritStartDay>
    <metricType>5</metricType>
    <name>sample string 2</name>
    <nextBirthdayReward>sample string 19</nextBirthdayReward>
    <occasionType>15</occasionType>
    <occasionTypeName>sample string 16</occasionTypeName>
    <profileQualification>true</profileQualification>
    <purchasedItems>
      <BonusPlanItem>
        <itemId>1</itemId>
        <name>sample string 2</name>
      </BonusPlanItem>
      <BonusPlanItem>
        <itemId>1</itemId>
        <name>sample string 2</name>
      </BonusPlanItem>
    </purchasedItems>
    <reward>sample string 7</reward>
    <rewardPriority>sample string 21</rewardPriority>
    <rewardProgramId>22</rewardProgramId>
    <rewardResetDate>2024-11-07T04:34:40.0693327+00:00</rewardResetDate>
    <rewardThreshold>sample string 8</rewardThreshold>
    <rewards>
      <BonusPlanReward>
        <expirationDate xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
          <d5p1:DateTime>2024-11-07T04:34:40.0693327Z</d5p1:DateTime>
          <d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
        </expirationDate>
        <name>sample string 3</name>
        <programId>1</programId>
        <rewardId>2</rewardId>
        <rewardType>5</rewardType>
        <rewardTypeName>sample string 6</rewardTypeName>
      </BonusPlanReward>
      <BonusPlanReward>
        <expirationDate xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
          <d5p1:DateTime>2024-11-07T04:34:40.0693327Z</d5p1:DateTime>
          <d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
        </expirationDate>
        <name>sample string 3</name>
        <programId>1</programId>
        <rewardId>2</rewardId>
        <rewardType>5</rewardType>
        <rewardTypeName>sample string 6</rewardTypeName>
      </BonusPlanReward>
    </rewards>
    <startDate>2024-11-07T04:34:40.0693327+00:00</startDate>
    <status>sample string 3</status>
    <type>sample string 4</type>
  </BonusPlan>
  <BonusPlan>
    <attributes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value>sample string 2</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 3</d3p1:Key>
        <d3p1:Value>sample string 4</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </attributes>
    <availableItems>
      <BonusPlanItem>
        <itemId>1</itemId>
        <name>sample string 2</name>
      </BonusPlanItem>
      <BonusPlanItem>
        <itemId>1</itemId>
        <name>sample string 2</name>
      </BonusPlanItem>
    </availableItems>
    <bonusPlanId>1</bonusPlanId>
    <credit>sample string 9</credit>
    <deferRewardSetting>true</deferRewardSetting>
    <description>sample string 6</description>
    <expireDate>2024-11-07T04:34:40.0693327+00:00</expireDate>
    <lastRewards>
      <BonusPlanLastReward>
        <name>sample string 1</name>
        <threshold>2.1</threshold>
      </BonusPlanLastReward>
      <BonusPlanLastReward>
        <name>sample string 1</name>
        <threshold>2.1</threshold>
      </BonusPlanLastReward>
    </lastRewards>
    <lifetimeRewardCount>10</lifetimeRewardCount>
    <memberExpireDate>2024-11-07T04:34:40.0693327+00:00</memberExpireDate>
    <meritEndDay>2024-11-07T04:34:40.0693327+00:00</meritEndDay>
    <meritStartDay>2024-11-07T04:34:40.0693327+00:00</meritStartDay>
    <metricType>5</metricType>
    <name>sample string 2</name>
    <nextBirthdayReward>sample string 19</nextBirthdayReward>
    <occasionType>15</occasionType>
    <occasionTypeName>sample string 16</occasionTypeName>
    <profileQualification>true</profileQualification>
    <purchasedItems>
      <BonusPlanItem>
        <itemId>1</itemId>
        <name>sample string 2</name>
      </BonusPlanItem>
      <BonusPlanItem>
        <itemId>1</itemId>
        <name>sample string 2</name>
      </BonusPlanItem>
    </purchasedItems>
    <reward>sample string 7</reward>
    <rewardPriority>sample string 21</rewardPriority>
    <rewardProgramId>22</rewardProgramId>
    <rewardResetDate>2024-11-07T04:34:40.0693327+00:00</rewardResetDate>
    <rewardThreshold>sample string 8</rewardThreshold>
    <rewards>
      <BonusPlanReward>
        <expirationDate xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
          <d5p1:DateTime>2024-11-07T04:34:40.0693327Z</d5p1:DateTime>
          <d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
        </expirationDate>
        <name>sample string 3</name>
        <programId>1</programId>
        <rewardId>2</rewardId>
        <rewardType>5</rewardType>
        <rewardTypeName>sample string 6</rewardTypeName>
      </BonusPlanReward>
      <BonusPlanReward>
        <expirationDate xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
          <d5p1:DateTime>2024-11-07T04:34:40.0693327Z</d5p1:DateTime>
          <d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
        </expirationDate>
        <name>sample string 3</name>
        <programId>1</programId>
        <rewardId>2</rewardId>
        <rewardType>5</rewardType>
        <rewardTypeName>sample string 6</rewardTypeName>
      </BonusPlanReward>
    </rewards>
    <startDate>2024-11-07T04:34:40.0693327+00:00</startDate>
    <status>sample string 3</status>
    <type>sample string 4</type>
  </BonusPlan>
</ArrayOfBonusPlan>