{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"8a45cf50-0845-4150-ab9e-eafd74a73a37","name":"ELDWebAPI","description":"For a secure connection please use [https://content.eldroadmap.com:9103](https://livetrack.atcompass.net:9103)\n\n**TimeZone** \nEASTERN_TIME = 0 \nCENTRAL_TIME = 1 \nMOUNTAIN_TIME = 2 \nPACIFIC_TIME = 3 \nALASKAN_TIME = 4 \nHAWAIIAN_TIME = 5 \nATLANTIC_TIME = 6\n\n**Posible US, Canada and Mexico states codes** \n“AL”, “AK”, “AR”, “AZ”, “CA”, “CO”, “CT”, “DC”, “DE”, “FL”, “GA”, “HI”, “IA”, “ID”, “IL”, “IN”, “KS”, “KY”, “LA”, “MA”, “MD”, “ME”, “MI”, “MN”, “MO”, “MS”, “MT”, “NC”, “ND”, “NE”, “NH”, “NJ”, “NM”, “NV”, “NY”, “OH”, “OK”, “OR”, “PA”, “RI”, “SC”, “SD”, “TN”, “TX”, “UT”, “VA”, “VT”, “WA”, “WI”, “WV”, “WY”, “AB”, “BC”, “MB”, “NB”, “NF”, “NS”, “NT”, “ON”, “PE”, “QC”, “SK”, “YT”, “AG”, “BN”, “BS”, “CH”, “CI”, “CL”, “CP”, “CS”, “DF”, “DG”, “GE”, “GJ”, “HD”, “JA”, “MC”, “MR”, “MX”, “NA”, “NL”, “OA”, “PU”, “QE”, “QI”, “SI”, “SL”, “SO”,”TA”, “TB”, “TL”, “VC”, “YU”, “ZA”, “OT”\n\n**Ruleset** \nUSA_60H = 0 \nUSA_70H = 1 \nCALIFORNIA_80H = 2 \nOILFIELD_60H = 3 \nOILFIELD_70H = 4 \nCANADA_70H = 5 \nCANADA_120H = 6 \nTEXAS_70H = 7 \nMEXICO = 8 \nPASSENGER_60H = 9 \nPASSENGER_70H = 10 \nFLORIDA_70H = 11 \nFLORIDA_80H = 12 \nASPHALT_60H = 13 \nASPHALT_70H = 14 \nCALIFORNIA_TANKER_60H = 15 \nTEXAS_OILFIELD_70H = 16 \nALASKA_70H = 17 \nALASKA_80H = 18\n\n**Carrier country code** \nUSA = 1 \nCANADA = 2 \nMEXICO = 3\n\n**Jurisdiction code** \nCANADA_SOUTH = 1 \nCANADA_NORTH = 2 \nUSA = 3\n\n**24-Period Starting Time** \nMIDNIGHT = 0 \nCURRENT_TIME = 1\n\n**Units** \nMILES_GALLONS = 1 \nKM_LITERS = 2\n\n**DVIR Vehicle Condition** \nNONE = -1 \nSATISFACTORY = 0 \nDEFECTS_CORRECTED = 1 \nDEFECTS_NOT_NEED_CORRECTED = 2 \nDEFECTS_NEED_CORRECTED = 3\n\n**Asset Type** \nTRACTOR = 0 \nTRAILER = 1\n\n**Response Error Codes** \nUNKNOWN_ERROR = 0 \nOK = 1 \nHOSCLIENT_API_KEY_MISSING = 2 \nHOSCLIENT_MISSING = 3 \nHOSCLIENT_API_KEY_EXIST = 4 \nHOSCLIENT_DUPLICATED = 5 \nHOSRESELLER_API_KEY_MISSING = 6 \nHOSCLIENT_API_KEY_INVALID = 7 \nHOSDRIVER_USERNAME_EXIST = 8 \nHOSDRIVER_LICENSE_STATE_INVALID = 9 \nHOSDRIVER_USERNAME_INVALID_LENGTH = 10 \nHOSDRIVER_MISSING = 11 \nHOSDRIVER_LICENSE_NUMBER_INVALID_LENGTH = 12 \nHOSDRIVER_DUPLICATED = 13 \nHOSCLIENT_CAN_NOT_ACTIVATE_DRIVER = 14 \nHOSCLIENT_CARRIER_ID_INVALID = 15 \nHOSCLIENT_CARRIER_NAME_INVALID_LENGTH = 16 \nHOSCLIENT_CARRIER_ADDRESS_EMPTY = 17 \nHOSDRIVER_NAME_INVALID_LENGTH = 18 \nHOSDRIVER_LAST_NAME_INVALID_LENGTH = 19 \nHOSNOTIFICATION_NAME_MISSING = 20 \nHOSNOTIFICATION_INVALID_EMAIL_FORMAT = 21 \nHOSNOTIFICATION_ITEMS_MISSING = 22 \nHOSASSET_NUMBER_INVALID_LENGTH = 23 \nHOSASSET_VIN_INVALID_LENGTH = 24 \nHOSASSET_VIN_DUPLICATED = 25 \nHOSASSET_PLATE_DUPLICATED = 26 \nHOSASSET_NUMBER_DUPLICATED = 27 \nINSERTION_UNAUTHORIZED_PARTNER = 28 \nHOSASSET_CHANGE_NOT_ALLOWED = 29 \nINVALID_DATE_RANGE = 30 \nHOSASSET_PLATE_INVALID_LENGTH = 31 \nHOSASSET_MISSING = 32 \nHOSJURISDICTION_INVALID = 33 \nHOSRULESET_ID_INVALID = 34 \nHOSDRIVER_EXEMPTION_REASON_REQUIRED = 35 \nHOSDRIVER_LICENSE_NUMBER_DUPLICATED = 36 \nHOSHOMEBASE_REQUIRED = 37 \nHOSCLIENT_SUPPORT_USERNAME_EXIST = 38 \nHOSCLIENT_DOTNUMBER_FMCSA_NOT_EXIST = 39 \nHOSRESELLER_CAN_NOT_ACTIVATE_DTC = 40 \nHOSCLIENT_SUPPORT_PASSWORD_EMPTY = 41 \nDVIR_VEHICLE_CONDITION_NOT_VALID = 42\n\n**ActionResponse data: BasicHOSClientDTO2** \nHOSClientId As Integer \nExternalClientId As Integer \nCarrierId As String \nCarrierName As String \nCarrierAddress As String \nTimeZoneCode As Integer \nCarrierCountry As Integer \nApiKey As String \nDistanceUnitCode As Integer \nFuelUnitCode As Integer \nDTCCodes As Integer \nActivateDriver As Integer \nECMAutomatic As Integer \nForceAssetSelection As Integer \nForceECMLinkConnection As Integer \nSupportUserName As String \nSupportPassword As String \nCanadaEnabled As Integer\n\n**ActionResponse data: BasicHOSDriverDTO** \nHOSDriverId As Integer \nExternalDriverId As Integer \nName As String \nLastName As String \nHOSUserName As String \nIsActive As Integer \nHOSRuleSetId As Integer \nPersonalUse As Integer \nYardMove As Integer \nExemption As Integer \nLicenseState As String \nLicenseNumber As String \nWifi As Integer \nDistanceUnitCode As Integer \nFuelUnitCode As Integer \nStarting24HTime As Integer \nTimeZoneCode As Integer \nJurisdictionCode As Integer\n\n**ActionResponse data for IFTA Report IFTAReportDTO** \nPublic items As List(Of IFTAStateDTO) \nPublic TotalMiles As Double \nPublic TaxableMiles As Double \nPublic MPG As Double \nPublic TaxPaidGallons As Double\n\n***IFTAStateDTO content*** \nState As String \nTotalMiles As Double \nTaxableMiles As Double \nTaxableGallons As Double \nTaxPaidGallons As Double \nNetTaxableGallons As Double \nTaxRate As Double \nTaxCreditDue As Double \nTotal As Double\n\n**ActionResponse data: HOSEventRecordDTO** \nHOSEventId As Integer \nELDId As String \nAppVersion As String \nTimestamp As Long \nTimestampString As String\n\n‘drivers \nHOSDriverId As Integer \nHOSDriver As String \nHOSCoDriverId As Integer \nHOSCoDriver As String\n\n‘vehicle profile \nTractorNumber As String \nTrailerNumber As String \nTractorVin As String\n\n‘position \nCity As String \nState As String \nLatitude As String \nLongitude As String \nDriverLocationDesc As String\n\n‘event \nOldDriverStatus As String \nNewDriverStatus As String \nEventStatus As Integer \nEventOrigin As Integer \nEventType As Integer \nEventCode As Integer \nMalFunctionDiagnosticCode As String \nDrivenMiles As Double\n\n‘ecm \nVehicleMiles As Double \nElapsedEngineHours As Integer\n\n**EventStatus:** \n\\-1 All \n1 Active \n2 Inactive-Changed \n3 Inactive-Change Requested \n4 Inactive-Change Rejected\n\n**EventOrigin:** \n\\-1 All \n1 Automatically Recorded \n2 Edited or Entered by Driver \n3 Edit Requested by Other than Driver \n4 Assumed from Unidentified Driver Profile\n\n**EventType:** \n\\-1 All Event Types \n1 A Change in Driver Duty Status \n2 An Intermediate Log \n3 Personal Use or Yard Move \n4 Driver’s Certification of Records \n5 Driver’s Login/Logout \n6 Engine On/Off \n7 Malfunctions/Diagnostics\n\n**EventCode:**\n\n
Event Type Event Code Event Code Description 
A change in driver's duty status 1 Driver's duty status changed to \"Off Duty\" 
A change in driver's duty status 2 Driver's duty status changed to \"Sleeper Berth\" 
A change in driver's duty status 3 Driver's duty status changed to \"Driving\" 
A change in driver's duty status 4 Driver's duty status changed to \"On-duty not driving\" 
An intermediate log 1 Intermediate log with conventional location precision 
An intermediate log 2 Intermediate log with reduced location precision 
A change in driver's indication of authorized personal use of CMV (Carrier Motor Vehicle) or yard moves 1 Driver indicates \"Authorized Personal Use of CMV\" 
A change in driver's indication of authorized personal use of CMV (Carrier Motor Vehicle) or yard moves 2 Driver indicates \"Yard Moves\" 
A change in driver's indication of authorized personal use of CMV (Carrier Motor Vehicle) or yard moves 0 Driver indication for Personal Conveyance, Yard Move, and Work Time Extension cleared 
A driver's certification/ recertification of records 1 Driver's first certification of a daily record 
A driver's certification/ recertification of records n Driver's [nth] certification of a daily record (when recertification necessary). The \"n\" value is an integer between 1 and 9. If more than 9 certifications are needed, use 9 for each new re-certification record 
A driver's login/logout activity 1 Authenticated driver's ELD login activity 
A driver's login/logout activity 2 Authenticated driver's ELD logout activity 
CMV engine power-up/ shut-down activity 1 Engine power-up with conventional location precision 
CMV engine power-up/ shut-down activity 2 Engine power-up with reduced location precision 
CMV engine power-up/ shut-down activity 3 Engine shut-down with conventional location precision 
CMV engine power-up/ shut-down activity 4 Engine shut-down with reduced location precision 
A malfunction or data diagnostic detection occurrence 1 An ELD malfunction logged 
A malfunction or data diagnostic detection occurrence 2 An ELD malfunction cleared 
A malfunction or data diagnostic detection occurrence 3 A data diagnostic event logged 
A malfunction or data diagnostic detection occurrence 4 A data diagnostic event cleared 
 \n\n**ActionResponse data: HOSAssetDTO**\n\nAssetId As Integer // The internal asset ID assigned by the apollo ELD platform \nHOSClientId As Integer //The internal client ID assigned by the apollo ELD platform \nNumber As String //The tractor or trailer number \nVIN As String //The tractor or trailer valid VIN number \nPlate As String //The tractor or trailer license plate \nRegistrationState As String //The tractor or trailer registration state (see enumerators above for state codes) \nDescription As String //The description assigned to the tractor or trailer \nType As Integer //tractor or trailer (see enumerators above for asset types) \nECMId As String //The ID of the ECM device assigned to this asset (optional) \nAdditionalECMId As String //The secondary ID of the ECM device assigned to this asset","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"5717716","team":1364396,"collectionId":"8a45cf50-0845-4150-ab9e-eafd74a73a37","publishedId":"TVYNYEkX","public":true,"publicUrl":"https://apidocu.reseller.apolloeld.com","privateUrl":"https://go.postman.co/documentation/5717716-8a45cf50-0845-4150-ab9e-eafd74a73a37","customColor":{"top-bar":"E5E4E2","right-sidebar":"153061","highlight":"F3B817"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2020-11-04T19:44:10.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/fb1796b6fa69f64d13b5f835723fbb67c942a0d4997d16c74cef2d840bcb97b5","favicon":"https://res.cloudinary.com/postman/image/upload/v1604431952/team/vtzfx1jvyk9yrirk0tbu.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://apidocu.reseller.apolloeld.com/view/metadata/TVYNYEkX"}