1Fetch Client API

CalculateDistance

The following routes are available for this service:
POST	/calculatedistance	Calculate the distance between a list of coordinates

import java.math.*
import java.util.*
import net.servicestack.client.*


open class CalculateDistance : ApiServiceRequest(), ILogRequest
{
    /**
    * Array of coordinates
    */
    @ApiMember(Description="Array of coordinates", IsRequired=true)
    var Coordinates:ArrayList<Coordinate> = ArrayList<Coordinate>()
}

open class ApiServiceRequest : IServiceRequest, IHasApiKey
{
    /**
    * The API Key required for authentication
    */
    @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
    var ApiKey:String? = null
}

open class Coordinate
{
    /**
    * The Latitude
    */
    @ApiMember(Description="The Latitude", IsRequired=true)
    var Latitude:Double? = null

    /**
    * The Longitude
    */
    @ApiMember(Description="The Longitude", IsRequired=true)
    var Longitude:Double? = null
}

open class CalculateDistanceResponse : ApiServiceResponse()
{
    /**
    * A list of the distances between each point, returned in order that the points were provided
    */
    @ApiMember(Description="A list of the distances between each point, returned in order that the points were provided")
    var PointDistances:ArrayList<BigDecimal> = ArrayList<BigDecimal>()

    /**
    * The total distance between all points
    */
    @ApiMember(Description="The total distance between all points")
    var TotalDistance:BigDecimal? = null
}

open class ApiServiceResponse : IServiceResponse
{
    /**
    * Information about the response.
    */
    @ApiMember(Description="Information about the response.", IsRequired=true)
    var Description:String? = null

    /**
    * Heading or summary of the response.
    */
    @ApiMember(Description="Heading or summary of the response.", IsRequired=true)
    var Heading:String? = null

    /**
    * Did the intended operation for this response complete successfully?
    */
    @ApiMember(DataType="boolean", Description="Did the intended operation for this response complete successfully?", IsRequired=true)
    var WasSuccessful:Boolean? = null
}

Kotlin CalculateDistance DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + 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: api.1fetch.co.za 
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>