| POST | /calculatedistance | Calculate the distance between a list of coordinates |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Coordinates | body | List<Coordinate> | Yes | Array of coordinates |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ApiKey | form | string | Yes | The API Key required for authentication |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Latitude | form | double | Yes | The Latitude |
| Longitude | form | double | Yes | The Longitude |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PointDistances | form | List<decimal> | No | A list of the distances between each point, returned in order that the points were provided |
| TotalDistance | form | decimal | No | The total distance between all points |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Description | form | string | Yes | Information about the response. |
| Heading | form | string | Yes | Heading or summary of the response. |
| WasSuccessful | form | boolean | Yes | Did the intended operation for this response complete successfully? |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /calculatedistance HTTP/1.1
Host: 1fetch.api.client.prod.86degrees.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"Coordinates":[{"Latitude":0,"Longitude":0}],"ApiKey":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"PointDistances":[0],"TotalDistance":0,"Description":"String","Heading":"String","WasSuccessful":false}