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
GeoDataCitiesQuery Parameters:
NameParameterData TypeRequiredDescription
CountryIdpathstringYesEnter the country id you want to search cities. Example SE for Sweden.
QueryBase Parameters:
NameParameterData TypeRequiredDescription
SkipqueryintNoSkip over a given number of elements in a sequence and then return the remainder. Use this when you need paging.

Example:
?skip=10&orderBy=Id
TakequeryintNoReturn a given number of elements in a sequence and then skip over the remainder. Use this when you need paging.

Example:
?take=20
OrderByquerystringNoComma 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.

Example:
?orderBy=Id,-Age,FirstName
OrderByDescquerystringNoComma 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.

Example:
?orderByDesc=Id,-Age,FirstName
IncludequerystringNoInclude any of the aggregates AVG, COUNT, FIRST, LAST, MAX, MIN, SUM in your result set. The results will be returned in the meta field.

Example:
?include=COUNT(*) as Total

or multiple fields with
?include=Count(*) Total, Min(Age), AVG(Age) AverageAge

or unique with
?include=COUNT(DISTINCT LivingStatus) as UniqueStatus
FieldsformstringNo
MetaformDictionary<string, string>No
City Parameters:
NameParameterData TypeRequiredDescription
LongitudeformdoubleNo
LatitudeformdoubleNo
NameformstringYes
CountryformstringYes
Iso2formstringNo
AdminformstringYes
CapitalformstringNo
Populationformint?No
PopulationProperformint?No
ModifiedDateformDateTimeOffset?No
IdformGuidYes
GeoDataCitiesQueryResponse Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
CityformstringNo
LongitudeformstringNo
LatitudeformstringNo
CountryformstringNo
Iso2formstringNo
AdminformstringNo
CapitalformstringNo
Populationformint?No
PopulationProperformint?No
QueryResponse<AccessKeyTypeResponse> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<AccessKeyTypeResponse>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo
AccessKeyTypeResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
KeyTypeformstringNo
DescriptionformstringNo

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"}}}