DigiOffice Gateway Web Services

<back to all web services

QuickLookup

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

namespace IDB.API.DTO.Controls.Operations
{
    public partial class QuickLookupResponse
        : IBaseQuickLookupResponse
    {
        public QuickLookupResponse()
        {
            Values = new List<SerializableKeyValuePair<String,String>>{};
            QuickAddOptions = new List<QuickAddOption>{};
        }

        public virtual int NumberOfAllRecords { get; set; }
        public virtual List<SerializableKeyValuePair<String,String>> Values { get; set; }
        public virtual List<QuickAddOption> QuickAddOptions { get; set; }
    }

}

namespace IDB.API.DTO.Controls.QuickLookup
{
    public partial class QuickAddOption
    {
        public virtual string Name { get; set; }
        public virtual string EntityType { get; set; }
    }

    public partial class QuickLookup
    {
        public QuickLookup()
        {
            DependableFields = new List<RegistrationProfileFieldValue>{};
        }

        public virtual Guid? DocumentID { get; set; }
        public virtual string DocumentFieldID { get; set; }
        public virtual string RegistrationProfileFieldID { get; set; }
        public virtual string LookupValue { get; set; }
        public virtual List<RegistrationProfileFieldValue> DependableFields { get; set; }
        public virtual bool ApplyOptionalFilters { get; set; }
    }

}

namespace IDB.API.DTO.Registrationprofile
{
    public partial class RegistrationProfileFieldValue
    {
        public virtual Guid DocumentFieldID { get; set; }
        public virtual string Value { get; set; }
        public virtual string ShadowValue { get; set; }
        public virtual bool IsModifiedByUser { get; set; }
    }

}

C# 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"}]}