BokaMera.API.Host

AdminIncentiveActionQuery

**Requires Authentication**
Requires the role:	superadmin

The following routes are available for this service:
GET	/superadmin/incentives/action	Query incentive actions

import 'package:servicestack/servicestack.dart';

// @DataContract
abstract class QueryBase
{
    /**
    * 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>
    */
    // @DataMember(Order=1)
    int? Skip;

    /**
    * 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>
    */
    // @DataMember(Order=2)
    int? Take;

    /**
    * 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>
    */
    // @DataMember(Order=3)
    String? OrderBy;

    /**
    * 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>
    */
    // @DataMember(Order=4)
    String? OrderByDesc;

    /**
    * 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>
    */
    // @DataMember(Order=5)
    String? Include;

    // @DataMember(Order=6)
    String? Fields;

    // @DataMember(Order=7)
    Map<String,String?>? Meta;

    QueryBase({this.Skip,this.Take,this.OrderBy,this.OrderByDesc,this.Include,this.Fields,this.Meta});
    QueryBase.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Skip = json['Skip'];
        Take = json['Take'];
        OrderBy = json['OrderBy'];
        OrderByDesc = json['OrderByDesc'];
        Include = json['Include'];
        Fields = json['Fields'];
        Meta = JsonConverters.toStringMap(json['Meta']);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Skip': Skip,
        'Take': Take,
        'OrderBy': OrderBy,
        'OrderByDesc': OrderByDesc,
        'Include': Include,
        'Fields': Fields,
        'Meta': Meta
    };

    getTypeName() => "QueryBase";
    TypeContext? context = _ctx;
}

abstract class QueryDb2<From,Into> extends QueryBase
{
    QueryDb2();
    QueryDb2.fromJson(Map<String, dynamic> json) : super.fromJson(json);
    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson();
    getTypeName() => "QueryDb<$From,$Into>";
    TypeContext? context = _ctx;
}

class BaseModel implements IConvertible
{
    BaseModel();
    BaseModel.fromJson(Map<String, dynamic> json) : super();
    fromMap(Map<String, dynamic> json) {
        return this;
    }

    Map<String, dynamic> toJson() => {};
    getTypeName() => "BaseModel";
    TypeContext? context = _ctx;
}

enum IncentiveActionType
{
    Upgrade,
    AddOn,
    Information,
}

class IncentiveAction extends BaseModel implements IConvertible
{
    int? Id;
    String? Description;
    IncentiveActionType? ActionType;
    String? Page;
    String? Segment;
    String? Element;
    int? LicenseTypeId;

    IncentiveAction({this.Id,this.Description,this.ActionType,this.Page,this.Segment,this.Element,this.LicenseTypeId});
    IncentiveAction.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        Id = json['Id'];
        Description = json['Description'];
        ActionType = JsonConverters.fromJson(json['ActionType'],'IncentiveActionType',context!);
        Page = json['Page'];
        Segment = json['Segment'];
        Element = json['Element'];
        LicenseTypeId = json['LicenseTypeId'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'Id': Id,
        'Description': Description,
        'ActionType': JsonConverters.toJson(ActionType,'IncentiveActionType',context!),
        'Page': Page,
        'Segment': Segment,
        'Element': Element,
        'LicenseTypeId': LicenseTypeId
    });

    getTypeName() => "IncentiveAction";
    TypeContext? context = _ctx;
}

// @ValidateRequest(Validator="IsAuthenticated")
// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
class AdminIncentiveActionQuery extends QueryDb2<IncentiveAction,QueryResponse<IncentiveActionResponse>> implements IConvertible
{
    int? Id;
    String? CountryId;

    AdminIncentiveActionQuery({this.Id,this.CountryId});
    AdminIncentiveActionQuery.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        Id = json['Id'];
        CountryId = json['CountryId'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'Id': Id,
        'CountryId': CountryId
    });

    getTypeName() => "AdminIncentiveActionQuery";
    TypeContext? context = _ctx;
}

class AccessKeyTypeResponse implements IConvertible
{
    int? Id;
    String? KeyType;
    String? Description;

    AccessKeyTypeResponse({this.Id,this.KeyType,this.Description});
    AccessKeyTypeResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Id = json['Id'];
        KeyType = json['KeyType'];
        Description = json['Description'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Id': Id,
        'KeyType': KeyType,
        'Description': Description
    };

    getTypeName() => "AccessKeyTypeResponse";
    TypeContext? context = _ctx;
}

// @DataContract
class QueryResponse<AccessKeyTypeResponse> implements IConvertible
{
    // @DataMember(Order=1)
    int? Offset;

    // @DataMember(Order=2)
    int? Total;

    // @DataMember(Order=3)
    List<AccessKeyTypeResponse>? Results;

    // @DataMember(Order=4)
    Map<String,String?>? Meta;

    // @DataMember(Order=5)
    ResponseStatus? ResponseStatus;

    QueryResponse({this.Offset,this.Total,this.Results,this.Meta,this.ResponseStatus});
    QueryResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Offset = json['Offset'];
        Total = json['Total'];
        Results = JsonConverters.fromJson(json['Results'],'List<${runtimeGenericTypeDefs(this,[0]).join(",")}>',context!);
        Meta = JsonConverters.toStringMap(json['Meta']);
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Offset': Offset,
        'Total': Total,
        'Results': JsonConverters.toJson(Results,'List<AccessKeyTypeResponse>',context!),
        'Meta': Meta,
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "QueryResponse<$AccessKeyTypeResponse>";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'testapi.bokamera.se', types: <String, TypeInfo> {
    'BaseModel': TypeInfo(TypeOf.Class, create:() => BaseModel()),
    'IncentiveActionType': TypeInfo(TypeOf.Enum, enumValues:IncentiveActionType.values),
    'IncentiveAction': TypeInfo(TypeOf.Class, create:() => IncentiveAction()),
    'AdminIncentiveActionQuery': TypeInfo(TypeOf.Class, create:() => AdminIncentiveActionQuery()),
    'List<QueryResponse<IncentiveActionResponse>>': TypeInfo(TypeOf.Class, create:() => <QueryResponse<IncentiveActionResponse>>[]),
    'AccessKeyTypeResponse': TypeInfo(TypeOf.Class, create:() => AccessKeyTypeResponse()),
    'QueryResponse<AccessKeyTypeResponse>': TypeInfo(TypeOf.Class, create:() => QueryResponse<AccessKeyTypeResponse>()),
});

Dart 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>
              <d4p1:LicensePriceResponse>
                <d4p1:Country xmlns:d9p1="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Db">
                  <d9p1:Culture>String</d9p1:Culture>
                  <d9p1:CurrencyId>String</d9p1:CurrencyId>
                  <d9p1:CurrencyInfo>
                    <d9p1:Active>false</d9p1:Active>
                    <d9p1:CurrencySign>String</d9p1:CurrencySign>
                    <d9p1:Id>String</d9p1:Id>
                    <d9p1:ModifiedDate xmlns:d11p1="http://schemas.datacontract.org/2004/07/System">
                      <d11p1:DateTime>0001-01-01T00:00:00Z</d11p1:DateTime>
                      <d11p1:OffsetMinutes>0</d11p1:OffsetMinutes>
                    </d9p1:ModifiedDate>
                    <d9p1:Name>String</d9p1:Name>
                  </d9p1:CurrencyInfo>
                  <d9p1:Id>String</d9p1:Id>
                  <d9p1:ModifiedDate xmlns:d10p1="http://schemas.datacontract.org/2004/07/System">
                    <d10p1:DateTime>0001-01-01T00:00:00Z</d10p1:DateTime>
                    <d10p1:OffsetMinutes>0</d10p1:OffsetMinutes>
                  </d9p1:ModifiedDate>
                  <d9p1:Name>String</d9p1:Name>
                  <d9p1:TimeZone>String</d9p1:TimeZone>
                </d4p1:Country>
                <d4p1:CountryId>String</d4p1:CountryId>
                <d4p1:LicensePlanId>0</d4p1:LicensePlanId>
                <d4p1:LicenseTypeId>0</d4p1:LicenseTypeId>
                <d4p1:Price>0</d4p1:Price>
              </d4p1:LicensePriceResponse>
            </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>