Difference between revisions of "Specifying Query Parameters in REST APIs"

Revision as of 18:58, 14 September 2011

In a REST request, you pass arguments in the form of query parameters. Those parameters are specified in the form parameterName=value.

A parameter list is appended to a URI after a "?". Multiple parameters are separated by "&", as shown here:

  http://{domain}/{address}?parameterName1=value1&parameterName2=value2

For example:

  http://myLongJump.com/networking/rest/user?fieldList=*&sortBy=first_name

For boolean arguments, the value passed can be "1" or "true", "0" or "false".

In some cases, it may be necessary to encode special characters in order to include them in an argument value. For example:

Instead of	Use
& (A&B)	%26 (A%26B)
space (A B)	%32 (A%32B)

You specify the response format as either XML (the default) or JSON, using the alt parameter:

Example

  http://{domain}/{address}?alt=json

@@ Line 14: / Line 14: @@
 For boolean arguments, the value passed can be "1" or "true", "0" or "false".
-In some cases, it may be necessary to [http://www.blooberry.com/indexdot/html/topics/urlencoding.htm encode special characters] in order to include them in an argument value.
+In some cases, it may be necessary to [http://www.blooberry.com/indexdot/html/topics/urlencoding.htm encode special characters] in order to include them in an argument value. For example:
+:{|
+! Instead of !! Use
+|-
+| & (A&B) || %26 (A%26B)
+|-
+| space (A B) || %32 (A%32B)
+|}
 == Specifying Response Format ==