{ "opencollection": "1.0.0", "info": { "name": "eCFR API Documentation Admin Service Versioner Service API" }, "items": [ { "info": { "name": "Versioner Service", "type": "folder" }, "items": [ { "info": { "name": "Ancestors route returns all ancestors (including self) from a given level through the top title node.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/versioner/v1/ancestry/:date/title-:title.json", "params": [ { "name": "date", "value": "", "type": "path", "description": "YYYY-MM-DD" }, { "name": "title", "value": "", "type": "path", "description": "Title Number: '1', '2', '50', etc" }, { "name": "subtitle", "value": "", "type": "query", "description": "Uppercase letter. 'A', 'B', 'C'" }, { "name": "chapter", "value": "", "type": "query", "description": "Roman Numerals and digits 0-9. 'I', 'X', '1'" }, { "name": "subchapter", "value": "", "type": "query", "description": "A SUBCHAPTER REQUIRES A CHAPTER. Uppercase letters with optional underscore or dash. 'A', 'B', 'I'" }, { "name": "part", "value": "", "type": "query", "description": "Uppercase letters with optional underscore or dash. 'A', 'B', 'I'" }, { "name": "subpart", "value": "", "type": "query", "description": "A SUBPART REQUIRES A PART. Generally an uppercase letter. 'A', 'B', 'C'" }, { "name": "section", "value": "", "type": "query", "description": "A SECTION REQUIRES A PART. Generally a number followed by a dot and another number. '121.1', '13.4', '1.9'" }, { "name": "appendix", "value": "", "type": "query", "description": "AN APPENDIX REQUIRES A SUBTITLE, CHAPTER or PART. Multiple formats. 'A', 'III', 'App. A'" } ] }, "docs": "The Ancestry service can be used to determine the complete ancestry to a leaf node at a specific point in time.\n### Example\nThe complete hierarchy for **2 CFR 1532.137** is\n```\nTitle 2\n Subtitle B\n Chapter XV\n Part 1532\n Subpart A\n Section 1532.137\n```\nTo retrieve this complete hierarchy you can use the ancestry endpoint and provide a Title, Part and Section (you can provide additional layers of the hierarchy) to retrieve a full ancestry.\nSee sample json responses below." }, { "info": { "name": "Source XML for a title or subset of a title. Requests can be for entire titles or part level and below. Downloadable XML document is returned for title requests. Processed XML is returned if part, subpart, section, or appendix is requested.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/versioner/v1/full/:date/title-:title.xml", "params": [ { "name": "date", "value": "", "type": "path", "description": "YYYY-MM-DD" }, { "name": "title", "value": "", "type": "path", "description": "Title Number: '1', '2', '50', etc" }, { "name": "subtitle", "value": "", "type": "query", "description": "Uppercase letter. 'A', 'B', 'C'" }, { "name": "chapter", "value": "", "type": "query", "description": "Roman Numerals and digits 0-9. 'I', 'X', '1'" }, { "name": "subchapter", "value": "", "type": "query", "description": "A SUBCHAPTER REQUIRES A CHAPTER. Uppercase letters with optional underscore or dash. 'A', 'B', 'I'" }, { "name": "part", "value": "", "type": "query", "description": "Uppercase letters with optional underscore or dash. 'A', 'B', 'I'" }, { "name": "subpart", "value": "", "type": "query", "description": "A SUBPART REQUIRES A PART. Generally an uppercase letter. 'A', 'B', 'C'" }, { "name": "section", "value": "", "type": "query", "description": "A SECTION REQUIRES A PART. Generally a number followed by a dot and another number. '121.1', '13.4', '1.9'" }, { "name": "appendix", "value": "", "type": "query", "description": "AN APPENDIX REQUIRES A SUBTITLE, CHAPTER or PART. Multiple formats. 'A', 'III', 'App. A'" } ] }, "docs": "The title source route can be used to retrieve the source xml for a complete title or subset. The subset of xml is determined by the lowest leaf node given. For example, if you request Title 1, Chapter I, Part 1, you'll receive the XML only for Part 1 and its children.\nIf you request a section you'll receive the section XML inside its parent Part as well as relevant non-section sibling nodes (Auth, Source, etc).\nThe largest title source xml files can be dozens of megabytes.\n\n[GPO eCFR XML User g" }, { "info": { "name": "Structure JSON for a title", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/versioner/v1/structure/:date/title-:title.json", "params": [ { "name": "date", "value": "", "type": "path", "description": "YYYY-MM-DD" }, { "name": "title", "value": "", "type": "path", "description": "Title Number: '1', '2', '50', etc" } ] }, "docs": "The structure JSON endpoint returns the complete structure of a title back as json. This format does not include the content of the title but does include all structure and content nodes as well as their meta data including their type, label, description, identifier and children." }, { "info": { "name": "Summary information about each title", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/versioner/v1/titles.json" }, "docs": "The Title service can be used to determine the status of each individual title and of the overall status of title imports and reprocessings. It returns an array of all titles containing a hash for each with the name of the title, the latest amended date, latest issue date, up-to-date date, reserved status, and if applicable, processing in progress status. The meta data returned indicates the latest issue date and whether titles are currently being reprocessed." }, { "info": { "name": "Returns an array of all sections and appendices inside a title.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/versioner/v1/versions/title-:title.json", "params": [ { "name": "title", "value": "", "type": "path", "description": "Title Number: '1', '2', '50', etc" }, { "name": "issue_date[on]", "value": "", "type": "query", "description": "One issue date is required. Select content added on the supplied issue date" }, { "name": "issue_date[lte]", "value": "", "type": "query", "description": "One issue date is required. Select content added on or before the supplied issue date" }, { "name": "issue_date[gte]", "value": "", "type": "query", "description": "One issue date is required. Select content added on or after the supplied issue date" }, { "name": "page", "value": "", "type": "query", "description": "Page number for paginated content version responses. Upto 1000 results are returned at a time." }, { "name": "subtitle", "value": "", "type": "query", "description": "Uppercase letter. 'A', 'B', 'C'" }, { "name": "chapter", "value": "", "type": "query", "description": "Roman Numerals and digits 0-9. 'I', 'X', '1'" }, { "name": "subchapter", "value": "", "type": "query", "description": "A SUBCHAPTER REQUIRES A CHAPTER. Uppercase letters with optional underscore or dash. 'A', 'B', 'I'" }, { "name": "part", "value": "", "type": "query", "description": "Uppercase letters with optional underscore or dash. 'A', 'B', 'I'" }, { "name": "subpart", "value": "", "type": "query", "description": "A SUBPART REQUIRES A PART. Generally an uppercase letter. 'A', 'B', 'C'" }, { "name": "section", "value": "", "type": "query", "description": "A SECTION REQUIRES A PART. Generally a number followed by a dot and another number. '121.1', '13.4', '1.9'" }, { "name": "appendix", "value": "", "type": "query", "description": "AN APPENDIX REQUIRES A SUBTITLE, CHAPTER or PART. Multiple formats. 'A', 'III', 'App. A'" } ] }, "docs": "Returns the content versions meeting the specified criteria. Each content object includes its identifier, parent hierarchy, last amendment date and issue date it was last updated. Queries return content versions `on` an issue date, or before or on a specific issue date `lte` or on or after `gte` a specific issue date. At least one issue date parameter must be provided. The `gte` and `lte` parameters may be combined. Use of the `on` parameter precludes use of `gte` or `lte`. Responses are paginat" } ] } ], "bundled": true }