BokaMera.API.Host

GetVossTier

The following routes are available for this service:
GET	/voss/tiers/{TierId}	gets voss tiers

**GetVossTier** Parameters:
Name	Parameter	Data Type	Required	Description
TierId	path	Guid	No	The company id, if empty will use the company id for the user you are logged in with.
PackageId	query	Guid?	No

**TierResult** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid	No
VersionId	form	Guid	No
Name	form	string	Yes
ExternalId	form	string	Yes
Rank	form	int	No
ProductGroups	form	List<TierProductGroupDto>	Yes

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

**ProductGroupTypeEnum** Enum:
Optional
Included

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

**TypeEnum** Enum:
AtSubscriptionBillingPeriodEnd
AtBindingPeriodEnd
Immediately

**TierProductDto** 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

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/tiers/{TierId} HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/xml

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

<TierResult 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>
  <productGroups>
    <TierProductGroupDto i:nil="true" />
  </productGroups>
  <rank>0</rank>
  <versionId>00000000-0000-0000-0000-000000000000</versionId>
</TierResult>