CustomerService
Click here for a complete list of operations.
CustomerList
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/CustomerService.asmx HTTP/1.1
Host: rosecommunications.salestarconnect.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://tempuri.org/CustomerList"
<?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>
<CustomerList xmlns="http://tempuri.org/">
<pSearchParams>
<CustomerID>int</CustomerID>
<CustomerName>string</CustomerName>
<OrganisationName>string</OrganisationName>
<CustomerCode>string</CustomerCode>
<strBirthday>string</strBirthday>
<Birthday>dateTime</Birthday>
<Reference>string</Reference>
<Active>boolean</Active>
<PostCode>string</PostCode>
<Street>string</Street>
<City>string</City>
<CountryID>int</CountryID>
<Mobile>string</Mobile>
<Phone>string</Phone>
<NetworkReference>string</NetworkReference>
<bDeleted>boolean</bDeleted>
<CustomerTypeID>int</CustomerTypeID>
<bVerified>boolean</bVerified>
<PhoneAll>string</PhoneAll>
<NetworkDealerCode>string</NetworkDealerCode>
<VATNumber>string</VATNumber>
<AlternativeRef>string</AlternativeRef>
<CustomerCategoryID>int</CustomerCategoryID>
<AccountManagerID>int</AccountManagerID>
<IsApproved>boolean</IsApproved>
<EmployeeLoginID>long</EmployeeLoginID>
<ContactName>string</ContactName>
<Status>int</Status>
<ApplicationID>int</ApplicationID>
<AccountManagerName>string</AccountManagerName>
<CampaignID>int</CampaignID>
<SearchString>string</SearchString>
<Address>string</Address>
<RenewalDateFrom>dateTime</RenewalDateFrom>
<RenewalDateTo>dateTime</RenewalDateTo>
<RenewalDateValue>int</RenewalDateValue>
<CreatedDateFrom>dateTime</CreatedDateFrom>
<CreatedDateTo>dateTime</CreatedDateTo>
<CreatedDateValue>int</CreatedDateValue>
<OrderByID>int</OrderByID>
<IsAcending>boolean</IsAcending>
<ContactPerson>string</ContactPerson>
<CompanyName>string</CompanyName>
<CustomerSourceID>int</CustomerSourceID>
<SearchTypeID>int</SearchTypeID>
<ExpectedRevenueGreaterThan>decimal</ExpectedRevenueGreaterThan>
<ExpectedRevenueLessThan>decimal</ExpectedRevenueLessThan>
<ProspectRatingID>int</ProspectRatingID>
<Source>string</Source>
<IsButtonSearch>boolean</IsButtonSearch>
<LoggingSiteID>int</LoggingSiteID>
<PageSize>int</PageSize>
<Page>int</Page>
<IsCount>boolean</IsCount>
<CampaignProspectStatus>int</CampaignProspectStatus>
<AssignedTo>int</AssignedTo>
<NotProcessedInCampaignOnly>boolean</NotProcessedInCampaignOnly>
<ActiveInCampaignOnly>boolean</ActiveInCampaignOnly>
<ProspectType>int</ProspectType>
<ContactPhone>string</ContactPhone>
<ContactEmail>string</ContactEmail>
<MarketingAllowedOnly>boolean</MarketingAllowedOnly>
<LeadImportFileID>int</LeadImportFileID>
<LeadImportFileSearchType>int</LeadImportFileSearchType>
<ContactDetails>string</ContactDetails>
<ProspectStatusID>int</ProspectStatusID>
<IsLoyality>boolean</IsLoyality>
<LoyalityGroupID>int</LoyalityGroupID>
<NoOfVisitsFrom>string</NoOfVisitsFrom>
<NoOfVisitsTo>string</NoOfVisitsTo>
<TotalGPFrom>string</TotalGPFrom>
<TotalGPTo>string</TotalGPTo>
<SaleValueFrom>string</SaleValueFrom>
<SaleValueTo>string</SaleValueTo>
<IsCampaignSearch>boolean</IsCampaignSearch>
<bCampaignPanelSearch>boolean</bCampaignPanelSearch>
<CustomerType>int</CustomerType>
<LeadCategoryID>int</LeadCategoryID>
<LeadSourceID>int</LeadSourceID>
<MarketingPreferenceID>int</MarketingPreferenceID>
<enableCustomerFullDetails>boolean</enableCustomerFullDetails>
</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>
</CustomerList>
</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>
<CustomerListResponse xmlns="http://tempuri.org/">
<CustomerListResult>
<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>
</CustomerListResult>
</CustomerListResponse>
</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/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>
<CustomerList xmlns="http://tempuri.org/">
<pSearchParams>
<CustomerID>int</CustomerID>
<CustomerName>string</CustomerName>
<OrganisationName>string</OrganisationName>
<CustomerCode>string</CustomerCode>
<strBirthday>string</strBirthday>
<Birthday>dateTime</Birthday>
<Reference>string</Reference>
<Active>boolean</Active>
<PostCode>string</PostCode>
<Street>string</Street>
<City>string</City>
<CountryID>int</CountryID>
<Mobile>string</Mobile>
<Phone>string</Phone>
<NetworkReference>string</NetworkReference>
<bDeleted>boolean</bDeleted>
<CustomerTypeID>int</CustomerTypeID>
<bVerified>boolean</bVerified>
<PhoneAll>string</PhoneAll>
<NetworkDealerCode>string</NetworkDealerCode>
<VATNumber>string</VATNumber>
<AlternativeRef>string</AlternativeRef>
<CustomerCategoryID>int</CustomerCategoryID>
<AccountManagerID>int</AccountManagerID>
<IsApproved>boolean</IsApproved>
<EmployeeLoginID>long</EmployeeLoginID>
<ContactName>string</ContactName>
<Status>int</Status>
<ApplicationID>int</ApplicationID>
<AccountManagerName>string</AccountManagerName>
<CampaignID>int</CampaignID>
<SearchString>string</SearchString>
<Address>string</Address>
<RenewalDateFrom>dateTime</RenewalDateFrom>
<RenewalDateTo>dateTime</RenewalDateTo>
<RenewalDateValue>int</RenewalDateValue>
<CreatedDateFrom>dateTime</CreatedDateFrom>
<CreatedDateTo>dateTime</CreatedDateTo>
<CreatedDateValue>int</CreatedDateValue>
<OrderByID>int</OrderByID>
<IsAcending>boolean</IsAcending>
<ContactPerson>string</ContactPerson>
<CompanyName>string</CompanyName>
<CustomerSourceID>int</CustomerSourceID>
<SearchTypeID>int</SearchTypeID>
<ExpectedRevenueGreaterThan>decimal</ExpectedRevenueGreaterThan>
<ExpectedRevenueLessThan>decimal</ExpectedRevenueLessThan>
<ProspectRatingID>int</ProspectRatingID>
<Source>string</Source>
<IsButtonSearch>boolean</IsButtonSearch>
<LoggingSiteID>int</LoggingSiteID>
<PageSize>int</PageSize>
<Page>int</Page>
<IsCount>boolean</IsCount>
<CampaignProspectStatus>int</CampaignProspectStatus>
<AssignedTo>int</AssignedTo>
<NotProcessedInCampaignOnly>boolean</NotProcessedInCampaignOnly>
<ActiveInCampaignOnly>boolean</ActiveInCampaignOnly>
<ProspectType>int</ProspectType>
<ContactPhone>string</ContactPhone>
<ContactEmail>string</ContactEmail>
<MarketingAllowedOnly>boolean</MarketingAllowedOnly>
<LeadImportFileID>int</LeadImportFileID>
<LeadImportFileSearchType>int</LeadImportFileSearchType>
<ContactDetails>string</ContactDetails>
<ProspectStatusID>int</ProspectStatusID>
<IsLoyality>boolean</IsLoyality>
<LoyalityGroupID>int</LoyalityGroupID>
<NoOfVisitsFrom>string</NoOfVisitsFrom>
<NoOfVisitsTo>string</NoOfVisitsTo>
<TotalGPFrom>string</TotalGPFrom>
<TotalGPTo>string</TotalGPTo>
<SaleValueFrom>string</SaleValueFrom>
<SaleValueTo>string</SaleValueTo>
<IsCampaignSearch>boolean</IsCampaignSearch>
<bCampaignPanelSearch>boolean</bCampaignPanelSearch>
<CustomerType>int</CustomerType>
<LeadCategoryID>int</LeadCategoryID>
<LeadSourceID>int</LeadSourceID>
<MarketingPreferenceID>int</MarketingPreferenceID>
<enableCustomerFullDetails>boolean</enableCustomerFullDetails>
</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>
</CustomerList>
</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>
<CustomerListResponse xmlns="http://tempuri.org/">
<CustomerListResult>
<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>
</CustomerListResult>
</CustomerListResponse>
</soap12:Body>
</soap12:Envelope>