| Requires the role: | superadmin |
| GET | /superadmin/incentives/action | Query incentive actions |
|---|
namespace BokaMera.API.ServiceModel.Db
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type BaseModel() =
class end
type IncentiveActionType =
| Upgrade = 1
| AddOn = 2
| Information = 3
[<AllowNullLiteral>]
type IncentiveAction() =
inherit BaseModel()
member val Id:Int32 = new Int32() with get,set
member val Description:String = null with get,set
member val ActionType:IncentiveActionType = new IncentiveActionType() with get,set
member val Page:String = null with get,set
member val Segment:String = null with get,set
member val Element:String = null with get,set
member val LicenseTypeId:Nullable<Int32> = new Nullable<Int32>() with get,set
[<ValidateRequest(Validator="IsAuthenticated")>]
[<ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)>]
[<AllowNullLiteral>]
type AdminIncentiveActionQuery() =
inherit QueryDb<IncentiveAction, QueryResponse<IncentiveActionResponse>>()
member val Id:Nullable<Int32> = new Nullable<Int32>() with get,set
member val CountryId:String = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type QueryBase() =
///<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)>]
member val Skip:Nullable<Int32> = new Nullable<Int32>() with get,set
///<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)>]
member val Take:Nullable<Int32> = new Nullable<Int32>() with get,set
///<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)>]
member val OrderBy:String = null with get,set
///<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)>]
member val OrderByDesc:String = null with get,set
///<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)>]
member val Include:String = null with get,set
[<DataMember(Order=6)>]
member val Fields:String = null with get,set
[<DataMember(Order=7)>]
member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set
[<AllowNullLiteral>]
type QueryDb<From, Into>() =
inherit QueryBase()
[<AllowNullLiteral>]
type AccessKeyTypeResponse() =
member val Id:Int32 = new Int32() with get,set
member val KeyType:String = null with get,set
member val Description:String = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type QueryResponse<AccessKeyTypeResponse>() =
[<DataMember(Order=1)>]
member val Offset:Int32 = new Int32() with get,set
[<DataMember(Order=2)>]
member val Total:Int32 = new Int32() with get,set
[<DataMember(Order=3)>]
member val Results:ResizeArray<AccessKeyTypeResponse> = new ResizeArray<AccessKeyTypeResponse>() with get,set
[<DataMember(Order=4)>]
member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set
[<DataMember(Order=5)>]
member val ResponseStatus:ResponseStatus = null with get,set
F# AdminIncentiveActionQuery DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>