Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates to reflect latest changes to API #488

Open
5 tasks
malikkotob opened this issue Jan 5, 2018 · 0 comments
Open
5 tasks

Updates to reflect latest changes to API #488

malikkotob opened this issue Jan 5, 2018 · 0 comments

Comments

@malikkotob
Copy link

malikkotob commented Jan 5, 2018

As an agency, in order to receive FOIA requests via API, I need updates made to reflect the latest changes to the API.

Acceptance criteria

  • A confirmation_id field is added (this corresponds to the ID returned to the requester when submitting a FOIA request)
  • A removed_files field is added
  • The "Sample Payload" is updated to include these fields
  • The "Sample Request" is updated to include these fields
  • The wording on the confirmation page a requester receives upon submission is updated such that "submission ID" is "confirmation ID"

Implementation details

Confirmation ID

Field: confirmation_id
Type: integer
Description: The unique confirmation ID sent to the requester upon successful submission of a FOIA request.
Required: yes
Example: 3123

Removed Files

Field: removed_files
Type: array
Description: Documents or attachments provided by the requester that were stripped from the request after being flagged as having a virus.
Required: no
Example: ["file-with-virus-1.txt","file-with-virus-2.txt"]

Current Confirmation Page

image

@malikkotob malikkotob added drupal and removed drupal labels Jan 5, 2018
@malikkotob malikkotob changed the title Update Agency API spec to reflect latest changes to API Updates to reflect latest changes to API Jan 8, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant