Query Parameters

Query parameters are sent in the request url after the question mark (?). Each query parameter is separated with an ampersand (&) and are written as name=value.

The RamBase Api has a set of query parameters in addition to the query parameters that are associated with a resource. All of these are listed below. Some query parameters are always available, and some are only available for some types of resources.

1. All RamBase query parameters

$inlinecount String Only usable when the result is a list. Set to "allpages" if you want size of the result list to be returned. Accepted values are: "allpages", "none"
$top String Only usable when the result is a list. Set the number of objects to return in result list. Maximum limit is specific for each resource, but is default 80.
$skip Integer Only usable when the result is a list. Set the number of objects to skip in the result list.
$filter String Only usable when the result is a list. Use to filter the result list, see the Filter and OrderBy page for more information about this.
$orderby String Only usable when the result is a list. Use to order the result list, see Filter and OrderBy page for more information about this.
$access_token String You receive a new access token after a successful login. Unless you are using the C# SDK, you need to provide this query parameter for all requests you are doing. Without this, the request will fail because the request is unauthorized. All access tokens are time limited.
$db String Set the database to use for the request
$format String Set the format of the response to use for the request. Accepted values are "xml", "json"
$select String Use to define the fields to return in the result. Accepts a comma-separated list of Output Field names. See the Expand and Select page for more information about this.
$expand String Use to expand Output fields that are not shown by default in the output result. Possible Expandable fields are listed in the Output tab for the resource. Accepts a comma-separated list of expandable Output Field names. See the Expand and Select page for more information about this.
$lang String Use to get localized responses. Supported formats are 3-letter ISO-639-1 [lll], 2-letter ISO-639-2 [ll], or a combination of a two-letter language code and a two-letter country code ISO-639-2 and ISO-3166-1 [ll_CC], [ll-CC]
$useMinimumVersion Integer This can be used to test a new version of a resource when your ApiClient is running an older, deprecated, version of a resource. $useminimumversion can be used to test against a newer version of the resource. See the Deprecated APIs page for more information about this.
$showDomainDescriptions Boolean Use to show an additional descriptional field for fields that are using Domain Values.

2. Examples

To get the response in Json, we can set the $format query parameter to json:

http://api.rambase.net/sales/customers?$format=json

To get the number of result items in the response, we can set the $inlinecount query parameter to allpages:

http://api.rambase.net/sales/customers?$inlinecount=allpages

We can easily combine multiple query parameters by inserting an ampersand (&) between each one:

http://api.rambase.net/sales/customers?$format=json&$inlinecount=allpages