SchemaDesignerServices.GetSchemas Method

SchemaDesignerServicesGetSchemas Method

Ingeniux CMS Web Services API

Retrieves listing of all Schemas. They are grouped into Page Schemas, Component Schemas and invalid Schemas

Namespace: IngeniuxCMService
Assembly: IngeniuxCMService (in IngeniuxCMService.dll) Version: 9.0.565.0 (9.0.565)

Syntax

C++

Copy

public XHRServiceResponseGeneric<SchemasListResult> GetSchemas()

Public Function GetSchemas As XHRServiceResponseGeneric(Of SchemasListResult)

public:
virtual XHRServiceResponseGeneric<SchemasListResult^>^ GetSchemas() sealed

abstract GetSchemas : unit -> XHRServiceResponseGeneric<SchemasListResult> 
override GetSchemas : unit -> XHRServiceResponseGeneric<SchemasListResult>

Return Value

Type: XHRServiceResponseGenericSchemasListResult

Object containing collections of Page Schemas, Component Schemas and invalid Schemas

Examples

Sample JSON return

JavaScript

Copy

{
    "code": 0,
    "error": null,
    "message": {
        "compSchemas": [{
            "CurrentVersion": 3,
            "Drafting": false,
            "Error": "",
            "File": "BinaryDocument",
            "HasPresentation": false,
            "ID": "Schema_BinaryDocument",
            "LastModified": "20140121T17:25:39",
            "LastModifiedUser": "INGENIUX\\awang",
            "Name": "{\"Name\":\"Binary Document\",\"Error\":\"\"}",
            "Root": "BinaryDocument",
            "Type": "View"
        }, {
            "CurrentVersion": 3,
            "Drafting": false,
            "Error": "",
            "File": "CompTest",
            "HasPresentation": false,
            "ID": "schemas\/449",
            "LastModified": "20140121T14:51:17",
            "LastModifiedUser": "INGENIUX\\awang",
            "Name": "{\"Name\":\"CompTest\",\"Error\":\"\"}",
            "Root": "CompTest",
            "Type": "View"
        }, {
            "CurrentVersion": 2,
            "Drafting": false,
            "Error": "",
            "File": "ContactInformation",
            "HasPresentation": false,
            "ID": "schemas\/227",
            "LastModified": "20140109T16:33:08",
            "LastModifiedUser": "INGENIUX\\awang",
            "Name": "{\"Name\":\"Contact Information\",\"Error\":\"\"}",
            "Root": "ContactInformation",
            "Type": "View"
        }, {
            "CurrentVersion": 1,
            "Drafting": false,
            "Error": "",
            "File": "DataBaseQuery",
            "HasPresentation": false,
            "ID": "Schema_DataBaseQuery",
            "LastModified": "20140109T17:07:41",
            "LastModifiedUser": "INGENIUX\\awang",
            "Name": "{\"Name\":\"DEX - Database Query Component\",\"Error\":\"\"}",
            "Root": "DataBaseQuery",
            "Type": "View"
        }, {
            "CurrentVersion": 1,
            "Drafting": false,
            "Error": "",
            "File": "PollServiceComponent",
            "HasPresentation": false,
            "ID": "Schema_PollServiceComponent",
            "LastModified": "20140109T17:07:41",
            "LastModifiedUser": "INGENIUX\\awang",
            "Name": "{\"Name\":\"DEX - Poll Service Component\",\"Error\":\"\"}",
            "Root": "PollServiceComponent",
            "Type": "View"
        }, {
            "CurrentVersion": 1,
            "Drafting": false,
            "Error": "",
            "File": "JSONServiceClient",
            "HasPresentation": false,
            "ID": "Schema_JSONServiceClient",
            "LastModified": "20140109T17:07:41",
            "LastModifiedUser": "INGENIUX\\awang",
            "Name": "{\"Name\":\"DEX - RESTful\/JSON Web Service Client\",\"Error\":\"\"}",
            "Root": "JSONServiceClient",
            "Type": "View"
        }],
        "invalidSchemas": [],
        "pageSchemas": [{
            "CurrentVersion": 4,
            "Drafting": false,
            "Error": "",
            "File": "Details",
            "HasPresentation": false,
            "ID": "schemas\/194",
            "LastModified": "20140109T16:33:08",
            "LastModifiedUser": "INGENIUX\\awang",
            "Name": "{\"Name\":\"Details\",\"Error\":\"\"}",
            "Root": "Details",
            "Type": "View"
        }, {
            "CurrentVersion": 0,
            "Drafting": true,
            "Error": "",
            "File": "FormFilteredResultPage",
            "HasPresentation": false,
            "ID": "schemas\/FormFilteredResultPage",
            "LastModified": "20140117T15:53:59",
            "LastModifiedUser": "INGENIUX\\awang",
            "Name": "{\"Name\":\"Form - Filtered Result Page\",\"Error\":\"\"}",
            "Root": "FormFilteredResultPage",
            "Type": "Stylesheet"
        }, {
            "CurrentVersion": 0,
            "Drafting": false,
            "Error": "",
            "File": "FormProcessorPage",
            "HasPresentation": false,
            "ID": "schemas\/FormProcessorPage",
            "LastModified": "20140109T16:33:08",
            "LastModifiedUser": "INGENIUX\\awang",
            "Name": "{\"Name\":\"Form Processor Page\",\"Error\":\"\"}",
            "Root": "FormProcessorPage",
            "Type": "Stylesheet"
        }, {
            "CurrentVersion": 2,
            "Drafting": false,
            "Error": "",
            "File": "Home",
            "HasPresentation": false,
            "ID": "schemas\/33",
            "LastModified": "20140109T16:33:08",
            "LastModifiedUser": "INGENIUX\\awang",
            "Name": "{\"Name\":\"Home Page\",\"Error\":\"\"}",
            "Root": "Home",
            "Type": "View"
        }]
    }
}

Remarks

Invalid schemas are Schema beyond repair and have to be fixed in the raw data level.

Each Schema entry has "Error" field, this field is used to indicate what type of fixable error the Schema has. These errors can be fixed via Schema editor.

Reference

SchemaDesignerServices Class

IngeniuxCMService Namespace