PUT api/Content/v2/GetLoyaltyRewardList

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
CustomerId	integer	None.
UniqueId	globally unique identifier	None.
UserUniqueId	integer	None.
ProgramType	integer	None.
ProgramId	integer	None.
SectionId	integer	None.
PageNumber	integer	None.
PageSize	integer	None.
LanguageId	integer	None.
SearchText	string	None.
SortBy	string	None.
SortDir	string	None.

Request Formats

application/json, text/json

Sample:

{
  "CustomerId": 1,
  "UniqueId": "dfdecec6-3efa-49bc-93c0-ca4376bc6794",
  "UserUniqueId": 3,
  "ProgramType": 4,
  "ProgramId": 5,
  "SectionId": 6,
  "PageNumber": 7,
  "PageSize": 8,
  "LanguageId": 9,
  "SearchText": "sample string 10",
  "SortBy": "sample string 11",
  "SortDir": "sample string 12"
}

application/xml, text/xml

Sample:

<APILoyaltyRewardRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tsunami.Model">
  <LanguageId>9</LanguageId>
  <PageNumber>7</PageNumber>
  <PageSize>8</PageSize>
  <SearchText>sample string 10</SearchText>
  <SortBy>sample string 11</SortBy>
  <SortDir>sample string 12</SortDir>
  <CustomerId>1</CustomerId>
  <ProgramId>5</ProgramId>
  <ProgramType>4</ProgramType>
  <SectionId>6</SectionId>
  <UniqueId>dfdecec6-3efa-49bc-93c0-ca4376bc6794</UniqueId>
  <UserUniqueId>3</UserUniqueId>
</APILoyaltyRewardRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

APILoyaltyRewardResponse

Name	Type	Additional 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 12",
      "AnniversaryYear": 13,
      "ProgramId": 14,
      "ProgramName": "sample string 15",
      "FromDate": "2026-01-16T04:32:13.2042608+00:00",
      "ToDate": "2026-01-16T04:32:13.2042608+00:00",
      "IsActiveProgram": true,
      "PickupInstructions": "sample string 17",
      "IsPickUpAvailable": true,
      "IsShippingCharge": true,
      "ShippingCost": 1.0,
      "MainImage": "sample string 18",
      "ColorList": [
        {
          "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"
        }
      ]
    },
    {
      "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 12",
      "AnniversaryYear": 13,
      "ProgramId": 14,
      "ProgramName": "sample string 15",
      "FromDate": "2026-01-16T04:32:13.2042608+00:00",
      "ToDate": "2026-01-16T04:32:13.2042608+00:00",
      "IsActiveProgram": true,
      "PickupInstructions": "sample string 17",
      "IsPickUpAvailable": true,
      "IsShippingCharge": true,
      "ShippingCost": 1.0,
      "MainImage": "sample string 18",
      "ColorList": [
        {
          "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"
        }
      ]
    }
  ],
  "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>13</AnniversaryYear>
      <ColorList 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>
      </ColorList>
      <CreatedDate>4</CreatedDate>
      <Description>sample string 3</Description>
      <FromDate>2026-01-16T04:32:13.2042608+00:00</FromDate>
      <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>
      <IsActiveProgram>true</IsActiveProgram>
      <IsBadge>true</IsBadge>
      <IsPickUpAvailable>true</IsPickUpAvailable>
      <IsShippingCharge>true</IsShippingCharge>
      <MainImage>sample string 18</MainImage>
      <PickupInstructions>sample string 17</PickupInstructions>
      <PinRequire>true</PinRequire>
      <PointRequire>1</PointRequire>
      <ProgramId>14</ProgramId>
      <ProgramName>sample string 15</ProgramName>
      <ProgramTitle>sample string 8</ProgramTitle>
      <Redeemed>true</Redeemed>
      <ShippingCost>1</ShippingCost>
      <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>
      <ToDate>2026-01-16T04:32:13.2042608+00:00</ToDate>
      <TotalStamp>10</TotalStamp>
      <TotalStampRequired>9</TotalStampRequired>
      <Type>sample string 12</Type>
    </APILoyaltyRewards>
    <APILoyaltyRewards>
      <AllowRedeem>true</AllowRedeem>
      <AnniversaryYear>13</AnniversaryYear>
      <ColorList 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>
      </ColorList>
      <CreatedDate>4</CreatedDate>
      <Description>sample string 3</Description>
      <FromDate>2026-01-16T04:32:13.2042608+00:00</FromDate>
      <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>
      <IsActiveProgram>true</IsActiveProgram>
      <IsBadge>true</IsBadge>
      <IsPickUpAvailable>true</IsPickUpAvailable>
      <IsShippingCharge>true</IsShippingCharge>
      <MainImage>sample string 18</MainImage>
      <PickupInstructions>sample string 17</PickupInstructions>
      <PinRequire>true</PinRequire>
      <PointRequire>1</PointRequire>
      <ProgramId>14</ProgramId>
      <ProgramName>sample string 15</ProgramName>
      <ProgramTitle>sample string 8</ProgramTitle>
      <Redeemed>true</Redeemed>
      <ShippingCost>1</ShippingCost>
      <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>
      <ToDate>2026-01-16T04:32:13.2042608+00:00</ToDate>
      <TotalStamp>10</TotalStamp>
      <TotalStampRequired>9</TotalStampRequired>
      <Type>sample string 12</Type>
    </APILoyaltyRewards>
  </List>
  <TotalRecords>1</TotalRecords>
</APILoyaltyRewardResponse>