| POST | /calculatedistance | Calculate the distance between a list of coordinates |
|---|
"use strict";
export class ApiServiceRequest {
/** @param {{ApiKey?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description The API Key required for authentication */
ApiKey;
}
export class ApiServiceResponse {
/** @param {{Description?:string,Heading?:string,WasSuccessful?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Information about the response. */
Description;
/**
* @type {string}
* @description Heading or summary of the response. */
Heading;
/**
* @type {boolean}
* @description Did the intended operation for this response complete successfully? */
WasSuccessful;
}
export class CalculateDistanceResponse extends ApiServiceResponse {
/** @param {{PointDistances?:number[],TotalDistance?:number,Description?:string,Heading?:string,WasSuccessful?:boolean}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/**
* @type {number[]}
* @description A list of the distances between each point, returned in order that the points were provided */
PointDistances;
/**
* @type {number}
* @description The total distance between all points */
TotalDistance;
}
export class Coordinate {
/** @param {{Latitude?:number,Longitude?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {number}
* @description The Latitude */
Latitude;
/**
* @type {number}
* @description The Longitude */
Longitude;
}
export class CalculateDistance extends ApiServiceRequest {
/** @param {{Coordinates?:Coordinate[],ApiKey?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/**
* @type {Coordinate[]}
* @description Array of coordinates */
Coordinates;
}
JavaScript CalculateDistance DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: text/jsv
Content-Type: text/jsv
Content-Length: length
{
Coordinates:
[
{
Latitude: 0,
Longitude: 0
}
],
ApiKey: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
PointDistances:
[
0
],
TotalDistance: 0,
Description: String,
Heading: String,
WasSuccessful: False
}