The Requirements Class "Profile query parameter" specifies additional provisions for properties that reference another resource.
Some properties may be represented in multiple representations in the same format, depending on the intended use of the data.
RFC 6906 The 'profile' Link Relation Type defines the concept of a profile to support such use cases.
A profile is defined not to alter the semantics of the resource representation itself, but to allow clients to learn about additional semantics (constraints, conventions, extensions) that are associated with the resource representation, in addition to those defined by the media type and possibly other mechanisms.
To request one or more profiles, a query parameter "profile" can be used:
Determining the profile(s) of the response is part of the content negotiation process after the proactive content negotiation as specified by the HTTP RFC has been completed. The server determines the applicable profile(s) for the selected media type.
Different media types have different characteristics. A consequence is that it can be impossible to support a profile for a media type or it can be against the design goals of a media type to support a profile.
The server will select the profile(s) of the response, if any, from the list of profiles supported for the media type and resource.
|
Note
|
A set of profile URIs for content defined in this Standard can be found in the Profile identifiers table. |