The following SOAP methods are provided specifically for interaction with containers.
copy
Creates a copy of the resource specified by resource_id
EvalancheResourceInformation copy (int resource_id, int category_id)Details: copy
create
Create container
EvalancheResourceInformation create (int container_preset_id, string name, EvalancheHashMap data, int category_id)Details
Parameters
- int container_preset_id: ID of the container type to be used
- string name: Name of the container
- EvalancheHashMap data: EvalancheHashMap with the data of the container
- int category_id: ID of the folder in which the container is to be created
Return value
- EvalancheResourceInformation: Object analogous to the method getById (retrieve information about an object using object ID)
Required rights
Create container
Use
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="https://scnem.com/soap.php/soap/container">
<soapenv:Header/>
<soapenv:Body>
<con:create>
<container_preset_id>CONTAINER_PRESET_ID</container_preset_id>
<name>CONTAINER_NAME</name>
<data>
<items>
<!--Zero or more repetitions:-->
<item>
<!--You may enter the following 2 items in any order-->
<key>ATTRIBUTE_NAME</key>
<value>ATTRIBUTE_CONTENT</value>
</item>
</items>
</data>
<category_id>FOLDER_ID</category_id>
</con: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/container">
<SOAP-ENV:Body>
<ns1:createResponse>
<createResult>
<url>CONTAINER_URL</url>
<type_id>CONTAINER_TYPE_ID</type_id>
<category_id>FOLDER_ID</category_id>
<customer_id>MANDATOR_ID</customer_id>
<id>CONTAINER_ID</id>
<name>CONTAINER_NAME</name>
</createResult>
</ns1:createResponse>
</SOAP-ENV:Body>
</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
getByCategory
Returns all objects of a folder.
ArrayOfEvalancheResourceInformation getByCategory (int category_id)Details: getByCategory
getByContainerTypeId
Get containers by container type id
EvalancheHashMap getByContainerTypeId(int container_type_id)Details
Parameter
- int container_type_id: ID of the container type to search for
Return value
-
item array of objects with following attributes:
- String url: integration-URL of the container
- int type_id: type-ID of the container
- int category_id: folder-ID of the container
- int customer_id: customer-ID of the container
- unix-timestamp last_modified: last modification date of the container
- int id: object ID of the container
- String name: name of the container
Required rights
Show container
Use
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prof="https://scnem.com/soap.php/soap/profile">
<soapenv:Header/>
<soapenv:Body>
<con:getByContainerTypeId>
<container_type_id>CONTAINER_TYPE_ID</container_type_id>
</con:getByContainerTypeId>
</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:getByContainerTypeIdResponse>
<getByContainerTypeIdResult>
<items>
<item>
<key>ATTRIBUTE_NAME</key>
<value>ATTRIBUTE_VALUE</value>
</item>
[...]
</items>
</getByContainerTypeIdResult>
</ns1:getByContainerTypeIdResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
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: getByModificationDate
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
Reading containers
EvalancheHashMap getData ( int container_id)Details
Parameters
- int container_id: ID of the container
Return value
- EvalancheHashMap: EvalancheHashMap with the data of the container
Required rights
Show container
Use
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="https://scnem.com/soap.php/soap/container">
<soapenv:Header/>
<soapenv:Body>
<con:getData>
<container_id>CONTAINER_ID</container_id>
</con: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/container">
<SOAP-ENV:Body>
<ns1:getDataResponse>
<getDataResult>
<items>
<item>
<key>ATTRIBUTE_NAME</key>
<value>ATTRIBUTE_CONTENT</value>
</item>
[...]
</getDataResult>
</ns1:getDataResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
getDetails
Provides information about container objects
EvalancheContainerInformation getDetails(int container_id)Details
Parameter
- int container_id: Id of container
Rückgabewert
- EvalancheContainerInformation: object (SOAP) or array with following attributes:
- int container_type_id: Id of container type
- string url: URL of container
- int type_id: Type Id
- int category_id: Id of folder
- int customer_id: Mandantor Id
- int last_modified: Timestamp of last modification
- int id: Id of container
- string name: Name of container
Required rights
View container
Use
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://scnem.com/soap.php/soap/mailing">
<soapenv:Header/>
<soapenv:Body>
<container:getDetails>
<container_id>CONTAINER_ID</container_id>
</container: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>
<container_type_id>CONTAINER_TYPE_ID</container_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>
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
update
Update Container
EvalancheResourceInformation update (int container_id, EvalancheHashMap data )Details
Parameters
- int container_id: ID of the container
- EvalancheHashMap data: EvalancheHashMap with the data of the container
Return value
- EvalancheResourceInformation: Object analogous to the method getById (retrieve information about an object using object ID)
Required rights
Change container
Use
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="https://scnem.com/soap.php/soap/container">
<soapenv:Header/>
<soapenv:Body>
<con:update>
<container_id>CONTAINER_ID</container_id>
<data>
<items>
<!--Zero or more repetitions:-->
<item>
<!--You may enter the following 2 items in any order-->
<key>ATTRIBUTE_NAME</key>
<value>ATTRIBUTE_CONTENT</value>
</item>
</items>
</data>
</con:update>
</soapenv:Body>
</soapenv:Envelope> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/container">
<SOAP-ENV:Body>
<ns1:updateResponse>
<updateResult>
<url>CONTAINER_URL</url>
<type_id>CONTAINER_TYPE_ID</type_id>
<category_id>FOLDER_ID</category_id>
<customer_id>MANDATOR_ID</customer_id>
<id>CONTAINER_ID</id>
<name>CONTAINER_NAME</name>
</updateResult>
</ns1:updateResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>