DigiOffice Gateway Web Services

<back to all web services

ProcessQuickLookup

Requires Authentication
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class ProcessQuickLookup extends QuickLookup
    {
        public String EntityContext = null;
        
        public String getEntityContext() { return EntityContext; }
        public ProcessQuickLookup setEntityContext(String value) { this.EntityContext = value; return this; }
    }

    public static class QuickLookup
    {
        public UUID DocumentID = null;
        public String DocumentFieldID = null;
        public String RegistrationProfileFieldID = null;
        public String LookupValue = null;
        public ArrayList<RegistrationProfileFieldValue> DependableFields = null;
        public Boolean ApplyOptionalFilters = null;
        
        public UUID getDocumentID() { return DocumentID; }
        public QuickLookup setDocumentID(UUID value) { this.DocumentID = value; return this; }
        public String getDocumentFieldID() { return DocumentFieldID; }
        public QuickLookup setDocumentFieldID(String value) { this.DocumentFieldID = value; return this; }
        public String getRegistrationProfileFieldID() { return RegistrationProfileFieldID; }
        public QuickLookup setRegistrationProfileFieldID(String value) { this.RegistrationProfileFieldID = value; return this; }
        public String getLookupValue() { return LookupValue; }
        public QuickLookup setLookupValue(String value) { this.LookupValue = value; return this; }
        public ArrayList<RegistrationProfileFieldValue> getDependableFields() { return DependableFields; }
        public QuickLookup setDependableFields(ArrayList<RegistrationProfileFieldValue> value) { this.DependableFields = value; return this; }
        public Boolean isApplyOptionalFilters() { return ApplyOptionalFilters; }
        public QuickLookup setApplyOptionalFilters(Boolean value) { this.ApplyOptionalFilters = value; return this; }
    }

    public static class RegistrationProfileFieldValue
    {
        public UUID DocumentFieldID = null;
        public String Value = null;
        public String ShadowValue = null;
        public Boolean IsModifiedByUser = null;
        
        public UUID getDocumentFieldID() { return DocumentFieldID; }
        public RegistrationProfileFieldValue setDocumentFieldID(UUID value) { this.DocumentFieldID = value; return this; }
        public String getValue() { return Value; }
        public RegistrationProfileFieldValue setValue(String value) { this.Value = value; return this; }
        public String getShadowValue() { return ShadowValue; }
        public RegistrationProfileFieldValue setShadowValue(String value) { this.ShadowValue = value; return this; }
        public Boolean getIsModifiedByUser() { return IsModifiedByUser; }
        public RegistrationProfileFieldValue setIsModifiedByUser(Boolean value) { this.IsModifiedByUser = value; return this; }
    }

    public static class QuickLookupResponse implements IBaseQuickLookupResponse
    {
        public Integer NumberOfAllRecords = null;
        public ArrayList<SerializableKeyValuePair<String,String>> Values = null;
        public ArrayList<QuickAddOption> QuickAddOptions = null;
        
        public Integer getNumberOfAllRecords() { return NumberOfAllRecords; }
        public QuickLookupResponse setNumberOfAllRecords(Integer value) { this.NumberOfAllRecords = value; return this; }
        public ArrayList<SerializableKeyValuePair<String,String>> getValues() { return Values; }
        public QuickLookupResponse setValues(ArrayList<SerializableKeyValuePair<String,String>> value) { this.Values = value; return this; }
        public ArrayList<QuickAddOption> getQuickAddOptions() { return QuickAddOptions; }
        public QuickLookupResponse setQuickAddOptions(ArrayList<QuickAddOption> value) { this.QuickAddOptions = value; return this; }
    }

    public static class QuickAddOption
    {
        public String Name = null;
        public String EntityType = null;
        
        public String getName() { return Name; }
        public QuickAddOption setName(String value) { this.Name = value; return this; }
        public String getEntityType() { return EntityType; }
        public QuickAddOption setEntityType(String value) { this.EntityType = value; return this; }
    }

}

Java ProcessQuickLookup DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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

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

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