Unfuddle API: People

Introduction top

  • An Account can have any number of People. These people interact with the different projects within the account depending upon their permissions.
  • An Involvement associates a Person with a Project and defines their specific permissions within that Project.

People top

The collection represents all People within the Account. When creating a new Person, an invitation email will automatically be generated to the provided email address.

URL:
/api/v1/people
[GET, POST]
/api/v1/people/{id}
[GET, PUT, DELETE]
/api/v1/projects/{id}/people
[GET]
Response Formats:
XML, JSON
Request/Response Body:
See Person Data Model
Notes:
Please note that the "people" URL within a project is meant as a convenience only as it simply mirrors the involvements. If you wish to modify people within a project, you must use the involvements resources.
Example:
curl -i -u username:password -X PUT \
  -H 'Accept: application/xml' \
  -H 'Content-Type: application/xml' \
  -d '<person><last-name>Johnson</last-name></person>' \
  http://mysubdomain.unfuddle.com/api/v1/people/4549.xml

Involvements top

The collection represents all Project Involvements for the given Person.

URL:
/api/v1/people/{id}/involvements
[GET, POST]
/api/v1/people/{id}/involvements/{id}
[GET, PUT, DELETE]
/api/v1/projects/{id}/involvements
[GET, POST]
/api/v1/projects/{id}/involvements/{id}
[GET, PUT, DELETE]
Response Formats:
XML, JSON
Request/Response Body:
See Involvement Data Model
Examples:
curl -i -u username:password -X PUT \
  -H 'Accept: application/xml' \
  -H 'Content-Type: application/xml' \
  -d '<involvement><messages>readcreate</messages></involvement>' \
  http://mysubdomain.unfuddle.com/api/v1/people/10040/inolvements/34256.xml

Current top

The resource represents the person who is currently accessing the API.

URL:
/api/v1/people/current
[GET]
Response Formats:
XML, JSON
Request/Response Body:
See Person Data Model
Examples:
curl -i -u username:password -X GET \
  -H 'Accept: application/xml' \
  http://mysubdomain.unfuddle.com/api/v1/people/current.xml