API Documentation
The CampusWire API 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 principles.
All API calls are authenticated using HTTP BasicAuth. Be sure to set your Content-Type and header to “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.
Ruby library
We have written a simple API wrapper in Ruby that you can. You can view it here.
Using cURL
If you have access to the cURL utility, you can use that to make API calls to CampusWire. Here are a few sample calls
Retrieving a list of messages
curl -u username:password -H "Content-Type:text/xml; charset=utf-8" https://thecampuswire.com/organizations/messages.xml
Retreiving an individual message
curl -u username:password -H "Content-Type:text/xml; charset=utf-8" https://thecampuswire.com/messages/1.xml
Deleting a user
curl -H "Content-Type:text/xml; charset=utf-8" -X DELETE -u username:password https://thecampuswire.com/users/290.xml
Creating a new group
curl -u username:password -H "Content-Type:text/xml; charset=utf-8" -d "<group><name>my group</name></group>" https://thecampuswire.com/organizations/org_name/groups.xml
Updating an existing user
curl -u ian2:ian2 -H "Content-Type:text/xml; charset=utf-8" -X PUT -d "<user><id>290</id><email>foo@bar.com</email></user>" https://thecampuswire.com/users/290.xml
Notes
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.xmlIf you are working with an individual resource, an example request would be GET http://www.thecampuswire.com/users/1.xml
