BokaMera.API.Host

<back to all web services

GetVossTier

The following routes are available for this service:
GET/voss/tiers/{TierId}gets voss tiers
GetVossTier Parameters:
NameParameterData TypeRequiredDescription
TierIdpathGuidNoThe company id, if empty will use the company id for the user you are logged in with.
PackageIdqueryGuid?No
TierResult Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
VersionIdformGuidNo
NameformstringYes
ExternalIdformstringYes
RankformintNo
ProductGroupsformList<TierProductGroupDto>Yes
TierProductGroupDto Parameters:
NameParameterData TypeRequiredDescription
ProductGroupTypeformProductGroupTypeEnumNo
IdformGuidNo
NameformstringYes
ExternalIdformstringYes
TagsformList<ProductGroupTagDto>Yes
ProductsformList<TierProductDto>Yes
ProductGroupTypeEnum Enum:
Optional
Included
ProductGroupTagDto Parameters:
NameParameterData TypeRequiredDescription
TypeformTypeEnumNo
TagformstringYes
TypeEnum Enum:
AtSubscriptionBillingPeriodEnd
AtBindingPeriodEnd
Immediately
TierProductDto Parameters:
NameParameterData TypeRequiredDescription
ProductTypeformProductTypeEnumNo
StatusformStatusEnumNo
IdformGuidNo
NameformstringYes
ExternalIdformstringYes
ArticleNumberformstringYes
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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"name":"String","externalId":"String","rank":0,"productGroups":[{}]}