Top

Assessments

Get Assessment List
GET /app/api/assessments/:account_id
Returns list of assessments available for the API caller account or one of its subaccounts.
Put Assessment
PUT /app/api/assessment/transfer
Transfer the rights to pass assessments between the API caller account and its subaccounts.
Get Assessment
GET /app/api/assessment/:assessment_id/
Returns detailed information about given assessment.
Get Core Assessment IDs
GET /app/api/assessment/core/:assessment_id/
Returns a list of core assessment IDs for given assessment.
Get Assessment Pages
GET /app/api/assessment/pages/:assessment_id/
Returns information about pages for given assessment.
Get Assessment Page Items
GET /app/api/assessment/items/:page_id/
Returns information about assessment page items.
Get Assessment Results
GET /app/api/assessment/results/:account_id?extended[&email=:email] [&max_records=:max_records][&start_record=:start_record][&date_since=:date_since]
Returns information about assessment results available for the API caller account or one of its subaccounts. Result status records are sorted by assessment start timestamp, the latest record is first.
Get Assessment Calculated Raw Scores
GET /app/api/assessment/results/calculate/:result_id
Obtains calculated raw scores for given assessment result.
Get Full PDF Report
GET /app/api/assessment/results/download/:result_id
Downloads full PDF report for given assessment result.
Get Full PDF Report (Graphs Only)
GET /app/api/assessment/results/download_graph/:result_id
Downloads PDF report (graphs only) for given assessment result.
Get HTML Nodes Of Summary Report
GET /app/api/assessment/results/report_summary/:result_id
Returns HTML nodes of “summary” report for given assessment result.

Get Assessment List

GET  /app/api/assessments/:account_id

Returns list of assessments available for the API caller account or one of its subaccounts.

HTTP URL Parameters

account_id int (12)
ID of the account.

Response: JSON array

assessment_id int (12)
Assessment ID.
owner_id int (12)
User ID of the record owner.
name string (255)
Assessment name.
quantity int (Length)
Number of available assessments.
infinite boolean
the flag indicates the account has infinite number of available assessments [0 | 1].

Sample Response


Status: 200 OK
Content Type: application/json;charset=UTF-8
[
    {
      "assessment_id": "8675",
      "owner_id": "12345",
      "name": "PeopleKeys DISC Assessment",
      "quantity": "50",
      "infinite": "1"
    },
    ...
]


Put Assessment

PUT /app/api/assessment/transfer

Transfer the rights to pass assessments between the API caller account and its subaccounts.

HTTP Form Parameters

assessment_id int (12)
assessment ID.
sender_account_id Data type and Length
ID of the account to transfer the assessment rights from.
recipient_account_id Data type and Length
ID of the account to transfer the assessment rights to.
quantity Data type and Length
number of available assessment passes to transfer.

Get Assessment

GET /app/api/assessment/:assessment_id/

Returns detailed information about given assessment.

HTTP GET Parameters

assessment_id int (12)
Assessment ID.

Response: JSON Array

assessment_id int (12)
Assessment ID.
name Data type and Length
Assessment name.
description Data type and Length
Assessment description.
environment Data type and Length
Assessment ‘environment’ tag.

Sample Response


Status: 200 OK
Content Type: application/json;charset=UTF-8
{
      "assessment_id": "8675",
      "name": "DISC",
      "description": "PeopleKeys DISC assessment",
      "environment": "Work - Project Manager"
}


Get Core Assessment IDs

GET /app/api/assessment/core/:assessment_id/

Returns a list of core assessment IDs for given assessment.

HTTP GET Parameters

assessment_id int (12)
ID of the account.

Response: JSON Array

core_assessments Data type and Length
JSON array containing list of core assessment IDs.

Sample Response


Status: 200 OK
Content Type: application/json;charset=UTF-8

    {
      "core_assessments": "Sample Return",
    }


Get Assessment Pages

GET /app/api/assessment/pages/:assessment_id/

Returns information about pages for given assessment.

HTTP URL Parameters

assessment_id int (12)
ID of the account to delete.

Response: JSON Array

page_id Data type and Length
assessment page ID.
sort_order Data type and Length
page order in the assessment.
type Data type and Length
page UI type.
content Data type and Length
page content:
  Type Data type and Length
page type.
  Header Data type and Length
page header.
  Sub-Header Data type and Length
page sub-header.
  Instructions Data type and Length
user instructions for assessment passage.

Sample Response


Status: 200 OK
Content Type: application/json;charset=UTF-8
[
    {
      "page_id": "Sample Return",
      "sort_order": "Sample Return",
      "type": "Sample Return",
      "content = {
      	  "Type": "Sample Return",
      	  "Header": "Sample Return",
      	  "Sub-Header": "Sample Return",
      	  "Instructions": "Sample Return"
      	}
    },
    ...
]


Get Assessment Page Items

GET /app/api/assessment/items/:page_id/

Returns information about assessment page items.

HTTP URL Parameters

page_id Data type and Length
assessment page ID.

Response: JSON Array

item_id Data type and Length
page item ID.
sort_order Data type and Length
page item order on the page.
content Data type and Length
page content:
  Type Data type and Length
page item type.
  Question Data type and Length
the question to answer.
  Value Data type and Length
answer value code.
  Text Data type and Length
answer text.

Sample Response


Status: 200 OK
Content Type: application/json;charset=UTF-8
[
    {
      "item_id": "Sample Return",
      "sort_order": "Sample Return",
      "content = {
      	  "Type": "Sample Return",
      	  "Question": "Sample Return",
      	  "Options = [
	      	  { "Value": "Sample Return", "Text": "Sample Return" }, ...
      	  ]
      	}
    },
    ...
]


Get Assessment Results

GET /app/api/assessment/results/:account_id?extended[&email=:email] [&max_records=:max_records][&start_record=:start_record][&date_since=:date_since][&tags=:tags]

Returns information about assessment results available for the API caller account or one of its subaccounts. Result status records are sorted by assessment start timestamp, the latest record is first.

HTTP URL Parameters

account_id Data type and Length
account ID.

HTTP GET Parameters

email string (255)
[optional] user email (login). Filters assessment results, returns the results available for user identified by the email (login).
max_records Data type and Length
[optional] the maximum number of result status records returned per request. By default, the maximum number of records is set to 10000. You cannot return more than 10000 result status records per request.
start_record Data type and Length
[optional] index of the first record. By default, index of the first record is 0.
date_since Data type and Length
[optional] [yyyy-mm-dd] filters out result records older than specified date.
tags JSON array
[optional]
{
    tag_list = [...]
}
tag_list Data type and Length
list of tags to apply as a filter. Filters assessment results, returns the results for users associated with at least one of the listed tags.

Response: JSON Array

total_record_number Data type and Length
total number of result status records found that match the filters.
results JSON array of result status records:
  id Data type and Length
assessment result ID.
  user_id Data type and Length
ID of the user that took the assessment.
  assessment_id Data type and Length
assessment ID.
  date_completed Data type and Length
[yyyy-mm-dd hh:mm:ss] assessment completion timestamp.
  date_started Data type and Length
[yyyy-mm-dd hh:mm:ss] assessment start timestamp.
  status Data type and Length
assessment completion status [Completed | In Progress].

Sample Response


Status: 200 OK
Content Type: application/json;charset=UTF-8

    {
      "total_record_number": "Sample Return"
      "results = [
	    {
      	  "id": "Sample Return",
      	  "user_id": "Sample Return",
      	  "assessment_id": "Sample Return",
      	  "date_completed": "Sample Return",
      	  "date_started": "Sample Return",
      	  "status": "Sample Return"
      	},
      	...
    ]
}


Get Assessment Calculated Raw Scores

GET /app/api/assessment/results/calculate/:result_id

Obtains calculated raw scores for given assessment result.

HTTP URL Parameters

result_id Data type and Length
assessment result ID.

Response: JSON Array

result_id Data type and Length
assessment result ID.
type Data type and Length
a JSON array, list of assessment types [bai|childrens|cognitive|disc15|disc24|perceptual|sgi|teams|values].
bai section contains ‘BAI’ assessment results:
  score_I Data type and Length
the “Inner Awareness” score.
  score_S Data type and Length
the “Social/Humanitarian” score.
  score_P Data type and Length
the “Political/EmPowerment” score.
  score_E Data type and Length
the “Economic” score.
  score_A Data type and Length
the “Artistic” score.
  score_K Data type and Length
the “Knowledge” score.
        primary_keyword Data type and Length
primary 'BAI' style.
        secondary_keyword Data type and Length
secondary 'BAI' style.
childrens section contains ‘CHILDRENS’ assessment results:
  score_D Data type and Length
the “D” score.
  score_I Data type and Length
the “I” score.
  score_S Data type and Length
the “S” score.
  score_C Data type and Length
the “C” score.
        intensity Data type and Length
DISC code
        style Data type and Length
calculated personality style.
cognitive section contains ‘COGNITIVE’ assessment results:
  score_L Data type and Length
the “Literal” score.
  score_I Data type and Length
the “Intuitive” score.
  score_T Data type and Length
the “Theoretical” score.
  score_E Data type and Length
the “Experimental” score.
        primary_keyword Data type and Length
primary 'COGNITIVE' style.
        secondary_keyword Data type and Length
secondary 'COGNITIVE' style.
disc15 section contains ‘DISC 15’ assessment results:
  score_D Data type and Length
the “D” score.
  score_I Data type and Length
the “I” score.
  score_S Data type and Length
the “S” score.
  score_C Data type and Length
the “C” score.
        intensity Data type and Length
DISC code.
        style Data type and Length
calculated personality style.
disc24 section contains ‘DISC 24’ assessment results:
  graph1_D Data type and Length
graph #1 “D” score.
  graph1_I Data type and Length
graph #1 “I” score.
  graph1_S Data type and Length
graph #1 “S” score.
  graph1_C Data type and Length
graph #1 “C” score.
  graph2_D Data type and Length
graph #2 “D” score.
  graph2_I Data type and Length
graph #2 “I” score.
  graph2_S Data type and Length
graph #2 “S” score.
  graph2_C Data type and Length
graph #2 “C” score.
  graph3_D Data type and Length
graph #3 “D” score.
  graph3_I Data type and Length
graph #3 “I” score.
  graph3_S Data type and Length
graph #3 “S” score.
  graph3_C Data type and Length
[graph #3 “C” score.
  intensity Data type and Length
DISC code.
  style Data type and Length
calculated personality style.
perceptual section contains ‘PERCEPTUAL’ assessment results:
  score_A Data type and Length
the “Auditory” score.
  score_V Data type and Length
the “Visual” score.
  score_K Data type and Length
the “Kinesthetic” score.
        primary_keyword Data type and Length
primary 'PERCEPTUAL' style.
        secondary_keyword Data type and Length
secondary 'PERCEPTUAL' style.
sgi section contains ‘SGI’ assessment results:
        score_Administration Data type and Length
the “Administration” score.
  score_Apostle Data type and Length
the “Apostle” score.
  score_Craftsman Data type and Length
the “Craftsman” score.
  score_Discernment Data type and Length
the “Discernment” score.
        score_Encouragement Data type and Length
the “Encouragement” score.
  score_Evangelist Data type and Length
the “Evangelist” score.
  score_Faith Data type and Length
the “Faith” score.
  score_Giving Data type and Length
the “Giving” score.
  score_Healing Data type and Length
the “Healing” score.
  score_Helps Data type and Length
the “Helps” score.
  score_Intercession Data type and Length
the “Intercession” score.
  score_Knowledge Data type and Length
the “Knowledge” score.
  score_Leadership Data type and Length
the “Leadership” score.
  score_Mercy Data type and Length
the “Mercy” score.
  score_Music Data type and Length
the “Music” score.
  score_Pastor Data type and Length
the “Pastor” score.
  score_Prophet Data type and Length
the “Prophet” score.
  score_Serving Data type and Length
the “Serving” score.
  score_Teacher Data type and Length
the “Teacher” score.
  score_Wisdom Data type and Length
the “Wisdom” score.
        absent_gifts Data type and Length
an array, list of absent gifts.
        present_gifts Data type and Length
an array, list of present gifts.
teams section contains ‘TEAMS’ assessment results:
  score_T Data type and Length
the “T” score.
  score_E Data type and Length
the “E” score.
  score_A Data type and Length
the “A” score.
  score_M Data type and Length
the “M” score.
  score_S Data type and Length
the “S” score.
  primary_keyword Data type and Length
primary personality style.
        secondary_keyword Data type and Length
secondary personality style.
values section contains ‘VALUES’ assessment results:
  score_L Data type and Length
the “L” score.
  score_E Data type and Length
the “E” score.
  score_P Data type and Length
the “P” score.
  score_J Data type and Length
the “J” score.
  primary_keyword Data type and Length
primary personality style.
        secondary_keyword Data type and Length
secondary personality style.

Sample Response


Status: 200 OK
Content Type: application/json;charset=UTF-8

    {
    "result_id": "Sample Return",
    "type = ["Sample Return"],
    "bai = {
      	"score_I": "Sample Return",
	  	"score_S": "Sample Return",
	  	"score_P": "Sample Return",
	  	"score_E": "Sample Return",
	  	"score_A": "Sample Return",
	  	"score_K": "Sample Return",
	  	"primary_keyword": "Sample Return",
      	"secondary_keyword": "Sample Return"
	},
	"childrens = {
      	"score_D": "Sample Return",
	  	"score_I": "Sample Return",
	  	"score_S": "Sample Return",
	  	"score_C": "Sample Return",
	  	"intensity": "Sample Return",
      	"style": "Sample Return"
	},
	"cognitive = {
      	"score_D": "Sample Return",
	  	"score_I": "Sample Return",
	  	"score_S": "Sample Return",
	  	"score_C": "Sample Return",
	  	"primary_keyword": "Sample Return",
      	"secondary_keyword": "Sample Return"
	},
	"disc15 = {
      	"score_D": "Sample Return",
	  	"score_I": "Sample Return",
	  	"score_S": "Sample Return",
	  	"score_C": "Sample Return",
	  	"intensity": "Sample Return",
      	"style": "Sample Return"
	},
	"disc24 = {
      	"graph1_D": "Sample Return",
      	"graph1_I": "Sample Return",
      	"graph1_S": "Sample Return",
      	"graph1_C": "Sample Return",
      	"graph2_D": "Sample Return",
      	"graph2_I": "Sample Return",
        "graph2_S": "Sample Return",
      	"graph2_C": "Sample Return",
      	"graph3_D": "Sample Return",
      	"graph3_I": "Sample Return",
      	"graph3_S": "Sample Return",
      	"graph3_C": "Sample Return",
      	"intensity": "Sample Return",
      	"style": "Sample Return"
	},
	"perceptual = {
      	"score_A": "Sample Return",
	  	"score_V": "Sample Return",
	  	"score_K": "Sample Return",
	  	"primary_keyword": "Sample Return",
      	"secondary_keyword": "Sample Return"
	},
	"sgi = {
      	"score_Administration": "Sample Return",
	  	"score_Apostle": "Sample Return",
	  	"score_Craftsman": "Sample Return",
	  	"score_Discernment": "Sample Return",
	  	"score_Encouragement": "Sample Return",
	  	"score_Evangelist": "Sample Return",
	  	"score_Faith": "Sample Return",
	  	"score_Giving": "Sample Return",
	  	"score_Healing": "Sample Return",
	  	"score_Helps": "Sample Return",
	  	"score_Intercession": "Sample Return",
	  	"score_Knowledge": "Sample Return",
	  	"score_Leadership": "Sample Return",
	  	"score_Mercy": "Sample Return",
	  	"score_Music": "Sample Return",
	  	"score_Pastor": "Sample Return",
	  	"score_Prophet": "Sample Return",
	  	"score_Serving": "Sample Return",
	  	"score_Teacher": "Sample Return",
	  	"score_Wisdom": "Sample Return"
      	"absent_gifts": "Sample Return",
      	"present_gifts": "Sample Return"
	},
	"teams = {
	   "score_T": "Sample Return",
	   "score_E": "Sample Return",
	   "score_A": "Sample Return",
	   "score_M": "Sample Return",
	   "score_S": "Sample Return",
	   "primary_keyword": "Sample Return",
	   "secondary_keyword": "Sample Return"
	},
	"values = {
	   "score_L": "Sample Return",
	   "score_E": "Sample Return",
	   "score_P": "Sample Return",
	   "score_J": "Sample Return",
	   "primary_keyword": "Sample Return",
	   "secondary_keyword": "Sample Return"
	}
	
    }


Get Full PDF Report

GET /app/api/assessment/results/download/:result_id

Downloads full PDF report for given assessment result.

HTTP URL Parameters

result_id int (12)
assessment result ID.

Response: Binary Stream

Binary stream for PDF report. Content-Type: application/pdf. Content-Disposition: attachment.

Get Full PDF Report (Graphs Only)

GET /app/api/assessment/results/download_graph/:result_id

Downloads PDF report (graphs only) for given assessment result.

HTTP URL Parameters

result_id int (12)
assessment result ID.

Response: Binary Stream

Binary stream for PDF report. Content-Type: application/pdf. Content-Disposition: attachment.

Get HTML Nodes Of Summary Report

GET /app/api/assessment/results/report_summary/:result_id

Returns HTML nodes of “summary” report for given assessment result.

HTTP URL Parameters

result_id int (12)
Assessment result ID.

Response: JSON array

result_id Data type and Length
assessment result ID.
type Data type and Length
a JSON array, list of assessment types [bai|childrens|cognitive|disc15|disc24|perceptual|sgi|teams|values].
report_nodes Data type and Length
the list of summary report HTML nodes.
  node_type Data type and Length
node type [bai|childrens|cognitive|disc15|disc24|perceptual|sgi|teams|values].
  node_html Data type and Length
HTML fragment that corresponds to the node.

Sample Response


Status: 200 OK
Content Type: application/json;charset=UTF-8
{
      "result_id": "Sample Return",
      "type = ["Sample Return"],
      "report_nodes = [
      	{
      	  "node_type": "Sample Return",
      	  "node_html": "Sample Return"
      	},
      	...
    ]   
}