BokaMera.API.Host

GeoDataCitiesQuery

The following routes are available for this service:
GET	/geodata/{CountryId}/cities/	Get all cities for a specific country	Get all information stored on the customer

"use strict";
export class QueryBase {
    /** @param {{Skip?:number,Take?:number,OrderBy?:string,OrderByDesc?:string,Include?:string,Fields?:string,Meta?:{ [index: string]: string; }}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {?number}
     * @description Skip over a given number of elements in a sequence and then return the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?skip=10&orderBy=Id</code> */
    Skip;
    /**
     * @type {?number}
     * @description Return a given number of elements in a sequence and then skip over the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?take=20</code> */
    Take;
    /**
     * @type {string}
     * @description Comma separated list of fields to order by. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderBy=Id,-Age,FirstName</code> */
    OrderBy;
    /**
     * @type {string}
     * @description Comma separated list of fields to order by in descending order. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderByDesc=Id,-Age,FirstName</code> */
    OrderByDesc;
    /**
     * @type {string}
     * @description Include any of the aggregates <code>AVG, COUNT, FIRST, LAST, MAX, MIN, SUM</code> in your result set. The results will be returned in the meta field.<br/><br/><strong>Example:</strong><br/><code>?include=COUNT(*) as Total</code><br/><br/>or multiple fields with<br/><code>?include=Count(*) Total, Min(Age), AVG(Age) AverageAge</code><br/></br>or unique with<br/><code>?include=COUNT(DISTINCT LivingStatus) as UniqueStatus</code> */
    Include;
    /** @type {string} */
    Fields;
    /** @type {{ [index: string]: string; }} */
    Meta;
}
/** @typedef From {any} */
/** @typedef  Into {any} */
export class QueryDb extends QueryBase {
    /** @param {{Skip?:number,Take?:number,OrderBy?:string,OrderByDesc?:string,Include?:string,Fields?:string,Meta?:{ [index: string]: string; }}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}
export class GeoDataCitiesQueryResponse {
    /** @param {{Id?:string,City?:string,Longitude?:string,Latitude?:string,Country?:string,Iso2?:string,Admin?:string,Capital?:string,Population?:number,PopulationProper?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Id;
    /** @type {string} */
    City;
    /** @type {string} */
    Longitude;
    /** @type {string} */
    Latitude;
    /** @type {string} */
    Country;
    /** @type {string} */
    Iso2;
    /** @type {string} */
    Admin;
    /** @type {string} */
    Capital;
    /** @type {?number} */
    Population;
    /** @type {?number} */
    PopulationProper;
}
export class BaseModel {
    constructor(init) { Object.assign(this, init) }
}
export class City extends BaseModel {
    /** @param {{Longitude?:number,Latitude?:number,Name?:string,Country?:string,Iso2?:string,Admin?:string,Capital?:string,Population?:number,PopulationProper?:number,ModifiedDate?:string,Id?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {number} */
    Longitude;
    /** @type {number} */
    Latitude;
    /** @type {string} */
    Name;
    /** @type {string} */
    Country;
    /** @type {string} */
    Iso2;
    /** @type {string} */
    Admin;
    /** @type {string} */
    Capital;
    /** @type {?number} */
    Population;
    /** @type {?number} */
    PopulationProper;
    /** @type {?string} */
    ModifiedDate;
    /** @type {string} */
    Id;
}
export class GeoDataCitiesQuery extends QueryDb {
    /** @param {{CountryId?:string,Skip?:number,Take?:number,OrderBy?:string,OrderByDesc?:string,Include?:string,Fields?:string,Meta?:{ [index: string]: string; }}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {string}
     * @description Enter the country id you want to search cities. Example SE for Sweden. */
    CountryId;
}
export class AccessKeyTypeResponse {
    /** @param {{Id?:number,KeyType?:string,Description?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {string} */
    KeyType;
    /** @type {string} */
    Description;
}
/** @typedef T {any} */
export class QueryResponse {
    /** @param {{Offset?:number,Total?:number,Results?:T[],Meta?:{ [index: string]: string; },ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Offset;
    /** @type {number} */
    Total;
    /** @type {T[]} */
    Results;
    /** @type {{ [index: string]: string; }} */
    Meta;
    /** @type {ResponseStatus} */
    ResponseStatus;
}

JavaScript GeoDataCitiesQuery 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.

GET /geodata/{CountryId}/cities/ HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsonl

HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}}