Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
DocumentID | query | Guid? | No | |
DocumentFieldID | query | string | No | |
RegistrationProfileFieldID | query | string | No | |
LookupValue | query | string | No | |
DependableFields | query | List<RegistrationProfileFieldValue> | No | |
ApplyOptionalFilters | query | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
DocumentFieldID | form | Guid | No | |
Value | form | string | No | |
ShadowValue | form | string | No | |
IsModifiedByUser | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
NumberOfAllRecords | form | int | No | |
Values | form | List<SerializableKeyValuePair<String,String>> | No | |
QuickAddOptions | form | List<QuickAddOption> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | form | string | No | |
EntityType | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=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"}]}