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

**GeoDataCitiesQuery** Parameters:
Name	Parameter	Data Type	Required	Description
CountryId	path	string	Yes	Enter the country id you want to search cities. Example SE for Sweden.

**QueryBase** Parameters:
Name	Parameter	Data Type	Required	Description
Skip	query	int	No	Skip 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`
Take	query	int	No	Return a given number of elements in a sequence and then skip over the remainder. Use this when you need paging. Example: `?take=20`
OrderBy	query	string	No	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. Example: `?orderBy=Id,-Age,FirstName`
OrderByDesc	query	string	No	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. Example: `?orderByDesc=Id,-Age,FirstName`
Include	query	string	No	Include 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`
Fields	form	string	No
Meta	form	Dictionary<string, string>	No

**City** Parameters:
Name	Parameter	Data Type	Required
Longitude	form	double	No
Latitude	form	double	No
Name	form	string	Yes
Country	form	string	Yes
Iso2	form	string	No
Admin	form	string	Yes
Capital	form	string	No
Population	form	int?	No
PopulationProper	form	int?	No
ModifiedDate	form	DateTimeOffset?	No
Id	form	Guid	Yes

**GeoDataCitiesQueryResponse** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid	No
City	form	string	Yes
Longitude	form	string	Yes
Latitude	form	string	Yes
Country	form	string	Yes
Iso2	form	string	Yes
Admin	form	string	Yes
Capital	form	string	Yes
Population	form	int?	No
PopulationProper	form	int?	No

**QueryResponse<T>** Parameters:
Name	Parameter	Data Type	Required
Offset	form	int	No
Total	form	int	No
Results	form	List<AccessKeyTypeResponse>	No
Meta	form	Dictionary<string, string>	No
ResponseStatus	form	ResponseStatus	No

**AccessKeyTypeResponse** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
KeyType	form	string	Yes
Description	form	string	Yes

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

HTTP + XML

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.bookmore.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfGeoDataCitiesQueryResponseWg5EthtI xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Offset>0</Offset>
  <Total>0</Total>
  <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
    <d2p1:GeoDataCitiesQueryResponse>
      <d2p1:Admin>String</d2p1:Admin>
      <d2p1:Capital>String</d2p1:Capital>
      <d2p1:City>String</d2p1:City>
      <d2p1:Country>String</d2p1:Country>
      <d2p1:Id>00000000-0000-0000-0000-000000000000</d2p1:Id>
      <d2p1:Iso2>String</d2p1:Iso2>
      <d2p1:Latitude>String</d2p1:Latitude>
      <d2p1:Longitude>String</d2p1:Longitude>
      <d2p1:Population>0</d2p1:Population>
      <d2p1:PopulationProper>0</d2p1:PopulationProper>
    </d2p1:GeoDataCitiesQueryResponse>
  </Results>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <ResponseStatus>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StackTrace>String</StackTrace>
    <Errors>
      <ResponseError>
        <ErrorCode>String</ErrorCode>
        <FieldName>String</FieldName>
        <Message>String</Message>
        <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Meta>
      </ResponseError>
    </Errors>
    <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Meta>
  </ResponseStatus>
</QueryResponseOfGeoDataCitiesQueryResponseWg5EthtI>