BokaMera.API.Host

GetVossProductGroup

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

**GetVossProductGroup** Parameters:
Name	Parameter	Data Type	Required	Description
PackageId	query	Guid?	No	Passed if we have multilpe packages
ProductGroupId	path	Guid	Yes	Procut Group id to get
TierId	query	Guid	Yes	Tier id required because it is used it voss url

**ProductGroupResult** Parameters:
Name	Parameter	Data Type	Required
ProductGroupType	form	ProductGroupTypeEnum	No
Id	form	Guid	No
VersionId	form	Guid	No
Name	form	string	Yes
ExternalId	form	string	Yes
Products	form	List<ProductGroupProductDto>	Yes
Tags	form	List<ProductGroupTagDto>	Yes

**ProductGroupTypeEnum** Enum:
Optional
Included

**ProductGroupProductDto** Parameters:
Name	Parameter	Data Type	Required
ProductType	form	ProductTypeEnum	No
Status	form	StatusEnum	No
Id	form	Guid	No
Name	form	string	Yes
ExternalId	form	string	Yes
ArticleNumber	form	string	Yes

**ProductTypeEnum** Enum:
Main
Addon
License
Usage

**StatusEnum** Enum:
Active
Terminated

**ProductGroupTagDto** Parameters:
Name	Parameter	Data Type	Required	Description
Type	form	TypeEnum	No
Tag	form	string	Yes

**TypeEnum** Enum:
AtSubscriptionBillingPeriodEnd
AtBindingPeriodEnd
Immediately

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>