Credit Calculation

Calculate the maximum number of credits needed for a respondent

curl --request POST \
  --url https://api.redem.io/v2/creditCalculation \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
{
  "OESDataPoints": 2,
  "GQSAnswers": 35,
  "TSDataPoints": 2,
  "CHSAnswers": 25,
  "BASDataPoints": 2
}
'

import requests

url = "https://api.redem.io/v2/creditCalculation"

payload = {
    "OESDataPoints": 2,
    "GQSAnswers": 35,
    "TSDataPoints": 2,
    "CHSAnswers": 25,
    "BASDataPoints": 2
}
headers = {
    "api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    OESDataPoints: 2,
    GQSAnswers: 35,
    TSDataPoints: 2,
    CHSAnswers: 25,
    BASDataPoints: 2
  })
};

fetch('https://api.redem.io/v2/creditCalculation', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.redem.io/v2/creditCalculation",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'OESDataPoints' => 2,
    'GQSAnswers' => 35,
    'TSDataPoints' => 2,
    'CHSAnswers' => 25,
    'BASDataPoints' => 2
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.redem.io/v2/creditCalculation"

	payload := strings.NewReader("{\n  \"OESDataPoints\": 2,\n  \"GQSAnswers\": 35,\n  \"TSDataPoints\": 2,\n  \"CHSAnswers\": 25,\n  \"BASDataPoints\": 2\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.redem.io/v2/creditCalculation")
  .header("api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"OESDataPoints\": 2,\n  \"GQSAnswers\": 35,\n  \"TSDataPoints\": 2,\n  \"CHSAnswers\": 25,\n  \"BASDataPoints\": 2\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.redem.io/v2/creditCalculation")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"OESDataPoints\": 2,\n  \"GQSAnswers\": 35,\n  \"TSDataPoints\": 2,\n  \"CHSAnswers\": 25,\n  \"BASDataPoints\": 2\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "message": "Credit calculation successfully retrieved",
  "results": {
    "creditCalculation": {
      "totalCredits": 12,
      "calculationBreakdown": {
        "OES": {
          "credits": 4,
          "dataPoints": 2
        },
        "GQS": {
          "credits": 3,
          "answers": 35
        },
        "TS": {
          "credits": 1,
          "dataPoints": 2
        },
        "CHS": {
          "credits": 4,
          "answers": 25
        },
        "BAS": {
          "credits": 4,
          "dataPoints": 2
        }
      }
    }
  }
}

POST

creditCalculation

Calculate the maximum number of credits needed for a respondent

curl --request POST \
  --url https://api.redem.io/v2/creditCalculation \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
{
  "OESDataPoints": 2,
  "GQSAnswers": 35,
  "TSDataPoints": 2,
  "CHSAnswers": 25,
  "BASDataPoints": 2
}
'

import requests

url = "https://api.redem.io/v2/creditCalculation"

payload = {
    "OESDataPoints": 2,
    "GQSAnswers": 35,
    "TSDataPoints": 2,
    "CHSAnswers": 25,
    "BASDataPoints": 2
}
headers = {
    "api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    OESDataPoints: 2,
    GQSAnswers: 35,
    TSDataPoints: 2,
    CHSAnswers: 25,
    BASDataPoints: 2
  })
};

fetch('https://api.redem.io/v2/creditCalculation', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.redem.io/v2/creditCalculation",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'OESDataPoints' => 2,
    'GQSAnswers' => 35,
    'TSDataPoints' => 2,
    'CHSAnswers' => 25,
    'BASDataPoints' => 2
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.redem.io/v2/creditCalculation"

	payload := strings.NewReader("{\n  \"OESDataPoints\": 2,\n  \"GQSAnswers\": 35,\n  \"TSDataPoints\": 2,\n  \"CHSAnswers\": 25,\n  \"BASDataPoints\": 2\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.redem.io/v2/creditCalculation")
  .header("api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"OESDataPoints\": 2,\n  \"GQSAnswers\": 35,\n  \"TSDataPoints\": 2,\n  \"CHSAnswers\": 25,\n  \"BASDataPoints\": 2\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.redem.io/v2/creditCalculation")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"OESDataPoints\": 2,\n  \"GQSAnswers\": 35,\n  \"TSDataPoints\": 2,\n  \"CHSAnswers\": 25,\n  \"BASDataPoints\": 2\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "message": "Credit calculation successfully retrieved",
  "results": {
    "creditCalculation": {
      "totalCredits": 12,
      "calculationBreakdown": {
        "OES": {
          "credits": 4,
          "dataPoints": 2
        },
        "GQS": {
          "credits": 3,
          "answers": 35
        },
        "TS": {
          "credits": 1,
          "dataPoints": 2
        },
        "CHS": {
          "credits": 4,
          "answers": 25
        },
        "BAS": {
          "credits": 4,
          "dataPoints": 2
        }
      }
    }
  }
}

If you need to estimate the number of credits required to add a respondent, you can use this endpoint.

This endpoint is optional and serves informational purposes only. It provides an estimate of the credits required based on the selected quality scores.

DESDataPoints is optional and defaults to 0 if omitted.

Authorizations

api-key

string

header

required

Body

application/json

Request body for calculating the maximum number of credits needed for a respondent

🔒 Authentication: Requires a private API key. Public keys may only call addRespondent.

OESDataPoints

number

required

The number of data points to be used for the Open-Ended Score (OES). ⭕ Note: If no OES data points are available, this value can be set to 0.

GQSAnswers

number

required

The number of data points to be used for the Grid-Question Score (GQS). ⭕ Note: If no GQS answers are available, this value can be set to 0.

TSDataPoints

number

required

The number of data points to be used for the Time Score (TS). ⭕ Note: If no TS data points are available, this value can be set to 0.

CHSAnswers

number

required

The number of data points to be used for the Coherence Score (CHS). ⭕ Note: If no CHS answers are available, this value can be set to 0.

BASDataPoints

number

required

The number of data points to be used for the Behavioral-Analytics Score (BAS). ⭕ Note: If no BAS data points are available, this value can be set to 0.

DESDataPoints

number

default:0

The number of data points to be used for the Duplicate Entrance Score (DES). Optional; defaults to 0 if omitted. ⭕ Note: If no DES data points are available, this value can be omitted or set to 0.

Response

When a request is successfully processed, the API returns a 200 OK status code along with the expected data.

success

enum<boolean>

A variable indicating whether the operation was successful.

Available options:

true,

false

message

string

A variable that human-readable message providing additional context or confirmation of the requested action.

results

object

This object serves as a container to hold the results for the requested data, encapsulating all relevant information and outputs in a structured format.

Show child attributes

How to integrate

API Specifications

Endpoints

Others

Authorizations

Body

Response