The following SOAP methods are provided specifically for interaction with containers.
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>
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>
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>