The following SOAP methods are provided specifically for interaction with container types.
create
Create Container Type
EvalancheResourceInformation create ( string name, int category_id )
Details
Parameters
- string name: Name of the container type
- int category_id: ID of the folder in which the container type 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 Type
Use
<soapenv:envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="https://scnem.com/soap.php/soap/containertype"> <soapenv
:Header/> <soapenv
:Body> <con:
create> <name>CONTAINER_PRESET_NAME</name>
<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/containertype"> <SOAP-ENV
:Body> <ns1:
createResponse> <createResult>
<url>CONTAINER_URL</url>
<type_id>CONTAINER_PRESET_TYPE_ID</type_id>
<category_id>FOLDER_ID</category_id>
<customer_id>MANDATOR_ID</customer_id> <id>CONTAINER_PRESET_ID</id>
<name>CONTAINER_PRESET_NAME</name>
</createResult> </ns1:
createResponse> </SOAP-ENV
:Body> </SOAP-ENV
:Envelope>
getAttributes
Querying Container Type Attributes
EvalancheResourceInformation getAttributes ( int resource_id )
Details
Parameters
- int resource_id: ID of the container type
Return value
- EvalancheContainertypeAttributes[]: List of objects with the following attributes:
- id: ID of the attribute
- name: Name of the attribute
- label: Label of the attribute
- type_id: ID of the attribute type
- group_id: ID of the group of the attribute
- help_text: Help text of the attribute
- input_help_text: Input help text of the attribute
- mandatory: Mandatory field option of the attribute
- visible: Display option of the attribute
- replacement_variable: Replacement variable of the attribute
- allows_options: Option investment Possibility
Required rights
Show container type
Use
<soapenv:envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="https://scnem.com/soap.php/soap/containertype"> <soapenv
:Header/> <soapenv
:Body> <con:getAttributes>
<resource_id>CONTAINER_PRESET_ID</resource_id>
</con:getAttributes> </soapenv:
Body> </soapenv:Envelope> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/containertype"> <SOAP-ENV
:Body> <ns1:
getAttributesResponse> <getAttributesResult>
<item> <id>ATTRIBUTE_ID</id>
<name>ATTRIBUTE_NAME</name>
<label>ATTRIBUTE_LABEL>/label> <type_id>ATTRIBUTE_TYPE_ID>/type_id>
<group_id>GROUP_ID>/group_id>
<
help_text/> <input_help_text/>
<mandatory>MANDATORY>/mandatory>
<visible>VISIBLE>/visible>
<replacement_variable>
ATTRIBUTE_REPLACEMENT_VARIABLE</replacement_variable> <allows_options>ALLOW_OPTIONS</allows_options>
</item> [.
...]
</getAttributesResult> </ns1
:getAttributesResponse> </SOAP-ENV:
Body> </SOAP-ENV:Envelope>
addAttributes
Creating Container Type Attributes
EvalancheResourceInformation addAttribute ( int resource_id, string name )
Details
Parameters
- int resource_id: ID of the container type
- string name: Name of the new attribute
- string label: Label of the new attribute
- string type_id: ID of the attribute type of the new attribute
- string group_id: ID of the group of the new attribute
Return value
- EvalancheContainertypeAttributes[]: List of objects with the following attributes:
- id: ID of the new attribute
- name: Name of the new attribute
- label: Label of the new attribute
- type_id: ID of the attribute type of the new attribute
- group_id: ID of the group of the new attribute
- help_text: Help text of the new attribute
- input_help_text: Input help text of the new attribute
- mandatory: Mandatory field option of the new attribute
- visible: Display option of the new attribute
- replacement_variable: Replacement variable of the new attribute
- allows_options: Option investment Possibility
Required rights
Show container type
Use
<soapenv:envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="https://scnem.com/soap.php/soap/containertype"> <soapenv
:Header/> <soapenv
:Body> <con:
addAttributes> <resource_id>CONTAINER_TYPE_ID</resource_id>
<name>ATTRIBUTE_NAME</name>
<label>
ATTRIBUTE_LABEL</label> <type_id>ATTRIBUTE_TYPE_ID</type_id>
<group_id>ATTRIBUTE_GROUP_ID</group_id>
</con:
addAttributes> </soapenv
:Body> </soapenv
:Envelope> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/containertype"> <SOAP-ENV
:Body> <ns1:
addAttributeResponse> <addAttributeResult>
<id>ATTRIBTUE_ID</id>
<name>ATTRIBUTE_NAME</name>
<label>
ATTRIBUTE_LABEL</label> <type_id>ATTRIBUTE_TYPE_ID</type_id>
<group_id>ATTRIBUTE_GROUP_ID</group_id>
<help_text/>
<input_help_text/> <mandatory>MANDATORY>/mandatory>
<visible>VISIBLE>/visible>
<replacement_variable>
ATTRIBUTE_REPLACEMENT_VARIABLE</replacement_variable> <allows_options>false</allows_options>
</addAttributeResult>
</ns1:
addAttributeResponse> </SOAP-ENV
:Body> </SOAP-ENV
:Envelope>
updateAttributes
Changing Container Type Attributes
EvalancheResourceInformation updateAttributes ( int resource_id, int attribute_id, EvalancheHashMap data, string name )
Details
Parameters
- int resource_id: ID of the container type
- int attribute_id: ID of the attribute to be changed
- EvalancheHashMap data: EvalancheHashMap with the data of the container
Return value
- EvalancheContainertypeAttributes[]: List of objects with the following attributes:
- id: ID of the changed attribute
- name: Name of the modified attribute
- label: Label of the modified attribute
- type_id: ID of the attribute type of the changed attribute
- group_id: ID of the group of the changed attribute
- help_text: Help text of the changed attribute
- input_help_text: Input help text of the changed attribute
- mandatory: Mandatory field option of the modified attribute
- visible: Display option of the changed attribute
- replacement_variable: Replacement variable of the modified attribute
- allows_options: Option investment Possibility
Required rights
Change container type
Use
<soapenv:envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="https://scnem.com/soap.php/soap/containertype"> <soapenv
:Header/> <soapenv
:Body> <con:updateAttribute>
<resource_id>CONTAINER_PRESET_ID</resource_id>
<attribute_id>ATTRIBUTE_ID</attribute_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
:
updateAttributes> </soapenv
:Body> </soapenv
:Envelope> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/containertype"> <SOAP-ENV
:Body> <ns1:
updateAttributeResponse> <updateAttributeResult>
<id>ATTRIBUTE_ID</id>
<name>ATTRIBUTE_NAME</name>
<label>
ATTRIBUTE_LABEL</label> <type_id>ATTRIBUTE_TYPE_ID</type_id>
<group_id>ATTRIBUTE_GROUP_ID</group_id>
<help_text/>
<input_help_text/> <mandatory>MANDATORY>/mandatory>
<visible>VISIBLE>/visible>
<replacement_variable>
REPLACEMENT_VARIABLE</replacement_variable> <allows_options>ALLOW_OPTIONS</allows_options>
</updateAttributeResult>
</ns1:
updateAttributeResponse> </SOAP-ENV
:Body> </SOAP-ENV
:Envelope>
removeAttribute
Remove Container Type attribute
EvalancheResourceInformation removeAttribute ( int resource_id, int attribute_id )
Details
Parameters
- int resource_id: ID of the container type from which the attribute is to be removed
- int attribute_id: ID of the attribute to be removed
Return value
- removeAttributeResult: True/False if the removal was successful
Required rights
Change container type
Use
<soapenv:envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="https://scnem.com/soap.php/soap/containertype"> <soapenv
:Header/> <soapenv
:Body> <con:
removeAttribute> <resource_id>CONTAINER_PRESET_ID</resource_id>
<attribute_id>ATTRIBUTE_ID</attribute_id>
</con:removeAttribute> </soapenv
:Body> </soapenv:Envelope> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/containertype"> <SOAP-ENV
:Body> <ns1:
removeAttributeResponse> <removeAttributeResult>true/false</removeAttributeResult>
</ns1:removeAttributeResponse>
</SOAP-ENV:Body> </SOAP-ENV:Envelope>
getAttributeGroups
Query attribute group
EvalancheResourceInformation getAttributeGroups ( int resource_id )
Details
Parameters
- int resource_id: ID of the container type
Return value
- EvalancheContainertypeGroups[]: List of objects with the following attributes:
- id: ID of the attribute group
- name: Name of the attribute group
- sort_order: Position in the order of the attribute groups
Required rights
Show container type
Use
<soapenv:envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="https://scnem.com/soap.php/soap/containertype"> <soapenv
:Header/> <soapenv
:Body> <con:getAttributeGroups>
<resource_id>CONTAINER_PRESET_ID</resource_id>
</con:getAttributeGroups> </soapenv
:Body> </soapenv:Envelope> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/containertype"> <SOAP-ENV
:Body> <ns1:
getAttributeGroupsResponse> <getAttributeGroupsResult>
<item> <id>GROUP_ID</id>
<name>GROUP_NAME</name> <sort_order>SORT_ORDER</sort_order>
</item>
</getAttributeGroupsResult> </ns1:
getAttributeGroupsResponse> </SOAP-ENV
:Body> </SOAP-ENV
:Envelope>
addAttributeGroup
Create attribute group
EvalancheResourceInformation addAttributeGroup ( int resource_id, string name )
Details
Parameters
- int resource_id: ID of the container type
- string name: Name of the attribute group
Return value
- EvalancheContainertypeGroups[]: List of objects with the following attributes:
- id: ID of the new attribute group
- name: Name of the attribute group
- sort_order: Position in the order of the attribute groups
Required rights
Change container type
Use
<soapenv:envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="https://scnem.com/soap.php/soap/containertype"> <soapenv
:Header/> <soapenv
:Body> <con:
addAttributeGroup> <resource_id>CONTAINER_PRESET_ID</resource_id>
<name>GROUP_NAME</name>
</con:addAttributeGroup> </soapenv
:Body> </soapenv:Envelope> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/containertype"> <SOAP-ENV
:Body> <ns1:
addAttributeGroupResponse> <addAttributeGroupResult>
<id>GROUP_ID</id>
<name>GROUP_NAME</name>
<sort_order>SORT_ORDER</sort_order>
</addAttributeGroupResult> </ns1:
addAttributeGroupResponse> </SOAP-ENV
:Body> </SOAP-ENV
:Envelope>
removeAttributeGroup
Remove Attribute Group
EvalancheResourceInformation removeAttributeGroup ( int resource_id, int attribute_group_id )
Details
Parameters
- int resource_id: ID of the container type
- int attribute_group_id: ID of the attribute group
Return value
- removeAttributeResult: True/False if the removal was successful
Required rights
Change container type
Use
<soapenv:envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="https://scnem.com/soap.php/soap/containertype"> <soapenv
:Header/> <soapenv
:Body> <con:
removeAttributeGroup> <resource_id>CONTAINER_PRESET_ID</resource_id>
<attribute_group_id>ATTRIBUTE_GROUP_ID</attribute_group_id>
</con:removeAttributeGroup>
</soapenv:Body> </soapenv:Envelope> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/containertype"> <SOAP-ENV
:Body> <ns1:
removeAttributeGroupResponse> <removeAttributeGroupResult>true/false</removeAttributeGroupResult>
</ns1:
removeAttributeGroupResponse> </SOAP-ENV
:Body> </SOAP-ENV
:Envelope></SOAP-ENV:Envelope>
getAttributeOptions
Querying Attribute Options
EvalancheResourceInformation getAttributeOptions ( int resource_id, int attribute_id )
Details
Parameters
- int resource_id: ID of the container type from which the attribute options are to be retrieved
- int attribute_id: ID of the attribute from which the attribute options are to be retrieved
Return value
- EvalancheContainertypeAttributeOptions[]: List of objects with the following attributes:
- id: ID of the attribute option
- name: Name of the attribute option
- label: Label of the attribute option
- order: Position in the order
Required rights
Show container type
Use
<soapenv:envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="https://scnem.com/soap.php/soap/containertype"> <soapenv
:Header/> <soapenv
:Body> <con:
getAttributeOptions> <resource_id>CONTAINER_PRESET_ID</resource_id>
<attribute_id>ATTRIBUTE_ID</attribute_id>
</con:getAttributeOptions>
</soapenv:Body> </soapenv:Envelope> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/containertype"> <SOAP-ENV
:Body> <ns1:
getAttributeOptionsResponse> <getAttributeOptionsResult>
<item> <id>ATTRIBUTE_OPTION_ID</id>
<name>
ATTRIBUTE_OPTION_NAME</name> <label>ATTRIBUTE_OPTION_LABEL</label>
<order>SORT_ORDER</order>
</item> [.
..]
</getAttributeOptionsResult> </ns1
:getAttributeOptionsResponse> </SOAP-ENV:
Body> </SOAP-ENV:Envelope>
createAttributeOption
Create Attribute Option
EvalancheResourceInformation createAttributeOption ( int resource_id, int attribute_id, string label )
Details
Parameters
- int resource_id: ID of the container type
- int attribute_id: ID of the attribute
- string label: Label of the attribute
Return value
- id: ID of the new attribute option
- name: Name of the new attribute option
- label: Label of the new attribute option
- order: Position of the new attribute option
Required rights
Change container type
Use
<soapenv:envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="https://scnem.com/soap.php/soap/containertype"> <soapenv
:Header/> <soapenv
:Body> <con:
createAttributeOption> <resource_id>CONTAINER_PRESET_ID</resource_id>
<attribute_id>ATTRIBUTE_ID</attribute_id>
<label>ATTRIBUTE_OPTION_LABEL</label>
</con:
createAttributeOption> </soapenv
:Body> </soapenv
:Envelope> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/containertype"> <SOAP-ENV
:Body> <ns1:
createAttributeOptionResponse> <createAttributeOptionResult>
<id>ATTRIBUTE_OPTION_ID</id>
<name>ATTRIBUTE_OPTION_NAME<
/name> <label>ATTRIBUTE_OPTION_LABEL</label>
<order>SORT_ORDER</order>
</createAttributeOptionResult>
</ns1:
createAttributeOptionResponse> </SOAP-ENV
:Body> </SOAP-ENV
:Envelope>
removeAttributeOption
Remove Attribute Options
EvalancheResourceInformation removeAttributeOption ( int resource_id, int attribute_id, int option_id )
Details
Parameters
- int resource_id: ID of the container type
- int attribute_id: ID of the attribute to be removed
- int option_id: ID of the option to be removed
Return value
- removeAttributeResult: True/False if the removal was successful
Required rights
Show container type
Use
<soapenv:envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="https://scnem.com/soap.php/soap/containertype"> <soapenv
:Header/> <soapenv
:Body> <con:
removeAttributeOption> <resource_id>CONTAINER_PRESET_ID</resource_id>
<attribute_id>ATTRIBUTE_ID</attribute_id>
<option_id>ATTRIBUTE_OPTION_ID</option_id>
</con:
removeAttributeOption> </soapenv
:Body> </soapenv
:Envelope> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/containertype"> <SOAP-ENV
:Body> <ns1:
removeAttributeOptionResponse> <removeAttributeOptionResult>true/false</removeAttributeOptionResult>
</ns1:removeAttributeOptionResponse>
</SOAP-ENV:Body> </SOAP-ENV:Envelope>
getTypeIds
Query attribute types
EvalancheResourceInformation getTypeIds ( )
Details
Parameters
Return value
- EvalancheContainertypeAttributeTypes[]: List of objects with the following attributes:
- id: ID of the attribute type
- description: Description of the attribute type
Required rights
Show container type
Use
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="https://scnem.com/soap.php/soap/containertype"> <soapenv
:Header/> <soapenv:
Body> <con:getTypeIds/>
</soapenv:Body> </soapenv
:Envelope> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/containertype"> <SOAP-ENV
:Body> <ns1:
getTypeIdsResponse> <getTypeIdsResult>
<item> <id>CONTAINER_PRESET_TYPE_ID</id>
<description>CONTAINER_PRESET_TYPE_DESCRIPTION</description>
</item> </getTypeIdsResult> </ns1:
getTypeIdsResponse> </SOAP-ENV
:Body> </SOAP-ENV
:Envelope></SOAP-ENV:Envelope>
changeAttributeType
Changing Attribute Types
EvalancheResourceInformation changeAttributeType ( int resource_id, int attribute_id, int type_id )
Details
Parameters
- int resource_id: ID of the container type
- int attribute_id: ID of the attribute
- int type_id: ID ???
Return value
- changeTypeResult: True/False if the change was successful
Required rights
Change container type
Use
<soapenv:envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="https://scnem.com/soap.php/soap/containertype"> <soapenv
:Header/> <soapenv
:Body> <con:
changeAttributeType> <resource_id>CONTAINER_PRESET_ID</resource_id>
<attribute_id>ATTRIBUTE_ID</attribute_id>
<type_id>ATTRIBUTE_TYPE_ID</type_id>
</con:
changeAttributeType> </soapenv
:Body> </soapenv
:Envelope> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/containertype"> <SOAP-ENV
:Body> <ns1:
changeAttributeTypeResponse> <changeAttributeTypeResult>true/false</changeAttributeTypeResult>
</ns1:changeAttributeTypeResponse>
</SOAP-ENV:Body> </SOAP-ENV:Envelope>