API Documentation Users

Back to API Docs

Actions

• GET https://thecampuswire.com/organization/org_name/users.xml – retrieve a list of all users
• GET https://thecampuswire.com/users/1.xml – gets an individual user
• POST https://thecampuswire.com/organization/org_name/users.xml – creates a new user
• PUT https://thecampuswire.com/users/1.xml – updates a user
• DELETE https://thecampuswire.com/users/1.xml – deletes a user

GET /organizations/org_name/users.xml

Here is example of a user list

<?xml version="1.0" encoding="UTF-8"?>
<users type="array">
  <user>
    <created-at type="datetime">2007-08-28T02:38:08-05:00</created-at>
    <email>foo@bar.com</email>
    <firstname>foo</firstname>
    <id type="integer">150</id>
    <lastname>bar</lastname>
    <login>bar</login>
    <phone></phone>
    <sms></sms>
    <updated-at type="datetime">2007-09-05T02:32:35-05:00</updated-at>
  </user>
  <user>
    <created-at type="datetime">2007-09-05T02:33:39-05:00</created-at>
    <email>jane@doe.com</email>
    <firstname>jane</firstname>
    <id type="integer">151</id>
    <lastname>doe</lastname>
    <login>jdoe</login>
    <phone>2105555555</phone>
    <sms>2105555555</sms>
    <updated-at type="datetime">2007-09-05T02:33:40-05:00</updated-at>
  </user>
</users>

POST /organizations/org_name/users.xml (create a new user)

Valid attributes

• login
• firstname
• lastname
• email
• phone
• sms
• password
• password-confirmation

PUT /users/150.xml (update an existing user)

Valid attributes

Same as POST