Comparing version 5 and version 4 back

The CampusWire API(Application Programming Interface) is a way to access CampusWire programatically. This makes it easy to integrate CampusWire into your own application, or even build an application around CampusWire. The API follows "REST":http://en.wikipedia.org/wiki/REST principles.

All API calls are authenticated using HTTP BasicAuth. Be sure to set your Content-Type and header to text/xml 

"text/xml; charset=utf-8"

There are four HTTP methods that are used when you make a call to our API. They are:

* GET -- Get information about a resource
* POST -- Create a new resource
* PUT -- Modify/update a resource
* DELETE -- Delete a resource

CampusWire has four resources that you can create/edit/update/destroy.

* [[API Documentation Message|Messages]]
* [[API Documentation Users|Users]]
* [[API Documentation Users|Groups]]Groups|Groups]]
* [[API Documentation Users|Memberships]]Memberships|Memberships]]

The request URI should end in .xml when making calls to the API. For instance, to retrieve a list of users the request would get GET http://www.thecampuswire.com/organizations/john_doe/users.xml

If you are working with an individual resource, an example request would be GET http://www.thecampuswire.com/users/1.xml