BokaMera.API.Host

<back to all web services

GeoDataCitiesQuery

The following routes are available for this service:
GET/geodata/{CountryId}/cities/Get all cities for a specific countryGet all information stored on the customer
import 'package:servicestack/servicestack.dart';

// @DataContract
abstract class QueryBase
{
    // @DataMember(Order=1)
    int? Skip;

    // @DataMember(Order=2)
    int? Take;

    // @DataMember(Order=3)
    String? OrderBy;

    // @DataMember(Order=4)
    String? OrderByDesc;

    // @DataMember(Order=5)
    String? Include;

    // @DataMember(Order=6)
    String? Fields;

    // @DataMember(Order=7)
    Map<String,String?>? Meta;

    QueryBase({this.Skip,this.Take,this.OrderBy,this.OrderByDesc,this.Include,this.Fields,this.Meta});
    QueryBase.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Skip = json['Skip'];
        Take = json['Take'];
        OrderBy = json['OrderBy'];
        OrderByDesc = json['OrderByDesc'];
        Include = json['Include'];
        Fields = json['Fields'];
        Meta = JsonConverters.toStringMap(json['Meta']);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Skip': Skip,
        'Take': Take,
        'OrderBy': OrderBy,
        'OrderByDesc': OrderByDesc,
        'Include': Include,
        'Fields': Fields,
        'Meta': Meta
    };

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

abstract class QueryDb2<From,Into> extends QueryBase
{
    QueryDb2();
    QueryDb2.fromJson(Map<String, dynamic> json) : super.fromJson(json);
    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson();
    getTypeName() => "QueryDb<$From,$Into>";
    TypeContext? context = _ctx;
}

class GeoDataCitiesQueryResponse implements IConvertible
{
    String Id = "";
    String City = "";
    String Longitude = "";
    String Latitude = "";
    String Country = "";
    String Iso2 = "";
    String Admin = "";
    String Capital = "";
    int? Population;
    int? PopulationProper;

    GeoDataCitiesQueryResponse({this.Id,this.City,this.Longitude,this.Latitude,this.Country,this.Iso2,this.Admin,this.Capital,this.Population,this.PopulationProper});
    GeoDataCitiesQueryResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Id = json['Id'];
        City = json['City'];
        Longitude = json['Longitude'];
        Latitude = json['Latitude'];
        Country = json['Country'];
        Iso2 = json['Iso2'];
        Admin = json['Admin'];
        Capital = json['Capital'];
        Population = json['Population'];
        PopulationProper = json['PopulationProper'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Id': Id,
        'City': City,
        'Longitude': Longitude,
        'Latitude': Latitude,
        'Country': Country,
        'Iso2': Iso2,
        'Admin': Admin,
        'Capital': Capital,
        'Population': Population,
        'PopulationProper': PopulationProper
    };

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

class BaseModel implements IConvertible
{
    BaseModel();
    BaseModel.fromJson(Map<String, dynamic> json) : super();
    fromMap(Map<String, dynamic> json) {
        return this;
    }

    Map<String, dynamic> toJson() => {};
    getTypeName() => "BaseModel";
    TypeContext? context = _ctx;
}

class City extends BaseModel implements IConvertible
{
    // @Ignore()
    double Longitude = 0;

    // @Ignore()
    double Latitude = 0;

    // @Required()
    String Name = "";

    // @Required()
    String Country = "";

    String? Iso2;
    // @Required()
    String Admin = "";

    String? Capital;
    int? Population;
    int? PopulationProper;
    DateTime? ModifiedDate;
    // @Required()
    String Id = "";

    City({this.Longitude,this.Latitude,this.Name,this.Country,this.Iso2,this.Admin,this.Capital,this.Population,this.PopulationProper,this.ModifiedDate,this.Id});
    City.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        Longitude = JsonConverters.toDouble(json['Longitude']);
        Latitude = JsonConverters.toDouble(json['Latitude']);
        Name = json['Name'];
        Country = json['Country'];
        Iso2 = json['Iso2'];
        Admin = json['Admin'];
        Capital = json['Capital'];
        Population = json['Population'];
        PopulationProper = json['PopulationProper'];
        ModifiedDate = JsonConverters.fromJson(json['ModifiedDate'],'DateTime',context!);
        Id = json['Id'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'Longitude': Longitude,
        'Latitude': Latitude,
        'Name': Name,
        'Country': Country,
        'Iso2': Iso2,
        'Admin': Admin,
        'Capital': Capital,
        'Population': Population,
        'PopulationProper': PopulationProper,
        'ModifiedDate': JsonConverters.toJson(ModifiedDate,'DateTime',context!),
        'Id': Id
    });

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

class GeoDataCitiesQuery extends QueryDb2<City,GeoDataCitiesQueryResponse> implements IConvertible
{
    /**
    * Enter the country id you want to search cities. Example SE for Sweden.
    */
    // @ApiMember(Description="Enter the country id you want to search cities. Example SE for Sweden.", IsRequired=true, ParameterType="path")
    String CountryId = "";

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

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

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'CountryId': CountryId
    });

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

class AccessKeyTypeResponse implements IConvertible
{
    int Id = 0;
    String KeyType = "";
    String Description = "";

    AccessKeyTypeResponse({this.Id,this.KeyType,this.Description});
    AccessKeyTypeResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

// @DataContract
class QueryResponse<T> implements IConvertible
{
    // @DataMember(Order=1)
    int Offset = 0;

    // @DataMember(Order=2)
    int Total = 0;

    // @DataMember(Order=3)
    List<AccessKeyTypeResponse> Results = [];

    // @DataMember(Order=4)
    Map<String,String?>? Meta;

    // @DataMember(Order=5)
    ResponseStatus? ResponseStatus;

    QueryResponse({this.Offset,this.Total,this.Results,this.Meta,this.ResponseStatus});
    QueryResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Offset = json['Offset'];
        Total = json['Total'];
        Results = JsonConverters.fromJson(json['Results'],'List<AccessKeyTypeResponse>',context!);
        Meta = JsonConverters.toStringMap(json['Meta']);
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Offset': Offset,
        'Total': Total,
        'Results': JsonConverters.toJson(Results,'List<AccessKeyTypeResponse>',context!),
        'Meta': Meta,
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "QueryResponse<$T>";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'api_staging.bookmore.com', types: <String, TypeInfo> {
    'GeoDataCitiesQueryResponse': TypeInfo(TypeOf.Class, create:() => GeoDataCitiesQueryResponse()),
    'BaseModel': TypeInfo(TypeOf.Class, create:() => BaseModel()),
    'City': TypeInfo(TypeOf.Class, create:() => City()),
    'GeoDataCitiesQuery': TypeInfo(TypeOf.Class, create:() => GeoDataCitiesQuery()),
    'List<GeoDataCitiesQueryResponse>': TypeInfo(TypeOf.Class, create:() => <GeoDataCitiesQueryResponse>[]),
    'AccessKeyTypeResponse': TypeInfo(TypeOf.Class, create:() => AccessKeyTypeResponse()),
    'List<AccessKeyTypeResponse>': TypeInfo(TypeOf.Class, create:() => <AccessKeyTypeResponse>[]),
});

Dart GeoDataCitiesQuery DTOs

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

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /geodata/{CountryId}/cities/ HTTP/1.1 
Host: api-staging.bookmore.com 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Offset":0,"Total":0,"Results":[{"City":"String","Longitude":"String","Latitude":"String","Country":"String","Iso2":"String","Admin":"String","Capital":"String","Population":0,"PopulationProper":0}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}