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 java.math.*;
import java.util.*;
import net.servicestack.client.*;
import com.google.gson.annotations.*;
import com.google.gson.reflect.*;

public class dtos
{

    @ValidateRequest(Validator="IsAuthenticated")
    @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
    public static class AdminIncentiveActionQuery extends QueryDb<IncentiveAction, QueryResponse<IncentiveActionResponse>>
    {
        public Integer Id = null;
        public String CountryId = null;
        
        public Integer getId() { return Id; }
        public AdminIncentiveActionQuery setId(Integer value) { this.Id = value; return this; }
        public String getCountryId() { return CountryId; }
        public AdminIncentiveActionQuery setCountryId(String value) { this.CountryId = value; return this; }
    }

    public static class QueryDb<From, Into> extends QueryBase
    {
        
    }

    @DataContract
    public static 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)
        public Integer Skip = null;

        /**
        * 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)
        public Integer Take = null;

        /**
        * 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)
        public String OrderBy = null;

        /**
        * 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)
        public String OrderByDesc = null;

        /**
        * 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)
        public String Include = null;

        @DataMember(Order=6)
        public String Fields = null;

        @DataMember(Order=7)
        public HashMap<String,String> Meta = null;
        
        public Integer getSkip() { return Skip; }
        public QueryBase setSkip(Integer value) { this.Skip = value; return this; }
        public Integer getTake() { return Take; }
        public QueryBase setTake(Integer value) { this.Take = value; return this; }
        public String getOrderBy() { return OrderBy; }
        public QueryBase setOrderBy(String value) { this.OrderBy = value; return this; }
        public String getOrderByDesc() { return OrderByDesc; }
        public QueryBase setOrderByDesc(String value) { this.OrderByDesc = value; return this; }
        public String getInclude() { return Include; }
        public QueryBase setInclude(String value) { this.Include = value; return this; }
        public String getFields() { return Fields; }
        public QueryBase setFields(String value) { this.Fields = value; return this; }
        public HashMap<String,String> getMeta() { return Meta; }
        public QueryBase setMeta(HashMap<String,String> value) { this.Meta = value; return this; }
    }

    public static class IncentiveAction extends BaseModel
    {
        public Integer Id = null;
        public String Description = null;
        public IncentiveActionType ActionType = null;
        public String Page = null;
        public String Segment = null;
        public String Element = null;
        public Integer LicenseTypeId = null;
        
        public Integer getId() { return Id; }
        public IncentiveAction setId(Integer value) { this.Id = value; return this; }
        public String getDescription() { return Description; }
        public IncentiveAction setDescription(String value) { this.Description = value; return this; }
        public IncentiveActionType getActionType() { return ActionType; }
        public IncentiveAction setActionType(IncentiveActionType value) { this.ActionType = value; return this; }
        public String getPage() { return Page; }
        public IncentiveAction setPage(String value) { this.Page = value; return this; }
        public String getSegment() { return Segment; }
        public IncentiveAction setSegment(String value) { this.Segment = value; return this; }
        public String getElement() { return Element; }
        public IncentiveAction setElement(String value) { this.Element = value; return this; }
        public Integer getLicenseTypeId() { return LicenseTypeId; }
        public IncentiveAction setLicenseTypeId(Integer value) { this.LicenseTypeId = value; return this; }
    }

    public static class BaseModel
    {
        
    }

    public static enum IncentiveActionType
    {
        Upgrade(1),
        AddOn(2),
        Information(3);

        private final int value;
        IncentiveActionType(final int intValue) { value = intValue; }
        public int getValue() { return value; }
    }

    @DataContract
    public static class QueryResponse<AccessKeyTypeResponse>
    {
        @DataMember(Order=1)
        public Integer Offset = null;

        @DataMember(Order=2)
        public Integer Total = null;

        @DataMember(Order=3)
        public ArrayList<AccessKeyTypeResponse> Results = null;

        @DataMember(Order=4)
        public HashMap<String,String> Meta = null;

        @DataMember(Order=5)
        public ResponseStatus ResponseStatus = null;
        
        public Integer getOffset() { return Offset; }
        public QueryResponse<AccessKeyTypeResponse> setOffset(Integer value) { this.Offset = value; return this; }
        public Integer getTotal() { return Total; }
        public QueryResponse<AccessKeyTypeResponse> setTotal(Integer value) { this.Total = value; return this; }
        public ArrayList<AccessKeyTypeResponse> getResults() { return Results; }
        public QueryResponse<AccessKeyTypeResponse> setResults(ArrayList<AccessKeyTypeResponse> value) { this.Results = value; return this; }
        public HashMap<String,String> getMeta() { return Meta; }
        public QueryResponse<AccessKeyTypeResponse> setMeta(HashMap<String,String> value) { this.Meta = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public QueryResponse<AccessKeyTypeResponse> setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

    public static class AccessKeyTypeResponse
    {
        public Integer Id = null;
        public String KeyType = null;
        public String Description = null;
        
        public Integer getId() { return Id; }
        public AccessKeyTypeResponse setId(Integer value) { this.Id = value; return this; }
        public String getKeyType() { return KeyType; }
        public AccessKeyTypeResponse setKeyType(String value) { this.KeyType = value; return this; }
        public String getDescription() { return Description; }
        public AccessKeyTypeResponse setDescription(String value) { this.Description = value; return this; }
    }

}

Java 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: api.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>