PUT api/Content/v2/GetLoyaltyRewardList

Request Information

URI Parameters

None.

Body Parameters

APILoyaltyRewardRequest
NameDescriptionTypeAdditional information
SortBy

string

None.

SortDir

string

None.

PageNumber

integer

None.

CustomerId

integer

None.

SearchText

string

None.

UniqueId

globally unique identifier

None.

UserUniqueId

integer

None.

ProgramType

integer

None.

ProgramId

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "SortBy": "sample string 1",
  "SortDir": "sample string 2",
  "PageNumber": 3,
  "CustomerId": 4,
  "SearchText": "sample string 5",
  "UniqueId": "9e06e73f-37d6-42d8-b587-b979c6ad9ae2",
  "UserUniqueId": 7,
  "ProgramType": 8,
  "ProgramId": 9
}

application/xml, text/xml

Sample:
<APILoyaltyRewardRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tsunami.Model">
  <CustomerId>4</CustomerId>
  <PageNumber>3</PageNumber>
  <ProgramId>9</ProgramId>
  <ProgramType>8</ProgramType>
  <SearchText>sample string 5</SearchText>
  <SortBy>sample string 1</SortBy>
  <SortDir>sample string 2</SortDir>
  <UniqueId>9e06e73f-37d6-42d8-b587-b979c6ad9ae2</UniqueId>
  <UserUniqueId>7</UserUniqueId>
</APILoyaltyRewardRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

APILoyaltyRewardResponse
NameDescriptionTypeAdditional information
List

Collection of APILoyaltyRewards

None.

TotalRecords

integer

None.

ClaimRewardTitle

string

None.

Response Formats

application/json, text/json

Sample:
{
  "List": [
    {
      "Id": 1,
      "Title": "sample string 2",
      "Description": "sample string 3",
      "Image": [
        "sample string 1",
        "sample string 2"
      ],
      "CreatedDate": 4,
      "PointRequire": 1,
      "SizeList": [
        {
          "Disabled": true,
          "Group": {
            "Disabled": true,
            "Name": "sample string 2"
          },
          "Selected": true,
          "Text": "sample string 3",
          "Value": "sample string 4"
        },
        {
          "Disabled": true,
          "Group": {
            "Disabled": true,
            "Name": "sample string 2"
          },
          "Selected": true,
          "Text": "sample string 3",
          "Value": "sample string 4"
        }
      ],
      "Sizes": "sample string 5",
      "Redeemed": true,
      "IsBadge": true,
      "ProgramTitle": "sample string 8",
      "TotalStampRequired": 9,
      "TotalStamp": 10,
      "AllowRedeem": true,
      "PinRequire": true,
      "Type": "sample string 13",
      "AnniversaryYear": 14,
      "ProgramId": 15,
      "ProgramName": "sample string 16"
    },
    {
      "Id": 1,
      "Title": "sample string 2",
      "Description": "sample string 3",
      "Image": [
        "sample string 1",
        "sample string 2"
      ],
      "CreatedDate": 4,
      "PointRequire": 1,
      "SizeList": [
        {
          "Disabled": true,
          "Group": {
            "Disabled": true,
            "Name": "sample string 2"
          },
          "Selected": true,
          "Text": "sample string 3",
          "Value": "sample string 4"
        },
        {
          "Disabled": true,
          "Group": {
            "Disabled": true,
            "Name": "sample string 2"
          },
          "Selected": true,
          "Text": "sample string 3",
          "Value": "sample string 4"
        }
      ],
      "Sizes": "sample string 5",
      "Redeemed": true,
      "IsBadge": true,
      "ProgramTitle": "sample string 8",
      "TotalStampRequired": 9,
      "TotalStamp": 10,
      "AllowRedeem": true,
      "PinRequire": true,
      "Type": "sample string 13",
      "AnniversaryYear": 14,
      "ProgramId": 15,
      "ProgramName": "sample string 16"
    }
  ],
  "TotalRecords": 1,
  "ClaimRewardTitle": "sample string 2"
}

application/xml, text/xml

Sample:
<APILoyaltyRewardResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tsunami.Model">
  <ClaimRewardTitle>sample string 2</ClaimRewardTitle>
  <List>
    <APILoyaltyRewards>
      <AllowRedeem>true</AllowRedeem>
      <AnniversaryYear>14</AnniversaryYear>
      <CreatedDate>4</CreatedDate>
      <Description>sample string 3</Description>
      <Id>1</Id>
      <Image xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </Image>
      <IsBadge>true</IsBadge>
      <PinRequire>true</PinRequire>
      <PointRequire>1</PointRequire>
      <ProgramId>15</ProgramId>
      <ProgramName>sample string 16</ProgramName>
      <ProgramTitle>sample string 8</ProgramTitle>
      <Redeemed>true</Redeemed>
      <SizeList xmlns:d4p1="http://schemas.datacontract.org/2004/07/System.Web.Mvc">
        <d4p1:SelectListItem>
          <d4p1:Disabled>true</d4p1:Disabled>
          <d4p1:Group>
            <d4p1:Disabled>true</d4p1:Disabled>
            <d4p1:Name>sample string 2</d4p1:Name>
          </d4p1:Group>
          <d4p1:Selected>true</d4p1:Selected>
          <d4p1:Text>sample string 3</d4p1:Text>
          <d4p1:Value>sample string 4</d4p1:Value>
        </d4p1:SelectListItem>
        <d4p1:SelectListItem>
          <d4p1:Disabled>true</d4p1:Disabled>
          <d4p1:Group>
            <d4p1:Disabled>true</d4p1:Disabled>
            <d4p1:Name>sample string 2</d4p1:Name>
          </d4p1:Group>
          <d4p1:Selected>true</d4p1:Selected>
          <d4p1:Text>sample string 3</d4p1:Text>
          <d4p1:Value>sample string 4</d4p1:Value>
        </d4p1:SelectListItem>
      </SizeList>
      <Sizes>sample string 5</Sizes>
      <Title>sample string 2</Title>
      <TotalStamp>10</TotalStamp>
      <TotalStampRequired>9</TotalStampRequired>
      <Type>sample string 13</Type>
    </APILoyaltyRewards>
    <APILoyaltyRewards>
      <AllowRedeem>true</AllowRedeem>
      <AnniversaryYear>14</AnniversaryYear>
      <CreatedDate>4</CreatedDate>
      <Description>sample string 3</Description>
      <Id>1</Id>
      <Image xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </Image>
      <IsBadge>true</IsBadge>
      <PinRequire>true</PinRequire>
      <PointRequire>1</PointRequire>
      <ProgramId>15</ProgramId>
      <ProgramName>sample string 16</ProgramName>
      <ProgramTitle>sample string 8</ProgramTitle>
      <Redeemed>true</Redeemed>
      <SizeList xmlns:d4p1="http://schemas.datacontract.org/2004/07/System.Web.Mvc">
        <d4p1:SelectListItem>
          <d4p1:Disabled>true</d4p1:Disabled>
          <d4p1:Group>
            <d4p1:Disabled>true</d4p1:Disabled>
            <d4p1:Name>sample string 2</d4p1:Name>
          </d4p1:Group>
          <d4p1:Selected>true</d4p1:Selected>
          <d4p1:Text>sample string 3</d4p1:Text>
          <d4p1:Value>sample string 4</d4p1:Value>
        </d4p1:SelectListItem>
        <d4p1:SelectListItem>
          <d4p1:Disabled>true</d4p1:Disabled>
          <d4p1:Group>
            <d4p1:Disabled>true</d4p1:Disabled>
            <d4p1:Name>sample string 2</d4p1:Name>
          </d4p1:Group>
          <d4p1:Selected>true</d4p1:Selected>
          <d4p1:Text>sample string 3</d4p1:Text>
          <d4p1:Value>sample string 4</d4p1:Value>
        </d4p1:SelectListItem>
      </SizeList>
      <Sizes>sample string 5</Sizes>
      <Title>sample string 2</Title>
      <TotalStamp>10</TotalStamp>
      <TotalStampRequired>9</TotalStampRequired>
      <Type>sample string 13</Type>
    </APILoyaltyRewards>
  </List>
  <TotalRecords>1</TotalRecords>
</APILoyaltyRewardResponse>