Projects & Teams
/
Add to Team

TonicDM Product API (0.0.5)

Main Product API

Download OpenAPI description
tonicdm-product.json
tonicdm-product.yaml
Overview
URL https://developers-internal.tonicdm.com
Reg Prentice apisupport@tonicdm.com
License Proprietary
 Terms of Service
Languages
Servers
Mock server
https://developers-internal.tonicdm.com/_mock/tonicdm-product/
Server located in the USA
https://us-api.tonicdm.com/
Server located in Germany
https://de-api.tonicdm.com/
Server located in Ireland
https://ie-api.tonicdm.com/

Organizations & People

Data on People and Organizations (includes both staff and contacts, so these do not need to be looked up separately and combined).

Operations

Projects & Teams

Operations

Get Team

Request

Returns the Brands and EmailAddresses that are Members of this project. Only Members with Status 1 and 0 are returned. Other Member Statuses are administrative only.

Query
projectIdstring(CompactUUID)^[0-9a-fA-F]{32}$required

UUID without hyphens (32 characters)

Example: projectId=8e8aa42241794371ae9d0ed7b67a8c86
searchQuerystring(JSON)

A JSON-encoded string containing the query options.

Example: searchQuery={"example"}
filterStatusesArray of strings(Status)

Provide the values of one or more statuses separated by comma (no spaces). If no value is supplied, active is assumed.

Items Enum"active""inactive""deleted"
Example: filterStatuses=active,inactive
filterDisciplinesArray of strings(CompactUUID)

provide the GUIDs of one or more disciplines separated by comma (no spaces)

Example: filterDisciplines={id},{id},{id}
dataQuantityboolean

If caching data on the client side, the data_quantity=id_only|basic|complete option can be passed to manage the completeness of the data received and therefore rate limiting.

Default false
Example: dataQuantity=true
pageSizeinteger[ 1 .. 1000 ]

The number of results to return per page

Default 50
Example: pageSize=100
pageNumberinteger

Which page of the results to return

Example: pageNumber=1
sortBystring

The field by which to sort the results

Enum"name""email""title""office"
sortDirectionstring

The sort direction for the results

Enum"asc""desc"
curl -i -X GET \
  'https://developers-internal.tonicdm.com/_mock/tonicdm-product/core/team?dataQuantity=true&filterDisciplines={id}%2C{id}%2C{id}&filterStatuses=active%2Cinactive&pageNumber=1&pageSize=100&projectId=8e8aa42241794371ae9d0ed7b67a8c86&searchQuery={%22example%22}&sortBy=name&sortDirection=asc' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successfully read the resource you requested. One or more records are returned in the form of an array.

Response
No content

Add to Team

Request

Submit an array of ProjectMember objects to add EmailAddresses to the project. You cannot add Organizations or Offices to the project directly. The Office that will display is a property of the EmailAddress added. The Brand can be specified, but typically will be ommitted and default based on the EmailAddress.

Query
projectIdstring(CompactUUID)^[0-9a-fA-F]{32}$required

UUID without hyphens (32 characters)

Example: projectId=8e8aa42241794371ae9d0ed7b67a8c86
Bodyapplication/jsonrequired
emailAddressIdstring(uuid)

The GUID associated with the email address of the team member. This is NOT a PersonID.

brandIdstring(uuid)

The GUID of the Brand associated with the EmailAddress. This allows easier look up of the Brands involved in a project.

projectIdstring(uuid)

The GUID associated with the Project.

ProjectMemberStatusstring(ProjectMemberStatus)

The status of a Person relative to a Project.

Default "nonmember"
Enum"active""inactive""deleted""nonmember"
isExecutiveboolean

Determines whether this Person has the rights of a project Executive on this Project. This parameter can only be set by a user who is an Organization Admin.

curl -i -X POST \
  'https://developers-internal.tonicdm.com/_mock/tonicdm-product/core/team?projectId=8e8aa42241794371ae9d0ed7b67a8c86' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "emailAddressId": "1f083644-e1f6-4eb7-98d6-dc7308e271bd",
    "brandId": "0e9bcbb3-096e-49f9-aeea-7a13a201eff5",
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "ProjectMemberStatus": "active",
    "isExecutive": true
  }'

Responses

Successfully created the resource you sent

Response
No content

Notes

Operations relating to the Notes that can be attached to various items.

Operations

Disciplines & Certification Definitions

Disciplines & Certification Definitions recognize areas of professional expertise.

Operations

Filesets

APIs to the Fileset module for accessing all files attached to objects in TonicDM.

Operations

Manual Uploading

APIs to the Fileset module for uploading files to the TonicDM cloud.

Operations

Cloud File Systems

Managing cloud file systems that TonicDM can connect to.

Operations

Correspondence

Managing Correspondence Data

Operations

File Transfers

APIs to the File Transfers Workflow module.

Operations

RFIs

APIs to the RFIs Workflow module.

Operations

Submittals

APIs to the Submittals Workflow module.

Operations

PCOs

APIs to the PCOs Workflow module.

Operations

COs

APIs to the COs Workflow module.

Operations

Tasks

APIs to the Tasks Workflow module.

Operations