| Requires the role: | superadmin |
| GET | /superadmin/incentives/ | Query incentives |
|---|
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 IncentiveRecurrenceFrequency =
| OneTime = 1
| Weekly = 2
| Monthly = 3
[<AllowNullLiteral>]
type IncentiveCompanyRelation() =
inherit BaseModel()
member val Id:Int64 = new Int64() with get,set
member val CompanyId:Guid = new Guid() with get,set
member val IncentiveId:Int32 = new Int32() with get,set
member val CreatedDate:DateTimeOffset = new DateTimeOffset() with get,set
type CriteriaType =
| LicenseAvailability = 0
| SmsActivation = 1
| eAccountingActivation = 2
| CodeLockActivation = 3
| SocialActivation = 4
| OnlinePaymentActivation = 5
| FollowUpMessageActivation = 6
| RatingActivation = 7
[<AllowNullLiteral>]
type IncentiveCriteria() =
inherit BaseModel()
member val Id:Int32 = new Int32() with get,set
member val IncentiveId:Int32 = new Int32() with get,set
member val CriteriaType:CriteriaType = new CriteriaType() with get,set
member val Value:String = null with get,set
member val InvertCondition:Boolean = new Boolean() with get,set
member val CreatedDate:DateTimeOffset = new DateTimeOffset() with get,set
type IncentiveActionType =
| Upgrade = 1
| AddOn = 2
| Information = 3
[<AllowNullLiteral>]
type IncentiveAction() =
inherit BaseModel()
member val Id:Int32 = new Int32() 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
[<AllowNullLiteral>]
type Incentive() =
inherit BaseModel()
member val Id:Int32 = new Int32() with get,set
member val Heading:String = null with get,set
member val StorageUrl:String = null with get,set
member val SuccessButtonText:String = null with get,set
member val Active:Boolean = new Boolean() with get,set
member val ActionId:Int32 = new Int32() with get,set
member val Frequency:IncentiveRecurrenceFrequency = new IncentiveRecurrenceFrequency() with get,set
member val RecurrenceInterval:UInt32 = new UInt32() with get,set
member val InitialDelayInSeconds:Int32 = new Int32() with get,set
member val MaxDisplayCount:Nullable<Int32> = new Nullable<Int32>() with get,set
member val ValidFrom:DateTimeOffset = new DateTimeOffset() with get,set
member val ValidTo:DateTimeOffset = new DateTimeOffset() with get,set
member val CreatedDate:DateTimeOffset = new DateTimeOffset() with get,set
member val ModifiedDate:Nullable<DateTimeOffset> = new Nullable<DateTimeOffset>() with get,set
member val AppliesToAllCompanies:Boolean = new Boolean() with get,set
member val Payload:String = null with get,set
member val Companies:ResizeArray<IncentiveCompanyRelation> = new ResizeArray<IncentiveCompanyRelation>() with get,set
member val Criteria:ResizeArray<IncentiveCriteria> = new ResizeArray<IncentiveCriteria>() with get,set
[<Ignore>]
member val Action:IncentiveAction = null with get,set
[<ValidateRequest(Validator="IsAuthenticated")>]
[<ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)>]
[<AllowNullLiteral>]
type AdminIncentivesQuery() =
inherit QueryDb<Incentive, QueryResponse<AdminIncentiveQueryResponse>>()
member val Id:Nullable<Int32> = new Nullable<Int32>() with get,set
member val CompanyId:Nullable<Guid> = new Nullable<Guid>() with get,set
member val ValidFrom:Nullable<Date> = new Nullable<Date>() with get,set
member val ValidTo:Nullable<Date> = new Nullable<Date>() with get,set
member val ActionId:Nullable<Int32> = new Nullable<Int32>() with get,set
member val Active:Nullable<Boolean> = new Nullable<Boolean>() with get,set
member val IncludeCriteria:Boolean = new Boolean() with get,set
member val IncludeCompanies:Boolean = new Boolean() with get,set
member val IncludeAction:Boolean = new Boolean() 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
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /superadmin/incentives/ HTTP/1.1 Host: testapi.bokamera.se Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"Offset":0,"Total":0,"Results":[{"Offset":0,"Total":0,"Results":[{"Frequency":"OneTime","RecurrenceInterval":0,"CreatedDate":"0001-01-01T00:00:00.0000000+00:00","ModifiedDate":"0001-01-01T00:00:00.0000000+00:00","CompanyIds":["00000000-0000-0000-0000-000000000000"],"Criteria":[{"Id":0,"IncentiveId":0,"CriteriaType":"LicenseAvailability","Value":"String","InvertCondition":false,"CreatedDate":"0001-01-01T00:00:00.0000000+00:00"}],"ApplyToAllCompanies":false,"Id":0,"Heading":"String","StorageUrl":"String","SuccessButtonText":"String","ActionId":0,"InitialDelayInSeconds":0,"MaxDisplayCount":0,"ValidFrom":"0001-01-01T00:00:00.0000000+00:00","ValidTo":"0001-01-01T00:00:00.0000000+00:00","Action":{"Id":0,"ActionType":"Upgrade","Page":"String","Segment":"String","Element":"String","LicenseTypeId":0,"SuggestedLicenseToUpgrade":{"Id":0,"Name":"String","Description":"String","IsExtraLicenseOption":false,"PeriodOfNoticeDays":0,"Items":[{"Id":0,"Name":"String","AllowedItems":0}],"Prices":[{"LicenseTypeId":0,"CountryId":"String","Price":0,"Country":{"CurrencyId":"String","CurrencyInfo":{"Name":"String","CurrencySign":"String","Active":false,"ModifiedDate":"0001-01-01T00:00:00.0000000+00:00","Id":"String"},"Name":"String","Culture":"String","TimeZone":"String","ModifiedDate":"0001-01-01T00:00:00.0000000+00:00","Id":"String"},"LicensePlanId":0}]}},"Payload":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}