| Requires the role: | superadmin |
| POST | /superadmin/incentives/action | Add a new incentive action |
|---|
namespace BokaMera.API.ServiceModel.Db
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
type IncentiveActionType =
| Upgrade = 1
| AddOn = 2
| Information = 3
[<AllowNullLiteral>]
type LicenseItemsResponse() =
member val Id:Int32 = new Int32() with get,set
member val Name:String = null with get,set
member val AllowedItems:Int32 = new Int32() with get,set
[<AllowNullLiteral>]
type BaseModel() =
class end
[<AllowNullLiteral>]
type Currency() =
inherit BaseModel()
[<Required>]
member val Name:String = null with get,set
[<Required>]
member val CurrencySign:String = null with get,set
[<Required>]
member val Active:Boolean = new Boolean() with get,set
member val ModifiedDate:Nullable<DateTimeOffset> = new Nullable<DateTimeOffset>() with get,set
[<Required>]
member val Id:String = null with get,set
[<AllowNullLiteral>]
type Country() =
inherit BaseModel()
[<References(typeof<Currency>)>]
member val CurrencyId:String = null with get,set
member val CurrencyInfo:Currency = null with get,set
[<Required>]
member val Name:String = null with get,set
member val Culture:String = null with get,set
member val TimeZone:String = null with get,set
member val ModifiedDate:Nullable<DateTimeOffset> = new Nullable<DateTimeOffset>() with get,set
[<Required>]
member val Id:String = null with get,set
[<AllowNullLiteral>]
type LicensePrice() =
inherit BaseModel()
[<Ignore>]
member val Country:Country = null with get,set
[<Ignore>]
member val MonthlyPayment:Boolean = new Boolean() with get,set
[<Required>]
member val LicenseTypeId:Int32 = new Int32() with get,set
[<Required>]
member val CountryId:String = null with get,set
[<Required>]
member val Price:Int32 = new Int32() with get,set
member val ModifiedDate:Nullable<DateTimeOffset> = new Nullable<DateTimeOffset>() with get,set
[<AllowNullLiteral>]
type LicenseTypeQueryResponse() =
///<summary>
///The license type id
///</summary>
[<ApiMember(Description="The license type id")>]
member val Id:Int32 = new Int32() with get,set
///<summary>
///The license type name
///</summary>
[<ApiMember(Description="The license type name")>]
member val Name:String = null with get,set
///<summary>
///The license type description
///</summary>
[<ApiMember(Description="The license type description")>]
member val Description:String = null with get,set
///<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.")>]
member val IsExtraLicenseOption:Boolean = new Boolean() with get,set
///<summary>
///The period of notice for the license in days.
///</summary>
[<ApiMember(Description="The period of notice for the license in days.")>]
member val PeriodOfNoticeDays:Int32 = new Int32() with get,set
///<summary>
///The license items for the license type
///</summary>
[<ApiMember(Description="The license items for the license type")>]
member val Items:ResizeArray<LicenseItemsResponse> = new ResizeArray<LicenseItemsResponse>() with get,set
///<summary>
///The license prices in each country for the license type
///</summary>
[<ApiMember(Description="The license prices in each country for the license type")>]
member val Prices:ResizeArray<LicensePrice> = new ResizeArray<LicensePrice>() with get,set
[<AllowNullLiteral>]
type IncentiveActionResponse() =
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
member val SuggestedLicenseToUpgrade:LicenseTypeQueryResponse = null with get,set
[<ValidateRequest(Validator="IsAuthenticated")>]
[<ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)>]
[<AllowNullLiteral>]
type CreateIncentiveAction() =
member val Id:Int32 = new Int32() with get,set
member val ActionType:IncentiveActionType = new IncentiveActionType() with get,set
member val Description:String = null 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
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.
POST /superadmin/incentives/action HTTP/1.1
Host: api.bookmore.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<CreateIncentiveAction xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<ActionType>Upgrade</ActionType>
<Description>String</Description>
<Element>String</Element>
<Id>0</Id>
<LicenseTypeId>0</LicenseTypeId>
<Page>String</Page>
<Segment>String</Segment>
</CreateIncentiveAction>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<IncentiveActionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<ActionType>Upgrade</ActionType>
<Description>String</Description>
<Element>String</Element>
<Id>0</Id>
<LicenseTypeId>0</LicenseTypeId>
<Page>String</Page>
<Segment>String</Segment>
<SuggestedLicenseToUpgrade>
<Description>String</Description>
<Id>0</Id>
<IsExtraLicenseOption>false</IsExtraLicenseOption>
<Items>
<LicenseItemsResponse>
<AllowedItems>0</AllowedItems>
<Id>0</Id>
<Name>String</Name>
</LicenseItemsResponse>
</Items>
<Name>String</Name>
<PeriodOfNoticeDays>0</PeriodOfNoticeDays>
<Prices xmlns:d3p1="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Db">
<d3p1:LicensePrice>
<d3p1:Country>
<d3p1:Culture>String</d3p1:Culture>
<d3p1:CurrencyId>String</d3p1:CurrencyId>
<d3p1:CurrencyInfo>
<d3p1:Active>false</d3p1:Active>
<d3p1:CurrencySign>String</d3p1:CurrencySign>
<d3p1:Id>String</d3p1:Id>
<d3p1:ModifiedDate xmlns:d7p1="http://schemas.datacontract.org/2004/07/System">
<d7p1:DateTime>0001-01-01T00:00:00Z</d7p1:DateTime>
<d7p1:OffsetMinutes>0</d7p1:OffsetMinutes>
</d3p1:ModifiedDate>
<d3p1:Name>String</d3p1:Name>
</d3p1:CurrencyInfo>
<d3p1:Id>String</d3p1:Id>
<d3p1:ModifiedDate xmlns:d6p1="http://schemas.datacontract.org/2004/07/System">
<d6p1:DateTime>0001-01-01T00:00:00Z</d6p1:DateTime>
<d6p1:OffsetMinutes>0</d6p1:OffsetMinutes>
</d3p1:ModifiedDate>
<d3p1:Name>String</d3p1:Name>
<d3p1:TimeZone>String</d3p1:TimeZone>
</d3p1:Country>
<d3p1:CountryId>String</d3p1:CountryId>
<d3p1:LicenseTypeId>0</d3p1:LicenseTypeId>
<d3p1:ModifiedDate xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
<d5p1:DateTime>0001-01-01T00:00:00Z</d5p1:DateTime>
<d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
</d3p1:ModifiedDate>
<d3p1:Price>0</d3p1:Price>
</d3p1:LicensePrice>
</Prices>
</SuggestedLicenseToUpgrade>
</IncentiveActionResponse>