Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Sv translation
languagede

Erlaubt das Bearbeiten und Anlegen von Ordnern in der Dateiablage.

Beschreibung

GET  /file_storage/modify_directory.php?company=RTI_COMPANYKEY&import=IMPORTKEY&action=action


Parameter

ParameterBeschreibungTypHinweisPflicht
companyRTI Firmenschlüsselstring
ja
importRTI Importschlüsselstring
ja
actionAktionstypstring

mögliche Werte:

  • NEW: neuen Ordner anlegen
    • wenn Sie einen Ordner an einem Pfad anlegen der bereits einmal existierte und Inhalte enthielt aber welcher gelöscht wurde, so wird dieser inklusive all seiner Unterordner
  • RENAME: bestehenden Ordner umbenennen
  • MOVE: Ordner verschieben
  • DELETE: Ordner löschen, enthaltene Dateien werden dabei in den Papierkorb verschoben
ja
source_pathPfad zum Ordnerstring

Format: Ordner/Unterordner/...,betroffener Ordner (Schrägstrich-getrennt)

Wurzelverzeichnis muss nicht mit angegeben werden. Um die Datei dorthin zu verschieben, kann der Parameter einfach weggelassen werden.

Pfadangaben sind case-insensitive.

nicht relevant bei Aktionstyp NEW

(ja)


nameOrdnernamestring

Name des Ordners

nur bei Aktionstypen

  • NEW (= Name des neuen Ordners)
  • RENAME (= neuer Name des Ordners)
(ja)
destination_pathPfad zum Ordner

Format: Ordner/Unterordner/.../betroffener Ordner (Schrägstrich-getrennt)

Wurzelverzeichnis muss nicht mit angegeben werden. Um die Datei dorthin zu verschieben, kann der Parameter einfach weggelassen werden.

Pfadangaben sind case-insensitive.

nur bei Aktionstypen

  • NEW (=Pfad des übergeordneten Ordners)
  • MOVE (=Pfad des neuen übergeordneten Ordners)
(ja)
recursive
string

Gibt an ob der angegebene destination_path existieren muss. Relevant für Aktionstypen

  • NEW
  • MOVE

Wenn auf 'true' gesetzt, werden ggf. nicht vorhandene Ordner im Pfad zunächst erstellt bevor die eigentliche Aktion ausgeführt wird. Standardmäßig false (unter dieser Einstellung wird stattdessen UNKNOWN_DESTINATION_PATH zurückgegeben wenn ein nicht existenter Pfad angesprochen wird.

nein


Systemordner können nicht gelöscht werden.

Das Wurzelverzeichnis kann nicht umbenannt werden.


Rückgabe

Bei Erfolg erhalten Sie "OK". Bei fehlenden Pflichtparametern oder Fehlern wird ein "ERROR:Beschreibung" zurückgegeben.


Mögliche Fehlerwerte

FehlerBeschreibung
MISSING_COMPANYFirmenschlüssel fehlt
INVALID_COMPANYFirma nicht gefunden. Dies kann an einem fehlerhaften Firmen- oder Import-Schlüssel liegen. 
ERROR_MAINTENANCEIhre Firma wird gerade gewartet, währenddessen sind keine RTI Abfragen möglich.
MISSING_IMPORTImport-Schlüssel fehlt.
UNKNOWN_ACTIONAktionstyp fehlt oder ist unbekannt.
UNKNOWN_DIRECTORYKein Ordner mit dem angegebenen source_path gefunden.
CAN_NOT_MODIFY_ROOTDas Wurzelverzeichnis kann nicht bearbeitet werden.
CAN_NOT_DELETE_SYSTEM_DIRECTORIESSystemordner können nicht gelöscht werden.
MISSING_NAME / MISSING_NEW_NAMEEs wurde kein Name angegeben (bei Aktionstyp NEW/RENAME).
NAME_SHOULD_NOT_BE_EMPTYDer Name kann kein Leerstring sein.
INVALID_DIRECTORY_NAMEIhr Ordnername enthält ungültige Zeichen. Nicht erlaubt: ~,",#,%,*,<,>,?,/,\,{,|,}
UNKNOWN_DESTINATION_PATHDer Zielpfad ist ungültig. Dieser Fehler kommt nicht wenn recursive auf true gesetzt ist, in diesem Fall würde der unbekannte Pfad erstellt werden.
DIRECTORY_DOES_ALREADY_EXISTSie versuchen einen neuen Ordner anzulegen, aber im angegebenen Verzeichnis existiert bereits ein Ordner mit diesem Namen.
DIRECTORY_WITH_THIS_PATH_DOES_ALREADY_EXISTSie versuchen einen Ordner zu verschieben, aber im angegebenen Verzeichnis existiert bereits ein Ordner mit demselben Namen.
MOVE_FAILEDVerschieben ist fehlgeschlagen.
RENAME_FAILEDUmbenennen ist fehlgeschlagen.
DELETE_FAILEDLöschen ist fehlgeschlagen.

Beispiele

Neuen Ordner anlegen

httphttps://map.yellowfox.de/rti/file_storage/modify_directory.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY&action=NEW&destination_path=Bilder&name=Fotos


Neuen Namen setzen

httphttps://map.yellowfox.de/rti/file_storage/modify_directory.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY&action=RENAME&source_path=Bilder&name=neuer name


Verschieben

httphttps://map.yellowfox.de/rti/file_storage/modify_directory.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY&action=MOVE&destination_path=Bilder,Fotos&source_path=Erinnerungen


...