OverviewServicesGetOverview Method

Ingeniux CMS Web Services API

Retrieves the general overview information of both Ingeniux CMS Site information, and current user activities.

Namespace:  IngeniuxCMService
Assembly:  IngeniuxCMService (in IngeniuxCMService.dll) Version: 10.3.70
Syntax

public XHRServiceResponseGeneric<OverviewData> GetOverview()

Return Value

Type: XHRServiceResponseGenericOverviewData

The Ingeniux CMS global and current user information

Examples

Sample JSON return
JavaScript
{
    "code": 0,
    "error": null,
    "message": {
        "ActiveUsers": {
            "Error": "",
            "List": []
        },
        "CMSStatistics": {
            "SiteName": {
                "Name": "Content Store",
                "Value": ""
            },
            "Statistics": {
                "Error": "",
                "List": [{
                    "Name": "Current Pages",
                    "Value": "112"
                }, {
                    "Name": "Server Version",
                    "Value": "9.0.80"
                }, {
                    "Name": "Site Version",
                    "Value": "9.0.80"
                }, {
                    "Name": "Total Users",
                    "Value": "4"
                }, {
                    "Name": "Database Build",
                    "Value": "2750"
                }]
            }
        },
        "InProgress": {
            "Error": "",
            "List": [{
                "Icon": 99,
                "Id": "x32",
                "Name": "asdfsdf"
            }, {
                "Icon": 2,
                "Id": "x16",
                "Name": "Sign Up"
            }, {
                "Icon": 1,
                "Id": "x100",
                "Name": "Default Dynamic Schemas Test"
            }, {
                "Icon": 99,
                "Id": "x18",
                "Name": "asdfsdf"
            }, {
                "Icon": 9,
                "Id": "x95",
                "Name": "SOAP"
            }, {
                "Icon": 99,
                "Id": "x29",
                "Name": "asdfsdf"
            }, {
                "Icon": 99,
                "Id": "x24",
                "Name": "asdfsdf"
            }, {
                "Icon": 99,
                "Id": "x43",
                "Name": "asdfsdf"
            }, {
                "Icon": 4,
                "Id": "x96",
                "Name": "Poll"
            }, {
                "Icon": 4,
                "Id": "x86",
                "Name": "Insert Test"
            }, {
                "Icon": 9,
                "Id": "x102",
                "Name": "dbquery"
            }, {
                "Icon": 9,
                "Id": "x101",
                "Name": "dbquery"
            }, {
                "Icon": 99,
                "Id": "x88",
                "Name": "adsfdfs"
            }, {
                "Icon": 4,
                "Id": "x98",
                "Name": "Json - Post with Auth"
            }, {
                "Icon": 9,
                "Id": "x105",
                "Name": "Emailer"
            }, {
                "Icon": 99,
                "Id": "x17",
                "Name": "HomeSlider"
            }, {
                "Icon": 9,
                "Id": "x108",
                "Name": "Soap"
            }, {
                "Icon": 99,
                "Id": "x33",
                "Name": "HomeSlider"
            }, {
                "Icon": 9,
                "Id": "x103",
                "Name": "Poll"
            }, {
                "Icon": 9,
                "Id": "x104",
                "Name": "Json"
            }, {
                "Icon": 99,
                "Id": "x46",
                "Name": "asdfsdf"
            }, {
                "Icon": 9,
                "Id": "x109",
                "Name": "soap1.2"
            }, {
                "Icon": 4,
                "Id": "x97",
                "Name": "Json"
            }, {
                "Icon": 9,
                "Id": "x110",
                "Name": "CompTest"
            }, {
                "Icon": 99,
                "Id": "x61",
                "Name": "asdfsdf"
            }, {
                "Icon": 99,
                "Id": "x87",
                "Name": "Test"
            }, {
                "Icon": 99,
                "Id": "x50",
                "Name": "asdfsdf"
            }, {
                "Icon": 99,
                "Id": "x51",
                "Name": "HomeSlider"
            }, {
                "Icon": 11,
                "Id": "x93",
                "Name": "Email"
            }, {
                "Icon": 99,
                "Id": "x69",
                "Name": "HomeSlider"
            }, {
                "Icon": 1,
                "Id": "x2",
                "Name": "Site"
            }, {
                "Icon": 9,
                "Id": "x111",
                "Name": "CompTest2"
            }, {
                "Icon": 1,
                "Id": "x15",
                "Name": "Forms"
            }, {
                "Icon": 11,
                "Id": "x92",
                "Name": "Emailer"
            }, {
                "Icon": 4,
                "Id": "x90",
                "Name": "DBQuery Test"
            }, {
                "Icon": 1,
                "Id": "x12",
                "Name": "What We Offer"
            }, {
                "Icon": 2,
                "Id": "x11",
                "Name": "About Us"
            }, {
                "Icon": 99,
                "Id": "x68",
                "Name": "asdfsdf"
            }, {
                "Icon": 99,
                "Id": "x112",
                "Name": "List"
            }, {
                "Icon": 3,
                "Id": "x116",
                "Name": "zBrush"
            }, {
                "Icon": 11,
                "Id": "x94",
                "Name": "Emailer"
            }, {
                "Icon": 4,
                "Id": "x91",
                "Name": "DB Query"
            }, {
                "Icon": 8,
                "Id": "x5",
                "Name": "Home"
            }, {
                "Icon": 99,
                "Id": "x19",
                "Name": "SiteControl"
            }, {
                "Icon": 99,
                "Id": "x64",
                "Name": "asdfsdf"
            }, {
                "Icon": 99,
                "Id": "x79",
                "Name": "asdfsdf"
            }, {
                "Icon": 99,
                "Id": "x82",
                "Name": "asdfsdf"
            }]
        },
        "PageCreationRules": {
            "Error": "",
            "List": [{
                "Icon": 3,
                "Id": "PageCreationRules\/1",
                "Name": "Image",
                "Schema": "Image File"
            }]
        },
        "Preferences": {
            "Error": null,
            "RecentPages": [{
                "Icon": 9,
                "Id": "x102",
                "Name": "dbquery"
            }, {
                "Icon": 9,
                "Id": "x95",
                "Name": "SOAP"
            }, {
                "Icon": 9,
                "Id": "x108",
                "Name": "Soap"
            }, {
                "Icon": 9,
                "Id": "x109",
                "Name": "soap1.2"
            }, {
                "Icon": 9,
                "Id": "x110",
                "Name": "CompTest"
            }, {
                "Icon": 99,
                "Id": "x112",
                "Name": "List"
            }, {
                "Icon": 2,
                "Id": "x9",
                "Name": "Terms"
            }, {
                "Icon": 99,
                "Id": "x19",
                "Name": "SiteControl"
            }, {
                "Icon": 9,
                "Id": "x111",
                "Name": "CompTest2"
            }, {
                "Icon": 2,
                "Id": "x11",
                "Name": "About Us"
            }],
            "WatchedPages": []
        },
        "PublishStats": {
            "Error": "",
            "List": [{
                "LastPubDate": "20131211T12:18:55",
                "Name": "Live",
                "Value": "14"
            }, {
                "LastPubDate": "",
                "Name": "Staging",
                "Value": "5"
            }, {
                "LastPubDate": "",
                "Name": "Staging 2",
                "Value": "0"
            }]
        }
    }
}
See Also

Reference