copy
Creates a copy of the resource specified by resource_id
EvalancheResourceInformation copy (int resource_id, int category_id)Details: copy
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>
delete
Deletes the resource.
bool delete (int resource_id)Details: delete
getAll
Lists all resources within a client.
ArrayOfEvalancheResourceInformation getAll (int mandator_id)Details: getAll
getByArticleTypeId
Lists all article of a certain article type.
ArrayOfEvalancheResourceInformation[] getByArticleTypeId(int article_type_id)Details
Parameter
- int article_type_id: Id of article type
Rückgabewert
-
ArrayOfEvalancheResourceInformation[]: list of objects with following attributes:
- string url: URL of article
- int type_id: type Id of article
- int category_id: folder Id of article
- int customer_id: mandantor Id of article
- int id: Id of article
- string name: name of article
Required rights
View articles
Use
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://core-staging.dev.broem/soap.php/soap/mailingtemplate">
<soapenv:Header/>
<soapenv:Body>
<article:getByArticleTypeId>
<article_type_id>ARTICLE_TYPE_ID</article_type_id>
</article:getByArticleTypeId>
</soapenv:Body>
</soapenv:Envelope></soapenv:Envelope><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://core-staging.dev.broem/soap.php/soap/mailingtemplate">
<SOAP-ENV:Body>
<ns1:getByArticleTypeIdResponse>
<getByArticleTypeIdResult>
<item>
<url>OBJEKT_URL</url>
<type_id>TYPE_ID</type_id>
<category_id>CATEGORY_ID</category_id>
<customer_id>CUSTOMER_ID</customer_id>
<id>OBJEKT_ID</id>
<name>OBJEKT_NAME</name>
</item>
</getByArticleTypeIdResult>
</ns1:getByArticleTypeIdResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope></SOAP-ENV:Envelope>
getByCategory
Returns all objects of a folder.
ArrayOfEvalancheResourceInformation getByCategory (int category_id)Details: getByCategory
getByExternalId
Outputs all direct mailing templates with a given EXTERNAL_ID.
ArrayOfEvalancheResourceInformation[] getByExternalId ( string external_id )Details: getByExternalId
getById
Searches for a object using an ID.
EvalancheHashMap Profile::getById( int resource_id ) Details: getById
getByModificationDate
Requesting an object via modification date
EvalancheResourceInformation getByModificationDate (int start_date, int end_date, int mandator_id)Details
Parameters
- int start_date: Start date
- int end_date: End date
- int mandator_id: Id of mandator
Rückgabewert
-
item Array of objects with following attributes:.
- String url: Integration-URL of object
- int type_id: Type-Id of object
- int category_id: Folder-Id of object
- int customer_id: Customer-Id of object
- unix-timestamp last_modified: last modification date of object
- int id: Object-Id
- String name: Name of object
Required rights
keine
Use
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:art="https://scnem.com/soap.php/soap/article">
<soapenv:Header />
<soapenv:Body>
<art:getByModificationDate>
<start_date>STARTDATE</start_date>
<end_date>ENDDATE</end_date>
<mandator_id>MANDATOR_ID</mandator_id>
</art:getByModificationDate>
</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:getByModificationDateResponse>
<getByModificationDateResult>
<item>
<url>URL</url>
<type_id>TYPE_ID</type_id>
<category_id>CATEGORY_ID</category_id>
<customer_id>CUSTOMER_ID</customer_id>
<last_modified>CHANGE_DATE</last_modified>
<id>ID</id>
<name>NAME</name>
</item>
<item>
...
</item>
</getByModificationDateResult>
</ns1:getByModificationDateResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
getByTypeId
Retrieve all resources within this namespace with the specified resource type ID (see the getTypeIds method).
ArrayOfEvalancheResourceInformation getByTypeId (int type_id, int mandator_id)Details: getByTypeId
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>
getDetails
Provides information about object
EvalancheArticleInformation getDetails(int object_id)Details
Parameter
- int object_id: Id of object
Return value
- EvalancheArticleInformation: object (SOAP) or array with following attributes:
- int article_type_id: Id of article type
- string url: URL of article
- int type_id: Type Id
- int category_id: Id of article folder
- int customer_id: Mandator Id
- int last_modified: Timestamp of last modification
- int id: Id of article
- string name: Name of article
Required rights
View articles
Use
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://scnem.com/soap.php/soap/mailing">
<soapenv:Header/>
<soapenv:Body>
<article:getDetails>
<article_id>ARTICLE_ID</article_id>
</article:getDetails>
</soapenv:Body>
</soapenv:Envelope><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns1="https://scnem.com/soap.php/soap/mailing">
<SOAP-ENV:Body>
<ns1:getDetailsResponse>
<getDetailsResult>
<article_type_id>ARTICLE_TYPE_ID</article_type_id>
<url>URL</url>
<type_id>TYPE_ID</type_id>
<category_id>CATEGORY_ID</category_id>
<customer_id>CUSTOMER_ID</customer_id>
<report_url>REPORT_URL</report_url>
<last_modified>LAST MODIFIED</last_modified>
<id>ID</id>
<name>NAME</name>
</getDetailsResult>
</ns1:getDetailsResponse>
</SOAP-ENV:Body>
</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
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: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>
getResourceDefaultCategory
Provides information about the default folder of objects
getResourceDefaultCategoryResponse getResourceDefaultCategory (int customer_id)Details: getResourceDefaultCategory
getTypeIds
Reading the type Ids belonging to an object class
ArrayOfEvalancheResourceInformation getTypeIds ()Details: getTypeIds
isAlive
Tests whether the API is available and the credentials used are valid. The `random_message` property of the result is completely irrelevant, since the values are randomly taken from http://whatthecommit.com.
isAliveResponse isAlive ()Details: isAlive
move
Moves the object to another folder
EvalancheResourceInformation move (int resource_id, int category_id)Details: move
rename
Gives the object a different name
EvalancheResourceInformation rename (int resource_id, string name)Details: rename
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
ARTICLE_IDARTICLE_ID<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>
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>