AgileApps Support Wiki Pre Release

Difference between revisions of "Specifying Parameters in a URL"

From AgileApps Support Wiki
imported>Aeric
imported>Aeric
m (Text replace - 'http://{domain}' to 'https://{domain}')
Line 3: Line 3:
A ''parameter list'' is appended to a URI after a "?". Multiple parameters are separated by "&", as shown here:
A ''parameter list'' is appended to a URI after a "?". Multiple parameters are separated by "&", as shown here:
:<syntaxhighlight lang="vbnet">
:<syntaxhighlight lang="vbnet">
   http://{domain}/networking/{targetAddress}?parameterName1=value1&parameterName2=value2
   https://{domain}/networking/{targetAddress}?parameterName1=value1&parameterName2=value2
</syntaxhighlight>
</syntaxhighlight>


For example:
For example:
:<syntaxhighlight lang="vbnet">
:<syntaxhighlight lang="vbnet">
   http://{domain}/networking/rest/user?fieldList=*&sortBy=first_name
   https://{domain}/networking/rest/user?fieldList=*&sortBy=first_name
</syntaxhighlight>
</syntaxhighlight>



Revision as of 19:20, 30 March 2012

You pass arguments in a URL using 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:

  https://{domain}/networking/{targetAddress}?parameterName1=value1&parameterName2=value2

For example:

  https://{domain}/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) %20 (A%20B)