Wialon for developers User guide API reference item update_ftp_property

update_ftp_property

The update_ftp_property function is used to update custom FTP settings.

Copied!
svc=item/update_ftp_property&params={"itemId":<long>,
				     				 "host":"<text>",
				     				 "login":"<text>",
				     				 "pass":"<text>",
				     				 "path":"<text>",
				     				 "check":<uint>,
				     				 "hostingFtp":<uint>}

Parameters

Name Description
itemId Resource ID.
host FTP URL.
login FTP login.
pass FTP password.
path Directory path.
check Valid FTP settings:
  • 0 — no;
  • 1 — yes.
hostingFtp Send data to the Wialon Hosting FTP:
  • 0 — no;
  • 1 — yes.
To send data to custom FTP, the “hostingFtp” value should be 0, the “check” value — 1.

Returned result

Copied!
{
   "hs":"<text>",	/* FTP URL */  
   "lg":"<text>",	/* FTP login */  
   "pt":"<text>",	/* directory path */  
   "ch":<uint>,	/* valid FTP settings */  
   "tp":<uint>	/* send data to the Wialon Hosting FTP */  
}

Possible error codes:

Code Description
7 Failed to fetch the item with the desired ACL(ADF_ACL_ITEM_EDIT_OTHER).
6 Undefined error.
4 Wrong input parameters.

If you find a mistake in the text, please select it and press Ctrl+Enter.