DigiOffice Gateway Web Services

<back to all web services

QuickLookup

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


open class QuickLookup
{
    var DocumentID:UUID? = null
    var DocumentFieldID:String? = null
    var RegistrationProfileFieldID:String? = null
    var LookupValue:String? = null
    var DependableFields:ArrayList<RegistrationProfileFieldValue> = ArrayList<RegistrationProfileFieldValue>()
    var ApplyOptionalFilters:Boolean? = null
}

open class RegistrationProfileFieldValue
{
    var DocumentFieldID:UUID? = null
    var Value:String? = null
    var ShadowValue:String? = null
    var IsModifiedByUser:Boolean? = null
}

open class QuickLookupResponse : IBaseQuickLookupResponse
{
    var NumberOfAllRecords:Int? = null
    var Values:ArrayList<SerializableKeyValuePair<String,String>> = ArrayList<SerializableKeyValuePair<String,String>>()
    var QuickAddOptions:ArrayList<QuickAddOption> = ArrayList<QuickAddOption>()
}

open class QuickAddOption
{
    var Name:String? = null
    var EntityType:String? = null
}

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