Parameters

The following parameters are defined in the DD-ECO-API.

Parameter	Purpose	Required	Default	Remarks
page	Define the page number to retrieve	Yes	1	Minimum page size is 1
pagesize	Define the page size (number of ‘records’) to retrieve	Yes	Provider specified	Cannot be less than 1
filter	Specifies the filter for filtering the data	No
nocount	Specifies if totalObjectCount should be calculated and provided	No	False	Boolean value: True or False
skipproperties	Specifies fields to exclude from the results response	No		List of strings
shape	Specifies fields to include in the results response	No		List of strings
sort	Specifies the sort order and sort direction of the response	No		List of fields with direction

page

See Pagination.

pagesize

See Pagination.

filter

See Filtering.

nocount

Note: implementing sorting is optional. The nocount parameter accepts a boolean (true or false) and controls whether not not the totalobjectcount property in the paging block will be present. This parameter can be useful to improve on performance, since the server does not need to query the whole data set. This parameter is optional and the default behavior is to include the totalobjectcount property, so the default value is true.

skipproperties

Note: implementing sorting is optional. The skipproperties parameter provides a mechanism to exclude the specified fields from the results.. Example: &skipproperties=id,changedate

This would remove the fields id and changedate from the response. The consumer cannot define the order of the fields. This is up to the server.

shape

Note: implementing shape is optional. The shape parameter provides a mechanism to define what fields the response consists of. When the consumer specified a field that the provider doesn’t know, it must be supplied by the provider with a null value. The consumer cannot define the order of the fields. This is up to the server.

Example:

shape=id,code,name,unknown

sort

Note: implementing sorting is optional. The sort parameter defines the sort order of the results. It comprises of a list of field name and sort direction. Possible values of the sort direction is ASC (for ascending) and DESC (for descending).