BokaMera.API.Host

<back to all web services

UpdateRebateCode

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
PUT/rebatecodes/{Id}Update RebateCode by IdUpdate RebateCode by Id)
import Foundation
import ServiceStack

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
public class UpdateRebateCode : ICompany, Codable
{
    /**
    * Id of the rebate code
    */
    // @ApiMember(Description="Id of the rebate code", IsRequired=true, ParameterType="path")
    public var id:Int?

    public var companyId:String?
    /**
    * The default value is 9999
    */
    // @ApiMember(Description="The default value is 9999")
    public var maxNumberOfUses:Int?

    /**
    * The default value is 1
    */
    // @ApiMember(Description="The default value is 1")
    public var maxNumberOfUsesPerCustomer:Int?

    /**
    * AutoGenerateRebateCodeSign=true - random generate code
    */
    // @ApiMember(Description="AutoGenerateRebateCodeSign=true - random generate code")
    public var autoGenerateRebateCodeSign:Bool

    /**
    * 1 - Percent, 2 - Сurrency
    */
    // @ApiMember(Description="1 - Percent, 2 - Сurrency")
    public var rebateCodeTypeId:Int

    /**
    * 
    */
    // @ApiMember(Description="")
    public var validFrom:Date?

    /**
    * 
    */
    // @ApiMember(Description="")
    public var validTo:Date?

    /**
    * 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.
    */
    // @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.")
    @TimeSpan public var fromTime:TimeInterval?

    /**
    * If the price is only valid for a specific time span during a time of day enter the FromTime and ToTime parameters.
    */
    // @ApiMember(Description="If the price is only valid for a specific time span during a time of day enter the FromTime and ToTime parameters.")
    @TimeSpan public var toTime:TimeInterval?

    public var rebateCodeValue:Int?
    /**
    * Is empty - random generate code, is not empty - more than four letters, unique among active codes
    */
    // @ApiMember(Description="Is empty - random generate code, is not empty - more than four letters, unique among active codes")
    public var rebateCodeSign:String

    /**
    * 
    */
    // @ApiMember(Description="")
    public var personalNote:String

    /**
    * 
    */
    // @ApiMember(Description="")
    public var daysOfWeek:[Int] = []

    /**
    * 
    */
    // @ApiMember(Description="")
    public var services:[Int] = []

    /**
    * 
    */
    // @ApiMember(Description="")
    public var customers:[String] = []

    required public init(){}
}

public class RebateCodeResponse : Codable
{
    public var id:Int
    public var companyId:String?
    public var validFrom:Date
    public var validTo:Date
    /**
    * 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.
    */
    // @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.")
    @TimeSpan public var fromTime:TimeInterval

    /**
    * If the price is only valid for a specific time span during a time of day enter the FromTime and ToTime parameters.
    */
    // @ApiMember(Description="If the price is only valid for a specific time span during a time of day enter the FromTime and ToTime parameters.")
    @TimeSpan public var toTime:TimeInterval

    public var createdBy:String
    public var created:Date
    public var updatedBy:String
    public var updated:Date
    public var personalNote:String
    public var rebateCodeSign:String
    public var rebateCodeValue:Int
    public var rebateCodeTypeId:Int
    public var name:String
    public var rebateCodeStatusId:Int
    public var statusName:String
    public var maxNumberOfUses:Int
    public var maxNumberOfUsesPerCustomer:Int
    public var numberOfUsesUsed:Int
    public var numberOfUsesPerCustomerUsed:Int
    public var daysOfWeek:[DaysOfWeekResponse] = []
    public var services:[RebateCodeServiceResponse] = []
    public var customers:[RebateCodeCustomerResponse] = []
    public var rebateCodeTypesOptions:[RebateCodeTypeResponse] = []
    public var rebateCodeStatusOptions:[RebateCodeStatusResponse] = []
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class DaysOfWeekResponse : Codable
{
    public var id:Int
    public var dayOfWeek:String
    public var dayOfWeekTranslation:String
    public var dayOfWeekActive:Bool?
    public var dayOfWeekSortOrder:Int16?

    required public init(){}
}

public class RebateCodeServiceResponse : Codable
{
    public var id:Int
    public var name:String
    public var Description:String
    public var active:Bool

    required public init(){}
}

public class RebateCodeCustomerResponse : Codable
{
    public var id:String
    public var firstname:String
    public var lastname:String
    public var email:String
    public var phone:String
    public var imageUrl:String

    required public init(){}
}

public class RebateCodeTypeResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var rebateCodeTypeItems:[RebateCodeTypeItem] = []

    required public init(){}
}

public class RebateCodeTypeItem : Codable
{
    public var id:Int
    public var name:String
    public var Description:String

    required public init(){}
}

public class RebateCodeStatusResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var rebateCodeStatusItems:[RebateCodeStatusItem] = []

    required public init(){}
}

public class RebateCodeStatusItem : Codable
{
    public var id:Int
    public var rebateCodeStatusName:String
    public var rebateCodeStatusDescription:String

    required public init(){}
}


Swift UpdateRebateCode 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.

PUT /rebatecodes/{Id} HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Id":0,"CompanyId":"00000000-0000-0000-0000-000000000000","MaxNumberOfUses":0,"MaxNumberOfUsesPerCustomer":0,"AutoGenerateRebateCodeSign":false,"RebateCodeTypeId":0,"ValidFrom":"0001-01-01T00:00:00","ValidTo":"0001-01-01T00:00:00","FromTime":"00:00:00","ToTime":"00:00:00","RebateCodeValue":0,"RebateCodeSign":"String","PersonalNote":"String","DaysOfWeek":[0],"Services":[0],"Customers":["00000000-0000-0000-0000-000000000000"]}
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,"NumberOfUsesPerCustomerUsed":0,"DaysOfWeek":[{"Id":0,"DayOfWeek":"String","DayOfWeekTranslation":"String","DayOfWeekActive":false,"DayOfWeekSortOrder":0}],"Services":[{"Id":0,"Name":"String","Description":"String","Active":false}],"Customers":[{"Firstname":"String","Lastname":"String","Email":"String","Phone":"String","ImageUrl":"String"}],"RebateCodeTypesOptions":[{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"RebateCodeTypeItems":[{"Id":0,"Name":"String","Description":"String"}]}],"RebateCodeStatusOptions":[{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"RebateCodeStatusItems":[{"Id":0,"RebateCodeStatusName":"String","RebateCodeStatusDescription":"String"}]}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}