TimeSync
Changelog
Jun 16, 2016 - v0.1.0
Usage Docs
Administration: activities and projects
Creating new projects and activities
Projects
Activities
Getting a subset of time entries
Projects
Activities
Users
Date worked
Example
Getting a subset of projects
Users
Draft API
Connection
Format
Versions
Slugs
Revisions
Auditing History
Pagination
GET Endpoints
GET /projects
GET /projects/:slug
GET /activities
GET /activities/:slug
GET /times
GET /times/:time-entry-uuid
GET Request Query Parameters
Reference Table
?user=:username
?project=:projectslug
?activity=:activityslug
?start=:date
?end=:date
?include_revisions=:bool
?include_deleted=:bool
Multiple Parameters Per Request
Malformed or Exceptional Parameter Usage
Including Revisions of Objects (include_revisions)
GET /projects/:slug?include_revisions=true
GET /projects?include_revisions=true
GET /times/:uuid?include_revisions=true
GET /times?include_revisions=true
GET /activities/:slug?include_revisions=true
GET /activities?include_revisions=true
Retrieving Deleted Objects (include_deleted)
GET /projects?include_deleted=true
GET /activities?include_deleted=true
GET /times?include_deleted=true
GET /times/:uuid?include_deleted=true
POST Endpoints
POST /projects/
POST /activities/
POST /times/
POST /users/
POST /projects/:slug
POST /activities/:slug
POST /times/:uuid
POST /users/:username
DELETE Endpoints
Authorization and Permissions
GET Endpoints
POST Endpoints
DELETE Endpoints
Authentication
Token-based authentication
Password authentication
LDAP Authentication
Errors
1. Object Not Found
2. Server Error
3. Invalid Foreign Key
4. Bad Object
5. Invalid Identifier
6. Invalid Username
7. Authentication Failure
8. Slug Already Exists
9. Authorization Failure
10. Request Failure
11. Bad Query Value
12. Username Already Exists
Object Model
Common
Times
Projects
Activities
Users
Organization Roles
User Management
Organization Roles
Users Model
Admin Users
/users Endpoint
GET /users
GET /users?role=:role
GET /users/:username
GET /users?include_deleted=true
GET /users/:username?include_deleted=true
POST /users
POST /users/:username
DELETE /users/:username
Roles Endpoints
GET /users/org-roles
GET /usrs/org-roles/:slug
POST /users/org-roles
POST /users/org-roles/:slug
DELETE /users/org-roles/:slug
Authorization Management
TimeSync
Docs
»
Welcome to TimeSync’s API documentation!
Edit on GitHub
Welcome to TimeSync’s API documentation!
¶
TimeSync is an OSU Open Source Lab developed Time Tracking system.
Changelog
Jun 16, 2016 - v0.1.0
Usage Docs
Administration: activities and projects
Draft API
Connection
Format
Versions
Slugs
Revisions
Auditing History
Pagination
GET Endpoints
GET Request Query Parameters
POST Endpoints
DELETE Endpoints
Authorization and Permissions
Authentication
Token-based authentication
Password authentication
LDAP Authentication
Errors
1. Object Not Found
2. Server Error
3. Invalid Foreign Key
4. Bad Object
5. Invalid Identifier
6. Invalid Username
7. Authentication Failure
8. Slug Already Exists
9. Authorization Failure
10. Request Failure
11. Bad Query Value
12. Username Already Exists
Object Model
Common
Times
Projects
Activities
Users
Organization Roles
User Management
Organization Roles
Users Model
Admin Users
/users Endpoint
Roles Endpoints
Authorization Management
Read the Docs
v: latest
Versions
latest
stable
Downloads
pdf
htmlzip
epub
On Read the Docs
Project Home
Builds
Free document hosting provided by
Read the Docs
.