BokaMera.API.Host

<back to all web services

LicenseInformationQuery

The following routes are available for this service:
GET/licenses/information/Get whats included in each licenseThis service is used to get to summare of information about whats included in each license.
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BokaMera.API.ServiceModel.Dtos
Imports BokaMera.API.ServiceModel.Db

Namespace Global

    Namespace BokaMera.API.ServiceModel.Db

        Public Partial Class BaseModel
        End Class

        Public Partial Class Country
            Inherits BaseModel
            <References(GetType(Currency))>
            Public Overridable Property CurrencyId As String

            Public Overridable Property CurrencyInfo As Currency
            <Required>
            Public Overridable Property Name As String

            Public Overridable Property Culture As String
            Public Overridable Property TimeZone As String
            Public Overridable Property ModifiedDate As Nullable(Of DateTimeOffset)
            <Required>
            Public Overridable Property Id As String
        End Class

        Public Partial Class Currency
            Inherits BaseModel
            <Required>
            Public Overridable Property Name As String

            <Required>
            Public Overridable Property CurrencySign As String

            <Required>
            Public Overridable Property Active As Boolean

            Public Overridable Property ModifiedDate As Nullable(Of DateTimeOffset)
            <Required>
            Public Overridable Property Id As String
        End Class

        Public Partial Class LicenseInformation
            Inherits BaseModel
            <Ignore>
            Public Overridable Property Prices As IList(Of LicensePrice)

            Public Overridable Property Id As Integer
            Public Overridable Property LicenseInformationId As Integer
            <Required>
            Public Overridable Property Name As String

            <Required>
            Public Overridable Property Description As String

            Public Overridable Property Url As String
            <Required>
            Public Overridable Property FreeEdition As Boolean

            Public Overridable Property FreeEditionValue As String
            <Required>
            Public Overridable Property StartEdition As Boolean

            Public Overridable Property StartEditionValue As String
            Public Overridable Property SmartEdition As Nullable(Of Boolean)
            Public Overridable Property SmartEditionValue As String
            <Required>
            Public Overridable Property ProEdition As Boolean

            Public Overridable Property ProEditionValue As String
            Public Overridable Property EnterpriseEdition As Nullable(Of Boolean)
            Public Overridable Property EnterpriseEditionValue As String
            Public Overridable Property ModifiedDate As Nullable(Of DateTimeOffset)
        End Class

        Public Partial Class LicensePrice
            Inherits BaseModel
            <Ignore>
            Public Overridable Property Country As Country

            <Ignore>
            Public Overridable Property MonthlyPayment As Boolean

            <Required>
            Public Overridable Property LicenseTypeId As Integer

            <Required>
            Public Overridable Property CountryId As String

            <Required>
            Public Overridable Property Price As Integer

            Public Overridable Property ModifiedDate As Nullable(Of DateTimeOffset)
        End Class
    End Namespace

    Namespace BokaMera.API.ServiceModel.Dtos

        Public Partial Class AccessKeyTypeResponse
            Public Overridable Property Id As Integer
            Public Overridable Property KeyType As String
            Public Overridable Property Description As String
        End Class

        <ApiResponse(Description:="You were unauthorized to call this service", StatusCode:=401)>
        Public Partial Class LicenseInformationQuery
            Inherits QueryDb(Of LicenseInformation, LicenseTypeQueryResponse)
            '''<Summary>
            '''If you want to include the connected license prices
            '''</Summary>
            <ApiMember(DataType:="boolean", Description:="If you want to include the connected license prices", ParameterType:="query")>
            Public Overridable Property IncludeLicensePrices As Boolean

            Public Overridable Property ResponseStatus As ResponseStatus
        End Class

        Public Partial Class LicenseItemsResponse
            Public Overridable Property Id As Integer
            Public Overridable Property Name As String
            Public Overridable Property AllowedItems As Integer
        End Class

        Public Partial Class LicenseTypeQueryResponse
            Public Sub New()
                Items = New List(Of LicenseItemsResponse)
                Prices = New List(Of LicensePrice)
            End Sub

            '''<Summary>
            '''The license type id
            '''</Summary>
            <ApiMember(Description:="The license type id")>
            Public Overridable Property Id As Integer

            '''<Summary>
            '''The license type name
            '''</Summary>
            <ApiMember(Description:="The license type name")>
            Public Overridable Property Name As String

            '''<Summary>
            '''The license type description
            '''</Summary>
            <ApiMember(Description:="The license type description")>
            Public Overridable Property Description As String

            '''<Summary>
            '''If the license type is not a standard license but instead an extra license option. An example would be sending new letter license.
            '''</Summary>
            <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 Overridable Property IsExtraLicenseOption As Boolean

            '''<Summary>
            '''The period of notice for the license in days.
            '''</Summary>
            <ApiMember(Description:="The period of notice for the license in days.")>
            Public Overridable Property PeriodOfNoticeDays As Integer

            '''<Summary>
            '''The license items for the license type
            '''</Summary>
            <ApiMember(Description:="The license items for the license type")>
            Public Overridable Property Items As List(Of LicenseItemsResponse)

            '''<Summary>
            '''The license prices in each country for the license type
            '''</Summary>
            <ApiMember(Description:="The license prices in each country for the license type")>
            Public Overridable Property Prices As List(Of LicensePrice)
        End Class
    End Namespace

    Namespace ServiceStack

        <DataContract>
        Public Partial Class QueryBase
            Public Sub New()
                Meta = New Dictionary(Of String, String)
            End Sub

            '''<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)>
            Public Overridable Property Skip As Nullable(Of Integer)

            '''<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)>
            Public Overridable Property Take As Nullable(Of Integer)

            '''<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)>
            Public Overridable Property OrderBy As String

            '''<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)>
            Public Overridable Property OrderByDesc As String

            '''<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)>
            Public Overridable Property Include As String

            <DataMember(Order:=6)>
            Public Overridable Property Fields As String

            <DataMember(Order:=7)>
            Public Overridable Property Meta As Dictionary(Of String, String)
        End Class

        Public Partial Class QueryDb(Of From, Into)
            Inherits QueryBase
        End Class

        <DataContract>
        Public Partial Class QueryResponse(Of AccessKeyTypeResponse)
            Public Sub New()
                Results = New List(Of AccessKeyTypeResponse)
                Meta = New Dictionary(Of String, String)
            End Sub

            <DataMember(Order:=1)>
            Public Overridable Property Offset As Integer

            <DataMember(Order:=2)>
            Public Overridable Property Total As Integer

            <DataMember(Order:=3)>
            Public Overridable Property Results As List(Of AccessKeyTypeResponse)

            <DataMember(Order:=4)>
            Public Overridable Property Meta As Dictionary(Of String, String)

            <DataMember(Order:=5)>
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET LicenseInformationQuery DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /licenses/information/ HTTP/1.1 
Host: api.bokamera.se 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Offset":0,"Total":0,"Results":[{"Id":0,"Name":"String","Description":"String","IsExtraLicenseOption":false,"PeriodOfNoticeDays":0,"Items":[{"Id":0,"Name":"String","AllowedItems":0}],"Prices":[{"Country":{"CurrencyId":"String","CurrencyInfo":{"Name":"String","CurrencySign":"String","Active":false,"ModifiedDate":"0001-01-01T00:00:00.0000000+00:00","Id":"String"},"Name":"String","Culture":"String","TimeZone":"String","ModifiedDate":"0001-01-01T00:00:00.0000000+00:00","Id":"String"},"MonthlyPayment":true,"LicenseTypeId":0,"CountryId":"String","Price":0,"ModifiedDate":"0001-01-01T00:00:00.0000000+00:00"}]}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}