Restriction on output properties

Restriction parameter: format

Definition

Impose the API output format

This parameter allows you to explicitly specify the format of the NA-ARC web API output. It can take as parameter one of the following: json, matlab, csv, kml, csh.

NOTE: Available output formats depend on the service and function used in the query.

Examples

The following example output the number of profiles as a Matlab format:

?get=np&format=matlab

Restriction parameter: limit

Definition

Limit the NA-ARC web API results to those that fall within a specified range.

This parameter allows you to limit the number of outputs or select the position of the output pointer. This restriction takes as a parameter one or two numerical (integer) values:

  • Specification 1: Limit the number of outputs: The number of outputs n_results must be positive and an integer. This specification output the first n_results.
  • Specification 2: Specify the range of results among the entire output of profiles: The number of outputs n_results must be positive and an integer. The first record to count n_results from is specified with the starting_from parameter. The first record of the output has number the 1.

Examples

The following example restricts the output to the first five records:

?get=coord&limit=5

And the following example restricts the output to records number 5 to 15 (10 records):

?get=coord&limit=10,5

You can verify that the last record of the first example corresponds to the first record of the second example.