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 .jsv suffix or ?format=jsv

HTTP + JSV

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

POST /jsv/reply/QuickLookup HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	DocumentID: 00000000-0000-0000-0000-000000000000,
	DocumentFieldID: String,
	RegistrationProfileFieldID: String,
	LookupValue: String,
	DependableFields: 
	[
		{
			Value: String,
			ShadowValue: String,
			IsModifiedByUser: False
		}
	],
	ApplyOptionalFilters: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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