The following SOAP methods are provided specifically for interaction with folders/categories.
create
Create a folder
EvalancheCategory create( string name, int parent_category_id )
Details
Parameters
- string name: Name of the folder
- int parent_category_id: ID of the parent folder
Return value
- EvalancheCategory: Object with the following attributes:
- int id: Id of the folder
- string name: Name of the folder
- int parent_id: Id of the parent folder
Required rights
Create folder
Use
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cat="https://scnem.com/soap.php/soap/category">
<soapenv:Header/>
<soapenv:Body>
<cat:create>
<name>CATEGORY_NAME</name>
<parent_category_id>PARENT_CATEGORY_ID</parent_category_id>
</cat: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/category">
<SOAP-ENV:Body>
<ns1:createResponse>
<createResult>
<id>CATEGORY_ID</id>
<name>CATEGORY_NAME</name>
<parent_id>PARENT_CATEGORY_ID</parent_id>
</createResult>
</ns1:createResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
getDetails
Find folder details by folder ID
EvalancheCategory getDetails( int category_id )
Details
Parameters
- int category: ID of the folder
Return value
- EvalancheCategory: Object with the following attributes:
- int id: Id of the folder
- string name: Name of the folder
- int parent_id: Id of the parent folder
Required rights
none
Use
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cat="https://scnem.com/soap.php/soap/category">
<soapenv:Header/>
<soapenv:Body>
<cat:getDetails>
<category_id>CATEGORY_ID</category_id>
</cat:getDetails>
</soapenv:Body>
</soapenv:Envelope>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/category">
<SOAP-ENV:Body>
<ns1:getDetailsResponse>
<getDetailsResult>
<id>CATEGORY_ID</id>
<name>CATEGORY_NAME</name>
<parent_id>PARENT_CATEGORY_ID</parent_id>
</getDetailsResult>
</ns1:getDetailsResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
getSubCategories
Find subfolders by folder ID
EvalancheCategory getSubCategories( int category_id )
Details
Parameters
- int category: ID of the folder
Return value
- EvalancheCategory: array item with the following attributes:
- int id: Id of the folder
- string name: Name of the folder
- int parent_id: Id of the parent folder
Required rights
none
Use
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cat="https://scnem.com/soap.php/soap/category">
<soapenv:Header/>
<soapenv:Body>
<cat:getSubCategories>
<category_id>CATEGORY_ID</category_id>
</cat:getSubCategories>
</soapenv:Body>
</soapenv:Envelope>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/category">
<SOAP-ENV:Body>
<ns1:getSubCategoriesResponse>
<getSubCategoriesResult>
<item>
<id>CATEGORY_ID</id>
<name>CATEGORY_NAME</name>
<parent_id>PARENT_CATEGORY_ID</parent_id>
</item>
[...]
</getSubCategoriesResult>
</ns1:getSubCategoriesResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>