| GET | /geodata/{CountryId}/cities/ | Get all cities for a specific country | Get all information stored on the customer |
|---|
namespace BokaMera.API.ServiceModel.Db
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type GeoDataCitiesQueryResponse() =
member val Id:Guid = new Guid() with get,set
member val City:String = null with get,set
member val Longitude:String = null with get,set
member val Latitude:String = null with get,set
member val Country:String = null with get,set
member val Iso2:String = null with get,set
member val Admin:String = null with get,set
member val Capital:String = null with get,set
member val Population:Nullable<Int32> = new Nullable<Int32>() with get,set
member val PopulationProper:Nullable<Int32> = new Nullable<Int32>() with get,set
[<AllowNullLiteral>]
type BaseModel() =
class end
[<AllowNullLiteral>]
type City() =
inherit BaseModel()
[<Ignore>]
member val Longitude:Double = new Double() with get,set
[<Ignore>]
member val Latitude:Double = new Double() with get,set
[<Required>]
member val Name:String = null with get,set
[<Required>]
member val Country:String = null with get,set
member val Iso2:String = null with get,set
[<Required>]
member val Admin:String = null with get,set
member val Capital:String = null with get,set
member val Population:Nullable<Int32> = new Nullable<Int32>() with get,set
member val PopulationProper:Nullable<Int32> = new Nullable<Int32>() with get,set
member val ModifiedDate:Nullable<DateTimeOffset> = new Nullable<DateTimeOffset>() with get,set
[<Required>]
member val Id:Guid = new Guid() with get,set
[<AllowNullLiteral>]
type GeoDataCitiesQuery() =
inherit QueryDb<City, GeoDataCitiesQueryResponse>()
///<summary>
///Enter the country id you want to search cities. Example SE for Sweden.
///</summary>
[<ApiMember(Description="Enter the country id you want to search cities. Example SE for Sweden.", IsRequired=true, ParameterType="path")>]
member val CountryId:String = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type QueryBase() =
///<summary>
///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>
///</summary>
[<DataMember(Order=1)>]
member val Skip:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///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>
///</summary>
[<DataMember(Order=2)>]
member val Take:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///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>
///</summary>
[<DataMember(Order=3)>]
member val OrderBy:String = null with get,set
///<summary>
///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>
///</summary>
[<DataMember(Order=4)>]
member val OrderByDesc:String = null with get,set
///<summary>
///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>
///</summary>
[<DataMember(Order=5)>]
member val Include:String = null with get,set
[<DataMember(Order=6)>]
member val Fields:String = null with get,set
[<DataMember(Order=7)>]
member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set
[<AllowNullLiteral>]
type QueryDb<From, Into>() =
inherit QueryBase()
[<AllowNullLiteral>]
type AccessKeyTypeResponse() =
member val Id:Int32 = new Int32() with get,set
member val KeyType:String = null with get,set
member val Description:String = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type QueryResponse<AccessKeyTypeResponse>() =
[<DataMember(Order=1)>]
member val Offset:Int32 = new Int32() with get,set
[<DataMember(Order=2)>]
member val Total:Int32 = new Int32() with get,set
[<DataMember(Order=3)>]
member val Results:ResizeArray<AccessKeyTypeResponse> = new ResizeArray<AccessKeyTypeResponse>() with get,set
[<DataMember(Order=4)>]
member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set
[<DataMember(Order=5)>]
member val ResponseStatus:ResponseStatus = null with get,set
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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
}
}
}