BokaMera.API.Host

<back to all web services

UpdateVossSubscriptions

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
PUT/voss/subscriptionsPUT voss subscription
UpdateVossSubscriptions Parameters:
NameParameterData TypeRequiredDescription
CompanyIdbodyGuidNoThe company id. Subscription will be fetched of this company
DiscountAgreementsbodyList<SubscriptionDiscountAgreementRequestDto>YesDiscount agreement data
DiscountAgreementsChangeTypebodyDiscountAgreementsChangeTypeEnumNo Discount agreements change type controls how already occured transactions are treated <br />Retrospective - all future and past not invoiced transactions will be recalculated with new discount agreements <br />Prospective - discounts will apply only for future transactions
CompanyOwnerIdbodyintNoThe company id. Subscription will be fetched of this company
SubscriptionDiscountAgreementRequestDto Parameters:
NameParameterData TypeRequiredDescription
DiscountAgreementIdformGuidNo
PeriodformSubscriptionDiscountPeriodRequestDtoYes
SubscriptionDiscountPeriodRequestDto Parameters:
NameParameterData TypeRequiredDescription
PeriodKindformPeriodKindEnumNo
LengthformDiscountAgreementTimeLengthRequestDtoYes
PeriodIterationCountformint?No
PeriodKindEnum Enum:
FixedTime
AlignedToBindingPeriod
AlignedToSubscriptionBillingPeriod
DiscountAgreementTimeLengthRequestDto Parameters:
NameParameterData TypeRequiredDescription
UnitformUnitEnumNo
ValueformintNo
UnitEnum Enum:
Day
Month
Year
DiscountAgreementsChangeTypeEnum Enum:
Prospective
Retrospective

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.

PUT /voss/subscriptions HTTP/1.1 
Host: api.bookmore.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateVossSubscriptions xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <CompanyOwnerId>0</CompanyOwnerId>
  <DiscountAgreements xmlns:d2p1="http://schemas.datacontract.org/2004/07/BokaMera.VossIntegration.ApiTools.Model">
    <d2p1:SubscriptionDiscountAgreementRequestDto i:nil="true" />
  </DiscountAgreements>
  <DiscountAgreementsChangeType>Prospective</DiscountAgreementsChangeType>
</UpdateVossSubscriptions>
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/" />