getSection()

Pixelsilk API function to get full information about a given section (page)--requires the edit-page-properties permission
Parameters:
sectionId: the unique identifier of the section (page)

Output:
The function getSection returns a section object containing all the properties associate with a section (page)

C# Example:
Guid sectionId = <section's id>;
object fullSection = GetSection(sectionId);
Note the capital first letter of the C# method.

HTTP Example:
Request Headers:
POST /api2/getSection HTTP/1.1
HOST: www.example.com
Content-Length: 108
Content-Type: application/x-www-form-urlencoded
Cookie: auth=C580E1F70BB9...7955044275A7

Request Data:
Unencoded Data:
json={"sectionId":"3c3299c1-1c41-4eea-a81b-7d1cfc5911ce"}&token=7AdbNHZQBtwc...RPTEK8UvSUQ=

Url-encoded Data:
json=%7b%22sectio...5911ce%22%7d&token=7AdbNHZQBtwc...TEK8UvSUQ%3d

Response Headers:
HTTP/1.1 200 OK
Set-Cookie: auth=F78D20BCD544...A9A8AA5B949; path=/
Content-Type: text/javascript; charset=UTF-8
Content-Length: 1550

Response Data:
{
  "isRoot":false,
  "path":"/",
  "sortOrder":2,
  "pageType":"HTML Page",
  "pageTypeId":"a866eeb2-1e6a-4e31-931a-d1839dc29418",
  "baseType":"HTML Page",
  "pathName":"ie1",
  "windowTitle":"ie1",
  "briefDescription":"ie1",
  "metaDescription":"",
  "siteMapDescription":"",
  "metaKeywords":"",
  "itemsPerPage":10,
  "linksPerPage":10,
  "childPageExtension":".aspx",
  "includeInXmlSiteMap":true,
  "siteMapPriority":null,
  "siteMapUpdateFrequency":null,
  "head":"",
  "listSectionRedirectMode":"DetailPage",
  "listSectionRedirect":null,
  "listSectionSendEmail":false,
  "listSectionEmailFromText":null,
  "listSectionEmailFromField":null,
  "listSectionEmailToText":null,
  "listSectionEmailToField":null,
  "listSectionEmailSubjectText":null,
  "listSectionEmailSubjectField":null,
  "listSectionEmailInsertItem":false,
  "listSectionEmailBody":null,
  "defaultView":"ShowListItems",
  "urlMode":"PathSlash",
  "urlModeParameter":null,
  "toLowerCase":false,
  "redirects":null,
  "description":null,
  "security":"Everyone|b69a7b39-7d88-47bf-835c-2baf14781aaa:view;
    Administrators|28702460-372d-4815-a594-92b9864b1085:edit,view",
  "sortQuery":null,
  "filterQuery":null,
  "theme":null,
  "menuName":"ie1",
  "id":"3c3299c1-1c41-4eea-a81b-7d1cfc5911ce",
  "urlRelative":"/ie1/",
  "enabled":true,
  "displayInNav":true,
  "includeInHtmlSiteMap":true,
  "approved":true,
  "typeImage":"Html",
  "typeName":"HTML Page",
  "children":[
    null
  ],
  "inheritSecurityFromParent":false,
  "inheritOptionsFromParent":false,
  "inheritUrlSettingsFromParent":false,
  "inheritAdvancedStettingsFromParent":false,
  "shouldBeEnabled":true,
  "shouldBeDisplayedInNav":true,
  "shouldBeVisibleInSiteMap":true,
  "isRoot":false
}

JavaScript Example:
Method Call:
pixelsilk2.getSection(input, callback);

Input Object:
{
    sectionId:"3c3299c1-1c41-4eea-a81b-7d1cfc5911ce"
}

Returned Data:
{
    "isRoot":false,
    "path":"/",
    "sortOrder":1,
    "pageType":"HTML Page",
    "pageTypeId":"a866eeb2-1e6a-4e31-931a-d1839dc29418",
    "baseType":"HTML Page",
    "pathName":"ie1",
    "windowTitle":"ie1",
    "briefDescription":"ie1",
    "metaDescription":"",
    "siteMapDescription":"",
    "metaKeywords":"",
    "itemsPerPage":10,
    "linksPerPage":10,
    "childPageExtension":".aspx",
    "includeInXmlSiteMap":true,
    "siteMapPriority":null,
    "siteMapUpdateFrequency":null,
    "head":"",
    "listSectionRedirectMode":"DetailPage",
    "listSectionRedirect":null,
    "listSectionSendEmail":false,
    "listSectionEmailFromText":null,
    "listSectionEmailFromField":null,
    "listSectionEmailToText":null,
    "listSectionEmailToField":null,
    "listSectionEmailSubjectText":null,
    "listSectionEmailSubjectField":null,
    "listSectionEmailInsertItem":false,
    "listSectionEmailBody":null,
    "defaultView":"ShowListItems",
    "urlMode":"PathSlash",
    "urlModeParameter":null,
    "toLowerCase":false,
    "redirects":null,
    "description":null,
    "security":"Everyone|b69a7b39-7d88-47bf-835c-2baf14781aaa:view;
        Administrators|28702460-372d-4815-a594-92b9864b1085:edit",
    view",
    "sortQuery":null,
    "filterQuery":null,
    "theme":null,
    "parent":{
        "isRoot":true,
        "path":"",
        "sortOrder":0,
        "pageType":"HTML Page",
        "pageTypeId":"a866eeb2-1e6a-4e31-931a-d1839dc29418",
        "baseType":"HTML Page",
        "pathName":"",
        "windowTitle":"localhost developer sandbox",
        "briefDescription":"Home",
        "metaDescription":"A content management system
            that knows what SEO specialists want to do.",
        "siteMapDescription":"",
        "metaKeywords":"test test",
        "itemsPerPage":0,
        "linksPerPage":10,
        "childPageExtension":".aspx",
        "includeInXmlSiteMap":true,
        "siteMapPriority":"",
        "siteMapUpdateFrequency":"",
        "head":"",
        "listSectionRedirectMode":"0",
        "listSectionRedirect":"null",
        "listSectionSendEmail":false,
        "listSectionEmailFromText":"null",
        "listSectionEmailFromField":null,
        "listSectionEmailToText":"null",
        "listSectionEmailToField":null,
        "listSectionEmailSubjectText":"null",
        "listSectionEmailSubjectField":null,
        "listSectionEmailInsertItem":false,
        "listSectionEmailBody":"null",
        "defaultView":"ShowListItems",
        "urlMode":"PathSlash",
        "urlModeParameter":"/null",
        "toLowerCase":false,
        "redirects":"",
        "description":"",
        "security":"Everyone|b69a7b39-7d88-47bf-835c-2baf14781aaa:view;
            Administrators|28702460-372d-4815-a594-92b9864b1085:edit",
        view;",
        "sortQuery":"null",
        "filterQuery":"null",
        "theme":"Default",
        "parent":null,
        "menuName":"Home",
        "id":"a1d8a436-8292-4487-8d2b-efb75e1f0ed2",
        "urlRelative":"/",
        "enabled":true,
        "displayInNav":true,
        "includeInHtmlSiteMap":true,
        "approved":true,
        "typeImage":"Html",
        "typeName":"HTML Page",
        "children":[
        ],
        "inheritSecurityFromParent":false,
        "inheritOptionsFromParent":false,
        "inheritUrlSettingsFromParent":false,
        "inheritAdvancedStettingsFromParent":false,
        "shouldBeEnabled":true,
        "shouldBeDisplayedInNav":true,
        "shouldBeVisibleInSiteMap":true
    },
    "menuName":"ie1",
    "id":"3c3299c1-1c41-4eea-a81b-7d1cfc5911ce",
    "urlRelative":"/ie1/",
    "enabled":true,
    "displayInNav":true,
    "includeInHtmlSiteMap":true,
    "approved":true,
    "typeImage":"Html",
    "typeName":"HTML Page",
    "children":[
        null
    ],
    "inheritSecurityFromParent":false,
    "inheritOptionsFromParent":false,
    "inheritUrlSettingsFromParent":false,
    "inheritAdvancedStettingsFromParent":false,
    "shouldBeEnabled":true,
    "shouldBeDisplayedInNav":true,
    "shouldBeVisibleInSiteMap":true
}

Back to Pages »