PutAsset

 Previous  Home topic  Next  Print this topic Send Feedback

The PutAsset method allows you to attach files through the API. It will return the attachment ID of the file and populates the Asset ID property of a File Attachment object on a form.

 

int PutAsset(string tokenIn, byte[] asset, string mimeType, string formId, out string tokenOut, out string assetId)

 

 

Send Params

Return Params
•asset - This represents the contents of the file to be attached.
•assetId - This is the ID of the newly attached asset.
•formId - This is the form that the asset is linked to.
•mimeType - This represents the type of file. Standard mime types are used.
•tokenIn - This is the security token that is obtained by the previous API call. See API Security topic for more details.

tokenOut - This is the new security token that should be used for the next Web service call after this one. See the API Security topic for more details.

 

 

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 /api/API.asmx HTTP/1.1

Host: testing.perfectforms.com

Content-Type: text/xml; charset=utf-8

Content-Length: length

SOAPAction: "http://www.PerfectForms.com/API/PutAsset"

 

<?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>

    <PutAsset xmlns="http://www.PerfectForms.com/API">

      <tokenIn>string</tokenIn>

      <asset>base64Binary</asset>

      <mimeType>string</mimeType>

      <formId>string</formId>

    </PutAsset>

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

    <PutAssetResponse xmlns="http://www.PerfectForms.com/API">

      <PutAssetResult>int</PutAssetResult>

      <tokenOut>string</tokenOut>

      <assetId>string</assetId>

    </PutAssetResponse>

  </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 /api/API.asmx HTTP/1.1

Host: testing.perfectforms.com

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>

    <PutAsset xmlns="http://www.PerfectForms.com/API">

      <tokenIn>string</tokenIn>

      <asset>base64Binary</asset>

      <mimeType>string</mimeType>

      <formId>string</formId>

    </PutAsset>

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

    <PutAssetResponse xmlns="http://www.PerfectForms.com/API">

      <PutAssetResult>int</PutAssetResult>

      <tokenOut>string</tokenOut>

      <assetId>string</assetId>

    </PutAssetResponse>

  </soap12:Body>

</soap12:Envelope>

 

Updated: 06/12/2011  Page url: http://www.perfectforms.com/Documentation/manual/html/?fg_putasset.htm
PerfectForms™ -- forms software, workflow software, and business process management