BokaMera.API.Host

<back to all web services

CreateRebateCode

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
POST/rebatecodesCreate RebateCode.Create RebateCode.
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 DaysOfWeekResponse() = 
        member val Id:Int32 = new Int32() with get,set
        member val DayOfWeek:String = null with get,set
        member val DayOfWeekTranslation:String = null with get,set
        member val DayOfWeekActive:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val DayOfWeekSortOrder:Nullable<Int16> = new Nullable<Int16>() with get,set

    [<AllowNullLiteral>]
    type RebateCodeServiceResponse() = 
        member val Id:Int32 = new Int32() with get,set
        member val Name:String = null with get,set
        member val Description:String = null with get,set
        member val Active:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type BaseModel() = 
        class end

    [<AllowNullLiteral>]
    type ArticleServiceDb() = 
        inherit BaseModel()
        [<Required>]
        member val CompanyId:Guid = new Guid() with get,set

        member val Id:Int32 = new Int32() with get,set
        [<Required>]
        member val ServiceId:Int32 = new Int32() with get,set

        [<Required>]
        member val ArticleId:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type ArticleResponse() = 
        member val CompanyId:Guid = new Guid() with get,set
        member val Id:Int32 = new Int32() with get,set
        member val Name:String = null with get,set
        member val ArticleTypeId:Int32 = new Int32() with get,set
        member val Description:String = null with get,set
        member val ImageUrl:String = null with get,set
        member val Active:Boolean = new Boolean() with get,set
        member val Amount:Int32 = new Int32() with get,set
        member val Price:Double = new Double() with get,set
        member val CurrencyId:String = null with get,set
        member val UpdatedDate:DateTime = new DateTime() with get,set
        member val CreatedDate:DateTime = new DateTime() with get,set
        member val Services:ResizeArray<ArticleServiceDb> = new ResizeArray<ArticleServiceDb>() with get,set
        member val ServiceIds:ResizeArray<Int32> = new ResizeArray<Int32>() with get,set
        member val PriceSign:String = null with get,set

    [<AllowNullLiteral>]
    type RebateCodeCustomerResponse() = 
        member val Id:Guid = new Guid() with get,set
        member val Firstname:String = null with get,set
        member val Lastname:String = null with get,set
        member val Email:String = null with get,set
        member val Phone:String = null with get,set
        member val ImageUrl:String = null with get,set

    [<AllowNullLiteral>]
    type RebateCodeTransactionQueryResponse() = 
        member val Id:Int32 = new Int32() with get,set
        member val CompanyId:Guid = new Guid() with get,set
        member val Note:String = null with get,set
        member val RebateCodeId:Int32 = new Int32() with get,set
        member val RebateCodeSign:String = null with get,set
        member val RebateCodeTypeId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val RebateCodeTypeName:String = null with get,set
        member val Amount:Double = new Double() with get,set
        member val BookingId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val UpdatedDate:DateTime = new DateTime() with get,set
        member val CreatedDate:DateTime = new DateTime() with get,set
        member val Service:RebateCodeServiceResponse = null with get,set
        member val Customer:RebateCodeCustomerResponse = null with get,set
        member val PriceSign:String = null with get,set

    [<AllowNullLiteral>]
    type RebateCodeResponse() = 
        member val Id:Int32 = new Int32() with get,set
        member val CompanyId:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val ValidFrom:DateTime = new DateTime() with get,set
        member val ValidTo:DateTime = new DateTime() with get,set
        ///<summary>
        ///If the price is only valid for specific days in week add a comma separated list of which days this day price belongs to, 1 = Monday .. 7 = Sunday. All old days connected will be removed on update.
        ///</summary>
        [<ApiMember(Description="If the price is only valid for specific days in week add a comma separated list of which days this day price belongs to, 1 = Monday .. 7 = Sunday. All old days connected will be removed on update.")>]
        member val FromTime:TimeSpan = new TimeSpan() with get,set

        ///<summary>
        ///If the price is only valid for a specific time span during a time of day enter the FromTime and ToTime parameters.
        ///</summary>
        [<ApiMember(Description="If the price is only valid for a specific time span during a time of day enter the FromTime and ToTime parameters.")>]
        member val ToTime:TimeSpan = new TimeSpan() with get,set

        member val CreatedBy:String = null with get,set
        member val Created:DateTime = new DateTime() with get,set
        member val UpdatedBy:String = null with get,set
        member val Updated:DateTime = new DateTime() with get,set
        member val PersonalNote:String = null with get,set
        member val RebateCodeSign:String = null with get,set
        member val RebateCodeValue:Int32 = new Int32() with get,set
        member val RebateCodeTypeId:Int32 = new Int32() with get,set
        member val Name:String = null with get,set
        member val RebateCodeStatusId:Int32 = new Int32() with get,set
        member val StatusName:String = null with get,set
        member val MaxNumberOfUses:Int32 = new Int32() with get,set
        member val MaxNumberOfUsesPerCustomer:Int32 = new Int32() with get,set
        member val NumberOfUsesUsed:Int32 = new Int32() with get,set
        member val DaysOfWeek:ResizeArray<DaysOfWeekResponse> = new ResizeArray<DaysOfWeekResponse>() with get,set
        member val Services:ResizeArray<RebateCodeServiceResponse> = new ResizeArray<RebateCodeServiceResponse>() with get,set
        member val Article:ArticleResponse = null with get,set
        member val Transactions:ResizeArray<RebateCodeTransactionQueryResponse> = new ResizeArray<RebateCodeTransactionQueryResponse>() with get,set
        member val RemainingAmount:Nullable<Double> = new Nullable<Double>() with get,set
        member val RemainingUsage:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Customers:ResizeArray<RebateCodeCustomerResponse> = new ResizeArray<RebateCodeCustomerResponse>() with get,set
        member val ResponseStatus:ResponseStatus = null with get,set
        member val PaymentReceived:Boolean = new Boolean() with get,set
        member val RebateCodeCurrencySign:String = null with get,set
        member val ActiveByStatus:Boolean = new Boolean() with get,set
        member val PriceSign:String = null with get,set
        member val RebateCodeTypeName:String = null with get,set

    [<AllowNullLiteral>]
    type PromoCodeReceiver() = 
        member val CustomerId:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val Firstname:String = null with get,set
        member val Lastname:String = null with get,set
        member val Email:String = null with get,set
        member val ReceiverMessage:String = null with get,set

    [<ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)>]
    [<ValidateRequest(Validator="IsAuthenticated")>]
    [<AllowNullLiteral>]
    type CreateRebateCode() = 
        ///<summary>
        ///
        ///</summary>
        [<ApiMember(Description="")>]
        member val CompanyId:Nullable<Guid> = new Nullable<Guid>() with get,set

        ///<summary>
        ///The default value is 9999
        ///</summary>
        [<ApiMember(Description="The default value is 9999")>]
        member val MaxNumberOfUses:Nullable<Int32> = new Nullable<Int32>() with get,set

        ///<summary>
        ///The default value is 1
        ///</summary>
        [<ApiMember(Description="The default value is 1")>]
        member val MaxNumberOfUsesPerCustomer:Nullable<Int32> = new Nullable<Int32>() with get,set

        ///<summary>
        ///
        ///</summary>
        [<ApiMember(Description="", IsRequired=true)>]
        member val ValidFrom:DateTime = new DateTime() with get,set

        ///<summary>
        ///
        ///</summary>
        [<ApiMember(Description="", IsRequired=true)>]
        member val ValidTo:DateTime = new DateTime() with get,set

        ///<summary>
        ///If the price is only valid for specific days in week add a comma separated list of which days this day price belongs to, 1 = Monday .. 7 = Sunday. All old days connected will be removed on update.
        ///</summary>
        [<ApiMember(Description="If the price is only valid for specific days in week add a comma separated list of which days this day price belongs to, 1 = Monday .. 7 = Sunday. All old days connected will be removed on update.")>]
        member val FromTime:Nullable<TimeSpan> = new Nullable<TimeSpan>() with get,set

        ///<summary>
        ///If the price is only valid for a specific time span during a time of day enter the FromTime and ToTime parameters.
        ///</summary>
        [<ApiMember(Description="If the price is only valid for a specific time span during a time of day enter the FromTime and ToTime parameters.")>]
        member val ToTime:Nullable<TimeSpan> = new Nullable<TimeSpan>() with get,set

        ///<summary>
        ///1 - Percent, 2 - Сurrency, 3 - PunchTicket, 4 - ValueCard, 5 - GiftCard
        ///</summary>
        [<ApiMember(Description="1 - Percent, 2 - Сurrency, 3 - PunchTicket, 4 - ValueCard, 5 - GiftCard", IsRequired=true)>]
        member val RebateCodeTypeId:Int32 = new Int32() with get,set

        ///<summary>
        ///If it's connected to an Article, add the Article Id here.
        ///</summary>
        [<ApiMember(Description="If it's connected to an Article, add the Article Id here.")>]
        member val ArticleId:Nullable<Int32> = new Nullable<Int32>() with get,set

        ///<summary>
        ///
        ///</summary>
        [<ApiMember(Description="", IsRequired=true)>]
        member val RebateCodeValue:Int32 = new Int32() with get,set

        ///<summary>
        ///If AutoGenerateRebateCodeSign=false - more than four letters, unique among active codes
        ///</summary>
        [<ApiMember(Description="If AutoGenerateRebateCodeSign=false - more than four letters, unique among active codes")>]
        member val RebateCodeSign:String = null with get,set

        ///<summary>
        ///AutoGenerateRebateCodeSign=true - random generate code
        ///</summary>
        [<ApiMember(Description="AutoGenerateRebateCodeSign=true - random generate code")>]
        member val AutoGenerateRebateCodeSign:Boolean = new Boolean() with get,set

        ///<summary>
        ///
        ///</summary>
        [<ApiMember(Description="")>]
        member val PersonalNote:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<ApiMember(Description="")>]
        member val DaysOfWeek:ResizeArray<Int32> = new ResizeArray<Int32>() with get,set

        ///<summary>
        ///
        ///</summary>
        [<ApiMember(Description="")>]
        member val Services:ResizeArray<Int32> = new ResizeArray<Int32>() with get,set

        ///<summary>
        ///
        ///</summary>
        [<ApiMember(Description="")>]
        member val Customers:ResizeArray<Guid> = new ResizeArray<Guid>() with get,set

        ///<summary>
        ///The price
        ///</summary>
        [<ApiMember(Description="The price")>]
        member val PriceVat:Nullable<Decimal> = new Nullable<Decimal>() with get,set

        ///<summary>
        ///The price currency
        ///</summary>
        [<ApiMember(Description="The price currency")>]
        member val CurrencyId:String = null with get,set

        ///<summary>
        ///Promo code Receiver infomration
        ///</summary>
        [<ApiMember(Description="Promo code Receiver infomration")>]
        member val PromoCodeReceiver:PromoCodeReceiver = null with get,set

F# CreateRebateCode DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /rebatecodes HTTP/1.1 
Host: api.bokamera.se 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","MaxNumberOfUses":0,"MaxNumberOfUsesPerCustomer":0,"FromTime":"00:00:00","ToTime":"00:00:00","RebateCodeTypeId":0,"ArticleId":0,"RebateCodeValue":0,"RebateCodeSign":"String","AutoGenerateRebateCodeSign":false,"PersonalNote":"String","DaysOfWeek":[0],"Services":[0],"Customers":["00000000-0000-0000-0000-000000000000"],"PriceVat":0,"CurrencyId":"String","PromoCodeReceiver":{"CustomerId":"00000000-0000-0000-0000-000000000000","Firstname":"String","Lastname":"String","Email":"String","ReceiverMessage":"String"}}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Id":0,"CompanyId":"00000000-0000-0000-0000-000000000000","FromTime":"00:00:00","ToTime":"00:00:00","CreatedBy":"String","UpdatedBy":"String","PersonalNote":"String","RebateCodeSign":"String","RebateCodeValue":0,"RebateCodeTypeId":0,"Name":"String","RebateCodeStatusId":0,"StatusName":"String","MaxNumberOfUses":0,"MaxNumberOfUsesPerCustomer":0,"NumberOfUsesUsed":0,"DaysOfWeek":[{"Id":0,"DayOfWeek":"String","DayOfWeekTranslation":"String","DayOfWeekActive":false,"DayOfWeekSortOrder":0}],"Services":[{"Id":0,"Name":"String","Description":"String","Active":false}],"Article":{"Id":0,"Name":"String","ArticleTypeId":0,"Description":"String","ImageUrl":"String","Active":false,"Amount":0,"Price":0,"CurrencyId":"String","Services":[{"Id":0,"ServiceId":0,"ArticleId":0}],"ServiceIds":[0],"PriceSign":"String"},"Transactions":[{"Id":0,"Note":"String","RebateCodeId":0,"RebateCodeSign":"String","RebateCodeTypeId":0,"RebateCodeTypeName":"String","Amount":0,"BookingId":0,"Service":{"Id":0,"Name":"String","Description":"String","Active":false},"Customer":{"Firstname":"String","Lastname":"String","Email":"String","Phone":"String","ImageUrl":"String"},"PriceSign":"String"}],"RemainingAmount":0,"RemainingUsage":0,"Customers":[{"Firstname":"String","Lastname":"String","Email":"String","Phone":"String","ImageUrl":"String"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"PaymentReceived":false,"RebateCodeCurrencySign":"String","ActiveByStatus":false,"PriceSign":"String","RebateCodeTypeName":"String"}