1Fetch Client API

<back to all web services

CalculateDistance

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

POST /calculatedistance HTTP/1.1 
Host: api.1fetch.co.za 
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
}