Skip to content

Updates to reflect latest changes to API #488

@malikkotob

Description

@malikkotob

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions