getData
Read article data
EvalancheHashMap Artikel::getData(int article_id)
Details
Parameters
- int article_id: ID of the article
Return value
- EvalancheHashMap: EvalancheHashMap with the article data
Required rights
View articles
Usage
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:art="https://scnem.com/soap.php/soap/article">
<soapenv:Header/>
<soapenv:Body>
<art:getData>
<article_id>ARTICLE_ID</article_id>
</art:getData>
</soapenv:Body>
</soapenv:Envelope><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/article">
<SOAP-ENV:Body>
<ns1:getDataResponse>
<getDataResult>
<items>
<item>
<key>ARTICLE_FIELD_NAME</key>
<value>CONTENT</value>
</item>
<item>
<key>ARTICLE_FIELD_NAME</key>
<value>CONTENT</value>
</item>
[...]
</items>
</getDataResult>
</ns1:getDataResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
create
Create article
EvalancheResourceInformation create (int article_preset_id, string name, EvalancheHashMap data, int category_id)
Details
Parameters
- int article_preset_id: ID of the desired article type
- string name: Name of the article
- EvalancheHashMap data: EvalancheHashMap with the article data
- int category_id: ID of the folder in which the article shall be created
Return value
- EvalancheResourceInformation: Object analog to the method getById (Request information about an object via object ID)
Required rights
Create articles
Usage
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:art="https://scnem.com/soap.php/soap/article">
<soapenv:Header/>
<soapenv:Body>
<art:create>
<article_preset_id>ARTICLE_PRESET_ID</article_preset_id>
<name>NAME</name>
<data>
<items>
<!--Zero or more repetitions:-->
<item>
<!--You may enter the following 2 items in any order-->
<key>ARTICLE_FIELD_NAME</key>
<value>CONTENT</value>
</item>
</items>
</data>
<category_id>FOLDER_ID</category_id>
</art:create>
</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/article">
<SOAP-ENV:Body>
<ns1:createResponse>
<createResult>
<url>ARTICLE_URL</url>
<type_id>TYPE_ID</type_id>
<category_id>FOLDER_ID</category_id>
<customer_id>MANDATOR_ID</customer_id>
<id>ARTICLE_ID</id>
<name>ARTICLE_NAME</name>
</createResult>
</ns1:createResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope></SOAP-ENV:Envelope>
update
Update article
EvalancheResourceInformation update (int article_id, EvalancheHashMap data)
Details
Parameters
- int article_id: ID of the article
- EvalancheHashMap data: EvalancheHashMap with the article data
Return value
- EvalancheResourceInformation: Object analog to the method getById (Request information about an object via object ID)
Required rights
Change articles
Usage
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:art="https://scnem.com/soap.php/soap/article">
<soapenv:Header/>
<soapenv:Body>
<art:update>
<article_id>ARTICLE_ID</article_id>
<data>
<items>
<!--Zero or more repetitions:-->
<item>
<!--You may enter the following 2 items in any order-->
<key>ARTICLE_FIELD_NAME</key>
<value>CONTENT</value>
</item>
</items>
</data>
</art:update>
</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/article">
<SOAP-ENV:Body>
<ns1:updateResponse>
<updateResult>
<url>ARTICLE_URL</url>
<type_id>ARTICLE_TYPE</type_id>
<category_id>FOLDER_ID</category_id>
<customer_id>MANDATOR_ID</customer_id>
<id>ARTICLE_ID</id>
<name>ARTICLE_NAME</name>
</updateResult>
</ns1:updateResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope></SOAP-ENV:Envelope>
getIndividualization
Query article individualization
EvalancheResourceInformation getIndividualization (int article_id)
Details
Parameters
- int article_id: ID of the article
Return value
- bool has_fallback: If true, the queried item itself will be displayed if no customization target group applies.
- EvalancheHashMap data: HashMap with article_id and targetgroup_ids of the individualized articles
Required rights
Show article
Usage
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:art="https://scnem.com/soap.php/soap/article">
<soapenv:Header/>
<soapenv:Body>
<art:getIndividualization>
<article_id>ARTICLE_ID</article_id>
</art:getIndividualization>
</soapenv:Body>
</soapenv:Envelope>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/article">
<SOAP-ENV:Body>
<ns1:getIndividualizationResponse>
<getIndividualizationResult>
<has_fallback>BOOL</has_fallback>
<individualization_items>
<item>
<article_id>ARTICLE_ID</article_id>
<targetgroup_id>TARGETGROUP_ID</targetgroup_id>
</item>
[...]
</individualization_items>
</getIndividualizationResult>
</ns1:getIndividualizationResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
setIndividualization
Update article individualization
EvalancheResourceInformation setIndividualization (int article_id, EvalancheHashMap configuration)
Details
Parameters
- int article_id: ID of the article
- EvalancheHashMap configuration: EvalancheHashMap with the data of article individualization
Return value
- bool: True if configuration was successfully updated.
Required rights
Change article
Usage
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:art="https://scnem.com/soap.php/soap/article">
<soapenv:Header/>
<soapenv:Body>
<art:setIndividualization>
<article_id>ARTICLE_ID</article_id>
<configuration>
<!--You may enter the following 2 items in any order-->
<has_fallback>BOOL</has_fallback>
<individualization_items>
<!--Zero or more repetitions:-->
<item>
<!--You may enter the following 2 items in any order-->
<article_id>ARTICLE_ID</article_id>
<targetgroup_id>TARGETGROUP_ID</targetgroup_id>
</item>
[...]
</individualization_items>
</configuration>
</art:setIndividualization>
</soapenv:Body>
</soapenv:Envelope>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/article">
<SOAP-ENV:Body>
<ns1:setIndividualizationResponse>
<setIndividualizationResult>BOOL</setIndividualizationResult>
</ns1:setIndividualizationResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>