getPageTypeSkins()

Pixelsilk API function to get the skins object for a page type--requires the advanced-admin-access permission

Parameters:
pageTypeId: the unique identifier for the page type

Output:
The function getPageTypeSkins returns an object containing the skins

C# Example:

Guid pageTypeId = <page type's id>;
object pageTypeSkins = GetPageTypeSkins(pageTypeId);

Note the capital first letter of the C# method.

HTTP Example:

Request Headers:
POST /api2/getPageTypeSkins HTTP/1.1
HOST: www.example.com
Content-Length: 124
Content-Type: application/x-www-form-urlencoded
Cookie: auth=983FA759425E...308AD7097B7B

Request Data:
Unencoded Data:
json={
   "pageTypeId":"56e7e8e2-fb4a-4aea-8bdb-d335f0e83462"
}&token=7AdbNHZQBtwc...RPTEK8UvSUQ=

Url-encoded Data:
json=%7b%0d%0a+++...%22%0d%0a%7d&token=7AdbNHZQBtwc...TEK8UvSUQ%3d

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

Response Data:
{
   "id":"",
   "content":"",
   "viewItem":"",
   "alternatingItem":"",
   "addEditItem":"",
   "itemDetail":"",
   "firstItem":"",
   "separator":"",
   "lastItem":"",
   "activeItem":"",
   "isSectionSkin":false,
   "sectionId":"",
   "typeId":null
}
NOTE: The skin contents have been removed so you can see
the organization of the returned data easily.

JavaScript Example:

Method Call:
pixelsilk2.getPageTypeSkins(input, callback);

Input Object:
{
    pageTypeId:"9e46a476-e8ac-488b-91e0-4d57b2dbaf6d"
}

Returned Data:
{
    "id":"27356162-c281-45a5-83e9-f82179c01ba3",
    "content":"<div></div>",
    "viewItem":"    ",
    "alternatingItem":"",
    "addEditItem":"",
    "itemDetail":"    ",
    "firstItem":"",
    "separator":"",
    "lastItem":"",
    "activeItem":"",
    "isSectionSkin":false,
    "sectionId":null,
    "typeId":"9e46a476-e8ac-488b-91e0-4d57b2dbaf6d"
}

Back to Page Types »