Skip to content
Organizations
/
Edit Office

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

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

Operations

New Office

Request

Add an Office to an Organization.

Security
OAuth2 or apiKeyAuth
Bodyapplication/json
statusstring(Status)

Whether the item is active or inactive in TonicDM. Potentially the item could be (soft) deleted.

Default "active"
Enum"active""inactive""deleted"
namestring[ 1 .. 64 ] charactersrequired

The name given to this Office. It is used in the TonicDM app only (not put onto anything externally facing).

addressstring[ 1 .. 256 ] characters

The address of the office. Use \n for new lines when submitting (they will be returned as <br>).

phoneCountryCodenumber

Numbers only, no spaces or +

phoneNumbernumber

Numbers only, no spaces or formatting

curl -i -X POST \
  https://developers-internal.tonicdm.com/_mock/tonicdm-product/core/offices \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "status": "active",
    "name": "string",
    "address": "string",
    "phoneCountryCode": 0,
    "phoneNumber": 0
  }'

Responses

Successfully created the resource you sent

Bodyapplication/json
idstring(CompactUUID)^[0-9a-fA-F]{32}$
Example: "8e8aa42241794371ae9d0ed7b67a8c86"
datetimeCreatedstring(date-time)read-only

The date and time this Office was created.

datetimeUpdatedstring(date-time)read-only

The date and time this Office was last updated.

statusstring(Status)

Whether the item is active or inactive in TonicDM. Potentially the item could be (soft) deleted.

Default "active"
Enum"active""inactive""deleted"
namestring[ 1 .. 64 ] characters

The name given to this Office. It is used in the TonicDM app only (not put onto anything externally facing).

addressstring[ 1 .. 256 ] characters

The address of the office. Use \n for new lines when submitting (they will be returned as <br>).

phoneCountryCodenumber

Numbers only, no spaces or +

phoneNumbernumber

Numbers only, no spaces or formatting

Response
application/json
{
  "id": "2122ff9ebbb140e9856934e8e33a8c1f",
  "organizationId": "da9c62640a894f61b247801a2e300c44",
  "status": "active",
  "name": "London",
  "address": "300 Dufferin Ave<br>London, ON N6B 1Z2",
  "phone": {
    "countryCode": 1,
    "phoneNumber": 5196612489,
    "extension": 32
  }
}

Edit Office

Request

Modify the information for an Office.

Security
OAuth2 or apiKeyAuth
Bodyapplication/json
idstring(CompactUUID)^[0-9a-fA-F]{32}$required
Example: "8e8aa42241794371ae9d0ed7b67a8c86"
statusstring(Status)

Whether the item is active or inactive in TonicDM. Potentially the item could be (soft) deleted.

Default "active"
Enum"active""inactive""deleted"
namestring[ 1 .. 64 ] characters

The name given to this Office. It is used in the TonicDM app only (not put onto anything externally facing).

addressstring[ 1 .. 256 ] characters

The address of the office. Use \n for new lines when submitting (they will be returned as <br>).

phoneCountryCodenumber

Numbers only, no spaces or +

phoneNumbernumber

Numbers only, no spaces or formatting

curl -i -X PATCH \
  https://developers-internal.tonicdm.com/_mock/tonicdm-product/core/offices \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "8e8aa42241794371ae9d0ed7b67a8c86",
    "status": "active",
    "name": "string",
    "address": "string",
    "phoneCountryCode": 0,
    "phoneNumber": 0
  }'

Responses

Successfully updated the resource you requested.

Bodyapplication/json
idstring(CompactUUID)^[0-9a-fA-F]{32}$
Example: "8e8aa42241794371ae9d0ed7b67a8c86"
datetimeCreatedstring(date-time)read-only

The date and time this Office was created.

datetimeUpdatedstring(date-time)read-only

The date and time this Office was last updated.

statusstring(Status)

Whether the item is active or inactive in TonicDM. Potentially the item could be (soft) deleted.

Default "active"
Enum"active""inactive""deleted"
namestring[ 1 .. 64 ] characters

The name given to this Office. It is used in the TonicDM app only (not put onto anything externally facing).

addressstring[ 1 .. 256 ] characters

The address of the office. Use \n for new lines when submitting (they will be returned as <br>).

phoneCountryCodenumber

Numbers only, no spaces or +

phoneNumbernumber

Numbers only, no spaces or formatting

Response
application/json
{
  "id": "2122ff9ebbb140e9856934e8e33a8c1f",
  "organizationId": "da9c62640a894f61b247801a2e300c44",
  "status": "active",
  "name": "London",
  "address": "300 Dufferin Ave<br>London, ON N6B 1Z2",
  "phone": {
    "countryCode": 1,
    "phoneNumber": 5196612489,
    "extension": 32
  }
}

People

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

Operations

Projects

The list of Projects for the customer.

Operations

Teams

The list of People associated with a Project.

Operations

Groups

The list of Groups associated with a Project.

Operations

Labels

Operations relating to the Labels that can be attached to various objects.

Operations

Notes

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

Operations

Disciplines

Disciplines are recognized areas of professional expertise.

Operations

Certifications

Certifications recognize areas of professional specialty or project accomplishments.

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