| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| GET | /voss/tiers/{TierId} | gets voss tiers |
|---|
namespace BokaMera.API.ServiceModel.Dtos
open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
type ProductGroupTypeEnum =
| Optional = 0
| Included = 1
type TypeEnum =
| AtSubscriptionBillingPeriodEnd = 0
| AtBindingPeriodEnd = 1
| Immediately = 2
[<DataContract(Name="ProductGroupTagDto")>]
[<AllowNullLiteral>]
type ProductGroupTagDto() =
[<DataMember(Name="type", IsRequired=true)>]
member val Type:TypeEnum = new TypeEnum() with get,set
[<DataMember(Name="tag", IsRequired=true)>]
member val Tag:String = null with get,set
type ProductTypeEnum =
| Main = 0
| Addon = 1
| License = 2
| Usage = 3
type StatusEnum =
| Active = 0
| Terminated = 1
[<DataContract(Name="TierProductDto")>]
[<AllowNullLiteral>]
type TierProductDto() =
[<DataMember(Name="type", IsRequired=true)>]
member val ProductType:ProductTypeEnum = new ProductTypeEnum() with get,set
[<DataMember(Name="status", IsRequired=true)>]
member val Status:StatusEnum = new StatusEnum() with get,set
[<DataMember(Name="id", IsRequired=true)>]
member val Id:Guid = new Guid() with get,set
[<DataMember(Name="name", IsRequired=true)>]
member val Name:String = null with get,set
[<DataMember(Name="externalId")>]
member val ExternalId:String = null with get,set
[<DataMember(Name="articleNumber", IsRequired=true)>]
member val ArticleNumber:String = null with get,set
[<DataContract(Name="TierProductGroupDto")>]
[<AllowNullLiteral>]
type TierProductGroupDto() =
[<DataMember(Name="productGroupType", IsRequired=true)>]
member val ProductGroupType:ProductGroupTypeEnum = new ProductGroupTypeEnum() with get,set
[<DataMember(Name="id", IsRequired=true)>]
member val Id:Guid = new Guid() with get,set
[<DataMember(Name="name", IsRequired=true)>]
member val Name:String = null with get,set
[<DataMember(Name="externalId")>]
member val ExternalId:String = null with get,set
[<DataMember(Name="tags", EmitDefaultValue=false)>]
member val Tags:ResizeArray<ProductGroupTagDto> = null with get,set
[<DataMember(Name="products", EmitDefaultValue=false)>]
member val Products:ResizeArray<TierProductDto> = null with get,set
[<DataContract(Name="TierResult")>]
[<AllowNullLiteral>]
type TierResult() =
[<DataMember(Name="id", IsRequired=true)>]
member val Id:Guid = new Guid() with get,set
[<DataMember(Name="versionId", IsRequired=true)>]
member val VersionId:Guid = new Guid() with get,set
[<DataMember(Name="name", IsRequired=true)>]
member val Name:String = null with get,set
[<DataMember(Name="externalId")>]
member val ExternalId:String = null with get,set
[<DataMember(Name="rank")>]
member val Rank:Int32 = new Int32() with get,set
[<DataMember(Name="productGroups", EmitDefaultValue=false)>]
member val ProductGroups:ResizeArray<TierProductGroupDto> = null with get,set
[<ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)>]
[<AllowNullLiteral>]
type 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.")>]
member val TierId:Guid = new Guid() with get,set
member val PackageId:Nullable<Guid> = new Nullable<Guid>() with get,set
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
name: String,
externalId: String,
rank: 0,
productGroups:
[
{
}
]
}