| GET | /licenses/plans/ | Get all license plans | This service is used to get get all license plans that exists. |
|---|
import Foundation
import ServiceStack
// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
public class LicensePlanQuery : QueryDb2<LicensePlan, LicensePlanQueryResponse>
{
/**
* Search active plan.
*/
// @ApiMember(Description="Search active plan.", ParameterType="query")
public var active:Bool
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case active
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
active = try container.decodeIfPresent(Bool.self, forKey: .active)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if active != nil { try container.encode(active, forKey: .active) }
}
}
public class LicensePlan : BaseModel, IBaseModelUpdated, IBaseModelCreated
{
// @Ignore()
public var vossPlan:VossPlanResponse
// @Required()
public var id:Int?
public var vossPlanId:String
// @Required()
public var planLength:Int?
// @Required()
public var planLengthUnitId:Int?
// @Required()
public var name:String?
// @Required()
public var Description:String?
public var updatedDate:Date
public var active:Bool
public var createdDate:Date
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case vossPlan
case id
case vossPlanId
case planLength
case planLengthUnitId
case name
case Description
case updatedDate
case active
case createdDate
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
vossPlan = try container.decodeIfPresent(VossPlanResponse.self, forKey: .vossPlan)
id = try container.decodeIfPresent(Int.self, forKey: .id)
vossPlanId = try container.decodeIfPresent(String.self, forKey: .vossPlanId)
planLength = try container.decodeIfPresent(Int.self, forKey: .planLength)
planLengthUnitId = try container.decodeIfPresent(Int.self, forKey: .planLengthUnitId)
name = try container.decodeIfPresent(String.self, forKey: .name)
Description = try container.decodeIfPresent(String.self, forKey: .Description)
updatedDate = try container.decodeIfPresent(Date.self, forKey: .updatedDate)
active = try container.decodeIfPresent(Bool.self, forKey: .active)
createdDate = try container.decodeIfPresent(Date.self, forKey: .createdDate)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if vossPlan != nil { try container.encode(vossPlan, forKey: .vossPlan) }
if id != nil { try container.encode(id, forKey: .id) }
if vossPlanId != nil { try container.encode(vossPlanId, forKey: .vossPlanId) }
if planLength != nil { try container.encode(planLength, forKey: .planLength) }
if planLengthUnitId != nil { try container.encode(planLengthUnitId, forKey: .planLengthUnitId) }
if name != nil { try container.encode(name, forKey: .name) }
if Description != nil { try container.encode(Description, forKey: .Description) }
if updatedDate != nil { try container.encode(updatedDate, forKey: .updatedDate) }
if active != nil { try container.encode(active, forKey: .active) }
if createdDate != nil { try container.encode(createdDate, forKey: .createdDate) }
}
}
public class BaseModel : Codable
{
required public init(){}
}
public class VossPlanResponse : Codable
{
public var id:String
public var name:String
public var lengthUnit:String
public var length:String
required public init(){}
}
public class LicensePlanQueryResponse : Codable
{
public var id:Int
public var vossPlanId:String
public var name:String
public var Description:String
public var vossPlan:VossPlanResponse
public var planLength:Int
public var planLengthUnit:LengthUnit
public var updatedDate:Date
public var createdDate:Date
public var active:Bool
required public init(){}
}
public enum LengthUnit : Int, Codable
{
case Week = 1
case Month = 2
case Year = 3
}
public class AccessKeyTypeResponse : Codable
{
public var id:Int
public var keyType:String
public var Description:String
required public init(){}
}
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 /licenses/plans/ HTTP/1.1 Host: testapi.bokamera.se Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<QueryResponseOfLicensePlanQueryResponseWg5EthtI 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:LicensePlanQueryResponse>
<d2p1:Active>false</d2p1:Active>
<d2p1:CreatedDate>0001-01-01T00:00:00</d2p1:CreatedDate>
<d2p1:Description>String</d2p1:Description>
<d2p1:Id>0</d2p1:Id>
<d2p1:Name>String</d2p1:Name>
<d2p1:PlanLength>0</d2p1:PlanLength>
<d2p1:PlanLengthUnit>Week</d2p1:PlanLengthUnit>
<d2p1:UpdatedDate>0001-01-01T00:00:00</d2p1:UpdatedDate>
<d2p1:VossPlan>
<d2p1:Id>00000000-0000-0000-0000-000000000000</d2p1:Id>
<d2p1:Length>String</d2p1:Length>
<d2p1:LengthUnit>String</d2p1:LengthUnit>
<d2p1:Name>String</d2p1:Name>
</d2p1:VossPlan>
<d2p1:VossPlanId>00000000-0000-0000-0000-000000000000</d2p1:VossPlanId>
</d2p1:LicensePlanQueryResponse>
</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>
</QueryResponseOfLicensePlanQueryResponseWg5EthtI>