UtilityService Web Service

UtilityService

Click here for a complete list of operations.

GetControlsForGroup

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 /RosecomLive/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/GetControlsForGroup"

<?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>
    <GetControlsForGroup xmlns="http://tempuri.org/">
      <pScreenFunGrp>
        <ScreenFunction>
          <ScreenFunctionChannel>
            <IsAllowQuickModeSales>boolean</IsAllowQuickModeSales>
            <IsSaleStockAutoAllocate>boolean</IsSaleStockAutoAllocate>
            <IsDeliveryItemMandatory>boolean</IsDeliveryItemMandatory>
            <IsOrderValidationRequire>boolean</IsOrderValidationRequire>
            <IsIdentityCheckMandatory>boolean</IsIdentityCheckMandatory>
            <IsConnectAfterDispatching>boolean</IsConnectAfterDispatching>
            <IsLoadAllAddressesInSale>boolean</IsLoadAllAddressesInSale>
            <IsCheckCreditLimit>boolean</IsCheckCreditLimit>
            <IsCheckCreditTerms>boolean</IsCheckCreditTerms>
            <IsReadTermsAndConditionsMandatory>boolean</IsReadTermsAndConditionsMandatory>
            <IsPromptForMarketingPromotions>boolean</IsPromptForMarketingPromotions>
            <IsDisplayInvoiceDiscount>boolean</IsDisplayInvoiceDiscount>
            <bAuthorisationMandatory>boolean</bAuthorisationMandatory>
            <bOrderValidationRequire>boolean</bOrderValidationRequire>
            <SaleLimit>decimal</SaleLimit>
            <MinimumMargin>decimal</MinimumMargin>
          </ScreenFunctionChannel>
          <ScreenFunctionScreen>
            <ScreenID>int</ScreenID>
            <ScreenName>string</ScreenName>
            <IsSequenceAvailable>boolean</IsSequenceAvailable>
            <ScreenApplicationControlName>string</ScreenApplicationControlName>
          </ScreenFunctionScreen>
        </ScreenFunction>
      </pScreenFunGrp>
      <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>
    </GetControlsForGroup>
  </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>
    <GetControlsForGroupResponse xmlns="http://tempuri.org/">
      <GetControlsForGroupResult>
        <IsError>boolean</IsError>
        <ErrorCode>int</ErrorCode>
        <ErrorMessage>string</ErrorMessage>
        <BusinessObjectList>
          <ScreenFunctionGroupControl>
            <ScreenFunctionGroup xsi:nil="true" />
            <ScreenFunction xsi:nil="true" />
          </ScreenFunctionGroupControl>
          <ScreenFunctionGroupControl>
            <ScreenFunctionGroup xsi:nil="true" />
            <ScreenFunction xsi:nil="true" />
          </ScreenFunctionGroupControl>
        </BusinessObjectList>
        <ActualRecordsCount>int</ActualRecordsCount>
        <MetaData>string</MetaData>
        <BusinessObjectBool>boolean</BusinessObjectBool>
      </GetControlsForGroupResult>
    </GetControlsForGroupResponse>
  </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 /RosecomLive/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>
    <GetControlsForGroup xmlns="http://tempuri.org/">
      <pScreenFunGrp>
        <ScreenFunction>
          <ScreenFunctionChannel>
            <IsAllowQuickModeSales>boolean</IsAllowQuickModeSales>
            <IsSaleStockAutoAllocate>boolean</IsSaleStockAutoAllocate>
            <IsDeliveryItemMandatory>boolean</IsDeliveryItemMandatory>
            <IsOrderValidationRequire>boolean</IsOrderValidationRequire>
            <IsIdentityCheckMandatory>boolean</IsIdentityCheckMandatory>
            <IsConnectAfterDispatching>boolean</IsConnectAfterDispatching>
            <IsLoadAllAddressesInSale>boolean</IsLoadAllAddressesInSale>
            <IsCheckCreditLimit>boolean</IsCheckCreditLimit>
            <IsCheckCreditTerms>boolean</IsCheckCreditTerms>
            <IsReadTermsAndConditionsMandatory>boolean</IsReadTermsAndConditionsMandatory>
            <IsPromptForMarketingPromotions>boolean</IsPromptForMarketingPromotions>
            <IsDisplayInvoiceDiscount>boolean</IsDisplayInvoiceDiscount>
            <bAuthorisationMandatory>boolean</bAuthorisationMandatory>
            <bOrderValidationRequire>boolean</bOrderValidationRequire>
            <SaleLimit>decimal</SaleLimit>
            <MinimumMargin>decimal</MinimumMargin>
          </ScreenFunctionChannel>
          <ScreenFunctionScreen>
            <ScreenID>int</ScreenID>
            <ScreenName>string</ScreenName>
            <IsSequenceAvailable>boolean</IsSequenceAvailable>
            <ScreenApplicationControlName>string</ScreenApplicationControlName>
          </ScreenFunctionScreen>
        </ScreenFunction>
      </pScreenFunGrp>
      <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>
    </GetControlsForGroup>
  </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>
    <GetControlsForGroupResponse xmlns="http://tempuri.org/">
      <GetControlsForGroupResult>
        <IsError>boolean</IsError>
        <ErrorCode>int</ErrorCode>
        <ErrorMessage>string</ErrorMessage>
        <BusinessObjectList>
          <ScreenFunctionGroupControl>
            <ScreenFunctionGroup xsi:nil="true" />
            <ScreenFunction xsi:nil="true" />
          </ScreenFunctionGroupControl>
          <ScreenFunctionGroupControl>
            <ScreenFunctionGroup xsi:nil="true" />
            <ScreenFunction xsi:nil="true" />
          </ScreenFunctionGroupControl>
        </BusinessObjectList>
        <ActualRecordsCount>int</ActualRecordsCount>
        <MetaData>string</MetaData>
        <BusinessObjectBool>boolean</BusinessObjectBool>
      </GetControlsForGroupResult>
    </GetControlsForGroupResponse>
  </soap12:Body>
</soap12:Envelope>