| Requires the role: | superadmin |
| GET | /superadmin/incentives/ | Query incentives |
|---|
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BokaMera.API.ServiceModel.Dtos
Imports BokaMera.API.ServiceModel.Db.Incentive
Imports BokaMera.API.ServiceModel.Db
Namespace Global
Namespace BokaMera.API.ServiceModel.Db
Public Partial Class BaseModel
End Class
End Namespace
Namespace BokaMera.API.ServiceModel.Db.Incentive
Public Enum CriteriaType
LicenseAvailability
SmsActivation
eAccountingActivation
CodeLockActivation
SocialActivation
OnlinePaymentActivation
FollowUpMessageActivation
RatingActivation
End Enum
Public Partial Class Incentive
Inherits BaseModel
Public Sub New()
Companies = New List(Of IncentiveCompanyRelation)
Criteria = New List(Of IncentiveCriteria)
End Sub
Public Overridable Property Id As Integer
Public Overridable Property Heading As String
Public Overridable Property StorageUrl As String
Public Overridable Property SuccessButtonText As String
Public Overridable Property Active As Boolean
Public Overridable Property ActionId As Integer
Public Overridable Property Frequency As IncentiveRecurrenceFrequency
Public Overridable Property RecurrenceInterval As UInt32
Public Overridable Property InitialDelayInSeconds As Integer
Public Overridable Property MaxDisplayCount As Nullable(Of Integer)
Public Overridable Property ValidFrom As DateTimeOffset
Public Overridable Property ValidTo As DateTimeOffset
Public Overridable Property CreatedDate As DateTimeOffset
Public Overridable Property ModifiedDate As Nullable(Of DateTimeOffset)
Public Overridable Property AppliesToAllCompanies As Boolean
Public Overridable Property Payload As String
Public Overridable Property Companies As List(Of IncentiveCompanyRelation)
Public Overridable Property Criteria As List(Of IncentiveCriteria)
<Ignore>
Public Overridable Property Action As IncentiveAction
End Class
Public Partial Class IncentiveAction
Inherits BaseModel
Public Overridable Property Id As Integer
Public Overridable Property ActionType As IncentiveActionType
Public Overridable Property Page As String
Public Overridable Property Segment As String
Public Overridable Property Element As String
Public Overridable Property LicenseTypeId As Nullable(Of Integer)
End Class
Public Enum IncentiveActionType
Upgrade = 1
AddOn = 2
Information = 3
End Enum
Public Partial Class IncentiveCompanyRelation
Inherits BaseModel
Public Overridable Property Id As Long
Public Overridable Property CompanyId As Guid
Public Overridable Property IncentiveId As Integer
Public Overridable Property CreatedDate As DateTimeOffset
End Class
Public Partial Class IncentiveCriteria
Inherits BaseModel
Public Overridable Property Id As Integer
Public Overridable Property IncentiveId As Integer
Public Overridable Property CriteriaType As CriteriaType
Public Overridable Property Value As String
Public Overridable Property InvertCondition As Boolean
Public Overridable Property CreatedDate As DateTimeOffset
End Class
Public Enum IncentiveRecurrenceFrequency
OneTime = 1
Weekly = 2
Monthly = 3
End Enum
End Namespace
Namespace BokaMera.API.ServiceModel.Dtos
Public Partial Class AccessKeyTypeResponse
Public Overridable Property Id As Integer
Public Overridable Property KeyType As String
Public Overridable Property Description As String
End Class
<ValidateRequest(Validator:="IsAuthenticated")>
<ApiResponse(Description:="You were unauthorized to call this service", StatusCode:=401)>
Public Partial Class AdminIncentivesQuery
Inherits QueryDb(Of Incentive, QueryResponse(Of AdminIncentiveQueryResponse))
Public Overridable Property Id As Nullable(Of Integer)
Public Overridable Property CompanyId As Nullable(Of Guid)
Public Overridable Property ValidFrom As Nullable(Of Date)
Public Overridable Property ValidTo As Nullable(Of Date)
Public Overridable Property ActionId As Nullable(Of Integer)
Public Overridable Property Active As Nullable(Of Boolean)
Public Overridable Property IncludeCriteria As Boolean
Public Overridable Property IncludeCompanies As Boolean
Public Overridable Property IncludeAction As Boolean
End Class
End Namespace
Namespace ServiceStack
<DataContract>
Public Partial Class QueryBase
Public Sub New()
Meta = New Dictionary(Of String, String)
End Sub
'''<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)>
Public Overridable Property Skip As Nullable(Of Integer)
'''<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)>
Public Overridable Property Take As Nullable(Of Integer)
'''<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)>
Public Overridable Property OrderBy As String
'''<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)>
Public Overridable Property OrderByDesc As String
'''<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)>
Public Overridable Property Include As String
<DataMember(Order:=6)>
Public Overridable Property Fields As String
<DataMember(Order:=7)>
Public Overridable Property Meta As Dictionary(Of String, String)
End Class
Public Partial Class QueryDb(Of From, Into)
Inherits QueryBase
End Class
<DataContract>
Public Partial Class QueryResponse(Of AccessKeyTypeResponse)
Public Sub New()
Results = New List(Of AccessKeyTypeResponse)
Meta = New Dictionary(Of String, String)
End Sub
<DataMember(Order:=1)>
Public Overridable Property Offset As Integer
<DataMember(Order:=2)>
Public Overridable Property Total As Integer
<DataMember(Order:=3)>
Public Overridable Property Results As List(Of AccessKeyTypeResponse)
<DataMember(Order:=4)>
Public Overridable Property Meta As Dictionary(Of String, String)
<DataMember(Order:=5)>
Public Overridable Property ResponseStatus As ResponseStatus
End Class
End Namespace
End Namespace
VB.NET AdminIncentivesQuery DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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
}
}
}