BokaMera.API.Host

GetVossPackage

The following routes are available for this service:
GET	/voss/packages	get voss package

**GetVossPackage** Parameters:
Name	Parameter	Data Type	Required	Description
PackageId	query	Guid?	No	The package id; if not passed the configured BokaMera package will be used.

**PackageResult** Parameters:
Name	Parameter	Data Type	Required
PackageStatus	form	PackageStatusEnum	No
Id	form	Guid	No
VersionId	form	Guid	No
SourceVersionId	form	Guid?	No
Name	form	string	Yes
ExternalId	form	string	Yes
Tiers	form	List<PackageTierDto>	Yes
Plans	form	List<PackagePlanDto>	Yes
ChargePlans	form	List<PackageChargePlanDto>	Yes
SalesChannels	form	List<PackageSalesChannelDto>	Yes
TargetGroups	form	List<PackageTargetGroupDto>	Yes
ScheduledChanges	form	List<PackageScheduledChangeResult>	Yes

**PackageStatusEnum** Enum:
Draft
Staged
Published
Archived
Discarded

**PackageTierDto** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid	No
Name	form	string	Yes
ExternalId	form	string	Yes
ProductGroups	form	List<PackageProductGroupDto>	Yes

**PackageProductGroupDto** 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<PackageProductDto>	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

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

**PackagePlanDto** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid	No
Name	form	string	Yes
ExternalId	form	string	Yes
BindingPeriodCycle	form	BindingPeriodCycleDto	Yes
SubscriptionBillingPeriodCycle	form	BillingPeriodCycleDto	Yes
UsageBillingPeriodCycle	form	BillingPeriodCycleDto	Yes

**BindingPeriodCycleDto** Parameters:
Name	Parameter	Data Type	Required	Description
PeriodEndAction	form	PeriodEndActionEnum	No
Length	form	TimeLengthDto	Yes

**PeriodEndActionEnum** Enum:
Renew
Terminate

**TimeLengthDto** Parameters:
Name	Parameter	Data Type	Required	Description
Unit	form	UnitEnum	No
Value	form	int	No

**UnitEnum** Enum:
Day
Month
Year

**BillingPeriodCycleDto** Parameters:
Name	Parameter	Data Type	Required
Length	form	TimeLengthDto	Yes
InvoiceDateOffset	form	PeriodDateOffsetDto	Yes
RenewalDateOffset	form	PeriodDateOffsetDto	Yes

**PeriodDateOffsetDto** Parameters:
Name	Parameter	Data Type	Required
PeriodAnchor	form	PeriodAnchorEnum	No
Length	form	TimeLengthDto	Yes
ValueAnchor	form	int?	No

**PeriodAnchorEnum** Enum:
PeriodCreated
PeriodStart
PeriodEnd

**PackageChargePlanDto** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid	No
TierId	form	Guid	No
PlanId	form	Guid	No
ProductGroupPricings	form	List<ProductGroupPricingDto>	Yes

**ProductGroupPricingDto** Parameters:
Name	Parameter	Data Type	Required
ProductGroupId	form	Guid	No
ArticleNumber	form	string	Yes
Price	form	double	No
ProductPricings	form	List<ProductPricingDto>	Yes

**ProductPricingDto** Parameters:
Name	Parameter	Data Type	Required
PricingScheme	form	PricingSchemeEnum	No
ProductId	form	Guid	No
IncludedQuantity	form	int?	No
MaxQuantity	form	int?	No
UnitPrice	form	double?	No
TierPricing	form	List<ProductTierPricingDto>	Yes
ArticleNumber	form	string	Yes

**PricingSchemeEnum** Enum:
UnitPricing
TierPricing

**ProductTierPricingDto** Parameters:
Name	Parameter	Data Type	Required
Index	form	int	No
UnitPrice	form	double	No
FlatPrice	form	double	No
RepeatEvery	form	int?	No
UpperLimit	form	int?	No

**PackageSalesChannelDto** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid	No
Name	form	string	Yes
Description	form	string	Yes
ValidFrom	form	DateTime?	No
ValidTo	form	DateTime?	No

**PackageTargetGroupDto** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid	No
Name	form	string	Yes
IsDefault	form	bool	No
ExternalId	form	string	Yes

**PackageScheduledChangeResult** Parameters:
Name	Parameter	Data Type	Required
Status	form	StatusEnum	No
Id	form	Guid	No
VersionId	form	Guid	No
Package	form	PackageScheduledChangeResultDto	Yes
ScheduledDate	form	DateTime	No

**PackageScheduledChangeResultDto** Parameters:
Name	Parameter	Data Type	Required	Description
Status	form	PackageStatusEnum?	No
Name	form	string	Yes

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

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

<PackageResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.VossIntegration.ApiTools.Model">
  <chargePlans>
    <PackageChargePlanDto i:nil="true" />
  </chargePlans>
  <externalId>String</externalId>
  <id>00000000-0000-0000-0000-000000000000</id>
  <name>String</name>
  <plans>
    <PackagePlanDto i:nil="true" />
  </plans>
  <salesChannels>
    <PackageSalesChannelDto i:nil="true" />
  </salesChannels>
  <scheduledChanges>
    <PackageScheduledChangeResult i:nil="true" />
  </scheduledChanges>
  <sourceVersionId>00000000-0000-0000-0000-000000000000</sourceVersionId>
  <status>Draft</status>
  <targetGroups>
    <PackageTargetGroupDto i:nil="true" />
  </targetGroups>
  <tiers>
    <PackageTierDto i:nil="true" />
  </tiers>
  <versionId>00000000-0000-0000-0000-000000000000</versionId>
</PackageResult>