Community:NDR/describe

From NSDLWiki

describe

Provides information about an NDR object.

This request is currently under development, and is subject to change at any time. It is not considered one of the core NDR API methods. If possible, use get instead

Request URL

http://ndr.nsdl.org/describe/[handle]

where [handle] is a handle for an NDR object.

May be an HTTP GET or POST request.

Arguments

(the Handle is at the end of the requestURL)

Response Fields

handle the NDR handle for the object.

properties these include:
- label - Contains the name of the type of object (e.g. Resource, Metadata)
- createdDate - the date the object was created, in UTC (GMT).
- lastModifiedDate - the date the object last modified, in UTC (GMT).
- state - the state of the object, per Fedora: Active or Deleted

relationships all the relationships this object participates in. Each relationship has:
- type - indicates the type of relationship (e.g. "memberOf", "metadataFor")
- target - an identifier for the thing this object relates TO. If the relationship is between two NDR objects, this identifier will be an NDR handle. If it is a relationship between the object and a resource URL, then this identifier will be a URL. If the relationship describes the objectType, then this identifier will be an object type (e.g. "Resource" or "Metadata"). It could also be a handle for the "hasHandle" relationship, an OAI id for the "itemId" relationship, etc.
- url (Optional) - if the identifier is an NDR handle, then this is the URL for a "describe" request of that NDR object.

Types of relationships (not an exhaustive list):

- objectType - this relationship's target is one of the NDR object types "Resource", "Metadata," etc. (see ObjectTypes)
- itemId - the target is the OAI identifier for this object, to be used in OAI views of the NDR.
- hasHandle - Resource and Agent objects may have handles; the target is the handle for the object.
- hasResourceURL - Resource objects have a normalized URL, which is the target of this relationship.
- uniqueId - Metadata objects have a unique identifier for the contained metadata, which is supplied by their metadataProvider.
- setSpec - the OAI setSpec for an aggregation's exposure as an OAI set. (see http://www.openarchives.org/OAI/openarchivesprotocol.html#Set)
- setSpecName - a short, human-readable name for the OAI set.

- memberOf - this object is a member of an aggregation; the target is the handle for the Aggregator object.
- hasMetadata - the target object contains metadata describing this object (or what this object represents in the NDR, such as a resource)
- metadataFor - this object contains metadata describing the target object (or what the target object represents in the NDR, such as a resource).
- metadataProvidedBy - target MetadataProvider object provided the metadata in this object.
- metadataProviderFor - target Agent object is the attributable source for any metadata provided by this object.
- aggregatedBy - target is the Aggregator object describing the aggregation relevant to this object.
- aggregatorFor - target is the Agent object attributable for any aggregation provided by this object.
- representedBy - target is the Resource object that will represent an actual aggregation (grouping) of objects.
- hasAggregator - target is an Aggregator object representing an aggregation attributable to this (Agent) object.
- hasMetadataProvider - - target is a MetadataProvider object representing provided metadata attributable to this (Agent) object.

data information about the data stored with this object. In Fedora parlance, these are the datastreams. Each data item has:
- id - Datastream identifier
- url - URL for the datastream contents. Points to a get request that fetches datastream content

Types of datastreams (not an exhaustive list):

- content - Contains the digital content of a Resource. Examples of resource content may include HTML web pages, PDF documents, XML files, images, and videos.
- serviceDescription - Aggregator and MetadataProvider objects require information to be associated with the service, such as dublin core metadata, contact imformation, branding, etc.
- format_xyz - Contains metadata in a given format 'xyz'. Examples of formats include nsdl_dc and oai_dc.
- format_zyz_info, Information about metadata in format xyz. Is used internally to create the OAI "about".
- metadata Not a true datastream, it represents individual units of metadata that describe a given object. For example, if executing a describe request on a resource, the metadata items refer to the content of each Metadata object that is metadataFor that resource.

Response Examples

for a Resource object: http://repository.nsdl.org/describe/ 2200/20060614134957422T (see also below)

for a Metadata object: http://repository.nsdl.org/describe/2200/20060614134958749T

for a MetadataProvider object: http://repository.nsdl.org/describe/2200/20060614134959193T

for an Aggregator object: http://repository.nsdl.org/describe/2200/20060614134958039T

for an Agent object: http://repository.nsdl.org/describe/2200/20060614134957733T

response for a describe request for a Resource object

<?xml version="1.0" encoding="UTF-8"?>

<NSDLRepository schemaVersion="1.00.000"

xmlns="http://ns.nsdl.org/schemas/api/resultsXML_v1.00/"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xsi:schemaLocation="http://ns.nsdl.org/schemas/api/resultsXML_v1.00/ http://ns.nsdl.org/schemas/api/resultsXML_v1.00.xsd">

<request>/repository/api/describe/2200/20060614134957422T</request>

<label>Resource</label>

<state>Active</state>

</properties>::::

<type>objectType</type>

<target>Resource</target>

</relationship>

<type>hasHandle</type>

<url>

http://repo4.nsdl.org:8380/repository/api/describe/2200/20060614134957422T

</url>

</relationship>

<type>memberOf</type>

<target>2200/NSDL_Collection_of_Resources</target>

<url>

http://repo4.nsdl.org:8380/repository/api/describe/2200/NSDL_Collection_of_Resources

</url>

</relationship>

<type>memberOf</type>

<target>2200/NSDL_Collection_of_Resources</target>

<url>

http://repo4.nsdl.org:8380/repository/api/describe/2200/NSDL_Collection_of_Resources

</url>

</relationship>

<type>hasResourceURL</type>

<target>http://mtn.merit.edu/</target>

</relationship>

<type>hasMetadata</type>

<url>

http://repo4.nsdl.org:8380/repository/api/describe/2200/20060614134958749T

</url>

</relationship>:

<type>hasRepresentation</type>

<url>

http://repo4.nsdl.org:8380/repository/api/describe/2200/20060614134958039T

</url>

</relationship>:

</relationships>:::::

<data>

<id>content_1</id>

<url>http://repo4.nsdl.org:8880/fedora/get/hdl:2200%2F20060614134957422T/content_1</url>

</content>

<nsdl_dc:nsdl_dc xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:dct="http://purl.org/dc/terms/" xmlns:ieee="http://www.ieee.org/xsd/LOMv1p0" xmlns:nsdl_dc="http://ns.nsdl.org/nsdl_dc_v1.02/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" schemaVersion="1.02.000" xsi:schemaLocation="http://ns.nsdl.org/nsdl_dc_v1.02/ http://ns.nsdl.org/schemas/nsdl_dc/nsdl_dc_v1.02.xsd">

<dc:title>Michigan Teacher Network</dc:title>

<dc:subject>Technology--Study and teaching</dc:subject>

<dc:subject>Mathematics--Study and teaching</dc:subject>

<dc:subject>Michigan; schools; teacher; educational technology; clearinghouse; curriculum; classroom; lesson plans; pedagogy; k-12; best practices; reviews; learning; teaching; professional development; Michigan Curriculum Framework; standards; technology plan; computers; education index</dc:subject>

<dc:subject>Science--Study and teaching</dc:subject>

<dc:subject xsi:type="dct:LCSH">Educational technology</dc:subject>

<dc:subject xsi:type="dct:LCSH">Curriculum planning</dc:subject>

<dc:subject xsi:type="dct:LCSH">Curriculum</dc:subject>

<dc:subject xsi:type="nsdl_dc:GEM">Instructional issues</dc:subject>

<dc:description>Michigan Teacher Network supports Michigan K-12 educators in the successful use of technology by providing best practice, professional development, and evaluated curriculum resources. Curriculum materials are correlated to Michigan Curriculum Framework content standards.</dc:description>

<dc:publisher>Merit Network Inc.</dc:publisher>

<dc:contributor>Center to Support Technology in Education; Kate Pittsley; Ellen Hoffman; Betty Van Dam</dc:contributor>

<dc:type xsi:type="dct:DCMIType">Collection</dc:type>

<dc:format xsi:type="dct:IMT">text/html</dc:format>

<dc:format xsi:type="dct:IMT">image</dc:format>

<dc:identifier xsi:type="dct:URI">http://mtn.merit.edu</dc:identifier>

<dc:language xsi:type="dct:RFC3066">en</dc:language>

<dct:spatial>Michigan</dct:spatial>

<dct:audience>Teachers</dct:audience>

<dct:mediator>Teachers</dct:mediator>

<dct:educationLevel xsi:type="nsdl_dc:NSDLEdLevel">Grades Pre-K to 12</dct:educationLevel>

</nsdl_dc:nsdl_dc>:::</record>

</metadata>::::::

</data>

</descriptiveXML>

</NSDLRepository>

Community:NDR/describe

From NSDLWiki

Contents

describe

Request URL

Arguments

Response Fields

Response Examples

API Links:

Views

Personal tools

Navigation

Wiki Search

Toolbox