WebCrmApi Web Service

WebCrmApi

Click here for a complete list of operations.

QuickSearch

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 /WebCrmApi.asmx HTTP/1.1
Host: api1.b2bsys.net
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.webcrm.com/QuickSearch"

<?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>
    <QuickSearch xmlns="http://www.webcrm.com/">
      <dbnCode>string</dbnCode>
      <userName>string</userName>
      <password>string</password>
      <searchMode>Undefined or TeleNumbers or Organisation or PersonName or PersonEmail</searchMode>
      <searchValue>string</searchValue>
      <userID>long</userID>
      <options>None or IgnoreCase</options>
    </QuickSearch>
  </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>
    <QuickSearchResponse xmlns="http://www.webcrm.com/">
      <QuickSearchResult>
        <Meetings>
          <MeetingData>
            <DateTime>dateTime</DateTime>
            <Description>string</Description>
            <ContactPersonName>string</ContactPersonName>
          </MeetingData>
          <MeetingData>
            <DateTime>dateTime</DateTime>
            <Description>string</Description>
            <ContactPersonName>string</ContactPersonName>
          </MeetingData>
        </Meetings>
        <Activities>
          <ActivityData>
            <DateTime>dateTime</DateTime>
            <Action>string</Action>
            <Description>string</Description>
            <ContactPersonName>string</ContactPersonName>
          </ActivityData>
          <ActivityData>
            <DateTime>dateTime</DateTime>
            <Action>string</Action>
            <Description>string</Description>
            <ContactPersonName>string</ContactPersonName>
          </ActivityData>
        </Activities>
        <SupportCases>
          <SupportCaseData>
            <DeadlineDateTime>dateTime</DeadlineDateTime>
            <Action>string</Action>
            <Subject>string</Subject>
            <ContactPersonName>string</ContactPersonName>
          </SupportCaseData>
          <SupportCaseData>
            <DeadlineDateTime>dateTime</DeadlineDateTime>
            <Action>string</Action>
            <Subject>string</Subject>
            <ContactPersonName>string</ContactPersonName>
          </SupportCaseData>
        </SupportCases>
        <Opportunities>
          <OpportunityData>
            <PipelineLevel>long</PipelineLevel>
            <DeliveryStatus>long</DeliveryStatus>
            <DeliveryRisk>long</DeliveryRisk>
            <Description>string</Description>
            <Number>string</Number>
            <Value>long</Value>
            <Product>string</Product>
            <DateTime>dateTime</DateTime>
          </OpportunityData>
          <OpportunityData>
            <PipelineLevel>long</PipelineLevel>
            <DeliveryStatus>long</DeliveryStatus>
            <DeliveryRisk>long</DeliveryRisk>
            <Description>string</Description>
            <Number>string</Number>
            <Value>long</Value>
            <Product>string</Product>
            <DateTime>dateTime</DateTime>
          </OpportunityData>
        </Opportunities>
        <PersonSalutation>string</PersonSalutation>
        <PersonTitle>string</PersonTitle>
        <PersonFullName>string</PersonFullName>
        <PersonTelephone>string</PersonTelephone>
        <PersonMobileNumber>string</PersonMobileNumber>
        <OrganisationName>string</OrganisationName>
        <OrganisationDivisionName>string</OrganisationDivisionName>
        <OrganisationTelephone>string</OrganisationTelephone>
        <OrganisationFullAddress>string</OrganisationFullAddress>
        <OrganisationAlertText>string</OrganisationAlertText>
      </QuickSearchResult>
    </QuickSearchResponse>
  </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 /WebCrmApi.asmx HTTP/1.1
Host: api1.b2bsys.net
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>
    <QuickSearch xmlns="http://www.webcrm.com/">
      <dbnCode>string</dbnCode>
      <userName>string</userName>
      <password>string</password>
      <searchMode>Undefined or TeleNumbers or Organisation or PersonName or PersonEmail</searchMode>
      <searchValue>string</searchValue>
      <userID>long</userID>
      <options>None or IgnoreCase</options>
    </QuickSearch>
  </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>
    <QuickSearchResponse xmlns="http://www.webcrm.com/">
      <QuickSearchResult>
        <Meetings>
          <MeetingData>
            <DateTime>dateTime</DateTime>
            <Description>string</Description>
            <ContactPersonName>string</ContactPersonName>
          </MeetingData>
          <MeetingData>
            <DateTime>dateTime</DateTime>
            <Description>string</Description>
            <ContactPersonName>string</ContactPersonName>
          </MeetingData>
        </Meetings>
        <Activities>
          <ActivityData>
            <DateTime>dateTime</DateTime>
            <Action>string</Action>
            <Description>string</Description>
            <ContactPersonName>string</ContactPersonName>
          </ActivityData>
          <ActivityData>
            <DateTime>dateTime</DateTime>
            <Action>string</Action>
            <Description>string</Description>
            <ContactPersonName>string</ContactPersonName>
          </ActivityData>
        </Activities>
        <SupportCases>
          <SupportCaseData>
            <DeadlineDateTime>dateTime</DeadlineDateTime>
            <Action>string</Action>
            <Subject>string</Subject>
            <ContactPersonName>string</ContactPersonName>
          </SupportCaseData>
          <SupportCaseData>
            <DeadlineDateTime>dateTime</DeadlineDateTime>
            <Action>string</Action>
            <Subject>string</Subject>
            <ContactPersonName>string</ContactPersonName>
          </SupportCaseData>
        </SupportCases>
        <Opportunities>
          <OpportunityData>
            <PipelineLevel>long</PipelineLevel>
            <DeliveryStatus>long</DeliveryStatus>
            <DeliveryRisk>long</DeliveryRisk>
            <Description>string</Description>
            <Number>string</Number>
            <Value>long</Value>
            <Product>string</Product>
            <DateTime>dateTime</DateTime>
          </OpportunityData>
          <OpportunityData>
            <PipelineLevel>long</PipelineLevel>
            <DeliveryStatus>long</DeliveryStatus>
            <DeliveryRisk>long</DeliveryRisk>
            <Description>string</Description>
            <Number>string</Number>
            <Value>long</Value>
            <Product>string</Product>
            <DateTime>dateTime</DateTime>
          </OpportunityData>
        </Opportunities>
        <PersonSalutation>string</PersonSalutation>
        <PersonTitle>string</PersonTitle>
        <PersonFullName>string</PersonFullName>
        <PersonTelephone>string</PersonTelephone>
        <PersonMobileNumber>string</PersonMobileNumber>
        <OrganisationName>string</OrganisationName>
        <OrganisationDivisionName>string</OrganisationDivisionName>
        <OrganisationTelephone>string</OrganisationTelephone>
        <OrganisationFullAddress>string</OrganisationFullAddress>
        <OrganisationAlertText>string</OrganisationAlertText>
      </QuickSearchResult>
    </QuickSearchResponse>
  </soap12:Body>
</soap12:Envelope>