Service Web Service

Service

Click here for a complete list of operations.

GetMenuItemsForNode

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

<?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="Master">
      <SessionId>string</SessionId>
      <UserHost>string</UserHost>
      <SystemClient>string</SystemClient>
    </SessionHeader>
  </soap:Header>
  <soap:Body>
    <GetMenuItemsForNode xmlns="Master">
      <node>
        <Name>string</Name>
        <NodeGuid>guid</NodeGuid>
        <ChildNodes>
          <ExternalNodeInfo>
            <Name>string</Name>
            <NodeGuid>guid</NodeGuid>
            <ChildNodes xsi:nil="true" />
            <NDXHash>string</NDXHash>
            <TerminationDate>dateTime</TerminationDate>
            <DisplayName>string</DisplayName>
            <Description>string</Description>
            <IsDigitalSignatureRequired>boolean</IsDigitalSignatureRequired>
            <NotSignedInformationalVariables xsi:nil="true" />
            <IsHardReaction>boolean</IsHardReaction>
            <IconHash>string</IconHash>
            <UserId>int</UserId>
            <UserName>string</UserName>
            <UserFullName>string</UserFullName>
            <Id>long</Id>
            <NodeComment>string</NodeComment>
            <ExecutionDuration>long</ExecutionDuration>
            <ContainsPrint>boolean</ContainsPrint>
            <StartDate>dateTime</StartDate>
            <HasLinkedToMenuItems>boolean</HasLinkedToMenuItems>
          </ExternalNodeInfo>
          <ExternalNodeInfo>
            <Name>string</Name>
            <NodeGuid>guid</NodeGuid>
            <ChildNodes xsi:nil="true" />
            <NDXHash>string</NDXHash>
            <TerminationDate>dateTime</TerminationDate>
            <DisplayName>string</DisplayName>
            <Description>string</Description>
            <IsDigitalSignatureRequired>boolean</IsDigitalSignatureRequired>
            <NotSignedInformationalVariables xsi:nil="true" />
            <IsHardReaction>boolean</IsHardReaction>
            <IconHash>string</IconHash>
            <UserId>int</UserId>
            <UserName>string</UserName>
            <UserFullName>string</UserFullName>
            <Id>long</Id>
            <NodeComment>string</NodeComment>
            <ExecutionDuration>long</ExecutionDuration>
            <ContainsPrint>boolean</ContainsPrint>
            <StartDate>dateTime</StartDate>
            <HasLinkedToMenuItems>boolean</HasLinkedToMenuItems>
          </ExternalNodeInfo>
        </ChildNodes>
        <NDXHash>string</NDXHash>
        <TerminationDate>dateTime</TerminationDate>
        <DisplayName>string</DisplayName>
        <Description>string</Description>
        <IsDigitalSignatureRequired>boolean</IsDigitalSignatureRequired>
        <NotSignedInformationalVariables>
          <string>string</string>
          <string>string</string>
        </NotSignedInformationalVariables>
        <IsHardReaction>boolean</IsHardReaction>
        <IconHash>string</IconHash>
        <UserId>int</UserId>
        <UserName>string</UserName>
        <UserFullName>string</UserFullName>
        <Id>long</Id>
        <NodeComment>string</NodeComment>
        <ExecutionDuration>long</ExecutionDuration>
        <ContainsPrint>boolean</ContainsPrint>
        <StartDate>dateTime</StartDate>
        <HasLinkedToMenuItems>boolean</HasLinkedToMenuItems>
      </node>
    </GetMenuItemsForNode>
  </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>
    <GetMenuItemsForNodeResponse xmlns="Master">
      <GetMenuItemsForNodeResult>
        <MenuItemNodeDTO>
          <MenuItem>
            <Id>int</Id>
            <SecurityApplicationName>string</SecurityApplicationName>
            <Tabs xsi:nil="true" />
            <Statuses xsi:nil="true" />
            <Parameters xsi:nil="true" />
            <CreatorUserId>int</CreatorUserId>
            <CreatorUserName>string</CreatorUserName>
            <CreatorFullUserName>string</CreatorFullUserName>
            <Parent xsi:nil="true" />
          </MenuItem>
          <Node>
            <Id>int</Id>
            <DisplayName>string</DisplayName>
            <Description>string</Description>
            <TerminationDate>dateTime</TerminationDate>
            <Guid>string</Guid>
            <IsLoginForm>int</IsLoginForm>
          </Node>
          <UseNodeLastVersion>boolean</UseNodeLastVersion>
        </MenuItemNodeDTO>
        <MenuItemNodeDTO>
          <MenuItem>
            <Id>int</Id>
            <SecurityApplicationName>string</SecurityApplicationName>
            <Tabs xsi:nil="true" />
            <Statuses xsi:nil="true" />
            <Parameters xsi:nil="true" />
            <CreatorUserId>int</CreatorUserId>
            <CreatorUserName>string</CreatorUserName>
            <CreatorFullUserName>string</CreatorFullUserName>
            <Parent xsi:nil="true" />
          </MenuItem>
          <Node>
            <Id>int</Id>
            <DisplayName>string</DisplayName>
            <Description>string</Description>
            <TerminationDate>dateTime</TerminationDate>
            <Guid>string</Guid>
            <IsLoginForm>int</IsLoginForm>
          </Node>
          <UseNodeLastVersion>boolean</UseNodeLastVersion>
        </MenuItemNodeDTO>
      </GetMenuItemsForNodeResult>
    </GetMenuItemsForNodeResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

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

POST /MasterServer/Service.asmx HTTP/1.1
Host: mc.brainysoft.biz
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Header>
    <SessionHeader xmlns="Master">
      <SessionId>string</SessionId>
      <UserHost>string</UserHost>
      <SystemClient>string</SystemClient>
    </SessionHeader>
  </soap12:Header>
  <soap12:Body>
    <GetMenuItemsForNode xmlns="Master">
      <node>
        <Name>string</Name>
        <NodeGuid>guid</NodeGuid>
        <ChildNodes>
          <ExternalNodeInfo>
            <Name>string</Name>
            <NodeGuid>guid</NodeGuid>
            <ChildNodes xsi:nil="true" />
            <NDXHash>string</NDXHash>
            <TerminationDate>dateTime</TerminationDate>
            <DisplayName>string</DisplayName>
            <Description>string</Description>
            <IsDigitalSignatureRequired>boolean</IsDigitalSignatureRequired>
            <NotSignedInformationalVariables xsi:nil="true" />
            <IsHardReaction>boolean</IsHardReaction>
            <IconHash>string</IconHash>
            <UserId>int</UserId>
            <UserName>string</UserName>
            <UserFullName>string</UserFullName>
            <Id>long</Id>
            <NodeComment>string</NodeComment>
            <ExecutionDuration>long</ExecutionDuration>
            <ContainsPrint>boolean</ContainsPrint>
            <StartDate>dateTime</StartDate>
            <HasLinkedToMenuItems>boolean</HasLinkedToMenuItems>
          </ExternalNodeInfo>
          <ExternalNodeInfo>
            <Name>string</Name>
            <NodeGuid>guid</NodeGuid>
            <ChildNodes xsi:nil="true" />
            <NDXHash>string</NDXHash>
            <TerminationDate>dateTime</TerminationDate>
            <DisplayName>string</DisplayName>
            <Description>string</Description>
            <IsDigitalSignatureRequired>boolean</IsDigitalSignatureRequired>
            <NotSignedInformationalVariables xsi:nil="true" />
            <IsHardReaction>boolean</IsHardReaction>
            <IconHash>string</IconHash>
            <UserId>int</UserId>
            <UserName>string</UserName>
            <UserFullName>string</UserFullName>
            <Id>long</Id>
            <NodeComment>string</NodeComment>
            <ExecutionDuration>long</ExecutionDuration>
            <ContainsPrint>boolean</ContainsPrint>
            <StartDate>dateTime</StartDate>
            <HasLinkedToMenuItems>boolean</HasLinkedToMenuItems>
          </ExternalNodeInfo>
        </ChildNodes>
        <NDXHash>string</NDXHash>
        <TerminationDate>dateTime</TerminationDate>
        <DisplayName>string</DisplayName>
        <Description>string</Description>
        <IsDigitalSignatureRequired>boolean</IsDigitalSignatureRequired>
        <NotSignedInformationalVariables>
          <string>string</string>
          <string>string</string>
        </NotSignedInformationalVariables>
        <IsHardReaction>boolean</IsHardReaction>
        <IconHash>string</IconHash>
        <UserId>int</UserId>
        <UserName>string</UserName>
        <UserFullName>string</UserFullName>
        <Id>long</Id>
        <NodeComment>string</NodeComment>
        <ExecutionDuration>long</ExecutionDuration>
        <ContainsPrint>boolean</ContainsPrint>
        <StartDate>dateTime</StartDate>
        <HasLinkedToMenuItems>boolean</HasLinkedToMenuItems>
      </node>
    </GetMenuItemsForNode>
  </soap12:Body>
</soap12:Envelope>

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

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetMenuItemsForNodeResponse xmlns="Master">
      <GetMenuItemsForNodeResult>
        <MenuItemNodeDTO>
          <MenuItem>
            <Id>int</Id>
            <SecurityApplicationName>string</SecurityApplicationName>
            <Tabs xsi:nil="true" />
            <Statuses xsi:nil="true" />
            <Parameters xsi:nil="true" />
            <CreatorUserId>int</CreatorUserId>
            <CreatorUserName>string</CreatorUserName>
            <CreatorFullUserName>string</CreatorFullUserName>
            <Parent xsi:nil="true" />
          </MenuItem>
          <Node>
            <Id>int</Id>
            <DisplayName>string</DisplayName>
            <Description>string</Description>
            <TerminationDate>dateTime</TerminationDate>
            <Guid>string</Guid>
            <IsLoginForm>int</IsLoginForm>
          </Node>
          <UseNodeLastVersion>boolean</UseNodeLastVersion>
        </MenuItemNodeDTO>
        <MenuItemNodeDTO>
          <MenuItem>
            <Id>int</Id>
            <SecurityApplicationName>string</SecurityApplicationName>
            <Tabs xsi:nil="true" />
            <Statuses xsi:nil="true" />
            <Parameters xsi:nil="true" />
            <CreatorUserId>int</CreatorUserId>
            <CreatorUserName>string</CreatorUserName>
            <CreatorFullUserName>string</CreatorFullUserName>
            <Parent xsi:nil="true" />
          </MenuItem>
          <Node>
            <Id>int</Id>
            <DisplayName>string</DisplayName>
            <Description>string</Description>
            <TerminationDate>dateTime</TerminationDate>
            <Guid>string</Guid>
            <IsLoginForm>int</IsLoginForm>
          </Node>
          <UseNodeLastVersion>boolean</UseNodeLastVersion>
        </MenuItemNodeDTO>
      </GetMenuItemsForNodeResult>
    </GetMenuItemsForNodeResponse>
  </soap12:Body>
</soap12:Envelope>