BokaMera.API.Host

<back to all web services

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
GetVossProductGroup Parameters:
NameParameterData TypeRequiredDescription
PackageIdqueryGuid?NoPassed if we have multilpe packages
ProductGroupIdpathGuidYesProcut Group id to get
TierIdqueryGuidYesTier id required because it is used it voss url
ProductGroupResult Parameters:
NameParameterData TypeRequiredDescription
ProductGroupTypeformProductGroupTypeEnumNo
IdformGuidNo
VersionIdformGuidNo
NameformstringYes
ExternalIdformstringYes
ProductsformList<ProductGroupProductDto>Yes
TagsformList<ProductGroupTagDto>Yes
ProductGroupTypeEnum Enum:
Optional
Included
ProductGroupProductDto Parameters:
NameParameterData TypeRequiredDescription
ProductTypeformProductTypeEnumNo
StatusformStatusEnumNo
IdformGuidNo
NameformstringYes
ExternalIdformstringYes
ArticleNumberformstringYes
ProductTypeEnum Enum:
Main
Addon
License
Usage
StatusEnum Enum:
Active
Terminated
ProductGroupTagDto Parameters:
NameParameterData TypeRequiredDescription
TypeformTypeEnumNo
TagformstringYes
TypeEnum Enum:
AtSubscriptionBillingPeriodEnd
AtBindingPeriodEnd
Immediately

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

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.bookmore.com 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"productGroupType":"Optional","name":"String","externalId":"String","products":[{}],"tags":[{}]}