ServiceRequestJSON

Initiates a service request to either retrieve, update, write, or delete JSON data through a RESTful API.

Syntax

Parameters

Parameter Name	Type	Description	Optional?	Default Value
RequestURI	String	The full URI of the intended JSON data.	No	n/a
Method	String	Determines the type of request made. This must be one of the following: GET - Fetches existing data. POST - Overwrites existing data. PUT - Adds new data. DELETE - Deletes existing data.	No	n/a
PostData	String	JSON data to be passed to the service. Only required if Method is set to either POST or PUT.	Yes	""
Token	String	An authorisation token for the intended API, if required.	Yes	""
CustomHeaders	String	Custom headers to include in the request. Headers must use the format Header~Value and if multiple headers are needed, they must be separated using a pipe symbol (|).	Yes	""
Timeout	Integer	The maximum number of seconds the operation has to complete before it times out.	Yes	5
SendHeaderFirst	Boolean	Determines whether the request initially sends header information ahead of the full data set. Some services require this, but it can be switched off if not needed.	Yes	1

Output

Whether or not the request is successful, the function will return a string based on the server's response.

Use Case

The LifeTracker productivity site uses sunrise and sunset data from an API. The following expression uses the GET method to fetch the necessary data, and assigns the resulting string to the VARSunriseJSON variable:

The value assigned to the variable will look something like this: