Versions Compared

Old Version 3

changes.mady.by.user NWEB Guest

Saved on

compared with

New Version 4

changes.mady.by.user NWEB Guest

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

 

Table of Contents

Overview

...

This method creates a new filter to be applied on recipient's personal data.

 

Note

Access token should be related to an authentication that is done by means of a console user that is enabled for creating filters on MailUp admin console (i.e. user 'a'+ consoleId is not allowed)


Method parameters

ParameterDescriptionExample
Id  always set to zero0
IdListSpecify here MailUp list ID (or 'NULL', if filter is applicable to all lists) 1
NameNumber that identifies console ID myFilter
Description  Category  optional, filter description"this filter selects recipients whose name starts with S"
CategoryCategory ID. Each filter should belong to a category, IDs can be retrieved by reading from tooltips (more on this)3
Conditions[ ]

Array of conditions (at list one). Each condition is composed of the following fields:

  • Id (always set to zero)
  • IdFilter (always set to zero)
  • LogicalOperation (allowed values: AND, ORNone, And, Or)
  • IdPersonalDataField (Personal Data Field ID)
  • IdPersonalDataFieldType (enum value, chosen between PersonalDataFilterConditionFieldType values in WSDL (link)
  • Type (enum value, chosen between PersonalDataFilterConditionType values in WSDL (link)
  • Value
 
  • (value to be checked by the filter)

If you want to filter all the recipients whose names starts with S you can use these values

  • Id=0
  • IdFilter=0
  • LogicalOperation=None
  • IdPersonalDataField=1
  • PersonalDataFieldTyp=String
  • Type=StartsWith
  • Value=S

SOAP Examples

Code Block
languagehtml/xml
titleSOAP request
coming soon<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ifil="http://Mailup.WS/IFilterService">
	<soapenv:Header/>
	<soapenv:Body>
		<ifil:FiltersCreatePersonalDataFilter>
			<ifil:request>
			<ifil:AccessToken>6CrfRUf5xb74brq/bBmtYYr8N7d5ZZuR0qA=</ifil:AccessToken>
			<ifil:Filter>
				<ifil:Id>0</ifil:Id>
				<ifil:IdList>1</ifil:IdList>
				<ifil:Name>myFilter</ifil:Name>
				<ifil:Description>this filter selects recipients whose name starts with S and birth date is after 1988-11-22</ifil:Description>
				<ifil:Category>1</ifil:Category>
				<ifil:Conditions>
					<ifil:PersonalDataFilterCondition>
						<ifil:Id>0</ifil:Id>
						<ifil:IdFilter>0</ifil:IdFilter>
						<ifil:LogicalOperation>None</ifil:LogicalOperation>
						<ifil:IdPersonalDataField>1</ifil:IdPersonalDataField>
						<ifil:PersonalDataFieldType>String</ifil:PersonalDataFieldType>
						<ifil:Type>StartsWith</ifil:Type>
						<ifil:Value>S</ifil:Value>
					</ifil:PersonalDataFilterCondition>
					<ifil:PersonalDataFilterCondition>
						<ifil:Id>0</ifil:Id>
						<ifil:IdFilter>0</ifil:IdFilter>
						<ifil:LogicalOperation>And</ifil:LogicalOperation>
						<ifil:IdPersonalDataField>4</ifil:IdPersonalDataField>
						<ifil:PersonalDataFieldType>Date_YYYYMMDD</ifil:PersonalDataFieldType>
						<ifil:Type>AfterDate</ifil:Type>
						<ifil:Value>19881122</ifil:Value>
					</ifil:PersonalDataFilterCondition>
				</ifil:Conditions>
			</ifil:Filter>
			</ifil:request>
		</ifil:FiltersCreatePersonalDataFilter>
	</soapenv:Body>
</soapenv:Envelope>
Code Block
languagehtml/xml
titleSOAP response
coming soon<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
      <FiltersCreatePersonalDataFilterResponse xmlns="http://Mailup.WS/IFilterService">
         <FiltersCreatePersonalDataFilterResult>
            <Filter>
               <Id>49</Id>
               <IdList>1</IdList>
               <Name>myFilter</Name>
               <Description>this filter selects recipients whose name starts with S and birth date is after 1988-11-22</Description>
               <Category>1</Category>
               <Conditions>
                  <PersonalDataFilterCondition>
                     <Id>27</Id>
                     <IdFilter>49</IdFilter>
                     <LogicalOperation>None</LogicalOperation>
                     <IdPersonalDataField>1</IdPersonalDataField>
                     <PersonalDataFieldType>String</PersonalDataFieldType>
                     <Type>StartsWith</Type>
                     <Value>S</Value>
                  </PersonalDataFilterCondition>
                  <PersonalDataFilterCondition>
                     <Id>28</Id>
                     <IdFilter>49</IdFilter>
                     <LogicalOperation>And</LogicalOperation>
                     <IdPersonalDataField>4</IdPersonalDataField>
                     <PersonalDataFieldType>Date_YYYYMMDD</PersonalDataFieldType>
                     <Type>AfterDate</Type>
                     <Value>19881122</Value>
                  </PersonalDataFilterCondition>
               </Conditions>
            </Filter>
         </FiltersCreatePersonalDataFilterResult>
      </FiltersCreatePersonalDataFilterResponse>
   </s:Body>
</s:Envelope>

 

FiltersDeletePersonalDataFilter

...