Report WSDL
Class for the classic reportsThis 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 Report
int add()
Return Values
| int | The ID of the Report (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 Report
boolean edit()
Return Values
| boolean | TRUE on succes, FALSE on fail |
fetchReportAreaListtop
Description
Fetch a list of availabel report types and areas
string fetchReportAreaList()
Return Values
| string | of arrays where key is the report type and sub-array items are the available areas |
generateReporttop
Description
Generates the report. May take a litle time. Use isReportReady for polling.
int generateReport()
Return Values
| int | gives you the reportId |
Faults
getAreatop
Description
Get the area
string getArea()
Return Values
| string | the report area name |
getAvailableAreastop
Description
Get a list of allowed areas for the current report type
string getAvailableAreas()
Return Values
| string | of the available areas |
getAvailableOptionstop
Description
Get a list of available options for the current report type
string getAvailableOptions()
Return Values
| string | of the available options |
getEndDatetop
Description
Get the enddate
string getEndDate()
Return Values
| string | the enddate |
getFileByHeadertop
Description
Try to load the report via the header directive from lighty
boolean getFileByHeader()
Return Values
| boolean |
getIdtop
Description
Get the id of the report target
int getId()
Return Values
| int | the target id |
getNametop
Description
Get the name of the report
string getName()
Return Values
| string | the report area name |
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 |
getOptiontop
Description
Get a report option value
string getOption(string $name)
Parameters
| string | $name | The option name |
Return Values
| string | The option value |
getOptionstop
Description
Get the report options
string getOptions()
Return Values
| string | the options |
getReporttop
Description
Returns the report as XML string.
string getReport()
Return Values
| string | the xml-report |
getReportAsCSVtop
Description
Returns a csv file zipped
string getReportAsCSV()
Return Values
| string | $file |
getReportAsZiptop
Description
Compress the report to an xml and send this to the client the outputstring is masked with base64_encode
string getReportAsZip()
Return Values
| string |
getReportTypetop
Description
Get the reportType
string getReportType()
Return Values
| string | the reportType |
getStartDatetop
Description
Get the startdate
string getStartDate()
Return Values
| string | the startdate |
getTargetIdtop
Description
Get the id of the report target
int getTargetId()
Return Values
| int | the target id |
getTokentop
Description
Gets the session token. Can be used for single-sign-on.
string getToken()
Return Values
| string |
isReportReadytop
Description
Checks if the report is ready and gives back how long to wait for next
Poll.
int isReportReady()
Return Values
| int | time to wait in ms. 0 if ready. |
loadtop
Description
Loads a report
boolean load(int $identifier)
Parameters
| int | $identifier |
Return Values
| boolean | True on success, otherwise false |
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
Removes a report
boolean remove()
Return Values
| boolean |
removeByIdtop
Description
Removes a ClassicReportModel with the given id
boolean removeById(int $id)
Parameters
| int | $id | ID of object to remove. |
Return Values
| boolean |
removeOptionstop
Description
Remove a report option
boolean removeOptions(string $name)
Parameters
| string | $name | The option name |
Return Values
| boolean | true on success |
savetop
Description
Persists current object state
boolean save()
Return Values
| boolean | True on success, otherwise false |
setAreatop
Description
Set the area
boolean setArea(string $area)
Parameters
| string | $area | The area name |
Return Values
| boolean | true on success |
setEndDatetop
Description
Set the enddate
boolean setEndDate(string $date)
Parameters
| string | $date | The enddate of the reporting time |
Return Values
| boolean | true on success, false if the type of the params was incorrect |
setNametop
Description
Sets the name of the report
boolean setName(string $name)
Parameters
| string | $name |
Return Values
| boolean | Returns TRUE on success or FALSE on failure. |
setOptionstop
Description
Set a report option
boolean setOptions(string $name, string $value)
Parameters
| string | $name | The option name |
| string | $value | The options value |
Return Values
| boolean | true on success |
setReportTypetop
Description
Set the reportType
boolean setReportType(string $report_type)
Parameters
| string | $report_type | The reportType name |
Return Values
| boolean | true on success |
setStartDatetop
Description
Set the startdate
boolean setStartDate(string $date)
Parameters
| string | $date | The startdate of the reporting time |
Return Values
| boolean | true on success, false if the type of the params was incorrect |
setTargetIdtop
Description
Set the id of the report target
boolean setTargetId(int $id)
Parameters
| int | $id | Target id |
Return Values
| boolean | true on success, false if the type of the params was incorrect |
validatetop
Description
Validates the object and returns an error stack.
string validate()
Return Values
| string |
ValidationErrorMessagetop
Definition
- - string $identifier
-
required
- - Array <string> $messages
-
required