| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| 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. |
|---|
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;
public class dtos
{
@ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
@ValidateRequest(Validator="IsAuthenticated")
public static class CancelLicense implements ICompany
{
/**
* The company id, if empty will use the company id for the user you are logged in with.
*/
@ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
public UUID CompanyId = null;
/**
* Id of the license
*/
@ApiMember(Description="Id of the license", IsRequired=true, ParameterType="path")
public Integer Id = null;
public UUID getCompanyId() { return CompanyId; }
public CancelLicense setCompanyId(UUID value) { this.CompanyId = value; return this; }
public Integer getId() { return Id; }
public CancelLicense setId(Integer value) { this.Id = value; return this; }
}
public static class CompanyLicenseQueryResponse
{
public Integer Id = null;
public Integer TypeId = null;
public LicenseTypeQueryResponse Type = null;
public Date ValidFrom = null;
public Date ValidTo = null;
public UUID VossSubscriptionId = null;
public VossSubscriptionResponse VossSubscription = null;
public String MetaData = null;
public Boolean Active = null;
public Boolean Canceled = null;
public Date Updated = null;
public Date Created = null;
public Integer getId() { return Id; }
public CompanyLicenseQueryResponse setId(Integer value) { this.Id = value; return this; }
public Integer getTypeId() { return TypeId; }
public CompanyLicenseQueryResponse setTypeId(Integer value) { this.TypeId = value; return this; }
public LicenseTypeQueryResponse getType() { return Type; }
public CompanyLicenseQueryResponse setType(LicenseTypeQueryResponse value) { this.Type = value; return this; }
public Date getValidFrom() { return ValidFrom; }
public CompanyLicenseQueryResponse setValidFrom(Date value) { this.ValidFrom = value; return this; }
public Date getValidTo() { return ValidTo; }
public CompanyLicenseQueryResponse setValidTo(Date value) { this.ValidTo = value; return this; }
public UUID getVossSubscriptionId() { return VossSubscriptionId; }
public CompanyLicenseQueryResponse setVossSubscriptionId(UUID value) { this.VossSubscriptionId = value; return this; }
public VossSubscriptionResponse getVossSubscription() { return VossSubscription; }
public CompanyLicenseQueryResponse setVossSubscription(VossSubscriptionResponse value) { this.VossSubscription = value; return this; }
public String getMetaData() { return MetaData; }
public CompanyLicenseQueryResponse setMetaData(String value) { this.MetaData = value; return this; }
public Boolean isActive() { return Active; }
public CompanyLicenseQueryResponse setActive(Boolean value) { this.Active = value; return this; }
public Boolean isCanceled() { return Canceled; }
public CompanyLicenseQueryResponse setCanceled(Boolean value) { this.Canceled = value; return this; }
public Date getUpdated() { return Updated; }
public CompanyLicenseQueryResponse setUpdated(Date value) { this.Updated = value; return this; }
public Date getCreated() { return Created; }
public CompanyLicenseQueryResponse setCreated(Date value) { this.Created = value; return this; }
}
public static class LicenseTypeQueryResponse
{
/**
* The license type id
*/
@ApiMember(Description="The license type id")
public Integer Id = null;
/**
* The license type name
*/
@ApiMember(Description="The license type name")
public String Name = null;
/**
* The license type description
*/
@ApiMember(Description="The license type description")
public String Description = null;
/**
* If the license type is not a standard license but instead an extra license option. An example would be sending newsletter license.
*/
@ApiMember(Description="If the license type is not a standard license but instead an extra license option. An example would be sending newsletter license.")
public Boolean IsExtraLicenseOption = null;
/**
* The period of notice for the license in days.
*/
@ApiMember(Description="The period of notice for the license in days.")
public Integer PeriodOfNoticeDays = null;
/**
* The license items for the license type
*/
@ApiMember(Description="The license items for the license type")
public ArrayList<LicenseItemsResponse> Items = new ArrayList<LicenseItemsResponse>();
/**
* The license prices in each country for the license type
*/
@ApiMember(Description="The license prices in each country for the license type")
public ArrayList<LicensePriceResponse> Prices = new ArrayList<LicensePriceResponse>();
public Integer getId() { return Id; }
public LicenseTypeQueryResponse setId(Integer value) { this.Id = value; return this; }
public String getName() { return Name; }
public LicenseTypeQueryResponse setName(String value) { this.Name = value; return this; }
public String getDescription() { return Description; }
public LicenseTypeQueryResponse setDescription(String value) { this.Description = value; return this; }
public Boolean getIsExtraLicenseOption() { return IsExtraLicenseOption; }
public LicenseTypeQueryResponse setIsExtraLicenseOption(Boolean value) { this.IsExtraLicenseOption = value; return this; }
public Integer getPeriodOfNoticeDays() { return PeriodOfNoticeDays; }
public LicenseTypeQueryResponse setPeriodOfNoticeDays(Integer value) { this.PeriodOfNoticeDays = value; return this; }
public ArrayList<LicenseItemsResponse> getItems() { return Items; }
public LicenseTypeQueryResponse setItems(ArrayList<LicenseItemsResponse> value) { this.Items = value; return this; }
public ArrayList<LicensePriceResponse> getPrices() { return Prices; }
public LicenseTypeQueryResponse setPrices(ArrayList<LicensePriceResponse> value) { this.Prices = value; return this; }
}
public static class LicenseItemsResponse
{
public Integer Id = null;
public String Name = null;
public Integer AllowedItems = null;
public Integer getId() { return Id; }
public LicenseItemsResponse setId(Integer value) { this.Id = value; return this; }
public String getName() { return Name; }
public LicenseItemsResponse setName(String value) { this.Name = value; return this; }
public Integer getAllowedItems() { return AllowedItems; }
public LicenseItemsResponse setAllowedItems(Integer value) { this.AllowedItems = value; return this; }
}
public static class LicensePriceResponse
{
public Integer LicenseTypeId = null;
public String CountryId = null;
public Integer Price = null;
public Country Country = null;
public Integer LicensePlanId = null;
public Integer getLicenseTypeId() { return LicenseTypeId; }
public LicensePriceResponse setLicenseTypeId(Integer value) { this.LicenseTypeId = value; return this; }
public String getCountryId() { return CountryId; }
public LicensePriceResponse setCountryId(String value) { this.CountryId = value; return this; }
public Integer getPrice() { return Price; }
public LicensePriceResponse setPrice(Integer value) { this.Price = value; return this; }
public Country getCountry() { return Country; }
public LicensePriceResponse setCountry(Country value) { this.Country = value; return this; }
public Integer getLicensePlanId() { return LicensePlanId; }
public LicensePriceResponse setLicensePlanId(Integer value) { this.LicensePlanId = value; return this; }
}
public static class Country extends BaseModel
{
@References(Type=Currency.class)
public String CurrencyId = null;
public Currency CurrencyInfo = null;
@Required()
public String Name = null;
public String Culture = null;
public String TimeZone = null;
public Date ModifiedDate = null;
@Required()
public String Id = null;
public String getCurrencyId() { return CurrencyId; }
public Country setCurrencyId(String value) { this.CurrencyId = value; return this; }
public Currency getCurrencyInfo() { return CurrencyInfo; }
public Country setCurrencyInfo(Currency value) { this.CurrencyInfo = value; return this; }
public String getName() { return Name; }
public Country setName(String value) { this.Name = value; return this; }
public String getCulture() { return Culture; }
public Country setCulture(String value) { this.Culture = value; return this; }
public String getTimeZone() { return TimeZone; }
public Country setTimeZone(String value) { this.TimeZone = value; return this; }
public Date getModifiedDate() { return ModifiedDate; }
public Country setModifiedDate(Date value) { this.ModifiedDate = value; return this; }
public String getId() { return Id; }
public Country setId(String value) { this.Id = value; return this; }
}
public static class BaseModel
{
}
public static class Currency extends BaseModel
{
@Required()
public String Name = null;
@Required()
public String CurrencySign = null;
@Required()
public Boolean Active = null;
public Date ModifiedDate = null;
@Required()
public String Id = null;
public String getName() { return Name; }
public Currency setName(String value) { this.Name = value; return this; }
public String getCurrencySign() { return CurrencySign; }
public Currency setCurrencySign(String value) { this.CurrencySign = value; return this; }
public Boolean isActive() { return Active; }
public Currency setActive(Boolean value) { this.Active = value; return this; }
public Date getModifiedDate() { return ModifiedDate; }
public Currency setModifiedDate(Date value) { this.ModifiedDate = value; return this; }
public String getId() { return Id; }
public Currency setId(String value) { this.Id = value; return this; }
}
public static class VossSubscriptionResponse
{
public Date SubscriptionBillingPeriodStartDate = null;
public Date SubscriptionBillingPeriodEndDate = null;
public TierResponse Tier = null;
public Date getSubscriptionBillingPeriodStartDate() { return SubscriptionBillingPeriodStartDate; }
public VossSubscriptionResponse setSubscriptionBillingPeriodStartDate(Date value) { this.SubscriptionBillingPeriodStartDate = value; return this; }
public Date getSubscriptionBillingPeriodEndDate() { return SubscriptionBillingPeriodEndDate; }
public VossSubscriptionResponse setSubscriptionBillingPeriodEndDate(Date value) { this.SubscriptionBillingPeriodEndDate = value; return this; }
public TierResponse getTier() { return Tier; }
public VossSubscriptionResponse setTier(TierResponse value) { this.Tier = value; return this; }
}
public static class TierResponse
{
public UUID Id = null;
public String Name = null;
public ArrayList<ProductGroupResponse> ProductGroups = new ArrayList<ProductGroupResponse>();
public UUID getId() { return Id; }
public TierResponse setId(UUID value) { this.Id = value; return this; }
public String getName() { return Name; }
public TierResponse setName(String value) { this.Name = value; return this; }
public ArrayList<ProductGroupResponse> getProductGroups() { return ProductGroups; }
public TierResponse setProductGroups(ArrayList<ProductGroupResponse> value) { this.ProductGroups = value; return this; }
}
public static class ProductGroupResponse
{
public UUID Id = null;
public String Name = null;
public UUID TierId = null;
public UUID getId() { return Id; }
public ProductGroupResponse setId(UUID value) { this.Id = value; return this; }
public String getName() { return Name; }
public ProductGroupResponse setName(String value) { this.Name = value; return this; }
public UUID getTierId() { return TierId; }
public ProductGroupResponse setTierId(UUID value) { this.TierId = value; return this; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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.bokamera.se
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>