Hospitium

API Overview

The API is broken down into three main resources: Services, Events, and Statuses.

Resource Schema

All resources returned will be JSON objects. In the case of a list resource, the JSON object will have a field containing the list of returned resources

{
    "objects": [
        {
            "id": "foo",
            "descrption": "This is a sample object"
        }
    ]
}

Authetioncation (or lack thereof)

No API requests require authentication as all resources are read-only

Client Errors

Client errors will have the following structure.

{
    "message": "Can't find resouce",
    "code": 404,
    "error": true
}