Skip to content

Commit 68d3c2e

Browse files
gbinalgbinal
authored
Merge pull request #1525 from erulemaking/apidocs-regulationsgov-20250925
Removed POST API language
2 parents 0609ea3 + 422f264 commit 68d3c2e

File tree

2 files changed

+2
-361
lines changed

2 files changed

+2
-361
lines changed

‎_apidocs/regulationsgov.md‎

Lines changed: 2 additions & 209 deletions
Original file line numberDiff line numberDiff line change
@@ -89,8 +89,6 @@ If you want to use commenting API, you MUST use the form below to register for a
8989
<noscript>Please enable JavaScript to signup for an <a href="http://api.data.gov/">api.data.gov</a> API key.</noscript>
9090
{% endraw %}
9191

92-
Comment posting capability of API key is available to authorized federal government entities only.
93-
9492
After registration, you will need to provide this API key in the `X-Api-Key` HTTP header with every API request.
9593

9694
| HTTP Header Name | Description |
@@ -99,27 +97,9 @@ After registration, you will need to provide this API key in the `X-Api-Key` HTT
9997

10098
<p><small><a href="#">Back to top</a></small></p>
10199

102-
## Terms of Participation
103-
104-
The eRulemaking post Application Programming Interface (API), informally referred to as the Comment API, is provided as a convenience to facilitate the bulk upload of comments from a number of different commenters. The use of the Comment API requires a key, which may be obtained through the [open GSA](https://open.gsa.gov/api/regulationsgov/#getting-started) website.
105-
106-
By registering for, receiving and using a key to the Comment API, the key holder agrees to the following terms and conditions:
107-
108-
1. When developing interfaces for commenters who will submit comment language and/or attachments through the Comment API, the key holder will include in the interface:
109-
1. A link to the same [terms of participation](https://www.regulations.gov/user-notice) and [privacy notice](https://www.regulations.gov/privacy-notice) that users encounter on the comment form for Regulations.gov, and
110-
2. A link to the Federal Register notice or other specific document in Regulations.gov for which the key holder is collecting or facilitating comments to be delivered through the Comment API.
111-
112-
2. The key holder certifies that:
113-
1. I will only submit comments through the Comment API that it has gathered through lawful means and that, to the best of the key holder’s knowledge, represent comments from real persons, and
114-
2. It has not and will not submit comments of its own creation under fictitious or misappropriated identities or otherwise in violation of federal law.
115-
116-
3. The API key may be disabled if an API key holder is determined to have violated these Terms of Participation.
117-
118-
<p><small><a href="#">Back to top</a></small></p>
119-
120100
## API Description
121101

122-
Regulations.gov offers a GET API for documents, comments, and dockets and a POST API for comments. These endpoints can be used for searching document, comments and dockets, and posting a comment.
102+
Regulations.gov offers a GET API for documents, comments, and dockets. These endpoints can be used for searching documents, comments, and dockets.
123103

124104
#### Searching for documents
125105

@@ -149,20 +129,6 @@ A docket is an organizational folder containing multiple documents. Dockets can
149129

150130
In order to obtain more details about a single docket, you can use the endpoint `/v4/dockets/{docketId}`. Each docket has its own set of attributes, which vary based on the Agency posting the docket. Another defining characteristic is if the docket is a Rulemaking or a Nonrulemaking Docket
151131

152-
#### Posting a comment
153-
154-
User can post a comment using the endpoint `/v4/comments`. User can post the comment using one of the following submitter types:
155-
156-
* Individual
157-
* Organization
158-
* Anonymous
159-
160-
If user would like to attach files with their submission, user can get a presigned url for the amazon s3 bucket using the endpoint `/v4/file-upload-urls`
161-
162-
A submissionKey can be retrieved using `/v4/submission-keys` endpoint.
163-
164-
submissionType should be set to API.
165-
166132
<p><small><a href="#">Back to top</a></small></p>
167133

168134
## Data Limitations
@@ -215,31 +181,6 @@ Agency configured fields can be updated by an agency at any point in time and ma
215181
* email
216182
* phone
217183
* fax
218-
219-
## Post Comment API Validation
220-
221-
#### Common Validations for all comments
222-
223-
* `commentOnDocumentId`, `comment` and `submissionType` are required fields.
224-
* If `sendEmailReceipt` is true, `email` field is required.
225-
* An emoji is not a valid character.
226-
* If a field has a maximum length requirement, the requirement is applied to both, the number of characters and the number of bytes.
227-
* `submitterType` field must be one of these allowed values: `ANONYMOUS`, `INDIVIDUAL`, `ORGANIZATION`.
228-
* `submissionType` field must be set to `API`.
229-
* Field value for `comment` must be less than or equals to 5000 characters/bytes.
230-
* Field value for `email` must be less than or equals to 100 characters/bytes.
231-
232-
#### Individual Comment Validations
233-
234-
* `firstName` and `lastName` are required fields.
235-
* Field value for `firstName` and `lastName` must be less than or equals to 25 characters/bytes.
236-
* Field value for `city`, `stateProvinceRegion`, `phone` and `country` must be less than or equals to 50 characters/bytes.
237-
* Field value for `zip` field must have less than or equals to 10 characters/bytes.
238-
239-
#### Organization Comment Validations
240-
241-
* `organization` and `organizationType` are required fields.
242-
* Field value for `organization` field must have less than or equals to 120 characters/bytes.
243184

244185
## Examples
245186

@@ -429,146 +370,6 @@ To retrieve detailed information on a docket, the following query can be used:
429370
https://api.regulations.gov/v4/dockets/EPA-HQ-OAR-2003-0129?api_key=DEMO_KEY
430371
```
431372
432-
#### Posting a comment
433-
434-
* Posting an anonymous comment without attachment:
435-
436-
```json
437-
POST https://api.regulations.gov/v4/comments {
438-
"data": {
439-
"attributes": {
440-
"commentOnDocumentId":"FDA-2009-N-0501-0012",
441-
"comment":"test comment",
442-
"submissionType":"API",
443-
"submitterType":"ANONYMOUS"
444-
},
445-
"type":"comments"
446-
}
447-
}
448-
```
449-
450-
Note: No submission key is needed for comments with no attached files.
451-
452-
* Posting a comment with attachment:
453-
454-
* Step 1: Get a submission key:
455-
456-
```json
457-
POST https://api.regulations.gov/v4/submission-keys {
458-
"data": {
459-
"type":"submission-keys"
460-
}
461-
}
462-
```
463-
464-
* Step 2: Get presigned url for each attachment:
465-
466-
```json
467-
POST https://api.regulations.gov/v4/file-upload-urls {
468-
"data": {
469-
"type":"file-upload-urls",
470-
"attributes": {
471-
"fileName":"test.jpg",
472-
"submissionKey":"kex-d31z-fe04",
473-
"contentType":"image/jpeg"
474-
}
475-
}
476-
}
477-
```
478-
479-
* Step 3: Upload binaries to presigned url
480-
481-
* Step 4: Submit your comment
482-
483-
```json
484-
POST https://api.regulations.gov/v4/comments {
485-
"data": {
486-
"attributes": {
487-
"commentOnDocumentId":"FDA-2009-N-0501-0012",
488-
"comment":"test comment",
489-
"submissionType":"API",
490-
"submissionKey":"kex-d31z-fe04",
491-
"submitterType":"ANONYMOUS",
492-
"files":[ "test.jpg" ]
493-
},
494-
"type":"comments"
495-
}
496-
}
497-
```
498-
499-
* Posting a comment with agency category:
500-
501-
* Step 1: Get agency categories for agency:
502-
503-
```
504-
https://api.regulations.gov/v4/agency-categories?filter[acronym]=FDA&api_key=DEMO_KEY
505-
```
506-
507-
* Step 2: Submit your comment with category:
508-
509-
```json
510-
POST https://api.regulations.gov/v4/comments {
511-
"data": {
512-
"attributes": {
513-
"commentOnDocumentId":"FDA-2009-N-0501-0012",
514-
"comment":"test comment",
515-
"submissionType":"API",
516-
"submitterType":"ANONYMOUS",
517-
"category":"Academia - E0007"
518-
},
519-
"type":"comments"
520-
}
521-
}
522-
```
523-
* Posting multiple submissions in a single comment:
524-
525-
To post a comment with attachment that carries 5 submissions, user should follow the following steps:
526-
527-
* Step 1: Get a submission key:
528-
529-
```json
530-
POST https://api.regulations.gov/v4/submission-keys {
531-
"data": {
532-
"type":"submission-keys"
533-
}
534-
}
535-
```
536-
537-
* Step 2: Get presigned url for the attachment with multiple submissions:
538-
539-
```json
540-
POST https://api.regulations.gov/v4/file-upload-urls {
541-
"data": {
542-
"type":"file-upload-urls",
543-
"attributes": {
544-
"fileName":"multipleSubmissions.pdf",
545-
"submissionKey":"kex-d31z-fe04",
546-
"contentType":"image/jpeg"
547-
}
548-
}
549-
}
550-
```
551-
552-
* Step 3: Upload binaries to presigned url
553-
554-
* Step 4: Submit your comment with
555-
556-
```json
557-
POST https://api.regulations.gov/v4/comments {
558-
"data": {
559-
"attributes": {
560-
"commentOnDocumentId":"FDA-2009-N-0501-0012",
561-
"comment":"test comment",
562-
"submissionType":"API",
563-
"submissionKey":"kex-d31z-fe04",
564-
"submitterType":"ANONYMOUS",
565-
"files":[ "multipleSubmissions.pdf" ],
566-
"numItemsReceived": 5
567-
},
568-
"type":"comments"
569-
}
570-
}
571-
```
572373
<p><small><a href="#">Back to top</a></small></p>
573374
574375
## OpenAPI Specification File
@@ -600,14 +401,6 @@ We have added an example that shows how to retrieve more than 5000 comments on a
600401
601402
Please note the new parameter `lastModifiedDate` is in beta and may be removed when we have a permanent bulk download solution available.
602403
603-
#### I submitted a comment, but I am unable to find it on regs. What happened to my comment?
604-
605-
Comments created via API are not made available in Regulations.gov right away. Agencies need to approve before the newly created comment can be posted out to Regulations.gov.
606-
607-
#### I am seeing 400 errors from commenting API. What am I doing wrong?
608-
609-
Please make sure you are setting Content-Type to application/vnd.api+json in request header.
610-
611404
#### What is DEMO_KEY api key?
612405
613406
As indicated by name, DEMO_KEY should only be used for demonstration purposes. We have added this api_key to our examples to make it easier for users to copy/paste the urls. It should not be used for anything more than exploring our APIs.
@@ -622,7 +415,7 @@ Please review https://api.data.gov/docs/rate-limits/ for information on rate lim
622415
623416
#### Can I request rate limit increases for my keys?
624417
625-
GSA may grant a rate limit increase on the GET keys for an indefinite period. Such requests must establish the need to justify the rate limit increases. Each submission will be reviewed and considered on a case-by-case basis. GSA is unable to increase the rate limits for POST API keys upon requests at this time. However, the current POST API key holders can request one additional key without going through the validation process again.
418+
GSA may grant a rate limit increase on the GET keys for an indefinite period. Such requests must establish the need to justify the rate limit increases. Each submission will be reviewed and considered on a case-by-case basis.
626419
627420
<p><small><a href="#">Back to top</a></small></p>
628421

0 commit comments

Comments
 (0)