BokaMera.API.Host

<back to all web services

AdminIncentiveActionQuery

Requires Authentication
Requires the role:superadmin
The following routes are available for this service:
GET/superadmin/incentives/actionQuery incentive actions
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.Incentive
Imports BokaMera.API.ServiceModel.Db

Namespace Global

    Namespace BokaMera.API.ServiceModel.Db

        Public Partial Class BaseModel
        End Class
    End Namespace

    Namespace BokaMera.API.ServiceModel.Db.Incentive

        Public Partial Class IncentiveAction
            Inherits BaseModel
            Public Overridable Property Id As Integer
            Public Overridable Property Description As String
            Public Overridable Property ActionType As IncentiveActionType
            Public Overridable Property Page As String
            Public Overridable Property Segment As String
            Public Overridable Property Element As String
            Public Overridable Property LicenseTypeId As Nullable(Of Integer)
        End Class

        Public Enum IncentiveActionType
            Upgrade = 1
            AddOn = 2
            Information = 3
        End Enum
    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

        <ValidateRequest(Validator:="IsAuthenticated")>
        <ApiResponse(Description:="You were unauthorized to call this service", StatusCode:=401)>
        Public Partial Class AdminIncentiveActionQuery
            Inherits QueryDb(Of IncentiveAction, QueryResponse(Of IncentiveActionResponse))
            Public Overridable Property Id As Nullable(Of Integer)
            Public Overridable Property CountryId As String
        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 AdminIncentiveActionQuery DTOs

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

HTTP + XML

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

GET /superadmin/incentives/action HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/xml

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

<QueryResponseOfQueryResponseOfIncentiveActionResponseWg5EthtI2Lm1MX14 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Offset>0</Offset>
  <Total>0</Total>
  <Results>
    <QueryResponseOfIncentiveActionResponseWg5EthtI>
      <Offset>0</Offset>
      <Total>0</Total>
      <Results xmlns:d4p1="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
        <d4p1:IncentiveActionResponse>
          <d4p1:ActionType>Upgrade</d4p1:ActionType>
          <d4p1:Description>String</d4p1:Description>
          <d4p1:Element>String</d4p1:Element>
          <d4p1:Id>0</d4p1:Id>
          <d4p1:LicenseTypeId>0</d4p1:LicenseTypeId>
          <d4p1:Page>String</d4p1:Page>
          <d4p1:Segment>String</d4p1:Segment>
          <d4p1:SuggestedLicenseToUpgrade>
            <d4p1:Description>String</d4p1:Description>
            <d4p1:Id>0</d4p1:Id>
            <d4p1:IsExtraLicenseOption>false</d4p1:IsExtraLicenseOption>
            <d4p1:Items>
              <d4p1:LicenseItemsResponse>
                <d4p1:AllowedItems>0</d4p1:AllowedItems>
                <d4p1:Id>0</d4p1:Id>
                <d4p1:Name>String</d4p1:Name>
              </d4p1:LicenseItemsResponse>
            </d4p1:Items>
            <d4p1:Name>String</d4p1:Name>
            <d4p1:PeriodOfNoticeDays>0</d4p1:PeriodOfNoticeDays>
            <d4p1:Prices xmlns:d7p1="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Db">
              <d7p1:LicensePrice>
                <d7p1:Country>
                  <d7p1:Culture>String</d7p1:Culture>
                  <d7p1:CurrencyId>String</d7p1:CurrencyId>
                  <d7p1:CurrencyInfo>
                    <d7p1:Active>false</d7p1:Active>
                    <d7p1:CurrencySign>String</d7p1:CurrencySign>
                    <d7p1:Id>String</d7p1:Id>
                    <d7p1:ModifiedDate xmlns:d11p1="http://schemas.datacontract.org/2004/07/System">
                      <d11p1:DateTime>0001-01-01T00:00:00Z</d11p1:DateTime>
                      <d11p1:OffsetMinutes>0</d11p1:OffsetMinutes>
                    </d7p1:ModifiedDate>
                    <d7p1:Name>String</d7p1:Name>
                  </d7p1:CurrencyInfo>
                  <d7p1:Id>String</d7p1:Id>
                  <d7p1:ModifiedDate xmlns:d10p1="http://schemas.datacontract.org/2004/07/System">
                    <d10p1:DateTime>0001-01-01T00:00:00Z</d10p1:DateTime>
                    <d10p1:OffsetMinutes>0</d10p1:OffsetMinutes>
                  </d7p1:ModifiedDate>
                  <d7p1:Name>String</d7p1:Name>
                  <d7p1:TimeZone>String</d7p1:TimeZone>
                </d7p1:Country>
                <d7p1:CountryId>String</d7p1:CountryId>
                <d7p1:LicenseTypeId>0</d7p1:LicenseTypeId>
                <d7p1:ModifiedDate xmlns:d9p1="http://schemas.datacontract.org/2004/07/System">
                  <d9p1:DateTime>0001-01-01T00:00:00Z</d9p1:DateTime>
                  <d9p1:OffsetMinutes>0</d9p1:OffsetMinutes>
                </d7p1:ModifiedDate>
                <d7p1:Price>0</d7p1:Price>
              </d7p1:LicensePrice>
            </d4p1:Prices>
          </d4p1:SuggestedLicenseToUpgrade>
        </d4p1:IncentiveActionResponse>
      </Results>
      <Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1: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:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:KeyValueOfstringstring>
                <d7p1:Key>String</d7p1:Key>
                <d7p1:Value>String</d7p1:Value>
              </d7p1:KeyValueOfstringstring>
            </Meta>
          </ResponseError>
        </Errors>
        <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>
      </ResponseStatus>
    </QueryResponseOfIncentiveActionResponseWg5EthtI>
  </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>
</QueryResponseOfQueryResponseOfIncentiveActionResponseWg5EthtI2Lm1MX14>