Click or drag to resize

SiteDefinitionsLocalizationServicesGetSchema Method

Retrieves a single Schema's localization

Namespace:  IngeniuxCMService
Assembly:  IngeniuxCMService (in IngeniuxCMService.dll) Version: 10.3.169
Syntax
Copy
public XHRServiceResponseGeneric<SchemaLocalizationData> GetSchema(
	SingleSiteDefitionLocalizationGetInput data
)

Parameters

data
Type: SingleSiteDefitionLocalizationGetInput

Object containng Schema Id and original Schema name

Examples
Sample JSON return
JavaScript
Copy
{
    "data": {
        "id": "Details",
        "label": "Schema Friendly Name:"
    }
}

Return Value

Type: XHRServiceResponseGenericSchemaLocalizationData

Localization of the given Schema, including Schema name, description and localization of all its fields

Examples
Sample JSON return
JavaScript
Copy
{
    "code": 0,
    "error": null,
    "message": {
        "children": [{
            "name": "Title",
            "firstEntry": {
                "label": "Label:",
                "original": "Title",
                "target": "",
                "name": "Label"
            },
            "isDone": false,
            "label": "Title",
            "secondEntry": {
                "label": "Help Text:",
                "original": "",
                "target": "",
                "name": "HelpText"
            }
        }, {
            "name": "BodyCopy",
            "firstEntry": {
                "label": "Label:",
                "original": "Body Copy",
                "target": "",
                "name": "Label"
            },
            "isDone": false,
            "label": "Body Copy",
            "secondEntry": {
                "label": "Help Text:",
                "original": "",
                "target": "",
                "name": "HelpText"
            }
        }, {
            "name": "SiteControl",
            "firstEntry": {
                "label": "Label:",
                "original": "Site Control",
                "target": "",
                "name": "Label"
            },
            "isDone": false,
            "label": "Site Control",
            "secondEntry": {
                "label": "Help Text:",
                "original": "",
                "target": "",
                "name": "HelpText"
            }
        }, {
            "name": "AncestorNavigation",
            "firstEntry": {
                "label": "Label:",
                "original": "Ancestor Navigation",
                "target": "",
                "name": "Label"
            },
            "isDone": false,
            "label": "Ancestor Navigation",
            "secondEntry": {
                "label": "Help Text:",
                "original": "",
                "target": "",
                "name": "HelpText"
            }
        }],
        "descriptionField": null,
        "nameField": {
            "label": "Schema Friendly Name:",
            "original": "Details",
            "target": ""
        },
        "isIncomplete": true,
        "isOutDated": true,
        "isTranslated": false,
        "metaData": "Details"
    }
}
Remarks

If Schema doesn't exist, returns error status

If Localization for Schema doesn't exist, all the "isDone" field of transition entries are "false"

See Also