BokaMera.API.Host

<back to all web services

CreatePresetBehaviour

The following routes are available for this service:
POST/voss/presetBehaviourcreate preset behaviour in voss
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
    public static class CreatePresetBehaviour
    {
        /**
        * Company ids to create invoice. If none added invoice for all will be created
        */
        @ApiMember(Description="Company ids to create invoice. If none added invoice for all will be created")
        public ChangeTypeEnum ChangeType = null;

        public ChangeOperationEnum ChangeOperation = null;
        public SubscriptionTimingEnum Timing = null;
        public PeriodAnchorEnum PeriodAnchor = null;
        public RenewalTimingEnum RenewalTiming = null;
        public SubscriptionBehaviourEnum DebitBehaviour = null;
        public SubscriptionBehaviourEnum CreditBehaviour = null;
        public CreditKindEnum CreditKind = null;
        public Integer PeriodIterationCount = null;
        
        public ChangeTypeEnum getChangeType() { return ChangeType; }
        public CreatePresetBehaviour setChangeType(ChangeTypeEnum value) { this.ChangeType = value; return this; }
        public ChangeOperationEnum getChangeOperation() { return ChangeOperation; }
        public CreatePresetBehaviour setChangeOperation(ChangeOperationEnum value) { this.ChangeOperation = value; return this; }
        public SubscriptionTimingEnum getTiming() { return Timing; }
        public CreatePresetBehaviour setTiming(SubscriptionTimingEnum value) { this.Timing = value; return this; }
        public PeriodAnchorEnum getPeriodAnchor() { return PeriodAnchor; }
        public CreatePresetBehaviour setPeriodAnchor(PeriodAnchorEnum value) { this.PeriodAnchor = value; return this; }
        public RenewalTimingEnum getRenewalTiming() { return RenewalTiming; }
        public CreatePresetBehaviour setRenewalTiming(RenewalTimingEnum value) { this.RenewalTiming = value; return this; }
        public SubscriptionBehaviourEnum getDebitBehaviour() { return DebitBehaviour; }
        public CreatePresetBehaviour setDebitBehaviour(SubscriptionBehaviourEnum value) { this.DebitBehaviour = value; return this; }
        public SubscriptionBehaviourEnum getCreditBehaviour() { return CreditBehaviour; }
        public CreatePresetBehaviour setCreditBehaviour(SubscriptionBehaviourEnum value) { this.CreditBehaviour = value; return this; }
        public CreditKindEnum getCreditKind() { return CreditKind; }
        public CreatePresetBehaviour setCreditKind(CreditKindEnum value) { this.CreditKind = value; return this; }
        public Integer getPeriodIterationCount() { return PeriodIterationCount; }
        public CreatePresetBehaviour setPeriodIterationCount(Integer value) { this.PeriodIterationCount = value; return this; }
    }

    public static enum ChangeTypeEnum
    {
        Subscription,
        ProductGroup,
        License;
    }

    public static enum ChangeOperationEnum
    {
        Create,
        Terminate,
        Upgrade,
        Sidegrade,
        Downgrade,
        Migration;
    }

    public static enum SubscriptionTimingEnum
    {
        AtSubscriptionBillingPeriodEnd,
        AtBindingPeriodEnd,
        Immediately;
    }

    public static enum PeriodAnchorEnum
    {
        LatestPeriod,
        CurrentPeriod;
    }

    public static enum RenewalTimingEnum
    {
        UseCurrentPlanRenewalDate,
        UseScheduledPlanRenewalDate;
    }

    public static enum SubscriptionBehaviourEnum
    {
        Prorate,
        Full,
        None;
    }

    public static enum CreditKindEnum
    {
        Normal,
        Internal;
    }

}

Java 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

{}