BokaMera.API.Host

GetVossProductGroup

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

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


class ProductGroupTypeEnum(str, Enum):
    OPTIONAL = 'Optional'
    INCLUDED = 'Included'


class ProductTypeEnum(str, Enum):
    MAIN = 'Main'
    ADDON = 'Addon'
    LICENSE = 'License'
    USAGE = 'Usage'


class StatusEnum(str, Enum):
    ACTIVE = 'Active'
    TERMINATED = 'Terminated'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ProductGroupProductDto:
    product_type: Optional[ProductTypeEnum] = None
    status: Optional[StatusEnum] = None
    id: Optional[str] = None
    name: Optional[str] = None
    external_id: Optional[str] = None
    article_number: Optional[str] = None


class TypeEnum(str, Enum):
    AT_SUBSCRIPTION_BILLING_PERIOD_END = 'AtSubscriptionBillingPeriodEnd'
    AT_BINDING_PERIOD_END = 'AtBindingPeriodEnd'
    IMMEDIATELY = 'Immediately'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ProductGroupTagDto:
    type: Optional[TypeEnum] = None
    tag: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ProductGroupResult:
    product_group_type: Optional[ProductGroupTypeEnum] = None
    id: Optional[str] = None
    version_id: Optional[str] = None
    name: Optional[str] = None
    external_id: Optional[str] = None
    products: Optional[List[ProductGroupProductDto]] = None
    tags: Optional[List[ProductGroupTagDto]] = None


# @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetVossProductGroup:
    # @ApiMember(Description="Passed if we have multilpe packages")
    package_id: Optional[str] = None
    """
    Passed if we have multilpe packages
    """


    # @ApiMember(Description="Procut Group id to get", IsRequired=true)
    product_group_id: Optional[str] = None
    """
    Procut Group id to get
    """


    # @ApiMember(Description="Tier id required because it is used it voss url", IsRequired=true)
    tier_id: Optional[str] = None
    """
    Tier id required because it is used it voss url
    """

Python 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: testapi.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/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>