BNEnetforumxml Web Service

BNEnetforumxml

Click here for a complete list of operations.

GetDynamicQueryDefinition

Retrieve definition of an iWeb Dynamic Query

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

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/GetDynamicQueryDefinition"

<?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>
    <GetDynamicQueryDefinition xmlns="http://www.avectra.com/2005/">
      <szObjectName>string</szObjectName>
      <szQueryName>string</szQueryName>
      <que_key>string</que_key>
    </GetDynamicQueryDefinition>
  </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>
    <GetDynamicQueryDefinitionResponse xmlns="http://www.avectra.com/2005/">
      <GetDynamicQueryDefinitionResult>
        <que_key>string</que_key>
        <que_description>string</que_description>
        <szObjectName>string</szObjectName>
        <Parameters>
          <QueryParameter>
            <Name>string</Name>
            <Description>string</Description>
            <Operator>Like or NotLike or Equals or NotEquals or GreaterThan or LessThan or GreaterThanOrEqualTo or LessThanOrEqualTo or IsIn or IsNotIn or IsNull or IsNotNull or SoundsLike or BeginsWith or DoesNotBeginWith or Contains or DoesNotContain or EndsWith or DoesNotEndWith</Operator>
            <ColumnName>string</ColumnName>
            <ColumnDescription>string</ColumnDescription>
            <ControlClass>string</ControlClass>
            <DataType>string</DataType>
            <IsExtended>boolean</IsExtended>
            <IsNullable>boolean</IsNullable>
            <TableAlias>string</TableAlias>
            <TableDescription>string</TableDescription>
            <TableName>string</TableName>
            <ListOptions xsi:nil="true" />
          </QueryParameter>
          <QueryParameter>
            <Name>string</Name>
            <Description>string</Description>
            <Operator>Like or NotLike or Equals or NotEquals or GreaterThan or LessThan or GreaterThanOrEqualTo or LessThanOrEqualTo or IsIn or IsNotIn or IsNull or IsNotNull or SoundsLike or BeginsWith or DoesNotBeginWith or Contains or DoesNotContain or EndsWith or DoesNotEndWith</Operator>
            <ColumnName>string</ColumnName>
            <ColumnDescription>string</ColumnDescription>
            <ControlClass>string</ControlClass>
            <DataType>string</DataType>
            <IsExtended>boolean</IsExtended>
            <IsNullable>boolean</IsNullable>
            <TableAlias>string</TableAlias>
            <TableDescription>string</TableDescription>
            <TableName>string</TableName>
            <ListOptions xsi:nil="true" />
          </QueryParameter>
        </Parameters>
        <Columns>
          <QueryColumn>
            <Name>string</Name>
            <Description>string</Description>
            <DataType>string</DataType>
            <TableAlias>string</TableAlias>
            <TableDescription>string</TableDescription>
            <TableName>string</TableName>
          </QueryColumn>
          <QueryColumn>
            <Name>string</Name>
            <Description>string</Description>
            <DataType>string</DataType>
            <TableAlias>string</TableAlias>
            <TableDescription>string</TableDescription>
            <TableName>string</TableName>
          </QueryColumn>
        </Columns>
      </GetDynamicQueryDefinitionResult>
    </GetDynamicQueryDefinitionResponse>
  </soap:Body>
</soap:Envelope>

HTTP GET

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

GET /xweb/secure/bnenetforumxml.asmx/GetDynamicQueryDefinition?szObjectName=string&szQueryName=string&que_key=string HTTP/1.1
Host: netforum.sema.org

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<QueryDefinition xmlns="http://www.avectra.com/2005/">
  <que_key>string</que_key>
  <que_description>string</que_description>
  <szObjectName>string</szObjectName>
  <Parameters>
    <QueryParameter>
      <Name>string</Name>
      <Description>string</Description>
      <Operator>Like or NotLike or Equals or NotEquals or GreaterThan or LessThan or GreaterThanOrEqualTo or LessThanOrEqualTo or IsIn or IsNotIn or IsNull or IsNotNull or SoundsLike or BeginsWith or DoesNotBeginWith or Contains or DoesNotContain or EndsWith or DoesNotEndWith</Operator>
      <ColumnName>string</ColumnName>
      <ColumnDescription>string</ColumnDescription>
      <ControlClass>string</ControlClass>
      <DataType>string</DataType>
      <IsExtended>boolean</IsExtended>
      <IsNullable>boolean</IsNullable>
      <TableAlias>string</TableAlias>
      <TableDescription>string</TableDescription>
      <TableName>string</TableName>
      <ListOptions>
        <ListOption d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <ListOption d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </ListOptions>
    </QueryParameter>
    <QueryParameter>
      <Name>string</Name>
      <Description>string</Description>
      <Operator>Like or NotLike or Equals or NotEquals or GreaterThan or LessThan or GreaterThanOrEqualTo or LessThanOrEqualTo or IsIn or IsNotIn or IsNull or IsNotNull or SoundsLike or BeginsWith or DoesNotBeginWith or Contains or DoesNotContain or EndsWith or DoesNotEndWith</Operator>
      <ColumnName>string</ColumnName>
      <ColumnDescription>string</ColumnDescription>
      <ControlClass>string</ControlClass>
      <DataType>string</DataType>
      <IsExtended>boolean</IsExtended>
      <IsNullable>boolean</IsNullable>
      <TableAlias>string</TableAlias>
      <TableDescription>string</TableDescription>
      <TableName>string</TableName>
      <ListOptions>
        <ListOption d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <ListOption d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </ListOptions>
    </QueryParameter>
  </Parameters>
  <Columns>
    <QueryColumn>
      <Name>string</Name>
      <Description>string</Description>
      <DataType>string</DataType>
      <TableAlias>string</TableAlias>
      <TableDescription>string</TableDescription>
      <TableName>string</TableName>
    </QueryColumn>
    <QueryColumn>
      <Name>string</Name>
      <Description>string</Description>
      <DataType>string</DataType>
      <TableAlias>string</TableAlias>
      <TableDescription>string</TableDescription>
      <TableName>string</TableName>
    </QueryColumn>
  </Columns>
</QueryDefinition>

HTTP POST

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

POST /xweb/secure/bnenetforumxml.asmx/GetDynamicQueryDefinition HTTP/1.1
Host: netforum.sema.org
Content-Type: application/x-www-form-urlencoded
Content-Length: length

szObjectName=string&szQueryName=string&que_key=string

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<QueryDefinition xmlns="http://www.avectra.com/2005/">
  <que_key>string</que_key>
  <que_description>string</que_description>
  <szObjectName>string</szObjectName>
  <Parameters>
    <QueryParameter>
      <Name>string</Name>
      <Description>string</Description>
      <Operator>Like or NotLike or Equals or NotEquals or GreaterThan or LessThan or GreaterThanOrEqualTo or LessThanOrEqualTo or IsIn or IsNotIn or IsNull or IsNotNull or SoundsLike or BeginsWith or DoesNotBeginWith or Contains or DoesNotContain or EndsWith or DoesNotEndWith</Operator>
      <ColumnName>string</ColumnName>
      <ColumnDescription>string</ColumnDescription>
      <ControlClass>string</ControlClass>
      <DataType>string</DataType>
      <IsExtended>boolean</IsExtended>
      <IsNullable>boolean</IsNullable>
      <TableAlias>string</TableAlias>
      <TableDescription>string</TableDescription>
      <TableName>string</TableName>
      <ListOptions>
        <ListOption d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <ListOption d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </ListOptions>
    </QueryParameter>
    <QueryParameter>
      <Name>string</Name>
      <Description>string</Description>
      <Operator>Like or NotLike or Equals or NotEquals or GreaterThan or LessThan or GreaterThanOrEqualTo or LessThanOrEqualTo or IsIn or IsNotIn or IsNull or IsNotNull or SoundsLike or BeginsWith or DoesNotBeginWith or Contains or DoesNotContain or EndsWith or DoesNotEndWith</Operator>
      <ColumnName>string</ColumnName>
      <ColumnDescription>string</ColumnDescription>
      <ControlClass>string</ControlClass>
      <DataType>string</DataType>
      <IsExtended>boolean</IsExtended>
      <IsNullable>boolean</IsNullable>
      <TableAlias>string</TableAlias>
      <TableDescription>string</TableDescription>
      <TableName>string</TableName>
      <ListOptions>
        <ListOption d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <ListOption d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </ListOptions>
    </QueryParameter>
  </Parameters>
  <Columns>
    <QueryColumn>
      <Name>string</Name>
      <Description>string</Description>
      <DataType>string</DataType>
      <TableAlias>string</TableAlias>
      <TableDescription>string</TableDescription>
      <TableName>string</TableName>
    </QueryColumn>
    <QueryColumn>
      <Name>string</Name>
      <Description>string</Description>
      <DataType>string</DataType>
      <TableAlias>string</TableAlias>
      <TableDescription>string</TableDescription>
      <TableName>string</TableName>
    </QueryColumn>
  </Columns>
</QueryDefinition>

Parameter	Value
szObjectName:
szQueryName:
que_key: