DigiOffice Gateway Web Services

<back to all web services

QuickLookup

Requires Authentication
import Foundation
import ServiceStack

public class QuickLookup : Codable
{
    public var documentID:String?
    public var documentFieldID:String?
    public var registrationProfileFieldID:String?
    public var lookupValue:String?
    public var dependableFields:[RegistrationProfileFieldValue] = []
    public var applyOptionalFilters:Bool?

    required public init(){}
}

public class RegistrationProfileFieldValue : Codable
{
    public var documentFieldID:String?
    public var value:String?
    public var shadowValue:String?
    public var isModifiedByUser:Bool?

    required public init(){}
}

public class QuickLookupResponse : IBaseQuickLookupResponse, Codable
{
    public var numberOfAllRecords:Int?
    public var values:[SerializableKeyValuePair<String,String>] = []
    public var quickAddOptions:[QuickAddOption] = []

    required public init(){}
}

public class QuickAddOption : Codable
{
    public var name:String?
    public var entityType:String?

    required public init(){}
}


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