Versions Compared

Key

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

Web APIs can pass in parameters in three different ways: 1.) Query Fields, 2.) Request Header Fields, and 3.) in the Request Body. This article will explain how to retrieve the value of a parameter for each of these scenarios.

Query

...

Fields

Query fields (aka query params) appear in the URL and are separated from the main resource endpoint with the question mark ("?") character and then followed with one or more parameters. Each parameter is separated with the ampersand ("&") character. Parameters normally take the form of a name/value pair. The equal sign ("=") character is used to separate the field name from the field value. Query fields can appear alone as a label, but this rare and discouraged because the meaning of a label is ambiguous (e.g., Does a label without a value imply an empty value? Is a label without a value meant to be a value in and of itself by virtue of appearing in the URL?).

...