Request contour (Contoor) data (async, delivered by email)

Queues generation of contour data for a parcel. The result is emailed to target_email asynchronously; the HTTP response only confirms the request was received.

POST

https://res.aireon.ch/res_api/contour_data

Authorization

ResApiToken
API key in header
required

Request body JSON required

target_email
string
required
Address the contour result is sent to.

format: email
parcel_id
string
required
Parcel EGRID.

Returns

200

Request acknowledged, or a plain-text error body.

401

Authentication missing or invalid.

JSON

error
string
required
Human-readable error description.
message
optional
string
Optional underlying error message.

Request contour (Contoor) data (async, delivered by email)

curl --request POST \
  --url https://res.aireon.ch/res_api/contour_data \
  --header 'Content-Type: application/json' \
  --header 'token: <token>' \
  --data '
{
  "target_email": "user@example.com",
  "parcel_id": "string"
}
'

const url = 'https://res.aireon.ch/res_api/contour_data';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json', token: '<token>'},
  body: JSON.stringify({target_email: 'user@example.com', parcel_id: 'string'})
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://res.aireon.ch/res_api/contour_data"

payload = {
    "target_email": "user@example.com",
    "parcel_id": "string"
}
headers = {
    "Content-Type": "application/json",
    "token": "<token>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

Response example

Request recieved... The Contoor will be sent to user@example.com

{
  "error": "string",
  "message": "string"
}