POST api/Campaign/GetCampaignInitialDefaultSettings

Request Information

URI Parameters

None.

Body Parameters

CampaignContactCountByRoutePriorityRequestVM
NameDescriptionTypeAdditional information
CampaignId

string

None.

AccountId

string

None.

UserId

string

None.

SendToAllContacts

boolean

None.

SendMultipleMessagesToContact

boolean

None.

ContactIds

Collection of string

None.

CampaignCreatedFromModule

CampaignCreatedFromModule

None.

GlobalConditionOperator

AnyAllOperator

None.

ContactFilters

Collection of CampaignContactFilterConditionVM

None.

IsGetRouteStepDetails

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "CampaignId": "sample string 1",
  "AccountId": "sample string 2",
  "UserId": "sample string 3",
  "SendToAllContacts": true,
  "SendMultipleMessagesToContact": true,
  "ContactIds": [
    "sample string 1",
    "sample string 2"
  ],
  "CampaignCreatedFromModule": "Campaign",
  "GlobalConditionOperator": "Any",
  "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-04T04:34:33.7627343+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-04T04:34:33.7627343+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
      }
    }
  ],
  "IsGetRouteStepDetails": true
}

application/xml, text/xml

Sample:
<CampaignContactCountByRoutePriorityRequestVM xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MindMe.Business.Service.Services.RequestViewModels.CampaignRequestViewModel">
  <AccountId>sample string 2</AccountId>
  <CampaignCreatedFromModule>Campaign</CampaignCreatedFromModule>
  <CampaignId>sample string 1</CampaignId>
  <ContactFilters xmlns:d2p1="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel.CampaignViewModels">
    <d2p1:CampaignContactFilterConditionVM>
      <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-12-04T04:34:33.7627343+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:CampaignContactFilterConditionVM>
    <d2p1:CampaignContactFilterConditionVM>
      <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-12-04T04:34:33.7627343+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:CampaignContactFilterConditionVM>
  </ContactFilters>
  <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>
  <GlobalConditionOperator>Any</GlobalConditionOperator>
  <IsGetRouteStepDetails>true</IsGetRouteStepDetails>
  <SendMultipleMessagesToContact>true</SendMultipleMessagesToContact>
  <SendToAllContacts>true</SendToAllContacts>
  <UserId>sample string 3</UserId>
</CampaignContactCountByRoutePriorityRequestVM>

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.