Disclosure API: Response - Retrieve a Discloser's response

This article is for an API Partner wanting to retrieve partner organization response information.

Contents

• Summary

• GET Request

  • URLs

  • Headers/Variables

  • Body

  • Response

    • Top Level: Response (n)

    • Second Level: Rows (n+1)

    • Second Level: Attachments (n+1)

    • Second Level: Response Version (n+1)

    • JSON Response Example

• Error Handling

• POST/PUT Requests

Summary

When interacting with a Discloser’s response data you can call two methods GET and PUT. This article covers the GET request, which allows you to retrieve the existing answer-values in an individual response. A GET request can be sent after a PUT request to verify the update to the data.

Pre-requisites: Valid subscription key and organization UUID for the respective Disclosure API environment.

Note - Data Sync: To ensure you are seeing the latest answer-values within a Discloser’s questionnaire-response then this data should be refreshed when updates are made to the response, either via the API or within the Portal directly.

Note - Hidden Questions: When a value is updated into a question which has been hidden by show/hide conditional logic, the value is stored regardless. Should the question become visible again (if the answer to a lead question changes), the previously hidden value would be included in the submission. You can see this using the “status” field.

Note - Different States: It is possible to GET when the response workflow is in an “In Progress”, “Submitted” or “Amendments” state.

GET Request

The GET request details how to send the request to the response/response endpoint and the response that is returned when a successful request is sent.

URLs

Sandbox: https://api-pre.cdpgreenstar.net/asp/response/response

Production: https://api.cdp.net/response/response

Headers/Variables

subscription-key (header): For authorized user, the primary/secondary subscription key.

organization-id (optional header): Enter the UUID for the organization’s response.

Body

NULL

Response

Top Level: Response (n)

Answer-value data for the specified organizations response.

Field table
 

Note: The “status” field is the current state of the question in the portal. These are for display purposes only; the Discloser should ensure their response is filled out correctly prior to final submission.

1. "UNANSWERED"– The question has not been answered.

2. "ANSWERED"– The question is answered or has been marked by the user as answered.

3. "SKIPPED"– The question is marked as skipped by the user. No content has been filled.

4. "REVIEWED"– The question has been marked as reviewed by the Submission Lead.

5. "CONDITIONAL" – The question is currently locked/hidden in the CDP Portal by conditional logic.