Basic elements and formats

Here you can find some of the types considered "basic" in the Plotwise API

Geolocation¶

The representation of a geolocation

Name	Format	Description	Required	Example
latitude	Float	The latitude	True	`52.12296`
longitude	Float	The longitude	True	`52.12296`

A Stop is, as its name hints, a stop that may happen between two times in certain geolocation.

Name	Format	Description	Required	Example
min_time	Date-time	The minimum time in which the stop should happen	True	`2019-06-04T04:00:00Z`
max_time	Date-time	The maximum time in which the stop should happen	True	`2019-06-04T04:00:00Z`
geo_point	Geolocation	The geolocation in which the stop is	True	`{"latitude": 52.12296,"longitude": 5.05141}`
stop_time	Float	Duration of stop in seconds	True	`600.0`

A timeslot is represented by a min_time and a max_time

Name	Format	Description	Required	Example
min_time	Date-time	The minimum time in which this timeslot happens	True	`2019-06-04T04:00:00Z`
max_time	Date-time	The maximum time in which this timeslot happens	True	`2019-06-04T04:00:00Z`
id	UUID	ID of this timeslot	False	`2f3ec672-af64-43bd-8fe8-f6262cefcd33`

When an attribute has no value the term null will be returned. When an array attribute is empty, an empty array will be returned as [].

All dates and times must be represented in the ISO 8601 format: YYYY-MM-DDTHH:mm:ssZ, where:

YYYY-MM-DD – is the date: year-month-day.
The character T is used as the delimiter.
HH:mm:ss – is the time: hours, minutes and seconds.
The Z part denotes the time zone in the format +-hh:mm. A single letter Z that would mean UTC+0.

Here an exmple of a date:

2017-11-13T14:30:00Z

Timezones

To know more about how to deal with Timezones in date fields, please visit the introduction.

When using multiple capacities, the capacity fields must be structured like the following.

Name	Format	Description	Required	Example
capacity_1	Non-negative float	The amount of the first capacity type	False	12.6
capacity_2	Non-negative float	The amount of the second capacity type	False	12.6
capacity_3	Non-negative float	The amount of the third capacity type	False	12.6
capacity_4	Non-negative float	The amount of the fourth capacity type	False	12.6
capacity_5	Non-negative float	The amount of the fifth capacity type	False	12.6

Each individual capacity field is optional and the default behaviour depends on the entity.

Entity	Field	Implied default value	Default behaviour
Event	capacity_vectory	0.0	Events don't fill capacity unless specified
Event	pickup_capacity_vector	0.0	Events don't fill capacity unless specified
Resource	driver_capacity	infinity	Drivers can handle everything unless specified
Resource	vehicle_capacity	infinity	Vehicles can fit everything unless specified
Route	capacity_threshold_vector	1.0	Intermediate depots are not triggered for this capacity unless specified. This parameter is partially deprecated