BokaMera.API.Host

CancelLicense

**Requires Authentication**
Requires any of the roles:	bookingsupplier-administrator-write, superadmin

The following routes are available for this service:
DELETE	/licenses/company/{Id}	Cancel a license to a company	Cancel an existing license to the company for the logged in user. The license will have it end date set to after it's period of notice.

**CancelLicense** Parameters:
Name	Parameter	Data Type	Required	Description
CompanyId	query	Guid?	No	The company id, if empty will use the company id for the user you are logged in with.
Id	path	int	Yes	Id of the license

**CompanyLicenseQueryResponse** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
TypeId	form	int	No
Type	form	LicenseTypeQueryResponse	Yes
ValidFrom	form	DateTime	No
ValidTo	form	DateTime	No
VossSubscriptionId	form	Guid	No
VossSubscription	form	VossSubscriptionResponse	Yes
MetaData	form	string	Yes
Active	form	bool	No
Canceled	form	bool	No
Updated	form	DateTime	No
Created	form	DateTime	No

**LicenseTypeQueryResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	int	No	The license type id
Name	form	string	Yes	The license type name
Description	form	string	Yes	The license type description
IsExtraLicenseOption	form	bool	No	If the license type is not a standard license but instead an extra license option. An example would be sending newsletter license.
PeriodOfNoticeDays	form	int	No	The period of notice for the license in days.
Items	form	List<LicenseItemsResponse>	Yes	The license items for the license type
Prices	form	List<LicensePriceResponse>	Yes	The license prices in each country for the license type

**LicenseItemsResponse** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Name	form	string	Yes
AllowedItems	form	int	No

**LicensePriceResponse** Parameters:
Name	Parameter	Data Type	Required
LicenseTypeId	form	int	No
CountryId	form	string	Yes
Price	form	int	No
Country	form	Country	Yes
LicensePlanId	form	int	No

**Country** Parameters:
Name	Parameter	Data Type	Required
CurrencyId	form	string	Yes
CurrencyInfo	form	Currency	Yes
Name	form	string	Yes
Culture	form	string	No
TimeZone	form	string	No
ModifiedDate	form	DateTimeOffset?	No
Id	form	string	Yes

**Currency** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	Yes
CurrencySign	form	string	Yes
Active	form	bool	Yes
ModifiedDate	form	DateTimeOffset?	No
Id	form	string	Yes

**VossSubscriptionResponse** Parameters:
Name	Parameter	Data Type	Required
SubscriptionBillingPeriodStartDate	form	DateTime	No
SubscriptionBillingPeriodEndDate	form	DateTime	No
Tier	form	TierResponse	Yes

**TierResponse** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid	No
Name	form	string	Yes
ProductGroups	form	List<ProductGroupResponse>	Yes

**ProductGroupResponse** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid	No
Name	form	string	Yes
TierId	form	Guid	No

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.

DELETE /licenses/company/{Id} HTTP/1.1 
Host: api.bookmore.com 
Accept: application/xml

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

<CompanyLicenseQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Active>false</Active>
  <Canceled>false</Canceled>
  <Created>0001-01-01T00:00:00</Created>
  <Id>0</Id>
  <MetaData>String</MetaData>
  <Type>
    <Description>String</Description>
    <Id>0</Id>
    <IsExtraLicenseOption>false</IsExtraLicenseOption>
    <Items>
      <LicenseItemsResponse>
        <AllowedItems>0</AllowedItems>
        <Id>0</Id>
        <Name>String</Name>
      </LicenseItemsResponse>
    </Items>
    <Name>String</Name>
    <PeriodOfNoticeDays>0</PeriodOfNoticeDays>
    <Prices>
      <LicensePriceResponse>
        <Country xmlns:d5p1="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Db">
          <d5p1:Culture>String</d5p1:Culture>
          <d5p1:CurrencyId>String</d5p1:CurrencyId>
          <d5p1:CurrencyInfo>
            <d5p1:Active>false</d5p1:Active>
            <d5p1:CurrencySign>String</d5p1:CurrencySign>
            <d5p1:Id>String</d5p1:Id>
            <d5p1:ModifiedDate xmlns:d7p1="http://schemas.datacontract.org/2004/07/System">
              <d7p1:DateTime>0001-01-01T00:00:00Z</d7p1:DateTime>
              <d7p1:OffsetMinutes>0</d7p1:OffsetMinutes>
            </d5p1:ModifiedDate>
            <d5p1:Name>String</d5p1:Name>
          </d5p1:CurrencyInfo>
          <d5p1:Id>String</d5p1:Id>
          <d5p1:ModifiedDate xmlns:d6p1="http://schemas.datacontract.org/2004/07/System">
            <d6p1:DateTime>0001-01-01T00:00:00Z</d6p1:DateTime>
            <d6p1:OffsetMinutes>0</d6p1:OffsetMinutes>
          </d5p1:ModifiedDate>
          <d5p1:Name>String</d5p1:Name>
          <d5p1:TimeZone>String</d5p1:TimeZone>
        </Country>
        <CountryId>String</CountryId>
        <LicensePlanId>0</LicensePlanId>
        <LicenseTypeId>0</LicenseTypeId>
        <Price>0</Price>
      </LicensePriceResponse>
    </Prices>
  </Type>
  <TypeId>0</TypeId>
  <Updated>0001-01-01T00:00:00</Updated>
  <ValidFrom>0001-01-01T00:00:00</ValidFrom>
  <ValidTo>0001-01-01T00:00:00</ValidTo>
  <VossSubscription xmlns:d2p1="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Helpers.VossHelper">
    <d2p1:SubscriptionBillingPeriodEndDate>0001-01-01T00:00:00</d2p1:SubscriptionBillingPeriodEndDate>
    <d2p1:SubscriptionBillingPeriodStartDate>0001-01-01T00:00:00</d2p1:SubscriptionBillingPeriodStartDate>
    <d2p1:Tier>
      <d2p1:Id>00000000-0000-0000-0000-000000000000</d2p1:Id>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:ProductGroups>
        <d2p1:ProductGroupResponse>
          <d2p1:Id>00000000-0000-0000-0000-000000000000</d2p1:Id>
          <d2p1:Name>String</d2p1:Name>
          <d2p1:TierId>00000000-0000-0000-0000-000000000000</d2p1:TierId>
        </d2p1:ProductGroupResponse>
      </d2p1:ProductGroups>
    </d2p1:Tier>
  </VossSubscription>
  <VossSubscriptionId>00000000-0000-0000-0000-000000000000</VossSubscriptionId>
</CompanyLicenseQueryResponse>