Views: 211

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

 

Summary   

Questionnaire details of a disclosing organization that are linked to an API Partner can be retrieved using the GET request from this endpoint. 

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

Note – Data Sync: The deadlines retrieved from calling this method are not 100% accurate as updating of these deadlines is a manual process. To ensure retrieval of accurate data, it is essential to refresh this request each time the disclosing organization makes a change to the status of the questionnaire in the portal. 

Note – Tagging: The tagging information can’t be retrieved using this method as it is not configured yet. 

 

GET Request 

Details how to send the request to the questionnaire/metadata endpoint and the response that is returned when a successful request is sent. 

 

URLs  

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

Production: https://api-prd.cdpgreenstar.net/response/questionnaire/metadata 

 

 
Headers/Variables 

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

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

 

Body

NULL 

 

Response 

Information regarding the requested organization’s questionnaire. 
 

Field Table 

Field 

Description 

Data Type 

startDate 

The start date of the relevant questionnaire in ISO 8601 format. 

string  

dueDate 

The date for when the questionnaire type closes (Constant for all organizations). 

string 

scoringDeadline

The scoring deadline for the questionnaire in which organizations need to have submitted their response to receive a score. Note: timestamps and time zone can be ignored here as CDP deadline always refer to the IDLW time zone. 

string  

isPublic 

Indicates if the response will be public/ non-public.

boolean 

submittedOn 

The date when questionnaire response has been submitted to receive a score. 

string  

participationDate 

The date when the organization registered on portal to disclose.

string 

orgDetailsDate 

The date when the organization's details was last published.

string 

orgName 

Name of the disclosing organization.

string 

Status 

The status of the specified organization’s questionnaire response instance. 

string 

 

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

  1. "NOT_STARTED": The questionnaire response has not been started.
  2. "IN_PROGRESS": The questionnaire response is currently being answered.
  3. "SUBMITTED": The questionnaire response is submitted pending export to scoring platform.
  4. "AMENDMENTS": The questionnaire response is currently being edited after previously being submitted.
  5. "EXPORTING_TO_SCORING": The questionnaire response is currently being exported to the scoring platform (Note: everything is exported regardless of the scoring eligibility).
  6. "EXPORTED_FOR_SCORING": The questionnaire response has exported to the scoring platform.
  7. "LAPSED_AMENDMENTS": The questionnaire response status is moved to "LAPSED_AMENDMENTS" when the response was still in "AMENDMENTS" at the end of the disclosure cycle (meaning the latest version was not resubmitted to CDP).

 

Schema 

{

"startDate": "string",
"dueDate": "string",
"scoringDeadline": "string",
"isPublic": boolean,
"submittedOn": "string",
"participationDate": "string",
"orgDetailsDate": "string",
"orgName": "string",
"status": "string",
"tags": null

} 

 

JSON Response Example 

Below is an example API response while calling the GET method for this endpoint, for a questionnaire-response instance that has been submitted. The data retrieved are the basic details of the questionnaire pertaining to the associated disclosing organization. The tagging information will be not displayed as this has not been configured yet. 

 

{
      "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
}
 

Error Handling 

  1. Invalid Subscription Key
    When an incorrect or invalid subscription key is entered, the following error is displayed.

    {
          "message": "Invalid subscription key",
          "error": "Unauthorized",
          "statusCode": 401
    }
     
  2. Invalid Organization ID
    When an incorrect or invalid (one you are not currently linked with) organization id is entered, the following error is displayed.

    {
          "message": "Invalid organization id",
          "error": "Unauthorized",
          "statusCode": 401
    }
     
 

POST/PUT/DELETE Requests 

POST, PUT and DELETE requests are not implemented for this endpoint, preventing changes being made to a Discloser’s questionnaire metadata. 

 

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