LibraryLinkWS Web Service

LibraryLinkWS

Click here for a complete list of operations.

PutFile

Given an image, this method inserts a thumbnail and related metadata into the LibraryLink database. Returns the new idThumb, or 0 for failure.

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 /LibraryLinkWS.asmx HTTP/1.1
Host: llws-colchester.esdm.co.uk
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.esdm.co.uk/PutFile"

<?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>
    <AuthHeader xmlns="http://www.esdm.co.uk/">
      <Token>guid</Token>
    </AuthHeader>
  </soap:Header>
  <soap:Body>
    <PutFile xmlns="http://www.esdm.co.uk/">
      <theFile>base64Binary</theFile>
      <fileSize>int</fileSize>
      <fileName>string</fileName>
      <description>string</description>
      <links>
        <ImageLink>
          <xgKey>string</xgKey>
          <xgType>string</xgType>
        </ImageLink>
        <ImageLink>
          <xgKey>string</xgKey>
          <xgType>string</xgType>
        </ImageLink>
      </links>
      <keywords>
        <string>string</string>
        <string>string</string>
      </keywords>
      <userFields>
        <UserField>
          <columnName>string</columnName>
          <columnValue>string</columnValue>
        </UserField>
        <UserField>
          <columnName>string</columnName>
          <columnValue>string</columnValue>
        </UserField>
      </userFields>
      <feedback>
        <string>string</string>
        <string>string</string>
      </feedback>
    </PutFile>
  </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>
    <PutFileResponse xmlns="http://www.esdm.co.uk/">
      <PutFileResult>int</PutFileResult>
      <feedback>
        <string>string</string>
        <string>string</string>
      </feedback>
    </PutFileResponse>
  </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 /LibraryLinkWS.asmx HTTP/1.1
Host: llws-colchester.esdm.co.uk
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>
    <AuthHeader xmlns="http://www.esdm.co.uk/">
      <Token>guid</Token>
    </AuthHeader>
  </soap12:Header>
  <soap12:Body>
    <PutFile xmlns="http://www.esdm.co.uk/">
      <theFile>base64Binary</theFile>
      <fileSize>int</fileSize>
      <fileName>string</fileName>
      <description>string</description>
      <links>
        <ImageLink>
          <xgKey>string</xgKey>
          <xgType>string</xgType>
        </ImageLink>
        <ImageLink>
          <xgKey>string</xgKey>
          <xgType>string</xgType>
        </ImageLink>
      </links>
      <keywords>
        <string>string</string>
        <string>string</string>
      </keywords>
      <userFields>
        <UserField>
          <columnName>string</columnName>
          <columnValue>string</columnValue>
        </UserField>
        <UserField>
          <columnName>string</columnName>
          <columnValue>string</columnValue>
        </UserField>
      </userFields>
      <feedback>
        <string>string</string>
        <string>string</string>
      </feedback>
    </PutFile>
  </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>
    <PutFileResponse xmlns="http://www.esdm.co.uk/">
      <PutFileResult>int</PutFileResult>
      <feedback>
        <string>string</string>
        <string>string</string>
      </feedback>
    </PutFileResponse>
  </soap12:Body>
</soap12:Envelope>