Correspondence

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

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

Get Conversations

Request

Get Conversations stored in the Correspondence module.

Query
filterIdsArray of strings(CompactUUID)

Returns data for the specified GUIDs

Example: filterIds={id},{id},{id}
curl -i -X GET \
  'https://developers-internal.tonicdm.com/_mock/tonicdm-product/correspondence/conversations?filterIds={id}%2C{id}%2C{id}' \
  -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.

Bodyapplication/jsonArray [
idstring(uuid)read-only

the GUID of the Conversation in TonicDM.

datetimeCreatedstring(date-time)read-only

The date and time this Conversation record was created.

datetimeUpdatedstring(date-time)read-only

The date and time this Conversation record was last updated.

]
Response
application/json
[
  {
    "id": "be26af2278974fddb5fcf67d83c10de3"
  }
]

Get Messages

Request

Get Messages stored in the Correspondence module.

Query
filterIdsArray of strings(CompactUUID)

Returns data for the specified GUIDs

Example: filterIds={id},{id},{id}
curl -i -X GET \
  'https://developers-internal.tonicdm.com/_mock/tonicdm-product/correspondence/messages?filterIds={id}%2C{id}%2C{id}' \
  -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.

Bodyapplication/jsonArray [
idstring(uuid)read-only

the GUID of the Message in TonicDM.

datetimeCreatedstring(date-time)read-only

The date and time this Message record was created.

datetimeUpdatedstring(date-time)read-only

The date and time this Message record was last updated.

senderstring(email)

The person who sent the message.

recipientsArray of strings(email)

The people who received the message.

subjectstring

The subject of the message.

bodystring

The body of the message.

attachmentsArray of strings(uuid)

The attachments of the message.

readboolean

The read status of the message.

starredboolean

The starred status of the message.

trashedboolean

The trashed status of the message.

archivedboolean

The archived status of the message.

datetimeSentstring(date-time)

The date and time the message was sent.

datetimeReceivedstring(date-time)

The date and time the message was received.

datetimeReadstring(date-time)

The date and time the message was read.

datetimeStarredstring(date-time)

The date and time the message was starred.

datetimeTrashedstring(date-time)

The date and time the message was trashed.

datetimeArchivedstring(date-time)

The date and time the message was archived.

datetimeDeletedstring(date-time)

The date and time the message was deleted.

datetimeUnreadstring(date-time)

The date and time the message was marked as unread.

datetimeUnstarredstring(date-time)

The date and time the message was unstarred.

datetimeUntrashedstring(date-time)

The date and time the message was untrashed.

datetimeUnarchivedany

The date and time the message was unarchived.

]
Response
application/json
[
  {
    "id": "be26af2278974fddb5fcf67d83c10de3"
  }
]

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