BokaMera.API.Host

<back to all web services

UpdateVossDiscountAgreements

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
PUT/voss/discountAgreementsPUT Discount agreements
UpdateVossDiscountAgreements Parameters:
NameParameterData TypeRequiredDescription
DiscountAgreementIdbodyGuidYesDiscount agreement data
DiscountPeriodbodyUpdateDiscountPeriodRequestDtoYesDiscount agreement period data. Iteration count must be added
DiscountAgreementStatusbodyDiscountAgreementStatusEnumYesDiscount agreement status. Published is default.
NamebodystringYes
DescriptionbodystringYes
ValidFrombodyDateTimeNo
ValidTobodyDateTime?No
UpdateDiscountPeriodRequestDto Parameters:
NameParameterData TypeRequiredDescription
PeriodKindformPeriodKindEnumNo
LengthformDiscountAgreementTimeLengthRequestDtoYes
PeriodIterationCountformint?No
PeriodKindEnum Enum:
FixedTime
AlignedToBindingPeriod
AlignedToSubscriptionBillingPeriod
DiscountAgreementTimeLengthRequestDto Parameters:
NameParameterData TypeRequiredDescription
UnitformUnitEnumNo
ValueformintNo
UnitEnum Enum:
Day
Month
Year
DiscountAgreementStatusEnum Enum:
Draft
Staged
Published
Archived
Discarded

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

<UpdateVossDiscountAgreements xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Description>String</Description>
  <DiscountAgreementId>00000000-0000-0000-0000-000000000000</DiscountAgreementId>
  <DiscountAgreementStatus>Draft</DiscountAgreementStatus>
  <DiscountPeriod xmlns:d2p1="http://schemas.datacontract.org/2004/07/BokaMera.VossIntegration.ApiTools.Model" i:nil="true" />
  <Name>String</Name>
  <ValidFrom>0001-01-01T00:00:00</ValidFrom>
  <ValidTo>0001-01-01T00:00:00</ValidTo>
</UpdateVossDiscountAgreements>
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/" />