POST api/List/GetStaticListContactSummary

Request Information

URI Parameters

None.

Body Parameters

StaticListViewModel
NameDescriptionTypeAdditional information
IsGetLoadingDetails

boolean

None.

CaterogyId

string

None.

CategoryType

ContactFilterByCategory

None.

ContactIds

Collection of string

None.

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:
{
  "IsGetLoadingDetails": true,
  "CaterogyId": "sample string 2",
  "CategoryType": "List",
  "ContactIds": [
    "sample string 1",
    "sample string 2"
  ],
  "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-04T12:09:49.1111703+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-04T12:09:49.1111703+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 3",
  "UserId": "sample string 4",
  "ContactId": "sample string 5",
  "ViewContactRoleAccessLevel": "None",
  "PageSize": 6,
  "SearchValue": "sample string 7",
  "SortingDirection": "Ascending",
  "SortBy": "sample string 8",
  "PageNumber": 9
}

application/xml, text/xml

Sample:
<StaticListViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel.ListViewModels">
  <PageNumber xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel.Common">9</PageNumber>
  <PageSize xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel.Common">6</PageSize>
  <SearchValue xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel.Common">sample string 7</SearchValue>
  <SortBy xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel.Common">sample string 8</SortBy>
  <SortingDirection xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel.Common">Ascending</SortingDirection>
  <ContactFilters xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel">
    <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-04T12:09:49.1111703+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-04T12:09:49.1111703+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 xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel">sample string 5</ContactId>
  <GlobalConditionOperator xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel">Any</GlobalConditionOperator>
  <SubAccountId xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel">sample string 3</SubAccountId>
  <UserId xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel">sample string 4</UserId>
  <ViewContactRoleAccessLevel xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel">None</ViewContactRoleAccessLevel>
  <CategoryType>List</CategoryType>
  <CaterogyId>sample string 2</CaterogyId>
  <ContactIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ContactIds>
  <IsGetLoadingDetails>true</IsGetLoadingDetails>
</StaticListViewModel>

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.