Post on 17-Feb-2022
transcript
SUPERSUDS
password123
b6e60bfb08994be79e17e35656e3246e
SUPERSUDS:password123b6e60bfb08994be79e17e35656e3246e
U1VQRVJTVURTOnBhc3N3b3JkMTIzYjZlNjBiZmIwODk5NGJlNzllMTdlMzU2NTZlMzI0NmU=
Authorization: Basic U1VQRVJTVURTOnBhc3N3b3JkMTIzYjZlNjBiZmIwODk5NGJlNzllMTdlMzU2NTZlMzI0NmU=
ms5TfennfWBaetfXyd6xfcscYbo739Wc
ms5TfennfWBaetfXyd6xfcscYbo739Wc:x
bXM1VGZlbm5mV0JhZXRmWHlkNnhmY3NjWWJvNzM5V2M6eA==
Authorization: Basic bXM1VGZlbm5mV0JhZXRmWHlkNnhmY3NjWWJvNzM5V2M6eA==
Accept: application/vnd.ingeniousgroup.testcraftapi-v1+json
{brillium_base_uri}/api/Accounts?page=2&pagesize=100
{brillium_base_uri}/api/Respondents?from=2019-01-01&thru=2019-01-31
•
•
•
•
•
Content-Type: application/json
{ "Assessments": [ { "Id": "MATH101", "AccountId": "SUPERSUDS", "Name": "Math 101", "Password": "******", "Anonymous": "No", . . . "DateCreated": "2008-11-03T14:14:00-05:00", "DateModified": "2008-11-03T17:15:34-05:00",
"Uri": "http:\/\/supersuds.brillium.com\/api\/Assessments\/MATH101", "RelatedUris": { "QuestionGroups": "http:\/\/supersuds.brillium.com\/api\/Assessments\/MATH101\/QuestionGroups", "Questions": "http:\/\/supersuds.brillium.com\/api\/Assessments\/MATH101\/Questions", . . . } } ], "Page": 1, "PageSize": 50, "TotalCount": 1, "HasMore": false }
{ "<Items>": [{}], "Page": 1, "PageSize": 50, "TotalCount": 123, "HasMore": true }
•
•
•
•
•
Id
ParentAccountId
Password
Name
ContactName
ContactTitle
ContactAddress1
ContactAddress2
ContactAddress3
ContactCity
ContactState
ContactPostalCode
ContactCountry
ContactPhone
ContactFax
ContactEmail
DateCreated
DateModified
DateExpired
Uri
RelatedUris
{brillium_base_uri}/api/Accounts/{account_id}
{brillium_base_uri}/api/Accounts
{brillium_base_uri}/api/Accounts/{account_id}/Children
{brillium_base_uri}/api/Accounts/{account_id}/Assessments
{brillium_base_uri}/api/Accounts/{account_id}/Respondents
{brillium_base_uri}/api/Accounts/{account_id}/ EmailTemplates
GET https://supersuds.brillium.com/api/Accounts/SUPERSUDS
{ "Accounts": [ { "Id": "SUPERSUDS", "ParentAccountId": "", "Password": "******", "Name": "Supersuds Corporation", "ContactName": "John Doe", "ContactTitle": "Instructional Designer", "ContactAddress1": "1234 Main Street", "ContactAddress2": "", "ContactAddress3": "", "ContactCity": "Anytown", "ContactState": "NY", "ContactPostalCode": "01234", "ContactCountry": "USA", "ContactPhone": "888-555-1235", "ContactFax": "888-555-2345", "ContactEmail": "john.doe@supersuds.com", "DateCreated": "2002-02-21T00:00:00-05:00", "DateModified": "2012-11-05T11:31:08-05:00", "DateExpired": "3000-12-31T00:00:00-05:00", "Uri": "http:\/\/supersuds.brillium.com\/api\/Accounts\/SUPERSUDS", "RelatedUris": { "Children": "http:\/\/supersuds.brillium.com\/api\/Accounts\/SUPERSUDS\/Children", "Assessments": "http:\/\/supersuds.brillium.com\/api\/Accounts\/SUPERSUDS\/Assessments", "Respondents": "http:\/\/supersuds.brillium.com\/api\/Accounts\/SUPERSUDS\/Respondents", "EmailTemplates": "http:\/\/supersuds.brillium.com\/api\/Accounts\/SUPERSUDS\/EmailTemplates" } } ], "Page": 1, "PageSize": 50, "TotalCount": 1, "HasMore": false }
Id
AccountId
Active
AllowPrintCopy
AllowRetakes
AllowSaveInfo
Anonymous
String The “Anonymous” property for an Assessment; No, YesWithoutCustomFields, YesWithCustomFields.
AnswersRequired
AppIntegration
CertificateId
CertificateIssued
DateCreated
DateEnd
DateModified
DateStart
ExplanationLabel
GroupPresentation
HoursBetweenRetakes
LogoUrl
LogoutButtonLabel
MaxRetakes
MD5Password
Mode
Name
NotifyNewResults
PassingScore
Password
PostLinkUrl
ProctorRequired
QuestionCount
QuestionsPerPage
RespondentCount
ResultSendMethod
ResultSendUrl
ScalePoints
TimeAllowed
ViewEmailResults
ViewScore
ViewReview
ViewReviewAnswers
ViewReviewQuestions
Uri
RelatedUris
{brillium_base_uri}/api/Assessments/{assessment_id}
{brillium_base_uri}/api/Assessments
{brillium_base_uri}/api/Assessments/{assessment_id}/Questions
{brillium_base_uri}/api/Assessments/{assessment_id}/QuestionGroups
{brillium_base_uri}/api/Assessments/{assessment_id}/Respondents
{brillium_base_uri}/api/Assessments/{assessment_id}/Respondents/{primary_key}
{brillium_base_uri}/api/Assessments/{assessment_id}/Incompletes
{brillium_base_uri}/api/Assessments/{assessment_id}/Invitations
{brillium_base_uri}/api/Assessments/{assessment_id}/Invitations/{email_address}
GET https://supersuds.brillium.com/api/Assessments
{ "Assessments": [ { "Id": "COURSE1123", "AccountId": "SUPERSUDS", "Name": "COURSE 1123 EXAM", "Password": "******", "Anonymous": "No", "Mode": "Normal", "Active": "Enabled",
"DateStart": "2000-01-01T04:00:00-05:00", "DateEnd": "3000-12-31T16:59:59-05:00", "QuestionCount": 14, "RespondentCount": 44, "PassingScore": 60, "ScalePoints": 0, "LogoUrl": "images\/BrilliumLogo_Demonstration.gif", "PostLinkUrl": "", "ResultSendMethod": "None", "ResultSendUrl": "", "AppIntegration": "None", "MD5Password": "", "LogoutButtonLabel": "Logout", "ExplanationLabel": "Reference", "ViewScore": "AllScores", "ViewReview": "Yes", "ViewReviewQuestions": "AllQuestions", "ViewReviewAnswers": "QuestionsAnswersExplanations", "ViewEmailResults": "Yes", "AllowRetakes": "YesToMaximum", "MaxRetakes": 999, "HoursBetweenRetakes": 0, "NotifyNewResults": "Yes", "GroupPresentation": "Sequential", "QuestionsPerPage": 1, "AnswersRequired": "SurveyTypeQuestions", "AllowSaveInfo": "Yes", "AllowPrintCopy": "Yes", "TimeAllowed": 0, "ProctorRequired": "No", "CertificateIssued": 0, "CertificateId": 0, "DateCreated": "2002-02-21T14:30:32-05:00", "DateModified": "2009-02-11T14:58:20-05:00", "Uri": "https:\/\/supersuds.brillium.com\/api\/Assessments\/COURSE1123", "RelatedUris": { "QuestionGroups": "https:\/\/supersuds.brillium.com\/api\/Assessments\/COURSE1123\/QuestionGroups", "Questions": "https:\/\/supersuds.brillium.com\/api\/Assessments\/COURSE1123\/Questions", "Respondents": "https:\/\/supersuds.brillium.com\/api\/Assessments\/COURSE1123\/Respondents", "Incompletes": "https:\/\/supersuds.brillium.com\/api\/Assessments\/COURSE1123\/Incompletes", "Invitations": "https:\/\/supersuds.brillium.com\/api\/Assessments\/COURSE1123\/Invitations" } } ], "Page": 1, "PageSize": 50, "TotalCount": 1, "HasMore": false }
Id
AssessId
BranchTarget
BranchType
DateCreated
DateModified
PassingRequirement
PassingScore
Name
QuestionPresentation
QuestionsToAsk
ReferenceId
ResourceUrl
Sequence
ShowOnSummary
StartNewPage
ViewDescriptionOnReview
Uri
RelatedUris
{brillium_base_uri}/api/QuestionGroups/{question_group_id}
{brillium_base_uri}/api/QuestionGroups/{question_group_id}/Questions
GET https://supersuds.brillium.com/api/QuestionGroups/149
{ "QuestionGroups": [ { "Id": 149, "AssessId": "COURSE1123", "ReferenceId": "", "Sequence": 1, "Name": "COURSE 1123 EXAM Questions", "QuestionPresentation": "Random", "QuestionsToAsk": 99999, "StartNewPage": "No", "PassingScore": 60, "PassingRequirement": "None", "ResourceUrl": "", "ViewDescriptionOnReview": "No", "ShowOnSummary": "None", "DateCreated": "2002-02-21T14:30:32-05:00", "DateModified": "2007-02-21T09:03:40-05:00", "BranchType": "NextQuestionGroup", "BranchTarget": "", "Uri": "https:\/\/supersuds.brillium.com\/api\/QuestionGroups\/149", "RelatedUris": { "Questions": "https:\/\/supersuds.brillium.com\/api\/QuestionGroups\/149\/Questions" } } ], "Page": 1, "PageSize": 50, "TotalCount": 1, "HasMore": false }
Id
AssessId
GroupId
OrigQuesId
AllowComments
AnswerPresentation
Answers
AuthorsNotes
CorrectExplanation
IncorrectExplaination
Points
ReferenceId
ResourceUrl
Sequence
Tags
Text
Type
Uri
RelatedUris
{brillium_base_uri}/api/Questions/{question_id}
{brillium_base_uri}/api/Questions/{question_id}/Results
{brillium_base_uri}/api/Questions/{question_id}/Comments
GET https://supersuds.brillium.com/api/Questions/10271
{ "Questions": [ { "Id": 10271, "AssessId": "COURSE1123", "GroupId": 149, "OrigQuesId": 0, "ReferenceId": "0", "Type": "MultipleChoice", "Sequence": 2, "Points": 1, "ResourceUrl": "", "AllowComments": "Yes", "AnswerPresentation": "Sequential", "Text": "What <B>geographic regions<\/B> currently prohibit the <STRONG>sales<\/STRONG> of the \"No-Suds\" and \"Color Stay Bleach\" products?", "CorrectExplanation": "North America. Currently, the EPA is in the process of reviewing the chemical agents used in the products, for use in home septic systems.", "IncorrectExplanation": "North America. Currently, the EPA is in the process of reviewing the chemical agents used in the products, for use in home septic systems.", "AuthorsNotes": "here are some author notes.", "Tags": [ "addition",
"testing", "subtraction" ], "Answers": [ ], "Uri": "http:\/\/supersuds.brillium.com\/api\/Questions\/10271", "RelatedUris": { "Results": "http:\/\/supersuds.brillium.com\/api\/Questions\/10271\/Results", "Comments": "http:\/\/supersuds.brillium.com\/api\/Questions\/10271\/Comments" } } ], "Page": 1, "PageSize": 50, "TotalCount": 1, "HasMore": false }
Id
AssessId
ProctorId
Attempt
CourseItemResultId
CreditUsed
Current
Custom[1–15]
DateFinished
DateReStarted
DateStarted
DemoMode
EarnedPoints
EssayCount
EssayPoints
FinalScore
FirstName
Guid
LastName
Page
PassFail
RawScore
ScalePoints
StatusCode
TimesTaken
TimeUsed
TotalPages
TotalPoints
Uri
RelatedUris
{brillium_base_uri}/api/Respondents/{respondent_id}
{brillium_base_uri}/api/Respondents/{respondent_id}/Results
{brillium_base_uri}/api/Respondents/{respondent_id}/Comments
{brillium_base_uri}/api/Respondents/{respondent_id}/Comments/{question_id}
{brillium_base_uri}/api/Respondents/{respondent_guid}/Guid
{brillium_base_uri}/api/Respondents/{respondent_email}/MostRecentByEmail
{brillium_base_uri}/api/Respondents/{respondent_custom_1}/MostRecentByCustom1
{brillium_base_uri}/api/Respondents
GET https://supersuds.brillium.com/api/Respondents/1476
{ "Respondents": [ { "Id": 1476, "AssessId": "COURSE1123", "FirstName": "JOHN", "LastName": "DOE", "Email": "jdoe1@email.com", "Custom1": "11223344",
"Custom2": "Boston", "Custom3": "Joel Wood", "Custom4": "Jane Smith", "Custom5": "", "Custom6": "", "Custom7": "", "Custom8": "", "Custom9": "", "Custom10": "", "Custom11": "", "Custom12": "", "Custom13": "", "Custom14": "", "Custom15": "", "Guid": "2EFEBC6852FF42388E51D12CF8127A0F", "RawScore": 57, "ScalePoints": 23, "FinalScore": 80, "PassFail": "Pass", "StatusCode": 50, "TimesTaken": 2, "TimeUsed": 916, "DateStarted": "2003-10-08T13:56:15-04:00", "DateFinished": "2003-10-08T14:11:31-04:00", "DateRestarted": "1900-01-01T00:00:00-05:00", "EssayCount": 1, "EssayPoints": 1, "TotalPoints": 7, "EarnedPoints": 4, "DemoMode": false, "CreditUsed": true, "ProctorId": "", "CourseItemResultId": 0, "Attempt": 2, "Current": true, "Page": 3, "TotalPages": 3, "Uri": "http:\/\/supersuds.brillium.com\/api\/Respondents\/1476", "RelatedUris": { "Results": "http:\/\/supersuds.brillium.com\/api\/Respondents\/1476\/Results", "Comments": "http:\/\/supersuds.brillium.com\/api\/Respondents\/1476\/Comments" } } ], "Page": 1, "PageSize": 50, "TotalCount": 1, "HasMore": false }
Id
GroupId
QuesId
RespId
Answer
DateAnswered
EarnedPoints
Essay
EarnedPoints
Marked
MarkedPage
ReviewPage
Page
Sequence
TotalPoints
Type
Uri
RelatedUris
{brillium_base_uri}/api/Results/{result_id}
GET https://supersuds.brillium.com/api/Results/6084
{ "Results": [ { "Id": 6084, "RespId": 1437, "QuesId": 10279, "GroupId": 150, "Sequence": 9, "Type": "DropdownChoose", "Page": 3, "MarkedPage": 0, "ReviewPage": 0, "Answer": "Between $10,000 and $20,000", "TotalPoints": 0, "EarnedPoints": 0, "Essay": "No", "Marked": "No", "DateAnswered": "2002-02-22T14:35:23-05:00", "Uri": "http:\/\/supersuds.brillium.com\/api\/Results\/6084", "RelatedUris": null } ], "Page": 1, "PageSize": 50, "TotalCount": 1, "HasMore": false }
Id
QuesId
RespId
Text
Type
Uri
RelatedUris
{brillium_base_uri}/api/Comments/{comment_id}
GET https://supersuds.brillium.com/api/Comments/9741
{ "Comments": [ { "Id": 0, "RespId": 8255, "QuesId": 10284, "Type": "Essay", "Text": "Very informative and helpful.", "Uri": "http:\/\/supersuds.brillium.com\/api\/Comments\/0", "RelatedUris": null
} ], "Page": 1, "PageSize": 50, "TotalCount": 1, "HasMore": false }
Id
AccountId
Body
DateCreated
DateModified
Format
FromEmail
FromName
IsShared
Name
ReplyTo
Subject
Type
Uri
RelatedUris
{brillium_base_uri}/api/EmailTemplates/{template_id}
{brillium_base_uri}/api/EmailTemplates
GET https://supersuds.brillium.com/api/EmailTemplates/42
{ "EmailTemplates": [ { "Id": 42, "AccountId": "SUPERSUDS", "Type": "Invite", "IsShared": true, "Name": "Assessment Invitation - Rob Shared", "FromEmail": "DONOTREPLY@brillium.com", "FromName": "", "ReplyTo": "", "Format": "PlainText", "Subject": "Assessment Invitation - [ASSESS_NAME]", "Body": "Below you will find the Web address required to sign into the [ASSESS_NAME] assessment. In most email software, you will be able to click on the link provided below to navigate to the sign-on page. If your email software does not support this functionality, please enter the link manually (or copy and paste) into your browser (starting with \"http\"). Once on the sign-on page, enter the required information and click on the Login button.\r\n\r\nAssessment Web Address:\r\n[INVITE_URL]\r\n\r\nGood luck!\r\n\r\nAssessment Administrators\r\n[ACCOUNT_NAME]", "DateCreated": "2011-01-14T14:36:44-05:00", "DateModified": "2011-03-18T14:13:46-04:00", "Uri": "http:\/\/supersuds.brillium.com\/api\/EmailTemplates\/42", "RelatedUris": null } ], "Page": 1, "PageSize": 50, "TotalCount": 1, "HasMore": false }
Id
AssessId
Code
Custom[1-20]
DateCreated
DateModified
FirstName
LastName
SourceId
SourceName
Status
Uri
RelatedUris
{brillium_base_uri}/api/Invitations/{invitation_id}
{brillium_base_uri}/api/Invitations/{invitation_code}/Code
GET https://supersuds.brillium.com/api/Invitations/11
{ "Invitations": [ { "Id": 11, "AssessId": "000TEST", "Code": "JFAF22eP", "SourceId": "20110126_Q7FDLW6X~2", "SourceName": "Spreadsheet Import", "Status": "New", "FirstName": "Tom", "LastName": "Jones", "Email": "tjones@email.com", "Custom": [ "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ], "DateCreated": "2011-01-26T17:15:43-05:00", "DateModified": "2011-01-26T17:16:17-05:00", "Uri": "http:\/\/supersuds.brillium.com\/api\/Invitations\/11", "RelatedUris": null } ], "Page": 1, "PageSize": 50, "TotalCount": 1, "HasMore": false }
{brillium_base_uri}/api/Invitations
SendEmails
POST https://supersuds.brillium.com/api/Invitations
{ "Invitations": [ { "AssessId": "000TEST", "FirstName": "Albert", "LastName": "Smythe", "Email": "asmythe@email.com", "Custom": [ "123456", "Male", "5-9 years" ] }, { "AssessId": "000TEST", "FirstName": "Janice", "LastName": "Kingston", "Email": "jkingston@email.com", "Custom": [ "246802", "Female", "1-4 years" ] } ], "SendEmails": true }
{ "Invitations": [ { "Id": 463, "AssessId": "000TEST", "Code": "ejJweHE6", "SourceId": "", "SourceName": "API", "Status": "Invited", "FirstName": "Albert", "LastName": "Smythe", "Email": "asmythe@email.com", "Custom": [ "123456", "Male", "5-9 years", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ], "DateCreated": "2015-04-09T14:50:43-05:00", "DateModified": "2015-04-09T14:50:43-05:00", "Uri": "http:\/\/supersuds.brillium.com\/api\/Invitations\/463", "RelatedUris": null }, { "Id": 464, "AssessId": "000TEST", "Code": "98dhJEU8", "SourceId": "", "SourceName": "API", "Status": "Invited", "FirstName": "Janice", "LastName": "Kingston", "Email": "jkingston@email.com", "Custom": [ "246802", "Female", "1-4 years", "", "", "", "",
"", "", "", "", "", "", "", "", "", "", "", "", "" ], "DateCreated": "2015-04-09T14:50:43-05:00", "DateModified": "2015-04-09T14:50:43-05:00", "Uri": "http:\/\/supersuds.brillium.com\/api\/Invitations\/464", "RelatedUris": null } ], "Page": 1, "PageSize": 50, "TotalCount": 2, "HasMore": false }
$.ajax({ type: 'GET', url: 'https://supersuds.brillium.com/api/Accounts/SUPERSUDS', beforeSend: function(xhr) { xhr.setRequestHeader('Authorization', 'Basic ' + 'U1VQRVJTVURTOnBhc3N3b3JkMTIzYjZlNjBiZmIwODk5NGJlNzllMTdlMzU2NTZlMzI0NmU='); xhr.setRequestHeader('Accept', 'application/vnd.ingeniousgroup.testcraftapi-v1+json'); }, success: function (data) { console.log(JSON.stringify(data)); }, error: function (error) { console.log(error[“responseText”]); } });