Internal API Documentation
Internal API uses GraphQL to send the requests and handle responses.
Your API token from the authentication response must be included in all API calls. For more information see here.
It is recommended for clients store the token and use it until the expiration time instead of generating a new token for each request to GraphQL API.
There is a playground here.
API Endpoints
https://iapi.vitanavis.com/v1/graphqlHeaders
Authorization: Bearer <YOUR_TOKEN_HERE>Version
1.0.0
Queries
accessCode
Description
Get the AccessCode details by guid.
Response
Returns an AccessCode!
Arguments
| Name | Description |
|---|---|
guid - GUID!
|
Example
Query
query accessCode($guid: GUID!) {
accessCode(guid: $guid) {
guid
name
code
usageCount
status
createdAt
group
experience
archive
description
limitStartDate
limitEndDate
limitMaxUses
}
}
Variables
{
"guid": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc"
}
Response
{
"data": {
"accessCode": {
"guid": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"name": "abc123",
"code": "xyz789",
"usageCount": 987.65,
"status": "active",
"createdAt": "2007-12-03T10:15:30Z",
"group": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"experience": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"archive": true,
"description": "xyz789",
"limitStartDate": "2007-12-03T10:15:30Z",
"limitEndDate": "2007-12-03T10:15:30Z",
"limitMaxUses": 123
}
}
}
accessCodes
Description
Get the list of AccessCodes by parameters.
Response
Returns [AccessCodeListItem!]!
Example
Query
query accessCodes(
$group: GUID!,
$keyword: String,
$experience: [GUID!],
$status: AccessCodeStatus,
$archive: Boolean,
$limit: Int
) {
accessCodes(
group: $group,
keyword: $keyword,
experience: $experience,
status: $status,
archive: $archive,
limit: $limit
) {
guid
name
code
usageCount
status
createdAt
group
experience
archive
}
}
Variables
{
"group": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"keyword": "abc123",
"experience": [
"66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc"
],
"status": "active",
"archive": false,
"limit": 100
}
Response
{
"data": {
"accessCodes": [
{
"guid": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"name": "abc123",
"code": "abc123",
"usageCount": 123.45,
"status": "active",
"createdAt": "2007-12-03T10:15:30Z",
"group": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"experience": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"archive": true
}
]
}
}
assessment
Description
Get the Assessment info by guid.
Response
Returns an Assessment
Arguments
| Name | Description |
|---|---|
guid - GUID!
|
Example
Query
query assessment($guid: GUID!) {
assessment(guid: $guid) {
guid
type
name
description
version
date
family
}
}
Variables
{
"guid": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc"
}
Response
{
"data": {
"assessment": {
"guid": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"type": "abc123",
"name": {},
"description": "abc123",
"version": "xyz789",
"date": "2007-12-03T10:15:30Z",
"family": "assessment"
}
}
}
assessmentResult
Description
Get the Assessment Result info with scores by guid.
Response
Returns an AssessmentResult
Arguments
| Name | Description |
|---|---|
guid - GUID!
|
Example
Query
query assessmentResult($guid: GUID!) {
assessmentResult(guid: $guid) {
guid
person
createdAt
completedAt
status
assessment
personExperienceModule
answers
assessmentType
scores
feedback
}
}
Variables
{
"guid": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc"
}
Response
{
"data": {
"assessmentResult": {
"guid": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"person": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"createdAt": "2007-12-03T10:15:30Z",
"completedAt": "2007-12-03T10:15:30Z",
"status": "incomplete",
"assessment": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"personExperienceModule": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"answers": {},
"assessmentType": "abc123",
"scores": {},
"feedback": {}
}
}
}
assessmentResults
Description
Get the list of Assessment Results by parameters.
Response
Returns [AssessmentResultListItem!]!
Arguments
| Name | Description |
|---|---|
person - GUID!
|
|
assessment - GUID
|
|
status - AssessmentResultStatus
|
|
limit - Int
|
Example
Query
query assessmentResults(
$person: GUID!,
$assessment: GUID,
$status: AssessmentResultStatus,
$limit: Int
) {
assessmentResults(
person: $person,
assessment: $assessment,
status: $status,
limit: $limit
) {
guid
person
createdAt
completedAt
status
assessment
}
}
Variables
{
"person": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"assessment": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"status": "incomplete",
"limit": 987
}
Response
{
"data": {
"assessmentResults": [
{
"guid": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"person": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"createdAt": "2007-12-03T10:15:30Z",
"completedAt": "2007-12-03T10:15:30Z",
"status": "incomplete",
"assessment": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc"
}
]
}
}
assessments
Description
Get the list of Assessments by parameters.
Response
Returns [Assessment!]!
Arguments
| Name | Description |
|---|---|
type - String
|
|
family - AssessmentFamily
|
|
limit - Int
|
Default = 10 |
offset - Int
|
Default = 0 |
Example
Query
query assessments(
$type: String,
$family: AssessmentFamily,
$limit: Int,
$offset: Int
) {
assessments(
type: $type,
family: $family,
limit: $limit,
offset: $offset
) {
guid
type
name
description
version
date
family
}
}
Variables
{
"type": "abc123",
"family": "assessment",
"limit": 10,
"offset": 0
}
Response
{
"data": {
"assessments": [
{
"guid": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"type": "abc123",
"name": {},
"description": "abc123",
"version": "abc123",
"date": "2007-12-03T10:15:30Z",
"family": "assessment"
}
]
}
}
assessmentsCount
Description
Get count of Assessments by parameters.
Response
Returns a Float!
Arguments
| Name | Description |
|---|---|
type - String
|
|
family - AssessmentFamily
|
Example
Query
query assessmentsCount(
$type: String,
$family: AssessmentFamily
) {
assessmentsCount(
type: $type,
family: $family
)
}
Variables
{"type": "xyz789", "family": "assessment"}
Response
{"data": {"assessmentsCount": 123.45}}
calculateScores
Description
Calculate scores by answers.
Response
Returns [CalculateScoresResult!]
Arguments
| Name | Description |
|---|---|
scoring - GUID
|
|
scoringName - String
|
|
scoringVersion - String
|
|
answers - [AnswerInput!]
|
|
answersByGuid - [AnswerByGuidInput!]
|
|
norms - [String!]!
|
Default = ["combined", "en-US"] |
Example
Query
query calculateScores(
$scoring: GUID,
$scoringName: String,
$scoringVersion: String,
$answers: [AnswerInput!],
$answersByGuid: [AnswerByGuidInput!],
$norms: [String!]!
) {
calculateScores(
scoring: $scoring,
scoringName: $scoringName,
scoringVersion: $scoringVersion,
answers: $answers,
answersByGuid: $answersByGuid,
norms: $norms
) {
scoring {
...ScoringFragment
}
scores
}
}
Variables
{
"scoring": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"scoringName": "abc123",
"scoringVersion": "abc123",
"answers": [AnswerInput],
"answersByGuid": [AnswerByGuidInput],
"norms": ["combined", "en-US"]
}
Response
{
"data": {
"calculateScores": [
{"scoring": Scoring, "scores": {}}
]
}
}
cover
Description
Get the Cover details by guid.
Example
Query
query cover($guid: GUID!) {
cover(guid: $guid) {
guid
contentBook
name
translations
createdAt
updatedAt
version
defaultAllowShare
defaultNorms
defaultDependency
retakeDays
dependencies
}
}
Variables
{
"guid": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc"
}
Response
{
"data": {
"cover": {
"guid": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"contentBook": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"name": "xyz789",
"translations": {},
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"version": "abc123",
"defaultAllowShare": false,
"defaultNorms": ["abc123"],
"defaultDependency": ["xyz789"],
"retakeDays": 123,
"dependencies": {}
}
}
}
covers
Description
Get the list of all Covers.
Response
Returns [Covers!]!
Example
Query
query covers {
covers {
guid
contentBook
name
translations
createdAt
updatedAt
version
defaultAllowShare
defaultNorms
defaultDependency
retakeDays
dependencies
}
}
Response
{
"data": {
"covers": [
{
"guid": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"contentBook": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"name": "xyz789",
"translations": {},
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"version": "abc123",
"defaultAllowShare": false,
"defaultNorms": ["abc123"],
"defaultDependency": ["xyz789"],
"retakeDays": 123,
"dependencies": {}
}
]
}
}
generateReport
Description
Generate a report by answers.
Response
Returns a GenerateReportResult!
Arguments
| Name | Description |
|---|---|
cover - GUID
|
|
coverName - String
|
|
coverVersion - String
|
|
contentVariables - ReportContentVariables!
|
|
language - Language
|
|
type - ReportType
|
Default = PDF |
clientOrigin - URL
|
The client origin with a protocol, a host by name or IP address, and an optional port number. We need this for security reasons and it is necessary only for HTML-type reports. Clients should provide the correct base origin to be able to embed the HTML report and work within. |
scoring - GUID
|
|
scoringName - String
|
|
scoringVersion - String
|
|
answers - [AnswerInput!]
|
|
answersByGuid - [AnswerByGuidInput!]
|
|
norms - [String!]!
|
Default = ["combined", "en-US"] |
Example
Query
query generateReport(
$cover: GUID,
$coverName: String,
$coverVersion: String,
$contentVariables: ReportContentVariables!,
$language: Language,
$type: ReportType,
$clientOrigin: URL,
$scoring: GUID,
$scoringName: String,
$scoringVersion: String,
$answers: [AnswerInput!],
$answersByGuid: [AnswerByGuidInput!],
$norms: [String!]!
) {
generateReport(
cover: $cover,
coverName: $coverName,
coverVersion: $coverVersion,
contentVariables: $contentVariables,
language: $language,
type: $type,
clientOrigin: $clientOrigin,
scoring: $scoring,
scoringName: $scoringName,
scoringVersion: $scoringVersion,
answers: $answers,
answersByGuid: $answersByGuid,
norms: $norms
) {
url
}
}
Variables
{
"cover": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"coverName": "xyz789",
"coverVersion": "xyz789",
"contentVariables": ReportContentVariables,
"language": "EN_US",
"type": "PDF",
"clientOrigin": "http://www.test.com/",
"scoring": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"scoringName": "xyz789",
"scoringVersion": "abc123",
"answers": [AnswerInput],
"answersByGuid": [AnswerByGuidInput],
"norms": ["combined", "en-US"]
}
Response
{
"data": {
"generateReport": {
"url": "http://www.test.com/"
}
}
}
generateReportByScoring
Description
Generate a report by scoring.
Response
Returns a GenerateReportResult!
Arguments
| Name | Description |
|---|---|
cover - GUID
|
|
coverName - String
|
|
coverVersion - String
|
|
contentVariables - ReportContentVariables!
|
|
language - Language
|
|
type - ReportType
|
Default = PDF |
clientOrigin - URL
|
The client origin with a protocol, a host by name or IP address, and an optional port number. We need this for security reasons and it is necessary only for HTML-type reports. Clients should provide the correct base origin to be able to embed the HTML report and work within. |
scores - [ScoreInput!]!
|
Example
Query
query generateReportByScoring(
$cover: GUID,
$coverName: String,
$coverVersion: String,
$contentVariables: ReportContentVariables!,
$language: Language,
$type: ReportType,
$clientOrigin: URL,
$scores: [ScoreInput!]!
) {
generateReportByScoring(
cover: $cover,
coverName: $coverName,
coverVersion: $coverVersion,
contentVariables: $contentVariables,
language: $language,
type: $type,
clientOrigin: $clientOrigin,
scores: $scores
) {
url
}
}
Variables
{
"cover": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"coverName": "abc123",
"coverVersion": "abc123",
"contentVariables": ReportContentVariables,
"language": "EN_US",
"type": "PDF",
"clientOrigin": "http://www.test.com/",
"scores": [ScoreInput]
}
Response
{
"data": {
"generateReportByScoring": {
"url": "http://www.test.com/"
}
}
}
invitation
Description
Get the Invitation details by guid.
Response
Returns an Invitation!
Arguments
| Name | Description |
|---|---|
guid - GUID!
|
Example
Query
query invitation($guid: GUID!) {
invitation(guid: $guid) {
id
guid
group
campaign
email
data {
...InvitationRecipientObjectFragment
}
status
createdAt
person
appliedAt
personExperience
sendingLog
template
accessCode
updatedAt
createdBy
updatedBy
archive
scheduledDate
timezone
fromName
invitationsCampaign {
...InvitationsCampaignFragment
}
}
}
Variables
{
"guid": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc"
}
Response
{
"data": {
"invitation": {
"id": 987,
"guid": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"group": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"campaign": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"email": "test@test.com",
"data": InvitationRecipientObject,
"status": "pending",
"createdAt": "2007-12-03T10:15:30Z",
"person": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"appliedAt": "2007-12-03T10:15:30Z",
"personExperience": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"sendingLog": {},
"template": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"accessCode": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"updatedAt": "2007-12-03T10:15:30Z",
"createdBy": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"updatedBy": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"archive": false,
"scheduledDate": "2007-12-03T10:15:30Z",
"timezone": "abc123",
"fromName": "xyz789",
"invitationsCampaign": InvitationsCampaign
}
}
}
invitations
Description
Get the list of Invitations by parameters.
Response
Returns [Invitation!]!
Arguments
| Name | Description |
|---|---|
group - GUID!
|
|
campaign - GUID
|
|
archive - Boolean
|
Filter based on Invitation Campaign and Invitation archive values. |
keyword - String
|
|
status - [InvitationStatus!]
|
|
limit - Int!
|
|
offset - Int!
|
|
orderBy - [InvitationsOrderByArgs!]
|
Default = [{column: "createdAt", order: DESC}] |
Example
Query
query invitations(
$group: GUID!,
$campaign: GUID,
$archive: Boolean,
$keyword: String,
$status: [InvitationStatus!],
$limit: Int!,
$offset: Int!,
$orderBy: [InvitationsOrderByArgs!]
) {
invitations(
group: $group,
campaign: $campaign,
archive: $archive,
keyword: $keyword,
status: $status,
limit: $limit,
offset: $offset,
orderBy: $orderBy
) {
id
guid
group
campaign
email
data {
...InvitationRecipientObjectFragment
}
status
createdAt
person
appliedAt
personExperience
sendingLog
template
accessCode
updatedAt
createdBy
updatedBy
archive
scheduledDate
timezone
fromName
invitationsCampaign {
...InvitationsCampaignFragment
}
}
}
Variables
{
"group": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"campaign": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"archive": false,
"keyword": "xyz789",
"status": ["pending"],
"limit": 987,
"offset": 987,
"orderBy": [{"column": "createdAt", "order": "DESC"}]
}
Response
{
"data": {
"invitations": [
{
"id": 123,
"guid": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"group": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"campaign": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"email": "test@test.com",
"data": InvitationRecipientObject,
"status": "pending",
"createdAt": "2007-12-03T10:15:30Z",
"person": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"appliedAt": "2007-12-03T10:15:30Z",
"personExperience": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"sendingLog": {},
"template": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"accessCode": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"updatedAt": "2007-12-03T10:15:30Z",
"createdBy": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"updatedBy": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"archive": false,
"scheduledDate": "2007-12-03T10:15:30Z",
"timezone": "abc123",
"fromName": "xyz789",
"invitationsCampaign": InvitationsCampaign
}
]
}
}
invitationsCampaign
Description
Get the Invitations Campaign by guid.
Response
Returns an InvitationsCampaign!
Arguments
| Name | Description |
|---|---|
guid - GUID!
|
Example
Query
query invitationsCampaign($guid: GUID!) {
invitationsCampaign(guid: $guid) {
id
guid
group
name
description
accessCode
isSent
createdAt
updatedAt
createdBy
updatedBy
template
archive
sendingLog
scheduledDate
timezone
fromName
}
}
Variables
{
"guid": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc"
}
Response
{
"data": {
"invitationsCampaign": {
"id": 123,
"guid": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"group": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"name": "xyz789",
"description": "abc123",
"accessCode": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"isSent": true,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"createdBy": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"updatedBy": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"template": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"archive": true,
"sendingLog": {},
"scheduledDate": "2007-12-03T10:15:30Z",
"timezone": "abc123",
"fromName": "abc123"
}
}
}
invitationsCampaignTemplate
Description
Get the Invitations Campaign Template by guid.
Response
Returns an InvitationsCampaignTemplate!
Arguments
| Name | Description |
|---|---|
guid - GUID!
|
Example
Query
query invitationsCampaignTemplate($guid: GUID!) {
invitationsCampaignTemplate(guid: $guid) {
id
guid
name
language
subject
body
createdAt
updatedAt
default
group
createdBy
updatedBy
}
}
Variables
{
"guid": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc"
}
Response
{
"data": {
"invitationsCampaignTemplate": {
"id": 123,
"guid": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"name": "abc123",
"language": "EN_US",
"subject": "xyz789",
"body": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"default": false,
"group": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"createdBy": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"updatedBy": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc"
}
}
}
invitationsCampaignTemplates
Description
Get the list of Invitations Campaign Templates by parameters.
Response
Returns [InvitationsCampaignTemplate!]!
Arguments
| Name | Description |
|---|---|
group - GUID!
|
|
keyword - String
|
|
limit - Int!
|
|
offset - Int!
|
|
orderBy - [InvitationsCampaignTemplatesOrderByArgs!]
|
Example
Query
query invitationsCampaignTemplates(
$group: GUID!,
$keyword: String,
$limit: Int!,
$offset: Int!,
$orderBy: [InvitationsCampaignTemplatesOrderByArgs!]
) {
invitationsCampaignTemplates(
group: $group,
keyword: $keyword,
limit: $limit,
offset: $offset,
orderBy: $orderBy
) {
id
guid
name
language
subject
body
createdAt
updatedAt
default
group
createdBy
updatedBy
}
}
Variables
{
"group": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"keyword": "xyz789",
"limit": 123,
"offset": 123,
"orderBy": [InvitationsCampaignTemplatesOrderByArgs]
}
Response
{
"data": {
"invitationsCampaignTemplates": [
{
"id": 987,
"guid": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"name": "abc123",
"language": "EN_US",
"subject": "xyz789",
"body": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"default": true,
"group": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"createdBy": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"updatedBy": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc"
}
]
}
}
invitationsCampaignTemplatesCount
Description
Get count of Invitations Campaign Templates by parameters.
Example
Query
query invitationsCampaignTemplatesCount(
$group: GUID!,
$keyword: String
) {
invitationsCampaignTemplatesCount(
group: $group,
keyword: $keyword
)
}
Variables
{
"group": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"keyword": "abc123"
}
Response
{"data": {"invitationsCampaignTemplatesCount": 123.45}}
invitationsCampaigns
Description
Get the list of Invitations Campaigns by parameters.
Response
Returns [InvitationsCampaign!]!
Example
Query
query invitationsCampaigns(
$group: GUID!,
$archive: Boolean,
$keyword: String,
$limit: Int!,
$offset: Int!,
$orderBy: [InvitationsCampaignsOrderByArgs!]
) {
invitationsCampaigns(
group: $group,
archive: $archive,
keyword: $keyword,
limit: $limit,
offset: $offset,
orderBy: $orderBy
) {
id
guid
group
name
description
accessCode
isSent
createdAt
updatedAt
createdBy
updatedBy
template
archive
sendingLog
scheduledDate
timezone
fromName
}
}
Variables
{
"group": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"archive": false,
"keyword": "xyz789",
"limit": 123,
"offset": 123,
"orderBy": [{"column": "createdAt", "order": "DESC"}]
}
Response
{
"data": {
"invitationsCampaigns": [
{
"id": 123,
"guid": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"group": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"name": "xyz789",
"description": "abc123",
"accessCode": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"isSent": true,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"createdBy": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"updatedBy": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"template": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"archive": false,
"sendingLog": {},
"scheduledDate": "2007-12-03T10:15:30Z",
"timezone": "xyz789",
"fromName": "abc123"
}
]
}
}
invitationsCampaignsCount
Description
Get count of Invitations Campaigns by parameters.
Response
Returns a Float!
Example
Query
query invitationsCampaignsCount(
$group: GUID!,
$archive: Boolean,
$keyword: String
) {
invitationsCampaignsCount(
group: $group,
archive: $archive,
keyword: $keyword
)
}
Variables
{
"group": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"archive": true,
"keyword": "abc123"
}
Response
{"data": {"invitationsCampaignsCount": 123.45}}
invitationsCount
Description
Get count of Invitations by parameters.
Response
Returns a Float!
Arguments
| Name | Description |
|---|---|
group - GUID!
|
|
campaign - GUID
|
|
archive - Boolean
|
Filter based on Invitation Campaign and Invitation archive values. |
keyword - String
|
|
status - [InvitationStatus!]
|
Example
Query
query invitationsCount(
$group: GUID!,
$campaign: GUID,
$archive: Boolean,
$keyword: String,
$status: [InvitationStatus!]
) {
invitationsCount(
group: $group,
campaign: $campaign,
archive: $archive,
keyword: $keyword,
status: $status
)
}
Variables
{
"group": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"campaign": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"archive": true,
"keyword": "xyz789",
"status": ["pending"]
}
Response
{"data": {"invitationsCount": 123.45}}
person
Description
Get the Person by guid.
Example
Query
query person($guid: GUID!) {
person(guid: $guid) {
guid
primaryEmail
alternativeEmails {
...PersonEmailFragment
}
}
}
Variables
{
"guid": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc"
}
Response
{
"data": {
"person": {
"guid": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"primaryEmail": "test@test.com",
"alternativeEmails": [PersonEmail]
}
}
}
personExperienceModules
Description
Get the list of Person Experiences Modules details by parameters (Example: for Cover module, we get the link to pdf, Hold & Release module can get not released.)
Response
Returns [PersonExperienceModule!]!
Arguments
| Name | Description |
|---|---|
person - GUID
|
|
personExperience - GUID
|
|
type - [PersonExperienceModulesType!]
|
|
cover - [GUID!]
|
|
released - Boolean
|
Example
Query
query personExperienceModules(
$person: GUID,
$personExperience: GUID,
$type: [PersonExperienceModulesType!],
$cover: [GUID!],
$released: Boolean
) {
personExperienceModules(
person: $person,
personExperience: $personExperience,
type: $type,
cover: $cover,
released: $released
) {
guid
person
personExperience
experience
experienceModule
type
startDate
endDate
status
data
pdf
}
}
Variables
{
"person": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"personExperience": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"type": ["action"],
"cover": [
"66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc"
],
"released": true
}
Response
{
"data": {
"personExperienceModules": [
{
"guid": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"person": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"personExperience": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"experience": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"experienceModule": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"type": "action",
"startDate": "2007-12-03T10:15:30Z",
"endDate": "2007-12-03T10:15:30Z",
"status": "completed",
"data": {},
"pdf": "http://www.test.com/"
}
]
}
}
personExperiences
Description
Get the list of Person Experiences by person guid.
Response
Returns [PersonExperience!]!
Arguments
| Name | Description |
|---|---|
person - GUID!
|
Example
Query
query personExperiences($person: GUID!) {
personExperiences(person: $person) {
guid
createdAt
updatedAt
completedAt
person
group
accessCode
experience
status
}
}
Variables
{
"person": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc"
}
Response
{
"data": {
"personExperiences": [
{
"guid": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"completedAt": "2007-12-03T10:15:30Z",
"person": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"group": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"accessCode": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"experience": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"status": "incomplete"
}
]
}
}
persons
Description
Get the list of persons by email.
Response
Returns [Person!]!
Arguments
| Name | Description |
|---|---|
email - EmailAddress!
|
Example
Query
query persons($email: EmailAddress!) {
persons(email: $email) {
guid
primaryEmail
alternativeEmails {
...PersonEmailFragment
}
}
}
Variables
{"email": "test@test.com"}
Response
{
"data": {
"persons": [
{
"guid": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"primaryEmail": "test@test.com",
"alternativeEmails": [PersonEmail]
}
]
}
}
scorings
Description
Get the list of Scorings by parameters.
Response
Returns [Scoring!]!
Arguments
| Name | Description |
|---|---|
keyword - String!
|
Example
Query
query scorings($keyword: String!) {
scorings(keyword: $keyword) {
guid
name
version
}
}
Variables
{"keyword": "xyz789"}
Response
{
"data": {
"scorings": [
{
"guid": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"name": "xyz789",
"version": "abc123"
}
]
}
}
Mutations
createInvitation
Description
Create the new Invitation.
Response
Returns an Invitation!
Arguments
| Name | Description |
|---|---|
data - CreateInvitationInput!
|
Example
Query
mutation createInvitation($data: CreateInvitationInput!) {
createInvitation(data: $data) {
id
guid
group
campaign
email
data {
...InvitationRecipientObjectFragment
}
status
createdAt
person
appliedAt
personExperience
sendingLog
template
accessCode
updatedAt
createdBy
updatedBy
archive
scheduledDate
timezone
fromName
invitationsCampaign {
...InvitationsCampaignFragment
}
}
}
Variables
{"data": CreateInvitationInput}
Response
{
"data": {
"createInvitation": {
"id": 987,
"guid": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"group": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"campaign": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"email": "test@test.com",
"data": InvitationRecipientObject,
"status": "pending",
"createdAt": "2007-12-03T10:15:30Z",
"person": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"appliedAt": "2007-12-03T10:15:30Z",
"personExperience": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"sendingLog": {},
"template": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"accessCode": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"updatedAt": "2007-12-03T10:15:30Z",
"createdBy": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"updatedBy": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"archive": false,
"scheduledDate": "2007-12-03T10:15:30Z",
"timezone": "abc123",
"fromName": "xyz789",
"invitationsCampaign": InvitationsCampaign
}
}
}
createInvitationsCampaign
Description
Create the new Invitations Campaign.
Response
Returns an InvitationsCampaign!
Arguments
| Name | Description |
|---|---|
data - CreateInvitationsCampaignInput!
|
Example
Query
mutation createInvitationsCampaign($data: CreateInvitationsCampaignInput!) {
createInvitationsCampaign(data: $data) {
id
guid
group
name
description
accessCode
isSent
createdAt
updatedAt
createdBy
updatedBy
template
archive
sendingLog
scheduledDate
timezone
fromName
}
}
Variables
{"data": CreateInvitationsCampaignInput}
Response
{
"data": {
"createInvitationsCampaign": {
"id": 987,
"guid": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"group": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"name": "xyz789",
"description": "xyz789",
"accessCode": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"isSent": false,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"createdBy": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"updatedBy": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"template": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"archive": true,
"sendingLog": {},
"scheduledDate": "2007-12-03T10:15:30Z",
"timezone": "xyz789",
"fromName": "abc123"
}
}
}
createInvitationsCampaignTemplate
Description
Create the new Invitations Campaign Template.
Response
Returns an InvitationsCampaignTemplate!
Arguments
| Name | Description |
|---|---|
data - CreateInvitationsCampaignTemplateInput!
|
Example
Query
mutation createInvitationsCampaignTemplate($data: CreateInvitationsCampaignTemplateInput!) {
createInvitationsCampaignTemplate(data: $data) {
id
guid
name
language
subject
body
createdAt
updatedAt
default
group
createdBy
updatedBy
}
}
Variables
{"data": CreateInvitationsCampaignTemplateInput}
Response
{
"data": {
"createInvitationsCampaignTemplate": {
"id": 123,
"guid": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"name": "abc123",
"language": "EN_US",
"subject": "abc123",
"body": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"default": false,
"group": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"createdBy": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"updatedBy": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc"
}
}
}
deleteInvitation
Description
Delete the Invitation by guid.
Response
Returns an Invitation!
Arguments
| Name | Description |
|---|---|
guid - GUID!
|
Example
Query
mutation deleteInvitation($guid: GUID!) {
deleteInvitation(guid: $guid) {
id
guid
group
campaign
email
data {
...InvitationRecipientObjectFragment
}
status
createdAt
person
appliedAt
personExperience
sendingLog
template
accessCode
updatedAt
createdBy
updatedBy
archive
scheduledDate
timezone
fromName
invitationsCampaign {
...InvitationsCampaignFragment
}
}
}
Variables
{
"guid": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc"
}
Response
{
"data": {
"deleteInvitation": {
"id": 123,
"guid": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"group": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"campaign": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"email": "test@test.com",
"data": InvitationRecipientObject,
"status": "pending",
"createdAt": "2007-12-03T10:15:30Z",
"person": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"appliedAt": "2007-12-03T10:15:30Z",
"personExperience": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"sendingLog": {},
"template": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"accessCode": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"updatedAt": "2007-12-03T10:15:30Z",
"createdBy": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"updatedBy": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"archive": true,
"scheduledDate": "2007-12-03T10:15:30Z",
"timezone": "abc123",
"fromName": "xyz789",
"invitationsCampaign": InvitationsCampaign
}
}
}
deleteInvitationsCampaign
Description
Delete the Invitations Campaign by guid.
Response
Returns an InvitationsCampaign
Arguments
| Name | Description |
|---|---|
guid - GUID!
|
Example
Query
mutation deleteInvitationsCampaign($guid: GUID!) {
deleteInvitationsCampaign(guid: $guid) {
id
guid
group
name
description
accessCode
isSent
createdAt
updatedAt
createdBy
updatedBy
template
archive
sendingLog
scheduledDate
timezone
fromName
}
}
Variables
{
"guid": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc"
}
Response
{
"data": {
"deleteInvitationsCampaign": {
"id": 123,
"guid": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"group": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"name": "abc123",
"description": "xyz789",
"accessCode": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"isSent": false,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"createdBy": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"updatedBy": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"template": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"archive": false,
"sendingLog": {},
"scheduledDate": "2007-12-03T10:15:30Z",
"timezone": "xyz789",
"fromName": "xyz789"
}
}
}
deleteInvitationsCampaignTemplate
Description
Delete the Invitations Campaign Template by guid.
Response
Returns an InvitationsCampaignTemplate
Arguments
| Name | Description |
|---|---|
guid - GUID!
|
Example
Query
mutation deleteInvitationsCampaignTemplate($guid: GUID!) {
deleteInvitationsCampaignTemplate(guid: $guid) {
id
guid
name
language
subject
body
createdAt
updatedAt
default
group
createdBy
updatedBy
}
}
Variables
{
"guid": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc"
}
Response
{
"data": {
"deleteInvitationsCampaignTemplate": {
"id": 123,
"guid": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"name": "xyz789",
"language": "EN_US",
"subject": "xyz789",
"body": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"default": false,
"group": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"createdBy": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"updatedBy": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc"
}
}
}
invitationTrigger
Description
Send/resend Invitation.
Example
Query
mutation invitationTrigger(
$guid: GUID!,
$template: GUID
) {
invitationTrigger(
guid: $guid,
template: $template
)
}
Variables
{
"guid": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"template": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc"
}
Response
{"data": {"invitationTrigger": true}}
invitationsCampaignTrigger
Description
Send/resend Invitation Campaign.
Example
Query
mutation invitationsCampaignTrigger(
$guid: GUID!,
$template: GUID
) {
invitationsCampaignTrigger(
guid: $guid,
template: $template
)
}
Variables
{
"guid": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"template": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc"
}
Response
{"data": {"invitationsCampaignTrigger": false}}
personExperienceModulesRelease
Description
Release Hold & Release modules by guids.
Response
Returns [PersonExperienceModule!]!
Arguments
| Name | Description |
|---|---|
module - [GUID!]!
|
Example
Query
mutation personExperienceModulesRelease($module: [GUID!]!) {
personExperienceModulesRelease(module: $module) {
guid
person
personExperience
experience
experienceModule
type
startDate
endDate
status
data
pdf
}
}
Variables
{
"module": [
"66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc"
]
}
Response
{
"data": {
"personExperienceModulesRelease": [
{
"guid": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"person": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"personExperience": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"experience": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"experienceModule": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"type": "action",
"startDate": "2007-12-03T10:15:30Z",
"endDate": "2007-12-03T10:15:30Z",
"status": "completed",
"data": {},
"pdf": "http://www.test.com/"
}
]
}
}
updateInvitation
Description
Update the Invitation.
Response
Returns an Invitation!
Arguments
| Name | Description |
|---|---|
data - UpdateInvitationInput!
|
Example
Query
mutation updateInvitation($data: UpdateInvitationInput!) {
updateInvitation(data: $data) {
id
guid
group
campaign
email
data {
...InvitationRecipientObjectFragment
}
status
createdAt
person
appliedAt
personExperience
sendingLog
template
accessCode
updatedAt
createdBy
updatedBy
archive
scheduledDate
timezone
fromName
invitationsCampaign {
...InvitationsCampaignFragment
}
}
}
Variables
{"data": UpdateInvitationInput}
Response
{
"data": {
"updateInvitation": {
"id": 123,
"guid": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"group": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"campaign": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"email": "test@test.com",
"data": InvitationRecipientObject,
"status": "pending",
"createdAt": "2007-12-03T10:15:30Z",
"person": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"appliedAt": "2007-12-03T10:15:30Z",
"personExperience": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"sendingLog": {},
"template": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"accessCode": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"updatedAt": "2007-12-03T10:15:30Z",
"createdBy": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"updatedBy": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"archive": false,
"scheduledDate": "2007-12-03T10:15:30Z",
"timezone": "abc123",
"fromName": "xyz789",
"invitationsCampaign": InvitationsCampaign
}
}
}
updateInvitationsCampaign
Description
Update the Invitations Campaign.
Response
Returns an InvitationsCampaign
Arguments
| Name | Description |
|---|---|
data - UpdateInvitationsCampaignInput!
|
Example
Query
mutation updateInvitationsCampaign($data: UpdateInvitationsCampaignInput!) {
updateInvitationsCampaign(data: $data) {
id
guid
group
name
description
accessCode
isSent
createdAt
updatedAt
createdBy
updatedBy
template
archive
sendingLog
scheduledDate
timezone
fromName
}
}
Variables
{"data": UpdateInvitationsCampaignInput}
Response
{
"data": {
"updateInvitationsCampaign": {
"id": 987,
"guid": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"group": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"name": "xyz789",
"description": "abc123",
"accessCode": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"isSent": true,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"createdBy": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"updatedBy": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"template": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"archive": false,
"sendingLog": {},
"scheduledDate": "2007-12-03T10:15:30Z",
"timezone": "abc123",
"fromName": "xyz789"
}
}
}
updateInvitationsCampaignTemplate
Description
Update the Invitations Campaign Template.
Response
Returns an InvitationsCampaignTemplate
Arguments
| Name | Description |
|---|---|
data - UpdateInvitationsCampaignTemplateInput!
|
Example
Query
mutation updateInvitationsCampaignTemplate($data: UpdateInvitationsCampaignTemplateInput!) {
updateInvitationsCampaignTemplate(data: $data) {
id
guid
name
language
subject
body
createdAt
updatedAt
default
group
createdBy
updatedBy
}
}
Variables
{"data": UpdateInvitationsCampaignTemplateInput}
Response
{
"data": {
"updateInvitationsCampaignTemplate": {
"id": 123,
"guid": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"name": "abc123",
"language": "EN_US",
"subject": "xyz789",
"body": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"default": true,
"group": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"createdBy": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"updatedBy": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc"
}
}
}
Types
AccessCode
Example
{
"guid": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"name": "abc123",
"code": "xyz789",
"usageCount": 123.45,
"status": "active",
"createdAt": "2007-12-03T10:15:30Z",
"group": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"experience": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"archive": true,
"description": "xyz789",
"limitStartDate": "2007-12-03T10:15:30Z",
"limitEndDate": "2007-12-03T10:15:30Z",
"limitMaxUses": 123
}
AccessCodeListItem
Example
{
"guid": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"name": "xyz789",
"code": "xyz789",
"usageCount": 123.45,
"status": "active",
"createdAt": "2007-12-03T10:15:30Z",
"group": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"experience": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"archive": false
}
AccessCodeStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"active"
AnswerByGuidInput
AnswerInput
Assessment
Example
{
"guid": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"type": "xyz789",
"name": {},
"description": "xyz789",
"version": "xyz789",
"date": "2007-12-03T10:15:30Z",
"family": "assessment"
}
AssessmentFamily
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"assessment"
AssessmentResult
Example
{
"guid": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"person": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"createdAt": "2007-12-03T10:15:30Z",
"completedAt": "2007-12-03T10:15:30Z",
"status": "incomplete",
"assessment": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"personExperienceModule": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"answers": {},
"assessmentType": "xyz789",
"scores": {},
"feedback": {}
}
AssessmentResultListItem
Example
{
"guid": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"person": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"createdAt": "2007-12-03T10:15:30Z",
"completedAt": "2007-12-03T10:15:30Z",
"status": "incomplete",
"assessment": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc"
}
AssessmentResultStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"incomplete"
Boolean
Description
The Boolean scalar type represents true or false.
Example
true
CalculateScoresResult
Covers
Example
{
"guid": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"contentBook": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"name": "abc123",
"translations": {},
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"version": "xyz789",
"defaultAllowShare": false,
"defaultNorms": ["xyz789"],
"defaultDependency": ["abc123"],
"retakeDays": 987,
"dependencies": {}
}
Cpi260cfrNorms
Fields
| Input Field | Description |
|---|---|
sd_Ac - Float!
|
|
sd_Ai - Float!
|
|
sd_Cf - Float!
|
|
sd_Cm - Float!
|
|
sd_Cs - Float!
|
|
sd_Ct - Float!
|
|
sd_Do - Float!
|
|
sd_Em - Float!
|
|
sd_Fx - Float!
|
|
sd_Gi - Float!
|
|
sd_In - Float!
|
|
sd_Is - Float!
|
|
sd_Lp - Float!
|
|
sd_Mp - Float!
|
|
sd_Re - Float!
|
|
sd_Sa - Float!
|
|
sd_Sc - Float!
|
|
sd_Sn - Float!
|
|
sd_So - Float!
|
|
sd_Sp - Float!
|
|
sd_Sy - Float!
|
|
sd_To - Float!
|
|
sd_Wb - Float!
|
|
sd_Wo - Float!
|
|
sd_v1 - Float!
|
|
sd_v2 - Float!
|
|
sd_v3 - Float!
|
|
type1 - Float!
|
|
type2 - Float!
|
|
type3 - Float!
|
|
type4 - Float!
|
|
level1 - Float!
|
|
level2 - Float!
|
|
level3 - Float!
|
|
level4 - Float!
|
|
level5 - Float!
|
|
level6 - Float!
|
|
level7 - Float!
|
|
p25_Ac - Float!
|
|
p25_Ai - Float!
|
|
p25_Cf - Float!
|
|
p25_Cm - Float!
|
|
p25_Cs - Float!
|
|
p25_Ct - Float!
|
|
p25_Do - Float!
|
|
p25_Em - Float!
|
|
p25_Fx - Float!
|
|
p25_Gi - Float!
|
|
p25_In - Float!
|
|
p25_Is - Float!
|
|
p25_Lp - Float!
|
|
p25_Mp - Float!
|
|
p25_Re - Float!
|
|
p25_Sa - Float!
|
|
p25_Sc - Float!
|
|
p25_Sn - Float!
|
|
p25_So - Float!
|
|
p25_Sp - Float!
|
|
p25_Sy - Float!
|
|
p25_To - Float!
|
|
p25_Wb - Float!
|
|
p25_Wo - Float!
|
|
p25_v1 - Float!
|
|
p25_v2 - Float!
|
|
p25_v3 - Float!
|
|
p50_Ac - Float!
|
|
p50_Ai - Float!
|
|
p50_Cf - Float!
|
|
p50_Cm - Float!
|
|
p50_Cs - Float!
|
|
p50_Ct - Float!
|
|
p50_Do - Float!
|
|
p50_Em - Float!
|
|
p50_Fx - Float!
|
|
p50_Gi - Float!
|
|
p50_In - Float!
|
|
p50_Is - Float!
|
|
p50_Lp - Float!
|
|
p50_Mp - Float!
|
|
p50_Re - Float!
|
|
p50_Sa - Float!
|
|
p50_Sc - Float!
|
|
p50_Sn - Float!
|
|
p50_So - Float!
|
|
p50_Sp - Float!
|
|
p50_Sy - Float!
|
|
p50_To - Float!
|
|
p50_Wb - Float!
|
|
p50_Wo - Float!
|
|
p50_v1 - Float!
|
|
p50_v2 - Float!
|
|
p50_v3 - Float!
|
|
p75_Ac - Float!
|
|
p75_Ai - Float!
|
|
p75_Cf - Float!
|
|
p75_Cm - Float!
|
|
p75_Cs - Float!
|
|
p75_Ct - Float!
|
|
p75_Do - Float!
|
|
p75_Em - Float!
|
|
p75_Fx - Float!
|
|
p75_Gi - Float!
|
|
p75_In - Float!
|
|
p75_Is - Float!
|
|
p75_Lp - Float!
|
|
p75_Mp - Float!
|
|
p75_Re - Float!
|
|
p75_Sa - Float!
|
|
p75_Sc - Float!
|
|
p75_Sn - Float!
|
|
p75_So - Float!
|
|
p75_Sp - Float!
|
|
p75_Sy - Float!
|
|
p75_To - Float!
|
|
p75_Wb - Float!
|
|
p75_Wo - Float!
|
|
p75_v1 - Float!
|
|
p75_v2 - Float!
|
|
p75_v3 - Float!
|
|
sd_Ami - Float!
|
|
sd_Leo - Float!
|
|
mean_Ac - Float!
|
|
mean_Ai - Float!
|
|
mean_Cf - Float!
|
|
mean_Cm - Float!
|
|
mean_Cs - Float!
|
|
mean_Ct - Float!
|
|
mean_Do - Float!
|
|
mean_Em - Float!
|
|
mean_Fx - Float!
|
|
mean_Gi - Float!
|
|
mean_In - Float!
|
|
mean_Is - Float!
|
|
mean_Lp - Float!
|
|
mean_Mp - Float!
|
|
mean_Re - Float!
|
|
mean_Sa - Float!
|
|
mean_Sc - Float!
|
|
mean_Sn - Float!
|
|
mean_So - Float!
|
|
mean_Sp - Float!
|
|
mean_Sy - Float!
|
|
mean_To - Float!
|
|
mean_Wb - Float!
|
|
mean_Wo - Float!
|
|
mean_v1 - Float!
|
|
mean_v2 - Float!
|
|
mean_v3 - Float!
|
|
p25_Ami - Float!
|
|
p25_Leo - Float!
|
|
p50_Ami - Float!
|
|
p50_Leo - Float!
|
|
p75_Ami - Float!
|
|
p75_Leo - Float!
|
|
mean_Ami - Float!
|
|
mean_Leo - Float!
|
|
NormSampleDescription - String!
|
Example
{
"sd_Ac": 987.65,
"sd_Ai": 123.45,
"sd_Cf": 123.45,
"sd_Cm": 123.45,
"sd_Cs": 123.45,
"sd_Ct": 987.65,
"sd_Do": 987.65,
"sd_Em": 123.45,
"sd_Fx": 987.65,
"sd_Gi": 987.65,
"sd_In": 987.65,
"sd_Is": 987.65,
"sd_Lp": 987.65,
"sd_Mp": 987.65,
"sd_Re": 987.65,
"sd_Sa": 123.45,
"sd_Sc": 987.65,
"sd_Sn": 987.65,
"sd_So": 987.65,
"sd_Sp": 987.65,
"sd_Sy": 987.65,
"sd_To": 123.45,
"sd_Wb": 123.45,
"sd_Wo": 123.45,
"sd_v1": 987.65,
"sd_v2": 123.45,
"sd_v3": 123.45,
"type1": 123.45,
"type2": 123.45,
"type3": 123.45,
"type4": 987.65,
"level1": 123.45,
"level2": 987.65,
"level3": 987.65,
"level4": 123.45,
"level5": 123.45,
"level6": 987.65,
"level7": 123.45,
"p25_Ac": 123.45,
"p25_Ai": 987.65,
"p25_Cf": 987.65,
"p25_Cm": 987.65,
"p25_Cs": 123.45,
"p25_Ct": 987.65,
"p25_Do": 987.65,
"p25_Em": 123.45,
"p25_Fx": 987.65,
"p25_Gi": 987.65,
"p25_In": 987.65,
"p25_Is": 987.65,
"p25_Lp": 123.45,
"p25_Mp": 123.45,
"p25_Re": 123.45,
"p25_Sa": 987.65,
"p25_Sc": 987.65,
"p25_Sn": 123.45,
"p25_So": 123.45,
"p25_Sp": 123.45,
"p25_Sy": 123.45,
"p25_To": 987.65,
"p25_Wb": 987.65,
"p25_Wo": 987.65,
"p25_v1": 987.65,
"p25_v2": 987.65,
"p25_v3": 987.65,
"p50_Ac": 987.65,
"p50_Ai": 987.65,
"p50_Cf": 987.65,
"p50_Cm": 987.65,
"p50_Cs": 987.65,
"p50_Ct": 123.45,
"p50_Do": 123.45,
"p50_Em": 123.45,
"p50_Fx": 123.45,
"p50_Gi": 123.45,
"p50_In": 123.45,
"p50_Is": 987.65,
"p50_Lp": 987.65,
"p50_Mp": 123.45,
"p50_Re": 987.65,
"p50_Sa": 123.45,
"p50_Sc": 123.45,
"p50_Sn": 123.45,
"p50_So": 987.65,
"p50_Sp": 123.45,
"p50_Sy": 987.65,
"p50_To": 123.45,
"p50_Wb": 123.45,
"p50_Wo": 987.65,
"p50_v1": 987.65,
"p50_v2": 123.45,
"p50_v3": 987.65,
"p75_Ac": 123.45,
"p75_Ai": 987.65,
"p75_Cf": 987.65,
"p75_Cm": 987.65,
"p75_Cs": 123.45,
"p75_Ct": 123.45,
"p75_Do": 987.65,
"p75_Em": 987.65,
"p75_Fx": 123.45,
"p75_Gi": 987.65,
"p75_In": 123.45,
"p75_Is": 123.45,
"p75_Lp": 123.45,
"p75_Mp": 987.65,
"p75_Re": 987.65,
"p75_Sa": 987.65,
"p75_Sc": 987.65,
"p75_Sn": 123.45,
"p75_So": 123.45,
"p75_Sp": 987.65,
"p75_Sy": 987.65,
"p75_To": 987.65,
"p75_Wb": 987.65,
"p75_Wo": 123.45,
"p75_v1": 123.45,
"p75_v2": 123.45,
"p75_v3": 987.65,
"sd_Ami": 987.65,
"sd_Leo": 987.65,
"mean_Ac": 123.45,
"mean_Ai": 987.65,
"mean_Cf": 987.65,
"mean_Cm": 123.45,
"mean_Cs": 123.45,
"mean_Ct": 123.45,
"mean_Do": 987.65,
"mean_Em": 123.45,
"mean_Fx": 987.65,
"mean_Gi": 123.45,
"mean_In": 987.65,
"mean_Is": 987.65,
"mean_Lp": 987.65,
"mean_Mp": 987.65,
"mean_Re": 987.65,
"mean_Sa": 123.45,
"mean_Sc": 987.65,
"mean_Sn": 123.45,
"mean_So": 987.65,
"mean_Sp": 987.65,
"mean_Sy": 123.45,
"mean_To": 987.65,
"mean_Wb": 123.45,
"mean_Wo": 987.65,
"mean_v1": 987.65,
"mean_v2": 987.65,
"mean_v3": 987.65,
"p25_Ami": 123.45,
"p25_Leo": 123.45,
"p50_Ami": 987.65,
"p50_Leo": 123.45,
"p75_Ami": 123.45,
"p75_Leo": 123.45,
"mean_Ami": 123.45,
"mean_Leo": 987.65,
"NormSampleDescription": "xyz789"
}
CreateInvitationInput
Fields
| Input Field | Description |
|---|---|
group - GUID!
|
|
accessCode - GUID
|
|
template - GUID
|
|
scheduledDate - DateTime
|
|
timezone - String
|
|
fromName - String
|
|
campaign - GUID
|
|
email - EmailAddress!
|
|
data - InvitationRecipientInput!
|
|
archive - Boolean!
|
Example
{
"group": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"accessCode": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"template": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"scheduledDate": "2007-12-03T10:15:30Z",
"timezone": "xyz789",
"fromName": "xyz789",
"campaign": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"email": "test@test.com",
"data": InvitationRecipientInput,
"archive": true
}
CreateInvitationsCampaignInput
Example
{
"group": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"accessCode": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"template": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"scheduledDate": "2007-12-03T10:15:30Z",
"timezone": "abc123",
"fromName": "abc123",
"name": "abc123",
"description": "abc123",
"createdBy": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"updatedBy": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc"
}
CreateInvitationsCampaignTemplateInput
DateTime
Description
A date-time string at UTC, such as 2019-12-03T09:54:33Z, compliant with the date-time format.
Example
"2007-12-03T10:15:30Z"
EmailAddress
Description
An email address
Example
"test@test.com"
Float
Description
The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.
Example
987.65
GUID
Description
A globally unique identifier version 4
Example
"66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc"
GenerateReportResult
Fields
| Field Name | Description |
|---|---|
url - URL!
|
Example
{"url": "http://www.test.com/"}
Int
Description
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
987
Invitation
Fields
| Field Name | Description |
|---|---|
id - Int!
|
|
guid - GUID!
|
|
group - GUID!
|
|
campaign - GUID
|
|
email - EmailAddress!
|
|
data - InvitationRecipientObject!
|
|
status - InvitationStatus!
|
|
createdAt - DateTime!
|
|
person - GUID
|
|
appliedAt - DateTime
|
|
personExperience - GUID
|
|
sendingLog - JSON!
|
|
template - GUID
|
|
accessCode - GUID
|
|
updatedAt - DateTime!
|
|
createdBy - GUID
|
|
updatedBy - GUID
|
|
archive - Boolean!
|
|
scheduledDate - DateTime
|
|
timezone - String
|
|
fromName - String
|
|
invitationsCampaign - InvitationsCampaign
|
Example
{
"id": 123,
"guid": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"group": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"campaign": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"email": "test@test.com",
"data": InvitationRecipientObject,
"status": "pending",
"createdAt": "2007-12-03T10:15:30Z",
"person": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"appliedAt": "2007-12-03T10:15:30Z",
"personExperience": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"sendingLog": {},
"template": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"accessCode": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"updatedAt": "2007-12-03T10:15:30Z",
"createdBy": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"updatedBy": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"archive": true,
"scheduledDate": "2007-12-03T10:15:30Z",
"timezone": "xyz789",
"fromName": "abc123",
"invitationsCampaign": InvitationsCampaign
}
InvitationRecipientInput
Example
{
"personEmail": "test@test.com",
"personFirstName": "abc123",
"personLastName": "abc123",
"city": "xyz789",
"state": "abc123",
"country": "abc123",
"street1": "xyz789",
"street2": "abc123",
"zipCode": "abc123"
}
InvitationRecipientObject
Example
{
"personEmail": "test@test.com",
"personFirstName": "abc123",
"personLastName": "xyz789",
"city": "abc123",
"state": "xyz789",
"country": "xyz789",
"street1": "abc123",
"street2": "abc123",
"zipCode": "abc123"
}
InvitationStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"pending"
InvitationsCampaign
Fields
| Field Name | Description |
|---|---|
id - Int!
|
|
guid - GUID!
|
|
group - GUID!
|
|
name - String!
|
|
description - String!
|
|
accessCode - GUID!
|
|
isSent - Boolean!
|
|
createdAt - DateTime!
|
|
updatedAt - DateTime!
|
|
createdBy - GUID!
|
|
updatedBy - GUID!
|
|
template - GUID!
|
|
archive - Boolean!
|
|
sendingLog - JSON!
|
|
scheduledDate - DateTime
|
|
timezone - String
|
|
fromName - String
|
Example
{
"id": 123,
"guid": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"group": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"name": "abc123",
"description": "xyz789",
"accessCode": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"isSent": true,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"createdBy": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"updatedBy": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"template": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"archive": true,
"sendingLog": {},
"scheduledDate": "2007-12-03T10:15:30Z",
"timezone": "abc123",
"fromName": "xyz789"
}
InvitationsCampaignTemplate
Example
{
"id": 123,
"guid": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"name": "xyz789",
"language": "EN_US",
"subject": "xyz789",
"body": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"default": true,
"group": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"createdBy": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"updatedBy": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc"
}
InvitationsCampaignTemplatesOrderByArgs
Fields
| Input Field | Description |
|---|---|
column - String!
|
|
order - OrderDirection
|
Example
{"column": "xyz789", "order": "DESC"}
InvitationsCampaignsOrderByArgs
Fields
| Input Field | Description |
|---|---|
column - String!
|
|
order - OrderDirection
|
Example
{"column": "xyz789", "order": "DESC"}
InvitationsOrderByArgs
Fields
| Input Field | Description |
|---|---|
column - String!
|
|
order - OrderDirection
|
Example
{"column": "xyz789", "order": "DESC"}
JSON
Description
The JSON scalar type represents JSON values as specified by ECMA-404.
Example
{}
Language
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"EN_US"
OrderDirection
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"DESC"
Person
Fields
| Field Name | Description |
|---|---|
guid - GUID!
|
|
primaryEmail - EmailAddress!
|
|
alternativeEmails - [PersonEmail!]!
|
Example
{
"guid": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"primaryEmail": "test@test.com",
"alternativeEmails": [PersonEmail]
}
PersonEmail
Fields
| Field Name | Description |
|---|---|
personEntry - Person!
|
|
email - EmailAddress!
|
|
id - Float!
|
|
approved - Boolean!
|
Example
{
"personEntry": Person,
"email": "test@test.com",
"id": 123.45,
"approved": false
}
PersonExperience
Example
{
"guid": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"completedAt": "2007-12-03T10:15:30Z",
"person": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"group": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"accessCode": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"experience": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"status": "incomplete"
}
PersonExperienceModule
Example
{
"guid": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"person": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"personExperience": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"experience": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"experienceModule": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"type": "action",
"startDate": "2007-12-03T10:15:30Z",
"endDate": "2007-12-03T10:15:30Z",
"status": "completed",
"data": {},
"pdf": "http://www.test.com/"
}
PersonExperienceModulesStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"completed"
PersonExperienceModulesType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"action"
PersonExperiencesStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"incomplete"
ReportContentVariables
Example
{
"firstName": "abc123",
"lastName": "abc123",
"email": "test@test.com",
"clientId": "xyz789",
"completedDate": "2007-12-03T10:15:30Z",
"occupationUrl": "http://www.test.com/",
"majorUrl": "http://www.test.com/",
"counselorName": "abc123",
"companyInitials": "xyz789",
"companyName": "abc123",
"cpi260cfrNorms": Cpi260cfrNorms
}
ReportType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"PDF"
ScoreInput
Fields
| Input Field | Description |
|---|---|
scores - JSON!
|
Example
{"scores": {}}
Scoring
String
Description
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Example
"xyz789"
URL
Description
A URL address
Example
"http://www.test.com/"
UpdateInvitationInput
Example
{
"group": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"accessCode": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"template": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"scheduledDate": "2007-12-03T10:15:30Z",
"timezone": "abc123",
"fromName": "abc123",
"campaign": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"email": "test@test.com",
"data": InvitationRecipientInput,
"archive": true,
"guid": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc"
}
UpdateInvitationsCampaignInput
Example
{
"group": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"accessCode": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"template": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"scheduledDate": "2007-12-03T10:15:30Z",
"timezone": "xyz789",
"fromName": "abc123",
"name": "abc123",
"description": "xyz789",
"createdBy": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"updatedBy": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"guid": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc"
}
UpdateInvitationsCampaignTemplateInput
Example
{
"name": "xyz789",
"language": "EN_US",
"subject": "abc123",
"body": "xyz789",
"group": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc",
"guid": "66c4bd1a-3e2e-4dfb-a17a-04c7997bcddc"
}