People
/
Edit Person

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

People

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

Operations

New Person

Request

If required, the EmailAddress can be merged into an existing Person as a second step. Note that Person records can only be manipulated if the customer has an AdvancedContacts license.

Similarly, adding an Office to the Person needs to be done using PATCH to the /persons endpoint submitting and officeId that would have been looked up using GET to the /offices endpoint submitting the organizationId returned in the response body.

Bodyapplication/json
emailAddressesArray of objects(PersonEmailAddressWithId)

Zero or more email addresses that person currently uses, or previously used.

curl -i -X POST \
  https://developers-internal.tonicdm.com/_mock/tonicdm-product/core/persons \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "emailAddresses": [
      {
        "id": "8e8aa42241794371ae9d0ed7b67a8c86",
        "personId": "8e8aa42241794371ae9d0ed7b67a8c86",
        "status": "active",
        "emailAddress": "user@example.com",
        "name": "string",
        "title": "string",
        "deskphoneCountryCode": 0,
        "deskphoneNumber": 0,
        "deskphoneExtension": 0,
        "mobilephoneCountryCode": 0,
        "mobilephoneNumber": 0,
        "dateActive": "2019-08-24",
        "dateInactive": "2019-08-24",
        "isPrime": true,
        "customerDataWarehouseId": "string",
        "customerErpId": "string",
        "customerCrmId": "string"
      }
    ]
  }'

Responses

Successfully created the resource you sent

Bodyapplication/json
idstring(CompactUUID)^[0-9a-fA-F]{32}$
Example: "8e8aa42241794371ae9d0ed7b67a8c86"
emailAddressesArray of objects(PersonEmailAddressWithId)

Zero or more email addresses that person currently uses, or previously used.

Response
application/json
{
  "id": "496061e05a9b43a98d7cdfb0ad15e158",
  "datetimeCreated": "2021-11-03T16:21:02+00:01",
  "datetimeUpdated": "2024-04-20T16:21:02+00:01",
  "status": "active",
  "emailAddresses": [
    { … }
  ],
  "name": "Steve Novosel",
  "title": "Architect",
  "deskPhone": null,
  "mobilePhone": null,
  "office": {
    "id": "570e423760dc4c9784d20a38216f0597",
    "datetimeCreated": "2021-11-03T16:21:02+00:01",
    "datetimeUpdated": "2024-04-20T16:21:02+00:01",
    "status": "active",
    "name": "London",
    "address": "123 Dundas Street\\nLondon",
    "phoneCountryCode": 1,
    "phoneNumber": 3107419309
  },
  "disciplines": null,
  "certifications": null,
  "customerDataWarehouseId": 124,
  "customerErpId": "fc95ced9-8c56-4a53-89b2-1c7217ea5a9c",
  "customerCrmId": "fcdaf58d-5497-47a2-af3d-077c928eda27"
}

Edit Person

Request

Note that you cannot change the Organization that a person belongs to as this is determined automatically by TonicDM. To delete a Person, PATCH their status to inactive or deleted (soft deleted).

Bodyapplication/json
idstring(CompactUUID)^[0-9a-fA-F]{32}$
Example: "8e8aa42241794371ae9d0ed7b67a8c86"
emailAddressesArray of objects(PersonEmailAddressWithId)

Zero or more email addresses that person currently uses, or previously used.

curl -i -X PATCH \
  https://developers-internal.tonicdm.com/_mock/tonicdm-product/core/persons \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "8e8aa42241794371ae9d0ed7b67a8c86",
    "emailAddresses": [
      {
        "id": "8e8aa42241794371ae9d0ed7b67a8c86",
        "personId": "8e8aa42241794371ae9d0ed7b67a8c86",
        "status": "active",
        "emailAddress": "user@example.com",
        "name": "string",
        "title": "string",
        "deskphoneCountryCode": 0,
        "deskphoneNumber": 0,
        "deskphoneExtension": 0,
        "mobilephoneCountryCode": 0,
        "mobilephoneNumber": 0,
        "dateActive": "2019-08-24",
        "dateInactive": "2019-08-24",
        "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"
emailAddressesArray of objects(PersonEmailAddressWithId)

Zero or more email addresses that person currently uses, or previously used.

Response
application/json
{
  "id": "1edb8a0bb607442ba167b9d28a75778c",
  "datetimeCreated": "2021-11-03T16:21:02+00:02",
  "datetimeUpdated": "2024-04-20T16:21:02+00:02",
  "status": "active",
  "emailAddresses": [
    { … },
    { … }
  ],
  "name": "Stuart de Silva",
  "title": "Senior Designer",
  "deskPhone": null,
  "mobilePhone": null,
  "office": {
    "id": "89df34cecd394e179436abc435368e53",
    "datetimeCreated": "2021-11-03T16:21:02+00:02",
    "datetimeUpdated": "2024-04-20T16:21:02+00:02",
    "status": "active",
    "name": "Dublin",
    "address": "50 Merrion Square South\\nDublin",
    "phoneCountryCode": 1,
    "phoneNumber": 3107419309
  },
  "disciplines": null,
  "certifications": null,
  "customerDataWarehouseId": 125,
  "customerErpId": "1b8c8dfc-daeb-42fd-8f50-b709a6dadf1a",
  "customerCrmId": "39b1011e-e21a-4518-8825-7b63f2fabe92"
}

Get Staff

Request

Gets data on one or more Staff: emailAddresses in the User's own Organization with an email address of Type business. This endpoint does not return Person objects. It returns emailAddress objects.

If called with no parameters (ie. /staff) it will return data for all Staff emailAddress records in no specific order.

Since emailAddress records contain full contact data, a specific set of staff' contact data can be returned by providing the filterIds parameter with an array of emailAddress id's (ie. /core/staff with filterIds={emailAddressId},{emailAddressId}).

If caching the emailAddress data on the client side, the data_quantity=id_only option can be chosen to get the list of GUIDs that match the filtering/sorting/paging requirements, with the emailAddress data coming from your client side cache, having been retrieved by providing the filterIds parameter.

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}
filterOfficeIdsArray of strings(CompactUUID)

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

Example: filterOfficeIds={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"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/staff?dataQuantity=id_only&filterDisciplineIds={id}%2C{id}%2C{id}&filterIds={id}%2C{id}%2C{id}&filterOfficeIds={id}%2C{id}%2C{id}&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 [
emailAddressesArray of objects(PersonEmailAddressWithId)

Zero or more email addresses that person currently uses, or previously used.

personIdstring(uuid)read-only

This joins the User Settings to the Person record, which rolls up the email addresses.

dailyReminderboolean

Indicates whether the person will be sent a daily reminder email.

Default false
isOrganizationManagerintegerread-only

Indicates whether the person is a TonicDM Administrator for the Tenant. This setting can only be changed by TonicDM Support. Currently the only valid values are 0 and 1, but in future this will be a bitwise field indicating different types of administrator.

Default 0
timezonestringread-only

Offset from UTC for the user's location. This is set automatically by the TonicDM application based on the information provided by their browser.

division1object(Division)

The division of the Organization that is assigned to the Project or Person. This allows filters/metrics by things like Market Sector or Studio.

Use of this feature requires the TonicDM AdvancedMetrics license.

division2object(Division)

The division of the Organization that is assigned to the Project or Person. This allows filters/metrics by things like Market Sector or Studio.

Use of this feature requires the TonicDM AdvancedMetrics license.

division3object(Division)

The division of the Organization that is assigned to the Project or Person. This allows filters/metrics by things like Market Sector or Studio.

Use of this feature requires the TonicDM AdvancedMetrics license.

division4object(Division)

The division of the Organization that is assigned to the Project or Person. This allows filters/metrics by things like Market Sector or Studio.

Use of this feature requires the TonicDM AdvancedMetrics license.

datetimeLastSeenstring(date-time)read-only

The date and time the user was last seen. This is when they last made an interactive call to the API.

]
Response
application/json
[
  {
    "emailAddresses": [ … ],
    "personId": "f3e5ff26-28ff-4cd6-9b1b-e303a185a13a",
    "dailyReminder": false,
    "isOrganizationManager": 0,
    "timezone": "string",
    "division1": { … },
    "division2": { … },
    "division3": { … },
    "division4": { … },
    "datetimeLastSeen": "2019-08-24T14:15:22Z"
  }
]

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