POST api/Campaign/GetFilteredContactsByCampaignConditions?accountId={accountId}&sortingDirection={sortingDirection}&pageNumber={pageNumber}&pageSize={pageSize}&searchValue={searchValue}&sortColumnName={sortColumnName}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
accountId

string

Required

sortingDirection

SortingDirection

Required

pageNumber

integer

Default value is 1

pageSize

integer

Default value is 10

searchValue

string

None.

sortColumnName

string

Default value is

Body Parameters

CampaignContactsWithCategoryConditionsViewModel
NameDescriptionTypeAdditional information
Conditions

Collection of CampaignContactsFilterConditionsViewModel

None.

GlobalAnyAllOperator

AnyAllOperator

None.

DateFilter

ContactDateFieldFilter

None.

SendToAllContacts

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "Conditions": [
    {
      "FilterCampaignContactBy": "NA",
      "IsAllCategoriesSelected": true,
      "ChooseCampaignContactFrom": "MyContacts",
      "AnyAllOperator": "Any",
      "Lists": [
        {
          "Id": "sample string 1",
          "IsCategoryContactExclude": true,
          "FilterCampaignContactBy": "List"
        },
        {
          "Id": "sample string 1",
          "IsCategoryContactExclude": true,
          "FilterCampaignContactBy": "List"
        }
      ],
      "SmartLists": [
        {
          "Id": "sample string 1",
          "IsCategoryContactExclude": true,
          "FilterCampaignContactBy": "List"
        },
        {
          "Id": "sample string 1",
          "IsCategoryContactExclude": true,
          "FilterCampaignContactBy": "List"
        }
      ],
      "Keywords": [
        {
          "Id": "sample string 1",
          "IsCategoryContactExclude": true,
          "FilterCampaignContactBy": "List"
        },
        {
          "Id": "sample string 1",
          "IsCategoryContactExclude": true,
          "FilterCampaignContactBy": "List"
        }
      ],
      "WebForms": [
        {
          "Id": "sample string 1",
          "IsCategoryContactExclude": true,
          "FilterCampaignContactBy": "List"
        },
        {
          "Id": "sample string 1",
          "IsCategoryContactExclude": true,
          "FilterCampaignContactBy": "List"
        }
      ],
      "MobilePages": [
        {
          "Id": "sample string 1",
          "IsCategoryContactExclude": true,
          "FilterCampaignContactBy": "List"
        },
        {
          "Id": "sample string 1",
          "IsCategoryContactExclude": true,
          "FilterCampaignContactBy": "List"
        }
      ],
      "Interests": [
        {
          "Id": "sample string 1",
          "IsCategoryContactExclude": true,
          "FilterCampaignContactBy": "List"
        },
        {
          "Id": "sample string 1",
          "IsCategoryContactExclude": true,
          "FilterCampaignContactBy": "List"
        }
      ],
      "Tags": [
        {
          "Id": "sample string 1",
          "IsCategoryContactExclude": true,
          "FilterCampaignContactBy": "List"
        },
        {
          "Id": "sample string 1",
          "IsCategoryContactExclude": true,
          "FilterCampaignContactBy": "List"
        }
      ],
      "Types": [
        {
          "Id": "sample string 1",
          "IsCategoryContactExclude": true,
          "FilterCampaignContactBy": "List"
        },
        {
          "Id": "sample string 1",
          "IsCategoryContactExclude": true,
          "FilterCampaignContactBy": "List"
        }
      ],
      "ContactIds": [
        "sample string 1",
        "sample string 2"
      ],
      "CampaignCreatedFromModule": "Campaign"
    },
    {
      "FilterCampaignContactBy": "NA",
      "IsAllCategoriesSelected": true,
      "ChooseCampaignContactFrom": "MyContacts",
      "AnyAllOperator": "Any",
      "Lists": [
        {
          "Id": "sample string 1",
          "IsCategoryContactExclude": true,
          "FilterCampaignContactBy": "List"
        },
        {
          "Id": "sample string 1",
          "IsCategoryContactExclude": true,
          "FilterCampaignContactBy": "List"
        }
      ],
      "SmartLists": [
        {
          "Id": "sample string 1",
          "IsCategoryContactExclude": true,
          "FilterCampaignContactBy": "List"
        },
        {
          "Id": "sample string 1",
          "IsCategoryContactExclude": true,
          "FilterCampaignContactBy": "List"
        }
      ],
      "Keywords": [
        {
          "Id": "sample string 1",
          "IsCategoryContactExclude": true,
          "FilterCampaignContactBy": "List"
        },
        {
          "Id": "sample string 1",
          "IsCategoryContactExclude": true,
          "FilterCampaignContactBy": "List"
        }
      ],
      "WebForms": [
        {
          "Id": "sample string 1",
          "IsCategoryContactExclude": true,
          "FilterCampaignContactBy": "List"
        },
        {
          "Id": "sample string 1",
          "IsCategoryContactExclude": true,
          "FilterCampaignContactBy": "List"
        }
      ],
      "MobilePages": [
        {
          "Id": "sample string 1",
          "IsCategoryContactExclude": true,
          "FilterCampaignContactBy": "List"
        },
        {
          "Id": "sample string 1",
          "IsCategoryContactExclude": true,
          "FilterCampaignContactBy": "List"
        }
      ],
      "Interests": [
        {
          "Id": "sample string 1",
          "IsCategoryContactExclude": true,
          "FilterCampaignContactBy": "List"
        },
        {
          "Id": "sample string 1",
          "IsCategoryContactExclude": true,
          "FilterCampaignContactBy": "List"
        }
      ],
      "Tags": [
        {
          "Id": "sample string 1",
          "IsCategoryContactExclude": true,
          "FilterCampaignContactBy": "List"
        },
        {
          "Id": "sample string 1",
          "IsCategoryContactExclude": true,
          "FilterCampaignContactBy": "List"
        }
      ],
      "Types": [
        {
          "Id": "sample string 1",
          "IsCategoryContactExclude": true,
          "FilterCampaignContactBy": "List"
        },
        {
          "Id": "sample string 1",
          "IsCategoryContactExclude": true,
          "FilterCampaignContactBy": "List"
        }
      ],
      "ContactIds": [
        "sample string 1",
        "sample string 2"
      ],
      "CampaignCreatedFromModule": "Campaign"
    }
  ],
  "GlobalAnyAllOperator": "Any",
  "DateFilter": {
    "DateFieldIntervalRangeType": "This",
    "DateFieldFilterIntervalType": "Day",
    "DateField": "CreatedDate",
    "BirthdayFiltersBySubCategory": "Birthday",
    "DateIntervalLength": 1,
    "StartDate": "2022-12-04T04:47:12.0758124+00:00",
    "EndDate": "2022-12-04T04:47:12.0758124+00:00"
  },
  "SendToAllContacts": true
}

application/xml, text/xml

Sample:
<CampaignContactsWithCategoryConditionsViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models">
  <Conditions>
    <CampaignContactsFilterConditionsViewModel>
      <AnyAllOperator>Any</AnyAllOperator>
      <CampaignCreatedFromModule>Campaign</CampaignCreatedFromModule>
      <ChooseCampaignContactFrom>MyContacts</ChooseCampaignContactFrom>
      <ContactIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </ContactIds>
      <FilterCampaignContactBy>NA</FilterCampaignContactBy>
      <Interests>
        <CampaignContactCategoryConditionViewModel>
          <FilterCampaignContactBy>List</FilterCampaignContactBy>
          <Id>sample string 1</Id>
          <IsCategoryContactExclude>true</IsCategoryContactExclude>
        </CampaignContactCategoryConditionViewModel>
        <CampaignContactCategoryConditionViewModel>
          <FilterCampaignContactBy>List</FilterCampaignContactBy>
          <Id>sample string 1</Id>
          <IsCategoryContactExclude>true</IsCategoryContactExclude>
        </CampaignContactCategoryConditionViewModel>
      </Interests>
      <IsAllCategoriesSelected>true</IsAllCategoriesSelected>
      <Keywords>
        <CampaignContactCategoryConditionViewModel>
          <FilterCampaignContactBy>List</FilterCampaignContactBy>
          <Id>sample string 1</Id>
          <IsCategoryContactExclude>true</IsCategoryContactExclude>
        </CampaignContactCategoryConditionViewModel>
        <CampaignContactCategoryConditionViewModel>
          <FilterCampaignContactBy>List</FilterCampaignContactBy>
          <Id>sample string 1</Id>
          <IsCategoryContactExclude>true</IsCategoryContactExclude>
        </CampaignContactCategoryConditionViewModel>
      </Keywords>
      <Lists>
        <CampaignContactCategoryConditionViewModel>
          <FilterCampaignContactBy>List</FilterCampaignContactBy>
          <Id>sample string 1</Id>
          <IsCategoryContactExclude>true</IsCategoryContactExclude>
        </CampaignContactCategoryConditionViewModel>
        <CampaignContactCategoryConditionViewModel>
          <FilterCampaignContactBy>List</FilterCampaignContactBy>
          <Id>sample string 1</Id>
          <IsCategoryContactExclude>true</IsCategoryContactExclude>
        </CampaignContactCategoryConditionViewModel>
      </Lists>
      <MobilePages>
        <CampaignContactCategoryConditionViewModel>
          <FilterCampaignContactBy>List</FilterCampaignContactBy>
          <Id>sample string 1</Id>
          <IsCategoryContactExclude>true</IsCategoryContactExclude>
        </CampaignContactCategoryConditionViewModel>
        <CampaignContactCategoryConditionViewModel>
          <FilterCampaignContactBy>List</FilterCampaignContactBy>
          <Id>sample string 1</Id>
          <IsCategoryContactExclude>true</IsCategoryContactExclude>
        </CampaignContactCategoryConditionViewModel>
      </MobilePages>
      <SmartLists>
        <CampaignContactCategoryConditionViewModel>
          <FilterCampaignContactBy>List</FilterCampaignContactBy>
          <Id>sample string 1</Id>
          <IsCategoryContactExclude>true</IsCategoryContactExclude>
        </CampaignContactCategoryConditionViewModel>
        <CampaignContactCategoryConditionViewModel>
          <FilterCampaignContactBy>List</FilterCampaignContactBy>
          <Id>sample string 1</Id>
          <IsCategoryContactExclude>true</IsCategoryContactExclude>
        </CampaignContactCategoryConditionViewModel>
      </SmartLists>
      <Tags>
        <CampaignContactCategoryConditionViewModel>
          <FilterCampaignContactBy>List</FilterCampaignContactBy>
          <Id>sample string 1</Id>
          <IsCategoryContactExclude>true</IsCategoryContactExclude>
        </CampaignContactCategoryConditionViewModel>
        <CampaignContactCategoryConditionViewModel>
          <FilterCampaignContactBy>List</FilterCampaignContactBy>
          <Id>sample string 1</Id>
          <IsCategoryContactExclude>true</IsCategoryContactExclude>
        </CampaignContactCategoryConditionViewModel>
      </Tags>
      <Types>
        <CampaignContactCategoryConditionViewModel>
          <FilterCampaignContactBy>List</FilterCampaignContactBy>
          <Id>sample string 1</Id>
          <IsCategoryContactExclude>true</IsCategoryContactExclude>
        </CampaignContactCategoryConditionViewModel>
        <CampaignContactCategoryConditionViewModel>
          <FilterCampaignContactBy>List</FilterCampaignContactBy>
          <Id>sample string 1</Id>
          <IsCategoryContactExclude>true</IsCategoryContactExclude>
        </CampaignContactCategoryConditionViewModel>
      </Types>
      <WebForms>
        <CampaignContactCategoryConditionViewModel>
          <FilterCampaignContactBy>List</FilterCampaignContactBy>
          <Id>sample string 1</Id>
          <IsCategoryContactExclude>true</IsCategoryContactExclude>
        </CampaignContactCategoryConditionViewModel>
        <CampaignContactCategoryConditionViewModel>
          <FilterCampaignContactBy>List</FilterCampaignContactBy>
          <Id>sample string 1</Id>
          <IsCategoryContactExclude>true</IsCategoryContactExclude>
        </CampaignContactCategoryConditionViewModel>
      </WebForms>
    </CampaignContactsFilterConditionsViewModel>
    <CampaignContactsFilterConditionsViewModel>
      <AnyAllOperator>Any</AnyAllOperator>
      <CampaignCreatedFromModule>Campaign</CampaignCreatedFromModule>
      <ChooseCampaignContactFrom>MyContacts</ChooseCampaignContactFrom>
      <ContactIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </ContactIds>
      <FilterCampaignContactBy>NA</FilterCampaignContactBy>
      <Interests>
        <CampaignContactCategoryConditionViewModel>
          <FilterCampaignContactBy>List</FilterCampaignContactBy>
          <Id>sample string 1</Id>
          <IsCategoryContactExclude>true</IsCategoryContactExclude>
        </CampaignContactCategoryConditionViewModel>
        <CampaignContactCategoryConditionViewModel>
          <FilterCampaignContactBy>List</FilterCampaignContactBy>
          <Id>sample string 1</Id>
          <IsCategoryContactExclude>true</IsCategoryContactExclude>
        </CampaignContactCategoryConditionViewModel>
      </Interests>
      <IsAllCategoriesSelected>true</IsAllCategoriesSelected>
      <Keywords>
        <CampaignContactCategoryConditionViewModel>
          <FilterCampaignContactBy>List</FilterCampaignContactBy>
          <Id>sample string 1</Id>
          <IsCategoryContactExclude>true</IsCategoryContactExclude>
        </CampaignContactCategoryConditionViewModel>
        <CampaignContactCategoryConditionViewModel>
          <FilterCampaignContactBy>List</FilterCampaignContactBy>
          <Id>sample string 1</Id>
          <IsCategoryContactExclude>true</IsCategoryContactExclude>
        </CampaignContactCategoryConditionViewModel>
      </Keywords>
      <Lists>
        <CampaignContactCategoryConditionViewModel>
          <FilterCampaignContactBy>List</FilterCampaignContactBy>
          <Id>sample string 1</Id>
          <IsCategoryContactExclude>true</IsCategoryContactExclude>
        </CampaignContactCategoryConditionViewModel>
        <CampaignContactCategoryConditionViewModel>
          <FilterCampaignContactBy>List</FilterCampaignContactBy>
          <Id>sample string 1</Id>
          <IsCategoryContactExclude>true</IsCategoryContactExclude>
        </CampaignContactCategoryConditionViewModel>
      </Lists>
      <MobilePages>
        <CampaignContactCategoryConditionViewModel>
          <FilterCampaignContactBy>List</FilterCampaignContactBy>
          <Id>sample string 1</Id>
          <IsCategoryContactExclude>true</IsCategoryContactExclude>
        </CampaignContactCategoryConditionViewModel>
        <CampaignContactCategoryConditionViewModel>
          <FilterCampaignContactBy>List</FilterCampaignContactBy>
          <Id>sample string 1</Id>
          <IsCategoryContactExclude>true</IsCategoryContactExclude>
        </CampaignContactCategoryConditionViewModel>
      </MobilePages>
      <SmartLists>
        <CampaignContactCategoryConditionViewModel>
          <FilterCampaignContactBy>List</FilterCampaignContactBy>
          <Id>sample string 1</Id>
          <IsCategoryContactExclude>true</IsCategoryContactExclude>
        </CampaignContactCategoryConditionViewModel>
        <CampaignContactCategoryConditionViewModel>
          <FilterCampaignContactBy>List</FilterCampaignContactBy>
          <Id>sample string 1</Id>
          <IsCategoryContactExclude>true</IsCategoryContactExclude>
        </CampaignContactCategoryConditionViewModel>
      </SmartLists>
      <Tags>
        <CampaignContactCategoryConditionViewModel>
          <FilterCampaignContactBy>List</FilterCampaignContactBy>
          <Id>sample string 1</Id>
          <IsCategoryContactExclude>true</IsCategoryContactExclude>
        </CampaignContactCategoryConditionViewModel>
        <CampaignContactCategoryConditionViewModel>
          <FilterCampaignContactBy>List</FilterCampaignContactBy>
          <Id>sample string 1</Id>
          <IsCategoryContactExclude>true</IsCategoryContactExclude>
        </CampaignContactCategoryConditionViewModel>
      </Tags>
      <Types>
        <CampaignContactCategoryConditionViewModel>
          <FilterCampaignContactBy>List</FilterCampaignContactBy>
          <Id>sample string 1</Id>
          <IsCategoryContactExclude>true</IsCategoryContactExclude>
        </CampaignContactCategoryConditionViewModel>
        <CampaignContactCategoryConditionViewModel>
          <FilterCampaignContactBy>List</FilterCampaignContactBy>
          <Id>sample string 1</Id>
          <IsCategoryContactExclude>true</IsCategoryContactExclude>
        </CampaignContactCategoryConditionViewModel>
      </Types>
      <WebForms>
        <CampaignContactCategoryConditionViewModel>
          <FilterCampaignContactBy>List</FilterCampaignContactBy>
          <Id>sample string 1</Id>
          <IsCategoryContactExclude>true</IsCategoryContactExclude>
        </CampaignContactCategoryConditionViewModel>
        <CampaignContactCategoryConditionViewModel>
          <FilterCampaignContactBy>List</FilterCampaignContactBy>
          <Id>sample string 1</Id>
          <IsCategoryContactExclude>true</IsCategoryContactExclude>
        </CampaignContactCategoryConditionViewModel>
      </WebForms>
    </CampaignContactsFilterConditionsViewModel>
  </Conditions>
  <DateFilter xmlns:d2p1="http://schemas.datacontract.org/2004/07/MindMe.Shared.Common.Models">
    <d2p1:BirthdayFiltersBySubCategory>Birthday</d2p1:BirthdayFiltersBySubCategory>
    <d2p1:DateField>CreatedDate</d2p1:DateField>
    <d2p1:DateFieldFilterIntervalType>Day</d2p1:DateFieldFilterIntervalType>
    <d2p1:DateFieldIntervalRangeType>This</d2p1:DateFieldIntervalRangeType>
    <d2p1:DateIntervalLength>1</d2p1:DateIntervalLength>
    <d2p1:EndDate>2022-12-04T04:47:12.0758124+00:00</d2p1:EndDate>
    <d2p1:StartDate>2022-12-04T04:47:12.0758124+00:00</d2p1:StartDate>
  </DateFilter>
  <GlobalAnyAllOperator>Any</GlobalAnyAllOperator>
  <SendToAllContacts>true</SendToAllContacts>
</CampaignContactsWithCategoryConditionsViewModel>

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.