Common System Specific Elements

Each CollectionSpace Service receives an HTTP request and responds with an HTTP response. These requests and responses share a common set of data that is exchanged between the service consumer and provider. Let's call it system specific data. This page describes elements of the system specific data.

The system specific data could be found in one or more of the following places in a request, a response or both.

1. HTTP header (ref: RFC 2616)

2. URI parameter

3. XML (response entity body). Here is the schema.

The requirement of the data is further categorized according to the type of operation (GET (R ead), PUT (U pdate), POST (C reate), DELETE (D elete)).

The information is categorized in the following general categories.

1. Common

2. Security

3. Error

4. Tenancy

5. Query and Resultset

6. Asynchronous Service

Common

Common elements should be present in request or response of any service-specific operation performed on the service layer.

Security

Security elements should be present in any service invocation performed in a secure manner.