| Requires the role: | superadmin |
| GET | /superadmin/licenses/company | Find licenses for the logged in users company | Find licenses for the logged in users company. |
|---|
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 License
Inherits BaseModel
Public Overridable Property Type As LicenseType
<Required>
Public Overridable Property CompanyId As Guid
Public Overridable Property Id As Integer
<Required>
Public Overridable Property TypeId As Integer
<Required>
Public Overridable Property ValidFrom As Date
<Required>
Public Overridable Property ValidTo As Date
<Required>
Public Overridable Property Active As Boolean
<Required>
Public Overridable Property Updated As Date
<Required>
Public Overridable Property Created As Date
Public Overridable Property ModifiedDate As Nullable(Of DateTimeOffset)
Public Overridable Property MetaData As String
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
Public Partial Class LicenseType
Inherits BaseModel
<Ignore>
Public Overridable Property LicenseItems As IList(Of LicenseTypeItem)
<Ignore>
Public Overridable Property Prices As IList(Of LicensePrice)
<Ignore>
Public Overridable Property PeriodOfNoticeDays As Integer
<Ignore>
Public Overridable Property NextLicenseOption As LicenseType
<Required>
Public Overridable Property Name As String
<Required>
Public Overridable Property Description As String
<Required>
Public Overridable Property ExtraLicenseOption As Boolean
Public Overridable Property ModifiedDate As Nullable(Of DateTimeOffset)
Public Overridable Property Active As Boolean
Public Overridable Property Id As Integer
End Class
Public Partial Class LicenseTypeItem
Inherits BaseModel
<Ignore>
Public Overridable Property Name As String
<Ignore>
Public Overridable Property LicenseType As LicenseType
<Required>
Public Overridable Property LicenseTypesId As Integer
<Required>
Public Overridable Property LicenseItemsId As Integer
<Required>
Public Overridable Property NumberOfItems As Integer
Public Overridable Property Id 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
Public Partial Class CompanyLicenseQueryResponse
Public Overridable Property Id As Integer
Public Overridable Property TypeId As Integer
Public Overridable Property Type As LicenseTypeQueryResponse
Public Overridable Property ValidFrom As Date
Public Overridable Property ValidTo As Date
Public Overridable Property MetaData As String
Public Overridable Property Active As Boolean
Public Overridable Property Canceled As Boolean
Public Overridable Property Updated As Date
Public Overridable Property Created As Date
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
<ApiResponse(Description:="You were unauthorized to call this service", StatusCode:=401)>
<ValidateRequest(Validator:="IsAuthenticated")>
Public Partial Class SuperAdminCompanyLicenseQuery
Inherits QueryDb(Of License, CompanyLicenseQueryResponse)
'''<Summary>
'''The company id, if empty will use the company id for the user you are logged in with.
'''</Summary>
<ApiMember(Description:="The company id, if empty will use the company id for the user you are logged in with.")>
Public Overridable Property CompanyId As Nullable(Of Guid)
'''<Summary>
'''If you want to include the connected license items
'''</Summary>
<ApiMember(DataType:="boolean", Description:="If you want to include the connected license items", ParameterType:="query")>
Public Overridable Property OnlyActiveLicenses As Boolean
'''<Summary>
'''What country you want to list the prices for
'''</Summary>
<ApiMember(DataType:="string", Description:="What country you want to list the prices for")>
Public Overridable Property CountryId As String
'''<Summary>
'''Search by the Meta data information on the license
'''</Summary>
<ApiMember(DataType:="string", Description:="Search by the Meta data information on the license")>
Public Overridable Property MetaData As String
'''<Summary>
'''Id of the license type
'''</Summary>
<ApiMember(Description:="Id of the license type")>
Public Overridable Property TypeId As Nullable(Of Integer)
'''<Summary>
'''If you want to only select Extra license options
'''</Summary>
<ApiMember(DataType:="boolean", Description:="If you want to only select Extra license options", ParameterType:="query")>
Public Overridable Property IsExtraLicenseOption As Nullable(Of Boolean)
'''<Summary>
'''If you want to include the connected license items
'''</Summary>
<ApiMember(DataType:="boolean", Description:="If you want to include the connected license items", ParameterType:="query")>
Public Overridable Property IncludeLicenseItems As Boolean
'''<Summary>
'''If you want to include the connected licens prices
'''</Summary>
<ApiMember(DataType:="boolean", Description:="If you want to include the connected licens prices", ParameterType:="query")>
Public Overridable Property IncludeLicensePrices As Boolean
Public Overridable Property ResponseStatus As ResponseStatus
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 SuperAdminCompanyLicenseQuery DTOs
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 /superadmin/licenses/company HTTP/1.1 Host: api.bokamera.se Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Offset":0,"Total":0,"Results":[{"Id":0,"TypeId":0,"Type":{"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"}]},"MetaData":"String","Active":false,"Canceled":false}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}