PriceBookService Web Service

PriceBookService

Click here for a complete list of operations.

PriceBookProductList

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

<?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>
    <PriceBookProductList xmlns="http://tempuri.org/">
      <pSearchParam>
        <PriceBookID>int</PriceBookID>
        <IsOnlyExisting>boolean</IsOnlyExisting>
      </pSearchParam>
      <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>
    </PriceBookProductList>
  </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>
    <PriceBookProductListResponse xmlns="http://tempuri.org/">
      <PriceBookProductListResult>
        <IsError>boolean</IsError>
        <ErrorCode>int</ErrorCode>
        <ErrorMessage>string</ErrorMessage>
        <BusinessObjectList>
          <PriceBookCommission>
            <ProductID>int</ProductID>
            <ProductName>string</ProductName>
            <ProductCode>string</ProductCode>
            <ProductDepartmentID>int</ProductDepartmentID>
            <ProductCategoryID>int</ProductCategoryID>
            <IsProductActive>boolean</IsProductActive>
            <ProductCreatedDate>dateTime</ProductCreatedDate>
            <ProductTypeID>int</ProductTypeID>
            <PriceBookCommissionElementName>string</PriceBookCommissionElementName>
            <CommissionValue>double</CommissionValue>
            <HandsetProductID>int</HandsetProductID>
            <HandsetName>string</HandsetName>
            <HandsetCode>string</HandsetCode>
            <HandsetDepartmentID>int</HandsetDepartmentID>
            <HandsetCategoryID>int</HandsetCategoryID>
            <IsHandsetActive>boolean</IsHandsetActive>
            <HandsetCreatedDate>dateTime</HandsetCreatedDate>
            <HandsetClassID>int</HandsetClassID>
            <HandsetSupplierID>int</HandsetSupplierID>
            <IsChangesApplied>boolean</IsChangesApplied>
            <PriceBook xsi:nil="true" />
            <EffectiveDate>dateTime</EffectiveDate>
            <PriceBookCategoryID>int</PriceBookCategoryID>
            <IsExport>boolean</IsExport>
          </PriceBookCommission>
          <PriceBookCommission>
            <ProductID>int</ProductID>
            <ProductName>string</ProductName>
            <ProductCode>string</ProductCode>
            <ProductDepartmentID>int</ProductDepartmentID>
            <ProductCategoryID>int</ProductCategoryID>
            <IsProductActive>boolean</IsProductActive>
            <ProductCreatedDate>dateTime</ProductCreatedDate>
            <ProductTypeID>int</ProductTypeID>
            <PriceBookCommissionElementName>string</PriceBookCommissionElementName>
            <CommissionValue>double</CommissionValue>
            <HandsetProductID>int</HandsetProductID>
            <HandsetName>string</HandsetName>
            <HandsetCode>string</HandsetCode>
            <HandsetDepartmentID>int</HandsetDepartmentID>
            <HandsetCategoryID>int</HandsetCategoryID>
            <IsHandsetActive>boolean</IsHandsetActive>
            <HandsetCreatedDate>dateTime</HandsetCreatedDate>
            <HandsetClassID>int</HandsetClassID>
            <HandsetSupplierID>int</HandsetSupplierID>
            <IsChangesApplied>boolean</IsChangesApplied>
            <PriceBook xsi:nil="true" />
            <EffectiveDate>dateTime</EffectiveDate>
            <PriceBookCategoryID>int</PriceBookCategoryID>
            <IsExport>boolean</IsExport>
          </PriceBookCommission>
        </BusinessObjectList>
        <ActualRecordsCount>int</ActualRecordsCount>
        <MetaData>string</MetaData>
        <BusinessObjectBool>boolean</BusinessObjectBool>
      </PriceBookProductListResult>
    </PriceBookProductListResponse>
  </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/PriceBookService.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>
    <PriceBookProductList xmlns="http://tempuri.org/">
      <pSearchParam>
        <PriceBookID>int</PriceBookID>
        <IsOnlyExisting>boolean</IsOnlyExisting>
      </pSearchParam>
      <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>
    </PriceBookProductList>
  </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>
    <PriceBookProductListResponse xmlns="http://tempuri.org/">
      <PriceBookProductListResult>
        <IsError>boolean</IsError>
        <ErrorCode>int</ErrorCode>
        <ErrorMessage>string</ErrorMessage>
        <BusinessObjectList>
          <PriceBookCommission>
            <ProductID>int</ProductID>
            <ProductName>string</ProductName>
            <ProductCode>string</ProductCode>
            <ProductDepartmentID>int</ProductDepartmentID>
            <ProductCategoryID>int</ProductCategoryID>
            <IsProductActive>boolean</IsProductActive>
            <ProductCreatedDate>dateTime</ProductCreatedDate>
            <ProductTypeID>int</ProductTypeID>
            <PriceBookCommissionElementName>string</PriceBookCommissionElementName>
            <CommissionValue>double</CommissionValue>
            <HandsetProductID>int</HandsetProductID>
            <HandsetName>string</HandsetName>
            <HandsetCode>string</HandsetCode>
            <HandsetDepartmentID>int</HandsetDepartmentID>
            <HandsetCategoryID>int</HandsetCategoryID>
            <IsHandsetActive>boolean</IsHandsetActive>
            <HandsetCreatedDate>dateTime</HandsetCreatedDate>
            <HandsetClassID>int</HandsetClassID>
            <HandsetSupplierID>int</HandsetSupplierID>
            <IsChangesApplied>boolean</IsChangesApplied>
            <PriceBook xsi:nil="true" />
            <EffectiveDate>dateTime</EffectiveDate>
            <PriceBookCategoryID>int</PriceBookCategoryID>
            <IsExport>boolean</IsExport>
          </PriceBookCommission>
          <PriceBookCommission>
            <ProductID>int</ProductID>
            <ProductName>string</ProductName>
            <ProductCode>string</ProductCode>
            <ProductDepartmentID>int</ProductDepartmentID>
            <ProductCategoryID>int</ProductCategoryID>
            <IsProductActive>boolean</IsProductActive>
            <ProductCreatedDate>dateTime</ProductCreatedDate>
            <ProductTypeID>int</ProductTypeID>
            <PriceBookCommissionElementName>string</PriceBookCommissionElementName>
            <CommissionValue>double</CommissionValue>
            <HandsetProductID>int</HandsetProductID>
            <HandsetName>string</HandsetName>
            <HandsetCode>string</HandsetCode>
            <HandsetDepartmentID>int</HandsetDepartmentID>
            <HandsetCategoryID>int</HandsetCategoryID>
            <IsHandsetActive>boolean</IsHandsetActive>
            <HandsetCreatedDate>dateTime</HandsetCreatedDate>
            <HandsetClassID>int</HandsetClassID>
            <HandsetSupplierID>int</HandsetSupplierID>
            <IsChangesApplied>boolean</IsChangesApplied>
            <PriceBook xsi:nil="true" />
            <EffectiveDate>dateTime</EffectiveDate>
            <PriceBookCategoryID>int</PriceBookCategoryID>
            <IsExport>boolean</IsExport>
          </PriceBookCommission>
        </BusinessObjectList>
        <ActualRecordsCount>int</ActualRecordsCount>
        <MetaData>string</MetaData>
        <BusinessObjectBool>boolean</BusinessObjectBool>
      </PriceBookProductListResult>
    </PriceBookProductListResponse>
  </soap12:Body>
</soap12:Envelope>