WebCrmApi

Click here for a complete list of operations.

ReturnFieldDescription

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/ReturnFieldDescription"

<?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>
    <ReturnFieldDescription xmlns="http://www.webcrm.com/">
      <entityType>Undefined or Organisations or Persons or Opportunities or Deliveries or Activities or Events or Products or Relations or Users or SupportCases</entityType>
      <fieldID>long</fieldID>
    </ReturnFieldDescription>
  </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>
    <ReturnFieldDescriptionResponse xmlns="http://www.webcrm.com/">
      <ReturnFieldDescriptionResult>
        <Metadata>
          <Index>long</Index>
          <DatabaseFieldKey>string</DatabaseFieldKey>
          <FieldDescription>string</FieldDescription>
          <SortOrder>long</SortOrder>
          <ItemNumber>long</ItemNumber>
          <DisplayType>C or CPL or D or DA or DAT or DI or DT or DTGMT or EMA or HM or HTML or I or IC or IS or LOGA or LOGP or M or ML or PI or R or SD or SDI or T or TM or UI</DisplayType>
          <FieldSize>int</FieldSize>
          <DropDownItems>
            <FieldMetadataDropdownItem xsi:nil="true" />
            <FieldMetadataDropdownItem xsi:nil="true" />
          </DropDownItems>
          <DatabaseName>string</DatabaseName>
        </Metadata>
      </ReturnFieldDescriptionResult>
    </ReturnFieldDescriptionResponse>
  </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>
    <ReturnFieldDescription xmlns="http://www.webcrm.com/">
      <entityType>Undefined or Organisations or Persons or Opportunities or Deliveries or Activities or Events or Products or Relations or Users or SupportCases</entityType>
      <fieldID>long</fieldID>
    </ReturnFieldDescription>
  </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>
    <ReturnFieldDescriptionResponse xmlns="http://www.webcrm.com/">
      <ReturnFieldDescriptionResult>
        <Metadata>
          <Index>long</Index>
          <DatabaseFieldKey>string</DatabaseFieldKey>
          <FieldDescription>string</FieldDescription>
          <SortOrder>long</SortOrder>
          <ItemNumber>long</ItemNumber>
          <DisplayType>C or CPL or D or DA or DAT or DI or DT or DTGMT or EMA or HM or HTML or I or IC or IS or LOGA or LOGP or M or ML or PI or R or SD or SDI or T or TM or UI</DisplayType>
          <FieldSize>int</FieldSize>
          <DropDownItems>
            <FieldMetadataDropdownItem xsi:nil="true" />
            <FieldMetadataDropdownItem xsi:nil="true" />
          </DropDownItems>
          <DatabaseName>string</DatabaseName>
        </Metadata>
      </ReturnFieldDescriptionResult>
    </ReturnFieldDescriptionResponse>
  </soap12:Body>
</soap12:Envelope>