BulkComplexCall WSDL
This service is stateful.
addBulkComplexCalltop
Description
Add a BulkComplexCall
boolean addBulkComplexCall(string $class, string $xml)
Parameters
| string | $class | The service for the complex calls |
| string | $xml | The bulk complex call xml |
Return Values
| boolean |
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 |
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 |
getProgresstop
Description
Get the progress for an BulkComplexCall in percent
float getProgress(string $job_id)
Parameters
| string | $job_id |
Return Values
| float |
getResulttop
Description
Get the result for a BulkComplexCall
string getResult(string $job_id)
Parameters
| string | $job_id |
Return Values
| string |
getResultDatatop
Description
Gets the result of a BulkComplexCall with additional return data
string getResultData(string $job_id)
Parameters
| string | $job_id |
Return Values
| string | XML |
getTokentop
Description
Gets the session token. Can be used for single-sign-on.
string getToken()
Return Values
| string |
initiateProcesstop
Description
Starts the bulk process and returns the job id
string initiateProcess()
Return Values
| string |
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 |