Class Api
A RESTful API system for interacting with the Blesta backend.
All public model methods are accessible. Plugin models may also be invoked by simply formatting the model as Plugin.Model (e.g. /api/plugin.model/method.format). Supports XML, JSON, and PHP as format types.
- AppController
-
Api
Package: blesta\app\controllers
Copyright: Copyright (c) 2010, Phillips Data, Inc.
License: The Blesta License Agreement
Link: Blesta
Located at app/controllers/api.php
Copyright: Copyright (c) 2010, Phillips Data, Inc.
License: The Blesta License Agreement
Link: Blesta
Located at app/controllers/api.php
public
|
#
preAction( )
Verify that the request is properly formatted, and ensure the requester is authorized. |
public
|
string |
OK
|
#
'OK'
|
string |
NOT_FOUND
|
#
'The requested resource does not exist.'
|
string |
UNAUTHORIZED
|
#
'The authorization details given appear to be invalid.'
|
string |
FORBIDDEN
|
#
'The requested resource is not accessible.'
|
string |
UNSUPPORTED_FORMAT
|
#
'The format requested is not supported by the server.'
|
string |
MAINTENANCE_MODE
|
#
'The requested resource is currently unavailable due to maintenance.'
|
string |
INTERNAL_ERROR
|
#
'An unexpected error occured.'
|
string |
BAD_REQUEST
|
#
'The request cannot be fulfilled due to bad syntax.'
|