FV_API
[ class tree: FV_API ] [ index: FV_API ] [ all elements ]

Procedural File: ApiConnector.php

Source Location: /ApiConnector.php



Classes:

InvalidRequestException
Thrown if a parameter exception occurred executing an API command. Any scripts or command should be prepared to handle this exception.
ConnectionException
Thrown if the ApiConnector couldn't connect to the API system, or a non-standard HTTP response was returned.
InternalErrorException
Thrown if an internal error occurred with the FastVision API systems. Please contact FastVision Support if you see this error.
MalformedRequestException
Thrown if the command request was malformed or invalid in some way. This should only occur in development.
LoginRequiredException
Thrown if the command requires authentication, or if the session token has expired or invalidated.
AccessDeniedException
Thrown if the command requires an access-level higher than the API account allows. This is not the same as the `ACCCES_DENIED` parameter error.
SSLRequiredException
Thrown if the current API account is marked as requiring an SSL-secure connection and we are not using a secure connection.
UnexpectedStatusException
Thrown if an unparseable response was recieved. Please contact FastVision Support if you see this error.
RequestGenerator
Utility class uses to generate the suitable HTTP request for an API command.


Page Details:

The class responsible for issuing a command to the FastVision reseller API system and parsing the reseller API system response.



Includes:

include_once("Configuration.php") [line 8]






executeCommand [line 14]

void executeCommand( Command $cmd, $token)

Dispatches the command to the FastVision API server, and parses its response.



Parameters

Command   $cmd  
   $token  
[ Top ]



issuePostRequest [line 60]

void issuePostRequest( $path, $data)



Parameters

   $path  
   $data  
[ Top ]



locateEmptyLine [line 101]

void locateEmptyLine( $lines)



Parameters

   $lines  
[ Top ]



parseRequestResponse [line 82]

void parseRequestResponse( $response)



Parameters

   $response  
[ Top ]



Documentation generated on Mon, 30 Mar 2009 16:34:33 +0100 by phpDocumentor 1.4.1