DigiOffice Gateway Web Services

<back to all web services

ProcessQuickLookup

Requires Authentication
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QuickAddOption:
    name: Optional[str] = None
    entity_type: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QuickLookupResponse(IBaseQuickLookupResponse):
    number_of_all_records: Optional[int] = None
    values: Optional[List[SerializableKeyValuePair[str, str]]] = None
    quick_add_options: Optional[List[QuickAddOption]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RegistrationProfileFieldValue:
    document_field_i_d: Optional[str] = None
    value: Optional[str] = None
    shadow_value: Optional[str] = None
    is_modified_by_user: Optional[bool] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QuickLookup:
    document_i_d: Optional[str] = None
    document_field_i_d: Optional[str] = None
    registration_profile_field_i_d: Optional[str] = None
    lookup_value: Optional[str] = None
    dependable_fields: Optional[List[RegistrationProfileFieldValue]] = None
    apply_optional_filters: Optional[bool] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ProcessQuickLookup(QuickLookup):
    entity_context: Optional[str] = None

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

{
	EntityContext: String,
	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
		}
	]
}