SOAP Profile

Parameters

• int pool_id: The ID of the pool in which the profile is to be created
• EvalancheHashMap data: EvalancheHachMap with the data of the profile

Return value

• int profile_id: The ID of the newly created profile

Required rights

Use

<soapenv:envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prof="https://scnem.com/soap.php/soap/profile">
<soapenv:Header/> 
<soapenv:Body> 
<prof:create> 
<pool_id>POOL_ID</pool_id>
<data> <items>
<item> <key>ATTRIBUTE_NAME</key>
<value>ATTRIBUTE_CONTENT</value>
</item> 
[...]
</items> 
</data>
</prof:create> 
</soapenv:body> 
</soapenv:envelope> 

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/profile"> 
<SOAP-ENV:Body> 
<ns1:createResponse> 
<createResult>PROFILE_ID</createResult>
</ns1:createResponse> 
</SOAP-ENV:Body> 
</SOAP-ENV:Envelope> 

Parameters

• int[] profile_id: A list of the IDs of the profiles to be deleted

Return value

• bool: true in case of success

Required rights

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prof="https://scnem.com/soap.php/soap/profile"> 
<soapenv:Header/> 
<soapenv:Body> 
<prof:delete> 
<profile_ids>
<!--Zero or more repetitions:--> 
<item>PROFILE_ID</item>
</profile_ids>
</prof:delete> 
</soapenv:Body> 
</soapenv:Envelope> 

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/profile"> 
<SOAP-ENV:Body> 
<ns1:deleteResponse> 
<deleteResult>true</deleteResult>
</ns1:deleteResponse> 
</SOAP-ENV:Body> 
</SOAP-ENV:Envelope> 

Parameters

• int profile_id: The ID of the profile whose permission is to be revoked

Return value

• bool: true in case of success

Required rights

Use

<soapenv:envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prof="https://scnem.com/soap.php/soap/profile"> 
<soapenv:Header/> 
<soapenv:Body> 
<prof:revokePermission>
<profile_id>PROFILE_ID</profile_id>
</prof:revokePermission> 
</soapenv:Body> 
</soapenv:Envelope> 

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/profile"> 
<SOAP-ENV:Body> 
<ns1:revokePermissionResponse>
<revokePermissionResult>true</revokePermissionResult>
</ns1:revokePermissionResponse>
</SOAP-ENV:Body> 
</SOAP-ENV:Envelope> 

Parameters

• int profile_id: The ID of the profile whose tracking consent is to be revoked

Return value

• bool: true in case of success

Required rights

Use

<soapenv:envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prof="https://scnem.com/soap.php/soap/profile"> 
<soapenv:Header/> 
<soapenv:Body> 
<prof:revokeTracking>
<profile_id>PROFILE_ID</profile_id>
</prof:revokeTracking> 
</soapenv:Body> 
</soapenv:Envelope> 

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/profile"> 
<SOAP-ENV:Body> 
<ns1:revokeTrackingResponse>
<revokeTrackingResult>true</revokeTrackingResult>
</ns1:revokeTrackingResponse>
</SOAP-ENV:Body> 
</SOAP-ENV:Envelope> 

Parameters

• int[] profile_id: A list of the IDs of the profiles to be granted

Return value

• bool: true in case of success

Required rights

Use

<soapenv:envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prof="https://scnem.com/soap.php/soap/profile"> 
<soapenv:Header/> 
<soapenv:Body> 
<prof:grantPermission>
<profile_id>PROFILE_ID</profile_id>
</prof:grantPermission> 
</soapenv:Body> 
</soapenv:Envelope> 

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/profile"> 
<SOAP-ENV:Body> 
<ns1:grantPermissionResponse> 
<grantPermissionResult>true</grantPermissionResult>
</ns1:grantPermissionResponse>
</SOAP-ENV:Body> 
</SOAP-ENV:Envelope> 

Parameters

• string profile_id: ID or UID of the profile to be searched

Return value

• EvalancheHashMap data: EvalancheHashMap with the data of the profile

Required rights

Use

<soapenv:envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prof="https://scnem.com/soap.php/soap/profile"> 
<soapenv:Header/> 
<soapenv:Body> 
<prof:getById>
<profile_id>PROFILE_ID</profile_id>
</prof:getById> 
</soapenv:Body> 
</soapenv:Envelope> 

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/profile"> 
<SOAP-ENV:Body> 
<ns1:getByIdResponse>
<getByIdResult>
<items> 
<item> 
<key>ATTRIBUTE_NAME</key>
<value>ATTRIBUTE_VALUE</value>
</item> 
[...]
</items> 
</getByIdResult>
</ns1:getByIdResponse>
</SOAP-ENV:Body> 
</SOAP-ENV:Envelope> 

Parameters

• int pool_id: ID of the pool to search in
• string key: Name of the pool attribute that is the key for the search, for example: EMAIL
• string value: Value to be searched for, e.g.: mustermann@example.com
• string[] pool_attribute_list: List with names of the pool attributes to be returned in the result (mandatory)

Return value

• EvalancheHashMap data: EvalancheHashMap with the data of the profiles

Required rights

Use

<soapenv:envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prof="https://scnem.com/soap.php/soap/profile"> 
<soapenv:Header/> 
<soapenv:Body> 
<prof:getByKey> 
<pool_id>POOL_ID</pool_id>
<key>KEY_ATTRIBUTE</key>
<value>KEY_ATTRIBUTE_VALUE</value>
<pool_attribute_list> 
<!--One or more repetitions:--> 
<item>ATTRIBUTE_NAME</item>
[...] 
</pool_attribute_list>
</prof:getByKey> 
</soapenv:Body> 
</soapenv:Envelope> 

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/profile"> 
<SOAP-ENV:Body> 
<ns1:getByKeyResponse> 
<getByKeyResult>
<item> 
<items>
<item>
<key>ATTRIBUTE_NAME</key>
<value>ATTRIBUTE_VALUE</value>
</item>
[...]
</items> 
</item>
[...] 
</getByKeyResult>
</ns1:getByKeyResponse>
</SOAP-ENV:Body> 
</SOAP-ENV:Envelope> 

Parameters

• int pool_id: ID of the pool. Defines in which customer should be searched
• int start_time: UTC Unix timestamp of the time from (including) which bounces should be returned
• int end_time: UTC Unix timestamp of the time up to (and including) which bounces should be returned. If 0 is passed here, the current time is used
• string[] pool_attribute_list: Optional list with names of the pool attributes to be returned in the result

Return value

• ProfileBounceStatus[]: List of objects with the following attributes:
  • int profile_id: ID of the relevant profile
  • int mailing_id: ID of the mailing in which the bounce occurred
  • int status: Bounce status. Possible values are:
    • 3: Soft Bounce
    • 2: Hardbounce
  • int timestamp: UTC Unix timestamp of the time when the bounce occurred
  • EvalancheHashMap profile_data: EvalancheHashMap with the data of the respective profile

Required rights

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prof="https://scnem.com/soap.php/soap/profile">
 <soapenv:Header/>
 <soapenv:Body>
 <prof:getBounces>
 <pool_id>POOL_ID</pool_id>
 <start_time>TIMESTAMP_START_TIME</start_time>
 <end_time>TIMESTAMP_END_TIME</end_time>
 <pool_attribute_list>
 <!--Zero or more repetitions:-->
 <item>ATTRIBUTE_NAME</item>
[...]
 </pool_attribute_list>
 </prof:getBounces>
 </soapenv:Body>
</soapenv:Envelope> 

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/profile">
 <SOAP-ENV:Body>
 <ns1:getBouncesResponse>
 <getBouncesResult>
 <item>
 <items>
 <item>
 <key>ATTRIBUTE_NAME</key>
 <value>ATTRIBUTE_VALUE</value>
 </item>
[...]
 </items>
 </item>
[...]
 </getBouncesResult>
 </ns1:getBouncesResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope> 

Parameters

• int pool_id: ID of the pool to be queried
• string[] attributes: List of pool attribute names whose values are to be returned for profiles found
• int start_time: UTC Unix timestamp of the time from (including) which changed profiles are to be returned
• int end_time: UTC Unix timestamp of the time up to (and including) which changed profiles should be returned

Return value

• EvalancheHashMap[]: List of 'EvaluancheHashMap' with the data of the respective profiles

Required rights

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prof="https://scnem.com/soap.php/soap/profile">
 <soapenv:Header/>
 <soapenv:Body>
 <prof:getModifiedProfiles>
 <pool_id>Pool_id</pool_id>
 <attributes>
 <!--Zero or more repetitions:-->
 <item>ATTRIBUTE_NAME</item>
 </attributes>
 <start_time>TIMESTAMP_START_TIME</start_time>
 <end_time>TIMESTAMP_END_TIME</end_time>
 </prof:getModifiedProfiles>
 </soapenv:Body>
</soapenv:Envelope> 

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/profile">
 <SOAP-ENV:Body>
 <ns1:getModifiedProfilesResponse>
 <getModifiedProfilesResult>
 <item>
 <items>
 <item>
 <key>ATTRIBUTE_NAME</key>
 <value>ATTRIBUTE_VALUE</value>
 </item>
[...]
 </items>
 </item>
[...]
 </getModifiedProfilesResult>
 </ns1:getModifiedProfilesResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope> 

Parameters

• int pool_id: ID of the pool to be queried
• int start_time: UTC Unix timestamp of the time from (including) which logouts are to be returned
• int end_time: UTC Unix timestamp of the time up to (and including) which logouts should be returned. If 0 is passed here, the current time is used.
• string[] attributes: Optional array of strings with names of pool attributes to be returned in the result

Return value

• EvalancheHashMap[]: List of 'EvaluancheHashMap' with the data of the respective profiles

Required rights

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prof="https://scnem.com/soap.php/soap/profile">
 <soapenv:Header/>
 <soapenv:Body>
 <prof:getUnsubscriptions>
 <pool_id>POOL_ID</pool_id>
 <start_time>TIMESTAMP_START_TIME</start_time>
 <end_time>TIMESTAMP_END_TIME</end_time>
 <pool_attribute_list>
 <!--Zero or more repetitions:-->
 <item>ATTRIBUTE_NAME</item>
 </pool_attribute_list>
 </prof:getUnsubscriptions>
 </soapenv:Body>
</soapenv:Envelope> 

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/profile">
 <SOAP-ENV:Body>
 <ns1:getUnsubscriptionsResponse>
 <getUnsubscriptionsResult>
 <item>
 <items>
 <item>
 <key>ATTRIBUTE_NAME</key>
 <value>ATTRIBUTE_VALUE</value>
 </item>
[...]
 </items>
 </item>
[...]
 </getUnsubscriptionsResult>
 </ns1:getUnsubscriptionsResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope> 

Parameters

• int pool_id: ID of the pool to be queried
• string[] attributes: Optional array of strings with names of pool attributes to be returned in the result
• int start_time: UTC Unix timestamp of the time from (including) which double-opt-in confirmations should be returned
• int end_time: UTC Unix timestamp of the time up to (and including) which double-opt-in confirmations should be returned. If 0 is passed here, the current time is used.

Return value

• EvalancheHashMap[]: List of 'EvaluancheHashMap' with the data of the respective profiles

Required rights

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prof="https://scnem.com/soap.php/soap/profile">
 <soapenv:Header/>
 <soapenv:Body>
 <prof:getGrantedPermissions>
 <pool_id>POOL_ID</pool_id>
 <attributes>
 <!--Zero or more repetitions:-->
 <item>ATTRIBUTE_NAME</item>
 </attributes>
 <start_time>TIMESTAMP_START_TIME</start_time>
 <end_time>TIMESTAMP_END_TIME</end_time>
 </prof:getGrantedPermissions>
 </soapenv:Body>
</soapenv:Envelope> 

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/profile">
 <SOAP-ENV:Body>
 <ns1:getGrantedPermissionsResponse>
 <getGrantedPermissionsResult>
 <item>
 <items>
 <item>
 <key>ATTRIBUTE_NAME</key>
 <value>ATTRIBUTE_VALUE</value>
 </item>
[...]
 </items>
 </item>
[...]
 </getGrantedPermissionsResult>
 </ns1:getGrantedPermissionsResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameters

• int targetgroup_id: ID of the target group to be queried
• string[] pool_attribute_list: List of attribute names to be returned in the result (mandatory)

Return value

• EvalancheJobHandle: An object of the type EvalancheJobHandle with the following attributes:
  • string id: The ID of the background job
  • int status: The status of the background job with the possible values:
    • 0: Queue
    • 1: In process
    • 2: Ready
    • 3: Temporary error (processing is repeated)
    • 4: Error
• string status_description: Description of the status
• namespace: Namespace under which the background job was started, here always profile
• string method: Name of the method that started the background job, here always getByTargetGroup
• int resource_id: ID of the resource for which the background job was started, here always the targetgroup_id
• int result_chunks: Number of result blocks found. This value is not equal to 0 only in status 2

Required rights

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prof="https://scnem.com/soap.php/soap/profile">
 <soapenv:Header/>
 <soapenv:Body>
 <prof:getByTargetGroup>
 <targetgroup_id>TARGETGROUP_ID</targetgroup_id>
 <pool_attribute_list>
 <!--One or more repetitions:-->
 <item>ATTRIBUTE_NAME</item>
 </pool_attribute_list>
 </prof:getByTargetGroup>
 </soapenv:Body>
</soapenv:Envelope> 

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/profile">
 <SOAP-ENV:Body>
 <ns1:getByTargetGroupResponse>
 <getByTargetGroupResult>
 <id>JOB_ID</id>
 <status>JOB_STATUS</status>
 <status_description>JOB_STATUS_DESCRIPTION</status_description>
 <namespace>JOB_NAMESPACE</namespace>
 <method>JOB_METHOD</method>
 <resource_id>TARGETGROUP_ID</resource_id>
 <result_chunks>COUNT_RESULT_CHUNKS</result_chunks>
 </getByTargetGroupResult>
 </ns1:getByTargetGroupResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope> 

See also:

• Background Jobs

Parameters

• int pool_id: ID of the pool to be queried
• string[] pool_attribute_list: List of attribute names to be returned in the result (mandatory)

Return value

• EvalancheJobHandle: An object of the type EvalancheJobHandle with the following attributes:
  • string id: The ID of the background job
  • int status: The status of the background job with the possible values:
    • 0: Queue
    • 1: In process
    • 2: Ready
    • 3: Temporary error (processing is repeated)
    • 4: Error
• string status_description: Description of the status
• namespace: Namespace under which the background job was started, here always profile
• string method: Name of the method that started the background job, here always getByPool
• int resource_id: ID of the resource for which the background job was started, here always the pool_id
• int result_chunks: Number of result blocks found. This value is not equal to 0 only in status 2

Required rights

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prof="https://scnem.com/soap.php/soap/profile">
 <soapenv:Header/>
 <soapenv:Body>
 <prof:getByPool>
 <pool_id>22852889</pool_id>
 <pool_attribute_list>
 <!--One or more repetitions:-->
 <item>EMAIL</item>
 <item>SID</item>
 </pool_attribute_list>
 </prof:getByPool>
 </soapenv:Body>
</soapenv:Envelope> 

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/profile">
 <SOAP-ENV:Body>
 <ns1:getByPoolResponse>
 <getByPoolResult>
 <id>JOB_ID</id>
 <status>JOB_STATUS</status>
 <status_description>JOB_STATUS_DESCRIPTION</status_description>
 <namespace>JOB_NAMESPACE</namespace>
 <method>JOB_METHOD</method>
 <resource_id>TARGETGROUP_ID</resource_id>
 <result_chunks>COUNT_RESULT_CHUNKS</result_chunks>
 </getByPoolResult>
 </ns1:getByPoolResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope> 

See also:

• Background Jobs

Parameters

• int profile_id: ID of the profile to be queried
• int[] targetgroup_ids: List of target group Ids to be tested

Return value

• EvalancheTargetgroupMembership[]: List of EvalancheTargetgroupMembership objects with the following attributes:
  • int profile_id: The ID of the checked profile
  • int targetgroup_id: ID of the target group in which the profile is located

Required rights

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prof="https://scnem.com/soap.php/soap/profile">
 <soapenv:Header/>
 <soapenv:Body>
 <prof:isInTargetgroups>
 <profile_id>PROFILE_ID</profile_id>
 <targetgroup_ids>
 <!--Zero or more repetitions:-->
 <item>TARGETGROUP_ID</item>
 </targetgroup_ids>
 </prof:isInTargetgroups>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/profile">
 <SOAP-ENV:Body>
 <ns1:isInTargetgroupsResponse>
 <isInTargetgroupsResult>
 <item>
 <profile_id>PROFILE_ID</profile_id>
 <targetgroup_id>TARGETGROUP_ID</targetgroup_id>
 </item>
[...]
 </isInTargetgroupsResult>
 </ns1:isInTargetgroupsResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameters

• int pool_attribute_option_id: ID of the attribute option to be set
• string[] values: List of strings with values to be searched for
• string key: Name of the pool attribute in which values are to be searched for
• bool set_profile_edit_date: If true is specified here, the change date is updated for all affected profiles

Return value

• bool: true in case of success

Required rights

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prof="https://scnem.com/soap.php/soap/profile">
 <soapenv:Header/>
 <soapenv:Body>
 <prof:tagWithOption>
 <pool_attribute_option_id>ATTRIBUTE_OPTION_ID</pool_attribute_option_id>
 <values>
 <!--Zero or more repetitions:-->
 <item>SEARCH_ATTRIBUTE_VALUES</item>
 </values>
 <key>SEARCH_ATTRIBUTE</key>
 <set_profile_edit_date_and_fire_update_event>SET_CHANGE_DATE 1/0</set_profile_edit_date_and_fire_update_event>
 </prof:tagWithOption>
 </soapenv:Body>
</soapenv:Envelope> 

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/profile">
 <SOAP-ENV:Body>
 <ns1:tagWithOptionResponse>
 <tagWithOptionResult>true</tagWithOptionResult>
 </ns1:tagWithOptionResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope> 

Parameters

• int pool_attribute_option_id: ID of the attribute option to be removed
• string[] values: List of strings with values to be searched for
• string key: Name of the pool attribute in which values are to be searched for
• bool set_profile_edit_date: If true is specified here, the change date is updated for all affected profiles

Return value

• bool: true in case of success

Required rights

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prof="https://scnem.com/soap.php/soap/profile">
 <soapenv:Header/>
 <soapenv:Body>
 <prof:untagWithOption>
 <pool_attribute_option_id>ATTRIBUTE_OPTION_ID</pool_attribute_option_id>
 <values>
 <!--Zero or more repetitions:-->
 <item>SEARCH_ATTRIBUTE_VALUE</item>
 </values>
 <key>SEARCH_ATTRIBUTE_KEY</key>
 <set_profile_edit_date_and_fire_update_event>SET_CHANGE_DATE 1/0</set_profile_edit_date_and_fire_update_event>
 </prof:untagWithOption>
 </soapenv:Body>
</soapenv:Envelope> 

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/profile">
 <SOAP-ENV:Body>
 <ns1:untagWithOptionResponse>
 <untagWithOptionResult>true</untagWithOptionResult>
 </ns1:untagWithOptionResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope> 

Parameters

• int profile_id: ID of the profile to be updated
• EvalancheHashMap data: EvalancheHashMap with the data of the profile

Return value

• bool: true in case of success

Required rights

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prof="https://scnem.com/soap.php/soap/profile">
 <soapenv:Header/>
 <soapenv:Body>
 <prof:updateById>
 <profile_id>PROFILE_ID</profile_id>
 <data>
 <items>
 <!--Zero or more repetitions:-->
 <item>
 <!--You may enter the following 2 items in any order-->
 <key>ATTRIBUTE_NAME</key>
 <value>ATTRIBUTE_VALUE</value>
 </item>
 </items>
 </data>
 </prof:updateById>
 </soapenv:Body>
</soapenv:Envelope> 

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/profile">
 <SOAP-ENV:Body>
 <ns1:updateByIdResponse>
 <updateByIdResult>true</updateByIdResult>
 </ns1:updateByIdResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope> 

Parameters

• int profile_id: ID of the profile to be updated
• EvalancheHashMap data: EvalancheHashMap with the data of the profile

Return value

• bool: true in case of success

Required rights

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prof="https://scnem.com/soap.php/soap/profile">
 <soapenv:Header/>
 <soapenv:Body>
 <prof:mergeById>
 <profile_id>PROFILE_ID</profile_id>
 <data>
 <items>
 <!--Zero or more repetitions:-->
 <item>
 <!--You may enter the following 2 items in any order-->
 <key>ATTRIBUTE_NAME</key>
 <value>ATTRIBUTE_VALUE</value>
 </item>
 </items>
 </data>
 </prof:mergeById>
 </soapenv:Body>
</soapenv:Envelope> 

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/profile">
 <SOAP-ENV:Body>
 <ns1:mergeByIdResponse>
 <mergeByIdResult>true</mergeByIdResult>
 </ns1:mergeByIdResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameters

• int pool_id: ID of the pool to be searched
• string key: Name of the pool attribute in which the search is to be made
• string value: Value to search for in key
• EvalancheHashMap data: EvalancheHashMap with the data of the profile

Return value

• bool: true in case of success

Required rights

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prof="https://scnem.com/soap.php/soap/profile">
 <soapenv:Header/>
 <soapenv:Body>
 <prof:updateByKey>
 <pool_id>POOL_ID</pool_id>
 <key>SEARCH_ATTRIBUTE_NAME</key>
 <value>SEARCH_ATTRIBUTE_VALUE</value>
 <data>
 <items>
 <!--Zero or more repetitions:-->
 <item>
 <!--You may enter the following 2 items in any order-->
 <key>ATTRIBUTE_NAME</key>
 <value>ATTRIBUTE_VALUE</value>
 </item>
 </items>
 </data>
 </prof:updateByKey>
 </soapenv:Body>
</soapenv:Envelope> 

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/profile">
 <SOAP-ENV:Body>
 <ns1:updateByKeyResponse>
 <updateByKeyResult>true</updateByKeyResult>
 </ns1:updateByKeyResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope> 

Parameters

• int pool_id: ID of the pool to be searched
• string key: Name of the pool attribute in which the search is to be made
• string value: Value to search for in key
• EvalancheHashMap data: EvalancheHashMap with the data of the profile

Return value

• bool: true in case of success

Required rights

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prof="https://scnem.com/soap.php/soap/profile">
 <soapenv:Header/>
 <soapenv:Body>
 <prof:mergeByKey>
 <pool_id>POOL_ID</pool_id>
 <key>SEARCH_ATTRIBUTE_NAME</key>
 <value>SEARCH_ATTRIBUTE_VALUE</value>
 <data>
 <items>
 <!--Zero or more repetitions:-->
 <item>
 <!--You may enter the following 2 items in any order-->
 <key>ATTRIBUTE_NAME</key>
 <value>ATTRIBUTE_VALUE</value>
 </item>
 </items>
 </data>
 </prof:mergeByKey>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/profile">
 <SOAP-ENV:Body>
 <ns1:mergeByKeyResponse>
 <mergeByKeyResult>true</mergeByKeyResult>
 </ns1:mergeByKeyResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope> 

Parameters

• int targetgroup_id: ID of the target group, in which profile should be updated
• EvalancheHashMap data: EvalancheHashMap with the data of the profile

Return value

• bool: true in case of success

Required rights

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prof="https://scnem.com/soap.php/soap/profile">
 <soapenv:Header/>
 <soapenv:Body>
 <prof:updateByTargetGroup>
 <target_group_id>TARGETGROUP_ID</target_group_id>
 <data>
 <items>
 <!--Zero or more repetitions:-->
 <item>
 <!--You may enter the following 2 items in any order-->
 <key>ATTRIBUTE_NAME</key>
 <value>ATTRIBUTE_VALUE</value>
 </item>
 </items>
 </data>
 </prof:updateByTargetGroup>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/profile">
 <SOAP-ENV:Body>
 <ns1:updateByTargetGroupResponse>
 <updateByTargetGroupResult>true</updateByTargetGroupResult>
 </ns1:updateByTargetGroupResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope> 

Parameters

• int targetgroup_id: ID of the target group, in which profile should be updated
• EvalancheHashMap data: EvalancheHashMap with the data of the profile

Return value

• bool: true in case of success

Required rights

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prof="https://scnem.com/soap.php/soap/profile">
 <soapenv:Header/>
 <soapenv:Body>
 <prof:mergeByTargetGroup>
 <target_group_id>TARGETGROUP_ID</target_group_id>
 <data>
 <items>
 <!--Zero or more repetitions:-->
 <item>
 <!--You may enter the following 2 items in any order-->
 <key>ATTRIBUTE_NAME</key>
 <value>ATTRIBUTE_VALUE</value>
 </item>
 </items>
 </data>
 </prof:mergeByTargetGroup>
 </soapenv:Body>
</soapenv:Envelope> 

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/profile">
 <SOAP-ENV:Body>
 <ns1:mergeByTargetGroupResponse>
 <mergeByTargetGroupResult>true</mergeByTargetGroupResult>
 </ns1:mergeByTargetGroupResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameters

• int pool_id: ID of the target group, in which profile should be updated
• EvalancheHashMap data: EvalancheHashMap with the data of the profile

Return value

• bool: true in case of success

Required rights

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prof="https://scnem.com/soap.php/soap/profile">
 <soapenv:Header/>
 <soapenv:Body>
 <prof:updateByPool>
 <pool_id>POOL_ID</pool_id>
 <data>
 <items>
 <!--Zero or more repetitions:-->
 <item>
 <!--You may enter the following 2 items in any order-->
 <key>ATTRIBUTE_NAME</key>
 <value>ATTRIBUTE_VALUE</value>
 </item>
 </items>
 </data>
 </prof:updateByPool>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/profile">
 <SOAP-ENV:Body>
 <ns1:updateByPoolResponse>
 <updateByPoolResult>true</updateByPoolResult>
 </ns1:updateByPoolResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope> 

Parameters

• int pool_id: ID of the target group, in which profile should be updated
• EvalancheHashMap data: EvalancheHashMap with the data of the profile

Return value

• bool: true in case of success

Required rights

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prof="https://scnem.com/soap.php/soap/profile">
 <soapenv:Header/>
 <soapenv:Body>
 <prof:mergeByPool>
 <pool_id>POOL_ID</pool_id>
 <data>
 <items>
 <!--Zero or more repetitions:-->
 <item>
 <!--You may enter the following 2 items in any order-->
 <key>ATTRIBUTE_NAME</key>
 <value>ATTRIBUTE_VALUE</value>
 </item>
 </items>
 </data>
 </prof:mergeByPool>
 </soapenv:Body>
</soapenv:Envelope> 

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/profile">
 <SOAP-ENV:Body>
 <ns1:mergeByPoolResponse>
 <mergeByPoolResult>true</mergeByPoolResult>
 </ns1:mergeByPoolResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope> 

Parameters

• int pool_id: ID of the target group, in which profile should be updated
• string key_attribute_name: Name of the pool attribute used to check whether a profile already exists. If an empty string is transferred, the profiles are always created again.
• string[] attributes: List of pool attribute names which are to be used for the import or update. If key_attribute_name is not empty, it must also be listed here
• string[][] data: List of lists of profile data. Each entry in the first dimension of the list represents a profile to be created or updated. The values of the list of the second dimension must be transferred in the exact order in which the names of the attributes are specified under attributes
• bool merge: Determines whether values of multiple selection fields should be merged or overwritten by the data from the request
• bool ignore_missing: Defines whether profiles that do not already exist in the pool are to be ignored or created

Return value

• MassUpdateResult: Object with the following attributes:
  • EvalancheHashMap updated: List of EvalancheHashMapItems where the attribute key contains the profile ID of the updated profile, the attribute value contains the value of the field from key_attribute_name
  • EvalancheHashMap created: List of EvalancheHashMapItems where the attribute key contains the profile ID of the newly created profile, the attribute value contains the value of the field from key_attribute_name
  • string[] ignored: List of values of key_attribute_name for which the corresponding profiles were not updated. This case can occur when updating a profile with unchanged data, or if ignore_missing == true and no profile was found using key_attribute_name
  • int[] error: List of record numbers from data beginning with 0, where an error has occurred

Required rights

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prof="https://scnem.com/soap.php/soap/profile">
   <soapenv:Header/>
   <soapenv:Body>
      <prof:massUpdate>
         <pool_id>POOL_ID</pool_id>
         <key_attribute_name>EXTERNALID</key_attribute_name>
         <attributes>
            <!--Zero or more repetitions:-->
            <item>EXTERNALID</item>
            <item>EMAIL</item>
            <item>FIRSTNAME</item>
            <item>NAME</item>
            <item>SALUTATION</item>
         </attributes>
         <data>
            <!--Zero or more repetitions:-->
            <item>
               <!--Zero or more repetitions:-->
               <item>47-11</item>
               <item>julien.bashir@example.com</item>
               <item>Julien</item>
               <item>Bashir</item>
               <item>1</item>
            </item>
            <item>
               <!--Zero or more repetitions:-->
               <item>47-12</item>
               <item>william.picard@example.com</item>
               <item>William</item>
               <item>Picard</item>
               <item>2</item>
            </item>
            <item>
               <!--Zero or more repetitions:-->
               <item>48-11</item>
               <item>benjamin.sisko@example.com</item>
               <item>Benjamin</item>
               <item>Sisko</item>
               <item>2</item>
            </item>
            <item>
               <!--Zero or more repetitions:-->
               <item>48-11</item>
               <item>benjamin.sisko@example.com</item>
               <item>Benjamin</item>
               <item>Sisko</item>
            </item>
         </data>
         <merge>true</merge>
         <ignore_missing>false</ignore_missing>
      </prof:massUpdate>
   </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/profile">
   <SOAP-ENV:Body>
      <ns1:massUpdateResponse>
         <massUpdateResult>
            <updated>
               <items>
                  <item>
                     <key>5718855</key>
                     <value>47-11</value>
                  </item>
               </items>
            </updated>
            <created>
               <items>
                  <item>
                     <key>5718856</key>
                     <value>47-13</value>
                  </item>
               </items>
            </created>
            <ignored>
               <item>47-12</item>
            </ignored>
            <error>
                <item>3</item>
            </error>
         </massUpdateResult>
      </ns1:massUpdateResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameters

• int profile_id: ID of the profile for which the status is to be queried
• int mailing_id: ID of the direct mailing for which the status is to be queried. If 0 is transferred as the ID, the system checks all the direct mailshots that were sent to the profile.

Return value

• EvalancheProfileMailingStatus2: An object of the type EvalancheJobResult with the following attributes:
  • int profile_id: ID of the requested profile
  • int newsletter_id: ID of the requested shipment
  • int last_status_change: Unix timestamp (UTF-8) of the last status change of the profile in relation to the mailing
  • int status: Current status of the profile in relation to the mailing
  • string preview_url: Personalized preview URL of the mailing
  • EvalancheHashMap profile_data: Always empty with this method

Required rights

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prof="https://scnem.com/soap.php/soap/profile">
 <soapenv:Header/>
 <soapenv:Body>
 <prof:getMailingStatus>
 <profile_id>PROFILE_ID</profile_id>
 <mailing_id>MAILING_ID</mailing_id>
 </prof:getMailingStatus>
 </soapenv:Body>
</soapenv:Envelope> 

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/profile">
 <SOAP-ENV:Body>
 <ns1:getMailingStatusResponse>
 <getMailingStatusResult>
 <item>
 <profile_id>PROFILE_ID</profile_id>
 <newsletter_id>MAILING_ID</newsletter_id>
 <last_status_change>TIMESTAMP_LAST_STATUS_CHANGE</last_status_change>
 <status>STATUS 1/0</status>
 <preview_url>PREVIEW_URL</preview_url>
 <profile_data>
 <items/>
 </profile_data>
 </item>
 </getMailingStatusResult>
 </ns1:getMailingStatusResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope> 

Parameters

• int profile_id: Id of the profile
• int from = 0: UTC Unix Timestamp, from which time on tracking data should be considered
• int to = 0: UTC Unix timestamp, up to and including which time tracking data should be considered

Return value

• EvalancheMailingTrackingHistory[]: List of objects with the following attributes:
  • int id: Unique Id of the tracking data record
  • int resource_id: Unique Id of the tracked object
  • string resource_name: Name of the tracked object
  • int resource_type_id: Unique ID of the tracked object type
  • int sub_resource_id: Unique ID of the object involved (e.g. article within an e-mailing)
  • string sub_resource_name: Name of the object involved
  • int sub_resource_type_id: Type of object involved
  • string sub_url: Involved direct URL
  • int profile_id: Unique Id of the tracked profile
  • int type: Type of tracking
  • int timestamp: Unix timestamp of the tracking
  • string referrer_domain: Involved domain

Required rights

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prof="https://scnem.com/soap.php/soap/profile">
 <soapenv:Header/>
 <soapenv:Body>
 <prof:getTrackingHistory>
 <profile_id>PROFILE_ID</profile_id>
 <from>TIMESTAMP_FROM</from>
 <to>TIMESTAMP_TO</to>
 </prof:getTrackingHistory>
 </soapenv:Body>
</soapenv:Envelope> 

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/profile">
 <SOAP-ENV:Body>
 <ns1:getTrackingHistoryResponse>
 <getTrackingHistoryResult>
 <item>
 <id>TRACKING_ID</id>
 <resource_id>RESOURCE_ID</resource_id>
 <resource_name>RESOURCE_NAME</resource_name>
 <resource_type_id>RESOURCE_TYPE_ID</resource_type_id>
 <sub_resource_id>SUB_RESOURCE_ID</sub_resource_id>
 <sub_resource_name>SUB_RESOURCE_NAME</sub_resource_name>
 <sub_resource_type_id>SUB_RESOURCE_TYPE_ID</sub_resource_type_id>
 <sub_url>SUB_URL</sub_url>
 <profile_id>PROFILE_ID</profile_id>
 <type>TRACKING_TYPE_ID</type>
 <timestamp>TRACKING_TIMESTAMP</timestamp>
 <referrer_domain>REFERRER_DOMAIN</referrer_domain>
 </item>
 </getTrackingHistoryResult>
 </ns1:getTrackingHistoryResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameters

• int profile_id: ID of the profile for which the status is to be queried

Return value

• ProfileGroupScore[]: A list of objects with the following attributes:
  • int profile_id: ID of the requested profile
  • int group_id: ID of the scoring group
  • string group_name: Name of the scoring group
  • int activity_score: Sum of all activity scores of the profile in relation to the above-mentioned scoring group
  • int profile_score: Sum of all profile scores of the profile in relation to the above-mentioned scoring group

Required rights

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prof="https://scnem.com/soap.php/soap/profile">
 <soapenv:Header/>
 <soapenv:Body>
 <prof:getScores>
 <profile_id>PROFILE_ID</profile_id>
 </prof:getScores>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/profile">
 <SOAP-ENV:Body>
 <ns1:getScoresResponse>
 <getScoresResult>
 <item>
 <profile_id>PROFILE_ID</profile_id>
 <group_id>SCORING_GROUP_ID</group_id>
 <group_name>SCORING_GROUP_NAME</group_name>
 <activity_score>ACTIVITY_SCORE</activity_score>
 <profile_score>PROFILE_SCORE</profile_score>
 </item>
[...]
 </getScoresResult>
 </ns1:getScoresResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope> 

Parameters

• int profile_id: ID of the profile for which the scoring history is to be queried
• int scoring_group_id: ID of the scoring group for which the scoring history for the profile is to be queried. If 0 is transferred here, no restriction is made.
• int scoring_type_id: ID of the scoring type for which the scoring history for the profile is to be queried. If 0 is transferred here, no restriction is made.
• int resource_id: ID of the resource for which the scoring history for the profile is to be queried. If 0 is transferred here, no restriction is made.
• int start_timestamp = 0: Unix Timestamp (UTC) of the time from which the scoring history for the profile should be returned.
• int end_timestamp = 0: Unix Timestamp (UTC) of the time up to and including which the scoring history for the profile should be returned. If 0 is passed here, the current time is used

Return value

• ProfileGroupScore[]: A list of objects with the following attributes:
  • int id: ID of the scoring entry
  • int scoring_group_id: ID of the scoring group
  • int scoring_type_id: ID of the scoring type
  • int timestamp: Unix timestamp (UTC) of the entry
  • int value: Value (score) of the entry
  • int resource_id: ID of the resource for which the entry was created

Values of scoring_type_id

Required rights

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prof="https://scnem.com/soap.php/soap/profile">
 <soapenv:Header/>
 <soapenv:Body>
 <prof:getActivityScoringHistory>
 <profile_id>PROFILE_ID</profile_id>
 <scoring_group_id>SCORING_GROUP_ID</scoring_group_id>
 <scoring_type_id>SCORING_TYPE_ID</scoring_type_id>
 <resource_id>RESOURCE_ID (FILTER)</resource_id>
 <start_timestamp>TIMESTAMP_START_TIME</start_timestamp>
 <end_timestamp>TIMESTAMP_END_TIME</end_timestamp>
 </prof:getActivityScoringHistory>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/profile">
 <SOAP-ENV:Body>
 <ns1:getActivityScoringHistoryResponse>
 <getActivityScoringHistoryResult>
 <item>
 <id>SCORING_ENTRY_ID</id>
 <scoring_group_id>SCORING_GROUP_ID</scoring_group_id>
 <scoring_type_id>SCORING_TYPE_ID</scoring_type_id>
 <timestamp>SCORING_ENTRY_TIMESTAMP</timestamp>
 <value>ACTIVITY_SCORING_POINTS</value>
 <resource_id>SCORING_ENTRY_RESOURCE</resource_id>
 </item>
 </getActivityScoringHistoryResult>
 </ns1:getActivityScoringHistoryResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameters

• int profile_id: ID of the profile for which the score value is to be written
• int scoring_group_id: ID of the scoring group to which the score value is to be assigned
• int score: Positive or negative score value. If 0 is transferred, the configured default score is used
• string name: Optional description of the score value. If an empty string is passed here, the configured default name is used

Return value

• bool: true in case of success

Required rights

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prof="https://scnem.com/soap.php/soap/profile">
 <soapenv:Header/>
 <soapenv:Body>
 <prof:addScore>
 <profile_id>PROFILE_ID</profile_id>
 <scoring_group_id>SCORING_GROUP_ID</scoring_group_id>
 <score>SCORING_POINTS</score>
 <name>SCORING_DESCRIPTION</name>
 </prof:addScore>
 </soapenv:Body>
</soapenv:Envelope> 

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/profile">
 <SOAP-ENV:Body>
 <ns1:addScoreResponse>
 <addScoreResult>true</addScoreResult>
 </ns1:addScoreResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameter2

• int profile_id: ID of the profile to be checked
• int milestone_id: ID of the milestone to be checked
• int from: Timestamp after which the milestone was assigned to the profile.
• int to: Timestamp up to which the milestone was assigned to the profile.

Return value

• bool: true in case of success

Required rights

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prof="https://scnem.com/soap.php/soap/profile">
<soapenv:Header/>
<soapenv:Body>
<prof:hasMilestone>
<profile_id>PROFILE_ID</profile_id>
<milestone_id>MILESTONE_ID</milestone_id>
<from>TIMESTAMP</from>
<to>TIMESTAMP</to>
</prof:hasMilestone>
</soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/profile">
<SOAP-ENV:Body>
<ns1:hasMilestoneResponse>
<hasMilestoneResult>TRUE</hasMilestoneResult>
</ns1:hasMilestoneResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameters

• int profile_id: ID of the profile to which the milestone is to be assigned
• int milestone_id: ID of the milestone to be assigned to the profile

Return value

• bool: true in case of success

Required rights

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prof="https://scnem.com/soap.php/soap/profile">
<soapenv:Header/>
<soapenv:Body>
<prof:hasMilestone>
<profile_id>PROFILE_ID</profile_id>
<milestone_id>MILESTONE_ID</milestone_id>
<from>TIMESTAMP</from>
<to>TIMESTAMP</to>
</prof:hasMilestone>
</soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/profile">
<SOAP-ENV:Body>
<ns1:hasMilestoneResponse>
<hasMilestoneResult>TRUE</hasMilestoneResult>
</ns1:hasMilestoneResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameters

• int milestone_id: ID of the Milestone whose profiles are to be read out.
• string[] pool_attribute_list: List of attribute names to be returned in the result (mandatory)
• int from: Timestamp from which the profile was assigned to the milestone.
• int to: Timestamp until when the profile was assigned to the milestone at the latest.

Return value

• EvalancheJobHandle: An object of type EvalancheJobHandle with the following attributes:
  • string id: The ID of the background job
  • int status: The status of the background job with the possible values:
    • 0: Waiting queue
    • 1: In process
    • 2: Finished
    • 3: Temporary error (processing is repeated)
    • 4: Error
• string status_description: Status description
• namespace: Namespace under which the background job was started, here always profile
• string method: Name of the method which started the background job, here always getByPool
• int resource_id: ID of the resource for which the background job was started, here always the pool_id
• int result_chunks: Number of result blocks found. This value is unequal to 0 only in status 2

Required rights

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prof="https://scnem.com/soap.php/soap/profile">
<soapenv:Header/>
<soapenv:Body>
<prof:getByMilestone>
<milestone_id>MILESTONE_ID</milestone_id>
<pool_attribute_list>
<!--One or more repetitions:-->
<item>ATTRIBUTE</item>
</pool_attribute_list>
<from>TIMESTAMP</from>
<to>TEIMSTAMP</to>
</prof:getByMilestone>
</soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/profile">
<SOAP-ENV:Body>
<ns1:getByMilestoneResponse>
<getByMilestoneResult>
<id>JOB_ID</id>
<status>STATUS</status>
<status_description>DESCRIPTION</status_description>
<namespace>profile</namespace>
<method>getByMilestone</method>
<resource_id>RESOURCE_ID</resource_id>
<result_chunks>CHUNK_COUNT</result_chunks>
</getByMilestoneResult>
</ns1:getByMilestoneResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>