| GET | /licenses/plans/ | Get all license plans | This service is used to get get all license plans that exists. |
|---|
"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} */
Skip;
/** @type {?number} */
Take;
/** @type {?string} */
OrderBy;
/** @type {?string} */
OrderByDesc;
/** @type {?string} */
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 VossPlanResponse {
/** @param {{Id?:string,Name?:string,LengthUnit?:string,Length?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Id;
/** @type {string} */
Name;
/** @type {string} */
LengthUnit;
/** @type {string} */
Length;
}
/** @typedef {number} */
export var LengthUnit;
(function (LengthUnit) {
LengthUnit[LengthUnit["Week"] = 1] = "Week"
LengthUnit[LengthUnit["Month"] = 2] = "Month"
LengthUnit[LengthUnit["Year"] = 3] = "Year"
})(LengthUnit || (LengthUnit = {}));
export class LicensePlanQueryResponse {
/** @param {{Id?:number,VossPlanId?:string,Name?:string,Description?:string,VossPlan?:VossPlanResponse,PlanLength?:number,PlanLengthUnit?:LengthUnit,UpdatedDate?:string,CreatedDate?:string,Active?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Id;
/** @type {string} */
VossPlanId;
/** @type {string} */
Name;
/** @type {string} */
Description;
/** @type {VossPlanResponse} */
VossPlan;
/** @type {number} */
PlanLength;
/** @type {LengthUnit} */
PlanLengthUnit;
/** @type {string} */
UpdatedDate;
/** @type {string} */
CreatedDate;
/** @type {boolean} */
Active;
}
export class BaseModel {
constructor(init) { Object.assign(this, init) }
}
export class LicensePlan extends BaseModel {
/** @param {{VossPlan?:VossPlanResponse,Id?:number,VossPlanId?:string,PlanLength?:number,PlanLengthUnitId?:number,Name?:string,Description?:string,UpdatedDate?:string,Active?:boolean,CreatedDate?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {VossPlanResponse} */
VossPlan;
/** @type {number} */
Id;
/** @type {string} */
VossPlanId;
/** @type {number} */
PlanLength;
/** @type {number} */
PlanLengthUnitId;
/** @type {string} */
Name;
/** @type {string} */
Description;
/** @type {string} */
UpdatedDate;
/** @type {boolean} */
Active;
/** @type {string} */
CreatedDate;
}
export class LicensePlanQuery extends QueryDb {
/** @param {{Active?:boolean,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 {boolean}
* @description Search active plan. */
Active;
}
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 LicensePlanQuery DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /licenses/plans/ HTTP/1.1 Host: api-staging.bookmore.com Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Offset: 0,
Total: 0,
Results:
[
{
Id: 0,
Name: String,
Description: String,
VossPlan:
{
Name: String,
LengthUnit: String,
Length: String
},
PlanLength: 0,
PlanLengthUnit: Week,
Active: False
}
],
Meta:
{
String: String
},
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}