DigiOffice API Services Services

GetNavigationContext

The following routes are available for this service:
GET	/api/navigation/context


export class CommonEntityIdentifier
{
    public ID: string;
    public DisplayName: string;
    public EntityName: string;

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

export class NavigationContext
{
    public Title: string;
    public NavigationElements: CommonEntityIdentifier[];

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

export class GetNavigationContext
{
    public ViewID: string;
    public Path: string;

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

TypeScript GetNavigationContext 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.

GET /api/navigation/context HTTP/1.1 
Host: test-do-services.klokgroep.nl 
Accept: application/xml

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

<NavigationContext xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Navigation">
  <NavigationElements xmlns:d2p1="http://schemas.datacontract.org/2004/07/IDB.API.DTO.General">
    <d2p1:CommonEntityIdentifier>
      <d2p1:DisplayName>String</d2p1:DisplayName>
      <d2p1:EntityName>String</d2p1:EntityName>
      <d2p1:ID>String</d2p1:ID>
    </d2p1:CommonEntityIdentifier>
  </NavigationElements>
  <Title>String</Title>
</NavigationContext>