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
import Foundation
import ServiceStack

// @ValidateRequest(Validator="IsAuthenticated")
// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
public class AdminIncentiveActionQuery : QueryDb2<IncentiveAction, QueryResponse<IncentiveActionResponse>>
{
    public var id:Int?
    public var countryId:String

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

    private enum CodingKeys : String, CodingKey {
        case id
        case countryId
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        id = try container.decodeIfPresent(Int.self, forKey: .id)
        countryId = try container.decodeIfPresent(String.self, forKey: .countryId)
    }

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

public class IncentiveAction : BaseModel
{
    public var id:Int
    public var Description:String
    public var actionType:IncentiveActionType
    public var page:String
    public var segment:String
    public var element:String
    public var licenseTypeId:Int?

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

    private enum CodingKeys : String, CodingKey {
        case id
        case Description
        case actionType
        case page
        case segment
        case element
        case licenseTypeId
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        id = try container.decodeIfPresent(Int.self, forKey: .id)
        Description = try container.decodeIfPresent(String.self, forKey: .Description)
        actionType = try container.decodeIfPresent(IncentiveActionType.self, forKey: .actionType)
        page = try container.decodeIfPresent(String.self, forKey: .page)
        segment = try container.decodeIfPresent(String.self, forKey: .segment)
        element = try container.decodeIfPresent(String.self, forKey: .element)
        licenseTypeId = try container.decodeIfPresent(Int.self, forKey: .licenseTypeId)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if id != nil { try container.encode(id, forKey: .id) }
        if Description != nil { try container.encode(Description, forKey: .Description) }
        if actionType != nil { try container.encode(actionType, forKey: .actionType) }
        if page != nil { try container.encode(page, forKey: .page) }
        if segment != nil { try container.encode(segment, forKey: .segment) }
        if element != nil { try container.encode(element, forKey: .element) }
        if licenseTypeId != nil { try container.encode(licenseTypeId, forKey: .licenseTypeId) }
    }
}

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

public enum IncentiveActionType : Int, Codable
{
    case Upgrade = 1
    case AddOn = 2
    case Information = 3
}

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

    required public init(){}
}

Swift 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>