The following SOAP methods are provided specifically for the configuration and evaluation of profile pools.
getAll
Lists all resources within a client.
ArrayOfEvalancheResourceInformation getAll (int mandator_id)Details: getAll
getAttributes
Read attributes of a pool
EvalanchePoolAttribute[] getAttributes ( int pool_id )
Details
Parameters
- int pool_id: ID of the pool
Return value
-
EvalanchePoolAttributes[]:List of objects with the following attributes:
- int id: ID of the attribute option
- string value:Display name of the attribute option
- int type_id:ID of the type of the attribute. The following values are possible:
- 1: SALUTATIONs
- 2: COUNTRY
- 3: STATE
- 4: MOBILENETWORK
- 5: INPUT (single-line input)
- 6: MULTILINEINPUT (multi-line input)
- 7: SELECTION (single selection)
- 8:MULTIPLESELECTION (multiple selection)
- 9: DATE (Date)
- 10: EMAIL
- 11: DATETIME (date with time)
- 12: LANGUAGE (language)
- 13: ???
- 14:DATETIMERO (date with time, read only)
- 15: PERMISSION
- 16: BOOLEAN (True/False)
- 17: HARDBOUNCES
- 18:USERSTATE (user status, deprecated)
- 19: FORM (original form)
- 20: INT (integer)
- 21: ZIPCODE (postal code)
- int id: ID of the attribute
- string name:Internal name of the attribute
- string label:Display name of the attribute
- bool has_options:true, if this attribute allows options
- bool can_add_options:true, if options may be added to this attribute
- EvalanchePoolAttributeOption[] options:List of objects with the following attributes:
Required rights
Show pool
Use
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pool="https://scnem.com/soap.php/soap/pool">
<soapenv:Header/>
<soapenv:Body>
<pool:getAttributes>
<pool_id>POOL_ID</pool_id>
</pool:getAttributes>
</soapenv:Body>
</soapenv:Envelope><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/pool">
<SOAP-ENV:Body>
<ns1:getAttributesResponse>
<getAttributesResult>
<item>
<id>ATTRIBUTE_ID</id>
<name>ATTRIBUTE_NAME</name>
<label>ATTRIBUTE_LABEL</label>
<has_options>true/false</has_options>
<can_add_options>true/false</can_add_options>
<options>
<item>
<id>ATTRIBUTE_OPTION_ID</id>
<value>ATTRIBUTE_OPTION_VALUE</value>
</item>
[...]
</options>
<type_id>ATTRIBUTE_TYPE_ID</type_id>
</item>
[...]
</getAttributesResult>
</ns1:getAttributesResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
getByCategory
Returns all objects of a folder.
ArrayOfEvalancheResourceInformation getByCategory (int category_id)Details: getByCategory
getByExternalId
Outputs all direct mailing templates with a given EXTERNAL_ID.
ArrayOfEvalancheResourceInformation[] getByExternalId ( string external_id )Details: getByExternalId
getById
Searches for a object using an ID.
EvalancheHashMap Profile::getById( int resource_id ) Details: getById
getByModificationDate
Requesting an object via modification date
EvalancheResourceInformation getByModificationDate (int start_date, int end_date, int mandator_id)Details: getByModificationDate
getByTypeId
Retrieve all resources within this namespace with the specified resource type ID (see the getTypeIds method).
ArrayOfEvalancheResourceInformation getByTypeId (int type_id, int mandator_id)Details: getByTypeId
getResourceDefaultCategory
Provides information about the default folder of objects
getResourceDefaultCategoryResponse getResourceDefaultCategory (int customer_id)Details: getResourceDefaultCategory
getTypeIds
Reading the type Ids belonging to an object class
ArrayOfEvalancheResourceInformation getTypeIds ()Details: getTypeIds
addAttributes
Creating an attribute
EvalanchePoolAttribute addAttribute ( int pool_id, string name, string label, int type_id )
Details
Parameters
- int pool_id: ID of the pool
- string name: Internal name of the attribute (capital letters and numbers only, first character must be an uppercase letter)
- string label: Display name of the attribute
- int type_id: Type ID of the field, see return value under Reading the attributes of a pool
Return value
- EvalanchePoolAttributes: An object of the type EvalanchePoolAttribute analogous to the return value of the methods getAttributes
Required rights
Change pool
Use
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pool="https://scnem.com/soap.php/soap/pool">
<soapenv:Header/>
<soapenv:Body>
<pool:addAttribute>
<pool_id>POOL_ID</pool_id>
<name>ATTRIBUTE_NAME</name>
<label>ATTRIBUTE_LABEL</label>
<type_id>ATTRIBUTE_TYPE_ID</type_id>
</pool:addAttribute>
</soapenv:Body>
</soapenv:Envelope></soapenv:Envelope><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/pool">
<SOAP-ENV:Body>
<ns1:addAttributeResponse>
<addAttributeResult>
<id>ATTRIBUTE_ID</id>
<name>ATTRIBUTE_NAME</name>
<label>ATTRIBUTE_LABEL</label>
<has_options>true/false</has_options>
<can_add_options>true/false</can_add_options>
<options/>
<type_id>ATTRIBUTE_TYPE_ID</type_id>
</addAttributeResult>
</ns1:addAttributeResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
addAttributeOptions
Create attribute options
EvalanchePoolAttribute addAttributeOptions ( int pool_id, int attribute_id, string[] labels )
Details
Parameters
- int pool_id: ID of the pool
- int attribute_id: ID of the attribute
- string[] labels: List with the display names of the options to be created
Return value
- EvalanchePoolAttributes: An object of the type EvalanchePoolAttribute analogous to the return value of the methods getAttributes
Required rights
none
Use
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pool="https://scnem.com/soap.php/soap/pool">
<soapenv:Header/>
<soapenv:Body>
<pool:addAttributeOptions>
<pool_id>POOL_ID</pool_id>
<attribute_id>ATTRIBUTE_ID</attribute_id>
<labels>
<!--Zero or more repetitions:-->
<item>ATTRIBUTE_OPTION_LABEL</item>
</labels>
</pool:addAttributeOptions>
</soapenv:Body>
</soapenv:Envelope></soapenv:Envelope><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/pool">
<SOAP-ENV:Body>
<ns1:addAttributeOptionsResponse>
<addAttributeOptionsResult>
<id>ATTRIBUTE_ID</id>
<name>ATTRIBUTE_NAME</name>
<label>ATTRIBUTE_LABEL</label>
<has_options>true/false</has_options>
<can_add_options>true/false</can_add_options>
<options>
<item>
<id>ATTRIBUTE_OPTION_ID</id>
<value>ATTRIBUTE_OPTION_VALUE</value>
</item>
[...]
</options>
<type_id>ATTRIBUTE_TYPE_ID</type_id>
</addAttributeOptionsResult>
</ns1:addAttributeOptionsResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
deleteAttribute
Removes a pool attribute
bool deleteAttribute (int pool_id, int attribute_id)Details
Parameter
- int pool_id: pool Id
- int attribute_id: attribute Id
Return value
- deleteAttributeResult: true if the attribute could be deleted
Required rights
none
Use
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pool="https://scnem.com/soap.php/soap/pool">
<soapenv:Header/>
<soapenv:Body>
<pool:deleteAttribute>
<pool_id>POOL_ID</pool_id>
<attribute_id>ATTRIBUTE_ID</attribute_id>
</pool:deleteAttribute>
</soapenv:Body>
</soapenv:Envelope><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/pool">
<SOAP-ENV:Body>
<ns1:deleteAttributeResponse>
<deleteAttributeResult>
<bool>TRUE/FALSE</bool>
</deleteAttributeResult>
</ns1:deleteAttributeResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
deleteAttributeOption
Delete attribute options
EvalanchePoolAttribute deleteAttributeOption ( int pool_id, int attribute_id, int option_id )
Details
Parameters
- int pool_id: ID of the pool
- int attribute_id: ID of the attribute
- int option_id: ID of the option to be deleted
Return value
- EvalanchePoolAttributes: An object of the type EvalanchePoolAttribute analogous to the return value of the methods getAttributes
Required rights
none
Use
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pool="https://scnem.com/soap.php/soap/pool">
<soapenv:Header/>
<soapenv:Body>
<pool:deleteAttributeOption>
<pool_id>POOL_ID</pool_id>
<attribute_id>ATTRIBUTE_ID</attribute_id>
<option_id>ATTRIBUTE_OPTION_ID</option_id>
</pool:deleteAttributeOption>
</soapenv:Body>
</soapenv:Envelope><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/pool">
<SOAP-ENV:Body>
<ns1:deleteAttributeOptionResponse>
<deleteAttributeOptionResult>
<id>ATTRIBUTE_ID</id>
<name>ATTRIBUTE_NAME</name>
<label>ATTRIBUTE_LABEL</label>
<has_options>true/false</has_options>
<can_add_options>true/false</can_add_options>
<options>
<item>
<id>ATTRIBUTE_OPTION_ID</id>
<value>ATTRIBUTE_OPTION_VALUE</value>
</item>
[...]
</options>
<type_id>ATTRIBUTE_TYPE_ID</type_id>
</deleteAttributeOptionResult>
</ns1:deleteAttributeOptionResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
isAlive
Tests whether the API is available and the credentials used are valid. The `random_message` property of the result is completely irrelevant, since the values are randomly taken from http://whatthecommit.com.
isAliveResponse isAlive ()Details: isAlive
updateAttributeOption
Update Attribute Options
EvalanchePoolAttribute updateAttributeOption ( int pool_id, int attribute_id, int option_id, string label )
Details
Parameters
- int pool_id: ID of the pool
- int attribute_id: ID of the attribute
- int option_id: ID of the option
- string label: New display name for the option
Return value
- EvalanchePoolAttributes: An object of the type EvalanchePoolAttribute analogous to the return value of the methods getAttributes
Required rights
none
Use
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pool="https://scnem.com/soap.php/soap/pool">
<soapenv:Header/>
<soapenv:Body>
<pool:updateAttributeOption>
<pool_id>POOL_ID</pool_id>
<attribute_id>ATTRIBUTE_ID</attribute_id>
<option_id>ATTRIBUTE_OPTION_ID</option_id>
<label>ATTRIBUTE_OPTION_LABEL</label>
</pool:updateAttributeOption>
</soapenv:Body>
</soapenv:Envelope></soapenv:Envelope><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/pool">
<SOAP-ENV:Body>
<ns1:updateAttributeOptionResponse>
<updateAttributeOptionResult>
<id>ATTRIBUTE_ID</id>
<name>ATTRIBUTE_NAME</name>
<label>ATTRIBUTE_LABEL</label>
<has_options>true/false</has_options>
<can_add_options>true/false</can_add_options>
<options>
<item>
<id>ATTRIBUTE_OPTION_ID</id>
<value>ATTRIBUTE_OPTION_VALUE</value>
</item>
[...]
</options>
<type_id>ATTRIBUTE_OPTION_TYPE_ID</type_id>
</updateAttributeOptionResult>
</ns1:updateAttributeOptionResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope></SOAP-ENV:Envelope>