The following SOAP methods are provided specifically for the processing and evaluation of target groups.
copy
Creates a copy of the resource specified by resource_id
EvalancheResourceInformation copy (int resource_id, int category_id)Details: copy
createByOption
Creation of a new target group using an attribute option
EvalancheResourceInformation createByOption ( int pool_id, int attribute_id, int option_id, int category_id, string name )
Parameters
- int pool_id: ID of the pool in which the attribute option is located
- int attribute_id: ID of the attribute in which the option is located
- int option_id: ID of the attribute option to be used for creating the target group
- int category_id: ID of the folder in which the target group is to be created
- string name: Name of the target group to be created
Return value
- EvalancheResourceInformation: Objects analogous to the method getById (retrieve information about an object using object Id)
Required rights
Use
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tar="https://scnem.com/soap.php/soap/targetgroup">
<soapenv:Header/>
<soapenv:Body>
<tar:createByOption>
<pool_id>POOL_ID</pool_id>
<attribute_id>ATTRIBUTE_ID</attribute_id>
<option_id>ATTRIBUTE_OPTION_ID</option_id>
<category_id>FOLDER_ID</category_id>
<name>TARGETGROUP_NAME</name>
</tar:createByOption>
</soapenv:Body>
</soapenv:Envelope><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/targetgroup">
<SOAP-ENV:Body>
<ns1:createByOptionResponse>
<createByOptionResult>
<url>TARGETGROUP_URL</url>
<type_id>TARGETGROUP_TYPE_ID</type_id>
<category_id>FOLDER_ID</category_id>
<customer_id>MANDATOR_ID</customer_id>
<id>TARGETGROUP_ID</id>
<name>TARGETGROUP_NAME</name>
</createByOptionResult>
</ns1:createByOptionResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
delete
Deletes the resource.
bool delete (int resource_id)Details: delete
getAll
Lists all resources within a client.
ArrayOfEvalancheResourceInformation getAll (int mandator_id)Details: getAll
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
getInformation
Read out information about a target group
EvalancheTargetgroupInformation getInformation ( int targetgroup_id )
Parameters
- int targetgroup_id: ID of the target group
Return value
- EvalancheTargetgroupInformation:Object with the following attributes:
- string name:Internal name of the target group
- int profile_count:Number of profiles currently available in the target group
Required rights
Use
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tar="https://scnem.com/soap.php/soap/targetgroup">
<soapenv:Header/>
<soapenv:Body>
<tar:getInformation>
<targetgroup_id>TARGETGROUP_ID</targetgroup_id>
</tar:getInformation>
</soapenv:Body>
</soapenv:Envelope><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/targetgroup">
<SOAP-ENV:Body>
<ns1:getInformationResponse>
<getInformationResult>
<name>TARGETGROP_NAME</name>
<profile_count>PROFILE_COUNT</profile_count>
</getInformationResult>
</ns1:getInformationResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>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
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
move
Moves the object to another folder
EvalancheResourceInformation move (int resource_id, int category_id)Details: move
rename
Gives the object a different name
EvalancheResourceInformation rename (int resource_id, string name)Details: rename