Viviot.Api

<back to all web services

UpdateServiceAddons

Requires Authentication
Requires any of the roles:Admin, TenantAdmin, MarketplaceAdmin
The following routes are available for this service:
PUT/service/addonsUpdates a service addon list.
UpdateServiceAddons Parameters:
NameParameterData TypeRequiredDescription
ServiceIdbodystringYesService Id (GUID)
AddonsbodyList<ServiceAddonDto>NoList of service addons.
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
VersionformintegerNoApi version
ServiceAddonDto Parameters:
NameParameterData TypeRequiredDescription
IdformGuid?No
NameformstringNo
UnitPriceformdecimal?No
VATPercentageformdecimal?No
MaxQuantityformint?No
ExternalIdformstringNo
ServiceResponse Parameters:
NameParameterData TypeRequiredDescription
DataformServiceViewNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ServiceView Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
OrganizationIdformGuidNo
ServiceTypeformServiceTypeNo
NameformstringNo
DescriptionformstringNo
SubTitleformstringNo
ImageUrlformstringNo
IsPublicformboolNo
RequireConfirmationformbool?No
RequirePaymentformbool?No
Latitudeformdecimal?No
Longitudeformdecimal?No
CurrencyformCurrencyDtoNo
VATPercentageformdecimal?No
ProductsformList<ServiceProductView>No
AddonsformList<ServiceAddonDto>No
TimeOptionformServiceTimeOptionDtoNo
PersonOptionformServicePersonOptionDtoNo
ProvidersformDictionary<string, Guid>No
OrganizationformOrganizationDtoNo
ServiceType Enum:
NameValue
Reservation1
Request2
External3
Ticket4
CurrencyDto Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
NameformstringNo
CodeformstringNo
SymbolformstringNo
ServiceProductView Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
NameformstringNo
DescriptionformstringNo
UnitPriceformdecimal?No
MinimalPriceformdecimal?No
VATPercentageformdecimal?No
ImageUrlformstringNo
ExternalIdformList<string>No
ReservationDataformServiceProductReservationDtoNo
RequestDataformServiceProductRequestDtoNo
ExternalDataformServiceProductExternalDtoNo
TicketDataformServiceProductTicketDtoNo
ServiceProductReservationDto Parameters:
NameParameterData TypeRequiredDescription
IdformGuid?No
AccessTemplateGroupIdformGuid?No
AccessTemplateIdformGuid?No
AutoAssignAccessTemplateformbool?No
ServiceProductRequestDto Parameters:
NameParameterData TypeRequiredDescription
IdformGuid?No
OptionsformList<string>No
AllowCommentsformboolNo
ApprovedTemplateformstringNo
DeniedTemplateformstringNo
ProcessingTemplateformstringNo
ServiceProductExternalDto Parameters:
NameParameterData TypeRequiredDescription
IdformGuid?No
ServiceUrlformstringNo
Latitudeformdecimal?No
Longitudeformdecimal?No
Ratingformdecimal?No
ServiceProductTicketDto Parameters:
NameParameterData TypeRequiredDescription
IdformGuid?No
AccessTemplateIdformGuidNo
ServiceTimeOptionDto Parameters:
NameParameterData TypeRequiredDescription
IdformGuid?No
TypeformServiceTimeOptionTypeNo
DailyOptionsformTimeDailyDtoNo
TimespanOptionsformTimespanDtoNo
ServiceTimeOptionType Enum:
NameValue
Daily0
Timespan1
TimeDailyDto Parameters:
NameParameterData TypeRequiredDescription
CheckinformTimeSpan?No
CheckoutformTimeSpan?No
TimespanDto Parameters:
NameParameterData TypeRequiredDescription
MinDurationformintNo
MaxDurationformintNo
Incrementformint?No
IncrementPriceMultiplierformdecimal?No
ServicePersonOptionDto Parameters:
NameParameterData TypeRequiredDescription
IdformGuid?No
CanSelectChildrenformboolNo
MaxAdultCountformint?No
MaxChildrenCountformint?No
AdultPriceMultiplierformdecimalNo
ChildPriceMultiplierformdecimalNo
OrganizationDto Parameters:
NameParameterData TypeRequiredDescription
IdformGuid?No
CodeformstringNo

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 /service/addons HTTP/1.1 
Host: api.4spaces.io 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateServiceAddons xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Viviot.Api.ServiceModel.Api.Business">
  <Version xmlns="http://schemas.datacontract.org/2004/07/Viviot.Api.ServiceModel.Api.Base">0</Version>
  <Addons xmlns:d2p1="http://schemas.datacontract.org/2004/07/Viviot.Infrastructure.Dto.Service">
    <d2p1:ServiceAddonDto>
      <d2p1:ExternalId>String</d2p1:ExternalId>
      <d2p1:Id>00000000-0000-0000-0000-000000000000</d2p1:Id>
      <d2p1:MaxQuantity>0</d2p1:MaxQuantity>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:UnitPrice>0</d2p1:UnitPrice>
      <d2p1:VATPercentage>0</d2p1:VATPercentage>
    </d2p1:ServiceAddonDto>
  </Addons>
  <ServiceId>00000000-0000-0000-0000-000000000000</ServiceId>
</UpdateServiceAddons>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ServiceResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Viviot.Api.ServiceModel.Api.Business">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/Viviot.Api.ServiceModel.Api.Base">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Viviot.Api.ServiceModel.Views.Shared.Service">
    <d2p1:Addons xmlns:d3p1="http://schemas.datacontract.org/2004/07/Viviot.Infrastructure.Dto.Service">
      <d3p1:ServiceAddonDto>
        <d3p1:ExternalId>String</d3p1:ExternalId>
        <d3p1:Id>00000000-0000-0000-0000-000000000000</d3p1:Id>
        <d3p1:MaxQuantity>0</d3p1:MaxQuantity>
        <d3p1:Name>String</d3p1:Name>
        <d3p1:UnitPrice>0</d3p1:UnitPrice>
        <d3p1:VATPercentage>0</d3p1:VATPercentage>
      </d3p1:ServiceAddonDto>
    </d2p1:Addons>
    <d2p1:Currency xmlns:d3p1="http://schemas.datacontract.org/2004/07/Integrations.Payment.Responses">
      <d3p1:Code>String</d3p1:Code>
      <d3p1:Id>00000000-0000-0000-0000-000000000000</d3p1:Id>
      <d3p1:Name>String</d3p1:Name>
      <d3p1:Symbol>String</d3p1:Symbol>
    </d2p1:Currency>
    <d2p1:Description>String</d2p1:Description>
    <d2p1:Id>00000000-0000-0000-0000-000000000000</d2p1:Id>
    <d2p1:ImageUrl>String</d2p1:ImageUrl>
    <d2p1:IsPublic>false</d2p1:IsPublic>
    <d2p1:Latitude>0</d2p1:Latitude>
    <d2p1:Longitude>0</d2p1:Longitude>
    <d2p1:Name>String</d2p1:Name>
    <d2p1:Organization xmlns:d3p1="http://schemas.datacontract.org/2004/07/Viviot.Infrastructure.Dto.Organization">
      <d3p1:Code>String</d3p1:Code>
      <d3p1:Id>00000000-0000-0000-0000-000000000000</d3p1:Id>
    </d2p1:Organization>
    <d2p1:OrganizationId>00000000-0000-0000-0000-000000000000</d2p1:OrganizationId>
    <d2p1:PersonOption xmlns:d3p1="http://schemas.datacontract.org/2004/07/Viviot.Infrastructure.Dto.Service">
      <d3p1:AdultPriceMultiplier>0</d3p1:AdultPriceMultiplier>
      <d3p1:CanSelectChildren>false</d3p1:CanSelectChildren>
      <d3p1:ChildPriceMultiplier>0</d3p1:ChildPriceMultiplier>
      <d3p1:Id>00000000-0000-0000-0000-000000000000</d3p1:Id>
      <d3p1:MaxAdultCount>0</d3p1:MaxAdultCount>
      <d3p1:MaxChildrenCount>0</d3p1:MaxChildrenCount>
    </d2p1:PersonOption>
    <d2p1:Products>
      <d2p1:ServiceProductView>
        <d2p1:Description>String</d2p1:Description>
        <d2p1:ExternalData xmlns:d5p1="http://schemas.datacontract.org/2004/07/Viviot.Infrastructure.Dto.Service">
          <d5p1:Id>00000000-0000-0000-0000-000000000000</d5p1:Id>
          <d5p1:Latitude>0</d5p1:Latitude>
          <d5p1:Longitude>0</d5p1:Longitude>
          <d5p1:Rating>0</d5p1:Rating>
          <d5p1:ServiceUrl>String</d5p1:ServiceUrl>
        </d2p1:ExternalData>
        <d2p1:ExternalId xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>String</d5p1:string>
        </d2p1:ExternalId>
        <d2p1:Id>00000000-0000-0000-0000-000000000000</d2p1:Id>
        <d2p1:ImageUrl>String</d2p1:ImageUrl>
        <d2p1:MinimalPrice>0</d2p1:MinimalPrice>
        <d2p1:Name>String</d2p1:Name>
        <d2p1:RequestData xmlns:d5p1="http://schemas.datacontract.org/2004/07/Viviot.Infrastructure.Dto.Service">
          <d5p1:AllowComments>false</d5p1:AllowComments>
          <d5p1:ApprovedTemplate>String</d5p1:ApprovedTemplate>
          <d5p1:DeniedTemplate>String</d5p1:DeniedTemplate>
          <d5p1:Id>00000000-0000-0000-0000-000000000000</d5p1:Id>
          <d5p1:Options xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>String</d6p1:string>
          </d5p1:Options>
          <d5p1:ProcessingTemplate>String</d5p1:ProcessingTemplate>
        </d2p1:RequestData>
        <d2p1:ReservationData xmlns:d5p1="http://schemas.datacontract.org/2004/07/Viviot.Infrastructure.Dto.Service">
          <d5p1:AccessTemplateGroupId>00000000-0000-0000-0000-000000000000</d5p1:AccessTemplateGroupId>
          <d5p1:AccessTemplateId>00000000-0000-0000-0000-000000000000</d5p1:AccessTemplateId>
          <d5p1:AutoAssignAccessTemplate>false</d5p1:AutoAssignAccessTemplate>
          <d5p1:Id>00000000-0000-0000-0000-000000000000</d5p1:Id>
        </d2p1:ReservationData>
        <d2p1:TicketData xmlns:d5p1="http://schemas.datacontract.org/2004/07/Viviot.Infrastructure.Dto.Service">
          <d5p1:AccessTemplateId>00000000-0000-0000-0000-000000000000</d5p1:AccessTemplateId>
          <d5p1:Id>00000000-0000-0000-0000-000000000000</d5p1:Id>
        </d2p1:TicketData>
        <d2p1:UnitPrice>0</d2p1:UnitPrice>
        <d2p1:VATPercentage>0</d2p1:VATPercentage>
      </d2p1:ServiceProductView>
    </d2p1:Products>
    <d2p1:Providers xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringguid>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>00000000-0000-0000-0000-000000000000</d3p1:Value>
      </d3p1:KeyValueOfstringguid>
    </d2p1:Providers>
    <d2p1:RequireConfirmation>false</d2p1:RequireConfirmation>
    <d2p1:RequirePayment>false</d2p1:RequirePayment>
    <d2p1:ServiceType>Reservation</d2p1:ServiceType>
    <d2p1:SubTitle>String</d2p1:SubTitle>
    <d2p1:TimeOption xmlns:d3p1="http://schemas.datacontract.org/2004/07/Viviot.Infrastructure.Dto.Service">
      <d3p1:DailyOptions>
        <d3p1:Checkin>PT0S</d3p1:Checkin>
        <d3p1:Checkout>PT0S</d3p1:Checkout>
      </d3p1:DailyOptions>
      <d3p1:Id>00000000-0000-0000-0000-000000000000</d3p1:Id>
      <d3p1:TimespanOptions>
        <d3p1:Increment>0</d3p1:Increment>
        <d3p1:IncrementPriceMultiplier>0</d3p1:IncrementPriceMultiplier>
        <d3p1:MaxDuration>0</d3p1:MaxDuration>
        <d3p1:MinDuration>0</d3p1:MinDuration>
      </d3p1:TimespanOptions>
      <d3p1:Type>Daily</d3p1:Type>
    </d2p1:TimeOption>
    <d2p1:VATPercentage>0</d2p1:VATPercentage>
  </Data>
</ServiceResponse>