DigiOffice Gateway Web Services

<back to all web services

ProcessQuickLookup

Requires Authentication
ProcessQuickLookup Parameters:
NameParameterData TypeRequiredDescription
EntityContextquerystringNo
QuickLookup Parameters:
NameParameterData TypeRequiredDescription
DocumentIDformGuid?No
DocumentFieldIDformstringNo
RegistrationProfileFieldIDformstringNo
LookupValueformstringNo
DependableFieldsformList<RegistrationProfileFieldValue>No
RegistrationProfileFieldValue Parameters:
NameParameterData TypeRequiredDescription
DocumentFieldIDformGuidNo
ValueformstringNo
ShadowValueformstringNo
IsModifiedByUserformboolNo
QuickLookupResponse Parameters:
NameParameterData TypeRequiredDescription
NumberOfAllRecordsformintNo
ValuesformList<SerializableKeyValuePair<String,String>>No
QuickAddOptionsformList<QuickAddOption>No
QuickAddOption Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
EntityTypeformstringNo

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/ProcessQuickLookup HTTP/1.1 
Host: doapigw.baasbv.nl 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	__type: "IDB.API.DTO.Controls.ProcessQuickLookup, IDB.API.DTO",
	EntityContext: String,
	DocumentID: 00000000-0000-0000-0000-000000000000,
	DocumentFieldID: String,
	RegistrationProfileFieldID: String,
	LookupValue: String,
	DependableFields: 
	[
		{
			__type: "IDB.API.DTO.Registrationprofile.RegistrationProfileFieldValue, IDB.API.DTO",
			Value: String,
			ShadowValue: String,
			IsModifiedByUser: False
		}
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	__type: "IDB.API.DTO.Controls.Operations.QuickLookupResponse, IDB.API.DTO",
	NumberOfAllRecords: 0,
	Values: 
	[
		{
			
		}
	],
	QuickAddOptions: 
	[
		{
			__type: "IDB.API.DTO.Controls.QuickLookup.QuickAddOption, IDB.API.DTO",
			Name: String,
			EntityType: String
		}
	]
}