ispapi.response
index
/var/www/whmcs-dev2/whmcs/ispapi/python/ispapi/response.py

 
Modules
       
ispapi

 
Classes
       
Response

 
class Response
     Methods defined here:
__getitem__(self, index)
Returns the item for the given index
__init__(self, response)
Constructor
__len__(self)
Returns the number of items
as_hash(self)
Returns the response as a hash
as_list(self)
Returns the response as a list
as_list_hash(self)
Returns the response as a list hash
as_string(self)
Returns the response as a string
code(self)
Returns the response code
columns(self)
Returns the columns
count(self)
Returns the number of list elements returned (= last - first + 1)
description(self)
Returns the response description
first(self)
Returns the index of the first element
is_success(self)
Returns true if the results is a success
Success = response code starting with 2
is_tmp_error(self)
Returns true if the results is a tmp error
tmp error = response code starting with 4
last(self)
Returns the index of the last element
lastpagefirst(self)
Returns the first index for the last page
limit(self)
Returns the limit of the response
nextpage(self)
Returns the number of the next page
nextpagefirst(self)
Returns the first index for the next page
page(self)
Returns the number of the current page (starts with 1)
pages(self)
Returns the number of pages
prevpage(self)
Returns the number of the previous page
prevpagefirst(self)
Returns the first index for the previous page
properties(self)
Returns the response properties
property(self, index=None)
Returns the property for a given index
If no index given, the complete property list is returned
queuetime(self)
Returns the response queuetime
runtime(self)
Returns the response runtime
total(self)
Returns the total number of elements found (!= count)