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
ApplyOptionalFiltersformboolNo
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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /json/reply/ProcessQuickLookup HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"EntityContext":"String","DocumentID":"00000000-0000-0000-0000-000000000000","DocumentFieldID":"String","RegistrationProfileFieldID":"String","LookupValue":"String","DependableFields":[{"DocumentFieldID":"00000000-0000-0000-0000-000000000000","Value":"String","ShadowValue":"String","IsModifiedByUser":false}],"ApplyOptionalFilters":false}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

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