Titan API Help Page

Introduction

Documentation for the Titan Application Programming Interface (API).

Request Authentication

There are specific requirements to sign your API calls using an HMAC algorithm. See Request Authentication for more information.

Atgs

ATG operations.

API	Description
GET v1/Clients/{clientId}/Atgs?updatedSinceUtc={updatedSinceUtc}&facilityIds={facilityIds}&includeDeleted={includeDeleted}	Gets ATGs.

CitldsResults

SIR operations.

API	Description
GET v1/Clients/{clientId}/CitldsResults?facilityId={facilityId}&tankId={tankId}&year={year}&month={month}	Gets all CITLDS Results for the client that match the query, if provided. Will not include file bytes. If you need file bytes, use v1/Clients/{clientId}/CitldsResults/Files
GET v2/Clients/{clientId}/CitldsResults?facilityId={facilityId}&tankId={tankId}&firstDateOfPeriod={firstDateOfPeriod}&lastDateOfPeriod={lastDateOfPeriod}	Gets all CITLDS Results for the client that match the query, if provided. Will not include file bytes. If you need file bytes, use v2/Clients/{clientId}/CitldsResults/Files
GET v1/Clients/{clientId}/CitldsResults/Files?facilityId={facilityId}&year={year}&month={month}	Gets all CITLDS Result Files for the given client, facility, year, and month. Facility, year, and month are required. File bytes will be returned.
GET v2/Clients/{clientId}/CitldsResults/Files?facilityId={facilityId}&firstDateOfPeriod={firstDateOfPeriod}&lastDateOfPeriod={lastDateOfPeriod}	Gets all CITLDS Result Files for the given client, facility, firstDateOfPeriod, and lastDateOfPeriod. Facility, year, and month are required. File bytes will be returned.
POST v1/Clients/{clientId}/CitldsResults	Post a CITLDS Result.
POST v2/Clients/{clientId}/CitldsResults	Post a CITLDS Result.

Clients

Client operations.

API	Description
GET v1/Clients	Gets all active clients.
GET v1/Clients/{clientId}	Gets the specified client.

Common

Common operations.

API	Description
GET v1/Common/CountryCodes	Gets all country codes.
GET v1/Common/StateProvinceCodes?countryCode={countryCode}	Gets all state/province codes.
GET v1/Common/TimeZones	Gets all Time Zones.
GET v1/Common/SupportedLanguages	Gets all Supported Languages.
GET v1/Common/Counties?stateProvince={stateProvince}	Gets counties. Filters by state/province if provided.

Contacts

Contacts operations.

API	Description
GET v1/Clients/{clientId}/Contacts?unassociatedOnly={unassociatedOnly}&facilityId={facilityId}&contactTypeReferenceId={contactTypeReferenceId}	Gets a list of contacts matching the provided parameters.
GET v1/Clients/{clientId}/Contacts/{contactId}/FacilityAssociations	Gets a list of Facility Associations for a specific contact.
POST v1/Clients/{clientId}/Contacts/{contactId}/FacilityAssociations	Creates an association between a contact and a facility.
POST v1/Clients/{clientId}/Contacts	Creates a contact.
PUT v1/Clients/{clientId}/Contacts/{contactId}	Updates a contact.
DELETE v1/Clients/{clientId}/Contacts/{contactId}	Deletes a contact.

Diagnostics

System diagnostics.

API	Description
GET v1/Time	Gets the current server time. Requests made to this action are exempt from the clock variance requirements for request authentication.

EFiles

E-File operations.

API	Description
POST v1/Clients/{clientId}/EFiles	Uploads the provided e-file to the system.
POST v2/Clients/{clientId}/EFiles	Uploads the provided e-file to the system.
GET v1/Clients/{clientId}/EFiles/{eFileId}	Retrieves the requested E-File, including the E-File’s bytes.
GET v2/Clients/{clientId}/EFiles/{eFileId}	Retrieves the requested E-File, including the E-File’s bytes.
GET v1/Clients/{clientId}/EFiles?facilityId={facilityId}&eFileApplicationReferenceId={eFileApplicationReferenceId}	Retrieves a list E-Files matching the provided parameters. The bytes of each E-File are not included.
GET v2/Clients/{clientId}/EFiles?facilityId={facilityId}&eFileApplicationReferenceId={eFileApplicationReferenceId}	Retrieves a list E-Files matching the provided parameters. The bytes of each E-File are not included.
DELETE v1/Clients/{clientId}/EFiles/{eFileId}	Deletes a specific E-File.

Facilities

Facility operations.

API	Description
GET v1/Clients/{clientId}/Facilities	Gets all active facilities.
GET v2/Clients/{clientId}/Facilities?updatedSinceUtc={updatedSinceUtc}&facilityIds={facilityIds}&includeDeleted={includeDeleted}	Gets all active facilities.
GET v3/Clients/{clientId}/Facilities?updatedSinceUtc={updatedSinceUtc}&createdSinceUtc={createdSinceUtc}&facilityIds={facilityIds}&includeDeleted={includeDeleted}&facilityNameMatch={facilityNameMatch}	Gets facilities.
GET v1/Clients/{clientId}/Facilities/{facilityId}	Gets the specified facility.
GET v3/Clients/{clientId}/Facilities/{facilityId}	Gets the specified facility.
PUT v3/Clients/{clientId}/Facilities/{facilityId}	Updates the specified facility.

FacilityGroups

Facility Group operations.

API	Description
GET v1/Clients/{clientId}/FacilityGroups	Gets all active Facility Groups that match the query, if provided.

InspectionProfiles

Inspection Profile operations.

API	Description
GET v1/Clients/{clientId}/InspectionProfiles?facilityId={facilityId}	Gets all active Inspection Profiles for the given facility.
GET v2/Clients/{clientId}/InspectionProfiles?facilityId={facilityId}	Gets all active Inspection Profiles for the given facility.
GET v3/Clients/{clientId}/InspectionProfiles?facilityId={facilityId}	Gets all active Inspection Profiles for the given facility.
GET v1/Clients/{clientId}/InspectionProfiles/{inspectionProfileId}	Gets the specified Inspection Profile.
GET v1/Clients/{clientId}/InspectionProfiles/{inspectionProfileId}/Inspectors?facilityId={facilityId}	Gets a list of available Inspectors for a Inspection Profile and Facility.

Inspections

Inspection operations.

API	Description
GET v1/Clients/{clientId}/Inspections?facilityId={facilityId}	Gets all active Inspections.
GET v2/Clients/{clientId}/Inspections?facilityId={facilityId}	Gets all active Inspections.
GET v3/Clients/{clientId}/Inspections?facilityId={facilityId}	Gets all active Inspections.
GET v1/Clients/{clientId}/Inspections/{inspectionId}	Gets the specified Inspection.
GET v2/Clients/{clientId}/Inspections/{inspectionId}	Gets the specified Inspection.
GET v3/Clients/{clientId}/Inspections/{inspectionId}	Gets the specified Inspection.
POST v1/Clients/{clientId}/Inspections	Creates an inspection based on the provided InspectionBaseInformation.
PUT v1/Clients/{clientId}/Inspections/{inspectionId}	Updates the specified Inspection.
PUT v2/Clients/{clientId}/Inspections/{inspectionId}	Updates the specified Inspection.
PUT v3/Clients/{clientId}/Inspections/{inspectionId}	Updates the specified Inspection.
DELETE v1/Clients/{clientId}/Inspections/{inspectionId}	Deletes a specific inspection.
DELETE v1/Clients/{clientId}/Inspections/{inspectionId}?deleteEfiles={deleteEfiles}&deleteActivities={deleteActivities}	Deletes an inspection along with allowing for deletion of efiles and activities associated.
POST v1/Clients/{clientId}/Inspections/Questions/{questionId}/Attachments	Get an attachment to the specified inspection question by file name.
GET v1/Clients/{clientId}/Inspections/{inspectionId}/Questions/{questionId}/Attachments/{attachmentId}	Get an attachment to the specified inspection question.
POST v1/Clients/{clientId}/Inspections/{inspectionId}/Questions/{questionId}/Attachments	Get an attachment to the specified inspection question.
POST v1/Clients/{clientId}/Inspections/{inspectionId}/Questions/{questionId}/Attachments/{attachmentId}	Update an attachment notes associated with a specified inspection question.
DELETE v1/Clients/{clientId}/Inspections/{inspectionId}/Questions/{questionId}/Attachments/{attachmentId}	Deletes an attachment associated with a specified inspection question.
GET v1/Clients/{clientId}/Inspections/Enumerations	Gets all Enumerations and Values.
GET v1/Clients/{clientId}/Inspections/Enumerations/{enumerationName}	Gets Values for specified Enumeration.
GET v1/Clients/{clientId}/Inspections/{inspectionId}/Exists	Check if inspection exists.
POST v1/Clients/{clientId}/Inspections/{inspectionId}/SourceDetails	Save details about the inspection's source.

InventoryVariance

Inventory Variance operations.

API	Description
GET v1/Clients/{clientId}/InventoryVariance?facilityId={facilityId}&tankId={tankId}&startDate={startDate}&endDate={endDate}	Gets all active InventoryVariance for the client.
POST v1/Clients/{clientId}/InventoryVariances	Adds one or more InventoryVariance.
POST v1/Clients/{clientId}/InventoryVariance	Adds one inventory.

PollingService

The polling service allows API to access functionality provided by the polling engine service.

API	Description
GET v1/Clients/{clientId}/PollNow?facilityId={facilityId}	Enqueues a poll now polling set for the given facility with the polling engine. Asynchronous process to request event, get a successful response that queued and separate asynchronous process to update data values.

ProblemCodes

Work Order Problem Code operations (require API Facility Maintenance Subscription).

API	Description
GET v1/Clients/{clientId}/ProblemCodes	Gets all active Problem Codes that match the query, if provided.

References

Reference operations.

API	Description
GET v1/Clients/{clientId}/References?type={type}	Gets all active references that match the query, if provided.
GET v1/Clients/{clientId}/References/{id}	Gets the specified reference.

Security

Security related operations

API	Description
POST v1/Security/AccessCredentials	Provision a new set of access credentials for the user.
GET v1/Security/AccessPermissions	Get a list of permissions the current user has access to.
POST v1/Security/ResetPassword	Resets password and sends user an email.
GET v1/Clients/{clientId}/Security/UserAccounts?RoleId={RoleId}&FacilityId={FacilityId}	Gets the User Accounts.
GET v1/Clients/{clientId}/Security/UserRoles	Gets the User Roles.
GET v1/Clients/{clientId}/Security/UserAccounts/{userId}	Gets the specified User Account.
POST v1/Clients/{clientId}/Security/UserAccounts	Creates an User Account based on the provided User Account information.
PUT v1/Clients/{clientId}/Security/UserAccounts	Updates the specified user account.
DELETE v1/Clients/{clientId}/Security/UserAccounts/{userId}	Deletes a specific user account.

ServiceChannelWorkOrder

The ServiceChannelWorkOrder controller class.

API	Description
POST v1/Clients/{clientId}/ServiceChannelWorkOrders?accessKey={accessKey}&signingKey={signingKey}	Updates a ServiceChannel work order's associated activity, if there is one. The access key and signing key must be provided via the query string.

SirResults

SIR operations.

API	Description
GET v1/Clients/{clientId}/SirResults?facilityId={facilityId}&tankId={tankId}&year={year}&month={month}	Gets all SIR Results for the client that match the query, if provided. Will not include file bytes. If you need file bytes, use v1/Clients/{clientId}/SirResults/Files
GET v2/Clients/{clientId}/SirResults?facilityId={facilityId}&tankId={tankId}&firstDateOfPeriod={firstDateOfPeriod}&lastDateOfPeriod={lastDateOfPeriod}	Gets all SIR Results for the client that match the query, if provided. Will not include file bytes. If you need file bytes, use v2/Clients/{clientId}/SirResults/Files
GET v1/Clients/{clientId}/SirResults/Files?facilityId={facilityId}&year={year}&month={month}	Gets all SIR Result Files for the given client, facility, year, and month. Facility, year, and month are required. File bytes will be returned.
GET v2/Clients/{clientId}/SirResults/Files?facilityId={facilityId}&firstDateOfPeriod={firstDateOfPeriod}&lastDateOfPeriod={lastDateOfPeriod}	Gets all SIR Result Files for the given client, facility, firstDateOfPeriod, and lastDateOfPeriod. Facility, year, and month are required. File bytes will be returned.
POST v1/Clients/{clientId}/SirResults	Post a SIR Result.
POST v2/Clients/{clientId}/SirResults	Post a SIR Result.

SubProblemCodes

Work Order Sub-Problem Code operations (require API Facility Maintenance Subscription).

API	Description
GET v1/Clients/{clientId}/SubProblemCodes	Gets all active Problem Codes that match the query, if provided.

TankDelivery

Tank Delivery operations.

API	Description
GET v1/Clients/{clientId}/TankDelivery?startDate={startDate}&endDate={endDate}&startCollectionDateUtc={startCollectionDateUtc}	Gets all tanks' Delivery for a given client (not sub-clients), startDate and endDate are optional.
GET v1/Clients/{clientId}/TankDelivery?facilityId={facilityId}&startDate={startDate}&endDate={endDate}&startCollectionDateUtc={startCollectionDateUtc}	Gets all tanks' Delivery for a given facility, startDate and endDate are optional.
GET v1/Clients/{clientId}/TankDelivery?facilityId={facilityId}&tankId={tankId}&startDate={startDate}&endDate={endDate}&startCollectionDateUtc={startCollectionDateUtc}	Get a specific tank's Delivery, startDate and endDate are optional

TankInventory

Tank Inventory operations.

API	Description
GET v1/Clients/{clientId}/TankInventory?startCollectionDateUtc={startCollectionDateUtc}	Gets all tanks' inventory for a given client (not sub-clients).
GET v1/Clients/{clientId}/TankInventory?facilityId={facilityId}&startCollectionDateUtc={startCollectionDateUtc}	Gets all tanks' inventory for a given facility.
GET v1/Clients/{clientId}/TankInventory?facilityId={facilityId}&tankId={tankId}&startCollectionDateUtc={startCollectionDateUtc}	Get a specific tank's inventory
GET v1/Clients/{clientId}/TankInventoryHistory?facilityId={facilityId}&tankId={tankId}&collectionDateUtc={collectionDateUtc}	Get a specific tank's inventory history

Tanks

Tank operations.

API	Description
GET v1/Clients/{clientId}/Tanks?facilityId={facilityId}	Gets all active tanks for the client that match the query, if provided.

TechVendors

Tech/Vendor operations (require API Facility Maintenance Subscription).

API	Description
GET v1/Clients/{clientId}/TechVendors	Gets all active Tech/Vendors that match the query, if provided.

WorkOrderComments

Facility Work Order Comments operations (require API Facility Maintenance Subscription).

API	Description
GET v1/Clients/{clientId}/WorkOrders/{workOrderId}/Comments	Gets work order comments.
GET v1/Clients/{clientId}/WorkOrders/{workOrderId}/Comments?commentType={commentType}	Gets work order comment filtered by comment type.
POST v1/Clients/{clientId}/WorkOrder/Comments	Creates a Work Order Comment based on the provided information.

WorkOrders

Facility Work Order operations (require API Facility Maintenance Subscription).

API	Description
GET v1/Clients/{clientId}/WorkOrders?FacilityId={FacilityId}&OpenDateBeginning={OpenDateBeginning}&OpenDateEnding={OpenDateEnding}&CompleteDateBeginning={CompleteDateBeginning}&CompleteDateEnding={CompleteDateEnding}&StartDate={StartDate}&EndDate={EndDate}&LastUpdatedDateTimeUTC={LastUpdatedDateTimeUTC}&VendorId={VendorId}&ProblemCodeId={ProblemCodeId}&SubProblemCodeId={SubProblemCodeId}	Gets active work orders(only return 100 records) that match the query, if provided.
GET v1/Clients/{clientId}/WorkOrderEventTypes	Gets all active Work Order Event Types.
GET v1/Clients/{clientId}/WorkOrderRateTypes	Gets all active Work Order Rate Types.
GET v1/Clients/{clientId}/WorkOrderCauseCodes	Gets all active Work Order Cause Codes.
PUT v1/Clients/{clientId}/WorkOrders/{workOrderId}	Updates a Work Order based on the provided information.

WorkOrderStatus

Facility Work Order Statuses operations (require API Facility Maintenance Subscription).

API	Description
GET v1/Clients/{clientId}/WorkOrders/{workOrderId}/StatusHistory	Gets work order statuses.
GET v1/Clients/{clientId}/WorkOrders/{workOrderId}/StatusHistory?latest={latest}	Gets latest work order status.
PUT v1/Clients/{clientId}/WorkOrders/{workOrderId}/UpdateStatus?eventTypeId={eventTypeId}	Updates a Work Order Status based on the provided information.