Folder WSDL
A Folder modelThis service is stateful.
addtop
Deprecated 2011-01-01
This method will be removed in upcoming releases.
Use save() to persist a new entity
Description
Saves changes made to the Folder
int add()
Return Values
| int | The ID of the Folder (unique) |
clearObjectDatatop
Description
Clears the current object state.
This method will unload possibly loaded objects. Unsaved changes will be lost.
boolean clearObjectData()
Return Values
| boolean |
doComplexCalltop
Description
Execute a complex call.
For further information read the API-User documentation.
string doComplexCall(string $xmlstr)
Parameters
| string | $xmlstr | XML of Complex Statements |
Return Values
| string | The output produced by the statements |
edittop
Deprecated 2011-01-01
This method will be removed in upcoming releases.
Use save() to persist changes made to an entity
Description
Saves changes made to the Folder
boolean edit()
Return Values
| boolean | TRUE on succes, FALSE on fail |
getAllowedTypestop
Description
GetValidTypes
string getAllowedTypes()
Return Values
| string |
getIdtop
Description
Get id
int getId()
Return Values
| int | $id |
getNametop
Description
Get name
string getName()
Return Values
| string | $name |
getNetworktop
Description
Returns the current network id
int getNetwork()
Return Values
| int | Network ID |
getNetworkIdtop
Description
Get networkId
int getNetworkId()
Return Values
| int | $networkId |
getTokentop
Description
Gets the session token. Can be used for single-sign-on.
string getToken()
Return Values
| string |
getTypetop
Description
Get type
string getType()
Return Values
| string | $type |
loadtop
Description
Gets a folder by ID
boolean load(int $identifier)
Parameters
| int | $identifier |
Return Values
| boolean | True on success, otherwise false |
loadByNametop
Description
Load a folder by name
int loadByName(string $name)
Parameters
| string | $name |
Return Values
| int |
logintop
Description
Initializes a new session with given information
boolean login(string $user, string $pass, int $network)
Parameters
| string | $user | Username |
| string | $pass | Password |
| int | $network | $network Network ID |
Return Values
| boolean | true on success, false on fail |
loginSmartPhonetop
Deprecated 2014-12-22
This method will be removed in upcoming releases.
Was only useful for the mobile app, which is not supported anymore.
Description
Login method
boolean loginSmartPhone(string $user, string $pass, int $network, string $client)
Parameters
| string | $user | Username |
| string | $pass | Password |
| int | $network | $network Network ID |
| string | $client | Client token e.g. "apn" token of iPhone |
Return Values
| boolean | TRUE on success, FALSE on fail |
logouttop
Description
Destroys the active session, logging out the user.
boolean logout()
Return Values
| boolean | true on success, false on fail |
removetop
Description
Remove a folder with the given ID
boolean remove()
Return Values
| boolean |
removeByIdtop
Description
Removes a FolderModel with the given id
boolean removeById(int $id)
Parameters
| int | $id | ID of object to remove. |
Return Values
| boolean |
savetop
Description
This implementation checks the permission for the Folder Entity
checked Rights are ADMIN therfor only admins can create Folder
boolean save()
Return Values
| boolean | True on success, otherwise false |
setNametop
Description
Set name
boolean setName(string $name)
Parameters
| string | $name |
Return Values
| boolean |
setTypetop
Description
Set type (either "order" or "website").
The type determines which kind of child objects are to be linked to this folder.
NOTE: The type is immutable. Once you have called this method with a valid type changing the type
is not possible.
boolean setType(string $type)
Parameters
| string | $type |
Return Values
| boolean |
validatetop
Description
Validates the object and returns an error stack.
string validate()
Return Values
| string |