1Fetch Client API

<back to all web services

CalculateDistance

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

public class dtos
{

    public static class CalculateDistance extends ApiServiceRequest implements ILogRequest
    {
        /**
        * Array of coordinates
        */
        @ApiMember(Description="Array of coordinates", IsRequired=true)
        public ArrayList<Coordinate> Coordinates = null;
        
        public ArrayList<Coordinate> getCoordinates() { return Coordinates; }
        public CalculateDistance setCoordinates(ArrayList<Coordinate> value) { this.Coordinates = value; return this; }
    }

    public static class ApiServiceRequest implements IServiceRequest, IHasApiKey
    {
        /**
        * The API Key required for authentication
        */
        @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
        public String ApiKey = null;
        
        public String getApiKey() { return ApiKey; }
        public ApiServiceRequest setApiKey(String value) { this.ApiKey = value; return this; }
    }

    public static class Coordinate
    {
        /**
        * The Latitude
        */
        @ApiMember(Description="The Latitude", IsRequired=true)
        public Double Latitude = null;

        /**
        * The Longitude
        */
        @ApiMember(Description="The Longitude", IsRequired=true)
        public Double Longitude = null;
        
        public Double getLatitude() { return Latitude; }
        public Coordinate setLatitude(Double value) { this.Latitude = value; return this; }
        public Double getLongitude() { return Longitude; }
        public Coordinate setLongitude(Double value) { this.Longitude = value; return this; }
    }

    public static class CalculateDistanceResponse extends 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")
        public ArrayList<BigDecimal> PointDistances = null;

        /**
        * The total distance between all points
        */
        @ApiMember(Description="The total distance between all points")
        public BigDecimal TotalDistance = null;
        
        public ArrayList<BigDecimal> getPointDistances() { return PointDistances; }
        public CalculateDistanceResponse setPointDistances(ArrayList<BigDecimal> value) { this.PointDistances = value; return this; }
        public BigDecimal getTotalDistance() { return TotalDistance; }
        public CalculateDistanceResponse setTotalDistance(BigDecimal value) { this.TotalDistance = value; return this; }
    }

    public static class ApiServiceResponse implements IServiceResponse
    {
        /**
        * Information about the response.
        */
        @ApiMember(Description="Information about the response.", IsRequired=true)
        public String Description = null;

        /**
        * Heading or summary of the response.
        */
        @ApiMember(Description="Heading or summary of the response.", IsRequired=true)
        public String Heading = 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)
        public Boolean WasSuccessful = null;
        
        public String getDescription() { return Description; }
        public ApiServiceResponse setDescription(String value) { this.Description = value; return this; }
        public String getHeading() { return Heading; }
        public ApiServiceResponse setHeading(String value) { this.Heading = value; return this; }
        public Boolean isWasSuccessful() { return WasSuccessful; }
        public ApiServiceResponse setWasSuccessful(Boolean value) { this.WasSuccessful = value; return this; }
    }

}

Java CalculateDistance DTOs

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>