BNEnetforumxml


Click here for a complete list of operations.

MetaDataGetForm

Retrieves Form Controls By Form Key

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /xweb/secure/bnenetforumxml.asmx HTTP/1.1
Host: netforum.sema.org
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.avectra.com/2005/MetaDataGetForm"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AuthorizationToken xmlns="http://www.avectra.com/2005/">
      <Token>string</Token>
    </AuthorizationToken>
  </soap:Header>
  <soap:Body>
    <MetaDataGetForm xmlns="http://www.avectra.com/2005/">
      <FormKey>guid</FormKey>
    </MetaDataGetForm>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AuthorizationToken xmlns="http://www.avectra.com/2005/">
      <Token>string</Token>
    </AuthorizationToken>
  </soap:Header>
  <soap:Body>
    <MetaDataGetFormResponse xmlns="http://www.avectra.com/2005/">
      <MetaDataGetFormResult>
        <Description>string</Description>
        <Title>string</Title>
        <ObjectKey>guid</ObjectKey>
        <ObjectName>string</ObjectName>
        <ObjectPrefix>string</ObjectPrefix>
        <ObjectType>string</ObjectType>
        <DisplayOnly>boolean</DisplayOnly>
        <Controls>
          <AVFormControl>
            <Caption>string</Caption>
            <DataObject>string</DataObject>
            <AvailableValues xsi:nil="true" />
            <DependantControls xsi:nil="true" />
            <Name>string</Name>
            <Type>string</Type>
            <IsRequired>boolean</IsRequired>
            <IsReadOnly>boolean</IsReadOnly>
            <IsInvisible>boolean</IsInvisible>
            <DefaultValue>string</DefaultValue>
            <InputMask>string</InputMask>
            <CausesAutoPostBack>boolean</CausesAutoPostBack>
            <GroupingTag>string</GroupingTag>
            <Left>int</Left>
            <Top>int</Top>
            <Height>int</Height>
            <Width>int</Width>
          </AVFormControl>
          <AVFormControl>
            <Caption>string</Caption>
            <DataObject>string</DataObject>
            <AvailableValues xsi:nil="true" />
            <DependantControls xsi:nil="true" />
            <Name>string</Name>
            <Type>string</Type>
            <IsRequired>boolean</IsRequired>
            <IsReadOnly>boolean</IsReadOnly>
            <IsInvisible>boolean</IsInvisible>
            <DefaultValue>string</DefaultValue>
            <InputMask>string</InputMask>
            <CausesAutoPostBack>boolean</CausesAutoPostBack>
            <GroupingTag>string</GroupingTag>
            <Left>int</Left>
            <Top>int</Top>
            <Height>int</Height>
            <Width>int</Width>
          </AVFormControl>
        </Controls>
        <Actions>
          <AVFormAction>
            <Type>SAVE or DELETE or NONE</Type>
            <Exit>boolean</Exit>
            <DestinationWizardFormKey>string</DestinationWizardFormKey>
          </AVFormAction>
          <AVFormAction>
            <Type>SAVE or DELETE or NONE</Type>
            <Exit>boolean</Exit>
            <DestinationWizardFormKey>string</DestinationWizardFormKey>
          </AVFormAction>
        </Actions>
        <Interface ServiceUrl="string">
          <InsertMethod>string</InsertMethod>
          <UpdateMethod>string</UpdateMethod>
          <SelectMethod>string</SelectMethod>
          <RefreshMethod>string</RefreshMethod>
          <DeleteMethod>string</DeleteMethod>
        </Interface>
      </MetaDataGetFormResult>
    </MetaDataGetFormResponse>
  </soap:Body>
</soap:Envelope>