SecurityService Web Service

SecurityService

Click here for a complete list of operations.

CustomerAuthenticate

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

<?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>
    <CustomerAuthenticate xmlns="http://tempuri.org/">
      <pCustomerAuthentication>
        <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>
      </pCustomerAuthentication>
      <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>
    </CustomerAuthenticate>
  </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>
    <CustomerAuthenticateResponse xmlns="http://tempuri.org/">
      <CustomerAuthenticateResult>
        <IsError>boolean</IsError>
        <ErrorCode>int</ErrorCode>
        <ErrorMessage>string</ErrorMessage>
        <BusinessObjectList>
          <Customer>
            <CustomerID>int</CustomerID>
            <Reference>string</Reference>
            <Contacts xsi:nil="true" />
            <Category xsi:nil="true" />
            <IntroductionDate>dateTime</IntroductionDate>
            <Source xsi:nil="true" />
            <MainAccountManager xsi:nil="true" />
            <SharedAccountManagers xsi:nil="true" />
            <IsActive>boolean</IsActive>
            <IsMergeInvoice>boolean</IsMergeInvoice>
            <PriceType xsi:nil="true" />
            <Currency xsi:nil="true" />
            <TaxGroup xsi:nil="true" />
            <IsApproved>boolean</IsApproved>
            <ApprovedUser xsi:nil="true" />
            <ApprovedDate>dateTime</ApprovedDate>
            <PaymentTerm xsi:nil="true" />
            <SelfBillingPeriod xsi:nil="true" />
            <Logo>base64Binary</Logo>
            <MailingAddress xsi:nil="true" />
            <InvoiceAddress xsi:nil="true" />
            <DeliveryAddress xsi:nil="true" />
            <WebSite>string</WebSite>
            <OrderConfirmationEmail xsi:nil="true" />
            <DespatchConfirmationEmail xsi:nil="true" />
            <SendMethod xsi:nil="true" />
            <SendFormat xsi:nil="true" />
            <SendAddress>string</SendAddress>
            <ReceiveMethod xsi:nil="true" />
            <ReceiveFormat xsi:nil="true" />
            <TurnOverLevel xsi:nil="true" />
            <EmployeeCountLevel xsi:nil="true" />
            <BankAccount xsi:nil="true" />
            <Proofs xsi:nil="true" />
            <Comment>string</Comment>
            <SourceNote>string</SourceNote>
            <NetworkReferenceNumber>string</NetworkReferenceNumber>
            <CompanyName>string</CompanyName>
            <CompanyRegistrationNo>string</CompanyRegistrationNo>
            <CompanyVatNo>string</CompanyVatNo>
            <Industry xsi:nil="true" />
            <MobilePhoneCountLevel xsi:nil="true" />
            <TradingAsType xsi:nil="true" />
            <CreditLimit>decimal</CreditLimit>
            <LoggedInSiteID>int</LoggedInSiteID>
            <SiteName>string</SiteName>
            <CreditRates>string</CreditRates>
            <CreditCategory xsi:nil="true" />
            <AccountCode>string</AccountCode>
            <Opportunities xsi:nil="true" />
            <AlternativeReference>string</AlternativeReference>
            <TimeWithEmployer>int</TimeWithEmployer>
            <DisplayName>string</DisplayName>
            <CurrencyCode>string</CurrencyCode>
            <Symbol>string</Symbol>
            <ExchangeRate>decimal</ExchangeRate>
            <OnStop>boolean</OnStop>
            <UserName>string</UserName>
            <Password1>string</Password1>
            <Password2>string</Password2>
            <Email>string</Email>
            <Fax>string</Fax>
            <Phone>string</Phone>
            <AvailableToSpend>decimal</AvailableToSpend>
            <Application xsi:nil="true" />
            <AllowedApplicationIDs xsi:nil="true" />
            <LangCode>string</LangCode>
            <AccountBalance>decimal</AccountBalance>
            <ProspectType>boolean</ProspectType>
            <LoyaltyGroupID>int</LoyaltyGroupID>
          </Customer>
          <Customer>
            <CustomerID>int</CustomerID>
            <Reference>string</Reference>
            <Contacts xsi:nil="true" />
            <Category xsi:nil="true" />
            <IntroductionDate>dateTime</IntroductionDate>
            <Source xsi:nil="true" />
            <MainAccountManager xsi:nil="true" />
            <SharedAccountManagers xsi:nil="true" />
            <IsActive>boolean</IsActive>
            <IsMergeInvoice>boolean</IsMergeInvoice>
            <PriceType xsi:nil="true" />
            <Currency xsi:nil="true" />
            <TaxGroup xsi:nil="true" />
            <IsApproved>boolean</IsApproved>
            <ApprovedUser xsi:nil="true" />
            <ApprovedDate>dateTime</ApprovedDate>
            <PaymentTerm xsi:nil="true" />
            <SelfBillingPeriod xsi:nil="true" />
            <Logo>base64Binary</Logo>
            <MailingAddress xsi:nil="true" />
            <InvoiceAddress xsi:nil="true" />
            <DeliveryAddress xsi:nil="true" />
            <WebSite>string</WebSite>
            <OrderConfirmationEmail xsi:nil="true" />
            <DespatchConfirmationEmail xsi:nil="true" />
            <SendMethod xsi:nil="true" />
            <SendFormat xsi:nil="true" />
            <SendAddress>string</SendAddress>
            <ReceiveMethod xsi:nil="true" />
            <ReceiveFormat xsi:nil="true" />
            <TurnOverLevel xsi:nil="true" />
            <EmployeeCountLevel xsi:nil="true" />
            <BankAccount xsi:nil="true" />
            <Proofs xsi:nil="true" />
            <Comment>string</Comment>
            <SourceNote>string</SourceNote>
            <NetworkReferenceNumber>string</NetworkReferenceNumber>
            <CompanyName>string</CompanyName>
            <CompanyRegistrationNo>string</CompanyRegistrationNo>
            <CompanyVatNo>string</CompanyVatNo>
            <Industry xsi:nil="true" />
            <MobilePhoneCountLevel xsi:nil="true" />
            <TradingAsType xsi:nil="true" />
            <CreditLimit>decimal</CreditLimit>
            <LoggedInSiteID>int</LoggedInSiteID>
            <SiteName>string</SiteName>
            <CreditRates>string</CreditRates>
            <CreditCategory xsi:nil="true" />
            <AccountCode>string</AccountCode>
            <Opportunities xsi:nil="true" />
            <AlternativeReference>string</AlternativeReference>
            <TimeWithEmployer>int</TimeWithEmployer>
            <DisplayName>string</DisplayName>
            <CurrencyCode>string</CurrencyCode>
            <Symbol>string</Symbol>
            <ExchangeRate>decimal</ExchangeRate>
            <OnStop>boolean</OnStop>
            <UserName>string</UserName>
            <Password1>string</Password1>
            <Password2>string</Password2>
            <Email>string</Email>
            <Fax>string</Fax>
            <Phone>string</Phone>
            <AvailableToSpend>decimal</AvailableToSpend>
            <Application xsi:nil="true" />
            <AllowedApplicationIDs xsi:nil="true" />
            <LangCode>string</LangCode>
            <AccountBalance>decimal</AccountBalance>
            <ProspectType>boolean</ProspectType>
            <LoyaltyGroupID>int</LoyaltyGroupID>
          </Customer>
        </BusinessObjectList>
        <ActualRecordsCount>int</ActualRecordsCount>
        <MetaData>string</MetaData>
        <BusinessObjectBool>boolean</BusinessObjectBool>
      </CustomerAuthenticateResult>
    </CustomerAuthenticateResponse>
  </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/SecurityService.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>
    <CustomerAuthenticate xmlns="http://tempuri.org/">
      <pCustomerAuthentication>
        <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>
      </pCustomerAuthentication>
      <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>
    </CustomerAuthenticate>
  </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>
    <CustomerAuthenticateResponse xmlns="http://tempuri.org/">
      <CustomerAuthenticateResult>
        <IsError>boolean</IsError>
        <ErrorCode>int</ErrorCode>
        <ErrorMessage>string</ErrorMessage>
        <BusinessObjectList>
          <Customer>
            <CustomerID>int</CustomerID>
            <Reference>string</Reference>
            <Contacts xsi:nil="true" />
            <Category xsi:nil="true" />
            <IntroductionDate>dateTime</IntroductionDate>
            <Source xsi:nil="true" />
            <MainAccountManager xsi:nil="true" />
            <SharedAccountManagers xsi:nil="true" />
            <IsActive>boolean</IsActive>
            <IsMergeInvoice>boolean</IsMergeInvoice>
            <PriceType xsi:nil="true" />
            <Currency xsi:nil="true" />
            <TaxGroup xsi:nil="true" />
            <IsApproved>boolean</IsApproved>
            <ApprovedUser xsi:nil="true" />
            <ApprovedDate>dateTime</ApprovedDate>
            <PaymentTerm xsi:nil="true" />
            <SelfBillingPeriod xsi:nil="true" />
            <Logo>base64Binary</Logo>
            <MailingAddress xsi:nil="true" />
            <InvoiceAddress xsi:nil="true" />
            <DeliveryAddress xsi:nil="true" />
            <WebSite>string</WebSite>
            <OrderConfirmationEmail xsi:nil="true" />
            <DespatchConfirmationEmail xsi:nil="true" />
            <SendMethod xsi:nil="true" />
            <SendFormat xsi:nil="true" />
            <SendAddress>string</SendAddress>
            <ReceiveMethod xsi:nil="true" />
            <ReceiveFormat xsi:nil="true" />
            <TurnOverLevel xsi:nil="true" />
            <EmployeeCountLevel xsi:nil="true" />
            <BankAccount xsi:nil="true" />
            <Proofs xsi:nil="true" />
            <Comment>string</Comment>
            <SourceNote>string</SourceNote>
            <NetworkReferenceNumber>string</NetworkReferenceNumber>
            <CompanyName>string</CompanyName>
            <CompanyRegistrationNo>string</CompanyRegistrationNo>
            <CompanyVatNo>string</CompanyVatNo>
            <Industry xsi:nil="true" />
            <MobilePhoneCountLevel xsi:nil="true" />
            <TradingAsType xsi:nil="true" />
            <CreditLimit>decimal</CreditLimit>
            <LoggedInSiteID>int</LoggedInSiteID>
            <SiteName>string</SiteName>
            <CreditRates>string</CreditRates>
            <CreditCategory xsi:nil="true" />
            <AccountCode>string</AccountCode>
            <Opportunities xsi:nil="true" />
            <AlternativeReference>string</AlternativeReference>
            <TimeWithEmployer>int</TimeWithEmployer>
            <DisplayName>string</DisplayName>
            <CurrencyCode>string</CurrencyCode>
            <Symbol>string</Symbol>
            <ExchangeRate>decimal</ExchangeRate>
            <OnStop>boolean</OnStop>
            <UserName>string</UserName>
            <Password1>string</Password1>
            <Password2>string</Password2>
            <Email>string</Email>
            <Fax>string</Fax>
            <Phone>string</Phone>
            <AvailableToSpend>decimal</AvailableToSpend>
            <Application xsi:nil="true" />
            <AllowedApplicationIDs xsi:nil="true" />
            <LangCode>string</LangCode>
            <AccountBalance>decimal</AccountBalance>
            <ProspectType>boolean</ProspectType>
            <LoyaltyGroupID>int</LoyaltyGroupID>
          </Customer>
          <Customer>
            <CustomerID>int</CustomerID>
            <Reference>string</Reference>
            <Contacts xsi:nil="true" />
            <Category xsi:nil="true" />
            <IntroductionDate>dateTime</IntroductionDate>
            <Source xsi:nil="true" />
            <MainAccountManager xsi:nil="true" />
            <SharedAccountManagers xsi:nil="true" />
            <IsActive>boolean</IsActive>
            <IsMergeInvoice>boolean</IsMergeInvoice>
            <PriceType xsi:nil="true" />
            <Currency xsi:nil="true" />
            <TaxGroup xsi:nil="true" />
            <IsApproved>boolean</IsApproved>
            <ApprovedUser xsi:nil="true" />
            <ApprovedDate>dateTime</ApprovedDate>
            <PaymentTerm xsi:nil="true" />
            <SelfBillingPeriod xsi:nil="true" />
            <Logo>base64Binary</Logo>
            <MailingAddress xsi:nil="true" />
            <InvoiceAddress xsi:nil="true" />
            <DeliveryAddress xsi:nil="true" />
            <WebSite>string</WebSite>
            <OrderConfirmationEmail xsi:nil="true" />
            <DespatchConfirmationEmail xsi:nil="true" />
            <SendMethod xsi:nil="true" />
            <SendFormat xsi:nil="true" />
            <SendAddress>string</SendAddress>
            <ReceiveMethod xsi:nil="true" />
            <ReceiveFormat xsi:nil="true" />
            <TurnOverLevel xsi:nil="true" />
            <EmployeeCountLevel xsi:nil="true" />
            <BankAccount xsi:nil="true" />
            <Proofs xsi:nil="true" />
            <Comment>string</Comment>
            <SourceNote>string</SourceNote>
            <NetworkReferenceNumber>string</NetworkReferenceNumber>
            <CompanyName>string</CompanyName>
            <CompanyRegistrationNo>string</CompanyRegistrationNo>
            <CompanyVatNo>string</CompanyVatNo>
            <Industry xsi:nil="true" />
            <MobilePhoneCountLevel xsi:nil="true" />
            <TradingAsType xsi:nil="true" />
            <CreditLimit>decimal</CreditLimit>
            <LoggedInSiteID>int</LoggedInSiteID>
            <SiteName>string</SiteName>
            <CreditRates>string</CreditRates>
            <CreditCategory xsi:nil="true" />
            <AccountCode>string</AccountCode>
            <Opportunities xsi:nil="true" />
            <AlternativeReference>string</AlternativeReference>
            <TimeWithEmployer>int</TimeWithEmployer>
            <DisplayName>string</DisplayName>
            <CurrencyCode>string</CurrencyCode>
            <Symbol>string</Symbol>
            <ExchangeRate>decimal</ExchangeRate>
            <OnStop>boolean</OnStop>
            <UserName>string</UserName>
            <Password1>string</Password1>
            <Password2>string</Password2>
            <Email>string</Email>
            <Fax>string</Fax>
            <Phone>string</Phone>
            <AvailableToSpend>decimal</AvailableToSpend>
            <Application xsi:nil="true" />
            <AllowedApplicationIDs xsi:nil="true" />
            <LangCode>string</LangCode>
            <AccountBalance>decimal</AccountBalance>
            <ProspectType>boolean</ProspectType>
            <LoyaltyGroupID>int</LoyaltyGroupID>
          </Customer>
        </BusinessObjectList>
        <ActualRecordsCount>int</ActualRecordsCount>
        <MetaData>string</MetaData>
        <BusinessObjectBool>boolean</BusinessObjectBool>
      </CustomerAuthenticateResult>
    </CustomerAuthenticateResponse>
  </soap12:Body>
</soap12:Envelope>