...
The goal of this document is to give an overview of API interactions that occur when a SafePaths mobile user uploads their data to the SafePlaces API within the context of a contact tracing interview.
Flow Overview
Case and Access Code Creation
Contact tracer creates a new case within the SafePaths web UI. After successful creation of a case the web UI makes another call to create an access code that will be displayed to the contact tracer and verbally communicated via phone to the intervieweethe new case has been created a new AccessCode record will be created and associated with the case. The accessCode value will be returned in the response payload of the create case endpoint. See this document (https://pathcheck.atlassian.net/wiki/spaces/SA/pages/81134291/SPL+Token+Exchange#Access-Code-Exchange ) for information on creating access tokens.
Endpoint:
POST /case/{caseId}/access-codeorganization/case(https://pathcheck.atlassian.net/wiki/spaces/SA/pages/73924822/SPL+API+Specification+v1+For+MVP1#POSTMVP1#confirmed%3A--%2Fcase%2F%7BcaseId%7D%2FaccessPOST-code%2Forganization%2Fcase )
Access Code Validation
The user will input the accessCode into the SafePaths app. An API request will be made to this endpoint. The endpoint returns a boolean indicating whether or not the accessCode exists and is valid.
...