| POST | /calculatedistance | Calculate the distance between a list of coordinates |
|---|
namespace WebService.ClientServiceModel
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type ApiServiceResponse() =
///<summary>
///Information about the response.
///</summary>
[<ApiMember(Description="Information about the response.", IsRequired=true)>]
member val Description:String = null with get,set
///<summary>
///Heading or summary of the response.
///</summary>
[<ApiMember(Description="Heading or summary of the response.", IsRequired=true)>]
member val Heading:String = null with get,set
///<summary>
///Did the intended operation for this response complete successfully?
///</summary>
[<ApiMember(DataType="boolean", Description="Did the intended operation for this response complete successfully?", IsRequired=true)>]
member val WasSuccessful:Boolean = new Boolean() with get,set
[<AllowNullLiteral>]
type CalculateDistanceResponse() =
inherit ApiServiceResponse()
///<summary>
///A list of the distances between each point, returned in order that the points were provided
///</summary>
[<ApiMember(Description="A list of the distances between each point, returned in order that the points were provided")>]
member val PointDistances:ResizeArray<Decimal> = new ResizeArray<Decimal>() with get,set
///<summary>
///The total distance between all points
///</summary>
[<ApiMember(Description="The total distance between all points")>]
member val TotalDistance:Decimal = new Decimal() with get,set
[<AllowNullLiteral>]
type ApiServiceRequest() =
///<summary>
///The API Key required for authentication
///</summary>
[<ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)>]
member val ApiKey:String = null with get,set
[<AllowNullLiteral>]
type Coordinate() =
///<summary>
///The Latitude
///</summary>
[<ApiMember(Description="The Latitude", IsRequired=true)>]
member val Latitude:Double = new Double() with get,set
///<summary>
///The Longitude
///</summary>
[<ApiMember(Description="The Longitude", IsRequired=true)>]
member val Longitude:Double = new Double() with get,set
[<AllowNullLiteral>]
type CalculateDistance() =
inherit ApiServiceRequest()
///<summary>
///Array of coordinates
///</summary>
[<ApiMember(Description="Array of coordinates", IsRequired=true)>]
member val Coordinates:ResizeArray<Coordinate> = new ResizeArray<Coordinate>() with get,set
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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/xml
Content-Type: application/xml
Content-Length: length
<CalculateDistance xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientServiceModel">
<ApiKey xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientServiceModel.Base">String</ApiKey>
<Coordinates>
<Coordinate>
<Latitude>0</Latitude>
<Longitude>0</Longitude>
</Coordinate>
</Coordinates>
</CalculateDistance>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<CalculateDistanceResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientServiceModel">
<Description xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientServiceModel.Base">String</Description>
<Heading xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientServiceModel.Base">String</Heading>
<WasSuccessful xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientServiceModel.Base">false</WasSuccessful>
<PointDistances xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:decimal>0</d2p1:decimal>
</PointDistances>
<TotalDistance>0</TotalDistance>
</CalculateDistanceResponse>