1Fetch Client API

<back to all web services

CalculateDistance

The following routes are available for this service:
POST/calculatedistanceCalculate the distance between a list of coordinates
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using WebService.ClientServiceModel;
using WebService.ClientServiceModel.Base;

namespace WebService.ClientServiceModel
{
    public partial class CalculateDistance
        : ApiServiceRequest, ILogRequest
    {
        public CalculateDistance()
        {
            Coordinates = new List<Coordinate>{};
        }

        ///<summary>
        ///Array of coordinates
        ///</summary>
        [ApiMember(Description="Array of coordinates", IsRequired=true)]
        public virtual List<Coordinate> Coordinates { get; set; }
    }

    public partial class CalculateDistanceResponse
        : ApiServiceResponse
    {
        public CalculateDistanceResponse()
        {
            PointDistances = new List<decimal>{};
        }

        ///<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")]
        public virtual List<decimal> PointDistances { get; set; }

        ///<summary>
        ///The total distance between all points
        ///</summary>
        [ApiMember(Description="The total distance between all points")]
        public virtual decimal TotalDistance { get; set; }
    }

    public partial class Coordinate
    {
        ///<summary>
        ///The Latitude
        ///</summary>
        [ApiMember(Description="The Latitude", IsRequired=true)]
        public virtual double Latitude { get; set; }

        ///<summary>
        ///The Longitude
        ///</summary>
        [ApiMember(Description="The Longitude", IsRequired=true)]
        public virtual double Longitude { get; set; }
    }

}

namespace WebService.ClientServiceModel.Base
{
    public partial class ApiServiceRequest
        : IServiceRequest, IHasApiKey
    {
        ///<summary>
        ///The API Key required for authentication
        ///</summary>
        [ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)]
        public virtual string ApiKey { get; set; }
    }

    public partial class ApiServiceResponse
        : IServiceResponse
    {
        ///<summary>
        ///Information about the response.
        ///</summary>
        [ApiMember(Description="Information about the response.", IsRequired=true)]
        public virtual string Description { get; set; }

        ///<summary>
        ///Heading or summary of the response.
        ///</summary>
        [ApiMember(Description="Heading or summary of the response.", IsRequired=true)]
        public virtual string Heading { 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)]
        public virtual bool WasSuccessful { get; set; }
    }

}

C# CalculateDistance DTOs

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

HTTP + OTHER

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: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"Coordinates":[{"Latitude":0,"Longitude":0}],"ApiKey":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"PointDistances":[0],"TotalDistance":0,"Description":"String","Heading":"String","WasSuccessful":false}