Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This document describes the various categories of the API endpoints and provides a workflow sequence for how these endpoints are typically used within the EPR Partner API. Each category is broken down into specific processes or actions.

Table of Contents
minLevel1
maxLevel2
outlinefalse
stylenone
typelist
printabletrue

Authentication

Authentication endpoints secure a token necessary for authorizing subsequent API calls. Refer to Authentication and Partner Configuration for proper steps for authentication to EPR.

...

  1. Retrieve Configuration Data:

    • Fetch list types and corresponding list items to populate fields like contactType.

  2. Document Upload:

    • Obtain a pre-signed URL for the document.

    • Upload the document to S3 using the pre-signed URL.

    • Confirm the upload using the POST /partner/uploadDocument endpoint.

  3. Attachment Upload:

    • Obtain a pre-signed URL for the attachment.

    • Upload the attachment to S3 using the pre-signed URL.

    • Confirm the upload using the POST /partner/projectAttachments endpoint.

Step 6: Document Intake, Document Versioning and Assignment Management

MVP Scope:

Document intake, document versioning, and assignment management are critical processes that the end user will handle manually during the MVP phase. This approach ensures the essential functionality is validated and approved before automating these processes.

...

Document Management

Performing Intake

Step 7: Deliverables

This section explains how to handle deliverables within the EPR system during the MVP phase. Deliverables typically include documents, attachments, and comment reports. Users can retrieve these items individually or as a ZIP package.

...