BokaMera.API.Host

<back to all web services

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 companyCancel 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 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 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 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 new letter license.
        */
        @ApiMember(Description="If the license type is not a standard license but instead an extra license option. An example would be sending new letter 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 = null;

        /**
        * The license prices in each country for the license type
        */
        @ApiMember(Description="The license prices in each country for the license type")
        public ArrayList<LicensePrice> Prices = null;
        
        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<LicensePrice> getPrices() { return Prices; }
        public LicenseTypeQueryResponse setPrices(ArrayList<LicensePrice> 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 LicensePrice extends BaseModel
    {
        @Ignore()
        public Country Country = null;

        @Ignore()
        public Boolean MonthlyPayment = null;

        @Required()
        public Integer LicenseTypeId = null;

        @Required()
        public String CountryId = null;

        @Required()
        public Integer Price = null;

        public Date ModifiedDate = null;
        
        public Country getCountry() { return Country; }
        public LicensePrice setCountry(Country value) { this.Country = value; return this; }
        public Boolean isMonthlyPayment() { return MonthlyPayment; }
        public LicensePrice setMonthlyPayment(Boolean value) { this.MonthlyPayment = value; return this; }
        public Integer getLicenseTypeId() { return LicenseTypeId; }
        public LicensePrice setLicenseTypeId(Integer value) { this.LicenseTypeId = value; return this; }
        public String getCountryId() { return CountryId; }
        public LicensePrice setCountryId(String value) { this.CountryId = value; return this; }
        public Integer getPrice() { return Price; }
        public LicensePrice setPrice(Integer value) { this.Price = value; return this; }
        public Date getModifiedDate() { return ModifiedDate; }
        public LicensePrice setModifiedDate(Date value) { this.ModifiedDate = value; return this; }
    }

    public static class BaseModel
    {
        
    }

    public static class Country extends BaseModel
    {
        @References(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 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; }
    }

}

Java CancelLicense DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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: testapi.bokamera.se 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Id":0,"TypeId":0,"Type":{"Id":0,"Name":"String","Description":"String","IsExtraLicenseOption":false,"PeriodOfNoticeDays":0,"Items":[{"Id":0,"Name":"String","AllowedItems":0}],"Prices":[{"Country":{"CurrencyId":"String","CurrencyInfo":{"Name":"String","CurrencySign":"String","Active":false,"ModifiedDate":"0001-01-01T00:00:00.0000000+00:00","Id":"String"},"Name":"String","Culture":"String","TimeZone":"String","ModifiedDate":"0001-01-01T00:00:00.0000000+00:00","Id":"String"},"MonthlyPayment":true,"LicenseTypeId":0,"CountryId":"String","Price":0,"ModifiedDate":"0001-01-01T00:00:00.0000000+00:00"}]},"MetaData":"String","Active":false,"Canceled":false}