PUT api/content/v4/getfilteredcouponsbycategory

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
CustomerId	integer	None.
LanguageId	integer	None.
CategoryId	integer	None.
SectionId	integer	None.
SearchText	string	None.
PageNumber	integer	None.
PageSize	integer	None.
Latitude	decimal number	None.
Longitude	decimal number	None.
GroupCategoryIds	string	None.
GroupSubCategoryIds	string	None.
CategoryType	GroupCategoryEnum	None.

Request Formats

application/json, text/json

Sample:

{
  "CustomerId": 1,
  "LanguageId": 2,
  "CategoryId": 3,
  "SectionId": 4,
  "SearchText": "sample string 5",
  "PageNumber": 6,
  "PageSize": 7,
  "Latitude": 1.0,
  "Longitude": 1.0,
  "GroupCategoryIds": "sample string 8",
  "GroupSubCategoryIds": "sample string 9",
  "CategoryType": 1
}

application/xml, text/xml

Sample:

<FilteredCouponsByCategoryRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/">
  <CategoryId>3</CategoryId>
  <CategoryType>Category</CategoryType>
  <CustomerId>1</CustomerId>
  <GroupCategoryIds>sample string 8</GroupCategoryIds>
  <GroupSubCategoryIds>sample string 9</GroupSubCategoryIds>
  <LanguageId>2</LanguageId>
  <Latitude>1</Latitude>
  <Longitude>1</Longitude>
  <PageNumber>6</PageNumber>
  <PageSize>7</PageSize>
  <SearchText>sample string 5</SearchText>
  <SectionId>4</SectionId>
</FilteredCouponsByCategoryRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

APICommonWrapperOfFilteredCouponResponse

Name	Type	Additional information
Status	HttpStatusCode	None.
Message	string	None.
Data	FilteredCouponResponse	None.

Response Formats

application/json, text/json

Sample:

{
  "Status": 100,
  "Message": "sample string 1",
  "Data": {
    "List": [
      {
        "Id": 1,
        "Title": "sample string 2",
        "Description": "sample string 3",
        "LocationTitle": "sample string 4",
        "City": "sample string 5",
        "State": "sample string 6",
        "ZipCode": "sample string 7",
        "Logo": "sample string 8",
        "LocationId": 1,
        "StartDate": "2026-01-16T04:34:01.1682941+00:00",
        "EndDate": "2026-01-16T04:34:01.1682941+00:00",
        "MemberId": 1,
        "IsFavorite": true,
        "IsRedeemed": true,
        "CustomerId": 11,
        "CouponProgramId": 12,
        "IsDefaultCoupon": true,
        "CouponProgramDescription": "sample string 14",
        "NextCouponRedeemDate": "2026-01-16T04:34:01.1682941+00:00"
      },
      {
        "Id": 1,
        "Title": "sample string 2",
        "Description": "sample string 3",
        "LocationTitle": "sample string 4",
        "City": "sample string 5",
        "State": "sample string 6",
        "ZipCode": "sample string 7",
        "Logo": "sample string 8",
        "LocationId": 1,
        "StartDate": "2026-01-16T04:34:01.1682941+00:00",
        "EndDate": "2026-01-16T04:34:01.1682941+00:00",
        "MemberId": 1,
        "IsFavorite": true,
        "IsRedeemed": true,
        "CustomerId": 11,
        "CouponProgramId": 12,
        "IsDefaultCoupon": true,
        "CouponProgramDescription": "sample string 14",
        "NextCouponRedeemDate": "2026-01-16T04:34:01.1682941+00:00"
      }
    ],
    "TotalRecords": 1
  }
}

application/xml, text/xml

Sample:

<APICommonWrapperOfFilteredCouponResponseMTRdQN6P xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tsunami.Model">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/">
    <d2p1:List>
      <d2p1:APIFilteredCouponListResponse>
        <d2p1:City>sample string 5</d2p1:City>
        <d2p1:CouponProgramDescription>sample string 14</d2p1:CouponProgramDescription>
        <d2p1:CouponProgramId>12</d2p1:CouponProgramId>
        <d2p1:CustomerId>11</d2p1:CustomerId>
        <d2p1:Description>sample string 3</d2p1:Description>
        <d2p1:EndDate>2026-01-16T04:34:01.1682941+00:00</d2p1:EndDate>
        <d2p1:Id>1</d2p1:Id>
        <d2p1:IsDefaultCoupon>true</d2p1:IsDefaultCoupon>
        <d2p1:IsFavorite>true</d2p1:IsFavorite>
        <d2p1:IsRedeemed>true</d2p1:IsRedeemed>
        <d2p1:LocationId>1</d2p1:LocationId>
        <d2p1:LocationTitle>sample string 4</d2p1:LocationTitle>
        <d2p1:Logo>sample string 8</d2p1:Logo>
        <d2p1:MemberId>1</d2p1:MemberId>
        <d2p1:NextCouponRedeemDate>2026-01-16T04:34:01.1682941+00:00</d2p1:NextCouponRedeemDate>
        <d2p1:StartDate>2026-01-16T04:34:01.1682941+00:00</d2p1:StartDate>
        <d2p1:State>sample string 6</d2p1:State>
        <d2p1:Title>sample string 2</d2p1:Title>
        <d2p1:ZipCode>sample string 7</d2p1:ZipCode>
      </d2p1:APIFilteredCouponListResponse>
      <d2p1:APIFilteredCouponListResponse>
        <d2p1:City>sample string 5</d2p1:City>
        <d2p1:CouponProgramDescription>sample string 14</d2p1:CouponProgramDescription>
        <d2p1:CouponProgramId>12</d2p1:CouponProgramId>
        <d2p1:CustomerId>11</d2p1:CustomerId>
        <d2p1:Description>sample string 3</d2p1:Description>
        <d2p1:EndDate>2026-01-16T04:34:01.1682941+00:00</d2p1:EndDate>
        <d2p1:Id>1</d2p1:Id>
        <d2p1:IsDefaultCoupon>true</d2p1:IsDefaultCoupon>
        <d2p1:IsFavorite>true</d2p1:IsFavorite>
        <d2p1:IsRedeemed>true</d2p1:IsRedeemed>
        <d2p1:LocationId>1</d2p1:LocationId>
        <d2p1:LocationTitle>sample string 4</d2p1:LocationTitle>
        <d2p1:Logo>sample string 8</d2p1:Logo>
        <d2p1:MemberId>1</d2p1:MemberId>
        <d2p1:NextCouponRedeemDate>2026-01-16T04:34:01.1682941+00:00</d2p1:NextCouponRedeemDate>
        <d2p1:StartDate>2026-01-16T04:34:01.1682941+00:00</d2p1:StartDate>
        <d2p1:State>sample string 6</d2p1:State>
        <d2p1:Title>sample string 2</d2p1:Title>
        <d2p1:ZipCode>sample string 7</d2p1:ZipCode>
      </d2p1:APIFilteredCouponListResponse>
    </d2p1:List>
    <d2p1:TotalRecords>1</d2p1:TotalRecords>
  </Data>
  <Message>sample string 1</Message>
  <Status>Continue</Status>
</APICommonWrapperOfFilteredCouponResponseMTRdQN6P>