PUT Attachment (Video, Picture, PDF, URL)

Updates the meta data of one attachment.

Author: Fabian Mielke

Immocaster/Immobilienscout/Rest.php

@@ -1598,4 +1598,50 @@ private function _changeObjectAttachmentsorder($aArgs)
 		$req->unset_parameter('username');
 		return parent::getContent($req,$sSecret);
 	}
+
+	/**
+	 * Attachment(Meta)daten ändern
+	 * Nur Infos über Bild und nicht binären Daten
+	 *
+	 * @param array $aArgs
+	 * @return mixed
+	 */
+	private function _changeObjectAttachment($aArgs)
+	{
+		$aRequired = array('username','estateid','attachmentid','type');
+		if(!isset($aArgs['username']))
+		{
+			$aArgs['username'] = $this->_sDefaultUsername;
+		}
+		// create body for different attachment types
+		$sBreak = "\r\n";
+		$sBody = '<common:attachment xsi:type="common:' .$aArgs['type']. '" xmlns:common="http://rest.immobilienscout24.de/schema/common/1.0" xmlns:ns3="http://rest.immobilienscout24.de/schema/platform/gis/1.0" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">' . $sBreak;
+		$sBody .= '<title>' .$aArgs['title']. '</title>' . $sBreak;
+		$sBody .= '<externalId>' .$aArgs['externalId']. '</externalId>' . $sBreak;
+		if($aArgs['type'] == 'Picture' or $aArgs['type'] == 'PDFDocument') {
+			$sBody .= '<floorplan>' .$aArgs['floorplan']. '</floorplan>' . $sBreak;
+		}
+		if($aArgs['type'] == 'Picture') {
+			$sBody .= '<titlePicture>' .$aArgs['titlePicture']. '</titlePicture>' . $sBreak;
+		}
+		if($aArgs['type'] == 'Link') {
+			$sBody .= '<url>' .$aArgs['url']. '</url>' . $sBreak;
+		}
+		$sBody .= '</common:attachment>';
+		$aArgs['request_body'] = $sBody;
+
+		$oToken = null;
+		$sSecret = null;
+		list($oToken, $sSecret) = $this->getApplicationTokenAndSecret($aArgs['username']);
+		if($oToken === NULL || $sSecret === NULL)
+		{
+			return IMMOCASTER_SDK_LANG_APPLICATION_NOT_CERTIFIED;
+		}
+		$req = $this->doRequest('offer/v1.0/user/'.$aArgs['username'].'/realestate/'.$aArgs['estateid'].'/attachment/'.$aArgs['attachmentid'],$aArgs,$aRequired,__FUNCTION__,$oToken,'PUT');
+		$req->unset_parameter('estateid');
+		$req->unset_parameter('username');
+		$req->unset_parameter('attachmentid');
+		$req->unset_parameter('type');
+		return parent::getContent($req,$sSecret);
+	}
 }

README.txt

@@ -1,4 +1,4 @@
-Immocaster PHP SDK v1.1.73
+Immocaster PHP SDK v1.1.74
 ==========================
 Author:     Norman Braun (http://www.medienopfer98.de)
 Copyright:  Immobilien Scout GmbH
@@ -9,6 +9,9 @@ Das PHP SDK von ImmobilienScout24 steht unter der FreeBSD Lizenz zur Verfügung
 History
 =======
 
+SDK Version 1.1.74
+- PUT Attachment möglich. Hinweis: Aktualisiert die Metdadaten vom Attachment jeder Art (Video, Bild, PDF und URL), aber nicht die binären!
+
 SDK Version 1.1.73
 - GET/PUT Attachmentsorder möglich. Bitte beachten, dass nur die attachmentids von Bildern und PDFs sortiert werden.
 

index.php

@@ -593,6 +593,27 @@
 $res        = $oImmocaster->changeObjectAttachmentsorder($aParameter);
 echo '<div class="codebox"><textarea>'.$res.'</textarea></div>';*/
 
+/**
+ * Aktualisierern eines Attachments (Bild, Video, PDF oder URL).
+ * Bitte beachten, dass dabei nur die Metadaten verändert werden können, nicht das Bild an sich.
+ * API Doku: http://api.immobilienscout24.de/our-apis/import-export/attachments/put-by-id.html
+ */
+echo '<h2>Aktualisieren eines Attachments</h2><br/>Diese Funktion wurde auskommentiert, da dafür eine Zertifizierung nötig ist.<br/><br/>';
+/*$aParameter =
+array(
+    'username'=>'USERNAME',
+    'estateid'=>'ESTATEID',
+    'attachmentid'=>'ATTACHMENTID',
+    'type'=>'ATTACHMENTTYPE', // "Picture", "PDFDocument", "StreamingVideo" oder "Link"
+    'title'=>'TITLE',
+    //'externalId'=>'EXTERNALID', // optional
+    //'floorplan'=>'BOOLEAN', // Nur für Bilder und PDFs
+    //'titlePicture'=>'BOOLEAN', // Nur für Bilder und PDFs
+    //'url' =>'http://URL' // Nur für Links
+);
+$res        = $oImmocaster->changeObjectAttachment($aParameter);
+echo '<div class="codebox"><textarea>'.$res.'</textarea></div>';*/
+
 ?>
 </body>
 </html>