Skip to content.
About GPO   |   Newsroom/Media   |   Congressional Relations   |   Inspector General   |   Careers   |   Contact   |   askGPO  

 
Find Government publications with GPO's Federal Digital System

Home > FDsys API Reference

FDsys API Reference


The FDsys API provides services for developers and webmasters to access content and metadata on FDsys. Current and planned services include a link service, list service, and search service. Please contact askGPO for additional information about current or planned services.


Services:

Link Service

The link service is used to create embedded links to content and metadata on FDsys and is currently enabled for the collections below. The collection code is listed in parenthesis after each collection name, and the available queries are listed below each collection. More information about each query is provided on the individual collection page.



List Service

Coming soon!
This service will provide the capability for developers to create lists of references to documents in FDsys that match a specified query against metadata.


Search Service

Coming soon!
This service will provide the capability for developers to retrieve metadata for documents in FDsys that match a specified query against metadata.


Common Errors:

Multiple Results Found

This error occurs when more than one document matches parameters for a given request. Additional parameters must be specified in order to return a single document.

No Results Found

This error occurs if a match document was not found for the given parameters. Please check the API documentation to make sure values provided are correct.

Validation Failed

This error occurs when request parameters fail validation. Possible causes include the following:
  • No queries found for COLLECTION CODE.
    This error occurs if the value for collection is incorrect or has not been enabled yet. Please check the documentation for available collections and collection codes.
  • Request parameter XXXX is not found but is required.
    This error occurs if a required parameter is missing in the URL. Please check the documentation for required parameters for each collection.
  • The value provided for XXXX is invalid. One of the following [XXXX, YYYY] is expected.
    This error occurs if a value provided for a parameter is not among the listed choices. Please check the documentation for parameter values.

Content File Not Found

This error can occur for an invalid or unavailable link-type value. Allowable values are pdf, html, mods, premis and contentdetail. This error can also occur if a requested link-type is not available for a specific document.

System Error

Please contact askGPO to report any system errors encountered while using the FDsys API.