BokaMera.API.Host

<back to all web services

GetVossTier

export enum ProductGroupTypeEnum
{
    Optional = 'Optional',
    Included = 'Included',
}

export enum TypeEnum
{
    AtSubscriptionBillingPeriodEnd = 'AtSubscriptionBillingPeriodEnd',
    AtBindingPeriodEnd = 'AtBindingPeriodEnd',
    Immediately = 'Immediately',
}

// @DataContract(Name="ProductGroupTagDto")
export class ProductGroupTagDto
{
    // @DataMember(Name="type", IsRequired=true)
    public type: TypeEnum;

    // @DataMember(Name="tag", IsRequired=true)
    public tag: string;

    public constructor(init?: Partial<ProductGroupTagDto>) { (Object as any).assign(this, init); }
}

export enum ProductTypeEnum
{
    Main = 'Main',
    Addon = 'Addon',
    License = 'License',
    Usage = 'Usage',
}

export enum StatusEnum
{
    Active = 'Active',
    Terminated = 'Terminated',
}

// @DataContract(Name="TierProductDto")
export class TierProductDto
{
    // @DataMember(Name="type", IsRequired=true)
    public type: ProductTypeEnum;

    // @DataMember(Name="status", IsRequired=true)
    public status: StatusEnum;

    // @DataMember(Name="id", IsRequired=true)
    public id: string;

    // @DataMember(Name="name", IsRequired=true)
    public name: string;

    // @DataMember(Name="externalId")
    public externalId: string;

    // @DataMember(Name="articleNumber", IsRequired=true)
    public articleNumber: string;

    public constructor(init?: Partial<TierProductDto>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="TierProductGroupDto")
export class TierProductGroupDto
{
    // @DataMember(Name="productGroupType", IsRequired=true)
    public productGroupType: ProductGroupTypeEnum;

    // @DataMember(Name="id", IsRequired=true)
    public id: string;

    // @DataMember(Name="name", IsRequired=true)
    public name: string;

    // @DataMember(Name="externalId")
    public externalId: string;

    // @DataMember(Name="tags", EmitDefaultValue=false)
    public tags: ProductGroupTagDto[];

    // @DataMember(Name="products", EmitDefaultValue=false)
    public products: TierProductDto[];

    public constructor(init?: Partial<TierProductGroupDto>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="TierResult")
export class TierResult
{
    // @DataMember(Name="id", IsRequired=true)
    public id: string;

    // @DataMember(Name="versionId", IsRequired=true)
    public versionId: string;

    // @DataMember(Name="name", IsRequired=true)
    public name: string;

    // @DataMember(Name="externalId")
    public externalId: string;

    // @DataMember(Name="rank")
    public rank: number;

    // @DataMember(Name="productGroups", EmitDefaultValue=false)
    public productGroups: TierProductGroupDto[];

    public constructor(init?: Partial<TierResult>) { (Object as any).assign(this, init); }
}

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
export class GetVossTier
{
    /** @description The company id, if empty will use the company id for the user you are logged in with. */
    // @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
    public TierId: string;

    public PackageId?: string;

    public constructor(init?: Partial<GetVossTier>) { (Object as any).assign(this, init); }
}

TypeScript GetVossTier DTOs

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

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

<TierResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VossIntegration.ApiTools.Model">
  <externalId>String</externalId>
  <id>00000000-0000-0000-0000-000000000000</id>
  <name>String</name>
  <productGroups>
    <TierProductGroupDto i:nil="true" />
  </productGroups>
  <rank>0</rank>
  <versionId>00000000-0000-0000-0000-000000000000</versionId>
</TierResult>