Service Web Service

Service

Click here for a complete list of operations.

GetDictionaries

TODO

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 /AdminServer/Service.asmx HTTP/1.1
Host: mc.brainysoft.biz
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "Admin/GetDictionaries"

<?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>
    <SessionHeader xmlns="Admin">
      <SessionId>string</SessionId>
      <UserHost>string</UserHost>
      <SystemClient>string</SystemClient>
    </SessionHeader>
  </soap:Header>
  <soap:Body>
    <GetDictionaries xmlns="Admin" />
  </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:Body>
    <GetDictionariesResponse xmlns="Admin">
      <GetDictionariesResult>
        <WarehouseDictionary>
          <Id>long</Id>
          <DisplayName>string</DisplayName>
          <TableName>string</TableName>
          <Description>string</Description>
          <Content>
            <WarehouseDictionaryRecord xsi:nil="true" />
            <WarehouseDictionaryRecord xsi:nil="true" />
          </Content>
          <Parameters>
            <WarehouseDictionaryParam xsi:nil="true" />
            <WarehouseDictionaryParam xsi:nil="true" />
          </Parameters>
        </WarehouseDictionary>
        <WarehouseDictionary>
          <Id>long</Id>
          <DisplayName>string</DisplayName>
          <TableName>string</TableName>
          <Description>string</Description>
          <Content>
            <WarehouseDictionaryRecord xsi:nil="true" />
            <WarehouseDictionaryRecord xsi:nil="true" />
          </Content>
          <Parameters>
            <WarehouseDictionaryParam xsi:nil="true" />
            <WarehouseDictionaryParam xsi:nil="true" />
          </Parameters>
        </WarehouseDictionary>
      </GetDictionariesResult>
    </GetDictionariesResponse>
  </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 /AdminServer/Service.asmx/GetDictionaries? HTTP/1.1
Host: mc.brainysoft.biz

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

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfWarehouseDictionary xmlns="Admin">
  <WarehouseDictionary>
    <Id>long</Id>
    <DisplayName>string</DisplayName>
    <TableName>string</TableName>
    <Description>string</Description>
    <Content>
      <WarehouseDictionaryRecord />
      <WarehouseDictionaryRecord />
    </Content>
    <Parameters>
      <WarehouseDictionaryParam>
        <Id>decimal</Id>
        <FieldName>string</FieldName>
        <DisplayName>string</DisplayName>
        <Description>string</Description>
        <FieldType>string</FieldType>
        <MasterDictionaryId>long</MasterDictionaryId>
        <MasterDictionaryName>string</MasterDictionaryName>
      </WarehouseDictionaryParam>
      <WarehouseDictionaryParam>
        <Id>decimal</Id>
        <FieldName>string</FieldName>
        <DisplayName>string</DisplayName>
        <Description>string</Description>
        <FieldType>string</FieldType>
        <MasterDictionaryId>long</MasterDictionaryId>
        <MasterDictionaryName>string</MasterDictionaryName>
      </WarehouseDictionaryParam>
    </Parameters>
  </WarehouseDictionary>
  <WarehouseDictionary>
    <Id>long</Id>
    <DisplayName>string</DisplayName>
    <TableName>string</TableName>
    <Description>string</Description>
    <Content>
      <WarehouseDictionaryRecord />
      <WarehouseDictionaryRecord />
    </Content>
    <Parameters>
      <WarehouseDictionaryParam>
        <Id>decimal</Id>
        <FieldName>string</FieldName>
        <DisplayName>string</DisplayName>
        <Description>string</Description>
        <FieldType>string</FieldType>
        <MasterDictionaryId>long</MasterDictionaryId>
        <MasterDictionaryName>string</MasterDictionaryName>
      </WarehouseDictionaryParam>
      <WarehouseDictionaryParam>
        <Id>decimal</Id>
        <FieldName>string</FieldName>
        <DisplayName>string</DisplayName>
        <Description>string</Description>
        <FieldType>string</FieldType>
        <MasterDictionaryId>long</MasterDictionaryId>
        <MasterDictionaryName>string</MasterDictionaryName>
      </WarehouseDictionaryParam>
    </Parameters>
  </WarehouseDictionary>
</ArrayOfWarehouseDictionary>

HTTP POST

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

POST /AdminServer/Service.asmx/GetDictionaries HTTP/1.1
Host: mc.brainysoft.biz
Content-Type: application/x-www-form-urlencoded
Content-Length: length

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

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfWarehouseDictionary xmlns="Admin">
  <WarehouseDictionary>
    <Id>long</Id>
    <DisplayName>string</DisplayName>
    <TableName>string</TableName>
    <Description>string</Description>
    <Content>
      <WarehouseDictionaryRecord />
      <WarehouseDictionaryRecord />
    </Content>
    <Parameters>
      <WarehouseDictionaryParam>
        <Id>decimal</Id>
        <FieldName>string</FieldName>
        <DisplayName>string</DisplayName>
        <Description>string</Description>
        <FieldType>string</FieldType>
        <MasterDictionaryId>long</MasterDictionaryId>
        <MasterDictionaryName>string</MasterDictionaryName>
      </WarehouseDictionaryParam>
      <WarehouseDictionaryParam>
        <Id>decimal</Id>
        <FieldName>string</FieldName>
        <DisplayName>string</DisplayName>
        <Description>string</Description>
        <FieldType>string</FieldType>
        <MasterDictionaryId>long</MasterDictionaryId>
        <MasterDictionaryName>string</MasterDictionaryName>
      </WarehouseDictionaryParam>
    </Parameters>
  </WarehouseDictionary>
  <WarehouseDictionary>
    <Id>long</Id>
    <DisplayName>string</DisplayName>
    <TableName>string</TableName>
    <Description>string</Description>
    <Content>
      <WarehouseDictionaryRecord />
      <WarehouseDictionaryRecord />
    </Content>
    <Parameters>
      <WarehouseDictionaryParam>
        <Id>decimal</Id>
        <FieldName>string</FieldName>
        <DisplayName>string</DisplayName>
        <Description>string</Description>
        <FieldType>string</FieldType>
        <MasterDictionaryId>long</MasterDictionaryId>
        <MasterDictionaryName>string</MasterDictionaryName>
      </WarehouseDictionaryParam>
      <WarehouseDictionaryParam>
        <Id>decimal</Id>
        <FieldName>string</FieldName>
        <DisplayName>string</DisplayName>
        <Description>string</Description>
        <FieldType>string</FieldType>
        <MasterDictionaryId>long</MasterDictionaryId>
        <MasterDictionaryName>string</MasterDictionaryName>
      </WarehouseDictionaryParam>
    </Parameters>
  </WarehouseDictionary>
</ArrayOfWarehouseDictionary>