DigiOffice Gateway Web Services

<back to all web services

QuickLookup

Requires Authentication
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class QuickLookup
{
    open var DocumentID:UUID? = null
    open var DocumentFieldID:String? = null
    open var RegistrationProfileFieldID:String? = null
    open var LookupValue:String? = null
    open var DependableFields:ArrayList<RegistrationProfileFieldValue>? = null
    open var ApplyOptionalFilters:Boolean? = null
}

open class RegistrationProfileFieldValue
{
    open var DocumentFieldID:UUID? = null
    open var Value:String? = null
    open var ShadowValue:String? = null
    open var IsModifiedByUser:Boolean? = null
}

open class QuickLookupResponse : IBaseQuickLookupResponse
{
    override var NumberOfAllRecords:Int? = null
    open var Values:ArrayList<SerializableKeyValuePair<String,String>>? = null
    override var QuickAddOptions:ArrayList<QuickAddOption>? = null
}

open class QuickAddOption
{
    open var Name:String? = null
    open var EntityType:String? = null
}

Kotlin 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
		}
	]
}