1Fetch Client API

<back to all web services

CalculateDistance

import 'package:servicestack/servicestack.dart';

class ApiServiceRequest implements IServiceRequest, IHasApiKey, IConvertible
{
    /**
    * The API Key required for authentication
    */
    // @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
    String? ApiKey;

    ApiServiceRequest({this.ApiKey});
    ApiServiceRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ApiKey = json['ApiKey'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ApiKey': ApiKey
    };

    getTypeName() => "ApiServiceRequest";
    TypeContext? context = _ctx;
}

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

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

    /**
    * Did the intended operation for this response complete successfully?
    */
    // @ApiMember(DataType="boolean", Description="Did the intended operation for this response complete successfully?", IsRequired=true)
    bool? WasSuccessful;

    ApiServiceResponse({this.Description,this.Heading,this.WasSuccessful});
    ApiServiceResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Description = json['Description'];
        Heading = json['Heading'];
        WasSuccessful = json['WasSuccessful'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Description': Description,
        'Heading': Heading,
        'WasSuccessful': WasSuccessful
    };

    getTypeName() => "ApiServiceResponse";
    TypeContext? context = _ctx;
}

class CalculateDistanceResponse extends ApiServiceResponse implements IConvertible
{
    /**
    * 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")
    List<double>? PointDistances;

    /**
    * The total distance between all points
    */
    // @ApiMember(Description="The total distance between all points")
    double? TotalDistance;

    CalculateDistanceResponse({this.PointDistances,this.TotalDistance});
    CalculateDistanceResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        PointDistances = JsonConverters.fromJson(json['PointDistances'],'List<double>',context!);
        TotalDistance = JsonConverters.toDouble(json['TotalDistance']);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'PointDistances': JsonConverters.toJson(PointDistances,'List<double>',context!),
        'TotalDistance': TotalDistance
    });

    getTypeName() => "CalculateDistanceResponse";
    TypeContext? context = _ctx;
}

class Coordinate implements IConvertible
{
    /**
    * The Latitude
    */
    // @ApiMember(Description="The Latitude", IsRequired=true)
    double? Latitude;

    /**
    * The Longitude
    */
    // @ApiMember(Description="The Longitude", IsRequired=true)
    double? Longitude;

    Coordinate({this.Latitude,this.Longitude});
    Coordinate.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Latitude = JsonConverters.toDouble(json['Latitude']);
        Longitude = JsonConverters.toDouble(json['Longitude']);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Latitude': Latitude,
        'Longitude': Longitude
    };

    getTypeName() => "Coordinate";
    TypeContext? context = _ctx;
}

class CalculateDistance extends ApiServiceRequest implements ILogRequest, IConvertible
{
    /**
    * Array of coordinates
    */
    // @ApiMember(Description="Array of coordinates", IsRequired=true)
    List<Coordinate>? Coordinates;

    CalculateDistance({this.Coordinates});
    CalculateDistance.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        Coordinates = JsonConverters.fromJson(json['Coordinates'],'List<Coordinate>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'Coordinates': JsonConverters.toJson(Coordinates,'List<Coordinate>',context!)
    });

    getTypeName() => "CalculateDistance";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'api.1fetch.co.za', types: <String, TypeInfo> {
    'ApiServiceRequest': TypeInfo(TypeOf.Class, create:() => ApiServiceRequest()),
    'ApiServiceResponse': TypeInfo(TypeOf.Class, create:() => ApiServiceResponse()),
    'CalculateDistanceResponse': TypeInfo(TypeOf.Class, create:() => CalculateDistanceResponse()),
    'Coordinate': TypeInfo(TypeOf.Class, create:() => Coordinate()),
    'CalculateDistance': TypeInfo(TypeOf.Class, create:() => CalculateDistance()),
    'List<Coordinate>': TypeInfo(TypeOf.Class, create:() => <Coordinate>[]),
});

Dart 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>