| 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. |
|---|
export class LicenseItemsResponse
{
public Id: number;
public Name: string;
public AllowedItems: number;
public constructor(init?: Partial<LicenseItemsResponse>) { (Object as any).assign(this, init); }
}
export class BaseModel
{
public constructor(init?: Partial<BaseModel>) { (Object as any).assign(this, init); }
}
export class Currency extends BaseModel
{
// @Required()
public Name: string;
// @Required()
public CurrencySign: string;
// @Required()
public Active: boolean;
public ModifiedDate?: string;
// @Required()
public Id: string;
public constructor(init?: Partial<Currency>) { super(init); (Object as any).assign(this, init); }
}
export class Country extends BaseModel
{
// @References("typeof(BokaMera.API.ServiceModel.Db.Currency)")
public CurrencyId: string;
public CurrencyInfo: Currency;
// @Required()
public Name: string;
public Culture: string;
public TimeZone: string;
public ModifiedDate?: string;
// @Required()
public Id: string;
public constructor(init?: Partial<Country>) { super(init); (Object as any).assign(this, init); }
}
export class LicensePrice extends BaseModel
{
// @Ignore()
public Country: Country;
// @Ignore()
public MonthlyPayment: boolean;
// @Required()
public LicenseTypeId: number;
// @Required()
public CountryId: string;
// @Required()
public Price: number;
public ModifiedDate?: string;
public constructor(init?: Partial<LicensePrice>) { super(init); (Object as any).assign(this, init); }
}
export class LicenseTypeQueryResponse
{
/** @description The license type id */
// @ApiMember(Description="The license type id")
public Id: number;
/** @description The license type name */
// @ApiMember(Description="The license type name")
public Name: string;
/** @description The license type description */
// @ApiMember(Description="The license type description")
public Description: string;
/** @description 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 IsExtraLicenseOption: boolean;
/** @description The period of notice for the license in days. */
// @ApiMember(Description="The period of notice for the license in days.")
public PeriodOfNoticeDays: number;
/** @description The license items for the license type */
// @ApiMember(Description="The license items for the license type")
public Items: LicenseItemsResponse[];
/** @description The license prices in each country for the license type */
// @ApiMember(Description="The license prices in each country for the license type")
public Prices: LicensePrice[];
public constructor(init?: Partial<LicenseTypeQueryResponse>) { (Object as any).assign(this, init); }
}
export class CompanyLicenseQueryResponse
{
public Id: number;
public TypeId: number;
public Type: LicenseTypeQueryResponse;
public ValidFrom: string;
public ValidTo: string;
public MetaData: string;
public Active: boolean;
public Canceled: boolean;
public Updated: string;
public Created: string;
public constructor(init?: Partial<CompanyLicenseQueryResponse>) { (Object as any).assign(this, init); }
}
// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
export class EndAllLicenses implements ICompany
{
/** @description 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 CompanyId?: string;
/** @description 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).")
public Deactivate: boolean;
/** @description Questionaire with answers from customer why ending license. */
// @ApiMember(Description="Questionaire with answers from customer why ending license.")
public Questionnaire: Questionnaire[];
public constructor(init?: Partial<EndAllLicenses>) { (Object as any).assign(this, init); }
}
export class Questionnaire
{
public Question: string;
public Value: string;
public constructor(init?: Partial<Questionnaire>) { (Object as any).assign(this, init); }
}
TypeScript EndAllLicenses DTOs
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: testapi.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 xmlns:d3p1="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Db">
<d3p1:LicensePrice>
<d3p1:Country>
<d3p1:Culture>String</d3p1:Culture>
<d3p1:CurrencyId>String</d3p1:CurrencyId>
<d3p1:CurrencyInfo>
<d3p1:Active>false</d3p1:Active>
<d3p1:CurrencySign>String</d3p1:CurrencySign>
<d3p1:Id>String</d3p1:Id>
<d3p1:ModifiedDate xmlns:d7p1="http://schemas.datacontract.org/2004/07/System">
<d7p1:DateTime>0001-01-01T00:00:00Z</d7p1:DateTime>
<d7p1:OffsetMinutes>0</d7p1:OffsetMinutes>
</d3p1:ModifiedDate>
<d3p1:Name>String</d3p1:Name>
</d3p1:CurrencyInfo>
<d3p1:Id>String</d3p1:Id>
<d3p1:ModifiedDate xmlns:d6p1="http://schemas.datacontract.org/2004/07/System">
<d6p1:DateTime>0001-01-01T00:00:00Z</d6p1:DateTime>
<d6p1:OffsetMinutes>0</d6p1:OffsetMinutes>
</d3p1:ModifiedDate>
<d3p1:Name>String</d3p1:Name>
<d3p1:TimeZone>String</d3p1:TimeZone>
</d3p1:Country>
<d3p1:CountryId>String</d3p1:CountryId>
<d3p1:LicenseTypeId>0</d3p1:LicenseTypeId>
<d3p1:ModifiedDate xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
<d5p1:DateTime>0001-01-01T00:00:00Z</d5p1:DateTime>
<d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
</d3p1:ModifiedDate>
<d3p1:Price>0</d3p1:Price>
</d3p1:LicensePrice>
</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>
</CompanyLicenseQueryResponse>