| POST | /calculatedistance | Calculate the distance between a list of coordinates |
|---|
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: '1fetch.api.client.prod.86degrees.com', 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>[]),
});
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /calculatedistance HTTP/1.1
Host: 1fetch.api.client.prod.86degrees.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"Coordinates":[{"Latitude":0,"Longitude":0}],"ApiKey":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"PointDistances":[0],"TotalDistance":0,"Description":"String","Heading":"String","WasSuccessful":false}