BokaMera.API.Host

CreatePresetBehaviour

**Requires Authentication**
Requires any of the roles:	bookingsupplier-administrator-write, superadmin

The following routes are available for this service:
POST	/voss/presetBehaviour	create preset behaviour in voss

import Foundation
import ServiceStack

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
public class CreatePresetBehaviour : Codable
{
    /**
    * 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 var changeType:ChangeTypeEnum

    public var changeOperation:ChangeOperationEnum
    public var timing:SubscriptionTimingEnum
    public var periodAnchor:PeriodAnchorEnum
    public var renewalTiming:RenewalTimingEnum
    public var debitBehaviour:SubscriptionBehaviourEnum?
    public var creditBehaviour:SubscriptionBehaviourEnum?
    public var creditKind:CreditKindEnum?
    public var periodIterationCount:Int?

    required public init(){}
}

public enum ChangeTypeEnum : String, Codable
{
    case Subscription
    case ProductGroup
    case License
}

public enum ChangeOperationEnum : String, Codable
{
    case Create
    case Terminate
    case Upgrade
    case Sidegrade
    case Downgrade
    case Migration
}

public enum SubscriptionTimingEnum : String, Codable
{
    case AtSubscriptionBillingPeriodEnd
    case AtBindingPeriodEnd
    case Immediately
}

public enum PeriodAnchorEnum : String, Codable
{
    case LatestPeriod
    case CurrentPeriod
}

public enum RenewalTimingEnum : String, Codable
{
    case UseCurrentPlanRenewalDate
    case UseScheduledPlanRenewalDate
}

public enum SubscriptionBehaviourEnum : String, Codable
{
    case Prorate
    case Full
    case None
}

public enum CreditKindEnum : String, Codable
{
    case Normal
    case Internal
}

Swift CreatePresetBehaviour 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 /voss/presetBehaviour HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreatePresetBehaviour xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <ChangeOperation>Create</ChangeOperation>
  <ChangeType>Subscription</ChangeType>
  <CreditBehaviour>Prorate</CreditBehaviour>
  <CreditKind>Normal</CreditKind>
  <DebitBehaviour>Prorate</DebitBehaviour>
  <PeriodAnchor>LatestPeriod</PeriodAnchor>
  <PeriodIterationCount>0</PeriodIterationCount>
  <RenewalTiming>UseCurrentPlanRenewalDate</RenewalTiming>
  <Timing>AtSubscriptionBillingPeriodEnd</Timing>
</CreatePresetBehaviour>

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

<z:anyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" />