GET POST | /api/documentviews/{Key} |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Key | path | string | No | |
IncludeExplorers | body | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
TranslateKey | form | string | No | |
SiteMapKey | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ID | form | Guid | No | |
Title | form | string | No | |
ImageUrl | form | string | No | |
ChildrenCount | form | int? | No | |
Order | form | int | No | |
Explorers | form | List<Explorer> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ID | form | Guid | No | |
Title | form | string | No | |
Order | form | int | No |
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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/documentviews/{Key} HTTP/1.1
Host: digiofficeapigateway.deltares.nl
Accept: application/json
Content-Type: application/json
Content-Length: length
{"Key":"String","IncludeExplorers":false}
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length {"TranslateKey":"String","SiteMapKey":"String","ID":"00000000-0000-0000-0000-000000000000","Title":"String","ImageUrl":"String","ChildrenCount":0,"Order":0,"Explorers":[{"ID":"00000000-0000-0000-0000-000000000000","Title":"String","Order":0}]}