Disclosure API: Questionnaire Metadata

Views:

This article is for an API Partner to retrieve basic information about a disclosing organization's questionnaire they have permission to access.

Summary
URLs
Headers/Variables
Response
JSON Response Example

Summary

This endpoint retrieves questionnaire details for a disclosing organization.

Pre-requisites: Valid subscription key and organization Id. 

URLs

Sandbox: https://api.pre.cdpgreenstar.net/asp/response/questionnaire/metadata

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

Headers/Variables

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

organization-id (header): The UUID for the specified disclosing organization.

Response

Field table

Field	Description	Data Type
startDate	The start date for the relevant questionnaire in ISO 8601 format.	string
dueDate	The date when the questionnaire type closes in ISO 8601 format.	string
scoringDeadline	The scoring deadline organizations need to have submitted their questionnaire responses by, to receive a score.	string
isPublic	Indicates if the Discloser has set the response to be public or not at the submission stage.	boolean
submittedOn	The date when questionnaire response has been submitted to receive a score, in ISO 8601 format.	string
participationDate	Deprecated, to be removed.	string
orgDetailsDate	Deprecated, to be removed.	string
orgName	Name of the disclosing organization.	string
Status	The status of the specified organization’s questionnaire response instance.	string
tags	Not in use.	null
isOpen	Defines the status of the questionnaire.	boolean
isClosed	Deprecated, to be removed.	boolean

The status of the latest version of the specified organization's questionnaire response instance is listed below:

Status	Description
IN_PROGRESS	The questionnaire response is currently being answered.
SUBMITTED	The questionnaire response is submitted pending export to scoring platform.
AMENDMENTS	The questionnaire response is currently being edited after previously being submitted.
EXPORTING_TO_SCORING	The questionnaire response is being exported to the scoring platform.
EXPORTING_FOR_SCORING	The questionnaire response has exported to the scoring platform.

JSON Response Example

Below is an example of a successful API response showing a summary of information for the disclosing organiation queried.

{

"startDate": "2024-06-04T00:00:00.000Z",
"dueDate": "2024-10-02T00:00:00.000Z",
"scoringDeadline": "2024-12-01T00:00:00.000Z",
"isPublic": true,
"submittedOn": "2024-06-19T11:17:41.548Z",
"participationDate": "2024-06-19T11:16:08.509Z",
"orgDetailsDate": "2024-06-19T11:16:08.509Z",
"orgName": "CDP_ADMIN",
"status": "IN_PROGRESS",
"tags": null

}

If you have not found the answer you were looking for, please contact your Account Manager who will be able to assist you further.

Keywords: Disclosure API, API, ASP, API Partner

Comments (0)