The following SOAP methods are provided specifically for the processing and evaluation of target groups.
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 )
Details
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
Create target group
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>
getInformation
Read out information about a target group
EvalancheTargetgroupInformation getInformation ( int targetgroup_id )
Details
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
Show target group
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>