Descriptors in the Ed-Fi Data Standard are a set of mechanisms to support flexible enumerations or code tables. Each Descriptor has the following attributes:
The GET of a resource must return the namespace and codeValue for Descriptor enumerations. Other components of the Descriptor can be retrieved from the Descriptor resource.
The PUT or POST of a resource must specify the namespace and codeValue for each Descriptor value.
Descriptors are also exposed as Resources of an Ed-Fi REST API and can be accessed and manipulated as follows:
Table 3. Accessing and Manipulating Descriptors
Adds a new Descriptor
References to a Descriptor value are a URI constructed with the namespace followed by the URL-encoded codeValue:
For example, to refer to the behaviorDescriptor value in the Ed-Fi namespace with a codeValue of “School Violation,” the reference would be the following URI:
Implementations may provide a default namespace that allows client systems to provide codeValues without the namespace prefix.
7 Where [abc] is the name of a specific Descriptor.
Find out more about the Ed-Fi REST API:
Powered by a free Atlassian Confluence Community License granted to Ed-Fi Alliance. Evaluate Confluence today.