Service Web Service

Service

Click here for a complete list of operations.

GetPageRules

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

<?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>
    <GetPageRules xmlns="Master">
      <page>int</page>
      <itemsPerPage>int</itemsPerPage>
      <query>string</query>
    </GetPageRules>
  </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>
    <GetPageRulesResponse xmlns="Master">
      <GetPageRulesResult>
        <AttachAccessRuleDTO>
          <Id>int</Id>
          <StrategyId>int</StrategyId>
          <StrategyName>string</StrategyName>
          <StrategyUniqueKey>string</StrategyUniqueKey>
          <NodeId>int</NodeId>
          <NodeName>string</NodeName>
          <NodeUniqueKey>string</NodeUniqueKey>
          <Attach>string</Attach>
          <Group>string</Group>
          <RolesIds>
            <int>int</int>
            <int>int</int>
          </RolesIds>
          <AllowView>boolean</AllowView>
          <AllowEdit>boolean</AllowEdit>
          <AllowDelete>boolean</AllowDelete>
          <AllowDownload>boolean</AllowDownload>
          <AllowUpload>boolean</AllowUpload>
          <Priority>int</Priority>
          <IsDeleted>int</IsDeleted>
          <TerminationDate>dateTime</TerminationDate>
          <UserId>int</UserId>
          <UserName>string</UserName>
          <FullUserName>string</FullUserName>
        </AttachAccessRuleDTO>
        <AttachAccessRuleDTO>
          <Id>int</Id>
          <StrategyId>int</StrategyId>
          <StrategyName>string</StrategyName>
          <StrategyUniqueKey>string</StrategyUniqueKey>
          <NodeId>int</NodeId>
          <NodeName>string</NodeName>
          <NodeUniqueKey>string</NodeUniqueKey>
          <Attach>string</Attach>
          <Group>string</Group>
          <RolesIds>
            <int>int</int>
            <int>int</int>
          </RolesIds>
          <AllowView>boolean</AllowView>
          <AllowEdit>boolean</AllowEdit>
          <AllowDelete>boolean</AllowDelete>
          <AllowDownload>boolean</AllowDownload>
          <AllowUpload>boolean</AllowUpload>
          <Priority>int</Priority>
          <IsDeleted>int</IsDeleted>
          <TerminationDate>dateTime</TerminationDate>
          <UserId>int</UserId>
          <UserName>string</UserName>
          <FullUserName>string</FullUserName>
        </AttachAccessRuleDTO>
      </GetPageRulesResult>
    </GetPageRulesResponse>
  </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>
    <GetPageRules xmlns="Master">
      <page>int</page>
      <itemsPerPage>int</itemsPerPage>
      <query>string</query>
    </GetPageRules>
  </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>
    <GetPageRulesResponse xmlns="Master">
      <GetPageRulesResult>
        <AttachAccessRuleDTO>
          <Id>int</Id>
          <StrategyId>int</StrategyId>
          <StrategyName>string</StrategyName>
          <StrategyUniqueKey>string</StrategyUniqueKey>
          <NodeId>int</NodeId>
          <NodeName>string</NodeName>
          <NodeUniqueKey>string</NodeUniqueKey>
          <Attach>string</Attach>
          <Group>string</Group>
          <RolesIds>
            <int>int</int>
            <int>int</int>
          </RolesIds>
          <AllowView>boolean</AllowView>
          <AllowEdit>boolean</AllowEdit>
          <AllowDelete>boolean</AllowDelete>
          <AllowDownload>boolean</AllowDownload>
          <AllowUpload>boolean</AllowUpload>
          <Priority>int</Priority>
          <IsDeleted>int</IsDeleted>
          <TerminationDate>dateTime</TerminationDate>
          <UserId>int</UserId>
          <UserName>string</UserName>
          <FullUserName>string</FullUserName>
        </AttachAccessRuleDTO>
        <AttachAccessRuleDTO>
          <Id>int</Id>
          <StrategyId>int</StrategyId>
          <StrategyName>string</StrategyName>
          <StrategyUniqueKey>string</StrategyUniqueKey>
          <NodeId>int</NodeId>
          <NodeName>string</NodeName>
          <NodeUniqueKey>string</NodeUniqueKey>
          <Attach>string</Attach>
          <Group>string</Group>
          <RolesIds>
            <int>int</int>
            <int>int</int>
          </RolesIds>
          <AllowView>boolean</AllowView>
          <AllowEdit>boolean</AllowEdit>
          <AllowDelete>boolean</AllowDelete>
          <AllowDownload>boolean</AllowDownload>
          <AllowUpload>boolean</AllowUpload>
          <Priority>int</Priority>
          <IsDeleted>int</IsDeleted>
          <TerminationDate>dateTime</TerminationDate>
          <UserId>int</UserId>
          <UserName>string</UserName>
          <FullUserName>string</FullUserName>
        </AttachAccessRuleDTO>
      </GetPageRulesResult>
    </GetPageRulesResponse>
  </soap12:Body>
</soap12:Envelope>