Sv translation

language	de

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

Code Block

title	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

Code Block

title	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

Code Block

title	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

Sv translation

language	en

Allows editing and creating directories in file storage.

description

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

parameters

parameter	description	type	hint	mandatory
company	RTI company key	string		yes
import	RTI import key	string		yes
action	action type	string	possible values: NEW: create new directory if you create a new folder that used to exist and contained items, but was deleted, this will reactivate the old folder and all its subfolders RENAME: rename existing directory MOVE: move directory DELETE: delete directory, contained files will be moved to bin	yes
source_path	path to directory	string	format: directory/sub directory/.../affected directory (slash-separated) Root does not have to be specified. To move the file to root directory, just leave the param empty. Paths are case insensitive. nicht relevant bei Aktionstyp NEW	(yes)
name	directory name	string	name of directory only for action types NEW (= name of new folder) RENAME (= new name of folder)	(yes)
destination_path	path to directory		format: directory/sub directory/.../affected directory (slash-separated) Root does not have to be specified. To move the file to root directory, just leave the param empty. Paths are case insensitive. only for action types NEW (= path to parent directory ) MOVE (=path to new parent directory)	(yes)
recursive		string	Flag if given destination_path has to exist. Relevant for action types NEW MOVE If set to 'true', directories specified in destination path that do not exist will be created first before executing the actual action. Is false by default (this will instead lead to UNKNOWN_DESTINATION_PATH error if you try to access a non-existing path).	no

System directories can not be removed.

Root can not be renamed.

return

On success you will receive "OK". On missing parameters or errors you will receive "ERROR:description".

possible error values

error	description
MISSING_COMPANY	company key is missing
INVALID_COMPANY	Company not found. Company key or import key might be faulty.
ERROR_MAINTENANCE	Your company is under maintenance, no RTI request are possible at the moment.
MISSING_IMPORT	import key is missing
UNKNOWN_ACTION	Action type is missing or unknown.
UNKNOWN_DIRECTORY	No directory with given source path found.
CAN_NOT_MODIFY_ROOT	Root directory can not be edited.
CAN_NOT_DELETE_SYSTEM_DIRECTORIES	System directories can not be deleted.
MISSING_NAME / MISSING_NEW_NAME	No name was given. (for action type NEW/RENAME).
NAME_SHOULD_NOT_BE_EMPTY	Name must not be empty string.
INVALID_DIRECTORY_NAME	Name contains invalid characters. Not allowed: ~,",#,%,*,<,>,?,/,\,{,\|,}
UNKNOWN_DESTINATION_PATH	Destination path is unknown. If recursive flag is set, this error will not occur, since the unknown path will be created at request.
DIRECTORY_DOES_ALREADY_EXIST	You are trying to create a new directory, but given destination path already owns a directory with this name.
DIRECTORY_WITH_THIS_PATH_DOES_ALREADY_EXIST	You are trying to move a directory, but given destination path already owns a directory with the same name.
MOVE_FAILED	Moving directory failed.
RENAME_FAILED	Renaming directory failed.
DELETE_FAILED	Deleting directory failed.

examples

create new directory

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

set new name

https://map.yellowfox.de/rti/file_storage/modify_directory.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY&action=RENAME&source_path=images&name=new name

move directory

https://map.yellowfox.de/rti/file_storage/modify_directory.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY&action=MOVE&destination_path=images,photos&source_path=memories

Page tree

Versions Compared

Old Version 15

New Version 16

Key

Beschreibung

Parameter

Rückgabe

Mögliche Fehlerwerte

Beispiele

description

parameters

return

possible error values

examples

Page tree

Page History

Versions Compared

Old Version 15

New Version 16

Key

Beschreibung

Parameter

Rückgabe

Mögliche Fehlerwerte

Beispiele

description

parameters

return

possible error values

examples