UtilityService

Click here for a complete list of operations.

GetScreenConfigControls

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 /RoseComServicesTest/RoseCommServiceV3/APIV1/UtilityService.asmx HTTP/1.1
Host: rosecommunications.salestarconnect.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://tempuri.org/GetScreenConfigControls"

<?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>
    <GetScreenConfigControls xmlns="http://tempuri.org/">
      <pScreen>
        <ScreenID>int</ScreenID>
        <ScreenName>string</ScreenName>
        <IsSequenceAvailable>boolean</IsSequenceAvailable>
        <ScreenApplicationControlName>string</ScreenApplicationControlName>
      </pScreen>
      <pAuthentication>
        <UserName>string</UserName>
        <Password>string</Password>
        <DealerCode>string</DealerCode>
        <PasswordLevel2>string</PasswordLevel2>
        <IsAuthenticated>boolean</IsAuthenticated>
        <NewPassword>string</NewPassword>
        <EmployeeID>int</EmployeeID>
        <AppServerPath>string</AppServerPath>
        <IsAPIUser>boolean</IsAPIUser>
      </pAuthentication>
    </GetScreenConfigControls>
  </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>
    <GetScreenConfigControlsResponse xmlns="http://tempuri.org/">
      <GetScreenConfigControlsResult>
        <ScreenFunction>
          <ScreenFunctionbase>
            <ScreenFunctionID>int</ScreenFunctionID>
            <dChannelID>int</dChannelID>
            <dScreenID>int</dScreenID>
            <dScreenName>string</dScreenName>
            <dScreenIsSequenceAvailable>boolean</dScreenIsSequenceAvailable>
            <ScreenFunctionName>string</ScreenFunctionName>
            <ScreenFunctionApplicationControlName>string</ScreenFunctionApplicationControlName>
            <IsActive>boolean</IsActive>
            <ScreenFunctionSequenceNo>int</ScreenFunctionSequenceNo>
          </ScreenFunctionbase>
          <ScreenFunctionbase>
            <ScreenFunctionID>int</ScreenFunctionID>
            <dChannelID>int</dChannelID>
            <dScreenID>int</dScreenID>
            <dScreenName>string</dScreenName>
            <dScreenIsSequenceAvailable>boolean</dScreenIsSequenceAvailable>
            <ScreenFunctionName>string</ScreenFunctionName>
            <ScreenFunctionApplicationControlName>string</ScreenFunctionApplicationControlName>
            <IsActive>boolean</IsActive>
            <ScreenFunctionSequenceNo>int</ScreenFunctionSequenceNo>
          </ScreenFunctionbase>
        </ScreenFunction>
        <ScreenFunctionGroup>
          <ScreenFunctionGroupBase>
            <ScreenFunctionGroupID>int</ScreenFunctionGroupID>
            <dScreenFunctionID>int</dScreenFunctionID>
            <ScreenFunctionGroupName>string</ScreenFunctionGroupName>
            <ScreenFunctionGroupApplicationControlName>string</ScreenFunctionGroupApplicationControlName>
            <IsActive>boolean</IsActive>
          </ScreenFunctionGroupBase>
          <ScreenFunctionGroupBase>
            <ScreenFunctionGroupID>int</ScreenFunctionGroupID>
            <dScreenFunctionID>int</dScreenFunctionID>
            <ScreenFunctionGroupName>string</ScreenFunctionGroupName>
            <ScreenFunctionGroupApplicationControlName>string</ScreenFunctionGroupApplicationControlName>
            <IsActive>boolean</IsActive>
          </ScreenFunctionGroupBase>
        </ScreenFunctionGroup>
        <ScreenFunctionGroupControl>
          <ScreenFunctionGroupControlBase>
            <ScreenFunctionGroupControlID>int</ScreenFunctionGroupControlID>
            <dScreenFunctionGroupID>int</dScreenFunctionGroupID>
            <dScreenFunctionID>int</dScreenFunctionID>
            <ScreenFunctionGroupControlName>string</ScreenFunctionGroupControlName>
            <ScreenFunctionGroupControlApplicationControlName>string</ScreenFunctionGroupControlApplicationControlName>
            <IsActive>boolean</IsActive>
          </ScreenFunctionGroupControlBase>
          <ScreenFunctionGroupControlBase>
            <ScreenFunctionGroupControlID>int</ScreenFunctionGroupControlID>
            <dScreenFunctionGroupID>int</dScreenFunctionGroupID>
            <dScreenFunctionID>int</dScreenFunctionID>
            <ScreenFunctionGroupControlName>string</ScreenFunctionGroupControlName>
            <ScreenFunctionGroupControlApplicationControlName>string</ScreenFunctionGroupControlApplicationControlName>
            <IsActive>boolean</IsActive>
          </ScreenFunctionGroupControlBase>
        </ScreenFunctionGroupControl>
      </GetScreenConfigControlsResult>
    </GetScreenConfigControlsResponse>
  </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 /RoseComServicesTest/RoseCommServiceV3/APIV1/UtilityService.asmx HTTP/1.1
Host: rosecommunications.salestarconnect.com
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>
    <GetScreenConfigControls xmlns="http://tempuri.org/">
      <pScreen>
        <ScreenID>int</ScreenID>
        <ScreenName>string</ScreenName>
        <IsSequenceAvailable>boolean</IsSequenceAvailable>
        <ScreenApplicationControlName>string</ScreenApplicationControlName>
      </pScreen>
      <pAuthentication>
        <UserName>string</UserName>
        <Password>string</Password>
        <DealerCode>string</DealerCode>
        <PasswordLevel2>string</PasswordLevel2>
        <IsAuthenticated>boolean</IsAuthenticated>
        <NewPassword>string</NewPassword>
        <EmployeeID>int</EmployeeID>
        <AppServerPath>string</AppServerPath>
        <IsAPIUser>boolean</IsAPIUser>
      </pAuthentication>
    </GetScreenConfigControls>
  </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>
    <GetScreenConfigControlsResponse xmlns="http://tempuri.org/">
      <GetScreenConfigControlsResult>
        <ScreenFunction>
          <ScreenFunctionbase>
            <ScreenFunctionID>int</ScreenFunctionID>
            <dChannelID>int</dChannelID>
            <dScreenID>int</dScreenID>
            <dScreenName>string</dScreenName>
            <dScreenIsSequenceAvailable>boolean</dScreenIsSequenceAvailable>
            <ScreenFunctionName>string</ScreenFunctionName>
            <ScreenFunctionApplicationControlName>string</ScreenFunctionApplicationControlName>
            <IsActive>boolean</IsActive>
            <ScreenFunctionSequenceNo>int</ScreenFunctionSequenceNo>
          </ScreenFunctionbase>
          <ScreenFunctionbase>
            <ScreenFunctionID>int</ScreenFunctionID>
            <dChannelID>int</dChannelID>
            <dScreenID>int</dScreenID>
            <dScreenName>string</dScreenName>
            <dScreenIsSequenceAvailable>boolean</dScreenIsSequenceAvailable>
            <ScreenFunctionName>string</ScreenFunctionName>
            <ScreenFunctionApplicationControlName>string</ScreenFunctionApplicationControlName>
            <IsActive>boolean</IsActive>
            <ScreenFunctionSequenceNo>int</ScreenFunctionSequenceNo>
          </ScreenFunctionbase>
        </ScreenFunction>
        <ScreenFunctionGroup>
          <ScreenFunctionGroupBase>
            <ScreenFunctionGroupID>int</ScreenFunctionGroupID>
            <dScreenFunctionID>int</dScreenFunctionID>
            <ScreenFunctionGroupName>string</ScreenFunctionGroupName>
            <ScreenFunctionGroupApplicationControlName>string</ScreenFunctionGroupApplicationControlName>
            <IsActive>boolean</IsActive>
          </ScreenFunctionGroupBase>
          <ScreenFunctionGroupBase>
            <ScreenFunctionGroupID>int</ScreenFunctionGroupID>
            <dScreenFunctionID>int</dScreenFunctionID>
            <ScreenFunctionGroupName>string</ScreenFunctionGroupName>
            <ScreenFunctionGroupApplicationControlName>string</ScreenFunctionGroupApplicationControlName>
            <IsActive>boolean</IsActive>
          </ScreenFunctionGroupBase>
        </ScreenFunctionGroup>
        <ScreenFunctionGroupControl>
          <ScreenFunctionGroupControlBase>
            <ScreenFunctionGroupControlID>int</ScreenFunctionGroupControlID>
            <dScreenFunctionGroupID>int</dScreenFunctionGroupID>
            <dScreenFunctionID>int</dScreenFunctionID>
            <ScreenFunctionGroupControlName>string</ScreenFunctionGroupControlName>
            <ScreenFunctionGroupControlApplicationControlName>string</ScreenFunctionGroupControlApplicationControlName>
            <IsActive>boolean</IsActive>
          </ScreenFunctionGroupControlBase>
          <ScreenFunctionGroupControlBase>
            <ScreenFunctionGroupControlID>int</ScreenFunctionGroupControlID>
            <dScreenFunctionGroupID>int</dScreenFunctionGroupID>
            <dScreenFunctionID>int</dScreenFunctionID>
            <ScreenFunctionGroupControlName>string</ScreenFunctionGroupControlName>
            <ScreenFunctionGroupControlApplicationControlName>string</ScreenFunctionGroupControlApplicationControlName>
            <IsActive>boolean</IsActive>
          </ScreenFunctionGroupControlBase>
        </ScreenFunctionGroupControl>
      </GetScreenConfigControlsResult>
    </GetScreenConfigControlsResponse>
  </soap12:Body>
</soap12:Envelope>