Update Notes
Over this weekend we will update the API below you will find a list of changes that we will be making.
Since the last update we have continued to roll out performance updates in the background so hopefully you have noticed some speed increases. With this update we are continuing in that trend and added some speed enhancements, as well as several new return fields for some of the objects and even a few more routes. We also were able to do some minor bug fixes
Test Site
We are happy to announce we have added a test site for the API. This site has it's own database and has the most cutting edge features of our API. If we any new features we develop will be here first before being make public. If you want to try it out you can at test-api.connectionsonline.net. Please keep in mind that the data in this database is not kept up to date or backed up. It is for testing purposes only.
Added Return Fields
We have already added the permission fields, CanRead, CanUpdate, CanDelete, CanDelegate, to many of our objects and with this update we added them to a few more, Individual, Metric, and Organization.
They have been added to the
Other modifications to objects in this update:
Metrics:
- ColorName
- ColorRank
- OwnerList
Organization:
- ParentName
Task: ** These are not new, but both have been updated to return correctly.
- Breaking Change: OnTime is now a boolean value instead of an integer.
- NearHighlight
New Routes:
MyDialogs
- Route: "me/alldialogs" | Optional Parameters: StartDate, EndDate
- Route: "/individuals/{id}/alldialogs" | Optional Parameters: StartDate, EndDate
- Return Object: MyDialog
- Description: Returns all dialogs for the given individual. This includes any dialog where the individual has a task assigned to them.
Forecast stats
- Route: "/individuals/{id}/forecaststats" | Optional Parameter: Date
- Return Object: ForecastStats
- Description: This returns statistics for the given individual to be used in the Forecast application. These statistics include how many tasks/projects are active, overdue, due today, starting today, and completed today.
Tasks
- Route: "me/tasks"
- Return Object: Task
- Description: Returns the same as /individual/ID/tasks except this one does it for the currently logged in individual. No ID needed.
- Route: "me/alltasks"
- Return Object: allTask
- Description: Returns the same as /individual/ID/alltasks except this one does it for the currently logged in individual. No ID needed.
Projects
- Route: "me/projects" | Optional Parameter: Deleted
- Route: "individuals/{id}/projects" | Optional Parameter: Deleted
- Return Object: Project
- Description: Returns projects for the given individual.
Organizations/Departments
- Route: "me/organizations" | Optional Parameter: Deleted
- Route: "individuals/{id}/organizations" | Optional Parameter: Deleted
- Route: "me/departments" | Optional Parameter: Deleted
- Route: "individuals/{id}/departments" | Optional Parameter: Deleted
- Return Object: Organization
- Description: Returns organizations/departments for the given individual.
Metrics
- Route: "me/metrics" | Optional Parameter: Deleted
- Route: "individuals/{id}/metrics" | Optional Parameter: Deleted
- Return Object: Metric
- Description: Returns metrics for the given individual.
- Route: "me/allmetrics" | Optional Parameter: Deleted
- Route: "individuals/{id}/allmetrics" | Optional Parameter: Deleted
- Return Object: Metric
Weekend Update 6-19-2015
- Description: Returns all metrics for the given individual.
Individuals
- Route: "organizations/{id}/individuals"
- Route: "departments/{id}/individuals"
- Return Object: Individual
- Description: Returns individuals for the given organization/department.
- Route: "projects/{id}/individuals"
- Return Object: Individual
- Description: Returns individuals for the given project. This call returns the same people as the team member route, except in this one it returns the individual object.
- Route: "tasks/{id}/individuals"
- Return Object: Individual
- Description: Returns individuals for the given task. This call returns the same people as the people responsible route, except in this one it returns the individual object.
Misc. Changes
The team member's route to read a team member by project ID changed from task/{id}/temamembers to projects/{id}/teammembers, the old route will still work but is now deprecated and the new route should be used in the future.
Departments now have their own section in the help. Previously they were under organization. They both still function the same and both return organization objects.
The Security Documentation has been updated to explain the uses of Tokens with the API.
Added documentation for size limits on some string objects. If the description of the variable does not contain (Max length *** characters) then it is a varchar(MAX) otherwise the limit is what is stated. Any characters exceeding this limit will be truncated.
Comments
1 comment
The API has been updated.
Please sign in to leave a comment.