BokaMera.API.Host

<back to all web services

CreatePresetBehaviour

The following routes are available for this service:
POST/voss/presetBehaviourcreate preset behaviour in voss
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BokaMera.API.ServiceModel.Dtos
Imports Org.OpenAPITools.Model
Imports VossIntegration.ApiTools.Enums

Namespace Global

    Namespace BokaMera.API.ServiceModel.Dtos

        <ApiResponse(Description:="You were unauthorized to call this service", StatusCode:=401)>
        Public Partial Class CreatePresetBehaviour
            '''<Summary>
            '''Company ids to create invoice. If none added invoice for all will be created
            '''</Summary>
            <ApiMember(Description:="Company ids to create invoice. If none added invoice for all will be created")>
            Public Overridable Property ChangeType As ChangeTypeEnum

            Public Overridable Property ChangeOperation As ChangeOperationEnum
            Public Overridable Property Timing As SubscriptionTimingEnum
            Public Overridable Property PeriodAnchor As PeriodAnchorEnum
            Public Overridable Property RenewalTiming As RenewalTimingEnum
            Public Overridable Property DebitBehaviour As Nullable(Of SubscriptionBehaviourEnum)
            Public Overridable Property CreditBehaviour As Nullable(Of SubscriptionBehaviourEnum)
            Public Overridable Property CreditKind As Nullable(Of CreditKindEnum)
            Public Overridable Property PeriodIterationCount As Nullable(Of Integer)
        End Class
    End Namespace

    Namespace VossIntegration.ApiTools.Enums

        Public Enum CreditKindEnum
            Normal
            Internal
        End Enum

        Public Enum SubscriptionBehaviourEnum
            Prorate
            Full
            None
        End Enum

        Public Enum SubscriptionTimingEnum
            AtSubscriptionBillingPeriodEnd
            AtBindingPeriodEnd
            Immediately
        End Enum
    End Namespace
End Namespace

VB.NET CreatePresetBehaviour 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 /voss/presetBehaviour HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"ChangeType":"Subscription","ChangeOperation":"Create","Timing":"AtSubscriptionBillingPeriodEnd","PeriodAnchor":"LatestPeriod","RenewalTiming":"UseCurrentPlanRenewalDate","DebitBehaviour":"Prorate","CreditBehaviour":"Prorate","CreditKind":"Normal","PeriodIterationCount":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{}