UtilityService Web Service

UtilityService

Click here for a complete list of operations.

QuickLinkSave

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

<?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>
    <QuickLinkSave xmlns="http://tempuri.org/">
      <pLink>
        <QuickLink>
          <QuicklinkID>int</QuicklinkID>
          <QuicklinkName>string</QuicklinkName>
          <QuicklinkIcon>base64Binary</QuicklinkIcon>
          <IsInactive>boolean</IsInactive>
          <QuicklinkTypeID>int</QuicklinkTypeID>
          <QuicklinkShortcutKey>string</QuicklinkShortcutKey>
          <QuickLinkParameters>
            <QuicklinkParameterID>int</QuicklinkParameterID>
            <QuicklinkID>int</QuicklinkID>
            <QuickLinkTypeParameterID>int</QuickLinkTypeParameterID>
            <ParameterName>string</ParameterName>
            <Value>string</Value>
          </QuickLinkParameters>
          <QuickLinkParametersList>
            <QuickLinkParameter xsi:nil="true" />
            <QuickLinkParameter xsi:nil="true" />
          </QuickLinkParametersList>
        </QuickLink>
        <QuickLink>
          <QuicklinkID>int</QuicklinkID>
          <QuicklinkName>string</QuicklinkName>
          <QuicklinkIcon>base64Binary</QuicklinkIcon>
          <IsInactive>boolean</IsInactive>
          <QuicklinkTypeID>int</QuicklinkTypeID>
          <QuicklinkShortcutKey>string</QuicklinkShortcutKey>
          <QuickLinkParameters>
            <QuicklinkParameterID>int</QuicklinkParameterID>
            <QuicklinkID>int</QuicklinkID>
            <QuickLinkTypeParameterID>int</QuickLinkTypeParameterID>
            <ParameterName>string</ParameterName>
            <Value>string</Value>
          </QuickLinkParameters>
          <QuickLinkParametersList>
            <QuickLinkParameter xsi:nil="true" />
            <QuickLinkParameter xsi:nil="true" />
          </QuickLinkParametersList>
        </QuickLink>
      </pLink>
      <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>
    </QuickLinkSave>
  </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>
    <QuickLinkSaveResponse xmlns="http://tempuri.org/">
      <QuickLinkSaveResult>
        <IsError>boolean</IsError>
        <ErrorCode>int</ErrorCode>
        <ErrorMessage>string</ErrorMessage>
        <BusinessObjectList>
          <QuickLink>
            <QuicklinkID>int</QuicklinkID>
            <QuicklinkName>string</QuicklinkName>
            <QuicklinkIcon>base64Binary</QuicklinkIcon>
            <IsInactive>boolean</IsInactive>
            <QuicklinkTypeID>int</QuicklinkTypeID>
            <QuicklinkShortcutKey>string</QuicklinkShortcutKey>
            <QuickLinkParameters xsi:nil="true" />
            <QuickLinkParametersList xsi:nil="true" />
          </QuickLink>
          <QuickLink>
            <QuicklinkID>int</QuicklinkID>
            <QuicklinkName>string</QuicklinkName>
            <QuicklinkIcon>base64Binary</QuicklinkIcon>
            <IsInactive>boolean</IsInactive>
            <QuicklinkTypeID>int</QuicklinkTypeID>
            <QuicklinkShortcutKey>string</QuicklinkShortcutKey>
            <QuickLinkParameters xsi:nil="true" />
            <QuickLinkParametersList xsi:nil="true" />
          </QuickLink>
        </BusinessObjectList>
        <ActualRecordsCount>int</ActualRecordsCount>
        <MetaData>string</MetaData>
      </QuickLinkSaveResult>
    </QuickLinkSaveResponse>
  </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 /RosecomUAT/Service/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>
    <QuickLinkSave xmlns="http://tempuri.org/">
      <pLink>
        <QuickLink>
          <QuicklinkID>int</QuicklinkID>
          <QuicklinkName>string</QuicklinkName>
          <QuicklinkIcon>base64Binary</QuicklinkIcon>
          <IsInactive>boolean</IsInactive>
          <QuicklinkTypeID>int</QuicklinkTypeID>
          <QuicklinkShortcutKey>string</QuicklinkShortcutKey>
          <QuickLinkParameters>
            <QuicklinkParameterID>int</QuicklinkParameterID>
            <QuicklinkID>int</QuicklinkID>
            <QuickLinkTypeParameterID>int</QuickLinkTypeParameterID>
            <ParameterName>string</ParameterName>
            <Value>string</Value>
          </QuickLinkParameters>
          <QuickLinkParametersList>
            <QuickLinkParameter xsi:nil="true" />
            <QuickLinkParameter xsi:nil="true" />
          </QuickLinkParametersList>
        </QuickLink>
        <QuickLink>
          <QuicklinkID>int</QuicklinkID>
          <QuicklinkName>string</QuicklinkName>
          <QuicklinkIcon>base64Binary</QuicklinkIcon>
          <IsInactive>boolean</IsInactive>
          <QuicklinkTypeID>int</QuicklinkTypeID>
          <QuicklinkShortcutKey>string</QuicklinkShortcutKey>
          <QuickLinkParameters>
            <QuicklinkParameterID>int</QuicklinkParameterID>
            <QuicklinkID>int</QuicklinkID>
            <QuickLinkTypeParameterID>int</QuickLinkTypeParameterID>
            <ParameterName>string</ParameterName>
            <Value>string</Value>
          </QuickLinkParameters>
          <QuickLinkParametersList>
            <QuickLinkParameter xsi:nil="true" />
            <QuickLinkParameter xsi:nil="true" />
          </QuickLinkParametersList>
        </QuickLink>
      </pLink>
      <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>
    </QuickLinkSave>
  </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>
    <QuickLinkSaveResponse xmlns="http://tempuri.org/">
      <QuickLinkSaveResult>
        <IsError>boolean</IsError>
        <ErrorCode>int</ErrorCode>
        <ErrorMessage>string</ErrorMessage>
        <BusinessObjectList>
          <QuickLink>
            <QuicklinkID>int</QuicklinkID>
            <QuicklinkName>string</QuicklinkName>
            <QuicklinkIcon>base64Binary</QuicklinkIcon>
            <IsInactive>boolean</IsInactive>
            <QuicklinkTypeID>int</QuicklinkTypeID>
            <QuicklinkShortcutKey>string</QuicklinkShortcutKey>
            <QuickLinkParameters xsi:nil="true" />
            <QuickLinkParametersList xsi:nil="true" />
          </QuickLink>
          <QuickLink>
            <QuicklinkID>int</QuicklinkID>
            <QuicklinkName>string</QuicklinkName>
            <QuicklinkIcon>base64Binary</QuicklinkIcon>
            <IsInactive>boolean</IsInactive>
            <QuicklinkTypeID>int</QuicklinkTypeID>
            <QuicklinkShortcutKey>string</QuicklinkShortcutKey>
            <QuickLinkParameters xsi:nil="true" />
            <QuickLinkParametersList xsi:nil="true" />
          </QuickLink>
        </BusinessObjectList>
        <ActualRecordsCount>int</ActualRecordsCount>
        <MetaData>string</MetaData>
      </QuickLinkSaveResult>
    </QuickLinkSaveResponse>
  </soap12:Body>
</soap12:Envelope>