BokaMera.API.Host

GetVossTier

**Requires Authentication**
Requires any of the roles:	bookingsupplier-administrator-write, superadmin

The following routes are available for this service:
GET	/voss/tiers/{TierId}	gets voss tiers

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BokaMera.API.ServiceModel.Dtos;
using BokaMera.VossIntegration.ApiTools.Model;
using BokaMera.VossIntegration.ApiTools.Enums;

namespace BokaMera.API.ServiceModel.Dtos
{
    [ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)]
    public partial class GetVossTier
    {
        ///<summary>
        ///The company id, if empty will use the company id for the user you are logged in with.
        ///</summary>
        [ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")]
        public virtual Guid TierId { get; set; }

        public virtual Guid? PackageId { get; set; }
    }

}

namespace BokaMera.VossIntegration.ApiTools.Enums
{
    public enum ProductGroupTypeEnum
    {
        Optional,
        Included,
    }

    public enum ProductTypeEnum
    {
        Main,
        Addon,
        License,
        Usage,
    }

}

namespace BokaMera.VossIntegration.ApiTools.Model
{
    [DataContract(Name="ProductGroupTagDto")]
    public partial class ProductGroupTagDto
    {
        [DataMember(Name="type", IsRequired=true)]
        public virtual TypeEnum Type { get; set; }

        [DataMember(Name="tag", IsRequired=true)]
        public virtual string Tag { get; set; }
        public enum TypeEnum
        {
            AtSubscriptionBillingPeriodEnd,
            AtBindingPeriodEnd,
            Immediately,
        }

    }

    [DataContract(Name="TierProductDto")]
    public partial class TierProductDto
    {
        [DataMember(Name="type", IsRequired=true)]
        public virtual ProductTypeEnum ProductType { get; set; }

        [DataMember(Name="status", IsRequired=true)]
        public virtual StatusEnum Status { get; set; }

        [DataMember(Name="id", IsRequired=true)]
        public virtual Guid Id { get; set; }

        [DataMember(Name="name", IsRequired=true)]
        public virtual string Name { get; set; }

        [DataMember(Name="externalId")]
        public virtual string ExternalId { get; set; }

        [DataMember(Name="articleNumber", IsRequired=true)]
        public virtual string ArticleNumber { get; set; }
        public enum StatusEnum
        {
            Active,
            Terminated,
        }

    }

    [DataContract(Name="TierProductGroupDto")]
    public partial class TierProductGroupDto
    {
        [DataMember(Name="productGroupType", IsRequired=true)]
        public virtual ProductGroupTypeEnum ProductGroupType { get; set; }

        [DataMember(Name="id", IsRequired=true)]
        public virtual Guid Id { get; set; }

        [DataMember(Name="name", IsRequired=true)]
        public virtual string Name { get; set; }

        [DataMember(Name="externalId")]
        public virtual string ExternalId { get; set; }

        [DataMember(Name="tags", EmitDefaultValue=false)]
        public virtual List<ProductGroupTagDto> Tags { get; set; } = [];

        [DataMember(Name="products", EmitDefaultValue=false)]
        public virtual List<TierProductDto> Products { get; set; } = [];
    }

    [DataContract(Name="TierResult")]
    public partial class TierResult
    {
        [DataMember(Name="id", IsRequired=true)]
        public virtual Guid Id { get; set; }

        [DataMember(Name="versionId", IsRequired=true)]
        public virtual Guid VersionId { get; set; }

        [DataMember(Name="name", IsRequired=true)]
        public virtual string Name { get; set; }

        [DataMember(Name="externalId")]
        public virtual string ExternalId { get; set; }

        [DataMember(Name="rank")]
        public virtual int Rank { get; set; }

        [DataMember(Name="productGroups", EmitDefaultValue=false)]
        public virtual List<TierProductGroupDto> ProductGroups { get; set; } = [];
    }

}

C# GetVossTier DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /voss/tiers/{TierId} HTTP/1.1 
Host: api.bokamera.se 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"name":"String","externalId":"String","rank":0,"productGroups":[{}]}