WebCrmApi

Click here for a complete list of operations.

RetrieveByQuery

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: webcrmapi5.b2bsys.net
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.webcrm.com/RetrieveByQuery"

<?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:Header>
    <TicketHeader xmlns="http://www.webcrm.com/">
      <Guid>string</Guid>
    </TicketHeader>
  </soap:Header>
  <soap:Body>
    <RetrieveByQuery xmlns="http://www.webcrm.com/">
      <selectFields>string</selectFields>
      <tables>string</tables>
      <whereClause>string</whereClause>
      <orderBy>string</orderBy>
    </RetrieveByQuery>
  </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>
    <RetrieveByQueryResponse xmlns="http://www.webcrm.com/">
      <RetrieveByQueryResult>
        <Fields>
          <string>string</string>
          <string>string</string>
        </Fields>
        <Rows>
          <RetrieveByQueryResultRow>
            <FieldValues xsi:nil="true" />
          </RetrieveByQueryResultRow>
          <RetrieveByQueryResultRow>
            <FieldValues xsi:nil="true" />
          </RetrieveByQueryResultRow>
        </Rows>
      </RetrieveByQueryResult>
    </RetrieveByQueryResponse>
  </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: webcrmapi5.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:Header>
    <TicketHeader xmlns="http://www.webcrm.com/">
      <Guid>string</Guid>
    </TicketHeader>
  </soap12:Header>
  <soap12:Body>
    <RetrieveByQuery xmlns="http://www.webcrm.com/">
      <selectFields>string</selectFields>
      <tables>string</tables>
      <whereClause>string</whereClause>
      <orderBy>string</orderBy>
    </RetrieveByQuery>
  </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>
    <RetrieveByQueryResponse xmlns="http://www.webcrm.com/">
      <RetrieveByQueryResult>
        <Fields>
          <string>string</string>
          <string>string</string>
        </Fields>
        <Rows>
          <RetrieveByQueryResultRow>
            <FieldValues xsi:nil="true" />
          </RetrieveByQueryResultRow>
          <RetrieveByQueryResultRow>
            <FieldValues xsi:nil="true" />
          </RetrieveByQueryResultRow>
        </Rows>
      </RetrieveByQueryResult>
    </RetrieveByQueryResponse>
  </soap12:Body>
</soap12:Envelope>