BokaMera.API.Host

GetVossProductGroup

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

The following routes are available for this service:
GET	/voss/productGroups/{ProductGroupId}	gets voss product group

import Foundation
import ServiceStack

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
public class GetVossProductGroup : Codable
{
    /**
    * Passed if we have multilpe packages
    */
    // @ApiMember(Description="Passed if we have multilpe packages")
    public var packageId:String?

    /**
    * Procut Group id to get
    */
    // @ApiMember(Description="Procut Group id to get", IsRequired=true)
    public var productGroupId:String

    /**
    * Tier id required because it is used it voss url
    */
    // @ApiMember(Description="Tier id required because it is used it voss url", IsRequired=true)
    public var tierId:String

    required public init(){}
}

// @DataContract(Name="ProductGroupResult")
public class ProductGroupResult : Codable
{
    // @DataMember(Name="productGroupType", IsRequired=true)
    public var productGroupType:ProductGroupTypeEnum

    // @DataMember(Name="id", IsRequired=true)
    public var id:String

    // @DataMember(Name="versionId", IsRequired=true)
    public var versionId:String

    // @DataMember(Name="name", IsRequired=true)
    public var name:String

    // @DataMember(Name="externalId")
    public var externalId:String

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

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

    required public init(){}
}

public enum ProductGroupTypeEnum : String, Codable
{
    case Optional
    case Included
}

// @DataContract(Name="ProductGroupProductDto")
public class ProductGroupProductDto : Codable
{
    // @DataMember(Name="type", IsRequired=true)
    public var type:ProductTypeEnum

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

    // @DataMember(Name="id", IsRequired=true)
    public var id:String

    // @DataMember(Name="name", IsRequired=true)
    public var name:String

    // @DataMember(Name="externalId")
    public var externalId:String

    // @DataMember(Name="articleNumber", IsRequired=true)
    public var articleNumber:String

    required public init(){}
}

public enum ProductTypeEnum : String, Codable
{
    case Main
    case Addon
    case License
    case Usage
}

public enum StatusEnum : String, Codable
{
    case Active
    case Terminated
}

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

    // @DataMember(Name="tag", IsRequired=true)
    public var tag:String

    required public init(){}
}

public enum TypeEnum : String, Codable
{
    case AtSubscriptionBillingPeriodEnd
    case AtBindingPeriodEnd
    case Immediately
}

Swift GetVossProductGroup DTOs

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.

GET /voss/productGroups/{ProductGroupId} HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml

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

<ProductGroupResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.VossIntegration.ApiTools.Model">
  <externalId>String</externalId>
  <id>00000000-0000-0000-0000-000000000000</id>
  <name>String</name>
  <productGroupType>Optional</productGroupType>
  <products>
    <ProductGroupProductDto i:nil="true" />
  </products>
  <tags>
    <ProductGroupTagDto i:nil="true" />
  </tags>
  <versionId>00000000-0000-0000-0000-000000000000</versionId>
</ProductGroupResult>