ReceiveFtpFile - Revision history

Administrator at 19:54, 1 April 2025

2025-04-01T19:54:57Z

← Older revision		Revision as of 19:54, 1 April 2025
Line 12:		Line 12:
	!Returns		!Returns
	\|-		\|-
	\|ReceiveFtpFile		\|'''ReceiveFtpFile'''
	\|PortIndex, RemoteFileName, LocalFileName, [Timeout]		\|PortIndex, RemoteFileName, LocalFileName, [Timeout]
	\|File saved in specified local file name, [[R2D2 Error Codes\|Error Code]] in case of error.		\|File saved in specified local file name, [[R2D2 Error Codes\|Error Code]] in case of error.

Administrator at 19:54, 1 April 2025

2025-04-01T19:54:27Z

← Older revision		Revision as of 19:54, 1 April 2025
Line 1:		Line 1:

	This command ~~executes HTTP method~~ on the specified GSM port.		This command receives a specified file from FTP server on the specified GSM port.

	It requires ~~an active connection to HTTP server~~ on the specified GSM port.		It requires a already opened FTP session on the specified GSM port.

	~~HTTP method can be GET, PUT, DELETE or POST. Input file path is used for PUT and POST methods, output file path is used for GET, DELETE and POST methods.~~		Command waits until file is received or optional timeout (entered in seconds) expired.

	~~If any of required parameter is not needed it can be specified as NULL string ("").~~

	~~Optional HTTP header name and value should be specified always in pair. Up to 12 HTTP headers can be specified.~~

	Command waits until ~~data~~ is ~~transferred~~ or ~~timer expires~~.

	'''COMMAND'''		'''COMMAND'''
Line 18:		Line 12:
	!Returns		!Returns
	\|-		\|-
	\|~~ExecuteHttpMethod~~		\|ReceiveFtpFile
	\|PortIndex, ~~HTTPMethod~~, ~~URL~~, ~~UserName, Password, FilePath, ListPairsHTTPHeaderName-HTTPHeaderValue~~		\|PortIndex, RemoteFileName, LocalFileName, [Timeout]
	\|[[R2D2 Error Codes\|Error Code]] in case of error.		\|File saved in specified local file name, [[R2D2 Error Codes\|Error Code]] in case of error.
	\|}		\|}

Line 29:		Line 23:
	'''EXAMPLE''' <syntaxhighlight lang="text">		'''EXAMPLE''' <syntaxhighlight lang="text">

	~# ~~ExecuteHttpMethod~~ 0 ~~GET www~~.~~acme~~.~~com "user" "pass" "~~""/tmp/test~~/url~~.~~html" "Accept" "text/html" "Transfer-coding" "compress~~"		~# ReceiveFtpFile 0 "./test.dat" "/mnt/sdcard/tmp/test.dat" 120
	OK		FILE RECEIVED

	~# ~~ExecuteHttpMethod~~ 0 ~~GET www~~.~~acme~~.~~com "user" "wrongpass" "~~""/tmp/test~~/url~~.~~html" "Accept" "text/html" "Transfer-coding" "compress~~"		~# ReceiveFtpFile 0 "./test.dot" "/mnt/sdcard/tmp/test.dat"
	~~AUTHENTICATION FAILED~~		FILE NOT FOUND

	~# ~~ExecuteHttpMethod~~ 1 ~~GET www~~.~~acme~~.~~com "" "" "~~" "/tmp/test~~/url~~.~~html" "Accept~~"		~# ReceiveFtpFile 1 "./test.dat" "/mnt/sdcard/tmp/test.dat"
	~~BAD PARAMETERS~~		FTP DISCONNECTED

	~# ~~ExecuteHttpMethod 0 POST www~~.~~acme~~.~~com "user" "pass~~" "/~~tmp~~/~~test/put.htm" "~~/tmp/test~~/url~~.~~html" "Accept" "text/html" "Transfer-coding" "compress~~"		~# ReceiveFtpFile 1 "./test.dat" "/mnt/sdcard/tmp/test.dat"
	OK		TIMEOUT EXPIRED
	</syntaxhighlight>		</syntaxhighlight>
	[[Category:R2D2]]		[[Category:R2D2]]
	[[Category:DATA]]		[[Category:DATA]]

Administrator: Created page with " This command executes HTTP method on the specified GSM port. It requires an active connection to HTTP server on the specified GSM port. HTTP method can be GET, PUT, DELETE or POST. Input file path is used for PUT and POST methods, output file path is used for GET, DELETE and POST methods. If any of required parameter is not needed it can be specified as NULL string (""). Optional HTTP header name and value should be specified always in pair. Up to 12 HTTP headers..."

2025-04-01T19:49:23Z

Created page with " This command executes HTTP method on the specified GSM port. It requires an active connection to HTTP server on the specified GSM port. HTTP method can be GET, PUT, DELETE or POST. Input file path is used for PUT and POST methods, output file path is used for GET, DELETE and POST methods. If any of required parameter is not needed it can be specified as NULL string (""). Optional HTTP header name and value should be specified always in pair. Up to 12 HTTP headers..."

New page

This command executes HTTP method on the specified GSM port.

It requires an active connection to HTTP server on the specified GSM port.

HTTP method can be GET, PUT, DELETE or POST. Input file path is used for PUT and POST methods, output file path is used for GET, DELETE and POST methods.

If any of required parameter is not needed it can be specified as NULL string ("").

Optional HTTP header name and value should be specified always in pair. Up to 12 HTTP headers can be specified.

Command waits until data is transferred or timer expires.

'''COMMAND'''
{| class="wikitable"
!Command
!Line Arguments
!Returns
|-
|ExecuteHttpMethod
|PortIndex, HTTPMethod, URL, UserName, Password, FilePath, ListPairsHTTPHeaderName-HTTPHeaderValue
|[[R2D2 Error Codes|Error Code]] in case of error.
|}

'''OUTPUT'''

Success or Error Message (See [[Data Messages|Data Commands Messages]])

'''EXAMPLE''' <syntaxhighlight lang="text">

~# ExecuteHttpMethod 0 GET www.acme.com "user" "pass" """/tmp/test/url.html" "Accept" "text/html" "Transfer-coding" "compress"
OK

~# ExecuteHttpMethod 0 GET www.acme.com "user" "wrongpass" """/tmp/test/url.html" "Accept" "text/html" "Transfer-coding" "compress"
AUTHENTICATION FAILED

~# ExecuteHttpMethod 1 GET www.acme.com "" "" "" "/tmp/test/url.html" "Accept"
BAD PARAMETERS

~# ExecuteHttpMethod 0 POST www.acme.com "user" "pass" "/tmp/test/put.htm" "/tmp/test/url.html" "Accept" "text/html" "Transfer-coding" "compress"
OK
</syntaxhighlight>
[[Category:R2D2]]
[[Category:DATA]]