Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Returns the value previously set for the indicated Query Field. If then indicated Query Field has not been set then then an error condition will be set.

Syntax

Code Block
Response = HTTP_Services('GetQueryField', Field)

Returns

The value for the specified Query Field.

Parameters

ParameterDescription
FieldQuery Field to get. 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 GetQueryField service provides a similar functionality as the Inet_QueryParam function, although the latter is only useful with the RUN_OECGI_REQUEST dispatch routine.