| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| POST | /licenses/company/delete | End all licenses | End all licenses on the company for the logged in user. |
|---|
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
@ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
@ValidateRequest(Validator="IsAuthenticated")
open class EndAllLicenses : 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.")
override var CompanyId:UUID? = null
/**
* If you want to deactivate the account the booking system also (will not be working during your period of notice).
*/
@ApiMember(Description="If you want to deactivate the account the booking system also (will not be working during your period of notice).")
open var Deactivate:Boolean? = null
/**
* Questionaire with answers from customer why ending license.
*/
@ApiMember(Description="Questionaire with answers from customer why ending license.")
open var Questionnaire:ArrayList<Questionnaire> = ArrayList<Questionnaire>()
}
open class Questionnaire
{
open var Question:String? = null
open var Value:String? = null
}
open class CompanyLicenseQueryResponse
{
open var Id:Int? = null
open var TypeId:Int? = null
open var Type:LicenseTypeQueryResponse? = null
open var ValidFrom:Date? = null
open var ValidTo:Date? = null
open var VossSubscriptionId:UUID? = null
open var VossSubscription:VossSubscriptionResponse? = null
open var MetaData:String? = null
open var Active:Boolean? = null
open var Canceled:Boolean? = null
open var Updated:Date? = null
open var Created:Date? = null
}
open class LicenseTypeQueryResponse
{
/**
* The license type id
*/
@ApiMember(Description="The license type id")
open var Id:Int? = null
/**
* The license type name
*/
@ApiMember(Description="The license type name")
open var Name:String? = null
/**
* The license type description
*/
@ApiMember(Description="The license type description")
open var Description:String? = 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.")
open var IsExtraLicenseOption:Boolean? = null
/**
* The period of notice for the license in days.
*/
@ApiMember(Description="The period of notice for the license in days.")
open var PeriodOfNoticeDays:Int? = null
/**
* The license items for the license type
*/
@ApiMember(Description="The license items for the license type")
open var Items:ArrayList<LicenseItemsResponse> = ArrayList<LicenseItemsResponse>()
/**
* The license prices in each country for the license type
*/
@ApiMember(Description="The license prices in each country for the license type")
open var Prices:ArrayList<LicensePriceResponse> = ArrayList<LicensePriceResponse>()
}
open class LicenseItemsResponse
{
open var Id:Int? = null
open var Name:String? = null
open var AllowedItems:Int? = null
}
open class LicensePriceResponse
{
open var LicenseTypeId:Int? = null
open var CountryId:String? = null
open var Price:Int? = null
open var Country:Country? = null
open var LicensePlanId:Int? = null
}
open class Country : BaseModel()
{
@References(Type=Currency::class)
open var CurrencyId:String? = null
open var CurrencyInfo:Currency? = null
@Required()
open var Name:String? = null
open var Culture:String? = null
open var TimeZone:String? = null
open var ModifiedDate:Date? = null
@Required()
open var Id:String? = null
}
open class BaseModel
{
}
open class Currency : BaseModel()
{
@Required()
open var Name:String? = null
@Required()
open var CurrencySign:String? = null
@Required()
open var Active:Boolean? = null
open var ModifiedDate:Date? = null
@Required()
open var Id:String? = null
}
open class VossSubscriptionResponse
{
open var SubscriptionBillingPeriodStartDate:Date? = null
open var SubscriptionBillingPeriodEndDate:Date? = null
open var Tier:TierResponse? = null
}
open class TierResponse
{
open var Id:UUID? = null
open var Name:String? = null
open var ProductGroups:ArrayList<ProductGroupResponse> = ArrayList<ProductGroupResponse>()
}
open class ProductGroupResponse
{
open var Id:UUID? = null
open var Name:String? = null
open var TierId:UUID? = null
}
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.
POST /licenses/company/delete HTTP/1.1
Host: api.bokamera.se
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<EndAllLicenses xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<Deactivate>false</Deactivate>
<Questionnaire>
<Questionnaire>
<Question>String</Question>
<Value>String</Value>
</Questionnaire>
</Questionnaire>
</EndAllLicenses>
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>