DigiOffice Gateway Web Services

<back to all web services

ViewsAndExplorers

Requires Authentication 
"use strict";
export class Node {
    /** @param {{EntityName?:string,ID?:string,ParentID?:string,Title?:string,Count?:number,ImageKey?:string,Expanded?:boolean,Selected?:boolean,DisplayPath?:string,ChildNodes?:Node[],RegistrationPathElement?:string,QueryPathElement?:string,Path?:string,IsHierarchy?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    EntityName;
    /** @type {string} */
    ID;
    /** @type {string} */
    ParentID;
    /** @type {string} */
    Title;
    /** @type {?number} */
    Count;
    /** @type {string} */
    ImageKey;
    /** @type {boolean} */
    Expanded;
    /** @type {boolean} */
    Selected;
    /** @type {string} */
    DisplayPath;
    /** @type {Node[]} */
    ChildNodes;
    /** @type {string} */
    RegistrationPathElement;
    /** @type {string} */
    QueryPathElement;
    /** @type {string} */
    Path;
    /** @type {boolean} */
    IsHierarchy;
}
export class ViewExplorerNode extends Node {
    /** @param {{ViewId?:string,ExplorerId?:string,ChildNodes?:ViewExplorerNode[],EntityName?:string,ID?:string,ParentID?:string,Title?:string,Count?:number,ImageKey?:string,Expanded?:boolean,Selected?:boolean,DisplayPath?:string,ChildNodes?:Node[],RegistrationPathElement?:string,QueryPathElement?:string,Path?:string,IsHierarchy?:boolean}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {?string} */
    ViewId;
    /** @type {?string} */
    ExplorerId;
    /** @type {ViewExplorerNode[]} */
    ChildNodes;
}
export class ViewsAndExplorers {
    /** @param {{Nodes?:ViewExplorerNode[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ViewExplorerNode[]} */
    Nodes;
}

JavaScript ViewsAndExplorers 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.

POST /csv/reply/ViewsAndExplorers HTTP/1.1 
Host: test-dogw.klokgroep.nl 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Nodes":[{"ViewId":"00000000-0000-0000-0000-000000000000","ExplorerId":"00000000-0000-0000-0000-000000000000","ChildNodes":[{"ViewId":"00000000-0000-0000-0000-000000000000","ExplorerId":"00000000-0000-0000-0000-000000000000","ChildNodes":[{"ViewId":"00000000-0000-0000-0000-000000000000","ExplorerId":"00000000-0000-0000-0000-000000000000","ChildNodes":null,"EntityName":"String","ID":"String","ParentID":"String","Title":"String","Count":0,"ImageKey":"String","Expanded":false,"Selected":false,"DisplayPath":"String","ChildNodes":[{"EntityName":"String","ID":"String","ParentID":"String","Title":"String","Count":0,"ImageKey":"String","Expanded":false,"Selected":false,"DisplayPath":"String","ChildNodes":[{"EntityName":"String","ID":"String","ParentID":"String","Title":"String","Count":0,"ImageKey":"String","Expanded":false,"Selected":false,"DisplayPath":"String","ChildNodes":[{"EntityName":"String","ID":"String","ParentID":"String","Title":"String","Count":0,"ImageKey":"String","Expanded":false,"Selected":false,"DisplayPath":"String","ChildNodes":null,"RegistrationPathElement":"String","QueryPathElement":"String","Path":"String","IsHierarchy":false}],"RegistrationPathElement":"String","QueryPathElement":"String","Path":"String","IsHierarchy":false}],"RegistrationPathElement":"String","QueryPathElement":"String","Path":"String","IsHierarchy":false}],"RegistrationPathElement":"String","QueryPathElement":"String","Path":"String","IsHierarchy":false}],"EntityName":"String","ID":"String","ParentID":"String","Title":"String","Count":0,"ImageKey":"String","Expanded":false,"Selected":false,"DisplayPath":"String","ChildNodes":[{"EntityName":"String","ID":"String","ParentID":"String","Title":"String","Count":0,"ImageKey":"String","Expanded":false,"Selected":false,"DisplayPath":"String","ChildNodes":[{"EntityName":"String","ID":"String","ParentID":"String","Title":"String","Count":0,"ImageKey":"String","Expanded":false,"Selected":false,"DisplayPath":"String","ChildNodes":[{"EntityName":"String","ID":"String","ParentID":"String","Title":"String","Count":0,"ImageKey":"String","Expanded":false,"Selected":false,"DisplayPath":"String","ChildNodes":null,"RegistrationPathElement":"String","QueryPathElement":"String","Path":"String","IsHierarchy":false}],"RegistrationPathElement":"String","QueryPathElement":"String","Path":"String","IsHierarchy":false}],"RegistrationPathElement":"String","QueryPathElement":"String","Path":"String","IsHierarchy":false}],"RegistrationPathElement":"String","QueryPathElement":"String","Path":"String","IsHierarchy":false}],"EntityName":"String","ID":"String","ParentID":"String","Title":"String","Count":0,"ImageKey":"String","Expanded":false,"Selected":false,"DisplayPath":"String","ChildNodes":[{"EntityName":"String","ID":"String","ParentID":"String","Title":"String","Count":0,"ImageKey":"String","Expanded":false,"Selected":false,"DisplayPath":"String","ChildNodes":[{"EntityName":"String","ID":"String","ParentID":"String","Title":"String","Count":0,"ImageKey":"String","Expanded":false,"Selected":false,"DisplayPath":"String","ChildNodes":[{"EntityName":"String","ID":"String","ParentID":"String","Title":"String","Count":0,"ImageKey":"String","Expanded":false,"Selected":false,"DisplayPath":"String","ChildNodes":null,"RegistrationPathElement":"String","QueryPathElement":"String","Path":"String","IsHierarchy":false}],"RegistrationPathElement":"String","QueryPathElement":"String","Path":"String","IsHierarchy":false}],"RegistrationPathElement":"String","QueryPathElement":"String","Path":"String","IsHierarchy":false}],"RegistrationPathElement":"String","QueryPathElement":"String","Path":"String","IsHierarchy":false}]}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Nodes":[{"ViewId":"00000000-0000-0000-0000-000000000000","ExplorerId":"00000000-0000-0000-0000-000000000000","ChildNodes":[{"ViewId":"00000000-0000-0000-0000-000000000000","ExplorerId":"00000000-0000-0000-0000-000000000000","ChildNodes":[{"ViewId":"00000000-0000-0000-0000-000000000000","ExplorerId":"00000000-0000-0000-0000-000000000000","ChildNodes":null,"EntityName":"String","ID":"String","ParentID":"String","Title":"String","Count":0,"ImageKey":"String","Expanded":false,"Selected":false,"DisplayPath":"String","ChildNodes":[{"EntityName":"String","ID":"String","ParentID":"String","Title":"String","Count":0,"ImageKey":"String","Expanded":false,"Selected":false,"DisplayPath":"String","ChildNodes":[{"EntityName":"String","ID":"String","ParentID":"String","Title":"String","Count":0,"ImageKey":"String","Expanded":false,"Selected":false,"DisplayPath":"String","ChildNodes":[{"EntityName":"String","ID":"String","ParentID":"String","Title":"String","Count":0,"ImageKey":"String","Expanded":false,"Selected":false,"DisplayPath":"String","ChildNodes":null,"RegistrationPathElement":"String","QueryPathElement":"String","Path":"String","IsHierarchy":false}],"RegistrationPathElement":"String","QueryPathElement":"String","Path":"String","IsHierarchy":false}],"RegistrationPathElement":"String","QueryPathElement":"String","Path":"String","IsHierarchy":false}],"RegistrationPathElement":"String","QueryPathElement":"String","Path":"String","IsHierarchy":false}],"EntityName":"String","ID":"String","ParentID":"String","Title":"String","Count":0,"ImageKey":"String","Expanded":false,"Selected":false,"DisplayPath":"String","ChildNodes":[{"EntityName":"String","ID":"String","ParentID":"String","Title":"String","Count":0,"ImageKey":"String","Expanded":false,"Selected":false,"DisplayPath":"String","ChildNodes":[{"EntityName":"String","ID":"String","ParentID":"String","Title":"String","Count":0,"ImageKey":"String","Expanded":false,"Selected":false,"DisplayPath":"String","ChildNodes":[{"EntityName":"String","ID":"String","ParentID":"String","Title":"String","Count":0,"ImageKey":"String","Expanded":false,"Selected":false,"DisplayPath":"String","ChildNodes":null,"RegistrationPathElement":"String","QueryPathElement":"String","Path":"String","IsHierarchy":false}],"RegistrationPathElement":"String","QueryPathElement":"String","Path":"String","IsHierarchy":false}],"RegistrationPathElement":"String","QueryPathElement":"String","Path":"String","IsHierarchy":false}],"RegistrationPathElement":"String","QueryPathElement":"String","Path":"String","IsHierarchy":false}],"EntityName":"String","ID":"String","ParentID":"String","Title":"String","Count":0,"ImageKey":"String","Expanded":false,"Selected":false,"DisplayPath":"String","ChildNodes":[{"EntityName":"String","ID":"String","ParentID":"String","Title":"String","Count":0,"ImageKey":"String","Expanded":false,"Selected":false,"DisplayPath":"String","ChildNodes":[{"EntityName":"String","ID":"String","ParentID":"String","Title":"String","Count":0,"ImageKey":"String","Expanded":false,"Selected":false,"DisplayPath":"String","ChildNodes":[{"EntityName":"String","ID":"String","ParentID":"String","Title":"String","Count":0,"ImageKey":"String","Expanded":false,"Selected":false,"DisplayPath":"String","ChildNodes":null,"RegistrationPathElement":"String","QueryPathElement":"String","Path":"String","IsHierarchy":false}],"RegistrationPathElement":"String","QueryPathElement":"String","Path":"String","IsHierarchy":false}],"RegistrationPathElement":"String","QueryPathElement":"String","Path":"String","IsHierarchy":false}],"RegistrationPathElement":"String","QueryPathElement":"String","Path":"String","IsHierarchy":false}]}