The following SOAP methods are provided specifically for interaction with SmartLinks.
create
New creation of a SmartLink
EvalancheResourceInformation create ( string name, int category_id )
Details
Parameters
- string name: Name of the SmartLink
- int category_id: ID of the folder in which the SmartLink was created
Return value
- string url: External URL of the SmartLink
- int type_id: Type_id of the SmartLink
- int category_id: ID of the folder in which the SmartLink was created
- int customer_id: ID of the client in which the SmartLink was created
- int id: ID of the SmartLink
- string name: Name of the SmartLink
Required rights
Creating SmartLink
Use
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:smar="https://scnem.com/soap.php/soap/smartlink">
<soapenv:Header/>
<soapenv:Body>
<smar:create>
<name>SMARTLINK_NAME</name>
<category_id>FOLDER_ID</category_id>
</smar: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/smartlink">
<SOAP-ENV:Body>
<ns1:createResponse>
<createResult>
<url>SMARTLINK_URL</url>
<type_id>SMARTLINK_TYPE_ID</type_id>
<category_id>FOLDER_ID</category_id>
<customer_id>MANDATOR_ID</customer_id>
<id>SMARTLINK_ID</id>
<name>SMARTLINK_NAME</name>
</createResult>
</ns1:createResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
createLink
Creating a new SmartLink Link
EvalancheResourceInformation createLink ( int smartlink_id, string link_name, string link_url )
Details
Parameters
- int smartlink_id: ID of the SmartLink object in which the new SmartLink Link is to be created
- string link_name: Name of the new SmartLink link
- string link_url: URL of the new SmartLink link
Return value
- string url: Integration URL of the new SmartLink Link
Required rights
Change SmartLink
Use
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:smar="https://scnem.com/soap.php/soap/smartlink">
<soapenv:Header/>
<soapenv:Body>
<smar:createLink>
<smartlink_id>SMARTLINK_ID</smartlink_id>
<link_name>LINK_NAME</link_name>
<link_url>LINK_URL</link_url>
</smar:createLink>
</soapenv:Body>
</soapenv:Envelope><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/smartlink">
<SOAP-ENV:Body>
<ns1:createLinkResponse>
<createLinkResult>SMARTLINK_LINK_TRACKING_URL</createLinkResult>
</ns1:createLinkResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
getTrackingUrls
Reading the integration URLs of a SmartLink
EvalancheResourceInformation getTrackingUrls ( int smartlink_id )
Details
Parameters
- int smartlink_id: ID of the SmartLink object whose integration URLs are to be read
Return value
- int id: ID of the SmartLink link. string name: Name of the SmartLink link
- string name: Name of the SmartLink link
- string url: Integration URL of the SmartLink link
Required rights
Show SmartLink
Use
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:smar="https://scnem.com/soap.php/soap/smartlink">
<soapenv:Header/>
<soapenv:Body>
<smar:getTrackingUrls>
<smartlink_id>SMARTLINK_URL</smartlink_id>
</smar:getTrackingUrls>
</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/smartlink">
<SOAP-ENV:Body>
<ns1:getTrackingUrlsResponse>
<getTrackingUrlsResult>
<item>
<id>SMARTLINK_LINK_ID</id>
<name>SMARTLINK_NAME</name>
<tracking_url>SMARTLINK_LINK_TRACKING_URL</tracking_url>
</item>
[...]
</getTrackingUrlsResult>
</ns1:getTrackingUrlsResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope></SOAP-ENV:Envelope>
getLinkConfigurations
Reading out the link configurations of a SmartLink link
EvalancheResourceInformation getLinkConfigurations(int smartlink_link_id)
Details
Parameter
- int smartlink_link_id: ID of the SmartLink link whose configurations are to be read out.
Return value
- int id: ID of the SmartLink link
- string target_url: URL of the SmartLink link destination
- int restriction_targetgroup_id: ID of the target group to which the target was restricted
- string restriction_useragents: User agent restriction
- int milestone_id: ID of the milestone to be set
- bool activate_redirect: Redirection activation state
- bool activate_profile_update: Profile update activation state
- bool activate_tracking: Tracking activation state
- scoring_configs[] scoring_configs: List of scoring configuration for each scoring group
- int id: ID of the scoring configuration
- string name: Name of the scoring configuration
- int value: Number of scoring points to be awarded
- int multiple_score_time_threshold: Multiple rating option (-1 -> none, 0 -> unlimited, >0 -> Number of seconds of restriction)
Rights required
Show SmartLink
Use
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:smar="https://scnem.com/soap.php/soap/smartlink">
<soapenv:Header/>
<soapenv:Body>
<smar:getLinkConfigurations>
<smartlink_link_id>SMARTLINK_LINK_ID</smartlink_link_id>
</smar:getLinkConfigurations>
</soapenv:Body>
</soapenv:Envelope><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns1="https://scnem.com/soap.php/soap/smartlink">
<SOAP-ENV:Body>
<ns1:getLinkConfigurationsResponse>
<getLinkConfigurationsResult>
<item>
<id>101149</id>
<target_url>https://heise.de</target_url>
<restriction_targetgroup_id>26145439</restriction_targetgroup_id>
<restriction_useragents/>
<milestone_id>MILESTONE_ID</milestone_id>
<activate_redirect>BOOL</activate_redirect>
<activate_profile_update>BOOL</activate_profile_update>
<activate_tracking>BOOL</activate_tracking>
<scoring_configs>
<SOAP-ENC:Struct>
<id>CONFIG_ID</id>
<name/>
<value>SCORING_VALUE</value>
<multiple_score_time_threshold>MULTIPLE_SCORE_TIME_THRESHOLD</multiple_score_time_threshold>
</SOAP-ENC:Struct>
</scoring_configs>
<pool_attributes>PROFILE_CHANGE_CONFIG</pool_attributes>
</item>
[...]
</getLinkConfigurationsResult>
</ns1:getLinkConfigurationsResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
setLinkConfiguration
Reading out the integration URLs of a SmartLink
EvalancheResourceInformation getTrackingUrls (int smartlink_link_id, smartlink_link_config[])
Details
Parameter
- int smartlink_link_id: ID of the SmartLink link which is to be configured.
- smartlink_link_config smartlink_link_id: Configuration of the smart link according to the return of the getLinkConfigurations method.
Return value
- bool: True if the configuration was successfully applied.
Required rights
Change SmartLink
Use
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:smar="https://scnem.com/soap.php/soap/smartlink" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
<soapenv:Header/>
<soapenv:Body>
<smar:setLinkConfigurations>
<smartlink_link_id>SMARTLINK_LINK_ID</smartlink_link_id>
<items>
<!--Zero or more repetitions:-->
<item>
<!--You may enter the following 10 items in any order-->
<id>SMARTLINK_LINK_CONFIG_ID</id>
<target_url>TARGET_URL</target_url>
<restriction_targetgroup_id>TARGETGROUP_ID</restriction_targetgroup_id>
<restriction_useragents/>
<milestone_id>MILESTONE_ID</milestone_id>
<activate_redirect>ACTIVATE_REDIRECT</activate_redirect>
<activate_profile_update>ACTIVATE_PROFILE_UPDATE</activate_profile_update>
<activate_tracking>ACTIVATE_TRACKING</activate_tracking>
<scoring_configs/>
<pool_attributes/>
</item>
</items>
</smar:setLinkConfigurations>
</soapenv:Body>
</soapenv:Envelope><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/smartlink">
<SOAP-ENV:Body>
<ns1:setLinkConfigurationsResponse>
<setLinkConfigurationsResult>true</setLinkConfigurationsResult>
</ns1:setLinkConfigurationsResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
createLinkConfigurations
Adds a destination to a Smartlink link
EvalancheResourceInformation createLinkConfigurations (int smartlink_link_id, smartlink_link_config[])
Details
Parameter
- int smartlink_link_id: ID of the SmartLink link to be configured.
- smartlink_link_config smartlink_link_id: Configuration of the Smartlink link according to the return of the method getLinkConfigurations
Return value
- bool: True if the configuration was successfully applied.
Required rights
Change SmartLink
Use
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:smar="https://scnem.com/soap.php/soap/smartlink" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
<soapenv:Header/>
<soapenv:Body>
<smar:createLinkConfigurations>
<smartlink_link_id>SMARTLINK_LINK_ID</smartlink_link_id>
<items>
<!--Zero or more repetitions:-->
<item>
<!--You may enter the following 10 items in any order-->
<id>SMARTLINK_LINK_CONFIG_ID</id>
<target_url>TARGET_URL</target_url>
<individual_scoring_config>BOOL</individual_scoring_config>
<restriction_targetgroup_id>TARGETGROUP_ID</restriction_targetgroup_id>
<restriction_useragents/>
<milestone_id>MILESTONE_ID</milestone_id>
<activate_redirect>ACTIVATE_REDIRECT</activate_redirect>
<activate_profile_update>ACTIVATE_PROFILE_UPDATE</activate_profile_update>
<activate_tracking>ACTIVATE_TRACKING</activate_tracking>
<scoring_configs>
<SOAP-ENC:Struct>
<id>0</id>
<name>NAME</name>
<value>VALUE</value>
<multiple_score_time_threshold>INT</multiple_score_time_threshold>
<scoring_group_id>SCORING_GROUP_ID</scoring_group_id>
<type>11</type>
</SOAP-ENC:Struct>
</scoring_configs>
<pool_attributes>
<SOAP-ENC:Struct>
<id>0</id>
<pool_id>POOL_ID</pool_id>
<pool_attribute_id>ATTRIBUTE_ID</pool_attribute_id>
<value>VALUE</value>
<is_merge>BOOL</is_merge>
</SOAP-ENC:Struct>
</pool_attributes>
</item>
</items>
</smar:createLinkConfigurations>
</soapenv:Body>
</soapenv:Envelope><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem3.com/soap.php/soap/smartlink">
<SOAP-ENV:Body>
<ns1:createLinkConfigurationsResponse>
<createLinkConfigurationsResult>true</createLinkConfigurationsResult>
</ns1:createLinkConfigurationsResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>