sfgboxapi

<back to all web services

UsersDetailsAutoQueryLookup

"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 T {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 UsersDetails {
    /** @param {{id?:number,appUserId?:number,approved?:boolean,identificationNumber?:string,passportNumber?:string,address?:string,latitude?:number,longitude?:number,age?:number,ethnicGroup?:string,gender?:string,isDisabled?:boolean,documentUrl?:string,applicationDate?:string,approvalDate?:string,isZoneMain?:boolean,publicAccessGuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    id;
    /** @type {number} */
    appUserId;
    /** @type {boolean} */
    approved;
    /** @type {string} */
    identificationNumber;
    /** @type {string} */
    passportNumber;
    /** @type {string} */
    address;
    /** @type {number} */
    latitude;
    /** @type {number} */
    longitude;
    /** @type {number} */
    age;
    /** @type {string} */
    ethnicGroup;
    /** @type {string} */
    gender;
    /** @type {boolean} */
    isDisabled;
    /** @type {string} */
    documentUrl;
    /** @type {string} */
    applicationDate;
    /** @type {string} */
    approvalDate;
    /** @type {boolean} */
    isZoneMain;
    /** @type {string} */
    publicAccessGuid;
}
export class UsersDetailsAutoQueryLookup extends QueryDb {
    /** @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 Tenants {
    /** @param {{id?:number,mainZonesId?:number,isPublic?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    id;
    /** @type {number} */
    mainZonesId;
    /** @type {boolean} */
    isPublic;
}
/** @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 UsersDetailsAutoQueryLookup 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.

POST /jsv/reply/UsersDetailsAutoQueryLookup HTTP/1.1 
Host: api-stage.smartfarmertech.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	skip: 0,
	take: 0,
	orderBy: String,
	orderByDesc: String,
	include: String,
	fields: String,
	meta: 
	{
		String: String
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	offset: 0,
	total: 0,
	results: 
	[
		{
			id: 0,
			appUserId: 0,
			approved: False,
			identificationNumber: String,
			passportNumber: String,
			address: String,
			latitude: 0,
			longitude: 0,
			age: 0,
			ethnicGroup: String,
			gender: String,
			isDisabled: False,
			documentUrl: String,
			applicationDate: 0001-01-01,
			approvalDate: 0001-01-01,
			isZoneMain: False,
			publicAccessGuid: 00000000000000000000000000000000
		}
	],
	meta: 
	{
		String: String
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}