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 java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


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

    /**
    * Procut Group id to get
    */
    @ApiMember(Description="Procut Group id to get", IsRequired=true)
    open var ProductGroupId:UUID? = null

    /**
    * Tier id required because it is used it voss url
    */
    @ApiMember(Description="Tier id required because it is used it voss url", IsRequired=true)
    open var TierId:UUID? = null
}

@DataContract(Name="ProductGroupResult")
open class ProductGroupResult
{
    @DataMember(Name="productGroupType", IsRequired=true)
    @SerializedName("productGroupType")
    open var ProductGroupType:ProductGroupTypeEnum? = null

    @DataMember(Name="id", IsRequired=true)
    @SerializedName("id")
    open var Id:UUID? = null

    @DataMember(Name="versionId", IsRequired=true)
    @SerializedName("versionId")
    open var VersionId:UUID? = null

    @DataMember(Name="name", IsRequired=true)
    @SerializedName("name")
    open var Name:String? = null

    @DataMember(Name="externalId")
    @SerializedName("externalId")
    open var ExternalId:String? = null

    @DataMember(Name="products", EmitDefaultValue=false)
    @SerializedName("products")
    open var Products:ArrayList<ProductGroupProductDto> = ArrayList<ProductGroupProductDto>()

    @DataMember(Name="tags", EmitDefaultValue=false)
    @SerializedName("tags")
    open var Tags:ArrayList<ProductGroupTagDto> = ArrayList<ProductGroupTagDto>()
}

enum class ProductGroupTypeEnum
{
    Optional,
    Included,
}

@DataContract(Name="ProductGroupProductDto")
open class ProductGroupProductDto
{
    @DataMember(Name="type", IsRequired=true)
    @SerializedName("type")
    open var ProductType:ProductTypeEnum? = null

    @DataMember(Name="status", IsRequired=true)
    @SerializedName("status")
    open var Status:StatusEnum? = null

    @DataMember(Name="id", IsRequired=true)
    @SerializedName("id")
    open var Id:UUID? = null

    @DataMember(Name="name", IsRequired=true)
    @SerializedName("name")
    open var Name:String? = null

    @DataMember(Name="externalId")
    @SerializedName("externalId")
    open var ExternalId:String? = null

    @DataMember(Name="articleNumber", IsRequired=true)
    @SerializedName("articleNumber")
    open var ArticleNumber:String? = null
}

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

enum class StatusEnum
{
    Active,
    Terminated,
}

@DataContract(Name="ProductGroupTagDto")
open class ProductGroupTagDto
{
    @DataMember(Name="type", IsRequired=true)
    @SerializedName("type")
    open var Type:TypeEnum? = null

    @DataMember(Name="tag", IsRequired=true)
    @SerializedName("tag")
    open var Tag:String? = null
}

enum class TypeEnum
{
    AtSubscriptionBillingPeriodEnd,
    AtBindingPeriodEnd,
    Immediately,
}

Kotlin 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>