BokaMera.API.Host

<back to all web services

CreatePresetBehaviour

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
POST/voss/presetBehaviourcreate preset behaviour in voss
CreatePresetBehaviour Parameters:
NameParameterData TypeRequiredDescription
ChangeTypebodyChangeTypeEnumNoCompany ids to create invoice. If none added invoice for all will be created
ChangeOperationbodyChangeOperationEnumNo
TimingbodySubscriptionTimingEnumNo
PeriodAnchorbodyPeriodAnchorEnumNo
RenewalTimingbodyRenewalTimingEnumNo
DebitBehaviourbodySubscriptionBehaviourEnum?No
CreditBehaviourbodySubscriptionBehaviourEnum?No
CreditKindbodyCreditKindEnum?No
PeriodIterationCountbodyint?No
ChangeTypeEnum Enum:
Subscription
ProductGroup
License
ChangeOperationEnum Enum:
Create
Terminate
Upgrade
Sidegrade
Downgrade
Migration
SubscriptionTimingEnum Enum:
AtSubscriptionBillingPeriodEnd
AtBindingPeriodEnd
Immediately
PeriodAnchorEnum Enum:
LatestPeriod
CurrentPeriod
RenewalTimingEnum Enum:
UseCurrentPlanRenewalDate
UseScheduledPlanRenewalDate
SubscriptionBehaviourEnum Enum:
Prorate
Full
None
CreditKindEnum Enum:
Normal
Internal

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/" />