Organizations & People
/
Get Offices

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

Edit a Brand

Request

Change a Brand.

If the Brand is at the User's own Organization, the User must be a Tenant Administrator in order to make changes to it.

Bodyapplication/jsonrequired
idstring(CompactUUID)^[0-9a-fA-F]{32}$

UUID without hyphens (32 characters)

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"
domainsArray of strings

Zero or more domains that belong to this organization and represent the Brand, eg. firm.com, firm.co.us.

In the case of a shared domain contact, the "domain" of their Brand is their full email address, eg. steven.novosel@gmail.com.

nameLongstring<= 128 characters

The full official name of the Brand (used on transmittals).

nameShortstring<= 128 characters

The friendly name of the Brand (used within the TonicDM app).

nameInitialsstring<= 4 characters

The initials of the Brand (used in very small spaces)

disciplinesArray of objects(Discipline)

limits the disciplines that can be chosen for any person in this Brand to help consistency.

organizationIdstring(guid)^[0-9a-fA-F]{32}$

A GUID used to link multiple Brand records together into an organization. There are no extra fields associated with this GUID. It serves only as a linking mechanism. Use of this feature requires the TonicDM AdvancedContacts license.

isPrimeboolean

Indicates that this Brand is the primary Brand for this organization. When displaying an organization, the Prime Brand info will be used for their Name, etc. Use of this feature requires the TonicDM AdvancedContacts license.

customerDataWarehouseIdstring

The ID of the Brand in the Customer's Data Warehouse. Use of this feature requires the TonicDM AdvancedMetrics license.

customerErpIdstring

The ID of the Brand in the Customer's ERP system (eg. Deltek Vantagepoint). Use of this feature requires the TonicDM AdvancedMetrics license.

customerCrmIdstring

The ID of the Brand in the Customer's CRM system (eg. Deltek Salesforce). Use of this feature requires the TonicDM AdvancedMetrics license.

curl -i -X PATCH \
  https://developers-internal.tonicdm.com/_mock/tonicdm-product/core/brands \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "8e8aa42241794371ae9d0ed7b67a8c86",
    "status": "active",
    "domains": [
      "string"
    ],
    "nameLong": "string",
    "nameShort": "string",
    "nameInitials": "stri",
    "disciplines": [
      {}
    ],
    "organizationId": "string",
    "isPrime": true,
    "customerDataWarehouseId": "string",
    "customerErpId": "string",
    "customerCrmId": "string"
  }'

Responses

Successfully updated the resource you requested

Bodyapplication/json
idstring(CompactUUID)^[0-9a-fA-F]{32}$

UUID without hyphens (32 characters)

Example: "8e8aa42241794371ae9d0ed7b67a8c86"
datetimeCreatedstring(date-time)read-only

The date and time this Brand was created.

datetimeUpdatedstring(date-time)read-only

The date and time this Brand 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"
domainsArray of strings

Zero or more domains that belong to this organization and represent the Brand, eg. firm.com, firm.co.us.

In the case of a shared domain contact, the "domain" of their Brand is their full email address, eg. steven.novosel@gmail.com.

nameLongstring<= 128 characters

The full official name of the Brand (used on transmittals).

nameShortstring<= 128 characters

The friendly name of the Brand (used within the TonicDM app).

nameInitialsstring<= 4 characters

The initials of the Brand (used in very small spaces)

brandColorstring(hex)^(?:[0-9a-fA-F]{6}|)$read-only

Brand color for the Brand. This is set centrally by TonicDM and can not be changed directly via this API.

disciplinesArray of objects(Discipline)

limits the disciplines that can be chosen for any person in this Brand to help consistency.

organizationIdstring(guid)^[0-9a-fA-F]{32}$

A GUID used to link multiple Brand records together into an organization. There are no extra fields associated with this GUID. It serves only as a linking mechanism. Use of this feature requires the TonicDM AdvancedContacts license.

isPrimeboolean

Indicates that this Brand is the primary Brand for this organization. When displaying an organization, the Prime Brand info will be used for their Name, etc. Use of this feature requires the TonicDM AdvancedContacts license.

customerDataWarehouseIdstring

The ID of the Brand in the Customer's Data Warehouse. Use of this feature requires the TonicDM AdvancedMetrics license.

customerErpIdstring

The ID of the Brand in the Customer's ERP system (eg. Deltek Vantagepoint). Use of this feature requires the TonicDM AdvancedMetrics license.

customerCrmIdstring

The ID of the Brand in the Customer's CRM system (eg. Deltek Salesforce). Use of this feature requires the TonicDM AdvancedMetrics license.

Response
application/json
{
  "id": "8e8aa42241794371ae9d0ed7b67a8c86",
  "datetimeCreated": "2019-08-24T14:15:22Z",
  "datetimeUpdated": "2019-08-24T14:15:22Z",
  "status": "active",
  "domains": [
    "string"
  ],
  "nameLong": "string",
  "nameShort": "string",
  "nameInitials": "stri",
  "brandColor": "string",
  "disciplines": [
    { … }
  ],
  "organizationId": "string",
  "isPrime": true,
  "customerDataWarehouseId": "string",
  "customerErpId": "string",
  "customerCrmId": "string"
}

Get Offices

Request

Supply one or more office GUIDs to get the data for specific offices (organization locations).

This endpoint is typically called with the filterOrganizationIds parameter passing a single Organization GUID.

Query
searchQuerystring(JSON)

A JSON-encoded string containing the query options.

Example: searchQuery={"example"}
filterIdsArray of strings(CompactUUID)

Returns data for the specified GUIDs

Example: filterIds={id},{id},{id}
filterOrganizationIdsArray of strings(CompactUUID)

Returns data for the specified Organization GUIDs

Example: filterOrganizationIds={OrganizationId},{OrganizationId},{OrganizationId}
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
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

Value"name"
sortDirectionstring

The sort direction for the results

Enum"asc""desc"
curl -i -X GET \
  'https://developers-internal.tonicdm.com/_mock/tonicdm-product/core/offices?dataQuantity=true&filterIds={id}%2C{id}%2C{id}&filterOrganizationIds={OrganizationId}%2C{OrganizationId}%2C{OrganizationId}&filterStatuses=active%2Cinactive&pageNumber=1&pageSize=100&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.

Bodyapplication/jsonArray [
idstring(CompactUUID)^[0-9a-fA-F]{32}$

UUID without hyphens (32 characters)

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>).

phoneobject(Phone)

A phone number in 3 parts. Country code and phone number are always required.

]
Response
application/json
[
  {
    "id": "2122ff9ebbb140e9856934e8e33a8c1f",
    "organizationId": "da9c62640a894f61b247801a2e300c44",
    "status": "active",
    "name": "London",
    "address": "300 Dufferin Ave<br>London, ON N6B 1Z2",
    "phone": { … }
  },
  {
    "id": "306b14664e374877ab19b75685393cf7",
    "organizationId": "da9c62640a894f61b247801a2e300c44",
    "status": "inactive",
    "name": "Fairyville",
    "phone": { … }
  }
]

New Office

Request

Add an Office to an Organization.

Bodyapplication/jsonrequired
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>).

phoneobject(Phone)

A phone number in 3 parts. Country code and phone number are always required.

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",
    "phone": {
      "countryCode": 0,
      "phoneNumber": 0,
      "extension": 0
    }
  }'

Responses

Successfully created the resource you sent

Bodyapplication/json
idstring(CompactUUID)^[0-9a-fA-F]{32}$

UUID without hyphens (32 characters)

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>).

phoneobject(Phone)

A phone number in 3 parts. Country code and phone number are always required.

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
  }
}

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

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