GeoView Server REST API enables sharing image content based on specified image identifier and transport service. Accessing this method requires Read permissions.
Request API method URI definition:
HTTP POST http://api.geoview.be/geoservice/v1/images/<id>/share
Request HTTP URI parameters:
Parameter |
Description |
token |
Access token (returned by this API method). |
id |
Image identifier (returned by i.e. this API method). |
Request Body structure in JSON format:
Parameter |
Type |
Description |
service |
Integer |
Service used to share recording. Default value 0 means share via e-mail service. This value is optional. |
recipient |
String |
Recipient's e-mail address. This value is mandatory if sharing via e-mail service.. |
description |
String |
Arbitrary description (note) sent along recording data. This value is optional. |
Example HTTP request URI:
HTTP POST http://api.geoview.be/geoservice/v1/images/6e39547d-aed2-4e60-9e01-5d5c0921953a/share?token=3dc718f2-ab20-4f41-86e1-72abcc1810c1
Example HTTP request URI message body contents:
{"service":0,"recipient":"user@demo.com","description":"This is a description."}
Possible resulting HTTP status codes:
Value |
Description |
200 |
API request succeeded. |
400 |
API request failed due to wrong parameter value(s). |
401 |
Supplied API request access token not valid. |
500 |
API request failed due to server error (i.e. service not available). |
Example e-mail message contents sent to recipient:
Sample e-mail message contents as received by recipient