DigiOffice Gateway Web Services

<back to all web services

ProcessQuickLookup

Requires Authentication
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports IDB.API.DTO.Controls
Imports IDB.API.DTO.Controls.QuickLookup
Imports IDB.API.DTO.Registrationprofile
Imports IDB.API.DTO.Controls.Operations

Namespace Global

    Namespace IDB.API.DTO.Controls

        Public Partial Class ProcessQuickLookup
            Inherits QuickLookup
            Public Overridable Property EntityContext As String
        End Class
    End Namespace

    Namespace IDB.API.DTO.Controls.Operations

        Public Partial Class QuickLookupResponse
            Implements IBaseQuickLookupResponse
            Public Sub New()
                Values = New List(Of SerializableKeyValuePair(Of String,String))
                QuickAddOptions = New List(Of QuickAddOption)
            End Sub

            Public Overridable Property NumberOfAllRecords As Integer
            Public Overridable Property Values As List(Of SerializableKeyValuePair(Of String,String))
            Public Overridable Property QuickAddOptions As List(Of QuickAddOption)
        End Class
    End Namespace

    Namespace IDB.API.DTO.Controls.QuickLookup

        Public Partial Class QuickAddOption
            Public Overridable Property Name As String
            Public Overridable Property EntityType As String
        End Class

        Public Partial Class QuickLookup
            Public Sub New()
                DependableFields = New List(Of RegistrationProfileFieldValue)
            End Sub

            Public Overridable Property DocumentID As Nullable(Of Guid)
            Public Overridable Property DocumentFieldID As String
            Public Overridable Property RegistrationProfileFieldID As String
            Public Overridable Property LookupValue As String
            Public Overridable Property DependableFields As List(Of RegistrationProfileFieldValue)
            Public Overridable Property ApplyOptionalFilters As Boolean
        End Class
    End Namespace

    Namespace IDB.API.DTO.Registrationprofile

        Public Partial Class RegistrationProfileFieldValue
            Public Overridable Property DocumentFieldID As Guid
            Public Overridable Property Value As String
            Public Overridable Property ShadowValue As String
            Public Overridable Property IsModifiedByUser As Boolean
        End Class
    End Namespace
End Namespace

VB.NET 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"}]}