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>NoDiscount 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 .other suffix or ?format=other

HTTP + OTHER

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: testapi.bokamera.se 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"DiscountAgreements":[{}],"DiscountAgreementsChangeType":"Prospective","CompanyOwnerId":0}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{}