GET api/navigationlinks/hierarchy

GET: api/navigationlinks/hierarchy Get navigation hierarchy

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of NavigationSourceViewModel

Name	Description	Type	Additional information
ID	Id	integer	None.
Name	Name	string	None.
Categories	Categories	Collection of NavigationCategoryViewModel	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "id": 1,
    "name": "sample string 2",
    "categories": [
      {
        "id": 1,
        "name": "sample string 2",
        "sourceId": 1,
        "links": [
          {
            "isJobStreamEnabled": true,
            "link": "sample string 2",
            "isEnabled": true,
            "pageControls": [
              {
                "id": 1,
                "name": "sample string 2",
                "description": "sample string 3",
                "navigationLinkId": 1
              },
              {
                "id": 1,
                "name": "sample string 2",
                "description": "sample string 3",
                "navigationLinkId": 1
              }
            ],
            "id": 4,
            "name": "sample string 5",
            "categoryId": 6
          },
          {
            "isJobStreamEnabled": true,
            "link": "sample string 2",
            "isEnabled": true,
            "pageControls": [
              {
                "id": 1,
                "name": "sample string 2",
                "description": "sample string 3",
                "navigationLinkId": 1
              },
              {
                "id": 1,
                "name": "sample string 2",
                "description": "sample string 3",
                "navigationLinkId": 1
              }
            ],
            "id": 4,
            "name": "sample string 5",
            "categoryId": 6
          }
        ]
      },
      {
        "id": 1,
        "name": "sample string 2",
        "sourceId": 1,
        "links": [
          {
            "isJobStreamEnabled": true,
            "link": "sample string 2",
            "isEnabled": true,
            "pageControls": [
              {
                "id": 1,
                "name": "sample string 2",
                "description": "sample string 3",
                "navigationLinkId": 1
              },
              {
                "id": 1,
                "name": "sample string 2",
                "description": "sample string 3",
                "navigationLinkId": 1
              }
            ],
            "id": 4,
            "name": "sample string 5",
            "categoryId": 6
          },
          {
            "isJobStreamEnabled": true,
            "link": "sample string 2",
            "isEnabled": true,
            "pageControls": [
              {
                "id": 1,
                "name": "sample string 2",
                "description": "sample string 3",
                "navigationLinkId": 1
              },
              {
                "id": 1,
                "name": "sample string 2",
                "description": "sample string 3",
                "navigationLinkId": 1
              }
            ],
            "id": 4,
            "name": "sample string 5",
            "categoryId": 6
          }
        ]
      }
    ]
  },
  {
    "id": 1,
    "name": "sample string 2",
    "categories": [
      {
        "id": 1,
        "name": "sample string 2",
        "sourceId": 1,
        "links": [
          {
            "isJobStreamEnabled": true,
            "link": "sample string 2",
            "isEnabled": true,
            "pageControls": [
              {
                "id": 1,
                "name": "sample string 2",
                "description": "sample string 3",
                "navigationLinkId": 1
              },
              {
                "id": 1,
                "name": "sample string 2",
                "description": "sample string 3",
                "navigationLinkId": 1
              }
            ],
            "id": 4,
            "name": "sample string 5",
            "categoryId": 6
          },
          {
            "isJobStreamEnabled": true,
            "link": "sample string 2",
            "isEnabled": true,
            "pageControls": [
              {
                "id": 1,
                "name": "sample string 2",
                "description": "sample string 3",
                "navigationLinkId": 1
              },
              {
                "id": 1,
                "name": "sample string 2",
                "description": "sample string 3",
                "navigationLinkId": 1
              }
            ],
            "id": 4,
            "name": "sample string 5",
            "categoryId": 6
          }
        ]
      },
      {
        "id": 1,
        "name": "sample string 2",
        "sourceId": 1,
        "links": [
          {
            "isJobStreamEnabled": true,
            "link": "sample string 2",
            "isEnabled": true,
            "pageControls": [
              {
                "id": 1,
                "name": "sample string 2",
                "description": "sample string 3",
                "navigationLinkId": 1
              },
              {
                "id": 1,
                "name": "sample string 2",
                "description": "sample string 3",
                "navigationLinkId": 1
              }
            ],
            "id": 4,
            "name": "sample string 5",
            "categoryId": 6
          },
          {
            "isJobStreamEnabled": true,
            "link": "sample string 2",
            "isEnabled": true,
            "pageControls": [
              {
                "id": 1,
                "name": "sample string 2",
                "description": "sample string 3",
                "navigationLinkId": 1
              },
              {
                "id": 1,
                "name": "sample string 2",
                "description": "sample string 3",
                "navigationLinkId": 1
              }
            ],
            "id": 4,
            "name": "sample string 5",
            "categoryId": 6
          }
        ]
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfNavigationSourceViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
  <NavigationSourceViewModel>
    <Categories>
      <NavigationCategoryViewModel>
        <ID>1</ID>
        <Links>
          <NavigationLinkViewModel>
            <CategoryId>6</CategoryId>
            <Id>4</Id>
            <Name>sample string 5</Name>
            <IsEnabled>true</IsEnabled>
            <IsJobStreamEnabled>true</IsJobStreamEnabled>
            <Link>sample string 2</Link>
            <PageControls>
              <PageControlViewModel>
                <Description>sample string 3</Description>
                <Id>1</Id>
                <Name>sample string 2</Name>
                <NavigationLinkId>1</NavigationLinkId>
              </PageControlViewModel>
              <PageControlViewModel>
                <Description>sample string 3</Description>
                <Id>1</Id>
                <Name>sample string 2</Name>
                <NavigationLinkId>1</NavigationLinkId>
              </PageControlViewModel>
            </PageControls>
          </NavigationLinkViewModel>
          <NavigationLinkViewModel>
            <CategoryId>6</CategoryId>
            <Id>4</Id>
            <Name>sample string 5</Name>
            <IsEnabled>true</IsEnabled>
            <IsJobStreamEnabled>true</IsJobStreamEnabled>
            <Link>sample string 2</Link>
            <PageControls>
              <PageControlViewModel>
                <Description>sample string 3</Description>
                <Id>1</Id>
                <Name>sample string 2</Name>
                <NavigationLinkId>1</NavigationLinkId>
              </PageControlViewModel>
              <PageControlViewModel>
                <Description>sample string 3</Description>
                <Id>1</Id>
                <Name>sample string 2</Name>
                <NavigationLinkId>1</NavigationLinkId>
              </PageControlViewModel>
            </PageControls>
          </NavigationLinkViewModel>
        </Links>
        <Name>sample string 2</Name>
        <SourceId>1</SourceId>
      </NavigationCategoryViewModel>
      <NavigationCategoryViewModel>
        <ID>1</ID>
        <Links>
          <NavigationLinkViewModel>
            <CategoryId>6</CategoryId>
            <Id>4</Id>
            <Name>sample string 5</Name>
            <IsEnabled>true</IsEnabled>
            <IsJobStreamEnabled>true</IsJobStreamEnabled>
            <Link>sample string 2</Link>
            <PageControls>
              <PageControlViewModel>
                <Description>sample string 3</Description>
                <Id>1</Id>
                <Name>sample string 2</Name>
                <NavigationLinkId>1</NavigationLinkId>
              </PageControlViewModel>
              <PageControlViewModel>
                <Description>sample string 3</Description>
                <Id>1</Id>
                <Name>sample string 2</Name>
                <NavigationLinkId>1</NavigationLinkId>
              </PageControlViewModel>
            </PageControls>
          </NavigationLinkViewModel>
          <NavigationLinkViewModel>
            <CategoryId>6</CategoryId>
            <Id>4</Id>
            <Name>sample string 5</Name>
            <IsEnabled>true</IsEnabled>
            <IsJobStreamEnabled>true</IsJobStreamEnabled>
            <Link>sample string 2</Link>
            <PageControls>
              <PageControlViewModel>
                <Description>sample string 3</Description>
                <Id>1</Id>
                <Name>sample string 2</Name>
                <NavigationLinkId>1</NavigationLinkId>
              </PageControlViewModel>
              <PageControlViewModel>
                <Description>sample string 3</Description>
                <Id>1</Id>
                <Name>sample string 2</Name>
                <NavigationLinkId>1</NavigationLinkId>
              </PageControlViewModel>
            </PageControls>
          </NavigationLinkViewModel>
        </Links>
        <Name>sample string 2</Name>
        <SourceId>1</SourceId>
      </NavigationCategoryViewModel>
    </Categories>
    <ID>1</ID>
    <Name>sample string 2</Name>
  </NavigationSourceViewModel>
  <NavigationSourceViewModel>
    <Categories>
      <NavigationCategoryViewModel>
        <ID>1</ID>
        <Links>
          <NavigationLinkViewModel>
            <CategoryId>6</CategoryId>
            <Id>4</Id>
            <Name>sample string 5</Name>
            <IsEnabled>true</IsEnabled>
            <IsJobStreamEnabled>true</IsJobStreamEnabled>
            <Link>sample string 2</Link>
            <PageControls>
              <PageControlViewModel>
                <Description>sample string 3</Description>
                <Id>1</Id>
                <Name>sample string 2</Name>
                <NavigationLinkId>1</NavigationLinkId>
              </PageControlViewModel>
              <PageControlViewModel>
                <Description>sample string 3</Description>
                <Id>1</Id>
                <Name>sample string 2</Name>
                <NavigationLinkId>1</NavigationLinkId>
              </PageControlViewModel>
            </PageControls>
          </NavigationLinkViewModel>
          <NavigationLinkViewModel>
            <CategoryId>6</CategoryId>
            <Id>4</Id>
            <Name>sample string 5</Name>
            <IsEnabled>true</IsEnabled>
            <IsJobStreamEnabled>true</IsJobStreamEnabled>
            <Link>sample string 2</Link>
            <PageControls>
              <PageControlViewModel>
                <Description>sample string 3</Description>
                <Id>1</Id>
                <Name>sample string 2</Name>
                <NavigationLinkId>1</NavigationLinkId>
              </PageControlViewModel>
              <PageControlViewModel>
                <Description>sample string 3</Description>
                <Id>1</Id>
                <Name>sample string 2</Name>
                <NavigationLinkId>1</NavigationLinkId>
              </PageControlViewModel>
            </PageControls>
          </NavigationLinkViewModel>
        </Links>
        <Name>sample string 2</Name>
        <SourceId>1</SourceId>
      </NavigationCategoryViewModel>
      <NavigationCategoryViewModel>
        <ID>1</ID>
        <Links>
          <NavigationLinkViewModel>
            <CategoryId>6</CategoryId>
            <Id>4</Id>
            <Name>sample string 5</Name>
            <IsEnabled>true</IsEnabled>
            <IsJobStreamEnabled>true</IsJobStreamEnabled>
            <Link>sample string 2</Link>
            <PageControls>
              <PageControlViewModel>
                <Description>sample string 3</Description>
                <Id>1</Id>
                <Name>sample string 2</Name>
                <NavigationLinkId>1</NavigationLinkId>
              </PageControlViewModel>
              <PageControlViewModel>
                <Description>sample string 3</Description>
                <Id>1</Id>
                <Name>sample string 2</Name>
                <NavigationLinkId>1</NavigationLinkId>
              </PageControlViewModel>
            </PageControls>
          </NavigationLinkViewModel>
          <NavigationLinkViewModel>
            <CategoryId>6</CategoryId>
            <Id>4</Id>
            <Name>sample string 5</Name>
            <IsEnabled>true</IsEnabled>
            <IsJobStreamEnabled>true</IsJobStreamEnabled>
            <Link>sample string 2</Link>
            <PageControls>
              <PageControlViewModel>
                <Description>sample string 3</Description>
                <Id>1</Id>
                <Name>sample string 2</Name>
                <NavigationLinkId>1</NavigationLinkId>
              </PageControlViewModel>
              <PageControlViewModel>
                <Description>sample string 3</Description>
                <Id>1</Id>
                <Name>sample string 2</Name>
                <NavigationLinkId>1</NavigationLinkId>
              </PageControlViewModel>
            </PageControls>
          </NavigationLinkViewModel>
        </Links>
        <Name>sample string 2</Name>
        <SourceId>1</SourceId>
      </NavigationCategoryViewModel>
    </Categories>
    <ID>1</ID>
    <Name>sample string 2</Name>
  </NavigationSourceViewModel>
</ArrayOfNavigationSourceViewModel>