copy
Creates a copy of the resource specified by resource_id
EvalancheResourceInformation copy (int resource_id, int category_id)Details
Parameter
- int resource_id: ID of the resource to be copied
- int category_id: ID of folder
Return value
- object: EvalancheResourceInformation:
- string: url
- int: type_id
- int: category_id
- int: last_modified
- int: resource_id
- string: name
Required rights
Create <object>
Use
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:lead="https://scnem.com/soap.php/soap/leadpage">
<soapenv:Header />
<soapenv:Body>
<lead:copy>
<resource_id>RESOURCE_ID</resource_id>
<category_id>CATEGORY_ID</category_id>
</lead:copy>
</soapenv:Body>
</soapenv:Envelope>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/leadpage">
<SOAP-ENV:Body>
<ns1:copyResponse>
<copyResultv
<url>URL</url>
<type_id>TYPE_ID</type_id>
<category_id>CATEGORY_ID</category_id>
<customer_id>CUSTUMER_ID</customer_id>
<last_modified>LAST_MODIFIED</last_modified>
<id>RESOURCE_ID</id>
<name>NAME</name>
</copyResult>
</ns1:copyResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
delete
Deletes the resource.
bool delete (int resource_id)Details
Parameter
- int resource_id: ID of the resource to be deleted
Return value
- bool: true if deletion was successful
Required rights
Manage object
Use
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:lead="https://scnem.com/soap.php/soap/leadpage">
<soapenv:Header />
<soapenv:Body>
<lead:delete>
<resource_id>OBJECT_ID</resource_id>
</lead:delete>
</soapenv:Body>
</soapenv:Envelope>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/leadpage">
<SOAP-ENV:Body>
<ns1:deleteResponse>
<deleteResult>true</deleteResult>
</ns1:deleteResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
getAll
Lists all resources within a client.
ArrayOfEvalancheResourceInformation getAll (int mandator_id)Details
Parameter
- int mandator_id: ID of client
Return value
- ArrayOfEvalancheResourceInformation Object array analogous to the getById method (querying information about an object using the object ID)
Required rights
no object rights required
Use
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:lead="https://scnem.com/soap.php/soap/leadpage">
<soapenv:Header />
<soapenv:Body>
<lead:getAll>
<mandator_id>MANDATOR_ID</mandator_id>
</lead:getAll>
</soapenv:Body>
</soapenv:Envelope>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/leadpage">
<SOAP-ENV:Body>
<ns1:getAllResponse>
<getAllResult>
<item>
<url>URL</url>
<type_id>TYPE_ID</type_id>
<category_id>CATEGORY_ID</category_id>
<customer_id>CUSTUMER_ID</customer_id>
<last_modified>LAST_MODIFIED</last_modified>
<id>RESOURCE_ID</id>
<name>NAME</name>
</item>
<item>
... </item>
</getAllResult>
</ns1:getAllResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
getByCategory
Returns all objects of a folder
ArrayOfEvalancheResourceInformation[] getByCategory(int category_id)Details
Parameters
- int category_id: Id of folder
Return value
- ArrayOfEvalancheResourceInformation[]: Array of objects with following attributes:
- string url: URL of object
- int type_id: Type-Id of object
- int category_id: Folder-Id of object
- int customer_id:Mandantor-Id of object
- int id: object-Id
- string name: Name of object
Required rights
Display object
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>
<mail:getByCategory>
<category_id>CATEGORY_ID</category_id>
</mail:getByCategory>
</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:getByCategoryResponse>
<getByCategoryResult>
<item>
<url>OBJECT_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>
</getByCategoryResult>
</ns1:getByCategoryResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope></SOAP-ENV:Envelope>
Reading the type Ids belonging to an object class
Method:
EvalancheResourceTypeInformation[] getTypeIds() Return value:
EvalancheResourceTypeInformation[]
This method is required for namespaces that manage more than one type of resource, such as in mailing.
Required rights:
none
Rename an object
Method:
EvalancheResourceTypeInformation[] rename(int resource_id, str name) Return value:
EvalancheResourceInformation
This method renames a resource.
Rights required:
Manage resource
Reading the default folder of an object class
Method:
EvalancheCategoryInformation getResourceDefaultCategory(int mandator_id)Return value:
EvalancheCategoryInformation
- int id
- string name
Required rights:
none
Query information about an object using object Id
Method:
EvalancheResourceInformation getById(int resource_id)Parameters:
int resource_id
Return value:
EvalancheResourceInformation
- int id
- string name
- string url
- int type_id
- int category_id
- int customer_id
Required rights:
none