3.12 SData Category Scheme
The SData category scheme is identified by the following URL:
http://schemas.sage.com/sdata/categories
The categories defined by this scheme classify feeds and entries according to their role in the SData protocol. The following table lists valid terms for this scheme:
| Term | Description | Valid on |
|---|---|---|
| provider | An SData provider | Feed returned by a query on the top URL of a provider. (http://www.example.com/sdata) |
| application | An SData application | Entries returned by a query on the top URL of a provider. (http://www.example.com/sdata) Feed returned by a query on an application URL. (http://www.example.com/sdata/myApp) |
| contract | An SData contract | Entries returned by a query on an application URL. (http://www.example.com/sdata/myApp) Feed returned by a query on a contract URL. (http://www.example.com/sdata/myApp/myContract) |
| dataset | An SData dataset | Entries returned by a query on a contract URL. (http://www.example.com/sdata/myApp/myContract) Feed returned by a query on a data set URL. (http://www.example.com/sdata/myApp/myContract/prod) |
| group | A functional group | Entries returned by a query on a data set URL or a functional group one step higher in the hierarchy. (http://www.example.com/sdata/sageErp/native/prod) Feed returned by a query on a functional group URL. (http://www.example.com/sdata/sageErp/native/prod/manufacturing) |
| collection | Collection of resources | Entries returned by a query on a contract URL or a functional group URL. (http://www.example.com/sdata/myApp/myContract/prod) Feed returned by a query on a collection ([resource kind](1.1 Terminology "1.1 Terminology")) URL. (http://www.example.com/sdata/myApp/myContract/prod/salesOrders) |
| resource | A single resource | Entries returned by a query on a resource kind URL. (http://www.example.com/sdata/myApp/myContract/prod/salesOrders) Entry returned by a query on a resource URL. (http://www.example.com/sdata/myApp/myContract/prod/salesOrders('S0001')) |
| service | A service (collection of service operations) | Feed returned by a query on a $service URL. (http://www.example.com/sdata/myApp/myContract/prod/salesOrders/$service) |
| operation | A service operation | Entry returned by a query on a $service URL. (http://www.example.com/sdata/myApp/myContract/prod/salesOrders/$service) |
| queries | A collection of named queries | Feed returned by a query on a $queries URL. (http://www.example.com/sdata/myApp/myContract/prod/salesOrders/$queries) |
| query | An individual named query | Entry returned by a query on a $queries URL. (http://www.example.com/sdata/myApp/myContract/prod/salesOrders/$queries) |
| request | A request on a service operation | Entry posted to a service operation or to a named query URL. (http://www.example.com/sdata/myApp/myContract/prod/salesOrders/$service/computePrices) |
| response | A response from a service operation | Entry returned by a service operation or feed returned by a named query URL. (http://www.example.com/sdata/myApp/myContract/prod/salesOrders/$service/computePrices) |
| schema | A schema | Reserved for future use. Unused for now because schemas are returned directly as an XML Scheme Definition (XSD). The raw XML data is unpackaged or supplied without a feed entry. |
SData providers SHOULD tag the feeds and entries that they return with the appropriate category from the list above.
SData consumers MAY tag the feeds and entries that they PUT or POST to the provider with the appropriate category. If a category is omitted, the provider infers a category from the URL, according to the table above (collection, resource or request).
Appendix D describes this scheme as an Atom Category Document.