file_storage/modify_directory.php

Zuletzt geändert von YellowFox_RD am 2025/01/20 15:36

Inhaltsverzeichnis

Beschreibung
Parameter
Rückgabe
- Mögliche Fehlerwerte
Beispiele

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

Parameter	Beschreibung	Typ	Hinweis	Pflicht
company	RTI Firmenschlüssel	string		ja
import	RTI Importschlüssel	string		ja
action	Aktionstyp	string	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_path	Pfad zum Ordner	string	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)
name	Ordnername	string	Name des Ordners nur bei Aktionstypen NEW (= Name des neuen Ordners) RENAME (= neuer Name des Ordners)	(ja)
destination_path	Pfad 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

Fehler	Beschreibung
MISSING_COMPANY	Firmenschlüssel fehlt
INVALID_COMPANY	Firma nicht gefunden. Dies kann an einem fehlerhaften Firmen- oder Import-Schlüssel liegen.
ERROR_MAINTENANCE	Ihre Firma wird gerade gewartet, währenddessen sind keine RTI Abfragen möglich.
MISSING_IMPORT	Import-Schlüssel fehlt.
UNKNOWN_ACTION	Aktionstyp fehlt oder ist unbekannt.
UNKNOWN_DIRECTORY	Kein Ordner mit dem angegebenen source_path gefunden.
CAN_NOT_MODIFY_ROOT	Das Wurzelverzeichnis kann nicht bearbeitet werden.
CAN_NOT_DELETE_SYSTEM_DIRECTORIES	Systemordner können nicht gelöscht werden.
MISSING_NAME / MISSING_NEW_NAME	Es wurde kein Name angegeben (bei Aktionstyp NEW/RENAME).
NAME_SHOULD_NOT_BE_EMPTY	Der Name kann kein Leerstring sein.
INVALID_DIRECTORY_NAME	Ihr Ordnername enthält ungültige Zeichen. Nicht erlaubt: ,",#,%,*,<,>,?,/,\,{,\|,}
UNKNOWN_DESTINATION_PATH	Der 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_EXIST	Sie versuchen einen neuen Ordner anzulegen, aber im angegebenen Verzeichnis existiert bereits ein Ordner mit diesem Namen.
DIRECTORY_WITH_THIS_PATH_DOES_ALREADY_EXIST	Sie versuchen einen Ordner zu verschieben, aber im angegebenen Verzeichnis existiert bereits ein Ordner mit demselben Namen.
MOVE_FAILED	Verschieben ist fehlgeschlagen.
RENAME_FAILED	Umbenennen ist fehlgeschlagen.
DELETE_FAILED	Löschen ist fehlgeschlagen.

Beispiele

Neuen Ordner anlegen
https://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
https://map.yellowfox.de/rti/file_storage/modify_directory.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY&action=RENAME&source_path=Bilder&name=neuer name

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