Project is a part of the Code for Venezuela codeathon challenge: COD-BLA.
We are following the GeoJSON standard as used by MongoDB
Our index endpoint. Will display main site.
Our API endpoint. Will serve data and take in apagones
via post
-
get:
-
filters (for the future not now):
- region
- parroquia
- municipio
- estado
- ciudad
-
response data:
- location: GeoJSON object. coordinates are in
[ longitude , latitude ]
order - source: Where the data was posted from Eg. "twitter", "whatsapp', "browser'
- created_at: timestamp of when the data entry was made
- type: the type of outage that this is. "power", "water"
Example endpoint response.
{ data: [ { location: { type: "point", coordinates: [ 40, 5 ] }, source: '', create_at: '2019-01-01 01:00:00', type: '' } ] }
- location: GeoJSON object. coordinates are in
-
-
post:
Takes in post requests. POST schema:
Eg. 1
{ "location": { "lat": 51.0, "lng": -0.1 } "type": "power", "source": "browser" }
Eg. 2
{ "location": { "lat": 51.0, "lng": -0.1 } "type": "power", "source": "twitter" }
apagones: main collection, will have geospatial data
- location: GeoJSON field of point type.
- source: where the data comes from. Eg. "twitter", "browser", "whatsapp", "facebook"
- created_at: date the data is inserted/created
- type: the type of the outage. Eg. "power", "water"
- how long: how long has the incident/apagon been happening (minutes)
Eg schema
{
location: {
type: "point",
coordinates: [ 40, 5 ]
},
source: '',
create_at: '2019-01-01 01:00:00',
type: '',
how_long: 1
}
lugares: collection for places/landmarks
- name: landmark name.
- attributes: JSON field of landmark atteributes. Eg. Hospital Type
- location: GeoJSON field of point type.
- created_at: date the data is inserted/created
- type: the type of the place. Eg. "hospital", "school"
Eg schema
{
location: {
type: "point",
coordinates: [ 40, 5 ]
},
name: '',
attributes: {
...
},
create_at: '2019-01-01 01:00:00',
type: ''
}