BokaMera.API.Host

CreateArticleRebateCode

The following routes are available for this service:
POST	/rebatecodes/fromarticle	Create RebateCode.	Create RebateCode.

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

Namespace Global

    Namespace BokaMera.API.ServiceModel.Db

        Public Partial Class ArticleServiceRelation
            Inherits BaseModel
            <Required>
            Public Overridable Property CompanyId As Guid

            Public Overridable Property Id As Integer
            <Required>
            Public Overridable Property ServiceId As Integer

            <Required>
            Public Overridable Property ArticleId As Integer
        End Class

        Public Partial Class BaseModel
        End Class
    End Namespace

    Namespace BokaMera.API.ServiceModel.Dtos

        Public Partial Class ArticleResponse
            Public Sub New()
                Services = New List(Of ArticleServiceRelation)
                ServiceIds = New List(Of Integer)
            End Sub

            Public Overridable Property CompanyId As Guid
            Public Overridable Property Id As Integer
            Public Overridable Property Name As String
            Public Overridable Property ArticleTypeId As Integer
            Public Overridable Property Description As String
            Public Overridable Property ImageUrl As String
            Public Overridable Property Active As Boolean
            Public Overridable Property Amount As Integer
            Public Overridable Property Price As Double
            Public Overridable Property CurrencyId As String
            Public Overridable Property UpdatedDate As Date
            Public Overridable Property CreatedDate As Date
            Public Overridable Property Services As List(Of ArticleServiceRelation)
            Public Overridable Property ServiceIds As List(Of Integer)
            Public Overridable Property PriceSign As String
        End Class

        <ApiResponse(Description:="You were unauthorized to call this service", StatusCode:=401)>
        Public Partial Class CreateArticleRebateCode
            Implements ICompany
            '''<Summary>
            '''
            '''</Summary>
            <ApiMember(Description:="")>
            Public Overridable Property CompanyId As Nullable(Of Guid)

            '''<Summary>
            '''Article ID for the rebate code
            '''</Summary>
            <ApiMember(Description:="Article ID for the rebate code", IsRequired:=true)>
            Public Overridable Property ArticleId As Integer

            '''<Summary>
            '''Customer infomration
            '''</Summary>
            <ApiMember(Description:="Customer infomration")>
            Public Overridable Property Customer As CustomerToHandle

            '''<Summary>
            '''Promo code Receiver information
            '''</Summary>
            <ApiMember(Description:="Promo code Receiver information")>
            Public Overridable Property Receiver As PromoCodeReceiver
        End Class

        Public Partial Class CustomerToHandle
            Public Overridable Property CustomerId As Nullable(Of Guid)
            Public Overridable Property Firstname As String
            Public Overridable Property Lastname As String
            Public Overridable Property Email As String
            Public Overridable Property Phone As String
            Public Overridable Property SubscribedToNewsletter As Boolean
        End Class

        Public Partial Class DaysOfWeekResponse
            Public Overridable Property Id As Integer
            Public Overridable Property DayOfWeek As String
            Public Overridable Property DayOfWeekTranslation As String
            Public Overridable Property DayOfWeekActive As Nullable(Of Boolean)
            Public Overridable Property DayOfWeekSortOrder As Nullable(Of Short)
        End Class

        Public Partial Class PromoCodeReceiver
            Public Overridable Property CustomerId As Nullable(Of Guid)
            Public Overridable Property Firstname As String
            Public Overridable Property Lastname As String
            Public Overridable Property Email As String
            Public Overridable Property ReceiverMessage As String
        End Class

        Public Partial Class RebateCodeCustomerResponse
            Public Overridable Property Id As Guid
            Public Overridable Property Firstname As String
            Public Overridable Property Lastname As String
            Public Overridable Property Email As String
            Public Overridable Property Phone As String
            Public Overridable Property ImageUrl As String
        End Class

        Public Partial Class RebateCodeResponse
            Public Sub New()
                DaysOfWeek = New List(Of DaysOfWeekResponse)
                Services = New List(Of RebateCodeServiceResponse)
                Transactions = New List(Of RebateCodeTransactionQueryResponse)
                Customers = New List(Of RebateCodeCustomerResponse)
            End Sub

            Public Overridable Property Id As Integer
            Public Overridable Property CompanyId As Nullable(Of Guid)
            Public Overridable Property ValidFrom As Date
            Public Overridable Property ValidTo As Date
            '''<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.")>
            Public Overridable Property FromTime As TimeSpan

            '''<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.")>
            Public Overridable Property ToTime As TimeSpan

            Public Overridable Property CreatedBy As String
            Public Overridable Property Created As Date
            Public Overridable Property UpdatedBy As String
            Public Overridable Property Updated As Date
            Public Overridable Property PersonalNote As String
            Public Overridable Property RebateCodeSign As String
            Public Overridable Property RebateCodeValue As Integer
            Public Overridable Property RebateCodeTypeId As Integer
            Public Overridable Property Name As String
            Public Overridable Property RebateCodeStatusId As Integer
            Public Overridable Property StatusName As String
            Public Overridable Property MaxNumberOfUses As Integer
            Public Overridable Property MaxNumberOfUsesPerCustomer As Integer
            Public Overridable Property NumberOfUsesUsed As Integer
            Public Overridable Property DaysOfWeek As List(Of DaysOfWeekResponse)
            Public Overridable Property Services As List(Of RebateCodeServiceResponse)
            Public Overridable Property Article As ArticleResponse
            Public Overridable Property Transactions As List(Of RebateCodeTransactionQueryResponse)
            Public Overridable Property RemainingAmount As Nullable(Of Double)
            Public Overridable Property RemainingUsage As Nullable(Of Integer)
            Public Overridable Property Customers As List(Of RebateCodeCustomerResponse)
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property PaymentReceived As Boolean
            Public Overridable Property RebateCodeCurrencySign As String
            Public Overridable Property ActiveByStatus As Boolean
            Public Overridable Property PriceSign As String
            Public Overridable Property RebateCodeTypeName As String
        End Class

        Public Partial Class RebateCodeServiceResponse
            Public Overridable Property Id As Integer
            Public Overridable Property Name As String
            Public Overridable Property Description As String
            Public Overridable Property Active As Boolean
        End Class

        Public Partial Class RebateCodeTransactionQueryResponse
            Public Overridable Property Id As Integer
            Public Overridable Property CompanyId As Guid
            Public Overridable Property Note As String
            Public Overridable Property RebateCodeId As Integer
            Public Overridable Property RebateCodeSign As String
            Public Overridable Property RebateCodeTypeId As Nullable(Of Integer)
            Public Overridable Property RebateCodeTypeName As String
            Public Overridable Property Amount As Double
            Public Overridable Property BookingId As Nullable(Of Integer)
            Public Overridable Property UpdatedDate As Date
            Public Overridable Property CreatedDate As Date
            Public Overridable Property Service As RebateCodeServiceResponse
            Public Overridable Property Customer As RebateCodeCustomerResponse
            Public Overridable Property PriceSign As String
        End Class
    End Namespace
End Namespace

VB.NET CreateArticleRebateCode 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/fromarticle HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateArticleRebateCode xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <ArticleId>0</ArticleId>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <Customer>
    <CustomerId>00000000-0000-0000-0000-000000000000</CustomerId>
    <Email>String</Email>
    <Firstname>String</Firstname>
    <Lastname>String</Lastname>
    <Phone>String</Phone>
    <SubscribedToNewsletter>false</SubscribedToNewsletter>
  </Customer>
  <Receiver>
    <CustomerId>00000000-0000-0000-0000-000000000000</CustomerId>
    <Email>String</Email>
    <Firstname>String</Firstname>
    <Lastname>String</Lastname>
    <ReceiverMessage>String</ReceiverMessage>
  </Receiver>
</CreateArticleRebateCode>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<RebateCodeResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <ActiveByStatus>false</ActiveByStatus>
  <Article>
    <Active>false</Active>
    <Amount>0</Amount>
    <ArticleTypeId>0</ArticleTypeId>
    <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
    <CreatedDate>0001-01-01T00:00:00</CreatedDate>
    <CurrencyId>String</CurrencyId>
    <Description>String</Description>
    <Id>0</Id>
    <ImageUrl>String</ImageUrl>
    <Name>String</Name>
    <Price>0</Price>
    <PriceSign>String</PriceSign>
    <ServiceIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>0</d3p1:int>
    </ServiceIds>
    <Services xmlns:d3p1="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Db">
      <d3p1:ArticleServiceRelation>
        <d3p1:ArticleId>0</d3p1:ArticleId>
        <d3p1:CompanyId>00000000-0000-0000-0000-000000000000</d3p1:CompanyId>
        <d3p1:Id>0</d3p1:Id>
        <d3p1:ServiceId>0</d3p1:ServiceId>
      </d3p1:ArticleServiceRelation>
    </Services>
    <UpdatedDate>0001-01-01T00:00:00</UpdatedDate>
  </Article>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <Created>0001-01-01T00:00:00</Created>
  <CreatedBy>String</CreatedBy>
  <Customers>
    <RebateCodeCustomerResponse>
      <Email>String</Email>
      <Firstname>String</Firstname>
      <Id>00000000-0000-0000-0000-000000000000</Id>
      <ImageUrl>String</ImageUrl>
      <Lastname>String</Lastname>
      <Phone>String</Phone>
    </RebateCodeCustomerResponse>
  </Customers>
  <DaysOfWeek>
    <DaysOfWeekResponse>
      <DayOfWeek>String</DayOfWeek>
      <DayOfWeekActive>false</DayOfWeekActive>
      <DayOfWeekSortOrder>0</DayOfWeekSortOrder>
      <DayOfWeekTranslation>String</DayOfWeekTranslation>
      <Id>0</Id>
    </DaysOfWeekResponse>
  </DaysOfWeek>
  <FromTime>PT0S</FromTime>
  <Id>0</Id>
  <MaxNumberOfUses>0</MaxNumberOfUses>
  <MaxNumberOfUsesPerCustomer>0</MaxNumberOfUsesPerCustomer>
  <Name>String</Name>
  <NumberOfUsesUsed>0</NumberOfUsesUsed>
  <PaymentReceived>false</PaymentReceived>
  <PersonalNote>String</PersonalNote>
  <PriceSign>String</PriceSign>
  <RebateCodeCurrencySign>String</RebateCodeCurrencySign>
  <RebateCodeSign>String</RebateCodeSign>
  <RebateCodeStatusId>0</RebateCodeStatusId>
  <RebateCodeTypeId>0</RebateCodeTypeId>
  <RebateCodeTypeName>String</RebateCodeTypeName>
  <RebateCodeValue>0</RebateCodeValue>
  <RemainingAmount>0</RemainingAmount>
  <RemainingUsage>0</RemainingUsage>
  <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>
  <Services>
    <RebateCodeServiceResponse>
      <Active>false</Active>
      <Description>String</Description>
      <Id>0</Id>
      <Name>String</Name>
    </RebateCodeServiceResponse>
  </Services>
  <StatusName>String</StatusName>
  <ToTime>PT0S</ToTime>
  <Transactions>
    <RebateCodeTransactionQueryResponse>
      <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>
    </RebateCodeTransactionQueryResponse>
  </Transactions>
  <Updated>0001-01-01T00:00:00</Updated>
  <UpdatedBy>String</UpdatedBy>
  <ValidFrom>0001-01-01T00:00:00</ValidFrom>
  <ValidTo>0001-01-01T00:00:00</ValidTo>
</RebateCodeResponse>