Create Order
Order drone data for a specific area of interest. The order endpoint must include the following items:
deliveryDeadline: represents the deadline by which you want to receive the datalocationMap: represents the coordinates of the polygon of the area of interest. it should consist of an array of lat and lng, with each lat and lng corresponding to an edge of the polygon.description: represents a detailed description of what the clients needs. It is recommended to write as much description as possible to detail the requirements of the client in terms of resolution, equipments, product, safety concerns...orderName: represents the name of the order that you are placing. It should not be more than 20 charactersmapTypes: represents the end product that the client is requesting. Currently supporting only_2dMap_3dMapelevationMapdigitalTerrainModeldigitalSurfaceModeltopographicMapthermalMapndvistreamedDataoriginalPhotos
The order endpoint can include the following:
clientEmail: represents the email address that the notification will be sent to. If not inserted, the email address associated with the API key will be used.clientName: represents the client name. If not inserted, the name associated with the API key will be used.companyName: represents the company name. If not inserted, the company name associated with the API key will be used.notifications: to specify if the client wants to be notified via a webhook and via email when the status of the order changes.otherMapType: in case the map type is not the one that is listed above, you can insert it here.
Supported Map Types
| mapTypes | Description |
|---|---|
| _2dMap | represents a 2D Orthomosaic Map |
| _3dMap | represents a 3D model or point cloud |
| elevationMap | represents a topographic Map with contour values |
| digitalTerrainModel | represents a digital terrain model |
| digitalSurfaceModel | represents a digital surface model |
| thermalMap | represents a thermal Map |
| ndvi | represents a plant health map made through an NDVI algorithm |
| streamedData | represents a Live streamed data (video footage) |
| originalPhotos | represents Raw data/photos straight from the drone that have not been processed into another product |
Example Request
POST https://us-central1-globhe-app.cloudfunctions.net/api/v1/orders {
"deliveryDeadline": "2022-10-01",
"locationMap": [
{
"lat": -26.652673646040256,
"lng": -6.2430225172747384
},
{
"lat": -26.713196983259046,
"lng": 2.2772415512977204
},
{
"lat": 17.441499309513688,
"lng": 108.58612411318285
}
],
"mapTypes": [
"_2dMap",
"elevationMap"
],
"description": "A detailed description of the data capture requirements goes here",
"clientEmail": "foo@foo.com",
"clientName": "Darth Vader",
"companyName": "The First Galactic Empire",
"orderName": "Site 001 Paris",
"notifications": {
"webhook": "http://YKgmigAHHvGCfxhGJqpjcuY.sufbf1IWOF3R.encEUQoZ5fWDGiZ6wlRi2hFLgHsWzf58-Asm9",
"email": false
},
"otherMapType": "in Ut amet"
}Example Response
{
"id": "adipisicing123456789",
"areaSize": 85301325.0620738,
"clientEmail": "foo@foo.com",
"deliveryDeadline": "2022-10-01",
"clientName": "Darth Vader",
"companyName": "The First Galactic Empire",
"deliveryFiles": [
"https://QASqjdhKvlxiCNNJwUHJrFmzLBWTjh.ockrTYSZnMhrJl9QM3uEOKjrjpVdpQTqhvvDQusfv",
"http://l.gmpdgsdfgjkGhjFRyDSbhjTYYGHJghjTYvUVuVYuVjSDSdnmb",
"http://l.gmpwkRAZCHIVptOfZ3DSDA56GHJbncGbnFSDAMSDbnmSDSDWEhjkqwVYUDSghjadA",
"http://l.gmpwkRAZCHIVptOfZ3HJWOpHuubnmFHjkEhjVuiopWbnAhjkASdkjhJJH"
],
"description": "A detailed description of the data capture requirements goes here",
"orderName": "Site 001 Paris",
"orderPrice": 44927494.15693178,
"orderStatus": "active",
"orderRejectionReason": "anim dolor dolore ex",
"locationMap": [
{
"lat": 47.40430222489124,
"lng": -33.278262875341284
},
{
"lat": -17.70925800990831,
"lng": 144.48954366869725
}
],
"mapTypes": [
"_2dMap",
"elevationMap"
],
"notifications": {
"webhook": "https://uLDIaEmhpasAXxN.xfsYQI7WVtzY96ZiVGIL8uvEwUid+C7Z,A,.5Or",
"email": true
},
"otherMapType": "ut incididunt labore"
}