FlashTrak API New routes Prod
Number of APIs: 50
Introduction The purpose of this document is to set the design requirements of the Application Programming Interface (API) for supporting the data integration services of the FlashTrak-RTL Web Application. The FlashTrak-RTL Wed Application is used for managing transportation conditions with the Real Time Data Loggers (RTL) of DeltaTrak. General Requirements The following general requirements shall apply to the FlashTrak Data Service:
The FlashTrak-RTL data service shall be available at data.flashtrakrtl.com via a secure connection.
The service shall respond when entering its URL in a web browser. The response shall be in the format of text such as “FlashTrak-RTL API x.x”, where x.x shall represent the current version of the API software. Any additional interaction with the service shall require Client’s Authentication.
The FlashTrak-RTL Service shall require Token string for authenticating Client’s requests. The Client must have an existing User profile in the FlashTrak-RTL Application and must be a member of the Account Administrators group i.e. a User with all access rights. The Client authentication shall be required for every transaction using the API.
A token for accessing the FlashTrak-RTL Service can be generated upon request by contacting DeltaTrak customer support.
Transactions with the services shall use JSON data objects. Every API function shall have its own JSON service end point.
1. status ok
GET {{baseUrl}}/status
Get current status and version of the API
2. Customer Endpoints-Shipments - List
GET {{baseUrl}}/shipment?tripNumber=Shipment Trip Number&shipperID=Shipper ID&receiverID=Receiver ID&status="Completed" | "Pending" | "Registered" | "Activated"&createdAt=2022-03-01 11:00&query=count&page=1&qty=10
Find Shipments that match specified criteria
■ Should pull back shipments belonging to account, plus shipments shared with
account (explicit & receiver sharing)
■ Optional filters reduce results, and no parameters return all shipments for
account (see above)
■ Should include locations, product, alarm criteria(s), and list of shipment alerts
3. Customer Endpoints-Shipments - Create
POST {{baseUrl}}/shipment
Creates new empty shipment record for a specific RTL Device ID. The Device ID must be free and not used for any other shipment with Incomplete status.
■ Ability to specify a single Product ID
■ Ability to specify locations (Shipper Location ID, Receiver Location ID, Airport
and Marine Port IDs, etc)
■ Available receiver locations include this account's receiver locations, plus any
receiver locations shared by receiver sharing
■ If user specifies a 3rd party receiver location, then the list of available products
to associate is limited to that receiver's locations, meaning product and receiver
location must match accounts
■ API should throw an error if the selected product doesn't match the account of
the selected receiver location.
4. Customer Endpoints-Shipments - Edit
PUT {{baseUrl}}/shipment/:tripNumber
Edit a Shipment with Incomplete status. Completed shipments shall no longer receive data from the associated Device ID.
■ Same criteria/rules as above
■ Will missing optional parameters clear that existing field in the DB, or leave that
field untouched? Think clearing is better, meaning the entire dataset is required.
5. Customer Endpoints-Shipments - Complete Shipment
PUT {{baseUrl}}/shipment/:tripNumber/complete
Edit a Shipment with Incomplete status. Completed shipments shall no longer receive data from the associated Device ID.
■ Empty body?
■ Completes the shipment, if belonging to account
■ Don't believe we need to take sharing into consideration
6. Customer Endpoints-Shipments - Delete
DELETE {{baseUrl}}/shipment/:tripNumber
Deletes a Shipment with Complete status. Deleting the Shipment shall also remove all
of its sensors’ data records.
■ Deletes the shipment (by marking in DB as deleted), if belonging to account
■ Don't believe we need to take sharing into consideration
7. Customer Endpoints-Products - List
GET {{baseUrl}}/product
List all products and shared products
■ Pulls back products belonging to account, plus products shared with account
(explicit & receiver sharing)
■ Each location node should contain the account ID that it belongs to
■ Since alarm criteria are defined at the product level, include array of alarm
criteria definitions associated with each product
8. Customer Endpoints-Locations - List Airport
GET {{baseUrl}}/location?type=string
List all locations and shared locations
■ Pulls back locations (of all types) belonging to account, plus shipments shared
with account (explicit & receiver sharing)
■ Ability to filter locations would be nice, but not required - this is typically a
smaller dataset
■ Each location node should contain the account ID that it belongs to
9. Admin Endpoints-Shipments-Get Success - Trip Numbeer
GET {{baseUrl}}/account/:accountID/shipment?tripNumber=TAGO123774727356785
Get list of all shipments with Flight Mode enabled
■ Returns the flight mode details for ALL non-completed shipments with flight
mode settings
■ These results should not be tied/limited to a specific account, because it will be
called the DeltaTrak device communication services
■ There should be some special DeltaTrak API key that will be used for these
admin
calls that will be used by DT (not the customer)
10. Admin Endpoints-Shipments-Get Success - List Flight Mode
GET {{baseUrl}}/admin/flightmode?tripID=TAGO278026586
Get list of all shipments with Flight Mode enabled
■ Returns the flight mode details for ALL non-completed shipments with flight
mode settings
■ These results should not be tied/limited to a specific account, because it will be
called the DeltaTrak device communication services
■ There should be some special DeltaTrak API key that will be used for these
admin
calls that will be used by DT (not the customer)
11. Admin Endpoints-Shipments-Get Error - List - Invalid AccountID
GET {{baseUrl}}/account/:accountID/shipment
Get list of all shipments with Flight Mode enabled
■ Returns the flight mode details for ALL non-completed shipments with flight
mode settings
■ These results should not be tied/limited to a specific account, because it will be
called the DeltaTrak device communication services
■ There should be some special DeltaTrak API key that will be used for these
admin
calls that will be used by DT (not the customer)
12. Admin Endpoints-Shipments-Get Error - List Flight Mode - Invalid Query
GET {{baseUrl}}/admin/flightmode
Get list of all shipments with Flight Mode enabled
■ Returns the flight mode details for ALL non-completed shipments with flight
mode settings
■ These results should not be tied/limited to a specific account, because it will be
called the DeltaTrak device communication services
■ There should be some special DeltaTrak API key that will be used for these
admin
calls that will be used by DT (not the customer)
13. Admin Endpoints-Shipments-Post Success - Create Trip Just required fields
POST {{baseUrl}}/account/:accountID/trip
14. Admin Endpoints-Shipments-Post Success - Create Just required fields
POST {{baseUrl}}/account/:accountID/shipment
Get list of all shipments with Flight Mode enabled
■ Returns the flight mode details for ALL non-completed shipments with flight
mode settings
■ These results should not be tied/limited to a specific account, because it will be
called the DeltaTrak device communication services
■ There should be some special DeltaTrak API key that will be used for these
admin
calls that will be used by DT (not the customer)
15. Admin Endpoints-Shipments-Post Success - Send Readings
POST {{baseUrl}}/account/:accountID/shipment/:tripNumber/data
Get list of all shipments with Flight Mode enabled
■ Returns the flight mode details for ALL non-completed shipments with flight
mode settings
■ These results should not be tied/limited to a specific account, because it will be
called the DeltaTrak device communication services
■ There should be some special DeltaTrak API key that will be used for these
admin
calls that will be used by DT (not the customer)
16. Admin Endpoints-Shipments-Post Error-Send Reading Error - Invalid Proccess
POST {{baseUrl}}/account/:accountID/shipment/:tripNumber/data
Get list of all shipments with Flight Mode enabled
■ Returns the flight mode details for ALL non-completed shipments with flight
mode settings
■ These results should not be tied/limited to a specific account, because it will be
called the DeltaTrak device communication services
■ There should be some special DeltaTrak API key that will be used for these
admin
calls that will be used by DT (not the customer)
17. Admin Endpoints-Shipments-Post Error-Post error OK - Duplicate Shipment trip number
POST {{baseUrl}}/account/:accountID/shipment
Get list of all shipments with Flight Mode enabled
■ Returns the flight mode details for ALL non-completed shipments with flight
mode settings
■ These results should not be tied/limited to a specific account, because it will be
called the DeltaTrak device communication services
■ There should be some special DeltaTrak API key that will be used for these
admin
calls that will be used by DT (not the customer)
18. Admin Endpoints-Shipments-Put Success - Success
PUT {{baseUrl}}/account/:accountID/shipment/:tripNumber
19. Admin Endpoints-Shipments-Put Error ok - NO Body
PUT {{baseUrl}}/account/:accountID/shipment/:tripNumber
20. Admin Endpoints-Shipments-Delete Success ok - Clean
DELETE {{baseUrl}}/account/:accountID/shipment/:shipmentID/clean
Get list of all shipments with Flight Mode enabled
■ Returns the flight mode details for ALL non-completed shipments with flight
mode settings
■ These results should not be tied/limited to a specific account, because it will be
called the DeltaTrak device communication services
■ There should be some special DeltaTrak API key that will be used for these
admin
calls that will be used by DT (not the customer)
21. Admin Endpoints-Shipments-Delete Success ok - Delete Just required fields
DELETE {{baseUrl}}/account/:accountID/shipment/:shipmentID
Get list of all shipments with Flight Mode enabled
■ Returns the flight mode details for ALL non-completed shipments with flight
mode settings
■ These results should not be tied/limited to a specific account, because it will be
called the DeltaTrak device communication services
■ There should be some special DeltaTrak API key that will be used for these
admin
calls that will be used by DT (not the customer)
22. Admin Endpoints-Shipments-Delete Success ok - Delete trip Just required Fields
DELETE {{baseUrl}}/account/:accountID/trip/:tripID
23. Admin Endpoints-Shipments-Delete Error Ok - Invalid trip number
DELETE {{baseUrl}}/account/:accountID/shipment/:shipmentID
Get list of all shipments with Flight Mode enabled
■ Returns the flight mode details for ALL non-completed shipments with flight
mode settings
■ These results should not be tied/limited to a specific account, because it will be
called the DeltaTrak device communication services
■ There should be some special DeltaTrak API key that will be used for these
admin
calls that will be used by DT (not the customer)
24. Admin Endpoints-Shipments-Delete Error Ok - Clean invalid account id
DELETE {{baseUrl}}/account/:accountID/shipment/:shipmentID/clean
Get list of all shipments with Flight Mode enabled
■ Returns the flight mode details for ALL non-completed shipments with flight
mode settings
■ These results should not be tied/limited to a specific account, because it will be
called the DeltaTrak device communication services
■ There should be some special DeltaTrak API key that will be used for these
admin
calls that will be used by DT (not the customer)
25. Admin Endpoints-Products OK-Post Success - Configuration enabled
POST {{baseUrl}}/account/:accountID/product
26. Admin Endpoints-Products OK-Post Error - Duplicate ID
POST {{baseUrl}}/account/:accountID/product
27. Admin Endpoints-Products OK-Get Success - Receiver share False Check
GET {{baseUrl}}/account/:accountID/product?hide_share=false
28. Admin Endpoints-Products OK-Get Error - Enabled as (aaaaaaa)
GET {{baseUrl}}/account/:accountID/product?configuration=aaaaaaa
29. Admin Endpoints-Products OK-Delete Success - Delete Configuration enabled
DELETE {{baseUrl}}/account/:accountID/product/:productID
30. Admin Endpoints-Products OK-Delete Error - Product is receiver sharing
DELETE {{baseUrl}}/account/:accountID/product/:productID
31. Admin Endpoints-Locations ok-Post Success - Create Seaport
POST {{baseUrl}}/account/:accountID/location
32. Admin Endpoints-Locations ok-Post folder error - airport Duplicate iD
POST {{baseUrl}}/account/:accountID/location
33. Admin Endpoints-Locations ok-Get success - Hide share True
GET {{baseUrl}}/account/:accountID/location?hide_share=True
34. Admin Endpoints-Locations ok-Get error - Invalid type
GET {{baseUrl}}/account/:accountID/location?type=test
35. Admin Endpoints-Locations ok-Delete success - Delete Seaport
DELETE {{baseUrl}}/account/:accountID/location/:locationID
36. Admin Endpoints-Locations ok-Delete Error - Invalid Location ID
DELETE {{baseUrl}}/account/:accountID/location/:locationID
37. Admin Endpoints-Accounts ok-Post Success - Create
POST {{baseUrl}}/account
38. Admin Endpoints-Accounts ok-Post Error - Duplicate Id
POST {{baseUrl}}/account
39. Admin Endpoints-Accounts ok-Get Success - List
GET {{baseUrl}}/account
40. Admin Endpoints-Accounts ok-Get Error - Invalid Token
GET {{baseUrl}}/account
41. Admin Endpoints-Accounts ok-delete Success - Delete
DELETE {{baseUrl}}/account/:accountID
42. Admin Endpoints-Accounts ok-Delete error - Invalid Token
DELETE {{baseUrl}}/account/:accountID
43. Admin Endpoints-Trips ok-Post Success - Create
POST {{baseUrl}}/account/:accountID/trip
44. Admin Endpoints-Trips ok-Post Error - Duplicate ID
POST {{baseUrl}}/account/:accountID/trip
45. Admin Endpoints-Trips ok-Get Success - List
GET {{baseUrl}}/account/:accountID/trip
46. Admin Endpoints-Trips ok-Get Error - Token
GET {{baseUrl}}/account/:accountID/trip
47. Admin Endpoints-Trips ok-Delete Success - Delete trip
DELETE {{baseUrl}}/account/:accountID/trip/:tripID
48. Admin Endpoints-Trips ok-Delete Error - Invalid Trip ID Check
DELETE {{baseUrl}}/account/:accountID/trip/:tripID
49. Admin Endpoints-Carriers-Carrier Success - List
GET {{baseUrl}}/account/:accountID/carrier
List all carriers of an account
50. Admin Endpoints-Carriers-Carrier Error - Invalid Token
GET {{baseUrl}}/account/:accountID/carrier
List all carriers of an account
ENDPOINTS