| GET | /geodata/{CountryId}/cities/ | Get all cities for a specific country | Get all information stored on the customer |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
import com.google.gson.annotations.*;
import com.google.gson.reflect.*;
public class dtos
{
public static class GeoDataCitiesQuery extends QueryDb<City, GeoDataCitiesQueryResponse>
{
/**
* 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")
public String CountryId = null;
public String getCountryId() { return CountryId; }
public GeoDataCitiesQuery setCountryId(String value) { this.CountryId = value; return this; }
}
public static class QueryDb<From, Into> extends QueryBase
{
}
@DataContract
public static class QueryBase
{
/**
* 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>
*/
@DataMember(Order=1)
public Integer Skip = null;
/**
* 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>
*/
@DataMember(Order=2)
public Integer Take = null;
/**
* 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>
*/
@DataMember(Order=3)
public String OrderBy = null;
/**
* 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>
*/
@DataMember(Order=4)
public String OrderByDesc = null;
/**
* 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>
*/
@DataMember(Order=5)
public String Include = null;
@DataMember(Order=6)
public String Fields = null;
@DataMember(Order=7)
public HashMap<String,String> Meta = null;
public Integer getSkip() { return Skip; }
public QueryBase setSkip(Integer value) { this.Skip = value; return this; }
public Integer getTake() { return Take; }
public QueryBase setTake(Integer value) { this.Take = value; return this; }
public String getOrderBy() { return OrderBy; }
public QueryBase setOrderBy(String value) { this.OrderBy = value; return this; }
public String getOrderByDesc() { return OrderByDesc; }
public QueryBase setOrderByDesc(String value) { this.OrderByDesc = value; return this; }
public String getInclude() { return Include; }
public QueryBase setInclude(String value) { this.Include = value; return this; }
public String getFields() { return Fields; }
public QueryBase setFields(String value) { this.Fields = value; return this; }
public HashMap<String,String> getMeta() { return Meta; }
public QueryBase setMeta(HashMap<String,String> value) { this.Meta = value; return this; }
}
public static class City extends BaseModel
{
@Ignore()
public Double Longitude = null;
@Ignore()
public Double Latitude = null;
@Required()
public String Name = null;
@Required()
public String Country = null;
public String Iso2 = null;
@Required()
public String Admin = null;
public String Capital = null;
public Integer Population = null;
public Integer PopulationProper = null;
public Date ModifiedDate = null;
@Required()
public UUID Id = null;
public Double getLongitude() { return Longitude; }
public City setLongitude(Double value) { this.Longitude = value; return this; }
public Double getLatitude() { return Latitude; }
public City setLatitude(Double value) { this.Latitude = value; return this; }
public String getName() { return Name; }
public City setName(String value) { this.Name = value; return this; }
public String getCountry() { return Country; }
public City setCountry(String value) { this.Country = value; return this; }
public String getIso2() { return Iso2; }
public City setIso2(String value) { this.Iso2 = value; return this; }
public String getAdmin() { return Admin; }
public City setAdmin(String value) { this.Admin = value; return this; }
public String getCapital() { return Capital; }
public City setCapital(String value) { this.Capital = value; return this; }
public Integer getPopulation() { return Population; }
public City setPopulation(Integer value) { this.Population = value; return this; }
public Integer getPopulationProper() { return PopulationProper; }
public City setPopulationProper(Integer value) { this.PopulationProper = value; return this; }
public Date getModifiedDate() { return ModifiedDate; }
public City setModifiedDate(Date value) { this.ModifiedDate = value; return this; }
public UUID getId() { return Id; }
public City setId(UUID value) { this.Id = value; return this; }
}
public static class BaseModel
{
}
public static class GeoDataCitiesQueryResponse
{
public UUID Id = null;
public String City = null;
public String Longitude = null;
public String Latitude = null;
public String Country = null;
public String Iso2 = null;
public String Admin = null;
public String Capital = null;
public Integer Population = null;
public Integer PopulationProper = null;
public UUID getId() { return Id; }
public GeoDataCitiesQueryResponse setId(UUID value) { this.Id = value; return this; }
public String getCity() { return City; }
public GeoDataCitiesQueryResponse setCity(String value) { this.City = value; return this; }
public String getLongitude() { return Longitude; }
public GeoDataCitiesQueryResponse setLongitude(String value) { this.Longitude = value; return this; }
public String getLatitude() { return Latitude; }
public GeoDataCitiesQueryResponse setLatitude(String value) { this.Latitude = value; return this; }
public String getCountry() { return Country; }
public GeoDataCitiesQueryResponse setCountry(String value) { this.Country = value; return this; }
public String getIso2() { return Iso2; }
public GeoDataCitiesQueryResponse setIso2(String value) { this.Iso2 = value; return this; }
public String getAdmin() { return Admin; }
public GeoDataCitiesQueryResponse setAdmin(String value) { this.Admin = value; return this; }
public String getCapital() { return Capital; }
public GeoDataCitiesQueryResponse setCapital(String value) { this.Capital = value; return this; }
public Integer getPopulation() { return Population; }
public GeoDataCitiesQueryResponse setPopulation(Integer value) { this.Population = value; return this; }
public Integer getPopulationProper() { return PopulationProper; }
public GeoDataCitiesQueryResponse setPopulationProper(Integer value) { this.PopulationProper = value; return this; }
}
@DataContract
public static class QueryResponse<AccessKeyTypeResponse>
{
@DataMember(Order=1)
public Integer Offset = null;
@DataMember(Order=2)
public Integer Total = null;
@DataMember(Order=3)
public ArrayList<AccessKeyTypeResponse> Results = null;
@DataMember(Order=4)
public HashMap<String,String> Meta = null;
@DataMember(Order=5)
public ResponseStatus ResponseStatus = null;
public Integer getOffset() { return Offset; }
public QueryResponse<AccessKeyTypeResponse> setOffset(Integer value) { this.Offset = value; return this; }
public Integer getTotal() { return Total; }
public QueryResponse<AccessKeyTypeResponse> setTotal(Integer value) { this.Total = value; return this; }
public ArrayList<AccessKeyTypeResponse> getResults() { return Results; }
public QueryResponse<AccessKeyTypeResponse> setResults(ArrayList<AccessKeyTypeResponse> value) { this.Results = value; return this; }
public HashMap<String,String> getMeta() { return Meta; }
public QueryResponse<AccessKeyTypeResponse> setMeta(HashMap<String,String> value) { this.Meta = value; return this; }
public ResponseStatus getResponseStatus() { return ResponseStatus; }
public QueryResponse<AccessKeyTypeResponse> setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
}
public static class AccessKeyTypeResponse
{
public Integer Id = null;
public String KeyType = null;
public String Description = null;
public Integer getId() { return Id; }
public AccessKeyTypeResponse setId(Integer value) { this.Id = value; return this; }
public String getKeyType() { return KeyType; }
public AccessKeyTypeResponse setKeyType(String value) { this.KeyType = value; return this; }
public String getDescription() { return Description; }
public AccessKeyTypeResponse setDescription(String value) { this.Description = value; return this; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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.bokamera.se
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>