BokaMera.API.Host

<back to all web services

SuperAdminCompanyLicenseQuery

import Foundation
import ServiceStack

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
public class SuperAdminCompanyLicenseQuery : QueryDb2<License, CompanyLicenseQueryResponse>
{
    /**
    * The company id, if empty will use the company id for the user you are logged in with.
    */
    // @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
    public var companyId:String?

    /**
    * If you want to include the connected license items
    */
    // @ApiMember(DataType="boolean", Description="If you want to include the connected license items", ParameterType="query")
    public var onlyActiveLicenses:Bool

    /**
    * What country you want to list the prices for
    */
    // @ApiMember(DataType="string", Description="What country you want to list the prices for")
    public var countryId:String

    /**
    * Search by the Meta data information on the license
    */
    // @ApiMember(DataType="string", Description="Search by the Meta data information on the license")
    public var metaData:String

    /**
    * Id of the license type
    */
    // @ApiMember(Description="Id of the license type")
    public var typeId:Int?

    /**
    * If you want to only select Extra license options
    */
    // @ApiMember(DataType="boolean", Description="If you want to only select Extra license options", ParameterType="query")
    public var isExtraLicenseOption:Bool?

    /**
    * If you want to include the connected license items
    */
    // @ApiMember(DataType="boolean", Description="If you want to include the connected license items", ParameterType="query")
    public var includeLicenseItems:Bool

    /**
    * If you want to include the connected licens prices
    */
    // @ApiMember(DataType="boolean", Description="If you want to include the connected licens prices", ParameterType="query")
    public var includeLicensePrices:Bool

    public var responseStatus:ResponseStatus

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case companyId
        case onlyActiveLicenses
        case countryId
        case metaData
        case typeId
        case isExtraLicenseOption
        case includeLicenseItems
        case includeLicensePrices
        case responseStatus
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        companyId = try container.decodeIfPresent(String.self, forKey: .companyId)
        onlyActiveLicenses = try container.decodeIfPresent(Bool.self, forKey: .onlyActiveLicenses)
        countryId = try container.decodeIfPresent(String.self, forKey: .countryId)
        metaData = try container.decodeIfPresent(String.self, forKey: .metaData)
        typeId = try container.decodeIfPresent(Int.self, forKey: .typeId)
        isExtraLicenseOption = try container.decodeIfPresent(Bool.self, forKey: .isExtraLicenseOption)
        includeLicenseItems = try container.decodeIfPresent(Bool.self, forKey: .includeLicenseItems)
        includeLicensePrices = try container.decodeIfPresent(Bool.self, forKey: .includeLicensePrices)
        responseStatus = try container.decodeIfPresent(ResponseStatus.self, forKey: .responseStatus)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if companyId != nil { try container.encode(companyId, forKey: .companyId) }
        if onlyActiveLicenses != nil { try container.encode(onlyActiveLicenses, forKey: .onlyActiveLicenses) }
        if countryId != nil { try container.encode(countryId, forKey: .countryId) }
        if metaData != nil { try container.encode(metaData, forKey: .metaData) }
        if typeId != nil { try container.encode(typeId, forKey: .typeId) }
        if isExtraLicenseOption != nil { try container.encode(isExtraLicenseOption, forKey: .isExtraLicenseOption) }
        if includeLicenseItems != nil { try container.encode(includeLicenseItems, forKey: .includeLicenseItems) }
        if includeLicensePrices != nil { try container.encode(includeLicensePrices, forKey: .includeLicensePrices) }
        if responseStatus != nil { try container.encode(responseStatus, forKey: .responseStatus) }
    }
}

public class License : BaseModel
{
    public var type:LicenseType
    // @Required()
    public var companyId:String?

    public var id:Int
    // @Required()
    public var typeId:Int?

    // @Required()
    public var validFrom:Date?

    // @Required()
    public var validTo:Date?

    // @Required()
    public var active:Bool?

    // @Required()
    public var updated:Date?

    // @Required()
    public var created:Date?

    public var modifiedDate:Date?
    public var metaData:String

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case type
        case companyId
        case id
        case typeId
        case validFrom
        case validTo
        case active
        case updated
        case created
        case modifiedDate
        case metaData
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        type = try container.decodeIfPresent(LicenseType.self, forKey: .type)
        companyId = try container.decodeIfPresent(String.self, forKey: .companyId)
        id = try container.decodeIfPresent(Int.self, forKey: .id)
        typeId = try container.decodeIfPresent(Int.self, forKey: .typeId)
        validFrom = try container.decodeIfPresent(Date.self, forKey: .validFrom)
        validTo = try container.decodeIfPresent(Date.self, forKey: .validTo)
        active = try container.decodeIfPresent(Bool.self, forKey: .active)
        updated = try container.decodeIfPresent(Date.self, forKey: .updated)
        created = try container.decodeIfPresent(Date.self, forKey: .created)
        modifiedDate = try container.decodeIfPresent(Date.self, forKey: .modifiedDate)
        metaData = try container.decodeIfPresent(String.self, forKey: .metaData)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if type != nil { try container.encode(type, forKey: .type) }
        if companyId != nil { try container.encode(companyId, forKey: .companyId) }
        if id != nil { try container.encode(id, forKey: .id) }
        if typeId != nil { try container.encode(typeId, forKey: .typeId) }
        if validFrom != nil { try container.encode(validFrom, forKey: .validFrom) }
        if validTo != nil { try container.encode(validTo, forKey: .validTo) }
        if active != nil { try container.encode(active, forKey: .active) }
        if updated != nil { try container.encode(updated, forKey: .updated) }
        if created != nil { try container.encode(created, forKey: .created) }
        if modifiedDate != nil { try container.encode(modifiedDate, forKey: .modifiedDate) }
        if metaData != nil { try container.encode(metaData, forKey: .metaData) }
    }
}

public class BaseModel : Codable
{
    required public init(){}
}

public class LicenseType : BaseModel
{
    // @Ignore()
    public var licenseItems:IList<LicenseTypeItem>

    // @Ignore()
    public var prices:IList<LicensePrice>

    // @Ignore()
    public var periodOfNoticeDays:Int

    // @Ignore()
    public var nextLicenseOption:LicenseType

    // @Required()
    public var name:String?

    // @Required()
    public var Description:String?

    // @Required()
    public var extraLicenseOption:Bool?

    public var modifiedDate:Date?
    public var id:Int

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case licenseItems
        case prices
        case periodOfNoticeDays
        case nextLicenseOption
        case name
        case Description
        case extraLicenseOption
        case modifiedDate
        case id
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        licenseItems = try container.decodeIfPresent(IList<LicenseTypeItem>.self, forKey: .licenseItems)
        prices = try container.decodeIfPresent(IList<LicensePrice>.self, forKey: .prices)
        periodOfNoticeDays = try container.decodeIfPresent(Int.self, forKey: .periodOfNoticeDays)
        nextLicenseOption = try container.decodeIfPresent(LicenseType.self, forKey: .nextLicenseOption)
        name = try container.decodeIfPresent(String.self, forKey: .name)
        Description = try container.decodeIfPresent(String.self, forKey: .Description)
        extraLicenseOption = try container.decodeIfPresent(Bool.self, forKey: .extraLicenseOption)
        modifiedDate = try container.decodeIfPresent(Date.self, forKey: .modifiedDate)
        id = try container.decodeIfPresent(Int.self, forKey: .id)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if licenseItems != nil { try container.encode(licenseItems, forKey: .licenseItems) }
        if prices != nil { try container.encode(prices, forKey: .prices) }
        if periodOfNoticeDays != nil { try container.encode(periodOfNoticeDays, forKey: .periodOfNoticeDays) }
        if nextLicenseOption != nil { try container.encode(nextLicenseOption, forKey: .nextLicenseOption) }
        if name != nil { try container.encode(name, forKey: .name) }
        if Description != nil { try container.encode(Description, forKey: .Description) }
        if extraLicenseOption != nil { try container.encode(extraLicenseOption, forKey: .extraLicenseOption) }
        if modifiedDate != nil { try container.encode(modifiedDate, forKey: .modifiedDate) }
        if id != nil { try container.encode(id, forKey: .id) }
    }
}

public class LicenseTypeItem : BaseModel
{
    // @Ignore()
    public var name:String

    // @Required()
    public var licenseTypesId:Int?

    // @Required()
    public var licenseItemsId:Int?

    // @Required()
    public var numberOfItems:Int?

    public var id:Int
    public var modifiedDate:Date?

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case name
        case licenseTypesId
        case licenseItemsId
        case numberOfItems
        case id
        case modifiedDate
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        name = try container.decodeIfPresent(String.self, forKey: .name)
        licenseTypesId = try container.decodeIfPresent(Int.self, forKey: .licenseTypesId)
        licenseItemsId = try container.decodeIfPresent(Int.self, forKey: .licenseItemsId)
        numberOfItems = try container.decodeIfPresent(Int.self, forKey: .numberOfItems)
        id = try container.decodeIfPresent(Int.self, forKey: .id)
        modifiedDate = try container.decodeIfPresent(Date.self, forKey: .modifiedDate)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if name != nil { try container.encode(name, forKey: .name) }
        if licenseTypesId != nil { try container.encode(licenseTypesId, forKey: .licenseTypesId) }
        if licenseItemsId != nil { try container.encode(licenseItemsId, forKey: .licenseItemsId) }
        if numberOfItems != nil { try container.encode(numberOfItems, forKey: .numberOfItems) }
        if id != nil { try container.encode(id, forKey: .id) }
        if modifiedDate != nil { try container.encode(modifiedDate, forKey: .modifiedDate) }
    }
}

public class LicensePrice : BaseModel
{
    // @Ignore()
    public var country:Country

    // @Ignore()
    public var monthlyPayment:Bool

    // @Required()
    public var licenseTypeId:Int?

    // @Required()
    public var countryId:String?

    // @Required()
    public var price:Int?

    public var modifiedDate:Date?

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case country
        case monthlyPayment
        case licenseTypeId
        case countryId
        case price
        case modifiedDate
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        country = try container.decodeIfPresent(Country.self, forKey: .country)
        monthlyPayment = try container.decodeIfPresent(Bool.self, forKey: .monthlyPayment)
        licenseTypeId = try container.decodeIfPresent(Int.self, forKey: .licenseTypeId)
        countryId = try container.decodeIfPresent(String.self, forKey: .countryId)
        price = try container.decodeIfPresent(Int.self, forKey: .price)
        modifiedDate = try container.decodeIfPresent(Date.self, forKey: .modifiedDate)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if country != nil { try container.encode(country, forKey: .country) }
        if monthlyPayment != nil { try container.encode(monthlyPayment, forKey: .monthlyPayment) }
        if licenseTypeId != nil { try container.encode(licenseTypeId, forKey: .licenseTypeId) }
        if countryId != nil { try container.encode(countryId, forKey: .countryId) }
        if price != nil { try container.encode(price, forKey: .price) }
        if modifiedDate != nil { try container.encode(modifiedDate, forKey: .modifiedDate) }
    }
}

public class Country : BaseModel
{
    // @References(typeof(Currency))
    public var currencyId:String

    public var currencyInfo:Currency
    // @Required()
    public var name:String?

    public var culture:String
    public var timeZone:String
    public var modifiedDate:Date?
    // @Required()
    public var id:String?

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case currencyId
        case currencyInfo
        case name
        case culture
        case timeZone
        case modifiedDate
        case id
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        currencyId = try container.decodeIfPresent(String.self, forKey: .currencyId)
        currencyInfo = try container.decodeIfPresent(Currency.self, forKey: .currencyInfo)
        name = try container.decodeIfPresent(String.self, forKey: .name)
        culture = try container.decodeIfPresent(String.self, forKey: .culture)
        timeZone = try container.decodeIfPresent(String.self, forKey: .timeZone)
        modifiedDate = try container.decodeIfPresent(Date.self, forKey: .modifiedDate)
        id = try container.decodeIfPresent(String.self, forKey: .id)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if currencyId != nil { try container.encode(currencyId, forKey: .currencyId) }
        if currencyInfo != nil { try container.encode(currencyInfo, forKey: .currencyInfo) }
        if name != nil { try container.encode(name, forKey: .name) }
        if culture != nil { try container.encode(culture, forKey: .culture) }
        if timeZone != nil { try container.encode(timeZone, forKey: .timeZone) }
        if modifiedDate != nil { try container.encode(modifiedDate, forKey: .modifiedDate) }
        if id != nil { try container.encode(id, forKey: .id) }
    }
}

public class Currency : BaseModel
{
    // @Required()
    public var name:String?

    // @Required()
    public var currencySign:String?

    // @Required()
    public var active:Bool?

    public var modifiedDate:Date?
    // @Required()
    public var id:String?

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case name
        case currencySign
        case active
        case modifiedDate
        case id
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        name = try container.decodeIfPresent(String.self, forKey: .name)
        currencySign = try container.decodeIfPresent(String.self, forKey: .currencySign)
        active = try container.decodeIfPresent(Bool.self, forKey: .active)
        modifiedDate = try container.decodeIfPresent(Date.self, forKey: .modifiedDate)
        id = try container.decodeIfPresent(String.self, forKey: .id)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if name != nil { try container.encode(name, forKey: .name) }
        if currencySign != nil { try container.encode(currencySign, forKey: .currencySign) }
        if active != nil { try container.encode(active, forKey: .active) }
        if modifiedDate != nil { try container.encode(modifiedDate, forKey: .modifiedDate) }
        if id != nil { try container.encode(id, forKey: .id) }
    }
}

public class CompanyLicenseQueryResponse : Codable
{
    public var id:Int
    public var typeId:Int
    public var type:LicenseTypeQueryResponse
    public var validFrom:Date
    public var validTo:Date
    public var metaData:String
    public var active:Bool
    public var canceled:Bool
    public var updated:Date
    public var created:Date

    required public init(){}
}

public class LicenseTypeQueryResponse : Codable
{
    /**
    * The license type id
    */
    // @ApiMember(Description="The license type id")
    public var id:Int

    /**
    * The license type name
    */
    // @ApiMember(Description="The license type name")
    public var name:String

    /**
    * The license type description
    */
    // @ApiMember(Description="The license type description")
    public var Description:String

    /**
    * If the license type is not a standard license but instead an extra license option. An example would be sending new letter license.
    */
    // @ApiMember(Description="If the license type is not a standard license but instead an extra license option. An example would be sending new letter license.")
    public var isExtraLicenseOption:Bool

    /**
    * The period of notice for the license in days.
    */
    // @ApiMember(Description="The period of notice for the license in days.")
    public var periodOfNoticeDays:Int

    /**
    * The license items for the license type
    */
    // @ApiMember(Description="The license items for the license type")
    public var items:[LicenseItemsResponse] = []

    /**
    * The license prices in each country for the license type
    */
    // @ApiMember(Description="The license prices in each country for the license type")
    public var prices:[LicensePrice] = []

    required public init(){}
}

public class LicenseItemsResponse : Codable
{
    public var id:Int
    public var name:String
    public var allowedItems:Int

    required public init(){}
}

public class AccessKeyTypeResponse : Codable
{
    public var id:Int
    public var keyType:String
    public var Description:String

    required public init(){}
}

Swift SuperAdminCompanyLicenseQuery DTOs

GET /superadmin/licenses/company HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfCompanyLicenseQueryResponseWg5EthtI 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:CompanyLicenseQueryResponse>
      <d2p1:Active>false</d2p1:Active>
      <d2p1:Canceled>false</d2p1:Canceled>
      <d2p1:Created>0001-01-01T00:00:00</d2p1:Created>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:MetaData>String</d2p1:MetaData>
      <d2p1:Type>
        <d2p1:Description>String</d2p1:Description>
        <d2p1:Id>0</d2p1:Id>
        <d2p1:IsExtraLicenseOption>false</d2p1:IsExtraLicenseOption>
        <d2p1:Items>
          <d2p1:LicenseItemsResponse>
            <d2p1:AllowedItems>0</d2p1:AllowedItems>
            <d2p1:Id>0</d2p1:Id>
            <d2p1:Name>String</d2p1:Name>
          </d2p1:LicenseItemsResponse>
        </d2p1:Items>
        <d2p1:Name>String</d2p1:Name>
        <d2p1:PeriodOfNoticeDays>0</d2p1:PeriodOfNoticeDays>
        <d2p1:Prices xmlns:d5p1="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Db">
          <d5p1:LicensePrice>
            <d5p1:Country>
              <d5p1:Culture>String</d5p1:Culture>
              <d5p1:CurrencyId>String</d5p1:CurrencyId>
              <d5p1:CurrencyInfo>
                <d5p1:Active>false</d5p1:Active>
                <d5p1:CurrencySign>String</d5p1:CurrencySign>
                <d5p1:Id>String</d5p1:Id>
                <d5p1:ModifiedDate xmlns:d9p1="http://schemas.datacontract.org/2004/07/System">
                  <d9p1:DateTime>0001-01-01T00:00:00Z</d9p1:DateTime>
                  <d9p1:OffsetMinutes>0</d9p1:OffsetMinutes>
                </d5p1:ModifiedDate>
                <d5p1:Name>String</d5p1:Name>
              </d5p1:CurrencyInfo>
              <d5p1:Id>String</d5p1:Id>
              <d5p1:ModifiedDate xmlns:d8p1="http://schemas.datacontract.org/2004/07/System">
                <d8p1:DateTime>0001-01-01T00:00:00Z</d8p1:DateTime>
                <d8p1:OffsetMinutes>0</d8p1:OffsetMinutes>
              </d5p1:ModifiedDate>
              <d5p1:Name>String</d5p1:Name>
              <d5p1:TimeZone>String</d5p1:TimeZone>
            </d5p1:Country>
            <d5p1:CountryId>String</d5p1:CountryId>
            <d5p1:LicenseTypeId>0</d5p1:LicenseTypeId>
            <d5p1:ModifiedDate xmlns:d7p1="http://schemas.datacontract.org/2004/07/System">
              <d7p1:DateTime>0001-01-01T00:00:00Z</d7p1:DateTime>
              <d7p1:OffsetMinutes>0</d7p1:OffsetMinutes>
            </d5p1:ModifiedDate>
            <d5p1:Price>0</d5p1:Price>
          </d5p1:LicensePrice>
        </d2p1:Prices>
      </d2p1:Type>
      <d2p1:TypeId>0</d2p1:TypeId>
      <d2p1:Updated>0001-01-01T00:00:00</d2p1:Updated>
      <d2p1:ValidFrom>0001-01-01T00:00:00</d2p1:ValidFrom>
      <d2p1:ValidTo>0001-01-01T00:00:00</d2p1:ValidTo>
    </d2p1:CompanyLicenseQueryResponse>
  </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>
</QueryResponseOfCompanyLicenseQueryResponseWg5EthtI>