Sets the indicated Query field with the indicated value.

Syntax

Response = HTTP_Services('SetQueryField', Field, Value)

Returns

N/A

Parameters

ParameterDescription
FieldQuery field to set. Required.
ValueValue for the Query field. This will be Trimmed to enforce proper formatting. Required.

Remarks

Query Fields are what appears at the end of a URL which are in this format:

?<field1>=<value1>[&<field2>=<value2>]

Hence, an example of a full URL with a Query Field would look like this:

https://www.mysite.com/api/contacts?name=smith

Query Fields are often used by an API to filter content. The SetQueryField service provides a similar functionality as the Inet_QueryParam function, although the latter is only useful with the RUN_OECGI_REQUEST dispatch routine.

  • No labels