From NSDLWiki

Return to NDR/API 2.0 Requests By Object

Contents [hide] 1 NDR API Implementation Details - listMetadataRecords 1.1 Discussions 1.1.1 Input Discussions 1.1.2 Output Discussions 1.1.3 Processing Discussions 1.1.4 General Discussions 1.2 Implementation 1.3 Links 1.3.1 API Links: 1.3.2 Additional Links Related to This Call:

Under Construction
Proposed method for inclusion in NDR/API 2.0.

NDR API Implementation Details - listMetadataRecords

List metadata records controlled by an application optionally limiting to a specified Collection.

Discussions

Input Discussions

• <optional> handle (Collection Aggregator)
• <optional> XMLFormat (id of format of XML - requires registration in advance)

OR

• <optional> Resumption Token URI (similar to OAI)

Output Discussions

• returns all metadata (in pages) for this application (determined by signing agent)
• if resumption token is passed in, then next pages of results is returned

Processing Discussions

Pagination -- Should the entire list be built at the time of the initial request? In this case, the request would be cached and pages drawn from the cache. OR each page of results is created on the fly with an order of results enforced by something like date.

General Discussions

Implementation

Developer: TBA

Basic description of the process...

• TBA

Links

API Links:

• Conceptual Framework (2.0 philosophy)
• APIBasics
• ObjectTypes
• Encoding
• APIRequestsByObject v1.0
• APIRequestsAlphabetical v1.0
• APIRequestsByObject v2.0

Additional Links Related to This Call:

• NDR-API 2.0 Features List
• Implementation Details for Metadata Record Objects
• Specification for listMetadataRecords