BokaMera.API.Host

<back to all web services

CreatePresetBehaviour

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

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 virtual ChangeTypeEnum ChangeType { get; set; }

        public virtual ChangeOperationEnum ChangeOperation { get; set; }
        public virtual SubscriptionTimingEnum Timing { get; set; }
        public virtual PeriodAnchorEnum PeriodAnchor { get; set; }
        public virtual RenewalTimingEnum RenewalTiming { get; set; }
        public virtual SubscriptionBehaviourEnum? DebitBehaviour { get; set; }
        public virtual SubscriptionBehaviourEnum? CreditBehaviour { get; set; }
        public virtual CreditKindEnum? CreditKind { get; set; }
        public virtual int? PeriodIterationCount { get; set; }
    }

}

namespace VossIntegration.ApiTools.Enums
{
    public enum CreditKindEnum
    {
        Normal,
        Internal,
    }

    public enum SubscriptionBehaviourEnum
    {
        Prorate,
        Full,
        None,
    }

    public enum SubscriptionTimingEnum
    {
        AtSubscriptionBillingPeriodEnd,
        AtBindingPeriodEnd,
        Immediately,
    }

}

C# 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

{}