HD API

Provide Progress, Resource and "Actual Cost" Updates

Updating HD with data from your other systems is easy when using the HD API. The HD API (Application Programming Interface) provides an automated method for updating HD with data from other systems to create new records, update existing records, or delete records automatically. By extracting the data from your other systems into an XML format supported by HD and submitting the XML data, HD will “listen” for the data and automatically update the appropriate projects. Currently, the HD API supports two types of data, Resource Rates and Job Tracking Details.

The HD API is a Windows service that “listens” for an XML file in a supported format on either a TCP/IP or HTTP port. The API requires that the XML data be submitted from the source system to the HD API Server so that HD can “pick up” the data. 

NOTE: The HD API Server can be installed on a dedicated server or on the same server where the HD Server application is installed.

The HD API supports three (3) operations:

• Insert – Creates new records (i.e. creates new resource rate records or job tracking detail records)
• Update – Updates existing records (i.e. updates existing resource rate records or job tracking detail records)
• Delete – Deletes existing records (i.e. deletes existing resource rate records or job tracking detail records)

Effective use of the HD API assumes that the records that are created (inserted) are “tracked” so that the Update and Delete operations can be carried out effectively in the future. The Insert operation allows the source system to generate a unique identifier for each record created (inserted). The API will return this unique identifier along with HD’s internal unique identifier allowing the user of the API to build a cross reference table that maps this information for future update and delete operations. 

Update and Delete operations require HD’s unique identifier in order to locate the appropriate record in HD. This requires the API user to “track” the HD unique identifiers to support these operations.

Back to Top