POST api/Contact/GetContactSummaryWithFilter

Request Information

URI Parameters

None.

Body Parameters

ContactSummaryWithFilterViewModel
NameDescriptionTypeAdditional information
ContactFilters

Collection of ContactFilterConditionVM

None.

GlobalConditionOperator

AnyAllOperator

None.

SubAccountId

string

None.

UserId

string

None.

ContactId

string

None.

ViewContactRoleAccessLevel

RolePermissionAccessLevel

None.

PageSize

integer

None.

SearchValue

string

None.

SortingDirection

SortingDirection

None.

SortBy

string

None.

PageNumber

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "ContactFilters": [
    {
      "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-12-02T23:33:33.44133+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-12-02T23:33:33.44133+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
      }
    }
  ],
  "GlobalConditionOperator": "Any",
  "SubAccountId": "sample string 1",
  "UserId": "sample string 2",
  "ContactId": "sample string 3",
  "ViewContactRoleAccessLevel": "None",
  "PageSize": 4,
  "SearchValue": "sample string 5",
  "SortingDirection": "Ascending",
  "SortBy": "sample string 6",
  "PageNumber": 7
}

application/xml, text/xml

Sample:
<ContactSummaryWithFilterViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel">
  <PageNumber xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel.Common">7</PageNumber>
  <PageSize xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel.Common">4</PageSize>
  <SearchValue xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel.Common">sample string 5</SearchValue>
  <SortBy xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel.Common">sample string 6</SortBy>
  <SortingDirection xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel.Common">Ascending</SortingDirection>
  <ContactFilters>
    <ContactFilterConditionVM>
      <AnyAllOperator>Any</AnyAllOperator>
      <ContactAge>2</ContactAge>
      <ContactBirthDayAgeFilter>GreaterThan</ContactBirthDayAgeFilter>
      <ContactBirthdayAgeBetween>
        <EndAge>2</EndAge>
        <StartAge>1</StartAge>
      </ContactBirthdayAgeBetween>
      <ContactBirthdayEqualsFilter>Today</ContactBirthdayEqualsFilter>
      <ContactBirthdayFilter>Equals</ContactBirthdayFilter>
      <ContactBirthdayIn>3</ContactBirthdayIn>
      <ContactBirthdayIntervalTypeFilter>Week</ContactBirthdayIntervalTypeFilter>
      <ContactBirthdayYear>4</ContactBirthdayYear>
      <ContactDateOfBirth>
        <DOB>2022-12-02T23:33:33.44133+00:00</DOB>
        <Day>1</Day>
        <Month>1</Month>
        <Year>1</Year>
      </ContactDateOfBirth>
      <ContactFilterSelectionType>NA</ContactFilterSelectionType>
      <ContactRecentDayFilter>Today</ContactRecentDayFilter>
      <ContactRecentFilter>Created</ContactRecentFilter>
      <ContactRecentIntervalTypeFilter>Days</ContactRecentIntervalTypeFilter>
      <FilterByCategory>List</FilterByCategory>
      <FilterCategoryDetails>
        <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>
        <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>1</RecentIntervalLength>
      <SourceFilterSelectionType>None</SourceFilterSelectionType>
    </ContactFilterConditionVM>
    <ContactFilterConditionVM>
      <AnyAllOperator>Any</AnyAllOperator>
      <ContactAge>2</ContactAge>
      <ContactBirthDayAgeFilter>GreaterThan</ContactBirthDayAgeFilter>
      <ContactBirthdayAgeBetween>
        <EndAge>2</EndAge>
        <StartAge>1</StartAge>
      </ContactBirthdayAgeBetween>
      <ContactBirthdayEqualsFilter>Today</ContactBirthdayEqualsFilter>
      <ContactBirthdayFilter>Equals</ContactBirthdayFilter>
      <ContactBirthdayIn>3</ContactBirthdayIn>
      <ContactBirthdayIntervalTypeFilter>Week</ContactBirthdayIntervalTypeFilter>
      <ContactBirthdayYear>4</ContactBirthdayYear>
      <ContactDateOfBirth>
        <DOB>2022-12-02T23:33:33.44133+00:00</DOB>
        <Day>1</Day>
        <Month>1</Month>
        <Year>1</Year>
      </ContactDateOfBirth>
      <ContactFilterSelectionType>NA</ContactFilterSelectionType>
      <ContactRecentDayFilter>Today</ContactRecentDayFilter>
      <ContactRecentFilter>Created</ContactRecentFilter>
      <ContactRecentIntervalTypeFilter>Days</ContactRecentIntervalTypeFilter>
      <FilterByCategory>List</FilterByCategory>
      <FilterCategoryDetails>
        <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>
        <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>1</RecentIntervalLength>
      <SourceFilterSelectionType>None</SourceFilterSelectionType>
    </ContactFilterConditionVM>
  </ContactFilters>
  <ContactId>sample string 3</ContactId>
  <GlobalConditionOperator>Any</GlobalConditionOperator>
  <SubAccountId>sample string 1</SubAccountId>
  <UserId>sample string 2</UserId>
  <ViewContactRoleAccessLevel>None</ViewContactRoleAccessLevel>
</ContactSummaryWithFilterViewModel>

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.