POST api/Contact/GetContactsBySmartListCondition

Request Information

URI Parameters

None.

Body Parameters

ContactSummaryBySmartListConditions
NameDescriptionTypeAdditional information
SmartListConditions

Collection of SmartListConditionsVM

None.

UserId

string

None.

AccountId

string

None.

AnyAllOperator

AnyAllOperator

None.

SortingDirection

SortingDirection

None.

PageNumber

integer

None.

PageSize

integer

None.

SearchValue

string

None.

Request Formats

application/json, text/json

Sample:
{
  "SmartListConditions": [
    {
      "FilterByCategory": "List",
      "AnyAllOperator": "Any",
      "ContactFilterSelectionType": "NA",
      "FilterCategoryDetails": [
        {
          "FilterId": "sample string 1",
          "FilterName": "sample string 2",
          "IsFilterCategoryExclude": true
        },
        {
          "FilterId": "sample string 1",
          "FilterName": "sample string 2",
          "IsFilterCategoryExclude": true
        }
      ],
      "ContactRecentFilter": "Created",
      "ContactRecentDayFilter": "Today",
      "ContactRecentIntervalTypeFilter": "Days",
      "RecentIntervalLength": 1,
      "ContactBirthdayFilter": "Equals",
      "ContactBirthdayEqualsFilter": "Today",
      "ContactBirthdayIntervalTypeFilter": "Week",
      "ContactAge": 2,
      "ContactBirthdayIn": 3,
      "ContactBirthdayYear": 4,
      "ContactDateOfBirth": {
        "DOB": "2022-11-27T08:09:54.576247+00:00",
        "Day": 1,
        "Month": 1,
        "Year": 1
      },
      "SourceFilterSelectionType": "None",
      "MobilePageOrCampaignFilterDetail": {
        "SelectedMobilePageOrCampaignFilterId": "sample string 1",
        "MobilePageOrCampaignFilterSelectionType": "None",
        "RecurringCampaignSendSummaryFilterId": "sample string 2",
        "RecurringCampaignContactFilterType": "None",
        "CampaignGeneralFilterType": "None",
        "FilterSelectedBuilderElementId": "sample string 3",
        "MobilePageGeneralFilterType": "None",
        "BuilderElementFilterType": "NA",
        "OfferBuilderElementFilterType": "None",
        "ButtonBuilderElementFilterType": "None",
        "DownloadBuilderElementFilterType": "None",
        "FormBuilderElementFilterType": "None"
      },
      "ContactBirthDayAgeFilter": "GreaterThan",
      "ContactBirthdayAgeBetween": {
        "StartAge": 1,
        "EndAge": 2
      }
    },
    {
      "FilterByCategory": "List",
      "AnyAllOperator": "Any",
      "ContactFilterSelectionType": "NA",
      "FilterCategoryDetails": [
        {
          "FilterId": "sample string 1",
          "FilterName": "sample string 2",
          "IsFilterCategoryExclude": true
        },
        {
          "FilterId": "sample string 1",
          "FilterName": "sample string 2",
          "IsFilterCategoryExclude": true
        }
      ],
      "ContactRecentFilter": "Created",
      "ContactRecentDayFilter": "Today",
      "ContactRecentIntervalTypeFilter": "Days",
      "RecentIntervalLength": 1,
      "ContactBirthdayFilter": "Equals",
      "ContactBirthdayEqualsFilter": "Today",
      "ContactBirthdayIntervalTypeFilter": "Week",
      "ContactAge": 2,
      "ContactBirthdayIn": 3,
      "ContactBirthdayYear": 4,
      "ContactDateOfBirth": {
        "DOB": "2022-11-27T08:09:54.576247+00:00",
        "Day": 1,
        "Month": 1,
        "Year": 1
      },
      "SourceFilterSelectionType": "None",
      "MobilePageOrCampaignFilterDetail": {
        "SelectedMobilePageOrCampaignFilterId": "sample string 1",
        "MobilePageOrCampaignFilterSelectionType": "None",
        "RecurringCampaignSendSummaryFilterId": "sample string 2",
        "RecurringCampaignContactFilterType": "None",
        "CampaignGeneralFilterType": "None",
        "FilterSelectedBuilderElementId": "sample string 3",
        "MobilePageGeneralFilterType": "None",
        "BuilderElementFilterType": "NA",
        "OfferBuilderElementFilterType": "None",
        "ButtonBuilderElementFilterType": "None",
        "DownloadBuilderElementFilterType": "None",
        "FormBuilderElementFilterType": "None"
      },
      "ContactBirthDayAgeFilter": "GreaterThan",
      "ContactBirthdayAgeBetween": {
        "StartAge": 1,
        "EndAge": 2
      }
    }
  ],
  "UserId": "sample string 1",
  "AccountId": "sample string 2",
  "AnyAllOperator": "Any",
  "SortingDirection": "Ascending",
  "PageNumber": 3,
  "PageSize": 4,
  "SearchValue": "sample string 5"
}

application/xml, text/xml

Sample:
<ContactSummaryBySmartListConditions xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MindMe.Business.Service.Services.RequestViewModels.ListRequestModels">
  <AccountId>sample string 2</AccountId>
  <AnyAllOperator>Any</AnyAllOperator>
  <PageNumber>3</PageNumber>
  <PageSize>4</PageSize>
  <SearchValue>sample string 5</SearchValue>
  <SmartListConditions xmlns:d2p1="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel.ListViewModels">
    <d2p1:SmartListConditionsVM>
      <AnyAllOperator xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel">Any</AnyAllOperator>
      <ContactAge xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel">2</ContactAge>
      <ContactBirthDayAgeFilter xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel">GreaterThan</ContactBirthDayAgeFilter>
      <ContactBirthdayAgeBetween xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel">
        <EndAge>2</EndAge>
        <StartAge>1</StartAge>
      </ContactBirthdayAgeBetween>
      <ContactBirthdayEqualsFilter xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel">Today</ContactBirthdayEqualsFilter>
      <ContactBirthdayFilter xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel">Equals</ContactBirthdayFilter>
      <ContactBirthdayIn xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel">3</ContactBirthdayIn>
      <ContactBirthdayIntervalTypeFilter xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel">Week</ContactBirthdayIntervalTypeFilter>
      <ContactBirthdayYear xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel">4</ContactBirthdayYear>
      <ContactDateOfBirth xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel">
        <DOB>2022-11-27T08:09:54.576247+00:00</DOB>
        <Day>1</Day>
        <Month>1</Month>
        <Year>1</Year>
      </ContactDateOfBirth>
      <ContactFilterSelectionType xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel">NA</ContactFilterSelectionType>
      <ContactRecentDayFilter xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel">Today</ContactRecentDayFilter>
      <ContactRecentFilter xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel">Created</ContactRecentFilter>
      <ContactRecentIntervalTypeFilter xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel">Days</ContactRecentIntervalTypeFilter>
      <FilterByCategory xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel">List</FilterByCategory>
      <FilterCategoryDetails xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel">
        <ContactFilterCategoryConditionViewModel>
          <FilterId>sample string 1</FilterId>
          <FilterName>sample string 2</FilterName>
          <IsFilterCategoryExclude>true</IsFilterCategoryExclude>
        </ContactFilterCategoryConditionViewModel>
        <ContactFilterCategoryConditionViewModel>
          <FilterId>sample string 1</FilterId>
          <FilterName>sample string 2</FilterName>
          <IsFilterCategoryExclude>true</IsFilterCategoryExclude>
        </ContactFilterCategoryConditionViewModel>
      </FilterCategoryDetails>
      <MobilePageOrCampaignFilterDetail xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel">
        <BuilderElementFilterType>NA</BuilderElementFilterType>
        <ButtonBuilderElementFilterType>None</ButtonBuilderElementFilterType>
        <CampaignGeneralFilterType>None</CampaignGeneralFilterType>
        <DownloadBuilderElementFilterType>None</DownloadBuilderElementFilterType>
        <FilterSelectedBuilderElementId>sample string 3</FilterSelectedBuilderElementId>
        <FormBuilderElementFilterType>None</FormBuilderElementFilterType>
        <MobilePageGeneralFilterType>None</MobilePageGeneralFilterType>
        <MobilePageOrCampaignFilterSelectionType>None</MobilePageOrCampaignFilterSelectionType>
        <OfferBuilderElementFilterType>None</OfferBuilderElementFilterType>
        <RecurringCampaignContactFilterType>None</RecurringCampaignContactFilterType>
        <RecurringCampaignSendSummaryFilterId>sample string 2</RecurringCampaignSendSummaryFilterId>
        <SelectedMobilePageOrCampaignFilterId>sample string 1</SelectedMobilePageOrCampaignFilterId>
      </MobilePageOrCampaignFilterDetail>
      <RecentIntervalLength xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel">1</RecentIntervalLength>
      <SourceFilterSelectionType xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel">None</SourceFilterSelectionType>
    </d2p1:SmartListConditionsVM>
    <d2p1:SmartListConditionsVM>
      <AnyAllOperator xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel">Any</AnyAllOperator>
      <ContactAge xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel">2</ContactAge>
      <ContactBirthDayAgeFilter xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel">GreaterThan</ContactBirthDayAgeFilter>
      <ContactBirthdayAgeBetween xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel">
        <EndAge>2</EndAge>
        <StartAge>1</StartAge>
      </ContactBirthdayAgeBetween>
      <ContactBirthdayEqualsFilter xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel">Today</ContactBirthdayEqualsFilter>
      <ContactBirthdayFilter xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel">Equals</ContactBirthdayFilter>
      <ContactBirthdayIn xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel">3</ContactBirthdayIn>
      <ContactBirthdayIntervalTypeFilter xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel">Week</ContactBirthdayIntervalTypeFilter>
      <ContactBirthdayYear xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel">4</ContactBirthdayYear>
      <ContactDateOfBirth xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel">
        <DOB>2022-11-27T08:09:54.576247+00:00</DOB>
        <Day>1</Day>
        <Month>1</Month>
        <Year>1</Year>
      </ContactDateOfBirth>
      <ContactFilterSelectionType xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel">NA</ContactFilterSelectionType>
      <ContactRecentDayFilter xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel">Today</ContactRecentDayFilter>
      <ContactRecentFilter xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel">Created</ContactRecentFilter>
      <ContactRecentIntervalTypeFilter xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel">Days</ContactRecentIntervalTypeFilter>
      <FilterByCategory xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel">List</FilterByCategory>
      <FilterCategoryDetails xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel">
        <ContactFilterCategoryConditionViewModel>
          <FilterId>sample string 1</FilterId>
          <FilterName>sample string 2</FilterName>
          <IsFilterCategoryExclude>true</IsFilterCategoryExclude>
        </ContactFilterCategoryConditionViewModel>
        <ContactFilterCategoryConditionViewModel>
          <FilterId>sample string 1</FilterId>
          <FilterName>sample string 2</FilterName>
          <IsFilterCategoryExclude>true</IsFilterCategoryExclude>
        </ContactFilterCategoryConditionViewModel>
      </FilterCategoryDetails>
      <MobilePageOrCampaignFilterDetail xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel">
        <BuilderElementFilterType>NA</BuilderElementFilterType>
        <ButtonBuilderElementFilterType>None</ButtonBuilderElementFilterType>
        <CampaignGeneralFilterType>None</CampaignGeneralFilterType>
        <DownloadBuilderElementFilterType>None</DownloadBuilderElementFilterType>
        <FilterSelectedBuilderElementId>sample string 3</FilterSelectedBuilderElementId>
        <FormBuilderElementFilterType>None</FormBuilderElementFilterType>
        <MobilePageGeneralFilterType>None</MobilePageGeneralFilterType>
        <MobilePageOrCampaignFilterSelectionType>None</MobilePageOrCampaignFilterSelectionType>
        <OfferBuilderElementFilterType>None</OfferBuilderElementFilterType>
        <RecurringCampaignContactFilterType>None</RecurringCampaignContactFilterType>
        <RecurringCampaignSendSummaryFilterId>sample string 2</RecurringCampaignSendSummaryFilterId>
        <SelectedMobilePageOrCampaignFilterId>sample string 1</SelectedMobilePageOrCampaignFilterId>
      </MobilePageOrCampaignFilterDetail>
      <RecentIntervalLength xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel">1</RecentIntervalLength>
      <SourceFilterSelectionType xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel">None</SourceFilterSelectionType>
    </d2p1:SmartListConditionsVM>
  </SmartListConditions>
  <SortingDirection>Ascending</SortingDirection>
  <UserId>sample string 1</UserId>
</ContactSummaryBySmartListConditions>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.