Integration Toolkit Web Service Wrappers

Last updated
Save as PDF

Wrapper API Specifications

The following list of Integration Toolkit APIs serve as local wrappers for their respective remote Services Portal web services. The wrappers may be called directly from customer integration code.

(plus) = Available in PIT v2.3

Category	Wrapper Specifications	Program name
Vehicle Management	Create Vehicle API	QTVEHCRT
Vehicle Management	Delete Vehicle API	QTDLTVEH
Vehicle Management	Rename Vehicle API	QTVEHRN
Vehicle Management	Change Vehicle API	QTCHGNM
Vehicle Management	Get Vehicle Identifier API	QTVEHID
Vehicle Management	Get Vehicle Information API	QTVEHINFO
Vehicle Management	Get Vehicle Unit Address API	QTVEHUA
Vehicle Management	Ping Vehicle API	QTPNGVEH
Vehicle Management	Change Vehicle Coverage API	QTCHGCVG
Vehicle Management	Add Vehicle to Message Group API	QTADGRP
Vehicle Management	Change Vehicle Message Group API	QTCHGGRP
Vehicle Management	Remove Vehicle from Message Group API	QTRMGRP
Vehicle Management	Change Vehicle License Plate Info API	QTVEHPLT
Vehicle Management	Change Vehicle VIN API	QTVEHVIN
Vehicle Management	Get Vehicle List API	QTVEHLST
Vehicle Inspection Report	VIR Update Inspection Report API	QTUPDVIR
Text and Macro Messaging	Send Text Message (Queued) API	QTCRTMSG
Text and Macro Messaging	Send Text Message (Non-Queued) API	QTSNDMSG
Text and Macro Messaging	Send Binary Message (Non-Queued) API	QTBINMSG
Text and Macro Messaging	Carbon Copy Return Message API	QTCCRMSG
Text and Macro Messaging	Mark Message as Seen API	QTMKSEEN
Text and Macro Messaging	Refresh Local Macro Template Definitions API	IIMACRFSH
Trailer Management	Create Trailer API	TTCRTTRL
Trailer Management	Delete Trailer API	TTDLTTRL
Trailer Management	Get Trailer Information API	TTTRLINFO
Trailer Management	Ping Trailer API	TTPNGTRL
Trailer Management	Rename Trailer API	TTTRLRN
Trailer Management	Set Trailer Type API	TTEDTTYP
Trailer Management	Assign Trailer Monitoring Plan API	TTASGTRL
Trailer Management	Get Scheduled Reefer Monitoring API	T2GETRMON
Trailer Management	Set Scheduled Reefer Monitoring API	T2SETRMON
Trailer Management	Get Trailer ID List API	TTGETLST
Event Subscription Service	ESS High Volume Dequeue API	IIDEQUEUE
Performance Monitoring	Request Extract API	QTVEHRPMEX
Performance Monitoring	Enable Vehicle For ST API	QTVEHPMENA
Performance Monitoring	Disable Vehicle For ST API	QTVEHPMDBL
Performance Monitoring	Change Vehicle Parameter Type API	QTVEHCPMPR
Performance Monitoring	Change Vehicle Management Group API	QTVEHCPMMG
Performance Monitoring	Change Driver Management Group API	QTDRVCPMMG
Performance Monitoring	Create Vehicle Management Group API	QTVEHAMGG
Performance Monitoring	Create Driver Management Group API	QTDRVAMGG
Driver Management	Get Driver ID List API	QTDRVLST
Driver Management	Create Driver API	QTDRVCRT
Driver Management	Get Driver Details API	QTDRVINF
Driver Management	Get Driver Details 2 API	QTDRV2GET
Driver Management	Change Driver Login API	QTDRVCLOG
Driver Management	Change Driver Name API	QTDRVCNAM
Driver Management	Edit Driver 2 API	QTDRV2EDT
Driver Management	Delete Driver API	QTDRVDEL
Global Group Management	Create Global Group API	QTGGCRT
Global Group Management	Edit Global Group API	QTGGEDT
Global Group Management	Delete Global Group API	QTGGDLT
Global Group Management	Add Global Group Members API	QTGGMBRA
Global Group Management	Remove Global Group Members API	QTGGMBRD
Global Group Management	Get Global Group Members API	QTGETDGGM
User, Role and Company Management	Get User List API	OMUSRLST
Hours of Service (Carrier)	HOS Add Carrier API	HSCARCR
Hours of Service (Carrier)	HOS Update Driver's Carrier API	HSCARUP
Hours of Service (Depot)	HOS Create Depot API	HSDEPCR
Hours of Service (Drivers)	HOS Export Driver Information API	HSDRVEXP
Hours of Service (Drivers)	HOS Export Driver by Depot ID API	HSDRVEXD
Hours of Service (Drivers)	HOS Get Driver Properties	QCHOSDRVG
Hours of Service (Drivers)	HOS Add Driver Group	QCHOSDRVGA
Hours of Service (Drivers)	HOS Update Driver Extended	HSDRVUX
Hours of Service (Drivers)	HOS Add Driver Extended	HSDRVAX
Hours of Service (Drivers)	HOS Driver Log Events	HSDRVLE
Hours of Service (Drivers)	HOS US Driver Log Reports 2	HSDRVLR
Hours of Service (Drivers)	HOS Export Driver Clock by Depot ID	HSDRVCD
Hours of Service (Drivers)	HOS Driver Log Queue Ex	HSDRVLQ
Hours of Service (Drivers)	HOS Get Roll Off Time by Depot ID	HSDRVRO
Hours of Service (Drivers)	HOS Get Violation Events	HSDRVVE
Hours of Service (Drivers)	HOS Driver Violation Events by Group ID	HSDRVVG
Hours of Service (Load)	HOS Add Load API	HSLODCR
Hours of Service (Load)	HOS Update Load API	HSLODUP
Hours of Service	HOS Verify Access	QCHOSVER
Hours of Service (Vehicles)	HOS Create Vehicle API	HSVEHCR
Hours of Service (Vehicles)	HOS Create Vehicle Group API	HSVEHGRP
Hours of Service (Vehicles)	HOS Get Vehicle API	HSVEHGET
Hours of Service (Vehicles)	HOS Get Vehicles API	HSVEHLS
Hours of Service (Vehicles)	HOS Update Vehicle API	HSVEHUP
Business System Service (IQ)	IQ Move Serial Number to Profile API	IQMSRTPR
Business System Service (IQ)	IQ Get Profile by Serial Number API	IQGETPSP
Business System Service (IQ)	IQ Get Serial Numbers by Profile ID API	IQGETSER

Specifications for Creating Other Wrapper APIs

The following list provides the Product Codes that
are associated to all the Web Services currently in Production. These Product Codes are needed as part of the format when the Send_Req function is called.

Product Code	Associated Web Service Group
QT	QTRACS Web Services (includes access to Load Management methods)
TMM	QTRACS Text and Macro Messaging Web Services
TT	TrailerTRACS Web Services
LM	Landmark Management Web Services
GG	Global Group Management Web Services
OMS	User, Role, and Company Management Web Services
OTS	ESS Web Services
VIR	Vehicle Inspection Reporting
IQ	Business System Services
HOSVehicle	Hours of Service Vehicles
HOSPortal	Hours of Service Portal
HOSLoad	Hours of Service Loads
HOSDriver	Hours of Service Drivers
HOSDepot	Hours of Service Depot
HOSCustomer	Hours of Service Customer
HOSCarrier	Hours of Service Carrier