Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

...

ParameterDescriptionExample
Idalways set to zero 
IdListSpecify here MailUp list ID (or zero, if filter is applicable to all lists) 
NameFilter name 
DescriptionFilter description (free text) 
Category Category ID. Each filter should belong to a category, IDs can be retrieved by reading from tooltips (more on this) 
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: "None for the first condition, "Or" for the other conditions)
  • Type (allowed values: "UserIsLocatedIn" and "UserIsNotLocatedIn")
  • Country (country code, check this table)
  • Region (region name, check this table)
 

SOAP Examples

Code Block
languagehtml/xml
titleSOAP request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ifil="http://Mailup.WS/IFilterService">
<soapenv:Header/>
<soapenv:Body>
	<ifil:FiltersCreateGeographicFilter>
		<ifil:request>
			<ifil:AccessToken>ykpSh06dkwEv+Mrogyv4U59837ftsZUNRaAxODcpxYAni4VOKmxvoLzAIul5PIo89E1ecrUqUY59M=</ifil:AccessToken>
			<ifil:Filter>
				<ifil:Id>0</ifil:Id>
				<ifil:IdList>2</ifil:IdList>
				<ifil:Name>MailUp headquarters</ifil:Name>
				<ifil:Description>Recipients located near MailUp headquarters</ifil:Description>
				<ifil:Category>4</ifil:Category>
				<ifil:Conditions>
					<ifil:GeographicFilterCondition>
						<ifil:Id>0</ifil:Id>
						<ifil:IdFilter>0</ifil:IdFilter>
						<ifil:LogicalOperation>None</ifil:LogicalOperation>
						<ifil:Type>UserIsLocatedIn</ifil:Type>
						<ifil:Country>IT</ifil:Country>
						<ifil:Region>LOMBARDIA</ifil:Region>
					</ifil:GeographicFilterCondition>
					<ifil:GeographicFilterCondition>
						<ifil:Id>0</ifil:Id>
						<ifil:IdFilter>0</ifil:IdFilter>
						<ifil:LogicalOperation>Or</ifil:LogicalOperation>
						<ifil:Type>UserIsLocatedIn</ifil:Type>
						<ifil:Country>US</ifil:Country>
						<ifil:Region>CALIFORNIA</ifil:Region>
					</ifil:GeographicFilterCondition>
				</ifil:Conditions>
				<ifil:Precision>Low</ifil:Precision>
			</ifil:Filter>
		</ifil:request>
	</ifil:FiltersCreateGeographicFilter>
</soapenv:Body>
</soapenv:Envelope>

...