POST api/Contact/GetContactsIdsByContactSummaryFilter

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional 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": "2023-10-01T02:55:37.7799101+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": "2023-10-01T02:55:37.7799101+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.Business.Service.Services.RequestViewModels.Contact">
  <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 xmlns:d2p1="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel">
    <d2p1:ContactFilterConditionVM>
      <d2p1:AnyAllOperator>Any</d2p1:AnyAllOperator>
      <d2p1:ContactAge>2</d2p1:ContactAge>
      <d2p1:ContactBirthDayAgeFilter>GreaterThan</d2p1:ContactBirthDayAgeFilter>
      <d2p1:ContactBirthdayAgeBetween>
        <d2p1:EndAge>2</d2p1:EndAge>
        <d2p1:StartAge>1</d2p1:StartAge>
      </d2p1:ContactBirthdayAgeBetween>
      <d2p1:ContactBirthdayEqualsFilter>Today</d2p1:ContactBirthdayEqualsFilter>
      <d2p1:ContactBirthdayFilter>Equals</d2p1:ContactBirthdayFilter>
      <d2p1:ContactBirthdayIn>3</d2p1:ContactBirthdayIn>
      <d2p1:ContactBirthdayIntervalTypeFilter>Week</d2p1:ContactBirthdayIntervalTypeFilter>
      <d2p1:ContactBirthdayYear>4</d2p1:ContactBirthdayYear>
      <d2p1:ContactDateOfBirth>
        <d2p1:DOB>2023-10-01T02:55:37.7799101+00:00</d2p1:DOB>
        <d2p1:Day>1</d2p1:Day>
        <d2p1:Month>1</d2p1:Month>
        <d2p1:Year>1</d2p1:Year>
      </d2p1:ContactDateOfBirth>
      <d2p1:ContactFilterSelectionType>NA</d2p1:ContactFilterSelectionType>
      <d2p1:ContactRecentDayFilter>Today</d2p1:ContactRecentDayFilter>
      <d2p1:ContactRecentFilter>Created</d2p1:ContactRecentFilter>
      <d2p1:ContactRecentIntervalTypeFilter>Days</d2p1:ContactRecentIntervalTypeFilter>
      <d2p1:FilterByCategory>List</d2p1:FilterByCategory>
      <d2p1:FilterCategoryDetails>
        <d2p1:ContactFilterCategoryConditionViewModel>
          <d2p1:FilterId>sample string 1</d2p1:FilterId>
          <d2p1:FilterName>sample string 2</d2p1:FilterName>
          <d2p1:IsFilterCategoryExclude>true</d2p1:IsFilterCategoryExclude>
        </d2p1:ContactFilterCategoryConditionViewModel>
        <d2p1:ContactFilterCategoryConditionViewModel>
          <d2p1:FilterId>sample string 1</d2p1:FilterId>
          <d2p1:FilterName>sample string 2</d2p1:FilterName>
          <d2p1:IsFilterCategoryExclude>true</d2p1:IsFilterCategoryExclude>
        </d2p1:ContactFilterCategoryConditionViewModel>
      </d2p1:FilterCategoryDetails>
      <d2p1:MobilePageOrCampaignFilterDetail>
        <d2p1:BuilderElementFilterType>NA</d2p1:BuilderElementFilterType>
        <d2p1:ButtonBuilderElementFilterType>None</d2p1:ButtonBuilderElementFilterType>
        <d2p1:CampaignGeneralFilterType>None</d2p1:CampaignGeneralFilterType>
        <d2p1:DownloadBuilderElementFilterType>None</d2p1:DownloadBuilderElementFilterType>
        <d2p1:FilterSelectedBuilderElementId>sample string 3</d2p1:FilterSelectedBuilderElementId>
        <d2p1:FormBuilderElementFilterType>None</d2p1:FormBuilderElementFilterType>
        <d2p1:MobilePageGeneralFilterType>None</d2p1:MobilePageGeneralFilterType>
        <d2p1:MobilePageOrCampaignFilterSelectionType>None</d2p1:MobilePageOrCampaignFilterSelectionType>
        <d2p1:OfferBuilderElementFilterType>None</d2p1:OfferBuilderElementFilterType>
        <d2p1:RecurringCampaignContactFilterType>None</d2p1:RecurringCampaignContactFilterType>
        <d2p1:RecurringCampaignSendSummaryFilterId>sample string 2</d2p1:RecurringCampaignSendSummaryFilterId>
        <d2p1:SelectedMobilePageOrCampaignFilterId>sample string 1</d2p1:SelectedMobilePageOrCampaignFilterId>
      </d2p1:MobilePageOrCampaignFilterDetail>
      <d2p1:RecentIntervalLength>1</d2p1:RecentIntervalLength>
      <d2p1:SourceFilterSelectionType>None</d2p1:SourceFilterSelectionType>
    </d2p1:ContactFilterConditionVM>
    <d2p1:ContactFilterConditionVM>
      <d2p1:AnyAllOperator>Any</d2p1:AnyAllOperator>
      <d2p1:ContactAge>2</d2p1:ContactAge>
      <d2p1:ContactBirthDayAgeFilter>GreaterThan</d2p1:ContactBirthDayAgeFilter>
      <d2p1:ContactBirthdayAgeBetween>
        <d2p1:EndAge>2</d2p1:EndAge>
        <d2p1:StartAge>1</d2p1:StartAge>
      </d2p1:ContactBirthdayAgeBetween>
      <d2p1:ContactBirthdayEqualsFilter>Today</d2p1:ContactBirthdayEqualsFilter>
      <d2p1:ContactBirthdayFilter>Equals</d2p1:ContactBirthdayFilter>
      <d2p1:ContactBirthdayIn>3</d2p1:ContactBirthdayIn>
      <d2p1:ContactBirthdayIntervalTypeFilter>Week</d2p1:ContactBirthdayIntervalTypeFilter>
      <d2p1:ContactBirthdayYear>4</d2p1:ContactBirthdayYear>
      <d2p1:ContactDateOfBirth>
        <d2p1:DOB>2023-10-01T02:55:37.7799101+00:00</d2p1:DOB>
        <d2p1:Day>1</d2p1:Day>
        <d2p1:Month>1</d2p1:Month>
        <d2p1:Year>1</d2p1:Year>
      </d2p1:ContactDateOfBirth>
      <d2p1:ContactFilterSelectionType>NA</d2p1:ContactFilterSelectionType>
      <d2p1:ContactRecentDayFilter>Today</d2p1:ContactRecentDayFilter>
      <d2p1:ContactRecentFilter>Created</d2p1:ContactRecentFilter>
      <d2p1:ContactRecentIntervalTypeFilter>Days</d2p1:ContactRecentIntervalTypeFilter>
      <d2p1:FilterByCategory>List</d2p1:FilterByCategory>
      <d2p1:FilterCategoryDetails>
        <d2p1:ContactFilterCategoryConditionViewModel>
          <d2p1:FilterId>sample string 1</d2p1:FilterId>
          <d2p1:FilterName>sample string 2</d2p1:FilterName>
          <d2p1:IsFilterCategoryExclude>true</d2p1:IsFilterCategoryExclude>
        </d2p1:ContactFilterCategoryConditionViewModel>
        <d2p1:ContactFilterCategoryConditionViewModel>
          <d2p1:FilterId>sample string 1</d2p1:FilterId>
          <d2p1:FilterName>sample string 2</d2p1:FilterName>
          <d2p1:IsFilterCategoryExclude>true</d2p1:IsFilterCategoryExclude>
        </d2p1:ContactFilterCategoryConditionViewModel>
      </d2p1:FilterCategoryDetails>
      <d2p1:MobilePageOrCampaignFilterDetail>
        <d2p1:BuilderElementFilterType>NA</d2p1:BuilderElementFilterType>
        <d2p1:ButtonBuilderElementFilterType>None</d2p1:ButtonBuilderElementFilterType>
        <d2p1:CampaignGeneralFilterType>None</d2p1:CampaignGeneralFilterType>
        <d2p1:DownloadBuilderElementFilterType>None</d2p1:DownloadBuilderElementFilterType>
        <d2p1:FilterSelectedBuilderElementId>sample string 3</d2p1:FilterSelectedBuilderElementId>
        <d2p1:FormBuilderElementFilterType>None</d2p1:FormBuilderElementFilterType>
        <d2p1:MobilePageGeneralFilterType>None</d2p1:MobilePageGeneralFilterType>
        <d2p1:MobilePageOrCampaignFilterSelectionType>None</d2p1:MobilePageOrCampaignFilterSelectionType>
        <d2p1:OfferBuilderElementFilterType>None</d2p1:OfferBuilderElementFilterType>
        <d2p1:RecurringCampaignContactFilterType>None</d2p1:RecurringCampaignContactFilterType>
        <d2p1:RecurringCampaignSendSummaryFilterId>sample string 2</d2p1:RecurringCampaignSendSummaryFilterId>
        <d2p1:SelectedMobilePageOrCampaignFilterId>sample string 1</d2p1:SelectedMobilePageOrCampaignFilterId>
      </d2p1:MobilePageOrCampaignFilterDetail>
      <d2p1:RecentIntervalLength>1</d2p1:RecentIntervalLength>
      <d2p1:SourceFilterSelectionType>None</d2p1:SourceFilterSelectionType>
    </d2p1: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.