MetaDataGetFormControlForFacadeObject

Initial Build	2011.01
xWeb	Web Method
Response Type	return type

The MetaDataGetFormControlForFacadeObject web method returns form control information for a specified facade object.

Parameters

• FormKey (guid).
• controlName (string).
• oNode (XML Node).

Response

Form control information.

Sample Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.avectra.com/2005/">

<soapenv:Header>

<ns:AuthorizationToken>

<!--Optional:-->

<ns:Token>90b7055b-354a-4f7c-b277-235506762c4a</ns:Token>

</ns:AuthorizationToken>

</soapenv:Header>

<soapenv:Body>

<ns:MetaDataGetFormControlForFacadeObject>

<ns:FormKey>0802aa22-1e4d-456a-b2cb-55156981b53d</ns:FormKey>

<!--Optional:-->

<ns:controlName>ssa_escalator3_percent</ns:controlName>

<!--Optional:-->

<ns:oNode>

<!--You may enter ANY elements at this point-->

</ns:oNode>

</ns:MetaDataGetFormControlForFacadeObject>

</soapenv:Body>

</soapenv:Envelope>

Sample Response

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<soap:Header>

<AuthorizationToken xmlns="http://www.avectra.com/2005/">

<Token>0941cdd5-5314-4e4a-9054-cd3bba9efa08</Token>

</AuthorizationToken>

</soap:Header>

<soap:Body>

<MetaDataGetFormControlForFacadeObjectResponse xmlns="http://www.avectra.com/2005/">

<MetaDataGetFormControlForFacadeObjectResult>

<AVFormControl>

<Caption>accelerator 3 percent:</Caption>

<DataObject>Sales_Territory</DataObject>

<AvailableValues/>

<DependantControls/>

<Name>ssa_escalator3_percent</Name>

<Type>TextBox</Type>

<IsRequired>false</IsRequired>

<IsReadOnly>false</IsReadOnly>

<IsInvisible>false</IsInvisible>

<DefaultValue/>

<InputMask/>

<CausesAutoPostBack>false</CausesAutoPostBack>

<GroupingTag/>

<Left>538</Left>

<Top>148</Top>

<Height>19</Height>

<Width>50</Width>

</AVFormControl>

</MetaDataGetFormControlForFacadeObjectResult>

</MetaDataGetFormControlForFacadeObjectResponse>

</soap:Body>

</soap:Envelope>

JSON Method

POST /xWeb/JSON/MetaDataGetFormControlForFacadeObject

DATA: JSON
{
    "MetaDataGetFormControlForFacadeObject": {
        "FormKey": "B772881D-D704-40F3-92B6-09B13A50FCC9",
        "controlName":"ind_last_name",
        "oNode": {{IndividualFacadeObjectXmlNode}}
    }
}

SAMPLE RESULT
HTTP STATUS: 200
DATA: JSON
[
    {
        "Caption": null,
        "DataObject": "Individual",
        "AvailableValues": [],
        "DependantControls": [],
        "InDesignMode": false,
        "ControlGuid": "b981c9c3-f678-4b66-b24a-972afaed4813",
        "ControlName": "ind_last_name",
        "Top": 37,
        "Left": 437,
        "Width": 241,
        "Height": 19,
        "Value": "last name:",
        "ControlClass": "TextBox",
        "ConditionalControlClass": "",
        "ConditionalControlClassControl": "",
        "ConditionalControlClassOperator": "",
        "ConditionalControlClassValue": "",
        "ReadOnly": false,
        "ReadOnlyControl": "",
        "ReadOnlyOperator": "",
        "ReadOnlyValue": "",
        "ReadOnlyEdit": false,
        "Required": true,
        "RequiredControl": "",
        "RequiredOperator": "",
        "RequiredValue": "",
        "AutoPostback": false,
        "Invisible": false,
        "NoExecute": false,
        "InvisibleControl": "",
        "InvisibleOperator": "",
        "InvisibleValue": "",
        "ValueFrom": "",
        "ValueColumn": "",
        "ValueTextColumn": "",
        "ValueWhere": "",
        "ValueWhereAdd": "",
        "ValueOrderBy": "",
        "WizardTab": "",
        "CSSClass": "DataFormTextBox",
        "DefaultValue": "",
        "DefaultValueFunction": "",
        "ControlData": "",
        "IsOnForm": true,
        "TabOrder": "5",
        "HasDefaultValue": false,
        "ReadOnlySQL": "",
        "RequiredSQL": "",
        "InvisibleSQL": "",
        "NoExecuteSQL": "",
        "CausesValidation": "",
        "InputMask": "",
        "HasInputMask": false,
        "FileUploadPath": "",
        "FileUploadBaseUrl": "",
        "FileIdentifier": "",
        "bHasChanged": false,
        "bIsLocked": false,
        "GroupingTag": "",
        "LayoutTableRow": "",
        "LayoutTableColumn": "",
        "PreserveWidth": false,
        "ReadOnlyDbFlag": false,
        "QueryParamFlag": false,
        "EnableViewState": true,
        "Name": "ind_last_name",
        "Type": "TextBox",
        "IsRequired": true,
        "IsReadOnly": false,
        "IsInvisible": false,
        "CausesAutoPostBack": false
    }
]