Stud.IP  4.0
 All Data Structures Namespaces Files Functions Variables Groups
RESTAPI Namespace Reference

Namespaces

 Consumer
 
 Renderer
 
 Routes
 

Data Structures

class  ConsumerPermissions
 
class  Response
 
class  RouteMap
 
class  Router
 
class  RouterException
 
class  RouterHalt
 
class  UriTemplate
 
class  UserPermissions
 

Variables

const VERSION = '2'
 
 $router = Router::getInstance()
 
 try
 
 $uri = $_SERVER['PATH_INFO']
 
 $api_user = $router->setupAuth()
 
 $response = $router->dispatch($uri)
 

Detailed Description

Im Namensraum RESTAPI sind alle Klassen und Funktionen versammelt, die für die RESTful Web Services von Stud.IP benötigt werden.

Variable Documentation

$api_user = $router->setupAuth()
$response = $router->dispatch($uri)
if (defined('RESTAPI\\VERSION')&&preg_match('~^/v(\d+)~i', $uri, $match) $router) = Router::getInstance()
$uri = $_SERVER['PATH_INFO']
try
Initial value:
{
if (!Config::get()->API_ENABLED) {
throw new RouterException(503, 'REST API is not available');
}
require 'lib/bootstrap-api.php'
static get()
Definition: Config.class.php:36
const VERSION = '2'