DigiOffice Gateway Web Services

<back to all web services

ViewsAndExplorers

Requires Authentication

export class Node
{
    public EntityName?: string;
    public ID?: string;
    public ParentID?: string;
    public Title?: string;
    public Count?: number;
    public ImageKey?: string;
    public Expanded?: boolean;
    public Selected?: boolean;
    public DisplayPath?: string;
    public ChildNodes?: Node[];
    public RegistrationPathElement?: string;
    public QueryPathElement?: string;
    public Path?: string;
    public IsHierarchy?: boolean;

    public constructor(init?: Partial<Node>) { (Object as any).assign(this, init); }
}

export class ViewExplorerNode extends Node
{
    public ViewId?: string;
    public ExplorerId?: string;
    public ChildNodes?: ViewExplorerNode[];

    public constructor(init?: Partial<ViewExplorerNode>) { super(init); (Object as any).assign(this, init); }
}

export class ViewsAndExplorers
{
    public Nodes?: ViewExplorerNode[];

    public constructor(init?: Partial<ViewsAndExplorers>) { (Object as any).assign(this, init); }
}

TypeScript ViewsAndExplorers DTOs

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

HTTP + JSV

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

POST /jsv/reply/ViewsAndExplorers HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: text/jsv
Content-Type: text/jsv
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,
							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,
													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,
											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,
									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/jsv
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,
							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,
													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,
											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,
									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
		}
	]
}