DigiOffice Gateway Web Services

<back to all web services

QuickLookup

Requires Authentication
"use strict";
export class QuickAddOption {
    /** @param {{Name?:string,EntityType?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Name;
    /** @type {string} */
    EntityType;
}
export class QuickLookupResponse {
    /** @param {{NumberOfAllRecords?:number,Values?:SerializableKeyValuePair<string,string>[],QuickAddOptions?:QuickAddOption[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    NumberOfAllRecords;
    /** @type {SerializableKeyValuePair<string,string>[]} */
    Values;
    /** @type {QuickAddOption[]} */
    QuickAddOptions;
}
export class RegistrationProfileFieldValue {
    /** @param {{DocumentFieldID?:string,Value?:string,ShadowValue?:string,IsModifiedByUser?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    DocumentFieldID;
    /** @type {string} */
    Value;
    /** @type {string} */
    ShadowValue;
    /** @type {boolean} */
    IsModifiedByUser;
}
export class QuickLookup {
    /** @param {{DocumentID?:string,DocumentFieldID?:string,RegistrationProfileFieldID?:string,LookupValue?:string,DependableFields?:RegistrationProfileFieldValue[],ApplyOptionalFilters?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?string} */
    DocumentID;
    /** @type {string} */
    DocumentFieldID;
    /** @type {string} */
    RegistrationProfileFieldID;
    /** @type {string} */
    LookupValue;
    /** @type {RegistrationProfileFieldValue[]} */
    DependableFields;
    /** @type {boolean} */
    ApplyOptionalFilters;
}

JavaScript QuickLookup 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/QuickLookup HTTP/1.1 
Host: test-dogw.klokgroep.nl 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	DocumentID: 00000000-0000-0000-0000-000000000000,
	DocumentFieldID: String,
	RegistrationProfileFieldID: String,
	LookupValue: String,
	DependableFields: 
	[
		{
			Value: String,
			ShadowValue: String,
			IsModifiedByUser: False
		}
	],
	ApplyOptionalFilters: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	NumberOfAllRecords: 0,
	Values: 
	[
		{
			
		}
	],
	QuickAddOptions: 
	[
		{
			Name: String,
			EntityType: String
		}
	]
}