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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<GetDocumentViewDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document.Operations">
  <IncludeExplorers>false</IncludeExplorers>
  <Key>String</Key>
</GetDocumentViewDetails>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DocumentView xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document">
  <ChildrenCount xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.MobileViews">0</ChildrenCount>
  <Explorers xmlns:d2p1="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Navigation" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.MobileViews">
    <d2p1:Explorer>
      <d2p1:ID>00000000-0000-0000-0000-000000000000</d2p1:ID>
      <d2p1:Order>0</d2p1:Order>
      <d2p1:Title>String</d2p1:Title>
    </d2p1:Explorer>
  </Explorers>
  <ID xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.MobileViews">00000000-0000-0000-0000-000000000000</ID>
  <ImageUrl xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.MobileViews">String</ImageUrl>
  <Order xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.MobileViews">0</Order>
  <Title xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.MobileViews">String</Title>
  <SiteMapKey>String</SiteMapKey>
  <TranslateKey>String</TranslateKey>
</DocumentView>