Overview

This document covers standards for the REST API that are used in all the ind2uce parts like PMP, PDP

HTTP verbs

RESTful policy decision service tries to adhere as closely as possible to standard HTTP and REST conventions in its use of HTTP verbs.

Verb Usage

GET

Used to retrieve a resource

POST

Used to create a new resource

DELETE

Used to delete an existing resource

HTTP status codes

RESTful policy management service tries to adhere as closely as possible to standard HTTP and REST conventions in its use of HTTP status codes.

Status code Usage

200 OK

The request completed successfully

400 Bad Request

The request was malformed. The response body will include an error providing further information. Due to Policies this error occurred if the ID is malformed.

404 Not Found

The requested resource did not exist

409 Conflict

The new Policy is in conflict to existing policies.

Headers

Every response has the following header(s):

Errors

Whenever an error response (status code >= 400) is returned, the body will contains a simple text content that describes the error.

Hypermedia

All API Methods consumes and produces application_json or text_xml. In error cases we create text_plain.