BokaMera.API.Host

ReferenceQuery

The following routes are available for this service:
GET	/references	Get all valid references	Get all valid references.

"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 ReferenceQueryResponse {
    /** @param {{CompanyId?:string,Id?:string,OwnerId?:string,ReferenceType?:string,ReferenceTypeId?:number,ExternalData?:string,Updated?:string,Created?:string,CreatedBy?:string,UpdatedBy?:string,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    CompanyId;
    /** @type {string} */
    Id;
    /** @type {string} */
    OwnerId;
    /** @type {string} */
    ReferenceType;
    /** @type {number} */
    ReferenceTypeId;
    /** @type {string} */
    ExternalData;
    /** @type {string} */
    Updated;
    /** @type {string} */
    Created;
    /** @type {string} */
    CreatedBy;
    /** @type {string} */
    UpdatedBy;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class BaseModel {
    constructor(init) { Object.assign(this, init) }
}
export class ExternalReference extends BaseModel {
    /** @param {{CompanyId?:string,Id?:string,OwnerId?:string,ReferenceType?:string,ReferenceTypeId?:number,ExternalData?:string,InternalData?:string,CreatedBy?:string,UpdatedDate?:string,CreatedDate?:string,ModifiedDate?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    CompanyId;
    /** @type {string} */
    Id;
    /** @type {string} */
    OwnerId;
    /** @type {string} */
    ReferenceType;
    /** @type {number} */
    ReferenceTypeId;
    /** @type {?string} */
    ExternalData;
    /** @type {?string} */
    InternalData;
    /** @type {?string} */
    CreatedBy;
    /** @type {string} */
    UpdatedDate;
    /** @type {string} */
    CreatedDate;
    /** @type {?string} */
    ModifiedDate;
}
export class ReferenceQuery extends QueryDb {
    /** @param {{CompanyId?:string,Id?:string,OwnerId?:string,ReferenceType?:string,ExternalData?:string,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 {?string}
     * @description Id of the reference */
    Id;
    /**
     * @type {?string}
     * @description Internal Id of the reference. Example could be the Booking Id */
    OwnerId;
    /**
     * @type {string}
     * @description The type of reference, you can name this parameter what you like. Example could be system_bookingid where the system is the external system */
    ReferenceType;
    /**
     * @type {string}
     * @description The external data. Could be a Id or a JSON object or anything */
    ExternalData;
}
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 ReferenceQuery 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 /references HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Offset: 0,
	Total: 0,
	Results: 
	[
		{
			ReferenceType: String,
			ReferenceTypeId: 0,
			ExternalData: String,
			CreatedBy: String,
			UpdatedBy: String,
			ResponseStatus: 
			{
				ErrorCode: String,
				Message: String,
				StackTrace: String,
				Errors: 
				[
					{
						ErrorCode: String,
						FieldName: String,
						Message: String,
						Meta: 
						{
							String: String
						}
					}
				],
				Meta: 
				{
					String: String
				}
			}
		}
	],
	Meta: 
	{
		String: String
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}