DigiOffice Gateway Web Services

GetDocumentViewDetails

The following routes are available for this service:
GET POST	/api/documentviews/{Key}


export class Explorer
{
    public ID?: string;
    public Title?: string;
    public Order?: number;

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

// @DataContract
export class MobileView
{
    // @DataMember
    public ID?: string;

    // @DataMember
    public Title?: string;

    // @DataMember
    public ImageUrl?: string;

    // @DataMember
    public ChildrenCount?: number;

    // @DataMember
    public Order?: number;

    // @DataMember
    public Explorers?: Explorer[];

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

export class DocumentView extends MobileView
{
    // @DataMember
    public TranslateKey?: string;

    // @DataMember
    public SiteMapKey?: string;

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

export class GetDocumentViewDetails
{
    public Key?: string;
    public IncludeExplorers?: boolean;

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

TypeScript GetDocumentViewDetails 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 /api/documentviews/{Key} HTTP/1.1 
Host: digiofficeapigateway.deltares.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
		}
	]
}