D-Tools SI API Documentation

Introduction

The API allows integrations to:

Publish catalogs and projects to SI users.
Subscribe to projects and catalogs published by SI users.

All API calls must pass an API key in the request header. The API key can be generated in SI 2016 Control Panel using the 'Manage Integrations' feature.
An API key is specific to a SI user and an integration.
API callers must add to each call a custom header named X-DTSI-ApiKey along with the value of the API key.
For example, if the API key value is q54R39UBr0Skgd7VHvEbuwiRAOArUpt02o7z/vY+iwrg, the custom header would be as follows:
X-DTSI-ApiKey: q54R39UBr0Skgd7VHvEbuwiRAOArUpt02o7z/vY+iwrg

PublishProjects

Allows an integration to publish or update a project to a SI user.

API	Description
POST https://api.d-tools.com/SI/Publish/Projects	Publish a new project to SI.
POST https://api.d-tools.com/SI/Publish/Projects/Update	Update an existing project in SI
POST https://api.d-tools.com/SI/Publish/Projects/NewChangeOrder	Publish new change order to existing SI project.
POST https://api.d-tools.com/SI/Publish/Projects/ArchiveProjects	Mark existing SI projects as archived (must be checked in) (BETA).
POST https://api.d-tools.com/SI/Publish/Projects/UnarchiveProjects	Mark existing SI projects as unarchived (BETA).
POST https://api.d-tools.com/SI/Publish/Projects/ProjectComments	Publish comments to an existing SI project (BETA).

SubscribeProjects

Allows an integration to subscribe to projects and change orders published by SI users.

API	Description
PUT https://api.d-tools.com/SI/Subscribe/Projects/MarkAsImported?id={id}&coNumber={coNumber}	Mark a project or change order as imported for a given project id.
GET https://api.d-tools.com/SI/Subscribe/Projects/GetProjectComments?id={id}&pageNumber={pageNumber}&pageSize={pageSize}	Get project comments published by a SI user.
GET https://api.d-tools.com/SI/Subscribe/Projects?clients[0]={clients[0]}&clients[1]={clients[1]}&progresses[0]={progresses[0]}&progresses[1]={progresses[1]}&includeImported={includeImported}&includeArchived={includeArchived}&searchText={searchText}&includeDeleted={includeDeleted}&pageNumber={pageNumber}&pageSize={pageSize}&projectNumber={projectNumber}	Get projects and change orders published by a SI user.
GET https://api.d-tools.com/SI/Subscribe/Projects?id={id}&coNumber={coNumber}&aggregateBy={aggregateBy}&getAdjustmentsByItem={getAdjustmentsByItem}	Get a specific project or change order for a given project id published by a SI user.

SubscribePartialProjects

Allows an integration to subscribe to partial projects published by SI users.

API	Description
PUT https://api.d-tools.com/SI/SubscribePartialProjects/MarkAsImported?messageId={messageId}	Mark a partial project as imported for a given message id.
GET https://api.d-tools.com/SI/SubscribePartialProjects/Projects?clients[0]={clients[0]}&clients[1]={clients[1]}&progresses[0]={progresses[0]}&progresses[1]={progresses[1]}&includeImported={includeImported}&searchText={searchText}&includeDeleted={includeDeleted}&pageNumber={pageNumber}&pageSize={pageSize}&projectNumber={projectNumber}	Get partial projects published by a SI user .
GET https://api.d-tools.com/SI/SubscribePartialProjects/Projects?messageId={messageId}&aggregateBy={aggregateBy}&getAdjustmentsByItem={getAdjustmentsByItem}	Get a specific partial project for a given message id published by a SI user.

PublishTasks

Allows an integration to publish a task to a SI user.

API	Description
POST https://api.d-tools.com/SI/Publish/UpdateTask	Update an existing task in SI.
POST https://api.d-tools.com/SI/Publish/Task	Publish a new task to SI.

SubscribeTask

Allows an integration to subscribe to Tasks published by SI users.

API	Description
PUT https://api.d-tools.com/SI/Subscribe/Task/MarkAsImported?id={id}	Mark a task as imported for a given task id.
GET https://api.d-tools.com/SI/Subscribe/Task/GetMobileInstallSiteNotes?id={id}	Get Mobile Install task site notes for a given task id
GET https://api.d-tools.com/SI/Subscribe/Tasks?clients[0]={clients[0]}&clients[1]={clients[1]}&progresses[0]={progresses[0]}&progresses[1]={progresses[1]}&projectId={projectId}&includeImported={includeImported}&searchText={searchText}&includeDeleted={includeDeleted}&pageNumber={pageNumber}&pageSize={pageSize}	Get tasks published by a SI user.
GET https://api.d-tools.com/SI/Subscribe/Tasks?projectId={projectId}	Get a tasks for a given project id.
GET https://api.d-tools.com/SI/Subscribe/Tasks?id={id}	Get a task for a given task id.

PublishServiceOrders

Allows an integration to publish a service order to a SI user.

API	Description
POST https://api.d-tools.com/SI/Publish/UpdateServiceOrder	Update an existing service order in SI.
POST https://api.d-tools.com/SI/Publish/ServiceOrder	Publish a new service order to SI.

SubscribeServiceOrder

Allows an integration to subscribe to Service orders published by SI users.

API	Description
PUT https://api.d-tools.com/SI/Subscribe/ServiceOrders/MarkAsImported?id={id}	Mark a service order as imported for a given service order id.
GET https://api.d-tools.com/SI/Subscribe/ServiceOrder/GetMobileInstallSiteNotes?id={id}	Get Mobile Install service order site notes for a given service order id
GET https://api.d-tools.com/SI/Subscribe/ServiceOrders?clients[0]={clients[0]}&clients[1]={clients[1]}&progresses[0]={progresses[0]}&progresses[1]={progresses[1]}&includeImported={includeImported}&searchText={searchText}&includeDeleted={includeDeleted}&pageNumber={pageNumber}&pageSize={pageSize}	Get service order published by a SI user.
GET https://api.d-tools.com/SI/Subscribe/ServiceOrders?id={id}	Get a service order for a given service order id.

SubscribePurchaseOrder

Allows an integration to subscribe to Purchase orders published by SI users.

API	Description
PUT https://api.d-tools.com/SI/Subscribe/PurchaseOrders/MarkAsImported?id={id}	Mark a purchase order as imported for a given purchase order id.
GET https://api.d-tools.com/SI/Subscribe/PurchaseOrders?vendors[0]={vendors[0]}&vendors[1]={vendors[1]}&statuses[0]={statuses[0]}&statuses[1]={statuses[1]}&includeImported={includeImported}&searchText={searchText}&includeDeleted={includeDeleted}&pageNumber={pageNumber}&pageSize={pageSize}	Get purchase orders published by a SI user.
GET https://api.d-tools.com/SI/Subscribe/PurchaseOrders?id={id}	Get a purchase order for a given purchase order id.

SubscribeServicePlan

Allows an integration to subscribe to Service plan published by SI users.

API	Description
PUT https://api.d-tools.com/SI/Subscribe/ServicePlans/MarkAsImported?id={id}	Mark a service plan as imported for a given service plan id.
GET https://api.d-tools.com/SI/Subscribe/ServicePlans?clients[0]={clients[0]}&clients[1]={clients[1]}&statuses[0]={statuses[0]}&statuses[1]={statuses[1]}&includeImported={includeImported}&searchText={searchText}&includeDeleted={includeDeleted}&pageNumber={pageNumber}&pageSize={pageSize}	Get service plans published by a SI user
GET https://api.d-tools.com/SI/Subscribe/ServicePlans?id={id}	Get a service plan for a given service plan id.

PublishTimeSheets

Allows an integration to publish a time sheet to a SI user.

API	Description
POST https://api.d-tools.com/SI/Publish/UpdateTimeSheets	Update an existing time sheets in SI.
POST https://api.d-tools.com/SI/Publish/TimeSheets	Publish a new time sheet to SI.

SubscribeTimeSheet

Allows an integration to subscribe to Time sheets published by SI users.

API	Description
PUT https://api.d-tools.com/SI/Subscribe/TimeSheets/MarkAsImported?id={id}	Mark a time sheet as imported for a given time sheet id
GET https://api.d-tools.com/SI/Subscribe/TimeSheets?clients[0]={clients[0]}&clients[1]={clients[1]}&includeImported={includeImported}&searchText={searchText}&includeDeleted={includeDeleted}&pageNumber={pageNumber}&pageSize={pageSize}	Get time sheets published by a SI user.
GET https://api.d-tools.com/SI/Subscribe/TimeSheets?id={id}	Get a time sheet for a given time sheet id

PublishProductCatalogs

Allows an integration to publish a product catalog to a SI user.

API	Description
POST https://api.d-tools.com/SI/Publish/ProductCatalogs	Publish a product catalog to a SI user.

SubscribeProductCatalogs

Allows an integration to subscribe to product catalogs published by SI users.

API	Description
PUT https://api.d-tools.com/SI/Subscribe/ProductCatalogs/MarkAsImported?id={id}	Mark a product catalog as imported for a given catalog id.
GET https://api.d-tools.com/SI/Subscribe/ProductCatalogs?includeImported={includeImported}&searchText={searchText}&pageNumber={pageNumber}&pageSize={pageSize}	Get product catalogs published by a SI user.
GET https://api.d-tools.com/SI/Subscribe/ProductCatalogs?id={id}&pageNumber={pageNumber}&pageSize={pageSize}	Get a product catalog for a given catalog id.

PublishClients

Allows an integration to update a client list to a SI user.

API	Description
POST https://api.d-tools.com/SI/Publish/Clients/Update	Update an existing client in SI
POST https://api.d-tools.com/SI/Publish/Clients	Publish a list of clients to SI.

SubscribeClients

Allows an integration to subscribe to clients published by SI users.

API	Description
POST https://api.d-tools.com/SI/Subscribe/Clients/ClientList	Get clients for given client ids published by a SI user. You can pass a maximum of 100 client ids.
POST https://api.d-tools.com/SI/Subscribe/Clients/MarkAsImported	Mark clients as imported for given client ids. You can pass a maximum of 100 client ids.
GET https://api.d-tools.com/SI/Subscribe/Clients?includeImported={includeImported}&searchText={searchText}&includeDeleted={includeDeleted}&pageNumber={pageNumber}&pageSize={pageSize}	Get clients published by a SI user.

Message

API	Description
GET https://api.d-tools.com/SI/Message/PublishedMessageStatus?messageId={messageId}	Get status of a published message.
GET https://api.d-tools.com/SI/Message/PublishedMessagesStatus?messageStatusIds[0]={messageStatusIds[0]}&messageStatusIds[1]={messageStatusIds[1]}&messageTypeIds[0]={messageTypeIds[0]}&messageTypeIds[1]={messageTypeIds[1]}&pageNumber={pageNumber}&pageSize={pageSize}	Get status of published messages.