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 an app.
int PutAsset(string tokenIn, byte[] asset, string mimeType, string appId, 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. •appId - This is the app 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. |
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: app.perfectforms.com Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "http://www.PerfectApps.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.PerfectApps.com/API"> <tokenIn>string</tokenIn> <asset>base64Binary</asset> <mimeType>string</mimeType> <appId>string</appId> </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.PerfectApps.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: app.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.PerfectApps.com/API"> <tokenIn>string</tokenIn> <asset>base64Binary</asset> <mimeType>string</mimeType> <appId>string</appId> </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.PerfectApps.com/API"> <PutAssetResult>int</PutAssetResult> <tokenOut>string</tokenOut> <assetId>string</assetId> </PutAssetResponse> </soap12:Body> </soap12:Envelope> |
Return to: Account API Methods (SOAP), Integration
