WebCrmApi

Click here for a complete list of operations.

ReadDocument

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

<?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>
    <ReadDocument xmlns="http://www.webcrm.com/">
      <documentId>long</documentId>
    </ReadDocument>
  </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>
    <ReadDocumentResponse xmlns="http://www.webcrm.com/">
      <ReadDocumentResult>
        <Document>
          <ID>long</ID>
          <CreatedAt>dateTime</CreatedAt>
          <CreatedBy>string</CreatedBy>
          <LastUpdatedAt>dateTime</LastUpdatedAt>
          <LastUpdatedBy>string</LastUpdatedBy>
          <Description>string</Description>
          <Folder>string</Folder>
          <UserGroup>long</UserGroup>
          <Territory>long</Territory>
          <LanguageCode>int</LanguageCode>
          <UserId>long</UserId>
          <OrganisationId>long</OrganisationId>
          <LinkedEntityType>int</LinkedEntityType>
          <LinkedEntityId>long</LinkedEntityId>
          <FileName>string</FileName>
          <FileCode>string</FileCode>
          <FileSize>int</FileSize>
          <FileExtension>string</FileExtension>
          <IsAllowedAsAttachment>boolean</IsAllowedAsAttachment>
          <UploadedAt>dateTime</UploadedAt>
          <UploadCount>unsignedByte</UploadCount>
        </Document>
      </ReadDocumentResult>
    </ReadDocumentResponse>
  </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:Header>
    <TicketHeader xmlns="http://www.webcrm.com/">
      <Guid>string</Guid>
    </TicketHeader>
  </soap12:Header>
  <soap12:Body>
    <ReadDocument xmlns="http://www.webcrm.com/">
      <documentId>long</documentId>
    </ReadDocument>
  </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>
    <ReadDocumentResponse xmlns="http://www.webcrm.com/">
      <ReadDocumentResult>
        <Document>
          <ID>long</ID>
          <CreatedAt>dateTime</CreatedAt>
          <CreatedBy>string</CreatedBy>
          <LastUpdatedAt>dateTime</LastUpdatedAt>
          <LastUpdatedBy>string</LastUpdatedBy>
          <Description>string</Description>
          <Folder>string</Folder>
          <UserGroup>long</UserGroup>
          <Territory>long</Territory>
          <LanguageCode>int</LanguageCode>
          <UserId>long</UserId>
          <OrganisationId>long</OrganisationId>
          <LinkedEntityType>int</LinkedEntityType>
          <LinkedEntityId>long</LinkedEntityId>
          <FileName>string</FileName>
          <FileCode>string</FileCode>
          <FileSize>int</FileSize>
          <FileExtension>string</FileExtension>
          <IsAllowedAsAttachment>boolean</IsAllowedAsAttachment>
          <UploadedAt>dateTime</UploadedAt>
          <UploadCount>unsignedByte</UploadCount>
        </Document>
      </ReadDocumentResult>
    </ReadDocumentResponse>
  </soap12:Body>
</soap12:Envelope>