View source for Component: HTTP Fetch ( Comms)

{| style="width:50%"
|-
| width="20%" style="color:gray;" | Author
| MatrixTSL
|-
| width="20%" style="color:gray;" | Version
| 0.1
|-
| width="20%" style="color:gray;" | Category
|  Comms
|}


==HTTP Fetch component==
Component designed to request resources from an external HTTP server.

==Component Source Code==

Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_WEBEXP_Fetch.fcsx FC_Comp_Source_WEBEXP_Fetch.fcsx]

Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_WEBEXP_Fetch.fcsx FC_Comp_Source_WEBEXP_Fetch.fcsx]

==Detailed description==

''No detailed description exists yet for this component''

==Examples==

===HTTP===

Example program showing how to retreive the HTML source of a HTTP URL. 

{{Fcfile|WebFetchHTML.fcsx|Fetch HTTP Example}}


The HTML source is hosted at the following URL: http://www.flowcode.co.uk/example/fetchtest.txt

[[:File:fetchtest.txt]]



===HTTP JSON Encoded===

Example program showing how to retreive the HTML source of a HTTP URL. Here the source is encoded JSON data which we can parse through.

{{Fcfile|WebFetchJSON.fcsx|Fetch HTTP JSON Example}}


The HTML source is hosted at the following URL: http://www.flowcode.co.uk/example/jsonfetchtest.txt

[[:File:jsonfetchtest.txt]]



===HTTP JSON Encoded Time and Date===

Example program showing how to retreive the HTML source of a HTTP URL. Here the source is encoded JSON data which we can parse through. The data is created using a PHP script which allows for dynamic data such as the current time and date.

{{Fcfile|WebFetchJSONTimeDate.fcsx|Fetch HTTP Time Date Example}}


The HTML source is hosted at the following URL: http://www.flowcode.co.uk/example/jsonfetchtimedate.php

Please note the file type for the file below has been changed from .php to .txt to be allowed onto the Wiki.

[[:File:jsonfetchtimedate.txt]]



===Fetch Parameters===

Example program showing how to retreive the JSON data source of a HTTP URL. Here the source is encoded JSON data which we can parse through. The data is created using a PHP script which allows for dynamic data in this case based on the selection made using the radio buttons.

{{Fcfile|WebFetchParameter.fcsx|Fetch Parameter Example}}


The HTML source is hosted at the following URL: http://www.flowcode.co.uk/example/get_data.php

Please note the file type for the file below has been changed from .php to .txt to be allowed onto the Wiki.

[[:File:get_data.txt]]



===Weather Example===

Example program showcasing a number of components used together to collect data from a URL using fetch, before processing the data using the object helper and array helper components.

{{Fcfile|Web_Weather.fcsx|Web Weather Example}}



==Macro reference==

===Fetch===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Fetch'''
|-
| colspan="2" | Start the process of fetching a resource from a web server&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | sParams
|-
| colspan="2" | Parameters for the Fetch call&nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


===SetDataType===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetDataType'''
|-
| colspan="2" | Override the DataType property&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
| width="90%" | Type
|-
| colspan="2" | 0=JSON Encoded. 1=Raw Text&nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


===SetMacro===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetMacro'''
|-
| colspan="2" | &nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | sMacro
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


===SetURL===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetURL'''
|-
| colspan="2" | Sets the URL for the Fetch call&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | sURL
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


==Property reference==

{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties''' 
|-
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | URL
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-24-icon.png]]
| width="90%" | Call macro
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | DataType
|-
| colspan="2" | Decide what type of data to receive&nbsp;
|}