Projects API

The Projects API gives access to TeamHaven's Project Management functionality.

List of projects

GET /api/projects

Returns a Paged Result containing the list of Projects available to the User.

Get project details & settings

GET /api/projects/:id

Response

{Name: 'My project',Description: 'This is a demo project',Reference: 'ABC123',ContactUserID: 12,PreviewMargin: 7,CriticalMargin: 3,ExpiryMargin: 3,CollectorCanUpdateCalls: true,CollectorCanCreateCalls: true,MobileGroupingAttributeID: 12,RetainCompletedCalls: true,CheckinMode: 1,CheckinsRequireLocationServices: true,// Prevent the user from checking in if they have switched off Location ServicesAllowApproximateCheckins: true,// Can the user check-in if their location is only approximate?AllowUnknownCheckins: true,// Can the user check-in if their location is not known?CheckinDistanceLimit: 250,// How far away can the user be from the store to check-in? (Set to null to disable)EnforceAccurateDistanceLimit: true,// Prevent users too far away from checking in if their distance is accurateEnforceApproximateDistanceLimit: false,// Prevent users too far away from checking in if their distance is approximateDefaultCountry: 'GB',IncludedInPayroll: true}

Update project details & settings

PUT /api/projects/:id

Create new project

POST /api/projects

Archive a project

PUT /api/projects/:id/archive

Unarchive a project

DELETE /api/projects/:id/archive

Request

{Name: "My project",Description: "This is a demo project",Reference: "ABC123",}

Project Theme

Get project theme

GET /api/projects/:id/theme

Response

{AccentBackgroundColor: '#0081c6',AccentForegroundColor: '#ffffff',AccentBorderColor: '#008186',BoxBackgroundColor: '#ffffff'}

Update project theme

PUT /api/projects/:id/theme

Reset project theme

DELETE /api/projects/:id/theme

Resets the Project's theme so that the Account's theme is used instead.

Project Pay Rates

Get project pay rates

GET /api/projects/:id/payrates

Update project pay rates

PUT /api/projects/:id/payrates

Project Security

Get the list of users with access

GET /api/projects/:id/users

Returns the list of Users who have access to the Project.

Set the list of users with access

POST /api/projects/:id/users

This replaces the current set of Users with access with the list provided.

Request

TODO

Note: This API does not affect Collectors, as their access is governed by whether they have been assigned to Calls or Targets in the Project.