DigiOffice Gateway Web Services

<back to all web services

QuickLookup

Requires Authentication
namespace IDB.API.DTO.Controls.Operations

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type QuickAddOption() = 
        member val Name:String = null with get,set
        member val EntityType:String = null with get,set

    [<AllowNullLiteral>]
    type QuickLookupResponse() = 
        member val NumberOfAllRecords:Int32 = new Int32() with get,set
        member val Values:ResizeArray<SerializableKeyValuePair<String,String>> = new ResizeArray<SerializableKeyValuePair<String,String>>() with get,set
        member val QuickAddOptions:ResizeArray<QuickAddOption> = new ResizeArray<QuickAddOption>() with get,set

    [<AllowNullLiteral>]
    type RegistrationProfileFieldValue() = 
        member val DocumentFieldID:Guid = new Guid() with get,set
        member val Value:String = null with get,set
        member val ShadowValue:String = null with get,set
        member val IsModifiedByUser:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type QuickLookup() = 
        member val DocumentID:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val DocumentFieldID:String = null with get,set
        member val RegistrationProfileFieldID:String = null with get,set
        member val LookupValue:String = null with get,set
        member val DependableFields:ResizeArray<RegistrationProfileFieldValue> = new ResizeArray<RegistrationProfileFieldValue>() with get,set
        member val ApplyOptionalFilters:Boolean = new Boolean() with get,set

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

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