GET api/{siteName}/config

Request Information

URI Parameters

NameDescriptionTypeAdditional information
siteName

string

Required

Body Parameters

None.

Response Information

Resource Description

SiteConfig
NameDescriptionTypeAdditional information
SiteName

string

None.

SiteWebAppName

string

None.

EventsUsed

boolean

None.

PrsUsed

boolean

None.

PagesUsed

boolean

None.

Sections

string

None.

MenuItems

string

None.

Keywords

string

None.

Description

string

None.

Title

string

None.

MainMenuId

string

None.

HeaderLinks

Collection of LinkItem

None.

FooterLinks

Collection of LinkItem

None.

Response Formats

application/json, text/json

Sample:
{
  "SiteName": "sample string 1",
  "SiteWebAppName": "sample string 2",
  "EventsUsed": true,
  "PrsUsed": true,
  "PagesUsed": true,
  "Sections": "sample string 6",
  "MenuItems": "sample string 7",
  "Keywords": "sample string 8",
  "Description": "sample string 9",
  "Title": "sample string 10",
  "MainMenuId": "sample string 11",
  "HeaderLinks": [
    {
      "Description": "sample string 1",
      "Link": "sample string 2",
      "LinkTarget": true,
      "PageId": "sample string 4",
      "SortValue": 5
    },
    {
      "Description": "sample string 1",
      "Link": "sample string 2",
      "LinkTarget": true,
      "PageId": "sample string 4",
      "SortValue": 5
    }
  ],
  "FooterLinks": [
    {
      "Description": "sample string 1",
      "Link": "sample string 2",
      "LinkTarget": true,
      "PageId": "sample string 4",
      "SortValue": 5
    },
    {
      "Description": "sample string 1",
      "Link": "sample string 2",
      "LinkTarget": true,
      "PageId": "sample string 4",
      "SortValue": 5
    }
  ]
}

application/xml, text/xml

Sample:
<SiteConfig xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MediaKit.Models">
  <Description>sample string 9</Description>
  <EventsUsed>true</EventsUsed>
  <FooterLinks>
    <LinkItem>
      <Description>sample string 1</Description>
      <Link>sample string 2</Link>
      <LinkTarget>true</LinkTarget>
      <PageId>sample string 4</PageId>
      <SortValue>5</SortValue>
    </LinkItem>
    <LinkItem>
      <Description>sample string 1</Description>
      <Link>sample string 2</Link>
      <LinkTarget>true</LinkTarget>
      <PageId>sample string 4</PageId>
      <SortValue>5</SortValue>
    </LinkItem>
  </FooterLinks>
  <HeaderLinks>
    <LinkItem>
      <Description>sample string 1</Description>
      <Link>sample string 2</Link>
      <LinkTarget>true</LinkTarget>
      <PageId>sample string 4</PageId>
      <SortValue>5</SortValue>
    </LinkItem>
    <LinkItem>
      <Description>sample string 1</Description>
      <Link>sample string 2</Link>
      <LinkTarget>true</LinkTarget>
      <PageId>sample string 4</PageId>
      <SortValue>5</SortValue>
    </LinkItem>
  </HeaderLinks>
  <Keywords>sample string 8</Keywords>
  <MainMenuId>sample string 11</MainMenuId>
  <MenuItems>sample string 7</MenuItems>
  <PagesUsed>true</PagesUsed>
  <PrsUsed>true</PrsUsed>
  <Sections>sample string 6</Sections>
  <SiteName>sample string 1</SiteName>
  <SiteWebAppName>sample string 2</SiteWebAppName>
  <Title>sample string 10</Title>
</SiteConfig>