Get Questionnaires By Product

'GetQuestionnariesByProduct' API enables to fetch the questionnaire

Questionnaire - refers to a structured set of questions designed to collect specific information about customer for onboarding

Bank or financial institution can fetch the questionnaire mapped for required product. On providing product name as request, question details of the questionnaire can be fetched out.

Method: POST

{{URL}}/jsonrpc

Headers

Name	Value
Content-Type	application/json

Example

Payload Parameters

Parameter	Description
method Mandatory	String API method that is being called to get questionnaire by product through program setting servic Constant value: "ProgramSettingService.GetQuestionnairesByProduct"
id Mandatory	String Unique ID of API request Sample value: "1"
params Mandatory	Object
api Mandatory	Object
signature Mandatory	String Signature for request validation Sample value: "signature"
keyId Mandatory	String API key used for request authentication Sample value: "ApplicationKeyId"
credential Mandatory	String API credential provided by NetXD Sample value: "Credential"
payload Mandatory	Object
name Mandatory	String Name of the product Sample value: "DEFAULT"

cURL

curl --location --globoff '{{URL}}/jsonrpc' \
--header 'Content-Type: application/json' \
--data '{"method":"ProgramSettingService.GetQuestionnairesByProduct","id":"1","params":{"api":{"signature":"{{signature}}","keyId":"{{ApplicationKeyId}}","credential":"{{Credential}}"},"payload":{"name":"DEFAULT"}}}'

C#

var options = new RestClientOptions("{{URL}}/jsonrpc")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Post);
request.AddHeader("Content-Type", "application/json");
var body = @"{
" + "\n" +
@"    ""method"": ""ProgramSettingService.GetQuestionnairesByProduct"",
" + "\n" +
@"    ""id"": ""1"",
" + "\n" +
@"    ""params"": {
" + "\n" +
@"        ""api"": {
" + "\n" +
@"            ""signature"": ""{{signature}}"",
" + "\n" +
@"            ""keyId"": ""{{ApplicationKeyId}}"",
" + "\n" +
@"            ""credential"": ""{{Credential}}""
" + "\n" +
@"        },
" + "\n" +
@"        ""payload"": {
" + "\n" +
@"            ""name"": ""DEFAULT""
" + "\n" +
@"        }
" + "\n" +
@"    }
" + "\n" +
@"}
" + "\n" +
@"";
request.AddStringBody(body, DataFormat.Json);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);

Go

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "{{URL}}/jsonrpc"
  method := "POST"

  payload := strings.NewReader(`{`+"
"+`
    "method": "ProgramSettingService.GetQuestionnairesByProduct",`+"
"+`
    "id": "1",`+"
"+`
    "params": {`+"
"+`
        "api": {`+"
"+`
            "signature": "{{signature}}",`+"
"+`
            "keyId": "{{ApplicationKeyId}}",`+"
"+`
            "credential": "{{Credential}}"`+"
"+`
        },`+"
"+`
        "payload": {`+"
"+`
            "name": "DEFAULT"`+"
"+`
        }`+"
"+`
    }`+"
"+`
}`+"
"+`
`)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/json")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

NodeJs

var https = require('follow-redirects').https;
var fs = require('fs');

var options = {
  'method': 'POST',
  'hostname': '{{URL}}',
  'path': '/jsonrpc',
  'headers': {
    'Content-Type': 'application/json'
  },
  'maxRedirects': 20
};

var req = https.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function (chunk) {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });

  res.on("error", function (error) {
    console.error(error);
  });
});

var postData = JSON.stringify({
  "method": "ProgramSettingService.GetQuestionnairesByProduct",
  "id": "1",
  "params": {
    "api": {
      "signature": "{{signature}}",
      "keyId": "{{ApplicationKeyId}}",
      "credential": "{{Credential}}"
    },
    "payload": {
      "name": "DEFAULT"
    }
  }
});

req.write(postData);

req.end();

Body

{
  "method": "ProgramSettingService.GetQuestionnairesByProduct",
  "id": "1",
  "params": {
    "api": {
      "signature": "{{signature}}",
      "keyId": "{{ApplicationKeyId}}",
      "credential": "{{Credential}}"
    },
    "payload": {
      "name": "DEFAULT"
    }
  }
}

Response: 200

Response Parameters

Parameter	Description
id	String Response ID echoed from the request ID Sample value: "1"
result	Object
questionnaires	Object
ID	String Unique ID of the questionnaire Sample value: "64f195eb77f796c5ba8724c7"
name	String Name of the questionnaire Sample value: "demo_1"
questions	Array
uid	String Unique ID of the question Sample value: "f671267131aa4ea5945d1faa655d4162"
title	String Title of the question Sample value: "Business classification"
question	String Question that is being asked Sample value: "Is the Business a Money Service Business (\"MSB\")?*"
mandatory	Boolean Indicates whether this question is mandatory (true) or optional (false) Sample value: true
optionType	String Type of option given for the question Sample value: "MultipleChoice"
optionValue	String Possible values applicable for the question Sample value: "Yes, No"
page	String Page number where the question is located within the questionnaire Sample value: "2"
hint	String Additional information given related to the question Sample value: "testing"
createdDate	String Date and time when the questionnaire was created Sample value: "2023-09-01T07:42:35.542Z"
updatedDate	String Date and time when the questionnaire was last updated Sample value: "2023-09-01T07:42:35.542Z"

{
  "id": "1",
  "result": {
    "questionnaires": {
      "ID": "64f195eb77f796c5ba8724c7",
      "name": "demo_1",
      "questions": [
        {
          "uid": "f671267131aa4ea5945d1faa655d4162",
          "title": "Business classification",
          "question": "Is the Business a Money Service Business (\"MSB\")?*",
          "mandatory": true,
          "optionType": "MultipleChoice",
          "optionValue": "Yes, No",
          "page": "2",
          "hint": "testing"
        }
      ],
      "createdDate": "2023-09-01T07:42:35.542Z",
      "updatedDate": "2023-09-01T07:42:35.542Z"
    }
  }
}