.. api_overview.rst:

API Overview
============

.. warning::

    The API and associated documentation are under active development.  While every effort is made to avoid breaking changes, any breaking change will be detailed on the resource specific API page.


REST
----

The Care Messenger API is built on RESTful principals, and as such defines a number of resources that respond to requests using the HTTP verbs, GET, POST, PUT, PATCH and DELETE.  

All the available resources are documented in the following sections along with the verbs each resource will respond to.

Base URL
--------

The API itself is currently available at the following URL::

	https://api.caremessenger.co.uk/v2/