< 上一个 | 内容 | 下一个 >

4.7 Resource design rules

The following rules apply to the design and use of list resources:


List resources SHALL support “start” and “limit” query string parameters, thus always supporting paging.

List resources that have a time-based primary key SHALL support the “after” query string parameters.

All subordinate resources of list resources SHALL include an href attribute containing the URI of the subordinate resource.

Each list resource described in this standard includes a list ordering that defines how the list is ordered, including the details of one or more keys used to order the list and the precedence of these keys.

When queried, list resources SHALL return subordinate resources in the order defined by the list ordering.

All subordinate resources of list resources that support multiple types, for example, NotificationList, SHALL include an xsi:type attribute. In this case, the XML Schema Instance Namespace must also be declared. See Clause 16 for examples.

The following rules apply to the design and use of non-list resources:


Non-list resources SHALL NOT support the defined query string parameters. Query string parameters applied to non-list resource URIs SHOULD be ignored.