| Requires the role: | superadmin |
| POST | /superadmin/incentives | Add a new incentive |
|---|
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
Public Partial Class Country
Inherits BaseModel
<References(GetType(Currency))>
Public Overridable Property CurrencyId As String
Public Overridable Property CurrencyInfo As Currency
<Required>
Public Overridable Property Name As String
Public Overridable Property Culture As String
Public Overridable Property TimeZone As String
Public Overridable Property ModifiedDate As Nullable(Of DateTimeOffset)
<Required>
Public Overridable Property Id As String
End Class
Public Partial Class Currency
Inherits BaseModel
<Required>
Public Overridable Property Name As String
<Required>
Public Overridable Property CurrencySign As String
<Required>
Public Overridable Property Active As Boolean
Public Overridable Property ModifiedDate As Nullable(Of DateTimeOffset)
<Required>
Public Overridable Property Id As String
End Class
End Namespace
Namespace BokaMera.API.ServiceModel.Db.Incentive
Public Enum CriteriaType
LicenseAvailability
SmsActivation
eAccountingActivation
CodeLockActivation
SocialActivation
OnlinePaymentActivation
FollowUpMessageActivation
RatingActivation
End Enum
Public Enum IncentiveActionType
Upgrade = 1
AddOn = 2
Information = 3
End Enum
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 AdminIncentiveQueryResponse
Inherits CompanyIncentiveResponse
Public Sub New()
CompanyIds = New List(Of Guid)
Criteria = New List(Of IncentiveCriteria)
End Sub
Public Overridable Property Frequency As IncentiveRecurrenceFrequency
Public Overridable Property RecurrenceInterval As UInt32
Public Overridable Property CreatedDate As DateTimeOffset
Public Overridable Property ModifiedDate As DateTimeOffset
Public Overridable Property CompanyIds As List(Of Guid)
Public Overridable Property Criteria As List(Of IncentiveCriteria)
Public Overridable Property ApplyToAllCompanies As Boolean
End Class
Public Partial Class CompanyIncentiveResponse
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 ActionId As Integer
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 Action As IncentiveActionResponse
Public Overridable Property Payload As String
End Class
<ValidateRequest(Validator:="IsAuthenticated")>
<ApiResponse(Description:="You were unauthorized to call this service", StatusCode:=401)>
Public Partial Class CreateIncentive
Public Sub New()
CompanyIds = New List(Of Guid)
Criteria = New List(Of IncentiveCriteriaDto)
End Sub
<ApiMember(IsRequired:=true)>
Public Overridable Property Heading As String
<ApiMember>
Public Overridable Property StorageUrl As String
<ApiMember>
Public Overridable Property Body As String
<ApiMember(IsRequired:=true)>
Public Overridable Property SuccessButtonText As String
<ApiMember(IsRequired:=true)>
Public Overridable Property ActionId As Integer
<ApiMember(IsRequired:=true)>
Public Overridable Property Frequency As IncentiveRecurrenceFrequency
<ApiMember>
Public Overridable Property RecurrenceInterval As UInt32
<ApiMember(IsRequired:=true)>
Public Overridable Property InitialDelayInSeconds As Integer
<ApiMember(IsRequired:=true)>
Public Overridable Property MaxDisplayCount As Nullable(Of Integer)
<ApiMember(IsRequired:=true)>
Public Overridable Property ValidFrom As DateTimeOffset
<ApiMember(IsRequired:=true)>
Public Overridable Property ValidTo As DateTimeOffset
<ApiMember>
Public Overridable Property Active As Boolean
<ApiMember>
Public Overridable Property Payload As String
Public Overridable Property CompanyIds As List(Of Guid)
Public Overridable Property Criteria As List(Of IncentiveCriteriaDto)
End Class
Public Partial Class IncentiveActionResponse
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)
Public Overridable Property SuggestedLicenseToUpgrade As LicenseTypeQueryResponse
End Class
Public Partial Class IncentiveCriteriaDto
Public Overridable Property CriteriaType As CriteriaType
Public Overridable Property Value As String
Public Overridable Property InvertCondition As Boolean
End Class
Public Partial Class LicenseItemsResponse
Public Overridable Property Id As Integer
Public Overridable Property Name As String
Public Overridable Property AllowedItems As Integer
End Class
Public Partial Class LicensePriceResponse
Public Overridable Property LicenseTypeId As Integer
Public Overridable Property CountryId As String
Public Overridable Property Price As Integer
Public Overridable Property Country As Country
Public Overridable Property LicensePlanId As Integer
End Class
Public Partial Class LicenseTypeQueryResponse
Public Sub New()
Items = New List(Of LicenseItemsResponse)
Prices = New List(Of LicensePriceResponse)
End Sub
'''<Summary>
'''The license type id
'''</Summary>
<ApiMember(Description:="The license type id")>
Public Overridable Property Id As Integer
'''<Summary>
'''The license type name
'''</Summary>
<ApiMember(Description:="The license type name")>
Public Overridable Property Name As String
'''<Summary>
'''The license type description
'''</Summary>
<ApiMember(Description:="The license type description")>
Public Overridable Property Description As String
'''<Summary>
'''If the license type is not a standard license but instead an extra license option. An example would be sending new letter license.
'''</Summary>
<ApiMember(Description:="If the license type is not a standard license but instead an extra license option. An example would be sending new letter license.")>
Public Overridable Property IsExtraLicenseOption As Boolean
'''<Summary>
'''The period of notice for the license in days.
'''</Summary>
<ApiMember(Description:="The period of notice for the license in days.")>
Public Overridable Property PeriodOfNoticeDays As Integer
'''<Summary>
'''The license items for the license type
'''</Summary>
<ApiMember(Description:="The license items for the license type")>
Public Overridable Property Items As List(Of LicenseItemsResponse)
'''<Summary>
'''The license prices in each country for the license type
'''</Summary>
<ApiMember(Description:="The license prices in each country for the license type")>
Public Overridable Property Prices As List(Of LicensePriceResponse)
End Class
End Namespace
End Namespace
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.
POST /superadmin/incentives HTTP/1.1
Host: testapi.bokamera.se
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"Heading":"String","StorageUrl":"String","Body":"String","SuccessButtonText":"String","ActionId":0,"Frequency":"OneTime","RecurrenceInterval":0,"InitialDelayInSeconds":0,"MaxDisplayCount":0,"ValidFrom":"0001-01-01T00:00:00.0000000+00:00","ValidTo":"0001-01-01T00:00:00.0000000+00:00","Active":false,"Payload":"String","CompanyIds":["00000000-0000-0000-0000-000000000000"],"Criteria":[{"CriteriaType":"LicenseAvailability","Value":"String","InvertCondition":false}]}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"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"}