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 .jsv suffix or ?format=jsv
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: doapigw.baasbv.nl
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
Key: String,
IncludeExplorers: False
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { TranslateKey: String, SiteMapKey: String, Title: String, ImageUrl: String, ChildrenCount: 0, Order: 0, Explorers: [ { Title: String, Order: 0 } ] }