BokaMera.API.Host

LicensePlanQuery

The following routes are available for this service:
GET	/licenses/plans/	Get all license plans	This service is used to get get all license plans that exists.

// @ts-nocheck

// @DataContract
export class QueryBase
{
    // @DataMember(Order=1)
    public Skip?: number;

    // @DataMember(Order=2)
    public Take?: number;

    // @DataMember(Order=3)
    public OrderBy?: string;

    // @DataMember(Order=4)
    public OrderByDesc?: string;

    // @DataMember(Order=5)
    public Include?: string;

    // @DataMember(Order=6)
    public Fields?: string;

    // @DataMember(Order=7)
    public Meta?: { [index:string]: string; };

    public constructor(init?: Partial<QueryBase>) { (Object as any).assign(this, init); }
}

export class QueryDb<From, Into> extends QueryBase
{

    public constructor(init?: Partial<QueryDb<From, Into>>) { super(init); (Object as any).assign(this, init); }
}

export class VossPlanResponse
{
    public Id: string;
    public Name: string;
    public LengthUnit: string;
    public Length: string;

    public constructor(init?: Partial<VossPlanResponse>) { (Object as any).assign(this, init); }
}

export enum LengthUnit
{
    Week = 1,
    Month = 2,
    Year = 3,
}

export class LicensePlanQueryResponse
{
    public Id: number;
    public VossPlanId: string;
    public Name: string;
    public Description: string;
    public VossPlan: VossPlanResponse;
    public PlanLength: number;
    public PlanLengthUnit: LengthUnit;
    public UpdatedDate: string;
    public CreatedDate: string;
    public Active: boolean;

    public constructor(init?: Partial<LicensePlanQueryResponse>) { (Object as any).assign(this, init); }
}

export class BaseModel
{

    public constructor(init?: Partial<BaseModel>) { (Object as any).assign(this, init); }
}

export class LicensePlan extends BaseModel implements IBaseModelUpdated, IBaseModelCreated
{
    // @Ignore()
    public VossPlan: VossPlanResponse;

    // @Required()
    public Id: number;

    public VossPlanId: string;
    // @Required()
    public PlanLength: number;

    // @Required()
    public PlanLengthUnitId: number;

    // @Required()
    public Name: string;

    // @Required()
    public Description: string;

    public UpdatedDate: string;
    public Active: boolean;
    public CreatedDate: string;

    public constructor(init?: Partial<LicensePlan>) { super(init); (Object as any).assign(this, init); }
}

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
export class LicensePlanQuery extends QueryDb<LicensePlan, LicensePlanQueryResponse>
{
    /** @description Search active plan. */
    // @ApiMember(Description="Search active plan.", ParameterType="query")
    public Active: boolean;

    public constructor(init?: Partial<LicensePlanQuery>) { super(init); (Object as any).assign(this, init); }
}

export class AccessKeyTypeResponse
{
    public Id: number;
    public KeyType: string;
    public Description: string;

    public constructor(init?: Partial<AccessKeyTypeResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class QueryResponse<T>
{
    // @DataMember(Order=1)
    public Offset: number;

    // @DataMember(Order=2)
    public Total: number;

    // @DataMember(Order=3)
    public Results: AccessKeyTypeResponse[] = [];

    // @DataMember(Order=4)
    public Meta?: { [index:string]: string; };

    // @DataMember(Order=5)
    public ResponseStatus?: ResponseStatus;

    public constructor(init?: Partial<QueryResponse<T>>) { (Object as any).assign(this, init); }
}

TypeScript LicensePlanQuery DTOs

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

HTTP + 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
		}
	}
}