Collector API

The Collector API aims to provide a full set of services required by an online service providing capabilities similar to TeamHaven Mobile.

It is still incomplete and experimental.

1. Profile
2. Settings
3. Projects
4. Vacancies
5. Self Assignment
6. Messages
7. Skills

Profile

GET /api/user

Returns the User's Profile.

Query String Parameters

schema

true to include the User Attribute Schema in the response.

PUT /api/user

Updates the User's Profile.

POST /api/user/password

Changes the User's password.

Settings

GET /api/user/settings

Gets the User's settings.

PUT /api/user/settings

Updates the User's settings.

Projects

GET /api/user/projects

List all projects the user has access to

GET /api/user/projects/:id

Gets information about a specific project.

URL parameters

id

The Project ID to retrieve.

Vacancies

GET /api/user/vacancies

Gets a list of the vacancies available to the user. This includes Calls to which the user has assigned themselves to, but which have not yet been activated by the Project Manager.

GET /api/user/vacancies/ignore

Gets a list of the vacancies that the user has indicated they are not interested in.

PUT /api/user/vacancies/ignore/:id

Ignore a specific Vacancy. The id is the Vacancy's Call ID.

DELETE /api/user/vacancies/ignore/:id

Unignore a Vacancy. The id is the Vacancy's Call ID

Self Assignment

PUT /api/user/calls/:id

Claim a vacant Call (assigns the User to the Call).

DELETE /api/user/calls/:id

Release a previously claimed Call (unassigns the User from the Call).

Messages

GET /api/user/messages

Gets a list of messages from the user's Inbox, most recent first.

GET /api/user/messages/:id

Marks the specified message as read.

POST /api/user/messages/:id

Sets the user's response to a message.

Skills

GET /api/user/skills

Gets a list of the User's Skills.