Folgende SOAP-Methoden werden speziell für die Interaktion mit SmartLinks bereitgestellt.
create
Neuanlage eines SmartLinks
EvalancheResourceInformation create (string name, int category_id)
Details
Parameter
- string name: Name des SmartLinks
- int category_id: ID des Ordners in dem der SmartLink erstellt wurde
Rückgabewert
- string url: Externe URL des SmartLinks
- int type_id: Type_id des SmartLinks
- int category_id: ID des Ordners, in dem der SmartLink erstellt wurde
- int customer_id: ID des Mandanten, in dem der SmartLink erstellt wurde
- int id: ID des SmartLinks
- string name: Name des SmartLinks
Benötigte Rechte
SmartLink erzeugen
Verwendung
<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
Neuanlage eines SmartLink-Links
EvalancheResourceInformation createLink (int smartlink_id, string link_name, string link_url)
Details
Parameter
- int smartlink_id: ID des SmartLink Objekts in dem der neue SmartLink-Link angelegt werden soll
- string link_name: Name des neuen SmartLink-Links
- string link_url: URL des neuen SmartLink-Links
Rückgabewert
- string url: Integrations-Url des neuen SmartLink-Links
Benötigte Rechte
SmartLink ändern
Verwendung
<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
Auslesen der Integrations-URLs eines SmartLink
EvalancheResourceInformation getTrackingUrls(int smartlink_id)
Details
Parameter
- int smartlink_id: ID des SmartLink Objekts dessen Integrations-URLs ausgelesen werden sollen
Rückgabewert
- int id: ID des SmartLink-Links. string name: Name des SmartLink-Links
- string name: Name des SmartLink-Links
- string url: Integrations-URL des SmartLink-Links
Benötigte Rechte
SmartLink anzeigen
Verwendung
<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>
getLinkConfigurations
Auslesen der Link-Konfigurationen eines SmartLink-Links
EvalancheResourceInformation getLinkConfigurations(int smartlink_link_id)
Details
Parameter
- int smartlink_link_id: ID des SmartLink-Links dessen Konfigurationen ausgelesen werden sollen
Rückgabewert
- int id: ID des SmartLink-Links
- string target_url: URL des SmartLink-Link-Ziels
- int restriction_targetgroup_id: ID der Zielgruppe, auf die das Ziel eingeschränkt wurde
- string restriction_useragents: Useragent Einschränkung
- int milestone_id: ID des zu setzenden Milestones
- bool activate_redirect: Zustand der Weiterleitungs-Aktivierung
- bool activate_profile_update: Zustand der Profil-Update-Aktivierung
- bool activate_tracking: Zustand der Tracking-Aktivierung
- scoring_configs[] scoring_configs: Liste der Scoring-Konfiguration für jede Scoring-Gruppe
- int id: ID der Scoringkonfiguration
- string name: Name der Scoringkonfiguration
- int value: Anzahl der zu vergebenen Scoring-Punkte
- int multiple_score_time_threshold: Mehrfachbewertungs-Option (-1 -> keine, 0 -> unbegrenzt, >0 -> Anzahl der Sekunden der Beschränkung)
Benötigte Rechte
SmartLink anzeigen
Verwendung
<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>
setLinkConfigurations
Konfigurieren der Integrations-URLs eines existierenden SmartLinks
EvalancheResourceInformation setLinkConfigurations (int smartlink_link_id, smartlink_link_config[])
Details
Parameter
- int smartlink_link_id: ID des SmartLink-Links, welcher konfiguriert werden soll.
- smartlink_link_config smartlink_link_id: Konfiguration des Smartlink-Links entsprechend der Rückgabe der Methode getLinkConfigurations
Rückgabewert
- bool: True, wenn die Konfiguration erfolgreich übernommen wurde.
Benötigte Rechte
SmartLink verändern
Verwendung
<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
Fügt einem Smartlink-link ein Ziel hinzu
EvalancheResourceInformation createLinkConfigurations (int smartlink_link_id, smartlink_link_config[])
Details
Parameter
- int smartlink_link_id: ID des SmartLink-Links, welcher konfiguriert werden soll.
- smartlink_link_config smartlink_link_id: Konfiguration des Smartlink-Links entsprechend der Rückgabe der Methode getLinkConfigurations
Rückgabewert
- bool: True, wenn die Konfiguration erfolgreich übernommen wurde.
Benötigte Rechte
SmartLink verändern
Verwendung
<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>