DigiOffice Gateway Web Services

<back to all web services

GetDocumentViewDetails

Requires Authentication
The following routes are available for this service:
GET/api/getdocumentviewdetails
"use strict";
export class Explorer {
    /** @param {{ID?:string,Title?:string,Order?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ID;
    /** @type {string} */
    Title;
    /** @type {number} */
    Order;
}
export class MobileView {
    /** @param {{ID?:string,Title?:string,ImageUrl?:string,ChildrenCount?:number,Order?:number,Explorers?:Explorer[],IsDirectSearch?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ID;
    /** @type {string} */
    Title;
    /** @type {string} */
    ImageUrl;
    /** @type {?number} */
    ChildrenCount;
    /** @type {number} */
    Order;
    /** @type {Explorer[]} */
    Explorers;
    /** @type {boolean} */
    IsDirectSearch;
}
export class DocumentView extends MobileView {
    /** @param {{TranslateKey?:string,SiteMapKey?:string,ID?:string,Title?:string,ImageUrl?:string,ChildrenCount?:number,Order?:number,Explorers?:Explorer[],IsDirectSearch?:boolean}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    TranslateKey;
    /** @type {string} */
    SiteMapKey;
}
export class GetDocumentViewDetails {
    /** @param {{ViewID?:string,IncludeExplorers?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ViewID;
    /** @type {boolean} */
    IncludeExplorers;
}

JavaScript GetDocumentViewDetails DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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

GET /api/getdocumentviewdetails HTTP/1.1 
Host: test-dogw.klokgroep.nl 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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}],"IsDirectSearch":false}