BokaMera.API.Host

<back to all web services

CreateRebateCodeTransaction

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
POST/rebatecodes/transactionsCreate transaction for the rebate codeCreate transaction for the rebate code
namespace BokaMera.API.ServiceModel.Dtos

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<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 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 RebateCodeTransactionResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val RebateCodeTransactionItem:RebateCodeTransactionQueryResponse = null with get,set

    type AmountChangeType =
        | Increase = 0
        | Decrease = 1

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

        ///<summary>
        ///Rebate code id to which you wish to add transaction
        ///</summary>
        [<ApiMember(Description="Rebate code id to which you wish to add transaction", IsRequired=true)>]
        member val RebateCodeId:Int32 = new Int32() with get,set

        [<ApiMember(IsRequired=true)>]
        member val Amount:Double = new Double() with get,set

        [<ApiMember(IsRequired=true)>]
        member val Usage:Int32 = new Int32() with get,set

        [<ApiMember>]
        member val BookingId:Nullable<Int32> = new Nullable<Int32>() with get,set

        ///<summary>
        ///If you want to Increase = 0 or Decrease = 1 the value
        ///</summary>
        [<ApiMember(Description="If you want to Increase = 0 or Decrease = 1 the value", IsRequired=true)>]
        member val ChangeType:AmountChangeType = new AmountChangeType() with get,set

F# CreateRebateCodeTransaction DTOs

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

HTTP + XML

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

POST /rebatecodes/transactions HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateRebateCodeTransaction xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Amount>0</Amount>
  <BookingId>0</BookingId>
  <ChangeType>Increase</ChangeType>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <RebateCodeId>0</RebateCodeId>
  <Usage>0</Usage>
</CreateRebateCodeTransaction>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<RebateCodeTransactionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <RebateCodeTransactionItem>
    <Amount>0</Amount>
    <BookingId>0</BookingId>
    <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
    <CreatedDate>0001-01-01T00:00:00</CreatedDate>
    <Customer>
      <Email>String</Email>
      <Firstname>String</Firstname>
      <Id>00000000-0000-0000-0000-000000000000</Id>
      <ImageUrl>String</ImageUrl>
      <Lastname>String</Lastname>
      <Phone>String</Phone>
    </Customer>
    <Id>0</Id>
    <Note>String</Note>
    <PriceSign>String</PriceSign>
    <RebateCodeId>0</RebateCodeId>
    <RebateCodeSign>String</RebateCodeSign>
    <RebateCodeTypeId>0</RebateCodeTypeId>
    <RebateCodeTypeName>String</RebateCodeTypeName>
    <Service>
      <Active>false</Active>
      <Description>String</Description>
      <Id>0</Id>
      <Name>String</Name>
    </Service>
    <UpdatedDate>0001-01-01T00:00:00</UpdatedDate>
  </RebateCodeTransactionItem>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</RebateCodeTransactionResponse>