Endpoints
For technical information on all endpoints click here
Events
For creating, retrieving events.
Used to record data that happens to a real world entity. For example on Monday: temperature event = 25
Please note that the recommended way for your application to stay up to date is to poll the API server at a certain intervals for example every 5 minutes and download all events that it is interested in. When specifying the event types to download you can seperate them by commas to represent multiple event types.
Profiles
For creating, retrieving, deleting profiles.
A profile represents a real world entity. For example a profile could represent a shipment. After a profile is created then events can be stored against that profile to describe details about the real world entity.
Please note that the data stored is immutable and cannot be deleted. Therefore deleting a profile simply adds a note that this profile has been deleted. It will be up to applications that connect to the CargoActivity API to respect that the profile is deleted and act accordingly.
ProfileFields
For retrieving profileFields.
During the lifetime of a profile many events may occur. For example on Monday: temperature event = 25. Tuesday: temperature event = 22. Wednesday: temperature event = 28.
Since the most recent temperature of the profile is 28. Then if you ask for the profile field "temperature" you will get a value of 28.
Please note that the recommended approach is not to use profileFields. Instead it is recommended for your application to download all event data of interest and keep track of the latest state of the figures inside your application.
Metadata
For creating, retrieving, deleting metadata.
When storing event data on a profile the values can be marked as public or private. But even private data can be seen by other parties if the profile is shared with them. If your application needs to store data against a profile which should never be seen by any other applications then you can add metadata values against the profile.