SoaCollection WSDL
SoaCollectionThis service is stateful.
addFiltertop
Description
Adds a filter without a qualifier.
It will use the default qualifier for this target.
boolean addFilter(string $target, string $value)
Parameters
| string | $target | |
| string | $value |
Return Values
| boolean |
addQualifiedFiltertop
Description
Adds a filter with an qualifier.
- 10 For string equal compare
- 11 String like compare
- 13 String locate compare
- 20 Number equals compare
- 21 Number greater compare
- 22 Number smaller compare
- 30 Bool equals compare
- 40 Datetime equals compare
- 41 Datetime greater compare
- 42 Datetime smaller compare
- 43 Datetime between compare
- 60 List compare
- 1000 Negation
boolean addQualifiedFilter(string $target, string $value, int $qualifier)
Parameters
| string | $target | This schould be a camelcased item |
| string | $value | |
| int | $qualifier |
Return Values
| boolean |
aggregateListtop
Description
Creates a (ID => Field) list
id -> $filterName array
string aggregateList(string $filter_name, string $params)
Parameters
| string | $filter_name | |
| string | $params | Parameter for the collector. |
Return Values
| string |
clearObjectDatatop
Description
Clears the current object state.
This method will unload possibly loaded objects. Unsaved changes will be lost.
boolean clearObjectData()
Return Values
| boolean |
deletetop
Description
Removes a record from the collection.
boolean delete()
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 |
fetchtop
Description
Executes the query specified by the filter.
boolean fetch()
Return Values
| boolean |
fetchFirstPagetop
Description
Fetches and moves the pointer to the first page.
boolean fetchFirstPage()
Return Values
| boolean |
fetchLastPagetop
Description
Fetches and moves the pointer to the last page.
boolean fetchLastPage()
Return Values
| boolean |
fetchNextPagetop
Description
Fetches and moves the pointer to the next page.
boolean fetchNextPage()
Return Values
| boolean |
fetchPagetop
Description
Fetches and moves the pointer to page $page.
boolean fetchPage(int $page)
Parameters
| int | $page | The page to fetch |
Return Values
| boolean |
fetchPreviousPagetop
Description
Fetches and moves the pointer to the previous page.
boolean fetchPreviousPage()
Return Values
| boolean |
getDeletedIDstop
Description
Fetch all deleted objects since given datetime.
string getDeletedIDs(string $sincedate)
Parameters
| string | $sincedate |
Return Values
| string |
getIdtop
Description
Gets the ID of the current element.
int getId()
Return Values
| int |
getMaxEntriestop
Description
Gets the size per page.
int getMaxEntries()
Return Values
| int |
getNetworktop
Description
Returns the current network id
int getNetwork()
Return Values
| int | Network ID |
getNetworkIdtop
Deprecated 2011-01-01
This method will be removed in upcoming releases.
Description
Returns the current network id. Alias for getNetwork()
int getNetworkId()
Return Values
| int | Network ID |
getSizeStattop
Description
Gets information about the collection
string getSizeStat()
Return Values
| string |
getTokentop
Description
Gets the session token. Can be used for single-sign-on.
string getToken()
Return Values
| string |
getValidFilterstop
Description
Gets a list of valid filters.
string getValidFilters()
Return Values
| string |
getValidQualifierForFiltertop
Description
Gets all valid qualifier for a specific filter.
string getValidQualifierForFilter(string $filter)
Parameters
| string | $filter |
Return Values
| string |
getValidQualifierstop
Description
Gets a associative list with all valid qualifiers.
string getValidQualifiers()
Return Values
| string |
keytop
Description
Returns the position of the pointer.
int key()
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 |
nexttop
Description
Set the pointer to the next element.
boolean next()
Return Values
| boolean |
publishCurrentToSoatop
Description
Loads current object to the corresponding SOAP Server.
Returns the location to the SOAP Server where the object is loaded.
string publishCurrentToSoa()
Return Values
| string |
removeFiltertop
Description
Removes a filter.
boolean removeFilter(string $filtername)
Parameters
| string | $filtername |
Return Values
| boolean | TRUE if there wa at least one filter to delete otherwise FALSE. |
rewindtop
Description
Set the pointer to the first element and close index gaps if exists.
boolean rewind()
Return Values
| boolean |
setPagertop
Description
Set the limit for the results.
The collection will never return more than 1000 results.
boolean setPager(int $limit)
Parameters
| int | $limit |
Return Values
| boolean |
setTargetClasstop
Description
Set the type of object you want to query.
boolean setTargetClass(string $type)
Parameters
| string | $type |
Return Values
| boolean |
setUseReplicationtop
Description
Enables usage of replicated data increasing the performance and stability of search operations.
Regardless of this setting live data will be used instead in case of replication having
a lag of more than a couple of seconds.
Only effective when called before setTargetClass().
Default: false
boolean setUseReplication(boolean $use_replication)
Parameters
| boolean | $use_replication |
Return Values
| boolean | True on success, otherwise false |
sizetop
Description
The size of the collection.
int size()
Return Values
| int |
validtop
Description
Check if the current element is valid.
boolean valid()
Return Values
| boolean |