CustomerService Web Service

CustomerService

Click here for a complete list of operations.

CustomerAddressList

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

<?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>
    <CustomerAddressList xmlns="http://tempuri.org/">
      <pSearchParams>
        <CustomerID>int</CustomerID>
        <Consignee>string</Consignee>
        <BuildingNo>string</BuildingNo>
        <StreetName>string</StreetName>
        <PostCode>string</PostCode>
        <AddressCode>string</AddressCode>
        <PageSize>int</PageSize>
        <PageIndex>int</PageIndex>
      </pSearchParams>
      <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>
    </CustomerAddressList>
  </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>
    <CustomerAddressListResponse xmlns="http://tempuri.org/">
      <CustomerAddressListResult>
        <IsError>boolean</IsError>
        <ErrorCode>int</ErrorCode>
        <ErrorMessage>string</ErrorMessage>
        <BusinessObjectList>
          <Address>
            <AddressLine1>string</AddressLine1>
            <AddressLine2>string</AddressLine2>
            <AddressLine3>string</AddressLine3>
            <AddressLine4>string</AddressLine4>
            <AddressLine5>string</AddressLine5>
            <City>string</City>
            <State>string</State>
            <PostCode>string</PostCode>
            <Country xsi:nil="true" />
            <IsDefault>boolean</IsDefault>
            <DateSince>dateTime</DateSince>
            <DurationFromInMonths>int</DurationFromInMonths>
            <PremisesType xsi:nil="true" />
            <IsUsedForCreditCheck>boolean</IsUsedForCreditCheck>
            <AddressSequence>int</AddressSequence>
            <FullAddress>string</FullAddress>
            <HouseName>string</HouseName>
            <ConsigneeName>string</ConsigneeName>
            <AddressCode>string</AddressCode>
            <PhoneNumber>string</PhoneNumber>
            <CustomerID>int</CustomerID>
            <ContactID>int</ContactID>
          </Address>
          <Address>
            <AddressLine1>string</AddressLine1>
            <AddressLine2>string</AddressLine2>
            <AddressLine3>string</AddressLine3>
            <AddressLine4>string</AddressLine4>
            <AddressLine5>string</AddressLine5>
            <City>string</City>
            <State>string</State>
            <PostCode>string</PostCode>
            <Country xsi:nil="true" />
            <IsDefault>boolean</IsDefault>
            <DateSince>dateTime</DateSince>
            <DurationFromInMonths>int</DurationFromInMonths>
            <PremisesType xsi:nil="true" />
            <IsUsedForCreditCheck>boolean</IsUsedForCreditCheck>
            <AddressSequence>int</AddressSequence>
            <FullAddress>string</FullAddress>
            <HouseName>string</HouseName>
            <ConsigneeName>string</ConsigneeName>
            <AddressCode>string</AddressCode>
            <PhoneNumber>string</PhoneNumber>
            <CustomerID>int</CustomerID>
            <ContactID>int</ContactID>
          </Address>
        </BusinessObjectList>
        <ActualRecordsCount>int</ActualRecordsCount>
        <MetaData>string</MetaData>
      </CustomerAddressListResult>
    </CustomerAddressListResponse>
  </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/CustomerService.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>
    <CustomerAddressList xmlns="http://tempuri.org/">
      <pSearchParams>
        <CustomerID>int</CustomerID>
        <Consignee>string</Consignee>
        <BuildingNo>string</BuildingNo>
        <StreetName>string</StreetName>
        <PostCode>string</PostCode>
        <AddressCode>string</AddressCode>
        <PageSize>int</PageSize>
        <PageIndex>int</PageIndex>
      </pSearchParams>
      <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>
    </CustomerAddressList>
  </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>
    <CustomerAddressListResponse xmlns="http://tempuri.org/">
      <CustomerAddressListResult>
        <IsError>boolean</IsError>
        <ErrorCode>int</ErrorCode>
        <ErrorMessage>string</ErrorMessage>
        <BusinessObjectList>
          <Address>
            <AddressLine1>string</AddressLine1>
            <AddressLine2>string</AddressLine2>
            <AddressLine3>string</AddressLine3>
            <AddressLine4>string</AddressLine4>
            <AddressLine5>string</AddressLine5>
            <City>string</City>
            <State>string</State>
            <PostCode>string</PostCode>
            <Country xsi:nil="true" />
            <IsDefault>boolean</IsDefault>
            <DateSince>dateTime</DateSince>
            <DurationFromInMonths>int</DurationFromInMonths>
            <PremisesType xsi:nil="true" />
            <IsUsedForCreditCheck>boolean</IsUsedForCreditCheck>
            <AddressSequence>int</AddressSequence>
            <FullAddress>string</FullAddress>
            <HouseName>string</HouseName>
            <ConsigneeName>string</ConsigneeName>
            <AddressCode>string</AddressCode>
            <PhoneNumber>string</PhoneNumber>
            <CustomerID>int</CustomerID>
            <ContactID>int</ContactID>
          </Address>
          <Address>
            <AddressLine1>string</AddressLine1>
            <AddressLine2>string</AddressLine2>
            <AddressLine3>string</AddressLine3>
            <AddressLine4>string</AddressLine4>
            <AddressLine5>string</AddressLine5>
            <City>string</City>
            <State>string</State>
            <PostCode>string</PostCode>
            <Country xsi:nil="true" />
            <IsDefault>boolean</IsDefault>
            <DateSince>dateTime</DateSince>
            <DurationFromInMonths>int</DurationFromInMonths>
            <PremisesType xsi:nil="true" />
            <IsUsedForCreditCheck>boolean</IsUsedForCreditCheck>
            <AddressSequence>int</AddressSequence>
            <FullAddress>string</FullAddress>
            <HouseName>string</HouseName>
            <ConsigneeName>string</ConsigneeName>
            <AddressCode>string</AddressCode>
            <PhoneNumber>string</PhoneNumber>
            <CustomerID>int</CustomerID>
            <ContactID>int</ContactID>
          </Address>
        </BusinessObjectList>
        <ActualRecordsCount>int</ActualRecordsCount>
        <MetaData>string</MetaData>
      </CustomerAddressListResult>
    </CustomerAddressListResponse>
  </soap12:Body>
</soap12:Envelope>