| GET | /licenses/plans/ | Get all license plans | This service is used to get get all license plans that exists. |
|---|
namespace BokaMera.API.ServiceModel.Db
open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type VossPlanResponse() =
member val Id:Guid = new Guid() with get,set
member val Name:String = null with get,set
member val LengthUnit:String = null with get,set
member val Length:String = null with get,set
type LengthUnit =
| Week = 1
| Month = 2
| Year = 3
[<AllowNullLiteral>]
type LicensePlanQueryResponse() =
member val Id:Int32 = new Int32() with get,set
member val VossPlanId:Guid = new Guid() with get,set
member val Name:String = null with get,set
member val Description:String = null with get,set
member val VossPlan:VossPlanResponse = null with get,set
member val PlanLength:Int32 = new Int32() with get,set
member val PlanLengthUnit:LengthUnit = new LengthUnit() with get,set
member val UpdatedDate:DateTime = new DateTime() with get,set
member val CreatedDate:DateTime = new DateTime() with get,set
member val Active:Boolean = new Boolean() with get,set
[<AllowNullLiteral>]
type BaseModel() =
class end
[<AllowNullLiteral>]
type LicensePlan() =
inherit BaseModel()
[<Ignore>]
member val VossPlan:VossPlanResponse = null with get,set
[<Required>]
member val Id:Int32 = new Int32() with get,set
member val VossPlanId:Guid = new Guid() with get,set
[<Required>]
member val PlanLength:Int32 = new Int32() with get,set
[<Required>]
member val PlanLengthUnitId:Int32 = new Int32() with get,set
[<Required>]
member val Name:String = null with get,set
[<Required>]
member val Description:String = null with get,set
member val UpdatedDate:DateTime = new DateTime() with get,set
member val Active:Boolean = new Boolean() with get,set
member val CreatedDate:DateTime = new DateTime() 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> = null with get,set
[<AllowNullLiteral>]
type QueryDb<From, Into>() =
inherit QueryBase()
[<ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)>]
[<AllowNullLiteral>]
type LicensePlanQuery() =
inherit QueryDb<LicensePlan, LicensePlanQueryResponse>()
///<summary>
///Search active plan.
///</summary>
[<ApiMember(Description="Search active plan.", ParameterType="query")>]
member val Active:Boolean = new Boolean() with get,set
[<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<T>() =
[<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> = null with get,set
[<DataMember(Order=4)>]
member val Meta:Dictionary<String, String> = null 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 .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /licenses/plans/ HTTP/1.1 Host: testapi.bokamera.se Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Offset":0,"Total":0,"Results":[{"Id":0,"Name":"String","Description":"String","VossPlan":{"Name":"String","LengthUnit":"String","Length":"String"},"PlanLength":0,"PlanLengthUnit":"Week","Active":false}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}