| GET | /cars |
|---|
namespace Application.Interfaces
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
type SortDirection =
| Ascending = 0
| Descending = 1
[<AllowNullLiteral>]
type Sorting() =
member val By:String = null with get,set
member val Direction:SortDirection = new SortDirection() with get,set
[<AllowNullLiteral>]
type Filtering() =
member val Fields:ResizeArray<String> = new ResizeArray<String>() with get,set
member val Search:String = null with get,set
[<AllowNullLiteral>]
type SearchMetadata() =
member val Total:Int32 = new Int32() with get,set
member val Limit:Int32 = new Int32() with get,set
member val Offset:Int32 = new Int32() with get,set
member val Sort:Sorting = null with get,set
member val Filter:Filtering = null with get,set
[<AllowNullLiteral>]
type SearchOperationResponse() =
member val Metadata:SearchMetadata = null with get,set
[<AllowNullLiteral>]
type CarManufacturer() =
member val Year:Int32 = new Int32() with get,set
member val Make:String = null with get,set
member val Model:String = null with get,set
[<AllowNullLiteral>]
type CarLicensePlate() =
member val Jurisdiction:String = null with get,set
member val Number:String = null with get,set
[<AllowNullLiteral>]
type CarOwner() =
member val Id:String = null with get,set
[<AllowNullLiteral>]
type CarManager() =
member val Id:String = null with get,set
[<AllowNullLiteral>]
type Car() =
member val Manufacturer:CarManufacturer = null with get,set
member val Plate:CarLicensePlate = null with get,set
member val Owner:CarOwner = null with get,set
member val Managers:ResizeArray<CarManager> = new ResizeArray<CarManager>() with get,set
member val Status:String = null with get,set
member val Altered:Nullable<Boolean> = new Nullable<Boolean>() with get,set
member val Id:String = null with get,set
[<AllowNullLiteral>]
type SearchAllCarsResponse() =
inherit SearchOperationResponse()
member val ResponseStatus:ResponseStatus = null with get,set
member val Cars:ResizeArray<Car> = new ResizeArray<Car>() with get,set
[<AllowNullLiteral>]
type SearchAllCarsRequest() =
inherit SearchOperationTenanted<SearchAllCarsResponse>()
[<AllowNullLiteral>]
type SearchOperationTenanted<'TResponse>() =
inherit SearchOperationUnTenanted<TResponse>()
member val OrganisationId:String = null with get,set
[<AllowNullLiteral>]
type SearchOperationUnTenanted<'TResponse>() =
inherit GetOperationUnTenanted<TResponse>()
member val Distinct:String = null with get,set
member val Limit:Nullable<Int32> = new Nullable<Int32>() with get,set
member val Offset:Nullable<Int32> = new Nullable<Int32>() with get,set
member val Sort:String = null with get,set
member val Filter:String = null with get,set
member val Search:String = null with get,set
[<AllowNullLiteral>]
type GetOperationUnTenanted<'TResponse>() =
interface IGet
member val Embed:String = 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 /cars HTTP/1.1 Host: staging-api.billiecart.com.au Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
},
cars:
[
{
manufacturer:
{
year: 0,
make: String,
model: String
},
plate:
{
jurisdiction: String,
number: String
},
owner:
{
id: String
},
managers:
[
{
id: String
}
],
status: String,
altered: False,
id: String
}
],
metadata:
{
total: 0,
limit: 0,
offset: 0,
sort:
{
by: String,
direction: Ascending
},
filter:
{
fields:
[
String
],
search: String
}
}
}