| Requires the role: | superadmin |
| GET | /superadmin/licenses/company | Find licenses for the logged in users company | Find licenses for the logged in users company. |
|---|
"use strict";
export class QueryBase {
/** @param {{Skip?:number,Take?:number,OrderBy?:string,OrderByDesc?:string,Include?:string,Fields?:string,Meta?:{ [index: string]: string; }}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {?number}
* @description Skip over a given number of elements in a sequence and then return the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?skip=10&orderBy=Id</code> */
Skip;
/**
* @type {?number}
* @description Return a given number of elements in a sequence and then skip over the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?take=20</code> */
Take;
/**
* @type {string}
* @description Comma separated list of fields to order by. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderBy=Id,-Age,FirstName</code> */
OrderBy;
/**
* @type {string}
* @description Comma separated list of fields to order by in descending order. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderByDesc=Id,-Age,FirstName</code> */
OrderByDesc;
/**
* @type {string}
* @description Include any of the aggregates <code>AVG, COUNT, FIRST, LAST, MAX, MIN, SUM</code> in your result set. The results will be returned in the meta field.<br/><br/><strong>Example:</strong><br/><code>?include=COUNT(*) as Total</code><br/><br/>or multiple fields with<br/><code>?include=Count(*) Total, Min(Age), AVG(Age) AverageAge</code><br/></br>or unique with<br/><code>?include=COUNT(DISTINCT LivingStatus) as UniqueStatus</code> */
Include;
/** @type {string} */
Fields;
/** @type {{ [index: string]: string; }} */
Meta;
}
/** @typedef From {any} */
/** @typedef Into {any} */
export class QueryDb extends QueryBase {
/** @param {{Skip?:number,Take?:number,OrderBy?:string,OrderByDesc?:string,Include?:string,Fields?:string,Meta?:{ [index: string]: string; }}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
}
export class LicenseItemsResponse {
/** @param {{Id?:number,Name?:string,AllowedItems?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Id;
/** @type {string} */
Name;
/** @type {number} */
AllowedItems;
}
export class BaseModel {
constructor(init) { Object.assign(this, init) }
}
export class Currency extends BaseModel {
/** @param {{Name?:string,CurrencySign?:string,Active?:boolean,ModifiedDate?:string,Id?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {string} */
Name;
/** @type {string} */
CurrencySign;
/** @type {boolean} */
Active;
/** @type {?string} */
ModifiedDate;
/** @type {string} */
Id;
}
export class Country extends BaseModel {
/** @param {{CurrencyId?:string,CurrencyInfo?:Currency,Name?:string,Culture?:string,TimeZone?:string,ModifiedDate?:string,Id?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {string} */
CurrencyId;
/** @type {Currency} */
CurrencyInfo;
/** @type {string} */
Name;
/** @type {string} */
Culture;
/** @type {string} */
TimeZone;
/** @type {?string} */
ModifiedDate;
/** @type {string} */
Id;
}
export class LicensePrice extends BaseModel {
/** @param {{Country?:Country,MonthlyPayment?:boolean,LicenseTypeId?:number,CountryId?:string,Price?:number,ModifiedDate?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {Country} */
Country;
/** @type {boolean} */
MonthlyPayment;
/** @type {number} */
LicenseTypeId;
/** @type {string} */
CountryId;
/** @type {number} */
Price;
/** @type {?string} */
ModifiedDate;
}
export class LicenseTypeQueryResponse {
/** @param {{Id?:number,Name?:string,Description?:string,IsExtraLicenseOption?:boolean,PeriodOfNoticeDays?:number,Items?:LicenseItemsResponse[],Prices?:LicensePrice[]}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {number}
* @description The license type id */
Id;
/**
* @type {string}
* @description The license type name */
Name;
/**
* @type {string}
* @description The license type description */
Description;
/**
* @type {boolean}
* @description If the license type is not a standard license but instead an extra license option. An example would be sending new letter license. */
IsExtraLicenseOption;
/**
* @type {number}
* @description The period of notice for the license in days. */
PeriodOfNoticeDays;
/**
* @type {LicenseItemsResponse[]}
* @description The license items for the license type */
Items;
/**
* @type {LicensePrice[]}
* @description The license prices in each country for the license type */
Prices;
}
export class CompanyLicenseQueryResponse {
/** @param {{Id?:number,TypeId?:number,Type?:LicenseTypeQueryResponse,ValidFrom?:string,ValidTo?:string,MetaData?:string,Active?:boolean,Canceled?:boolean,Updated?:string,Created?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Id;
/** @type {number} */
TypeId;
/** @type {LicenseTypeQueryResponse} */
Type;
/** @type {string} */
ValidFrom;
/** @type {string} */
ValidTo;
/** @type {string} */
MetaData;
/** @type {boolean} */
Active;
/** @type {boolean} */
Canceled;
/** @type {string} */
Updated;
/** @type {string} */
Created;
}
export class LicenseTypeItem extends BaseModel {
/** @param {{Name?:string,LicenseType?:LicenseType,LicenseTypesId?:number,LicenseItemsId?:number,NumberOfItems?:number,Id?:number,ModifiedDate?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {string} */
Name;
/** @type {LicenseType} */
LicenseType;
/** @type {number} */
LicenseTypesId;
/** @type {number} */
LicenseItemsId;
/** @type {number} */
NumberOfItems;
/** @type {number} */
Id;
/** @type {?string} */
ModifiedDate;
}
export class LicenseType extends BaseModel {
/** @param {{LicenseItems?:IList<LicenseTypeItem>,Prices?:IList<LicensePrice>,PeriodOfNoticeDays?:number,NextLicenseOption?:LicenseType,Name?:string,Description?:string,ExtraLicenseOption?:boolean,ModifiedDate?:string,Active?:boolean,Id?:number}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {IList<LicenseTypeItem>} */
LicenseItems;
/** @type {IList<LicensePrice>} */
Prices;
/** @type {number} */
PeriodOfNoticeDays;
/** @type {LicenseType} */
NextLicenseOption;
/** @type {string} */
Name;
/** @type {string} */
Description;
/** @type {boolean} */
ExtraLicenseOption;
/** @type {?string} */
ModifiedDate;
/** @type {boolean} */
Active;
/** @type {number} */
Id;
}
export class License extends BaseModel {
/** @param {{Type?:LicenseType,CompanyId?:string,Id?:number,TypeId?:number,ValidFrom?:string,ValidTo?:string,Active?:boolean,Updated?:string,Created?:string,ModifiedDate?:string,MetaData?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {LicenseType} */
Type;
/** @type {string} */
CompanyId;
/** @type {number} */
Id;
/** @type {number} */
TypeId;
/** @type {string} */
ValidFrom;
/** @type {string} */
ValidTo;
/** @type {boolean} */
Active;
/** @type {string} */
Updated;
/** @type {string} */
Created;
/** @type {?string} */
ModifiedDate;
/** @type {string} */
MetaData;
}
export class SuperAdminCompanyLicenseQuery extends QueryDb {
/** @param {{CompanyId?:string,OnlyActiveLicenses?:boolean,CountryId?:string,MetaData?:string,TypeId?:number,IsExtraLicenseOption?:boolean,IncludeLicenseItems?:boolean,IncludeLicensePrices?:boolean,ResponseStatus?:ResponseStatus,Skip?:number,Take?:number,OrderBy?:string,OrderByDesc?:string,Include?:string,Fields?:string,Meta?:{ [index: string]: string; }}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/**
* @type {?string}
* @description The company id, if empty will use the company id for the user you are logged in with. */
CompanyId;
/**
* @type {boolean}
* @description If you want to include the connected license items */
OnlyActiveLicenses;
/**
* @type {string}
* @description What country you want to list the prices for */
CountryId;
/**
* @type {string}
* @description Search by the Meta data information on the license */
MetaData;
/**
* @type {?number}
* @description Id of the license type */
TypeId;
/**
* @type {?boolean}
* @description If you want to only select Extra license options */
IsExtraLicenseOption;
/**
* @type {boolean}
* @description If you want to include the connected license items */
IncludeLicenseItems;
/**
* @type {boolean}
* @description If you want to include the connected licens prices */
IncludeLicensePrices;
/** @type {ResponseStatus} */
ResponseStatus;
}
export class AccessKeyTypeResponse {
/** @param {{Id?:number,KeyType?:string,Description?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Id;
/** @type {string} */
KeyType;
/** @type {string} */
Description;
}
/** @typedef T {any} */
export class QueryResponse {
/** @param {{Offset?:number,Total?:number,Results?:T[],Meta?:{ [index: string]: string; },ResponseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Offset;
/** @type {number} */
Total;
/** @type {T[]} */
Results;
/** @type {{ [index: string]: string; }} */
Meta;
/** @type {ResponseStatus} */
ResponseStatus;
}
JavaScript SuperAdminCompanyLicenseQuery DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /superadmin/licenses/company HTTP/1.1 Host: api.bokamera.se Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Offset":0,"Total":0,"Results":[{"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}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}