DigiOffice Gateway Web Services

QuickLookup


export class QuickAddOption
{
    public Name?: string;
    public EntityType?: string;

    public constructor(init?: Partial<QuickAddOption>) { (Object as any).assign(this, init); }
}

export class QuickLookupResponse implements IBaseQuickLookupResponse
{
    public NumberOfAllRecords?: number;
    public Values?: SerializableKeyValuePair<string,string>[];
    public QuickAddOptions?: QuickAddOption[];

    public constructor(init?: Partial<QuickLookupResponse>) { (Object as any).assign(this, init); }
}

export class RegistrationProfileFieldValue
{
    public DocumentFieldID?: string;
    public Value?: string;
    public ShadowValue?: string;
    public IsModifiedByUser?: boolean;

    public constructor(init?: Partial<RegistrationProfileFieldValue>) { (Object as any).assign(this, init); }
}

export class QuickLookup
{
    public DocumentID?: string;
    public DocumentFieldID?: string;
    public RegistrationProfileFieldID?: string;
    public LookupValue?: string;
    public DependableFields?: RegistrationProfileFieldValue[];
    public ApplyOptionalFilters?: boolean;

    public constructor(init?: Partial<QuickLookup>) { (Object as any).assign(this, init); }
}

TypeScript QuickLookup DTOs

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/QuickLookup HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"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"}]}