Edit a Brand

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

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

Get Brands

Request

Gets data on the User's Organization's own Brands and their Contact Organization's Brands.

Query

searchQuerystring(JSON)

A JSON-encoded string containing the query options.

Example: searchQuery={"example"}

filterIdsArray of strings(CompactUUID)

Returns data for the specified GUIDs. If this filter is specifed, all other filters will be ignored.

Example: filterIds={id},{id},{id}

filterStatusesArray of strings(Status)

Provide the values of one or more statuses separated by comma (no spaces). If more than one filter is given, they will be combined with AND. If no value is supplied, active is assumed.

Items Enum"active""inactive""deleted"

Example: filterStatuses=active,inactive

filterDisciplineIdsArray of strings(CompactUUID)

provide the GUIDs of one or more disciplines separated by comma (no spaces). If more than one filter is given, they will be combined with AND.

Example: filterDisciplineIds={id},{id},{id}

dataQuantitystring

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 "id_only"

Enum"id_only""basic""complete"

Example: dataQuantity=id_only

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"nameLong""nameShort""nameInitials"

sortDirectionstring

The sort direction for the results

Enum"asc""desc"

curl -i -X GET \
  'https://developers-internal.tonicdm.com/_mock/tonicdm-product/core/brands?dataQuantity=id_only&filterDisciplineIds={id}%2C{id}%2C{id}&filterIds={id}%2C{id}%2C{id}&filterStatuses=active%2Cinactive&pageNumber=1&pageSize=100&searchQuery={%22example%22}&sortBy=nameLong&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}$

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.

brandNameLegalstring<= 128 characters

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

brandNameKnownAsstring<= 128 characters

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

brandInitialsstring<= 4 characters

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

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

Brand color for the Brand.

disciplinesArray of strings(CompactUUID)

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

Example: ["8e8aa42241794371ae9d0ed7b67a8c86"]

certificationsArray of strings(CompactUUID)

Zero or more certifications that this Brand has obtained, or previously obtained, for example Women Owned Business. Use of this feature requires the TonicDM AdvancedContacts license. Use of this feature requires the TonicDM AdvancedContacts license.

Example: ["8e8aa42241794371ae9d0ed7b67a8c86"]

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

Example: "8e8aa42241794371ae9d0ed7b67a8c86"

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[ 0 .. 40 ] characters

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

customerErpIdstring[ 0 .. 40 ] characters

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

customerCrmIdstring[ 0 .. 40 ] characters

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": "39f81d26576d41a285504fac5cc0d215",
    "datetimeCreated": "2021-11-03T16:21:02+00:00",
    "datetimeUpdated": "2024-04-20T16:21:02+00:00",
    "status": "active",
    "domains": [ … ],
    "nameLong": "Pacific Architects and Engineers Inc.",
    "nameShort": "Pacific",
    "nameInitials": "PAE",
    "brandColor": "0F6CBD",
    "organizationId": "f3efcad7082d4e85ae2741a57629b323",
    "isPrime": true,
    "customerDataWarehouseId": 675,
    "customerErpId": "8b37e6b2-786e-4546-93e8-d6760e71bed4",
    "customerCrmId": "8a12f0af-249d-435b-b997-2034fd472ff8"
  },
  {
    "id": "5af9258c92204f79b589ddf511f41604",
    "datetimeCreated": "2021-11-03T16:21:02+00:05",
    "datetimeUpdated": "2024-04-20T16:21:02+00:05",
    "status": "active",
    "domains": [ … ],
    "nameLong": "Steve Novosel",
    "nameInitials": "SN",
    "organizationId": "6c09ed8ddce440fab1319530ce22fd67",
    "customerDataWarehouseId": 987,
    "customerErpId": "ae656d88-c979-4e11-ba0b-695b61fa7f5d",
    "customerCrmId": "9a6d37ef-fc9d-43ee-ac78-678c273cc1e8"
  }
]

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/json

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

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.

brandNameLegalstring<= 128 characters

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

brandNameKnownAsstring<= 128 characters

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

brandInitialsstring<= 4 characters

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

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

Brand color for the Brand.

disciplinesArray of strings(CompactUUID)

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

Example: ["8e8aa42241794371ae9d0ed7b67a8c86"]

certificationsArray of strings(CompactUUID)

Example: ["8e8aa42241794371ae9d0ed7b67a8c86"]

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

Example: "8e8aa42241794371ae9d0ed7b67a8c86"

isPrimeboolean

customerDataWarehouseIdstring[ 0 .. 40 ] characters

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

customerErpIdstring[ 0 .. 40 ] characters

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

customerCrmIdstring[ 0 .. 40 ] characters

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"
    ],
    "brandNameLegal": "string",
    "brandNameKnownAs": "string",
    "brandInitials": "stri",
    "brandColor": "string",
    "disciplines": [
      "8e8aa42241794371ae9d0ed7b67a8c86"
    ],
    "certifications": [
      "8e8aa42241794371ae9d0ed7b67a8c86"
    ],
    "organizationId": "8e8aa42241794371ae9d0ed7b67a8c86",
    "isPrime": true,
    "customerDataWarehouseId": "string",
    "customerErpId": "string",
    "customerCrmId": "string"
  }'

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

brandNameLegalstring<= 128 characters

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

brandNameKnownAsstring<= 128 characters

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

brandInitialsstring<= 4 characters

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

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

Brand color for the Brand.

disciplinesArray of strings(CompactUUID)

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

Example: ["8e8aa42241794371ae9d0ed7b67a8c86"]

certificationsArray of strings(CompactUUID)

Example: ["8e8aa42241794371ae9d0ed7b67a8c86"]

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

Example: "8e8aa42241794371ae9d0ed7b67a8c86"

isPrimeboolean

customerDataWarehouseIdstring[ 0 .. 40 ] characters

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

customerErpIdstring[ 0 .. 40 ] characters

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

customerCrmIdstring[ 0 .. 40 ] characters

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"
  ],
  "brandNameLegal": "string",
  "brandNameKnownAs": "string",
  "brandInitials": "stri",
  "brandColor": "string",
  "disciplines": [
    "8e8aa42241794371ae9d0ed7b67a8c86"
  ],
  "certifications": [
    "8e8aa42241794371ae9d0ed7b67a8c86"
  ],
  "organizationId": "8e8aa42241794371ae9d0ed7b67a8c86",
  "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. If this filter is specifed, all other filters will be ignored.

Example: filterIds={id},{id},{id}

filterOrganizationIds. If more than one filter is given, they will be combined with AND.Array of strings(CompactUUID)

Returns data for the specified Organization GUIDs

Example: filterOrganizationIds. If more than one filter is given, they will be combined with AND.={OrganizationId},{OrganizationId},{OrganizationId}

filterStatusesArray of strings(Status)

Provide the values of one or more statuses separated by comma (no spaces). If more than one filter is given, they will be combined with AND. If no value is supplied, active is assumed.

Items Enum"active""inactive""deleted"

Example: filterStatuses=active,inactive

dataQuantitystring

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 "id_only"

Enum"id_only""basic""complete"

Example: dataQuantity=id_only

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=id_only&filterIds={id}%2C{id}%2C{id}&filterOrganizationIds.%20If%20more%20than%20one%20filter%20is%20given%2C%20they%20will%20be%20combined%20with%20AND.={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}$

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": { … }
  },
  {
    "id": "306b14664e374877ab19b75685393cf7",
    "organizationId": "da9c62640a894f61b247801a2e300c44",
    "status": "inactive",
    "name": "Fairyville",
    "phone": { … }
  }
]

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

Operations

Notes

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

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

TonicDM Product API (0.0.5)

Organizations

Get Brands

Request

Responses

Was this helpful?

Edit a Brand

Request

Responses

Was this helpful?

Get Offices

Request

Responses

Was this helpful?

People

Projects

Teams

Groups

Notes

Disciplines

Certifications

Filesets

Manual Uploading

Cloud File Systems

Correspondence

File Transfers

RFIs

Submittals

PCOs

COs

Tasks