POST /cognito-idp
\nThis endpoint is used to authenticate a user through Amazon Cognito Identity Provider.
\nRequest Body
\n- \n
AuthFlow(string, required): Specifies the authentication flow for the user. \nClientId(string, required): The app client ID. \nAuthParameters(object, required): Contains the user's credentials for authentication.- \n
USERNAME(string, required): The username of the user. \nPASSWORD(string, required): The password of the user. \n
\nClientMetadata(object): Additional information about the client request. \n
Response
\n- \n
- Status: 200 \n
- Content-Type: application/x-amz-json-1.1 \n
AuthenticationResult(object): Contains the authentication result.- \n
AccessToken(string): The access token for the authenticated user. \nExpiresIn(integer): The expiration time of the access token. \nIdToken(string): The ID token for the authenticated user. \nRefreshToken(string): The refresh token for the authenticated user. \nTokenType(string): The type of the token. \n
\nChallengeParameters(object): Additional challenge parameters if any. \n
Our endpoints support authentication in general through a JWT provided by cognito that can be obtained from the endpoint described in this section.
\nAdditionally, some requests support access by API-KEY, but those are provided on demand and don't have methods to obtain them from the server.
\n","_postman_id":"0a59208c-f8fa-4151-ac7d-4c17cceb6e2b"},{"name":"Alpha","item":[{"name":"getKhanAcademyMasteryCheck","id":"ef067540-ef3a-4be2-93b5-358f30839cd0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"AUTO_GEN_GRAPHQL_ID_TOKEN"}],"body":{"mode":"graphql","graphql":{"query":"query getKhanAcademyMasteryCheck($input: GetKhanAcademyMasteryCheckInput!) {\n getKhanAcademyMasteryCheck(\n input: $input\n ) {\n masteredThroughExercise\n masteredThroughExerciseAt\n }\n}","variables":"{\n \"input\": {\n \"platformStudentId\": \"f60dbfcf-28c1-4d1b-8aa2-be77136049cd\",\n \"levelId\": \"x326874291fa8c7cb\"\n }\n}\n"}},"url":"GRAPHQL_URL","description":"This endpoint allows to get the mastery status of Khan Academy levels for a specific student.
\nInput
\n- \n
Valid student identifier: Please refer to the Student Identification section
\n \n
\nlevelIds(string array, required): The Khan Academy level ids to check. Min 1 item, max 120 \n
Output
\nThe output consists of an array of objects having the following attributes:
\n- \n
\nlevelId(string): The Khan Academy level ids this data relates to \n
\nmasteredThroughExercise(boolean): Whether the level was mastered through an exercise or not. Null if level is not mastered \n
\nmasteredThroughExerciseAt(string): The date in which the level was mastered through an exercise. Null if level not mastered, or mastered through other means. \n
The alpha module contains all endpoints required by the Alpha school
\n","_postman_id":"0e63cc9c-9736-43a9-b1af-47475afff930"},{"name":"Learning App Data","item":[{"name":"getMaxGrade","id":"6e4c4edd-0e7c-4989-8788-fea9fc7c7fb1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"AUTO_GEN_GRAPHQL_ID_TOKEN"}],"body":{"mode":"graphql","graphql":{"query":"query GetMaxGrade($input: GetMaxGradeInput!) {\n getMaxGrade(input: $input) {\n courseName\n topics {\n topicName\n topicId\n maxMasteryPercentage\n maxGrade\n maxGradeAchievedAt\n }\n }\n} ","variables":"{\n \"input\": {\n \"platformStudentId\": \"a6baae29-7533-4a5d-8260-5f9eb1b36551\",\n \"learningAppName\": \"TeactTower\",\n \"courseId\": \"dd66c7e3-d200-11ec-829e-12bc5a81f3ad\"\n }\n}"}},"url":"GRAPHQL_URL","description":"The getMaxGrade endpoint retrieves the maximum grade achieved by a student at a topic level for a given course or specific topic. This helps identify whether the current grade is being achieved for the first time or if it has been reached previously.
Input
\nThe input is validated using the GetMaxGradeInput and includes:
- \n
\nstudentIdentifier: One of the following must be provided:- \n
\nplatformStudentId: String (optional) - The platform-specific student ID \n
\nemail: String (optional) - The student's email address \n
\nplatformSchoolId: String (optional) - The platform-specific school ID (must be used withschoolStudentId) \n
\nschoolStudentId: String (optional) - The school-specific student ID (must be used withplatformSchoolId) \n
\n
\nlearningAppName: String (required) - The name of the learning application \n
\ncourseId: String (required) - The third-party course ID \n
\ntopicId: String (optional) - The third-party topic ID \n
Output
\nThe endpoint returns a GetMaxGradeOutput object containing:
- \n
\ncourseName: String - The name of the course \n
\ntopics: Array of objects, each containing:- \n
\ntopicName: String - The name of the topic \n
\ntopicId: String - The ID of the topic \n
\nmaxMasteryPercentage: Float - The highest mastery percentage achieved for this topic \n
\nmaxGrade: String (nullable) - The corresponding grade for the max mastery percentage \n
\nmaxGradeAchievedAt: AWSDateTime (nullable) - The date when the max grade was achieved \n
\n
Usage Notes
\n- \n
Consumers can pass the course ID alone to calculate max grade for all topics, or pass both course ID and topic ID to calculate max grade for a specific topic.
\n \nThis method relies on the availability of event history for topic mastery percentage. For applications that do not populate this data, the calculation may not be possible.
\n \n
This endpoint allows to get the XP (experience) a student has gained in the academic curriculum.
\nIt supports filtering the response by academic course names, domain external ids, and cluster external ids.
\nInput
\n- \n
Valid student identifier: Please refer to the Student Identification section
\n \n
\nlearningAppName(string): Name of the learning app to get XP for. \n
\nsubject(string): Name of the subject to get XP for. \n
\nacademicCourses(string array, optional): An array of course names to filter by \n
\ndomains(string array, optional): An array of domain external ids to filter by \n
\nclusters(string array, optional): An array of cluster external ids to filter by \n
Output
\nThe output consists of an object having the following attributes:
\n- \n
\nmaxXP(Int): Max XP obtainable for the chosen learning app and subject \n
\ntotalXP(Int): Total XP obtained for the chosen learning app and subject \n
\ngrades(GradeXP array): List of GradeXP objects containing the data for each grade \n
The GradeXP object has the following attributes:
\n- \n
\nname(String): Name of the grade \n
\ngrade(String): The grade itself, between PK and 12 \n
\ngradeXP(Int): XP obtained for this grade \n
\nmaxGradeXP(Int): Max XP obtainable for this grade \n
\nacademicCourses(AcademicCourseXP array): List of AcademicCourseXP objects containing the data for each academic course \n
The AcademicCourseXP object has the following attributes:
\n- \n
\nname(String): Name of the academic course \n
\nplatformAcademicCourseId(String): Platform academic course ID \n
\norder(Int): Order of the academic course \n
\nacademicCourseXP(Int): XP obtained for this academic course \n
\nmaxAcademicCourseXP(Int): Max XP obtainable for this academic course \n
\ndomains(DomainXP array): List of DomainXP objects containing the data for each domain \n
The DomainXP object has the following attributes:
\n- \n
\nname(String): Name of the domain \n
\ndomainId(String): Domain ID \n
\nplatformDomainId(String): Platform domain ID \n
\norder(Int): Order of the domain \n
\ndomainXP(Int): XP obtained for this domain \n
\nmaxDomainXP(Int): Max XP obtainable for this domain \n
\nclusters(ClusterXP array): List of ClusterXP objects containing the data for each cluster \n
The ClusterXP object has the following attributes:
\n- \n
\nname(String): Name of the cluster \n
\nclusterId(String): Cluster ID \n
\nplatformClusterId(String): Platform cluster ID \n
\norder(Int): Order of the cluster \n
\nclusterXP(Int): XP obtained for this cluster \n
\nmaxClusterXP(Int): Max XP obtainable for this cluster \n
\nstandards(StandardXP array): List of StandardXP objects containing the data for each standard \n
The StandardXP object has the following attributes:
\n- \n
\nstandardId(String): Standard external id \n
\nplatformStandardId(String): Platform standard id \n
\nstandardXP(Int): XP obtained for this standard \n
\nmaxStandardXP(Int): Max XP obtainable for this standard \n
This endpoint allows to get the XP (experience) a student has gained in the academic curriculum.
\nInput
\n- \n
Valid student identifier: Please refer to the Student Identification section
\n \n
\nlearningAppName(string): Name of the learning app to get XP for. \n
\nsubject(string): Name of the subject to get XP for. \n
\nacademicCourse(string): An course names to filter by \n
Output
\nThe AcademicCourseXP object has the following attributes:
\n- \n
\nname(String): Name of the academic course \n
\nplatformAcademicCourseId(String): Platform academic course ID \n
\ncourseEarnedXP(Int): Total XP obtained for this academic course \n
\ncourseDailyEarnedXP(Int): Total XP obtained for this academic course during the current day (PST/PDT timezone) \n
\ncourseWeeklyEarnedXP(Int): Total XP obtained for this academic course during the current week, starting Monday (PST/PDT timezone) \n
\ndomains(DomainXP array): List of DomainXP objects containing the data for each domain \n
The DomainXP object has the following attributes:
\n- \n
\nname(String): Name of the domain \n
\ndomainId(String): Domain ID \n
\nplatformDomainId(String): Platform domain ID \n
\nclusters(ClusterXP array): List of ClusterXP objects containing the data for each cluster \n
The ClusterXP object has the following attributes:
\n- \n
\nname(String): Name of the cluster \n
\nclusterId(String): Cluster ID \n
\nplatformClusterId(String): Platform cluster ID \n
\nclusterEarnedXP(Int): XP obtained for this cluster \n
\nclusterTotalXP(Int): Total achieveable XP - if none achieved yet, otherwise is the same asclusterEarnedXP\n
\nstandards(StandardXP array): List of StandardXP objects containing the data for each standard \n
The StandardXP object has the following attributes:
\n- \n
\nstandardId(String): Standard external id \n
\nplatformStandardId(String): Platform standard id \n
This endpoint allows consumers to fetch the curriculum of a learning app as a hierarchical list of objects, with courses being on the top level, going down to topics and levels.
\nInput
\n- \n
\ncourseId(string, optional): Id of a single course to fetch. If not provided, all are included \n
\nlearningAppName(string, required): Name of the learning app to fetch the curriculum for \n
\nincludeInactive(boolean, optional): Whether to include inactive content or only active
Default value: false \n
Output
\nThe output is a list of LearningAppCurriculumCourse objects.
\nA LearningAppCurriculumCourse object has the following structure:
- \n
\nplatformId(string): The platform id of the course \n
\ncourseName(string): The name of the course \n
\ncourseId(string): The external id of the course \nacademicCourseName (string, optional): The name of the academic course this learning app course is linked to, if any, null otherwise.
\n \ngrade (string, optional): The grade ('PK' to '12') for the academic course this learning app course is linked to, if any, null otherwise)
\n \n
\nsubject(string): The name of the subject for the course \n
\nactivityUnit(string): Value of the activity unit, like \"Questions\" \n
\nactivityUnitCorrect(string, optional): Value of the activity unit correct, like \"Questions Correct\" \n
\nlearningUnit(string): Value of the learning unit, like \"Skills\" \n
\nlearningUnitCorrect(string, optional): Value of the learning unit correct, like \"Skills Mastered\" \n
\nisActive(boolean, optional): Whether the course is active or not \n
\ndeactivatedAt(string, optional): Date when the course was deactivated in isoformat \n
\ndeactivationReason(string, optional): Reason why the course was deactivated \n
\ntopics: A list ofLearningAppCurriculumTopicobjects \n
A LearningAppCurriculumTopic object has the following structure:
- \n
\nplatformId(string): The platform id of the topic \n
\ntopicName(string): The name of the topic \n
\ntopicId(string): The external id of the topic \n
\norder(int, optional): The order for this topic within the course \n
\nurl(string, optional): The url for this topic \n
\nisActive(boolean, optional): Whether the topic is active or not \n
\ndeactivatedAt(string, optional): Date when the course was deactivated in isoformat \n
\ndeactivationReason(string, optional): Reason why the course was deactivated \n
\nlevels: A list ofLearningAppCurriculumLevelobjects \n
A LearningAppCurriculumLevel object has the following structure:
- \n
\nplatformId(string): The platform id of the level \n
\nlevelName(string): The name of the level \n
\nlevelId(string): The external id of the level \n
\norder(int, optional): The order for this level within the topic \n
\nurl(string, optional): The url for this level \n
\nisActive(boolean, optional): Whether the level is active or not \n
\ndeactivatedAt(string, optional): Date when the level was deactivated in isoformat \n
\ndeactivationReason(string, optional): Reason why the level was deactivated \n
This endpoint allows consumers to fetch the progress of a student in various courses within a learning app.
\nInput
\n- \n
\ncourseIds(array of strings, required): IDs of the courses to fetch. \n
\nlearningAppName(string, required): Name of the learning app. \nValid student identifier: Please refer to the Student Identification section.
\n \n
\nincludeInactive(boolean, optional): Whether to include inactive content or only active content. \n
Output
\nThe output is a list of GetLearningAppProgressCourseOutput objects.
GetLearningAppProgressCourseOutput Object
\n- \n
\nplatformId(string): The platform ID of the course. \n
\ncourseName(string): The name of the course. \n
\ncourseId(string): The external ID of the course. \n
\nmasteredLevels(int): Number of levels mastered by the student. \n
\ntotalLevels(int): Total number of levels in the course. \n
\nmasteryPercentage(float): Percentage of mastery achieved. \n
\nthresholdMasteryProgressPercentage(float): Threshold of mastery progress percentage. \n
\nstudentGrade(string): Grade of the student. \n
\nisActive(boolean, optional): Whether the course is active or not. \n
\ndeactivatedAt(string, optional): Date when the course was deactivated in ISO format. \n
\ndeactivationReason(string, optional): Reason why the course was deactivated. \n
\ntopics: A list ofGetLearningAppProgressTopicOutputobjects. \n
GetLearningAppProgressTopicOutput Object
\n- \n
\nplatformId(string): The platform ID of the topic. \n
\ntopicName(string): The name of the topic. \n
\ntopicId(string): The external ID of the topic. \n
\nmasteredLevels(int): Number of levels mastered by the student. \n
\ntotalLevels(int): Total number of levels in the topic. \n
\nmasteryPercentage(float): Percentage of mastery achieved. \n
\nthresholdMasteryProgressPercentage(float): Threshold of mastery progress percentage. \n
\nstudentGrade(string): Grade of the student. \n
\norder(int, optional): The order for this topic within the course. \n
\nisActive(boolean, optional): Whether the topic is active or not. \n
\ndeactivatedAt(string, optional): Date when the topic was deactivated in ISO format. \n
\ndeactivationReason(string, optional): Reason why the topic was deactivated. \n
\nlevels: A list ofGetLearningAppProgressLevelOutputobjects. \n
GetLearningAppProgressLevelOutput Object
\n- \n
\nplatformId(string): The platform ID of the level. \n
\nlevelName(string): The name of the level. \n
\nlevelId(string): The external ID of the level. \n
\nactiveMinutes(float): Number of active minutes spent on the level. \n
\nactivityUnitsAttempted(int): Number of activity units attempted. \n
\nactivityUnitsCorrect(int): Number of activity units correct. \n
\nmasteryPercentage(float): Percentage of mastery achieved. \n
\nthresholdMasteryProgressPercentage(float): Threshold of mastery progress percentage. \n
\nstudentGrade(string): Grade of the student. \n
\nmasteredAt(DateTime): Date and time when the level was mastered. \n
\norder(int, optional): The order for this level within the topic. \n
\nisActive(boolean, optional): Whether the level is active or not. \n
\ndeactivatedAt(string, optional): Date when the level was deactivated in ISO format. \n
\ndeactivationReason(string, optional): Reason why the level was deactivated. \n
The getLastInteractedStandard query fetches the last interacted standard details for a student within specified subjects.
Input
\n- \n
\nplatformStudentId(string, optional): The platform identifier for the student. \n
\nemail(string, optional): The email address of the student. \n
\nplatformSchoolId(string, optional): The platform identifier for the school. \n
\nschoolStudentId(string, optional): The identifier for the student within the school. \n
\nlearningAppName(string, required): The name of the learning app. \n
\nsubjectNames(string array, required): A list of subject names to retrieve the last interacted standard for. \n
Output
\nThe output is an object containing a list of LastInteractedSubject objects under the property lastInteractedStandardForSubjects.
LastInteractedSubject Object
\n- \n
\nsubjectName(string): The name of the subject for which the last interacted standard is retrieved. \n
\ngrade(LastInteractedGrade): An object containing grade details. \n
\nlastInteractedAt(String, required): The timestamp of the last interaction with the standard. \n
LastInteractedGrade Object
\n- \n
\nname(string): The name of the grade. \n
\nplatformGradeId(string): The platform identifier for the grade. \n
\nacademicCourse(LastInteractedAcademicCourse): An object representing the academic course linked to the grade. \n
LastInteractedAcademicCourse Object
\n- \n
\nname(string): The name of the academic course. \n
\nplatformCourseId(string): The platform identifier of the course. \n
\ndomain(LastInteractedDomain): An object representing the domain associated with the academic course. \n
LastInteractedDomain Object
\n- \n
\nplatformDomainId(string): The platform identifier for the domain. \n
\norganizationName(string): The organization linked to the domain. \n
\nname(string): The domain name. \n
\ndomainId(string): The identifier for the domain. \n
\ncluster(LastInteractedCluster): An object describing the cluster within the domain. \n
LastInteractedCluster Object
\n- \n
\nplatformClusterId(string): The platform identifier for the cluster. \n
\norganizationName(string): The name of the organization affiliated with the cluster. \n
\nname(string): The cluster name. \n
\nclusterId(string): The identifier for the cluster. \n
\nstandard(LastInteractedStandard): An object detailing the last interacted standard within the cluster. \n
LastInteractedStandard Object
\n- \n
\nstandardId(string): The external standard identifier. \n
\nplatformStandardId(string): The platform identifier for the standard. \n
\norganizationName(string): The organization name associated with the standard. \n
This API allows to get the learning sessions for a particular student and learning app with optional date filters.
\nInput
\n- \n
Valid student identifier: Please refer to the Student Identification section.
\n \n
\nlearningAppName(string): Name of the learning app associated with the session. \n
\nstartDate(Date, optional): Date to fetch data from, inclusive \n
\nendDate(Date, optional): Date to fetch data until, inclusive \n
Output
\nThe output is an array of objects containing session information with the following fields:
\n- \n
\nid(string): Unique identifier for the session \n
\nstartTime(string): Session start time (In UTC) \n
\nendTime(string): Session end time (In UTC) \n
\nduration(string): Time spent in the session in minutes \n
\nurl(string, optional): URL for the learning session if available, null otherwise \n
\nplatformCourseId(string, optional): id for learning app course if available, null otherwise \n
\ncourseId(string, optional): third party id for learning app course if available, null otherwise \n
\ncourseName(string, optional): learning app course name if available, null otherwise \n
\nsubject(string, optional): Subject Name if available, null otherwise \n
\nplatformTopicId(string, optional): id for learning app topic if available, null otherwise \n
\ntopicId(string, optional): third party id for learning app topic if available, null otherwise \n
\ntopicName(string, optional): learning app topic name if available, null otherwise \n
\nplatformLevelId(string, optional): id for learning app level if available, null otherwise \n
\nlevelId(string, optional): third party id for learning app level if available, null otherwise \n
\nlevelName(string, optional): learning app level name if available, null otherwise \n
This endpoint allows consumers to fetch messages related to a learning app for a specific student.
\nInput
\n- \n
Valid student identifier: Please refer to theย Student Identificationย section
\n \n
\nlearningAppNameย (String, required): The name of the learning app. \n
\nmessageTypesย ([LearningAppMessageMessageType!], optional): A list of message types to filter by. \n
\nstartDateย (DateTime, optional): The start date for filtering messages. \n
\nendDateย (DateTime, optional): The end date for filtering messages. \n
\nviewedย (Boolean, optional): Filter messages based on their viewed status. \n
Output
\nThe output is a list ofย LearningAppMessageย objects.
LearningAppMessageย Object
\n- \n
\nidย (String): The unique identifier of the message. \n
\nplatformStudentIdย (String): The platform student ID. \n
\nlearningAppNameย (String): The name of the learning app. \n
\nmessageTypeย (LearningAppMessageMessageType): The type of the message. \n
\npayloadย (JSON, optional): The payload of the message. \n
\nviewedย (Boolean, optional): Whether the message has been viewed. \n
\ncreatedOnย (DateTime): The date and time when the message was created. \n
\nviewedOnย (DateTime, optional): The date and time when the message was viewed. \n
LearningAppMessageMessageType Enum
\n- \n
\nreferred_by_student_referral_used\n
\nenrolled_student_referral_used\n
\nstudent_currency_transaction\n
\nstudent_asset_transaction\n
This API allows the creation or update of a learning session. It is designed to handle the session details for a student within a specific learning application and subject.
\nInput
\n- \n
Valid student identifier: Please refer to the Student Identification section.
\n \n
\nlearningAppName(string, required): Name of the learning app associated with the session. \n
\nsubject(string, required): Subject matter of the learning session. \n
\nstartTime(DateTime, required): Start time of the learning session. \n
\nendTime(DateTime, required): End time of the learning session. \n
\nlevelId(string, optional): Identifier for the level of content covered in the session. \n
\ntopicId(string, optional): Identifier for the topic covered in the session. \n
\ncourseId(string, optional): Identifier for the course associated with the session. \n
\nurl(string, optional): URL to access the learning material directly. \n
Output
\n- \n
platformLearningSessionId(string): Unique identifier for the learning session created or updated. \n
This API allows the creation or update of a batch of learning sessions. It is designed to handle the session details for a student within any amount of subjects and learning apps for any range of dates.
\nFor each session to upsert, either url or titlebar should be provided, so not providing none will cause the session to be rejected and returned as a failure.
\nInput
\n- \n
Valid student identifier: Please refer to the Student Identification section.
\n \n
\nlearningSessions(array): The list of learning sessions to upsert, following the LearningSessionInput schema, which is as follows:- \n
\nurl(string, optional): URL for the session. \n
\ntitlebar(string, optional): Titlebar for the session \n
\nstartTime(DateTime, required): Start time of the learning session. \n
\nendTime(DateTime, required): End time of the learning session. \n
\n
Output
\n- \n
\nfailedLearningSessions(array): The list of sessions that failed to insert, following the FailedLearningSession schema, which is as follows:- \n
- \n
\nurl(string, optional): URL for the session.- \n
\ntitlebar(string, optional): Titlebar for the session \n
\nstartTime(DateTime, required): Start time of the learning session. \n
\nendTime(DateTime, required): End time of the learning session. \n
\n
\n
\n
This endpoint allows consumers to mark specific learning app messages as viewed.
\nInput
\n- \n
Valid student identifier: Please refer to the Student Identification section
\n \n
\nlearningAppMessageIds(array of strings, required): List of IDs of the learning app messages to be marked as viewed. \n
Output
\nThe output is a list ofย updated LearningAppMessageย objects.
LearningAppMessageย Object
\n- \n
\nidย (String): The unique identifier of the message. \n
\nplatformStudentIdย (String): The platform student ID. \n
\nlearningAppNameย (String): The name of the learning app. \n
\nmessageTypeย (LearningAppMessageMessageType): The type of the message. \n
\npayloadย (JSON, optional): The payload of the message. \n
\nviewedย (Boolean, optional): Whether the message has been viewed. \n
\ncreatedOnย (DateTime): The date and time when the message was created. \n
\nviewedOnย (DateTime, optional): The date and time when the message was viewed. \n
LearningAppMessageMessageType Enum
\n- \n
\nreferred_by_student_referral_used\n
\nenrolled_student_referral_used\n
\nstudent_currency_transaction\n
\nstudent_asset_transaction\n
App Integration APIs allows the consumers to integrate their learning applications with the gt.school platform.
\nThere are two broad sections that cater to the main aspects of integration:
\nSubmitting Curriculum: This section covers the processes involved in adding and managing educational content, including courses, topics, and levels. It provides detailed instructions on how to structure and submit curriculum data, ensuring that it aligns with the gt.school platform's format and standards.
\nSubmitting Student Activity: This part of the guide focuses on the real-time submission of student activity data. It includes guidelines for tracking and reporting various student interactions within the learning apps, such as activity completion, progress tracking, and mastery levels. The real-time submission feature ensures that student data is up-to-date and accurately reflects their learning journey.
\n","_postman_id":"76126e98-c97e-405a-ba59-acbdecf9a4b2"},{"name":"Common","item":[{"name":"Configuration","item":[{"name":"getConfiguration","id":"53f896c2-0df9-4ee3-8548-6f18e3b7476f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"AUTO_GEN_GRAPHQL_ID_TOKEN"}],"body":{"mode":"graphql","graphql":{"query":"query GetConfiguration($input: GetConfigurationInput!) {\n getConfiguration(input: $input) {\n configuration {\n name\n key\n value\n }\n }\n}","variables":"{\n \"input\": {\n \"key\": \"โ ๏ธ WARNING โ ๏ธ This endpoint is deprecated. Please use getConfigurations instead.
\nThis endpoint retrieves a specific configuration using its key.
\nInput
\n- \n
key(string): key of the configuration to retrieve \n
Output
\nThe output is an object with a single key called configuration that contains a Configuration object.
The Configuration object has the following structure:
- \n
\nname(string): The name of the retrieved configuration \n
\nkey(string): The key of the retrieved configuration. Should match the one provided in the input \n
\nvalue(JSON): The value of the retrieved configuration \n
This endpoint retrieves configurations for a specific learning app, and optionally a list of keys to filter for.
\nInput
\n- \n
\nlearningAppName(string): Name of the learning app to fetch configurations for \n
\nkeys(string array, optional): List of keys to filter for \n
Output
\nThe output is an object with a single key called configurations that contains a list of Configuration objects.
The Configuration object has the following structure:
- \n
\nname(string): The name of the retrieved configuration \n
\nkey(string): The key of the retrieved configuration \n
\nvalue(JSON): The value of the retrieved configuration \n
Module handling DB based configuration service
\n","_postman_id":"7d7718df-5958-4efc-b71d-6e15aa7cb484"}],"id":"990b2caf-c0f6-43e9-b1e6-122b4de3ae1b","description":"This section includes global conventions for Platform API usage.
\nStudent Identification
\n- \n
\nplatformStudentId(string, optional): The platform id of the student \n
\nemail(string, optional): The email of the student \n
\nschoolStudentId(string, optional): The id of the student within the school \n
\nplatformSchoolId(string, optional): The platform id of the school \n
Note: for identifying the student, one (and ONLY one) of the following must be included in the input:
\n- \n
\nplatformStudentId\n
\nemail\n
\nschoolStudentId+platformSchoolId\n
This mutation generates customized educational content based on the input parameters specified. It currently supports only synchronous generation. For content retrieval, please consult the selectContent API.
For some content types (such as Tutor Conversations or DMs From the Dead), there is also the streaming over GraphQL Subscription capability. See onCreateGeneratedContentChunk about how to subscribe to it.
Decision Logic
\nStandard, Content Type, and Content Generator Selection:
\n- \n
The API begins by determining whether a specific
\ncontentTypeIdis provided in the input. If not, it assigns a random content type using predefined weights from the configuration. \nThe standard for content generation is determined by checking the input parameters. If a specific
\nstandardIdis provided, the API uses that to find the relevant standard. If not, it selects an appropriate standard based on the subject and other contextual information provided. \n
Content Generation:
\n- \n
Synchronous Generation (
\nisSyncGenerationset to true): If synchronous generation is requested, the API generates new content on demand. Only works for generators that complete under 30 sec. Some generators that only with synchronous generation (e.g. Tutor Conversations, DMs From the Dead) support streaming to provide data after the initial 30 seconds window. \nAsynchronous Generation: It is not supported, as it is done internally by the Automated Content Generation mechanism.
\n \n
Streaming
\n- \n
Generators that work with synchronous generation (e.g. Tutor Conversations, DMs From the Dead) also supports streaming to get partial responses while generation is ongoing.
\n \nTo use streaming, you need to subscribe
\nonCreateGeneratedContentChunkto receive stream messages. \nTo separate different stream responses between different requests, you can add an optional
\nrequestIdparameter which will be directly added to stream messages. \n
Input
\nThe mutation requires a GenerateContentInput object with the following fields:
- \n
\nsubject(string, required): Subject name of the content. Should match with subjects existing in the records. (Can be obtained from getCurriculum query) \n
\ncourse(string): Name of the course. (Can be obtained from getCurriculum query) \n
\ndomainId(string): External ID of the domain. (Can be obtained from getCurriculum query) \n
\nclusterId(string): External ID of the cluster. (Can be obtained from getCurriculum query) \n
\nstandardId(string): External ID of the educational standard. (Can be obtained from getCurriculum query) \n
\ngrade(string): Educational grade level. One of below:- \n
- 'PK' | 'K' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | '10' | '11' | '12' | 'AP' \n
\n
\ncontentGeneratorId(string): External ID of the content generator. Its only for specific use case like \"DMs From the Dead\" generators and most of the times its not needed. \n
\ncontentTypeId(string): External ID of the content type. If content type is not specified, a random one out of a predefined list will be picked.- \n
โ ๏ธ If both
\ncontentTypeIdandcontentGeneratorIdis provided, it'll use thecontentGeneratorIdand won't enforce if it matches with the content type. \nโ ๏ธ Currently, values for
\ncontentTypeIdandcontentGeneratorIdcannot be obtained via API and you need to contact with the Content Gen Platform to obtain the values. If not provided, random config based on content type will be picked. \n
\n
\nattributes([ContentAttributeInput!]): List of attributes to tailor content. This is used for specific content types for various reasons. For example one use case of it is in DMs From the Dead v2 content type to identify user interaction history and the message.- \n
Object with below fields:
\n- \n
\nattributeName(string) Name of the attribute- \n
Required attributes for tutors: (See also the examples about how to use these)
\n- \n
\nuserMessage: The student's question. \n
\ngeneratedContentId: ID of the content card being asked about. \n
\nuserInteractionHistory: JSON string containing previous interactions (see example request for \"Tutor Conversations\"). \n
\n
\n
\nattributeValue(string) Value of the attribute \n
\n
\n
\nextendedAttributes([GenerateContentInputExtendedAttribute!]): Additional attributes to be used in content generation and be linked to the content. One example use case of it in DMs From the Dead v2 Content Type to pass id of key figure to chat with.- \n
platformIdPlatform ID of the extended attribute. For tutors its the ID of the key figure that should play the role of tutor.getHistoricalFiguresquery can be used to retrieve figures. To retrieve other ids than KeyFigure, you need to contact with Content Gen Platform. \n
\n
\nisSyncGeneration(boolean): If this is set to true - the default, and the only supported value - a new piece of content will be generated on demand and synchronously returned. Only a specific set of content types are supported, given the hard limit of 30 seconds of a request in AppSync. For content types that take longer than 30 seconds to generate, it will timeout. \n
\nrequestId(string): Request Id that can be passed for stream responses. If its passed, it'll be directly added to stream notifications ononCreateGeneratedContentChunk. This is useful to distinguish when client receives subscription messages from multiple requests. \n
Output
\nReturns a content item. The output is a GeneratedContentOutput object with the following fields:
- \n
\ncontent(string, JSON): JSON containing the detailed content. \n
\ngeneratedContentId(string): Unique identifier for the generated content. \n
\ncontentTypeId(string): ID of the generated content. \n
\ncontentTypeName(string): Name of the content type. \n
\ncontentTypeVersion(string): Version of the content type. \n
\ngrade(string): Grade level for the content. \n
\nsubjectName(string): Name of the subject. \n
\nplatformSubjectId(string): Platform ID of the subject of the generated content. \n
\ncourseName(string): Name of the course. \n
\nplatformCourseId(string): Platform ID of the course of the generated content. \n
\ndomainId(string): External ID of the Domain. \n
\ndomainDescription(string): Description of the domain. \n
\nplatformDomainId(string): Platform ID of the domain of the generated content. \n
\nclusterId(string): External ID of the cluster. \n
\nclusterDescription(string): Description of the cluster. \n
\nplatformClusterId(string): Platform ID of the cluster of the generated content. \n
\nstandardId(string): External ID of the Standard. \n
\nstandardName(string): Name of the standard. \n
\nstandardDescription(string): Description of the standard. \n
\nplatformStandardId(string): Platform ID of the standard of the generated content. \n
\ndifficulty(integer): Difficulty level of the content. (DEPRECATED, use the value returned in theattributesfield instead) \n
\nattributes([ContentAttributeOutput]): Output list of content attributes with below fields:- \n
\nattributeName(string) Name of the attribute \n
\nattributeValue(string) Value of the attribute \n
\n
\nextendedAttributes([GeneratedContentExtendedAttributeOutput!]): List of extended attributes- \n
\nplatformIdPlatform ID \n
\nvalueValue of the attribute \n
\n
\ntotalLikes,totalViews,totalComments,totalBookmarks,totalShares,totalReports(integer): Metrics on content interaction. \n
\nisLikedByUser,isSharedByUser,isBookmarkedByUser,isCommentedByUser(boolean): Flags indicating user interaction. If the user calling the API is not anonymous and has provided feedback for this instance of generated content, these will be true/false, otherwise they will be null \n
This endpoint allows consumers to get a \"correct\" or \"incorrect\" result to a student's answer to a given question. gradeContent uses AI to determine the result of students' answers.
Input
\nThe GradeContentInput object must be provided to the endpoint. It contains the following fields:
- \n
\ncontentId(String, required): The identifier for the content being graded. \n
\nstudentAnswer(String, required): The answer submitted by the student for the content. \n
Output
\nThe output is an object of type GradeContentOutput, which provides detailed information about the grading result:
- \n
\nresult(GradeContentResult): Indicates whether the student's answer is CORRECT or INCORRECT. \n
\nfeedback(String): Provides feedback on the student's answer. \n
\nscore(Float, optional): The score awarded to the student's answer. \n
\nmaxScore(Float, optional): The maximum possible score for the question. \n
\ngrade(String, optional): The grade assigned to the student's answer. \n
\nsubParts([GradeContentSubPart!], optional): A list of sub-part grading details, if applicable. \n
GradeContentSubPart Object
\nEach GradeContentSubPart provides detailed grading information for subsections of the content:
- \n
\nid(String): The identifier of the content sub-part. \n
\nname(String): The name of the sub-part. \n
\nfeedback(String): Specific feedback for the sub-part. \n
\nresult(GradeContentResult): The result for the sub-part, indicating CORRECT or INCORRECT. \n
\nscore(Float): The score awarded for the sub-part answer. \n
\nmaxScore(Float): The maximum possible score for this sub-part. \n
Related Enums
\n- \n
GradeContentResult: Enum indicating the grading result, with possible values ofCORRECTorINCORRECT. \n
This API selects educational content based on specified input criteria with different options to choose from
\nCurriculum Filtering
\nThis API allows filtering of curriculum items based on platform IDs at various hierarchical levels (subjects, courses, domains, clusters, and standards).
\nParameters
\nAll parameters are optional arrays of platform IDs:
\n- \n
\nsubjectIds: Subject platform IDs \n
\ncourseIds: Course platform IDs \n
\ndomainIds: Domain platform IDs \n
\nclusterIds: Cluster platform IDs \n
\nstandardIds: Standard platform IDs \n
Filtering Behavior
\nAt each level of the curriculum hierarchy, the selection contains one set of standards per disjoint curriculum scope. When processing the next level:
\n- \n
If an item at the next level is contained within one of the selected scopes, it narrows its set of standards to that scope.
\n \nIf no standards are found at the current level, the selection falls back to the most granular defined level to obtain the standards.
\n \n
This process is applied sequentially from subjects down to standards. The final selection is the union of all the remaining scopes. If the final selection is empty, then only the most granular defined level is applied to obtain the selection.
\nExample
\nRequest: subjectIds=[1,2]&courseIds=[101,102,103]
Assume:
\n- \n
Course 101 belongs to Subject 1
\n \nCourse 102 belongs to Subject 2
\n \nCourse 103 belongs to Subject 3 (not in the subject filter)
\n \n
Result:
\n- \n
Standards from Course 101 in Subject 1
\n \nStandards from Course 102 in Subject 2
\n \nStandards from Course 103 (regardless of its subject)
\n \n
Explanation:
\n- \n
Initially, the selection includes all standards from Subjects 1 and 2.
\n \nCourse 101 narrows the scope for Subject 1 to just standards in Course 101.
\n \nCourse 102 narrows the scope for Subject 2 to just standards in Course 102.
\n \nCourse 103 adds a new scope to the selection, including all its standards.
\n \n
This filtering logic applies similarly to all levels of the curriculum hierarchy.
\nInput
\nThe query requires a SelectContentInput object with the following fields:
- \n
\nbatchSize(integer, required): The number of content items to return. Defaults to 2. On some conditions we might return fewer content than requested batch size such as:- \n
If the number of candidate standards is less than the batchSize, the method will return as many standards as available.
\n \nIf the repeat content policy restricts the selection and there isn't enough unseen content to meet the batchSize.
\n \nIf the fallback policy is set to ALLOW_NO_FALLBACKS and there isn't enough content to meet the batchSize.
\n \n
\n
\nlearningAppName(string, required): Name of the learning application. You need to contact with Content Gen Platform to get alearningAppName. \n
\nplatformSubjectIds([string]): The curriculum scope for which the caller wants to retrieve content items, using internal platform IDs. Represents the subject level of the curriculum hierarchy. \n
\nplatformAcademicCourseIds([string]): The curriculum scope for which the caller wants to retrieve content items, using internal platform IDs. Represents the course level of the curriculum hierarchy. \n
\nplatformDomainIds([string]): The curriculum scope for which the caller wants to retrieve content items, using internal platform IDs. Represents the domain level of the curriculum hierarchy. \n
\nplatformClusterIds([string]): The curriculum scope for which the caller wants to retrieve content items, using internal platform IDs. Represents the cluster level of the curriculum hierarchy. \n
\nplatformStandardIds([string]): The curriculum scope for which the caller wants to retrieve content items, using internal platform IDs. Represents the standard level of the curriculum hierarchy.- \n
๐ก The API will return content items only for standards inside the specified curriculum scope. If the scope has a null intersection, it will pick the most granular scope.
\n \n๐ก To get the internal platform IDs of the curriculum items you can call the getCurriculum API
\n \n
\n
\ncontentTypes(SelectContentInputContentTypes): Object that specifies the content types. Either contentTypeIds or contentTypeDetails must be provided, but not both.- \n
\ncontentTypeIds([string]): External IDs of the content types. Mutually exclusive with the weights \n
\ncontentTypeDetails([ContentTypeDetails]): Mapping of content type to various customisations. Has below fields:- \n
\ncontentTypeId(string, required): External ID of the content type. \n
\nweight(float, required): Weight assigned to the content type.- \n
- ๐กOnly content types with weight zero will be eligible to be returned as fallbacks. If none are specified with weight zero fallbacks are disabled. \n
\n
\nversion(string): Version of the content type.- \n
- ๐ก If only the major version (x) if specified the API returns content for all versions matching the major version specified. If both major(x) and minor (x.y) versions are specified, we only return content for that specific version of the content type. Defaults to \"0\". \n
\n
\nformat(enum): The format the content is returned in. Can be:- \n
\nJSON(default) - renders as a stringified JSON representation \n
\nQTI3_0- renders as an XML that satisfies the QTI 3.0 standard \n
\nQTI2_1- renders as an XML that satisfies the QTI 2.1 standard \n
\n
\n
\n
\nstandardSelectionStrategy(enum): Strategy to select standards, if selected standards don't have content for specificed type(s), fallbacks will be used. Defaults toRANDOMIZED. Options include:- \n
\nRANDOMIZED: The standards are selected at random from the input curriculum scope. \n
\nBREADTH_FIRST_MASTERY: The standards are selected according to the mastery order of the calling user, sorted in ascending order, starting with the standard with the least mastery. \n
\nBREADTH_FIRST_MASTERY_WITH_ADAPTIVE_DIFFICULTY: The standards are selected according to the mastery order of the calling user, sorted in ascending order, starting with the standard with the least mastery. The chosen standard is then assigned a difficulty using theadaptiveDifficultySelectionalgorithm. When choosing this strategy,batchSize = 1andALLOW_ALL_FALLBACKSis enforced. \n
\nTEST_PREP: Used to select content for a test. The standards are chosen according to the distribution of standards for the test, as indicated by thequizAlgorithmvalue. \n
\nSPACED_REPETITION: Used to select content for spaced repetition. \n
\n
\nrepeatContentPolicy(enum): Policy on repeating content. Defaults toALLOW_NO_REPEATS. options include:- \n
\nALLOW_NO_REPEATS: Only content items not viewed by the calling user will be returned. \n
\nALLOW_REPEAT_ANSWERED: Can return both viewed and non-viewed content items by the calling user. \n
\nALLOW_REPEAT_CORRECTLY_ANSWERED:Not supported. \n
\nALLOW_REPEAT_INCORRECTLY_ANSWERED: Not supported. \n
\n
\nfallbackPolicy(enum): Fallback policy. Defaults toALLOW_ALL_FALLBACKS. Options include:- \n
\nALLOW_ALL_FALLBACKS: This policy enables the use of any available fallback content selection mechanisms to ensure that some form of content is delivered, even if it does not strictly meet the initial request criteria.- \n
When using fallbacks, order of fetches happen is below:
\n- \n
- 1. highScores/lowViews: (Before fallbacks) This means, first we try to retrieve content with high scores (large number of user interaction) and content with low views. The ratio is 80% for highScores and 20% for low views (80-20 are defaults and can be adjusted with
selectionWeightsparameter)
2. anyContentType: If number of contents after initial call is not enough, we use fallback and select content from different content types matching with given input.
3. anyContentTypeAndAnyStandardInScope: If number of contents are still not enough finall fallback will be returning content from any standard in given curriculum scope. \n
\n- 1. highScores/lowViews: (Before fallbacks) This means, first we try to retrieve content with high scores (large number of user interaction) and content with low views. The ratio is 80% for highScores and 20% for low views (80-20 are defaults and can be adjusted with
\n
\nALLOW_NO_FALLBACKS: Disables fallbacks. \n
\n
\nselectionWeights(SelectContentInputSelectionWeights): Weights controlling the type of content selected during fallbacks (Also see fallbackPolicy for details). The percentages must positive and add up to 100. Its used to randomize content seen instead of always getting the popular items. Object with below fields:- \n
\npopularContent(integer, required): Percentage weight for popular content which means content with large number of user interactions. Defaults to 80. \n
\nlessSeenContent(integer, required): Percentage weight for less seen content. Defaults to 20. \n
\n
\nquizAlgorithm(enum): Algorithm used to select quiz content. Defaults toEXAM_WEIGHTED_DOMAIN_TEST. Possible options:- \n
\nEXAM_WEIGHTED_DOMAIN_TEST: Uses the weight and question count of the different standards in the official tests to generate a list of standards for the quiz, containing them in the same exact proportion. If the amount is 5 or fewer questions, it doubles all the entries to avoid too small tests \n
\nDOMAIN_WEIGHTED_TEST: Uses the expected question count for the domain to pick standards for the test. Standards are weighted depending on their own expected question count for a test. The final list is built to have exactly the amount of questions expected, keeping the proportion as much as possible using a weighted random sampling without replacement when necessary to fill the gaps. \n
\n
\nuserIdOverride(string): The ID of the user on behalf of whom the API is called. If not specified is the calling user. Used to determine which content items the user viewed to exclude them from the output whenALLOW_NO_REPEATSis used asrepeatContentPolicy. \n
\nexcludeContentIds([string]): List of content IDs to exclude from the selection. \n
\nextendedAttributes([ExtendedAttributeFilter], optional): List of extended attribute filters to further refine content selection.- \n
Each filter is an object with:
\n- \n
\ntype(string, required): The type of extended attribute to filter by \n
\nvalue(string, required): The specific value to match for the given attribute type \n
\nIf there are multiple filters, content will be returned if it matches ANY of the specified filters (OR)
\n \nIf invalid or non-existent extended attributes are provided, they will be ignored and the API will return content based on other specified criteria or filters if specified in the query.
\n \nThe extended attributes filter is applied in addition to other filtering mechanisms (curriculum scope, content types, etc.)
\n \n
\n
Output
\nThe output is an array of GeneratedContentOutput which is same type as output of the generateContentv2 mutation with extra following fields can be used:
- \n
\nselectionReason(string): Details about content selection (useful for tracing) \n
\nwarnings([ContentSelectionWarning]): Warnings to inform if selected content does not exactly match the request (e.g. fallbacks used), object with below properties:- \n
\ncode(enum) Warning code, one of below:- \n
\nintersection_of_curriculum_empty: Indicates that the intersection of the specified curriculum scope is empty. \n
\nretrieved_from_fallback: Indicates that the content item was retrieved using a fallback mechanism. \n
\n
\nmessage(string) More detailed warning message \n
\n
\\n ![\\\"Background](\\\"https://alphacoachbot-production-midjourney-images.s3.us-east-1.amazonaws.com/production/mcq6bgImage.jpeg\\\")
\\n
This API returns all the active educational content that is mapped for a particular test ordered by the \"order\" value in the mapping itself.
\nInput
\nThe query requires an input object with the following properties:
\n- \n
testType(string): The name of the test type we want to fetch all content for. \n
Output
\nThe output is an object that contains a single property \"items\". The items property is an array of SelectedContent which has the same exact structure as the response in the SelectContent endpoint just above.
\nNote: In this endpoint, the selectionReason and the warnings will always be null because we don't perfrom any selection or logic, we just fetch all. Likewise, the personal attributes, like \"likedByUser\" will be null because as of now we don't allow to provide a user in the input, but it might be expanded in the future.
\n","urlObject":{"host":["GRAPHQL_URL"],"query":[],"variable":[]}},"response":[{"id":"8727abd6-8414-4d9b-9c7e-6ae36d0a0036","name":"selectContentForTest","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"AUTO_GEN_GRAPHQL_ID_TOKEN","disabled":true}],"body":{"mode":"graphql","graphql":{"query":"query SelectContentForTest($input: SelectContentForTestInput!) {\n selectContentForTest(input: $input) {\n items {\n contentTypeId\n courseName\n difficulty\n totalViews\n totalShares\n totalReports\n totalLikes\n totalComments\n totalBookmarks\n subjectName\n standardId\n standardDescription\n isSharedByUser\n platformStandardId\n isLikedByUser\n isCommentedByUser\n isBookmarkedByUser\n grade\n generatedContentId\n }\n }\n}\n","variables":"{\r\n \"input\": {\r\n \"testType\": \"SAT - 10th grade practice test- R&W - Module 1\"\r\n }\r\n}"}},"url":"GRAPHQL_URL"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"data\": {\r\n \"selectContentForTest\": {\r\n \"items\": [\r\n {\r\n \"contentTypeId\": \"MCQ - DSAT\",\r\n \"courseName\": \"SAT Prep\",\r\n \"difficulty\": 2,\r\n \"totalViews\": 0,\r\n \"totalShares\": 0,\r\n \"totalReports\": 0,\r\n \"totalLikes\": 0,\r\n \"totalComments\": 0,\r\n \"totalBookmarks\": 0,\r\n \"subjectName\": \"SAT Prep\",\r\n \"standardId\": \"Function of a Sentence\",\r\n \"standardDescription\": \"The generated question must ask the student to identify which choice best states the function of the underlined sentence in the text as a whole.\",\r\n \"isSharedByUser\": false,\r\n \"platformStandardId\": \"1bfcbb08-7971-4a63-95ba-734899c13c7c\",\r\n \"isLikedByUser\": false,\r\n \"isCommentedByUser\": false,\r\n \"isBookmarkedByUser\": false,\r\n \"grade\": \"12\",\r\n \"generatedContentId\": \"11f4a5e3-b48b-4118-971f-d13b2b71d4f4\"\r\n },\r\n {\r\n \"contentTypeId\": \"MCQ - DSAT\",\r\n \"courseName\": \"SAT Prep\",\r\n \"difficulty\": 2,\r\n \"totalViews\": 2,\r\n \"totalShares\": 0,\r\n \"totalReports\": 0,\r\n \"totalLikes\": 0,\r\n \"totalComments\": 0,\r\n \"totalBookmarks\": 0,\r\n \"subjectName\": \"SAT Prep\",\r\n \"standardId\": \"Function of a Sentence\",\r\n \"standardDescription\": \"The generated question must ask the student to identify which choice best states the function of the underlined sentence in the text as a whole.\",\r\n \"isSharedByUser\": false,\r\n \"platformStandardId\": \"1bfcbb08-7971-4a63-95ba-734899c13c7c\",\r\n \"isLikedByUser\": false,\r\n \"isCommentedByUser\": false,\r\n \"isBookmarkedByUser\": false,\r\n \"grade\": \"12\",\r\n \"generatedContentId\": \"20cdabf3-359f-4d4f-9356-610dd96fa9e0\"\r\n }\r\n ]\r\n }\r\n }\r\n}"}],"_postman_id":"4e48106e-bd8e-4240-8e27-aa371f1fd524"},{"name":"getDMChatHistory","id":"ee0df449-faf8-475e-a3de-d1713818767c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"AUTO_GEN_GRAPHQL_ID_TOKEN"}],"body":{"mode":"graphql","graphql":{"query":"query GetDMChatHistory {\n getDMChatHistory(input: {\n keyFigureName: \"Julius Caesar\"\n page:0\n }) {\n hasNextPage\n chatHistory {\n timestamp\n senderUserId\n message\n platformGeneratedContentId\n }\n }\n}\n","variables":""}},"url":"GRAPHQL_URL","description":"This endpoint allows to get chat history that student made with a key figure. Uses pagination with 50 item per page.
\nInput
\ninput object with below parameters:
\n- \n
\nkeyFigureName(string, required) Name of the key figure.getHistoricalFiguresquery can be used to retrieve key figure names. \n
\ngeneratedContentId(string) Content ID if you want to retrieve chat history for specific content. \n
\npage(integer) Page number to retrieve, starts from zero. \n
Output
\nThe output is an object with the following attributes:
\n- \n
\nhasNextPage(boolean): Indicates if there is next page to retrieve. \n
\nchatHistory(list): Contains list of object with following fields- \n
\nmessage(string): Message content \n
\nsenderUserId(string): The user ID of the sender \n
\ntimestamp(string): The iso formatted timestamp of message sent \n
\nplatformGeneratedContentID(string): generatedContentId if conversation belongs to specific content \n
\n
Get list of historical figures that are matching with given parameters
\nInput
\ninput object with below parameters:
\n- \n
\nname(string) Name of the figure \n
\nfacet(string) Facet you want to retrieve. Available options at the moment are:Top50Figure\n
Either name or facet should be provided.
\nOutput
\nThe output is an object with the following attributes:
\n- \n
\nplatformId(string): ID of the figure. \n
\nname(string): Name of the figure \n
\nimageUrl(string): URL of the figure image. \n
\nproperties(string): Extra information related to figure in JSON format. \n
\nsubjectsITeach(list): Contains list of subjects that figure teach with following fields- \n
\nid(string): ID of the subject \n
\nimage(integer): Image of the subject \n
\nname(string): Name of the subject \n
\n
Get list of comments for given content.
\nInput
\ninput object with below parameters:
\n- \n
\ngeneratedContentId(string, required) Id of content to retrieve comments for. This can be found in selectContent or generateContentV2 requests. \n
\nparentCommentId(string) Parent comment id for retrieving comments under specific comment. \n
Output
\nThe output is an object with the following attributes:
\n- \n
\ngeneratedContentId(string): ID of the content \n
\ncomments(list): Contains list of commnets with following fields:- \n
\ncommentId(string): ID of the comment \n
\nuserId(string): ID of the user who wrote the comment \n
\nuserPreferredName(string): Name of the user \n
\nuserProfileImage(string): Image URL of the user \n
\ncomment(string): Comment body. \n
\ncreationDateTime(string): The iso formatted timestamp of comment created \n
\nlikesCount(integer): Number of likes for the comment \n
\ndislikesCount(integer): Number of dislikes for the comment \n
\nrepliesCount(integer): Number of replies for the comment \n
\n
Create new comment
\nInput
\ninput object with below parameters:
\n- \n
\ngeneratedContentId(string, required) Id of content to write comment for. This can be found in selectContent or generateContentV2 requests. \n
\ncomment(string, required) Comment text to post. \n
\nparentCommentId(string) Parent comment id to reply under specific comment. This can be found in the comment details get from thegetGeneratedContentCommentsquery \n
Output
\nThe output is an object with the following attributes:
\n- \n
commentId(string): ID of the generated comment \n
Saves specific fedback (likes, bookmarks, shares, reports, etc.) of the user for a generated content.
\nInput
\nUses separate field for each of the below:
\n- \n
\ngeneratedContentId(string, required) Id of content to create feedback. This can be found in selectContent or generateContentV2 requests. \n
\nfeedbackType(GeneratedContentFeedbackType) Type of feedback \n
\nfeedbackNotes(string) Notes for feedback \n
If feedbackType is REPORT_OTHER the feedbackNotes is required.
enum GeneratedContentFeedbackType {\n LIKE\n DISLIKE\n BOOKMARK\n SHARE\n REPORT_INCORRECT\n REPORT_UNRELATED\n REPORT_OFFENSIVE\n REPORT_NOT_INTERESTED\n REPORT_OTHER\n}\n\nOutput
\nReturns string of content id with 200 status if feedback is created successfully.
\n","urlObject":{"host":["GRAPHQL_URL"],"query":[],"variable":[]}},"response":[{"id":"1c13eb20-57d7-458e-afcb-3424fda03674","name":"generatedContentFeedback","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"AUTO_GEN_GRAPHQL_ID_TOKEN","disabled":true}],"body":{"mode":"graphql","graphql":{"query":"mutation GeneratedContentFeedback {\n generatedContentFeedback(\n generatedContentId: \"02a44a7a-e9a0-428c-a0d5-67652eccfffd\"\n feedbackType: LIKE\n feedbackNotes: \"Not related\"\n )\n}","variables":""}},"url":"GRAPHQL_URL"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"generatedContentFeedback\": \"02a44a7a-e9a0-428c-a0d5-67652eccfffd\"\n }\n}"}],"_postman_id":"692837de-1837-450b-bfe6-5b7ac6a0be5e"},{"name":"deleteGeneratedContentFeedback","id":"bee09025-f41d-4aea-91ed-35b3439bee3c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"AUTO_GEN_GRAPHQL_ID_TOKEN"}],"body":{"mode":"graphql","graphql":{"query":"mutation DeleteGeneratedContentFeedback {\n deleteGeneratedContentFeedback(\n generatedContentId: \"02a44a7a-e9a0-428c-a0d5-67652eccfffd\"\n feedbackType: LIKE\n )\n}","variables":""}},"url":"GRAPHQL_URL","description":"Delete feedback created for specific content.
\nInput
\nUses separate field for each of the below:
\n- \n
\ngeneratedContentId(string, required) Id of content to delete feedback. This can be found in selectContent or generateContentV2 requests. \n
\nfeedbackType(GeneratedContentFeedbackType) Type of feedback to delete (see generatedContentFeedback mutation for available options) \n
Only the LIKE, DISLIKE, BOOKMARK or SHARE feedbacks can be deleted.
\nOutput
\nReturns list of string that contains feedback id with 200 status if feedback is deleted successfully.
\n","urlObject":{"host":["GRAPHQL_URL"],"query":[],"variable":[]}},"response":[{"id":"09bfe2c1-7d4e-4375-97f1-7d59bba8835f","name":"deleteGeneratedContentFeedback","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"AUTO_GEN_GRAPHQL_ID_TOKEN","disabled":true}],"body":{"mode":"graphql","graphql":{"query":"mutation DeleteGeneratedContentFeedback {\n deleteGeneratedContentFeedback(\n generatedContentId: \"02a44a7a-e9a0-428c-a0d5-67652eccfffd\"\n feedbackType: LIKE\n )\n}","variables":""}},"url":"GRAPHQL_URL"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"deleteGeneratedContentFeedback\": [\n \"537e430c-804f-4959-99a4-cadc2a017831\"\n ]\n }\n}"}],"_postman_id":"bee09025-f41d-4aea-91ed-35b3439bee3c"},{"name":"recordGeneratedContentView","id":"b4df6648-3f31-4412-b148-df4884da88f6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"AUTO_GEN_GRAPHQL_ID_TOKEN"}],"body":{"mode":"graphql","graphql":{"query":"mutation RecordGeneratedContentView {\n recordGeneratedContentView(input: {\n generatedContentId: \"02a44a7a-e9a0-428c-a0d5-67652eccfffd\"}\n )\n}\n","variables":""}},"url":"GRAPHQL_URL","description":"Create view record for generated content when user sees it.
\nInput
\ninput object with below parameters:
\n- \n
generatedContentId(string, required) Id of content to save view record. This can be found in selectContent or generateContentV2 requests. \n
Output
\nReturns response with 200 status if the request succeed.
\n","urlObject":{"host":["GRAPHQL_URL"],"query":[],"variable":[]}},"response":[{"id":"93711ad7-8033-4afa-81a5-a16f3484942a","name":"recordGeneratedContentView","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"AUTO_GEN_GRAPHQL_ID_TOKEN","disabled":true}],"body":{"mode":"graphql","graphql":{"query":"mutation RecordGeneratedContentView {\n recordGeneratedContentView(input: {\n generatedContentId: \"02a44a7a-e9a0-428c-a0d5-67652eccfffd\"}\n )\n}\n","variables":""}},"url":"GRAPHQL_URL"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"recordGeneratedContentView\": \"OK\"\n }\n}"}],"_postman_id":"b4df6648-3f31-4412-b148-df4884da88f6"},{"name":"getContentItemCounts","id":"36b280df-1d38-464e-8c6e-cdea36311aee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"AUTO_GEN_GRAPHQL_ID_TOKEN"}],"body":{"mode":"graphql","graphql":{"query":"query MyQuery {\n getContentItemCounts(input: {\n subjectIds: [\"73344647-0b4f-11ec-92a8-0e3f2490ced5\"],\n courseIds: [\"3491d53d-d196-4c36-b948-2787e26a5b54\"], \n domainIds: [\"bd7bccff-f977-48f3-927a-0d02763c961f\"], \n contentTypes: [\n {externalId: \"MCQ - DSAT\", version: \"0\"}\n ]\n }) { \n subject {\n id\n name\n }\n course {\n id\n name\n }\n domain {\n externalId\n id\n }\n standards {\n contentCounts {\n contentType\n count\n version\n }\n externalId\n id\n }\n }\n}\n","variables":""}},"url":"GRAPHQL_URL","description":"The getContentItemCounts endpoint helps learning applications determine which features to activate based on the availability of specific content types for a given curriculum. The endpoint processes a curriculum filter and returns an array of domains that fit the input criteria, including content counts for specified content types and versions.
\n\nNote: The API is eventually consistent, and the data returned by the API is synced every hour. This means that content generations occurring within the hour may not be reflected immediately.
\n
See getCurriculum query for more details about the curriculum and see selectContent query for more details about how filtering work on given curriculum inputs.
Input
\nThe inputs for getContentItemCounts are:
- \n
\nsubjectIds([string]): An array of subject platform IDs to filter by. \n
\ncourseIds([string]): An array of course platform IDs to filter by. \n
\ndomainIds([string]): An array of domain database IDs to filter by. \n
\ncontentTypes([ContentTypeInput]): An array of objects specifying content type and version to filter by.- \n
Each object has the following fields:
\n- \n
\nexternalId(string): The external ID of the content type. \n
\nversion(string): The version of the content type, which can be either just the major (x) version or both the major and minor version (x.y). \n
\n
\n
Output
\nThe output is a list of objects with the following attributes:
\n- \n
\nsubject(ContentItemSubject): Details about the subject, contains the following fields:- \n
\nid(string): Platform ID of the subject \n
\nname(string): Name of the subject. \n
\n
\ncourse(ContentItemCourse): Details about the course, contains the following fields:- \n
\nid(string): Platform ID of the course \n
\nname(string): Name of the course. \n
\n
\ndomain(ContentItemDomain): Details about the domain, contains the following fields:- \n
\nid(string): Platform ID of the domain \n
\nexternalId(string): External ID of the domain. \n
\n
\nstandards([ContentItemStandard]): Contains a list of standards within the domain with the following fields:- \n
\nid(string): Platform ID of the standard. \n
\nexternalId(string): External ID of the standard. \n
\ncontentCounts([ContentCount]): Contains a list of content counts for the standard with the following fields:- \n
\ncontentType(string): External ID of the content type. \n
\nversion(string): Version of the content type. \n
\ncount(int): Number of associated active content items. \n
\n
\n
\n\n","urlObject":{"host":["GRAPHQL_URL"],"query":[],"variable":[]}},"response":[{"id":"0420d1c6-48c5-46fd-9a36-47e193d77da7","name":"GetContentItemCounts","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"AUTO_GEN_GRAPHQL_ID_TOKEN"}],"body":{"mode":"graphql","graphql":{"query":"query MyQuery {\n getContentItemCounts(input: {\n subjectIds: [\"73344647-0b4f-11ec-92a8-0e3f2490ced5\"],\n courseIds: [\"3491d53d-d196-4c36-b948-2787e26a5b54\"], \n domainIds: [\"bd7bccff-f977-48f3-927a-0d02763c961f\"], \n contentTypes: [\n {externalId: \"MCQ - DSAT\", version: \"0\"}\n ]\n }) { \n subject {\n id\n name\n }\n course {\n id\n name\n }\n domain {\n externalId\n id\n }\n standards {\n contentCounts {\n contentType\n count\n version\n }\n externalId\n id\n }\n }\n}\n","variables":""}},"url":"GRAPHQL_URL"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"getContentItemCounts\": [\n {\n \"subject\": {\n \"id\": \"73344647-0b4f-11ec-92a8-0e3f2490ced5\",\n \"name\": \"SAT Prep\"\n },\n \"course\": {\n \"id\": \"3491d53d-d196-4c36-b948-2787e26a5b54\",\n \"name\": \"SAT Prep\"\n },\n \"domain\": {\n \"externalId\": \"SAT Unit 8 - Math\",\n \"id\": \"bd7bccff-f977-48f3-927a-0d02763c961f\"\n },\n \"standards\": [\n {\n \"contentCounts\": [\n {\n \"contentType\": \"MCQ - DSAT\",\n \"count\": 100,\n \"version\": \"0.1\"\n }\n ],\n \"externalId\": \"Volume Difference\",\n \"id\": \"560aa9c4-6291-4b3e-8b28-48553b3ee8e9\"\n },\n {\n \"contentCounts\": [\n {\n \"contentType\": \"MCQ - DSAT\",\n \"count\": 100,\n \"version\": \"0.1\"\n }\n ],\n \"externalId\": \"Volume Solids\",\n \"id\": \"88eb1a3d-8d36-40c0-ac6c-53dca247b685\"\n },\n {\n \"contentCounts\": [\n {\n \"contentType\": \"MCQ - DSAT\",\n \"count\": 100,\n \"version\": \"0.1\"\n }\n ],\n \"externalId\": \"Perimeter\",\n \"id\": \"a91d9c6a-b486-41f9-9f98-437d5e1fb2d8\"\n },\n {\n \"contentCounts\": [\n {\n \"contentType\": \"MCQ - DSAT\",\n \"count\": 0,\n \"version\": \"0.1\"\n }\n ],\n \"externalId\": \"Surface Area\",\n \"id\": \"ab55ed70-dbcb-4cc9-a2c8-d8b22f527367\"\n },\n {\n \"contentCounts\": [\n {\n \"contentType\": \"MCQ - DSAT\",\n \"count\": 100,\n \"version\": \"0.1\"\n }\n ],\n \"externalId\": \"Area Circle\",\n \"id\": \"bfb38cb4-9cea-4022-9c62-0cec576b9719\"\n },\n {\n \"contentCounts\": [\n {\n \"contentType\": \"MCQ - DSAT\",\n \"count\": 100,\n \"version\": \"0.1\"\n }\n ],\n \"externalId\": \"Area Polygon\",\n \"id\": \"cda49c8a-4d49-45e1-92ad-bf4a35becb88\"\n }\n ]\n }\n ]\n }\n}"}],"_postman_id":"36b280df-1d38-464e-8c6e-cdea36311aee"},{"name":"onCreateGeneratedContentChunk","id":"8f3b9642-e3d9-47c5-9e98-ea6b090129cc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"AUTO_GEN_GRAPHQL_ID_TOKEN"}],"body":{"mode":"graphql","graphql":{"query":"subscription MySubscription {\n onCreateGeneratedContentChunk {\n chunk\n contentSoFar\n requestId\n userId\n createdOn\n }\n}\n","variables":""}},"url":"GRAPHQL_URL","description":"โ ๏ธ The API returns content item counts for content types and standards active for content generation only.
\n
Subscribe to content chunks for streaming supported content types. At the moment only the tutor messages support streaming. Only responses generated for the currently logged in user are returned.
\nInput
\n- \n
- N/A \n
Output
\nThe output is an object with the following attributes:
\n- \n
\nchunk(string): Chunk of AI Response, in each subscription message youโll get next chunk of the message to concatenate \n
\ncontentSoFar(string): Content generated so far, in case you want to use full content and re-render each time.- \n
- This will be especially helpful for LaTeX messages as we need a full message to properly fix LaTeX issues and using it chunk by chunk may create corrupted LaTeX. \n
\n
\nrequestIdThe requestId the client sent in the initial request. This will be useful to separate notifications in case a client sends a new request before completing the previous one. \n
\nuserIdSame userId as you subscribe \n
\ncreatedOnDate of the message \n
Retrieves a paginated list of extended attribute types used in content generation.
\nInput
\n- \n
after(string, optional): Pagination cursor for fetching next page of results \nlimit(int, optional): Maximum number of items to return per page \n
Output
\nThe output contains pagination information and a list of extended attribute types:
\n- \n
next(string, optional): Cursor for fetching the next page of results \ndata([ContentGenExtendedAttributeType]): List of extended attribute type objects \n
ContentGenExtendedAttributeType Object
\n- \n
platformId(string): Unique platform identifier for the attribute type \ntype(string): The type name/category of the extended attribute \n
Retrieves extended attribute mappings for a given subject, with support for pagination. The response includes attribute details and their relationships with other attributes.
\nInput
\n- \n
subject(String, required): The name of the subject to get mappings for \nafter(String, optional): Pagination cursor for fetching next set of results \nlimit(Int, optional): Maximum number of items to return \n
Output
\nThe output contains pagination information and a list of extended attributes with their relations:
\n- \n
next(String, optional): Cursor for the next page of results \ndata([ExtendedAttributeWithRelations]): List of extended attributes and their relations \n
ExtendedAttributeWithRelations Object
\n- \n
platformId(String): Unique platform identifier \nid(String, optional): Attribute identifier \ntype(String): Type of the attribute \nvalue(String): Value of the attribute \nproperties(JSON, optional): Additional properties as JSON \ncategory(String, optional): Category of the attribute \nrelatesTo([RelatedExtendedAttribute]): List of related attributes \n
RelatedExtendedAttribute Object
\n- \n
platformId(String): Unique platform identifier \nid(String, optional): Related attribute identifier \ntype(String): Type of the related attribute \nvalue(String): Value of the related attribute \nproperties(JSON, optional): Additional properties as JSON \ncategory(String, optional): Category of the related attribute \nrelation(String, optional): Type of relationship \n
Returns a paginated list of standards with their associated extended attributes for a given subject.
\nInput
\n- \n
subject(String, required): The name of the subject to get mappings for \nafter(String, optional): Pagination cursor for getting the next page of results \nlimit(Int, optional): Maximum number of results to return per page \n
Output
\nThe output contains pagination information and a list of standards with their extended attributes:
\n- \n
next(String, optional): Cursor for getting the next page of results \ndata([StandardWithExtendedAttributes]): List of standards and their extended attributes \n
StandardWithExtendedAttributes Object
\n- \n
platformId(String, required): The platform identifier for the standard \nid(String, required): The standard identifier \nparentPlatformId(String, optional): The platform identifier of the parent standard \nname(String, optional): The name of the standard \ndescription(String, required): The description of the standard \nextendedAttributes([BaseExtendedAttribute], required): List of extended attributes \n
BaseExtendedAttribute Object
\n- \n
platformId(String, required): The platform identifier for the extended attribute \nid(String, optional): The identifier of the extended attribute \ntype(String, required): The type of extended attribute \nvalue(String, required): The value of the extended attribute \nproperties(AWSJSON, optional): Additional properties as JSON \ncategory(String, optional): The category of the extended attribute \n
Retrieves content generator configurations
\nInput
\n- \n
\ncontentTypeId(String, required): The identifier of the content type. \n
\ncontentTypeVersion(String, required): Version of the content type. \n
\nplatformStandardIds([String!], Optional): List of platform standard identifiers. \n
Output
\nReturns an array of content generator configuration objects (GetContentGenConfigsOutput), each containing:
- \n
\nplatformId(String, required): The platform identifier for the configuration. \n
\nid(String, required): The unique identifier of the configuration. \n
\nversion(String, required): Version of the configuration. \n
\npromptTemplate(String, optional): Template used for content generation prompts. \n
\npromptOutputSchema(String, optional): Schema defining the expected output format. \n
\ncontentGeneratorType(String, optional): Type of the content generator. \n
\nstatus(String, optional): Current status of the configuration. \n
\ngenerationType(String, optional): Type of content generation. \n
Note: This endpoint requires authentication and is restricted to users with Guide or Admin roles.
\n","urlObject":{"host":["GRAPHQL_URL"],"query":[],"variable":[]}},"response":[],"_postman_id":"efa29d61-c30f-46c5-8ebb-d9831fdfefec"},{"name":"deactivateContent","id":"ee1f1ce6-b883-4f97-86b0-c1cb6d340ef6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"AUTO_GEN_GRAPHQL_ID_TOKEN"}],"body":{"mode":"graphql","graphql":{"query":"mutation DeactivateContent($input: DeactivateContentInput!) {\n deactivateContent(input: $input) {\n deactivatedContentIds\n }\n}\n","variables":"{\r\n \"input\" : {\r\n \"contentIds\": [\"03bfe50f-d70e-4aad-ab4c-28cfe6f7f37a\"],\r\n \"platformStandardId\": \"6b60bf34-9221-4bb0-b8a5-749f5cf14e21\",\r\n \"contentTypeExternalId\": \"Learning Applet\",\r\n \"contentTypeVersions\": [\"2.0\"]\r\n }\r\n }"}},"url":"GRAPHQL_URL","description":"Allows deactivating content from the system using either direct content IDs or criteria-based selection. This mutation is restricted to Guide and Admin users, or IAM authentication. Content can be deactivated by providing specific content IDs for direct deactivation, or by specifying criteria (platform standard, content type, and versions) for bulk deactivation.
\nInput
input (DeactivateContentInput, required): The input object containing deactivation parameters.
DeactivateContentInput Object
contentIds (Array of String, optional): List of specific content IDs to deactivate directly
platformStandardId (String, optional): The standard identifier for criteria-based deactivation
contentTypeExternalId (String, optional): The external identifier for the content type
contentTypeVersions (Array of String, optional): List of content type versions to target
Validation Rules:
\n- \n
Eitherย
\ncontentIdsย must be provided for direct deactivation, OR \nAll three criteria fields (
\nplatformStandardId,ยcontentTypeExternalId, andยcontentTypeVersions) must be provided for criteria-based deactivation \n
Output
DeactivateContentOutput Object
deactivatedContentIds (Array of String, required): List of content IDs that were successfully deactivated
Allows inserting content into the system with specified attributes and configurations. This mutation is restricted to Guide and Admin users, or IAM authentication.
\nInput
\n- \n
input(InsertContentInput, required): The input object containing content details. \n
InsertContentInput Object
\n- \n
\nplatformGeneratedContentId(String, optional): Unique identifier for the generated content \n
\nplatformContentGeneratorConfigId(String, required): The identifier for the content generator configuration \n
\nplatformStandardId(String, required): The standard identifier associated with the content \n
\ncontent(String, required): The actual content to be inserted \n
\nplatformParentContentId(String, optional): Identifier of the parent content if applicable \n
\nextendedAttributes([InsertContentExtendedAttributeInput], optional): List of extended attributes \n
\ncustomAttributes([InsertContentCustomAttributeInput], optional): List of custom attributes \n
InsertContentExtendedAttributeInput Object
\n- \n
\nplatformId(String, required): Platform identifier for the extended attribute \n
\nusageType(String, required): Type of usage for the extended attribute \n
InsertContentCustomAttributeInput Object
\n- \n
\nattributeName(String, required): Name of the custom attribute \n
\nattributeValue(String, required): Value of the custom attribute \n
Output
\nInsertContentOutput Object
\n- \n
platformGeneratedContentId(String, required): The unique identifier assigned to the inserted content \n
Content Generation Platform User Guide
\nOverview
\nWelcome to the Content Generation Platform, a comprehensive solution for creating, retrieving, and interacting with educational content at scale. Our platform leverages advanced AI technologies to support a wide range of educational needs, from content creation to personalized tutoring.
\nKey Capabilities:
\n- \n
Automated Content Generation:
\n- \n
Create diverse educational content aligned with specific curricula
\n \nSupport for various content types including questions, exercises, and explanations
\n \nCustomizable to meet different educational standards and difficulty levels
\n \n
\nContent Retrieval System:
\n- \n
Access a vast repository of pre-generated, curriculum-aligned content
\n \nFlexible filtering options based on subjects, courses, standards, and more
\n \nCustomizable selection strategies to meet specific learning objectives
\n \n
\nAI Tutoring:
\n- \n
Interact with AI tutors for personalized learning guidance
\n \nSupport for various subjects and learning styles
\n \nAbility to contextualize discussions around specific content items
\n \n
\n
Our platform is designed to be flexible and scalable, catering to a wide range of educational technology applications. Whether you're building an adaptive learning system, a test prep application, or a comprehensive e-learning platform, our tools can be integrated to enhance your educational offerings.
\nIn the following sections, we'll dive deeper into each of these capabilities, providing you with the knowledge to effectively leverage our platform for your specific needs.
\nContent Generation
\nOur platform empowers you to create AI-powered content generators that produce high-quality, curriculum-aligned educational content at scale. Here's what you need to know:
\nKey Concepts
\n- \n
Content Types: These define the structure and format of the content to be generated (e.g., Multiple Choice Questions, Fill in the Blank, True/False). Each Content Type has a specific JSON schema that all generated content must adhere to.
\n \nCurriculum Alignment: All generated content is tied to specific academic standards, ensuring relevance and proper educational context.
\n \nExternal Generators: The platform supports integration of external content generators, allowing third parties to create custom generators for specific Content Types and curriculum scopes.
\n \nGenerator Registration: External generators can be registered with the platform, enabling them to be used in content generation workflows.
\n \n
Creating a Content Generator
\nTo create a new content generator, you'll typically follow these steps:
\n- \n
Define Scope: Decide which Content Type(s) and curriculum scope your generator will handle.
\n \nBuild the Generator: Develop your generator as an arbitrary piece of code that can produce content matching the chosen Content Type's schema and curriculum scope. This could involve crafting AI prompts, implementing algorithms, or any other suitable approach.
\n \nImplement the Interface: Ensure your generator implements the required interface for integration with our platform.
\n \nRegister the Generator: Use our platform's registration process to make your generator available for content generation. This involves creating a Content Generator Configuration that specifies when and how your generator should be used.
\n \n
Generator Selection Process
\nThe platform automatically selects the appropriate generator for content creation based on the Content Type and academic standard. Here's how it works:
\n- \n
Matching Content Type: The platform first identifies all Content Generator Configurations that support the requested Content Type.
\n \nCurriculum Scope Filtering: From these, it selects configurations that support the curriculum scope of the requested standard.
\n \nVersion Prioritization: If multiple configurations match, the platform chooses the one with the highest version number.
\n \nSpecificity Preference: If there are still multiple matches, the platform selects the configuration with the most specific curriculum scope that includes the standard.
\n \nRandom Selection: In the rare case of multiple equally suitable configurations, one is chosen at random.
\n \n
Automated Content Pre-filling
\nOnce your content generator is created and configured:
\n- \n
The platform automatically starts generating content for the curriculum scope your generator supports.
\n \nThis process, called Content Pre-filling, runs periodically to maintain a fresh pool of content.
\n \nGenerated content becomes immediately available for learning applications to retrieve and use.
\n \nThe platform manages the quantity of content, ensuring sufficient coverage across all supported standards.
\n \n
Quality Control
\nQuality control is a critical part of the content generation process:
\n- \n
Built-in Validation: Your generator should implement validation steps using generative AI. This might include:
\n- \n
Using AI to check the accuracy of generated answers
\n \nVerifying that content aligns with the intended difficulty level
\n \nEnsuring language is appropriate for the target audience
\n \n
\nAutomated Checks: The platform performs additional automated checks on generated content, like checking that the returned content matches the schema specified for the content type.
\n \n
Best Practices
\n- \n
Quality Control: Leverage AI in your validation steps to ensure high-quality output.
\n \nSpecialization: Design your generator to be specialized on a specific curriculum scope.
\n \nEfficiency: Optimize your generator for scale, as it may need to produce large volumes of content.
\n \n
Next Steps
\n- \n
Explore our developer documentation for detailed guides on implementing content generators.
\n \nReview existing Content Types and consider how your generator might fit into or expand our content ecosystem.
\n \nReach out to our platform team for guidance on best practices and integration with our content generation workflows.
\n \n
Retrieving Pre-generated Content
\nOverview
\nThe Select Content API is a powerful tool designed to retrieve educational content items tailored to specific curriculum needs. Whether you're building an adaptive learning platform, a quiz application, or any educational technology solution, this API allows you to access a vast repository of curriculum-aligned content with fine-grained control.
\nKey Features
\n- \n
Curriculum-based content selection
\n \nSupport for multiple content types
\n \nCustomizable content selection strategies
\n \nFlexible repeat and fallback policies
\n \nContent format options (JSON, QTI 3.0 or QTI 2.1)
\n \n
How It Works
\n- \n
You specify a curriculum scope (subjects, courses, standards, etc.)
\n \nYou define content type preferences and selection strategies
\n \nThe API returns a batch of content items matching your criteria
\n \n
Getting Started
\nTo use the Select Content API, you'll need:
\n- \n
A valid learningAppName (contact us to obtain one)
\n \nFamiliarity with the curriculum structure and their IDs
\n \n
Basic Usage
\nHere's a simple example of how to use the API:
\nquery SelectContent {\n selectContent(input: {\n batchSize: 20,\n learningAppName: \"YourAppName\",\n platformStandardIds: [\"standard-id-1\", \"standard-id-2\"],\n contentTypes: {\n contentTypeDetails: [{\n{ contentTypeId: \"MCQ\", weight: 1.0, format: \"QTI3_0\" },\n { contentTypeId: \"Truth or Lie\", weight: 0.5 },\n }]\n }) {\n content\n generatedContentId\n standardId\n contentTypeName\n }\n}\n\nThis query will return 20 content items for the specified academic standards. It will include both Multiple Choice Questions (MCQs) and Truth or Lie questions, with about twice as many MCQs. The MCQs will be in QTI v3 format, while the Truth or Lie questions will be in JSON format.
\nKey Concepts
\nCurriculum Filtering
\nYou can filter content at various levels of the curriculum hierarchy:
\n- \n
Subjects
\n \nCourses
\n \nDomains
\n \nClusters
\n \nStandards
\n \n
The API will:
\n- \n
Start with the broadest level you specified (like subjects)
\n \nNarrow down through each level you provided
\n \nSelect the standards inside all the specified levels
\n \nIf no standards are found, it will use just the most specific level you gave
\n \n
Content Types
\nSpecify which types of content you want (e.g., multiple-choice questions, true/false, essay prompts). You can also assign weights to prefer certain content types.
\nThe platform now supports the following content types, and growing:
\n- \n
Did You Know: a video by a relevant historical or contemporary figure explaining a curious fact related to the subject.
\n \nDifferent variants of Multiple Choice Questions, e.g. for regular learning, SAT Prep, AP Tests, etc.
\n \nFill in the Blanks
\n \nTruth or Lie: the student needs to decide if a fun/curious statement related to the subject matter is true or false.
\n \nMatching Pairs: the student needs to match related concepts in pairs relevant to the subject matter.
\n \nControversial Conversation: a video engaging two relevant historical or contemporary figures, contrasting their points of view in a fun way on a controversy related to the subject matter.
\n \n
Selection Strategies
\nChoose how standards are selected:
\n- \n
RANDOMIZED: Selects standards randomly from the specified curriculum scope. This is useful for general practice or when you want a diverse mix of content.
\n \nBREADTH_FIRST_MASTERY: Selects standards based on the user's mastery levels. It prioritizes standards where the user has lower mastery, helping to focus on areas that need improvement. This strategy requires you to provide a user ID.
\n \nTEST_PREP: Designed for test preparation scenarios. This strategy selects standards based on their importance and frequency in standardized tests. It works in conjunction with the quizAlgorithm parameter to simulate test conditions more accurately.
\n \n
Policies
\nControl content repetition and fallback behavior:
\n- \n
repeatContentPolicy: Manage whether users see repeat content
\n \nfallbackPolicy: Define behavior when ideal content isn't available
\n \n
Advanced Features
\n- \n
Content format selection (JSON, QTI 3.0 or QTI 2.1)
\n \nQuiz algorithm selection for test prep scenarios
\n \nContent exclusion by ID
\n \nUser-specific content selection
\n \n
Best Practices
\n- \n
Start with broader curriculum scopes and narrow down as needed
\n \nUse weights to balance different content types
\n \nImplement fallback policies for consistent content delivery
\n \nRegularly update your curriculum IDs to ensure accuracy
\n \n
Next Steps
\n- \n
Explore the full API documentation for detailed parameter descriptions
\n \nContact our support team to setup tour learning app
\n \nTry out different selection strategies to optimize for your use case
\n \n
AI Tutors
\nOur AI Tutoring feature provides an interactive, personalized learning guidance by leveraging advanced language models to simulate conversations with knowledgeable historical and contemporary figures. This capability enhances engagement and supports deeper understanding of educational content.
\nKey Features
\n- \n
Personalized interactions with AI tutors embodying various historical and contemporary figures
\n \nSupport for specialization in specific parts of the curriculum or learning activities (e.g., SAT prep, AP tests)
\n \nAbility to contextualize discussions around specific content items
\n \nReal-time, streaming responses for a smooth user experience
\n \n
How It Works
\n- \n
User Interaction: Students can ask questions or seek explanations on specific topics or content items.
\n \nTutor Selection: Each interaction is associated with a specific historical or contemporary figure, chosen based on the subject matter or learning context.
\n \nContext-Aware Responses: The AI considers the student's question, any associated content items, and the student's interaction history to generate relevant and personalized responses.
\n \nReal-Time Delivery: Responses are streamed in real-time, allowing for a natural conversational flow.
\n \n
Key Concepts
\n- \n
Content-Linked Conversations: AI tutors can discuss specific content items, providing explanations, hints, or deeper context.
\n \nHistorical and Contemporary Figures: Different figures can be selected to suit various subjects or teaching contexts.
\n \nConversation Management: The platform maintains conversation threads, allowing for coherent, multi-turn interactions.
\n \nAdaptive Explanations: Tutors adjust their explanations based on the student's apparent understanding and previous interactions.
\n \n
Implementation
\nAI tutors are implemented as a special type of content generator, powered by AI models and controlled via prompts. This means they can be developed and customized using the same principles and processes outlined in the Content Generation section.
\nNext Steps
\n- \n
Explore our API documentation for integrating AI tutors into your application.
\n \nReview available historical and contemporary figures and consider how they align with your educational goals.
\n \nReach out to our platform team for guidance on customizing AI tutor interactions for your specific needs.
\n \n
By incorporating AI Tutors into your educational technology solution, you can offer students a more engaging, interactive, and personalized learning experience that adapts to their individual needs and learning styles.
\nNote
\n- \n
- Within the documentation all IDs named as \"Platform Id\" like
platformSubjectId,platformIdetc. corresponds to Database IDs within the Content Gen Platform. \n
This endpoint allows publishing application events within the CoachBot platform. It validates the input, processes the event, and manages any immediate actions required, like giving rewards in a synchronous manner if the granted rewards output parameter is selected.
\nInput
\n- \n
\nclientLearningAppId(string): The id of the client app emitting the event \n
\ntargetLearningAppId(string): The id of the app the event is related to. Most times this will be the same as the client learning app. \n
\nlearningAppEventTypeId(string): Type of event being emitted, like \"quiz_submitted\". \n
\nstudentId(string): Platform id of the student the event is being submitted for \n
\neventDate(string, optional): Iso formatted event date. If not provided \"now\" will be used \n
\neventKey(string): Unique key for this event from the client app's side \n
\ndetails(dict): Extra json details to store for the event. \n
\nsubjectName(string, optional): If passed the subject of the event along with the event is stored. \n
Output
\n- \n
\nid(string): The platform id of the generated event \n
\nclientLearningAppId(string): The id of the client app emitting the event \n
\ntargetLearningAppId(string): The id of the app the event is related to. Most times this will be the same as the client learning app. \n
\nlearningAppEventTypeId(string): Type of event being that was emitted, like \"quiz_submitted\". \n
\nstudentId(string): Platform id of the student the event was being submitted for \n
\neventDate(string): Iso formatted event date \n
\neventKey(string): Unique key for this event from the client app's side \n
\ndetails(dict): Extra json details from the event. \n
\nsubjectId(string | null ): Subject Id if it exists for the event, else null. \n
\ngrantedRewards(array): List of GrantedReward items if any reward was granted. \n
The GrantedReward items have the following fields:
\n- \n
\ncurrency(string): The key of the currency for this reward, for example \"points\" \n
\namount(int): The amount given as reward. \n
Retrieves application events for a specific student and learning app combination. This endpoint allows filtering events by specific parameters and returns detailed information about the events, including their timestamps and associated curriculum data.
\nInput
\n- \n
input(GetApplicationEventInput, required): The parameters to filter application events. \n
GetApplicationEventInput Object
\n- \n
platformStudentId(String, optional): The platform ID of the student. \nschoolStudentId(String, optional): The school's ID for the student. \nplatformSchoolId(String, optional): The platform ID of the school. \nemail(String, optional): The email address of the student. \nclientLearningAppId(String, required): The ID of the client learning application. \ntargetLearningAppId(String, required): The ID of the target learning application. \nlearningAppEventTypeId(String, required): The ID of the learning app event type. \nplatformStandardId(String, optional): The platform ID of the standard. \nplatformClusterId(String, optional): The platform ID of the cluster. \nplatformDomainId(String, optional): The platform ID of the domain. \nplatformAcademicCourseId(String, optional): The platform ID of the academic course. \n
Note: For identifying the student, one (and only one) of the following must be included:
\n- \n
platformStudentId\nemail\nschoolStudentId+platformSchoolId\n
Output
\nThe output is an array of GetApplicationEventOutput objects, each representing an individual application event.
GetApplicationEventOutput Object
\n- \n
eventKey(String, required): The unique key of the event. \neventDate(String, required): The date when the event occurred. \ndetails(AWSJSON, optional): Additional details about the event in JSON format. \nsubject(String, optional): The subject associated with the event. \nplatformStandardId(String, optional): The platform ID of the associated standard. \nstandardId(String, optional): The external ID of the associated standard. \nplatformClusterId(String, optional): The platform ID of the associated cluster. \nclusterId(String, optional): The external ID of the associated cluster. \nplatformDomainId(String, optional): The platform ID of the associated domain. \ndomainId(String, optional): The external ID of the associated domain. \nplatformAcademicCourseId(String, optional): The platform ID of the associated academic course. \nacademicCourseName(String, optional): The name of the associated academic course. \n
The Events module is responsible for handling various application events within the CoachBot platform. It ensures that events are published, processed, and managed efficiently to support the platform's functionality.
\n","_postman_id":"15aab01e-38b7-4c40-a5e4-bb7bb1a42e66"},{"name":"Curriculum","item":[{"name":"getCurriculum","id":"fc862630-4e1d-49e3-bc5b-565162953352","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"AUTO_GEN_GRAPHQL_ID_TOKEN"}],"body":{"mode":"graphql","graphql":{"query":"query MyQuery($filters: GetCurriculumInput) {\n getCurriculum(filters: $filters) {\n subjects {\n courses {\n domains {\n alias\n category\n clusters {\n externalId\n name\n standards {\n platformId\n description\n descriptionPlus\n externalId\n parentId\n }\n }\n useInContentGeneration\n platformId\n externalId\n name\n thumbnailUrl\n imageUrl\n standards {\n platformId\n description\n externalId\n thumbnailUrl\n imageUrl\n }\n }\n useInContentGeneration\n platformId\n externalId\n name\n thumbnailUrl\n imageUrl\n }\n platformId\n grade {\n grade\n name\n }\n platformId\n mainImageUrl\n name\n order\n thumbnailUrl\n useInContentGeneration\n }\n image\n name\n platformId\n }\n }\n}","variables":"{\n \"filters\": {}\n}"}},"url":"GRAPHQL_URL","description":"The getCurriculum endpoint accepts a number of optional filters in the input, and returns an array of Subjects that fit the input filters.
Each Subject in the output has the following nested structure:
Subject\n โโ Courses\n โโ Domains\n โโ Clusters\n โโ Standards\n\nInput
\nThe inputs for getCurriculum are:
- \n
\nsubjectNames(string array, optional): An array of subject names to filter by \n
\ncourseNames(string array, optional): An array of course names to filter by \n
\ndomainExternalIds(string array, optional): An array of domain external ids to filter by \n
\nclusterExternalIds(string array, optional): An array of cluster external ids to filter by \n
\nstandardExternalIds(string array, optional): An array of standard external ids to filter by \n
\nlearningAppName(string, optional): learningAppName like \"TeachTap\" to filter by \n
Output
\nCurriculum {\n subjects: CurriculumSubject[];\n}\nCurriculumSubject {\n platformId: string;\n name: string;\n image: string | null;\n courses: CurriculumCourse[];\n}\nCurriculumCourse {\n platformId: string;\n name: string;\n order: number;\n grade: {\n grade: string;\n name: string;\n };\n useInContentGeneration: boolean;\n mainImageUrl: string | null;\n thumbnailUrl: string | null;\n domains: CurriculumDomain[];\n}\nCurriculumDomain {\n platformId: string;\n externalId: string;\n parentId: string;\n name: string;\n alias: string;\n order: number | null;\n useInContentGeneration: boolean;\n clusters: CurriculumCluster[];\n imageUrl: string | null;\n thumbnailUrl: string | null;\n category: string | null;\n}\nCurriculumCluster {\n platformId: string;\n externalId: string;\n name: string;\n order: number | null;\n useInContentGeneration: boolean;\n imageUrl: string | null;\n thumbnailUrl: string | null;\n standards: CurriculumStandard[];\n}\nCurriculumStandard {\n platformId: string;\n externalId: string;\n description: string;\n descriptionPlus: string | null;\n order: number | null;\n imageUrl: string | null;\n thumbnailUrl: string | null;\n useInContentGeneration: boolean;\n}\n\nReturns a paginated list of standards with their dependencies for a given subject.
\nInput
\n- \n
subject(string, required): The name of the subject to get standards for \nafter(string, optional): Pagination cursor to get the next page of results \nlimit(int, optional): Maximum number of standards to return \n
Output
\nThe output contains a paginated list of standards with their dependencies:
\n- \n
next(string, optional): Cursor for the next page of results \ndata(array): List of StandardWithDependenciesOutput objects \n
StandardWithDependenciesOutput Object
\n- \n
platformId(string): The platform identifier for this standard \nid(string): The standard identifier \nparentPlatformId(string, optional): The platform identifier of the parent standard \nname(string, optional): The name of the standard \ndescription(string): The description of the standard \ndependsOn(array): List of StandardWithRelationOutput objects that this standard depends on \n
StandardWithRelationOutput Object
\n- \n
platformId(string): The platform identifier for this standard \nid(string): The standard identifier \nparentPlatformId(string, optional): The platform identifier of the parent standard \nname(string, optional): The name of the standard \ndescription(string): The description of the standard \ntype(string): The type of the standard \n
The Curriculum module is designed to model educational curricula based on standards set by official third-party standards organizations. This module is integral for aligning educational content, assessments, and student learning objectives with recognized academic benchmarks.
\n","_postman_id":"e55ff0b9-1506-40a9-b7bf-8d932374b22a"},{"name":"Common Events","item":[],"id":"62ccf039-9ac4-4250-8872-7c6876d18ae8","description":"This section includes the format & details for Events that we emit for external consumers.
\nLevel Mastery Updated Event
\nThis event is triggered whenever there is a modification in the Level Mastery entity. For example, change in the mastery percentage.
\nApps that we currently emit this event for:
\n- \n
IXL
\n \nKhan Academy
\n \nKnewton
\n \nAny app integrated via our Integration APIs
\n \n
Field Descriptions
\n- \n
studentId: Unique identifier for the student within the platform. [Deprecated]
\n \nexternalStudentId: External identifier for the student. [Deprecated]
\n \nlevelId: Unique identifier for the level within the platform. [Deprecated]
\n \napp: Name of the application or platform where the event occurred.
\n \ncourse: Name of the course associated with the event.
\n \ntopic: Name of the specific topic within the course related to the event.
\n \nlevel: Name of the specific level within the topic related to the event.
\n \nthirdPartyLevelId: Unique identifier for the level within a third-party system. [Deprecated]
\n \nmasteryPercentage: Percentage of mastery achieved by the student.
\n \nisLevelMastered: Boolean indicating whether the level has been mastered by the student. This would set to TRUE for both mastery and remastery.
\n \nplatformStudentId: Unique identifier for the student within the platform.
\n \nschoolStudentId: School-specific identifier for the student.
\n \nschoolId: Unique identifier for the school associated with the student.
\n \nemail: Email address of the student.
\n \nappLevel: Object containing the platform-specific and third-party level identifiers.
\n- \n
platformLevelId: Unique identifier for the level within the platform.
\n \nlevelId: Unique identifier for the level within the third-party system.
\n \n
\nappTopic: Object containing the platform-specific and third-party topic identifiers.
\n- \n
platformTopicId: Unique identifier for the topic within the platform.
\n \ntopicId: Unique identifier for the topic within the third-party system.
\n \n
\nappCourse: Object containing the platform-specific and third-party course identifiers.
\n- \n
platformCourseId: Unique identifier for the course within the platform.
\n \ncourseId: Unique identifier for the course within the third-party system.
\n \n
\ntimestamp: Timestamp indicating when the event occurred.
\n \nactivityUnitsAttempted: Number of activity units attempted by the student.
\n \nactivityUnitsCorrect: Number of activity units correctly answered by the student.
\n \nmasteredAt: Timestamp indicating when the level was mastered.
\n \nstatus: Additional status information.
\n \nevent: Type of event being recorded (For ex: \"Question Answered - Mastery Change\").
\n \n
Example
\n{\n \"studentId\": \"8a2a1fe6-037b-435f-8d34-c5b2e72db6d3\",\n \"externalStudentId\": \"cloches.steeds.0m@icloud.com\",\n \"levelId\": \"a7c558e2-3447-4edf-966f-6bb52036c1fd\",\n \"app\": \"TeachTap\",\n \"course\": \"AP Psychology\",\n \"topic\": \"Introduction to Memory\",\n \"level\": \"Compare and contrast metacognition with other cognitive processes.\",\n \"thirdPartyLevelId\": \"27c564eb-4709-4699-989a-e4e9874fb47b\",\n \"masteryPercentage\": 20,\n \"isLevelMastered\": false,\n \"platformStudentId\": \"8a2a1fe6-037b-435f-8d34-c5b2e72db6d3\",\n \"schoolStudentId\": \"cloches.steeds.0m@icloud.com\",\n \"schoolId\": \"6346dd03-15b6-11ee-bbe3-12a0ee46e8c1\",\n \"email\": \"cloches.steeds.0m@icloud.com\",\n \"appLevel\": {\n \"platformLevelId\": \"a7c558e2-3447-4edf-966f-6bb52036c1fd\",\n \"levelId\": \"27c564eb-4709-4699-989a-e4e9874fb47b\"\n },\n \"appTopic\": {\n \"platformTopicId\": \"c99a3750-2915-425d-86cb-6aa1f6d17c2d\",\n \"topicId\": \"d8994cc5-4911-47a9-b6f3-895cb55d1bd6\"\n },\n \"appCourse\": {\n \"platformCourseId\": \"80906be0-7b54-4598-8a0d-55224b1946e1\",\n \"courseId\": \"71a81911-4a94-adfe-9b53-7405611d204e\"\n },\n \"timestamp\": \"2024-05-22T10:34:26.205Z\",\n \"activityUnitsAttempted\": 1,\n \"activityUnitsCorrect\": 1,\n \"masteredAt\": null,\n \"status\": null,\n \"event\": \"Question Answered - Mastery Change\"\n}\n\nMastery Test Result Updated Event
\nThis event is triggered whenever there is a modification in the Mastery Test Result entity. For example, change in the test status.
\nApps that we currently emit this event for:
\n- \n
Khan Academy
\n \nKnewton
\n \nAny app integrated via our Integration APIs
\n \n
Field Descriptions
\n- \n
platformSchoolId: Unique identifier for the school within the platform.
\n \nplatformStudentId: Unique identifier for the student within the platform.
\n \nemail: Email address of the student.
\n \nschoolStudentId: School-specific identifier for the student.
\n \ntimestamp: Timestamp indicating when the event occurred.
\n \nlearningAppName: Name of the learning application.
\n \nmasteryTestResult: Object containing details of the mastery test result.
\n- \n
platformId: Unique identifier for the mastery test within the platform.
\n \nname: Name of the mastery test.
\n \nmasteryTestId: Third party unique identifier for the mastery test.
\n \ncourse: Name of the course associated with the mastery test.
\n \nsubject: Subject of the mastery test.
\n \nplatformResultId: Unique identifier for the mastery test result within the platform.
\n \nmasteryTestResultId: Third party unique identifier for the mastery test result.
\n \nsentAt: Timestamp indicating when the test was sent.
\n \nsubmittedAt: Timestamp indicating when the test was submitted.
\n \ngrade: Percentage achieved by the student on the mastery test.
\n \nquestionsAnswered: Number of questions answered by the student.
\n \naccuracy: Accuracy percentage of the student's answers.
\n \nstatus: Status of the mastery test (e.g., \"completed\").
\n \nurl: URL link to the mastery test.
\n \nscore: Score achieved by the student on the mastery test.
\n \nquestionResults: Array of objects containing the results of individual questions.
\n- \n
platformId: Unique identifier for the question within the platform.
\n \nplatformQuestionResultId: Unique identifier for the question result within the platform.
\n \nid: Third party unique identifier for the question.
\n \nresult: Result of the question (e.g., \"correct\", \"incorrect\").
\n \nanswer: Student's answer to the question.
\n \n
\nmasteryTestUrl: URL link to the mastery test result.
\n \n
\n
Example
\n{\n \"platformSchoolId\": \"6346dd03-15b6-11ee-bbe3-12a0ee46e8c1\",\n \"platformStudentId\": \"d68552c6-6594-457b-87b2-45c29f66bd1a\",\n \"email\": \"epicfighterj@icloud.com\",\n \"schoolStudentId\": \"epicfighterj@icloud.com\",\n \"timestamp\": \"2024-05-22 05:01:24\",\n \"learningAppName\": \"TeachTap\",\n \"masteryTestResult\": {\n \"platformId\": \"1fca2cf7-e1ee-4a6c-86c9-d12599db7aa8\",\n \"name\": \"4f8c5697-13f6-4c5e-a7aa-8236a4643dd2\",\n \"masteryTestId\": \"99b1509c-025a-4614-a841-d0a2a69cfda4\",\n \"course\": \"AP US Government and Politics\",\n \"subject\": \"Government\",\n \"platformResultId\": \"56a5e1b7-5573-4943-b205-6e91957d30a3\",\n \"masteryTestResultId\": \"1fca2cf7-e1ee-4a6c-86c9-d12599db7aa8\",\n \"sentAt\": null,\n \"submittedAt\": \"2024-05-22 05:01:24\",\n \"grade\": 54,\n \"questionsAnswered\": 13,\n \"accuracy\": 54,\n \"status\": \"completed\",\n \"url\": null,\n \"score\": 7,\n \"questionResults\": [\n {\n \"platformId\": \"6670dbf0-3c85-46c0-b519-a36f5acbd2e5\",\n \"platformQuestionResultId\": \"7aa5290d-99c4-4f64-a2a2-b27dd6f5b776\",\n \"id\": \"06397ec7-008a-4323-a291-76aec08e5f3b\",\n \"result\": \"incorrect\",\n \"answer\": \"Fiscal federalism\"\n },\n {\n \"platformId\": \"00653a79-8519-42ef-bb74-2b0bef22f939\",\n \"platformQuestionResultId\": \"a0d001bb-57f1-47eb-a45e-34f69f055e4a\",\n \"id\": \"19d06684-d011-46a0-b8d4-4c865a577797\",\n \"result\": \"correct\",\n \"answer\": \"The allocation of powers between national and state governments\"\n },\n {\n \"platformId\": \"671306f0-37da-48b8-8a87-ad07e6960ede\",\n \"platformQuestionResultId\": \"a39160b3-14af-489e-9de1-764dbe8de78c\",\n \"id\": \"31088447-4459-4dbc-8943-7f7f0d84365a\",\n \"result\": \"incorrect\",\n \"answer\": \"The primary goal of Congressional oversight is to gather legislative support for the passage of new laws.\"\n },\n {\n \"platformId\": \"20bf2599-8204-421a-ba7a-5783f32fbbea\",\n \"platformQuestionResultId\": \"6eb6501f-9553-47cc-8bce-ab0a3fc87526\",\n \"id\": \"611daab9-00d4-4629-bf6b-b3379a9aa3fc\",\n \"result\": \"correct\",\n \"answer\": \"The ACA's implementation represented concurrent powers, as it required both federal legislation and state-level cooperation for successful execution.\"\n },\n {\n \"platformId\": \"e6b5b5e3-a001-43d9-b0b2-ac0cf8db7c9b\",\n \"platformQuestionResultId\": \"a3c697cd-a5cf-435a-acef-ceae2fe85f5e\",\n \"id\": \"6c092480-bbe3-46a6-85c9-7ca5ea7f35b0\",\n \"result\": \"incorrect\",\n \"answer\": \"The resolution of the Nullification Crisis in 1832\"\n },\n {\n \"platformId\": \"0735b0ba-5bc4-4fe3-8e80-17ad97e2d41c\",\n \"platformQuestionResultId\": \"74ac33b4-1a12-4b87-a162-f87b50eb13b0\",\n \"id\": \"742b9cee-2397-49b8-82be-644b6b1bbc03\",\n \"result\": \"correct\",\n \"answer\": \"While US v. Lopez (1995) limited congressional power, McCulloch v. Maryland (1819) affirmed and expanded it.\"\n },\n {\n \"platformId\": \"0459cfdc-2b4a-4d87-b973-787b962652c1\",\n \"platformQuestionResultId\": \"031201b0-0246-4575-831f-4e04ca69dfc6\",\n \"id\": \"7490b2ee-b0d8-4917-9a7c-dd616f1a8134\",\n \"result\": \"correct\",\n \"answer\": \"The principle of pluralism\"\n },\n {\n \"platformId\": \"5d23fa93-0772-40d6-8258-a781771dae4b\",\n \"platformQuestionResultId\": \"97e8c0f3-c962-4a61-8ed1-b70f0d17294d\",\n \"id\": \"92c3f10d-3fb5-4d73-ac41-11c16005d33e\",\n \"result\": \"correct\",\n \"answer\": \"Interest groups lobbying Congress and the President and testifying at congressional committee hearings\"\n },\n {\n \"platformId\": \"9093dd73-8d89-4835-a9be-39ba975b6eb6\",\n \"platformQuestionResultId\": \"1c49fc48-edd6-4f03-b939-0e844e290d86\",\n \"id\": \"9f172540-891f-452a-be9e-afa61908f7e1\",\n \"result\": \"incorrect\",\n \"answer\": \"Citizens United v. FEC (2010)\"\n },\n {\n \"platformId\": \"acc5927b-a550-4275-babb-07366788f5af\",\n \"platformQuestionResultId\": \"73eb4ace-46a6-4b48-b4a5-605038ccabd3\",\n \"id\": \"a082ca4d-4b52-4377-8fe7-80055df445ab\",\n \"result\": \"correct\",\n \"answer\": \"Providing categorical grants for initiatives aligned with national objectives\"\n },\n {\n \"platformId\": \"651db95b-1a5e-4076-acc7-3125ed950cb9\",\n \"platformQuestionResultId\": \"e8b28727-321d-4747-b756-3e6c19db5641\",\n \"id\": \"dac8353e-6f4b-4b58-a36d-7a0e6a9786b0\",\n \"result\": \"incorrect\",\n \"answer\": \"The lack of a national court system to settle disputes\"\n },\n {\n \"platformId\": \"cd96ed0d-1609-44e5-a8b5-18c70c37f940\",\n \"platformQuestionResultId\": \"a9892a60-7b97-46b2-934a-8a067fcc76b5\",\n \"id\": \"f28c4118-7098-4a99-ab43-f509656a4b81\",\n \"result\": \"correct\",\n \"answer\": \"The Supreme Court overrules the state law due to the supremacy of federal law.\"\n },\n {\n \"platformId\": \"b832c23e-a6a1-41d8-86cd-7cf24ccc20e4\",\n \"platformQuestionResultId\": \"b382a659-ce21-4590-8e6a-c90c4841b0bb\",\n \"id\": \"fa571abc-ad60-468e-82de-bef3e113fda2\",\n \"result\": \"incorrect\",\n \"answer\": \"McCutcheon v. Federal Election Commission (2014)\"\n }\n ],\n \"masteryTestUrl\": \"\"\n }\n}\n\nThis endpoint retrieves the percentile ranking for a student's test score.
\nInput
\n- \n
\nscore(integer): The raw score achieved by the student on the test. \n
\ntestType(enum): The type of test taken.- \n
Allowed values
\n- \n
'MAP'
\n \n'SAT'
\n \n'CBE'
\n \n
\n
\n
\nscope(string): The educational scope or domain the test covers, such as 'Mathematics' or 'Reading' or 'Total'. \n
\ngrade(enum, optional): The educational grade level of the student when the test was taken.- \n
Allowed values
\n- \n
'PK'
\n \n'K'
\n \n'1'
\n \n'2'
\n \n'3'
\n \n'4'
\n \n'5'
\n \n'6'
\n \n'7'
\n \n'8'
\n \n'9'
\n \n'10'
\n \n'11'
\n \n'12'
\n \n'HS'
\n \n
\n
\n
\nseason(enum, optional): The season during which the test was administered- \n
Allowed values
\n- \n
'Fall'
\n \n'Spring'
\n \n'Winter'
\n \n
\n
\n
Output
\nThe output consists of an object with following attributes
\n- \n
\npercentile(integer): The percentile rank of the student's score. \n
\npercentile_extended(string): A string representation of the percentile rank. This can include additional descriptors or qualifiers based on specific thresholds or criteria (e.g., \"1-\", \"99+\"). \n
Input
\n- \n
\nmasteryTestId(string, required): Id of the test to fetch results for \n
\nlearningAppName(string, optional): Name of the learning app to fetch the mastery test result for \n
\nsubject(string, optional): Name of the subject to fetch related to the results we want to obtain \n
\nacademicCourseName(string, optional): Name of the course related to the test results. Need to have a subject provided as well \n
\nplatformStudentId(string, optional): The platform id of the student \n
\nemail(string, optional): The email of the student \n
\nschoolStudentId(string, optional): The id of the student within the school \n
\nplatformSchoolId(string, optional): The platform id of the school \n
Note: for identifying the student, one (and ONLY one) of the following must be included in the input:
\n- \n
\nplatformStudentId- \n
email\n
\n
\nschoolStudentId+platformSchoolId\n
Output
\nThe output consists of an object with the following properties:
\n- \n
\nplatformId(string): The platform id for the test \n
\nname(string): The name of the test \n
\nlearningAppName(string): The learning app the test belongs to \n
\nmasteryTestId(string): The external id of the test \n
\ncourse(string, optional): Name of the course the test is attached to \n
\nsubject(string, optional): Name of the subject the test if attached to \n
\nplatformResultId(string): The platform id of the result \n
\nmasteryTestResultId(string): The external id of the result \n
\nsentAt(string, optional): The iso formatted timestamp of when the test was sent \n
\nsubmittedAt(string, optional): The iso formatted timestamp of when the test was submitted \n
\nquestionsAnswered(int, optional): Amount of questions answered \n
\naccuracy(int, optional): Percentage of accuracy of the student in the test \n
\nstatus(string): Status of the test result \n
\nurl(string, optional): Url for the test result \n
\nmasteryTestUrl(string, optional): Url for the test \n
\nscore(int, optional): Score obtained for the test \n
\nmaxScore(int, optional): Max score that can be obtained for the test \n
\ngrade(string, optional): The grade obtained by the student \n
\ngradePercentage(int, optional): The grade percentage obtained by the student \n
\nstudentGrade(string, optional): The inferred official test grade the student would obtain, based on the grade obtained in this test, if available \n
\ntotalQuestions(int, optional): Amount of questions the test has \n
\nmasteryTestType(enum, string): The type of the mastery test- \n
\ngeneral\n
\ndiagnostic\n
\ncarelessness\n
\ntargeted\n
\npreparation\n
\nquiz\n
\nplacement\n
\n
\nappSpecificMasteryTestType(string): The app-specific type of the mastery test \n
\nquestionResults: List ofMasteryTestQuestionResultobjects \n
A MasteryTestQuestionResult object has the following structure:
\n- \n
\nplatformId(string): Platform id of the question \n
\nplatformQuestionResultId(string): Platform id of the question result \n
\nid(string): External id of the question \n
\nresult(enum, string): The result of this question.- \n
\ncorrect\n
\nincorrect\n
\nskipped\n
\n
\nanswer(string): Answer provided to the question by the student \n
\ngroupId(string, optional): Id of the group the question belongs to \n
\nlevelId(string, optional): The level id associated with the question \n
\ntopicId(string, optional): The topic id associated with the question \n
\nmasteryPercentage(float, optional): The mastery percentage for the question \n
\nscore(int, optional): The score obtained for the question \n
\nmaxScore(int, optional): The maximum score that can be obtained for the question \n
\nstate(enum, string, optional): The state of the mastery for this question.- \n
\nUNKNOWN\n
\nLEARNED\n
\nLEARNING\n
\n
\nrubricItemResults(array, optional): List ofRubricItemResultobjects with the rubric evaluation details for the question. \n
\nquestionShownAt(string, optional): The time when the question was shown \n
\nquestionAnsweredAt(string, optional): The time when the question was answered \n
\nquestionExplanationShownAt(string, optional): The time when the explanation for the question was shown \n
\nquestionFinishedReadingExplanationAt(string, optional): The time when the student finished reading the explanation for the question \n
RubricItemResult Object
\n- \n
\nname(string): The name of the rubric item \n
\nmaxScore(int): The maximum score of the rubric item \n
\nscore(int): The score obtained for the rubric item \n
\nfeedback(string, optional): The feedback provided for the rubric item \n
This endpoint retrieves all mastery test results matching the provided filters.
\nInput
\n- \n
\nmasteryTestId(string, optional): External id of the mastery test \n
\nmasteryTestResultId(string, optional): External id of the mastery test result \n
\nlearningAppName(string, optional): Name of the learning app \n
\nsubject(string, optional): Name of the subject \n
\nacademicCourseName(string, optional): Name of the academic course. Requiressubjectto be provided \n
\nplatformStudentId(string, optional): Platform id of the student. Must be provided ifschoolStudentIdandplatformSchoolIdare not provided \n
\nschoolStudentId(string, optional): External student ID for the school. Must be provided together withplatformSchoolId\n
\nplatformSchoolId(string, optional): Platform id of the school. Must be provided together withschoolStudentId\n
\nemail(string, optional): Email of the user. Must be provided ifplatformStudentIdandschoolStudentIdare not provided \n
Output
\nThe output consists of an object with the following attribute:
\n- \n
\nmasteryTestResults(array): An array of mastery test result objects, each containing the following attributes:- \n
\nplatformId(string): The platform id of the mastery test \n
\nlearningAppName(string): Name of the learning app \n
\nname(string): Name of the mastery test \n
\nmasteryTestId(string): External id of the mastery test- \n
course(string): Name of the course \n
\n
\nsubject(string): Name of the subject \n
\nplatformResultId(string): The platform id of the mastery test result \n
\nmasteryTestResultId(string): External id of the mastery test result \n
\nsentAt(string): ISO formatted timestamp when the test was sent \n
\nsubmittedAt(string): ISO formatted timestamp when the test was submitted \n
\ngrade(string, optinal): The grade obtained by the student \n
\ngradePercentage(int, optional): The grade percentage obtained by the student \n
\nquestionsAnswered(number): Number of questions answered \n
\naccuracy(number): Accuracy percentage \n
\nstatus(string): Status of the mastery test result \n
\nurl(string): URL of the mastery test \n
\nscore(number): Score of the test \n
\nstudentGrade(string): Grade of the student \n
\nmasteryTestType(enum, string): The type of the mastery test
Values- \n
\ngeneral\n
\ndiagnostic\n
\ncarelessness\n
\ntargeted\n
\npreparation\n
\nquiz\n
\nplacement\n
\n
\nappSpecificMasteryTestType(string): The app-specific type of the mastery test \n
\nquestionResults(array): An array of question result objects, each containing the following attributes:- \n
\nplatformId(string): The platform id of the question \n
\nplatformQuestionResultId(string): The platform id of the question result \n
\nid(string): External id of the question \n
\nresult(string): Result of the question \n
\nanswer(string): Answer to the question \n
\nlevelId(string): Level id associated with the question \n
\ntopicId(string): Topic id associated with the question \n
\nmasteryPercentage(number): Mastery percentage for the question \n
\nscore(int, optional): The score obtained for the question \n
\nmaxScore(int, optional): The maximum score that can be obtained for the question \n
\nstate(string): State of the question \n
\nquestionShownAt(Date): Timestamp when the question was shown \n
\nquestionAnsweredAt(Date): Timestamp when the question was answered \n
\nquestionExplanationShownAt(Date): Timestamp when the question explanation was shown \n
\nquestionFinishedReadingExplanationAt(Date): Timestamp when the question explanation was finished reading \n
\nrubricItemResults(array): An array with rubrics part of the question, each containing the following attributes:- \n
\nname(string): Name of the rubric \n
\ndescription(string): Description of the rubric \n
\nscore(number): The score awarded for this rubric's answer \n
\nmaxScore(number): Maximum rubric obtaininable score \n
\nfeedback(string, optional): Grading feedback of the rubric \n
\n
\n
\nmasteryTestUrl(string): URL of the mastery test \n
\nmaxScore(number | null): Maximum score of the test \n
\ntotalQuestions(number): Total number of questions in the test \n
\n
This endpoint allows to upsert a mastery test, with question, result and question result, all in one go, including the question to test and question to standard mappings and other auxiliar processes.
\nIf used to store placement mastery test responses, it will calculate the placement status and generate the initial student recommendation if placement has finished.
\nAdditionally for the placement test, the api will perform the following actions:
\n- \n
If the student answers a question correctly on a standard:
\n- \n
Create level mastery for the linked level with a mastery percentage of 100%.
\n \nCreate level mastery with a mastery percentage of 100% for all prerequisites of the standard.
\n \n
\nIf the student answers a question incorrectly on a standard:
\n- \n
Create level mastery for the linked level with a mastery percentage of 0%.
\n \nCreate level mastery with a mastery percentage of 0% for all dependencies of the standard.
\n \n
\n
Input
\n- \n
Valid student identifier: Please refer to the Student Identification section
\n \n
\nstudentAccountId(string): External id of the student account in the learning app \n
\nlearningAppName(string): Name of the learning app \n
\nsubject(string): Name of the subject \n
\nacademicCourseName(string): Name of the academic course \n
\nmasteryTestId(string): External id of the mastery test \n
\nmasteryTestName(string, optional): Name for the mastery test. If not provided it will be generated with the test type and learning app name \n
\nmasteryTestType(string enum, optional): Will default to 'placement' if not provided. Valid values:- \n
diagnostic
\n \ntargeted
\n \ncarelessness
\n \ngeneral
\n \nplacement
\n \nspaced_repetition
\n \n
\n
\nmasteryTestAppSpecificType(string, optional): Specific type for the test. Will default to the mastery test type if not provided \n
\nmasteryTestUrl(string, optional): Url for the mastery test. Empty if not provided \n
\nmasteryTestStatus(string enum, optional): Status of the test. Defaults to 'active' if not provided. Valid values:- \n
active
\n \ndeprecated
\n \n
\n
\nmaxScore(int): Max score for the test, 0 if not provided \n
\nquestionId(string): External id of the question \n
\ngroupId(string, optional): Id of the group the question belongs to \n
\nquestionName(string, optional): Name of the question, defaults to the external id if not provided \n
\nquestionUrl(string, optional): Url of the question, defaults to empty string if not provided \n
\nanswer(string, optional): Answer of the question, defaults to empty string if not provided \n
\nplatformStandardId(string): Platform id of the standard \n
\nresult(string enum): Result for the question. Valid values:- \n
correct
\n \nincorrect
\n \nskipped
\n \nskipped_optional
\n \n
\n
\nmasteryTestResultStatus(string enum, optional): Status for the result. Defaults to in progress. Valid values:- \n
completed
\n \nin progress
\n \nnot started
\n \nplaced on this level
\n \nsent targeted learning
\n \ncanceled
\n \nwaiting for interview
\n \nwaiting for retest
\n \nwaiting for targeted learning
\n \nsubmitted
\n \nnot taken
\n \n
\n
\ntimestamp(string): Iso formatted timestamp for the current test submission \n
\nquestionShownAt(string, optional): Iso formatted timestamp for the time the question was shown \n
\nquestionAnsweredAt(string, optional): Iso formatted timestamp for the time the question was answered \n
\nquestionExplanationShownAt(string, optional): Iso formatted timestamp for the time the question explanation was shown \n
\nquestionFinishedReadingExplanationAt(string, optional): Iso formatted timestamp for the time the question explanation was finished reading \n
Output
\nThe output consists of an array of objects having the following attributes:
\n- \n
\nplatformMasteryTestId(string): The platform id of the mastery test \n
\nplatformMasteryTestQuestionId(string): The platform id of the mastery test question \n
\nplatformMasteryTestResultId(string): The platform id of the mastery test result \n
\nplatformMasteryTestQuestionResultId(string): The platform id of the mastery test question result \n
\nlevelMasteryId(string, optional): The platform id of the level mastery if created \n
\nisLevelMastered(boolean): Whether the affected level was mastered as a result of this call \n
This endpoint allows to retrieve the mastery test statistics for a student and a learning app with an optional set of courses to filter for (all otherwise).
\nInput
\n- \n
Valid student identifier: Please refer to the Student Identification section
\n \n
\nlearningAppName(string): Name of the learning app \n
\nacademicCourses(array, optional): List of courses to filter for (AcademicCourseInput). All courses included if not provided or empty. \n
The AcademicCourseInput object has the following structure:
\n- \n
\nacademicCourseName(string): Name of the course \n
\nsubject(string): Name of the subject for this course \n
Output
\nThe output consists of an array of objects with the following properties:
\n- \n
\nacademicCourseName(string): Name of the course \n
\nsubject(string): Name of the subject for this course \n
\ntotalNumberOfQuestionsAnswered(int): The amount of mastery test questions the student answered for this course in total. \n
\ntotalNumberOfQuestionsCorrect(int): The amount of mastery test questions the student answered for this course correctly. \n
This mutation allows updating or creating a mastery test question result for a student.
\nInput
\n- \n
input(UpsertMasteryTestQuestionResultInput, required): The input object containing the mastery test question result details. \n
UpsertMasteryTestQuestionResultInput Object
\n- \n
\nmasteryTestId(ID, required): The ID of the mastery test. \n
\nmasteryTestResultId(String, optional): The ID of the mastery test result. \n
\nlearningAppName(String, required): The name of the learning app. \n
\nplatformStudentId(ID, optional): The platform ID of the student. \n
\nschoolStudentId(ID, optional): The school ID of the student. \n
\nplatformSchoolId(ID, optional): The platform ID of the school. \n
\nemail(String, optional): The email of the student. \n
\nquestionId(ID, required): The ID of the question. \n
\nresult(string enum, required): The result of the question. Valid values:- \n
correct
\n \nincorrect
\n \nskipped
\n \n
\n
\nanswer(String, optional): The answer provided by the student. \n
\nquestionShownAt(AWSDateTime, optional): The timestamp when the question was shown. \n
\nquestionAnsweredAt(AWSDateTime, optional): The timestamp when the question was answered. \n
\nquestionExplanationShownAt(AWSDateTime, optional): The timestamp when the question explanation was shown. \n
\nquestionFinishedReadingExplanationAt(AWSDateTime, optional): The timestamp when the student finished reading the explanation. \n
\nstudentAccountId(String, optional): The account ID of the student. \n
Output
\nThe output provides information about the updated or created mastery test question result.
\nUpsertMasteryTestQuestionResultOutput Object
\n- \n
\nplatformMasteryTestQuestionResultId(ID, required): The platform ID of the mastery test question result. \n
\nisLevelMastered(Boolean, required): Indicates whether the level is mastered. \n
Description
\nThis mutation allows the user to update or insert results for a mastery test associated with a specific student based on the provided input data. It returns identifiers associated with the successfully processed mastery test result.
\nInput
\n- \n
\ninput(UpsertMasteryTestResultInput, required): The input object containing details about the mastery test result that needs to be created or updated.UpsertMasteryTestResultInput Object
\n- \n
\nmasteryTestId(ID, required): The unique identifier of the mastery test. \n
\nmasteryTestResultId(String, optional): A unique identifier for the mastery test result. \n
\nlearningAppName(String, required): The name of the learning application. \n
\nplatformStudentId(ID, optional): The platform-specific identifier of the student. \n
\nschoolStudentId(ID, optional): The school-specific identifier of the student. \n
\nplatformSchoolId(ID, optional): The platform-specific identifier of the school. \n
\nemail(String, optional): The email address associated with the student. \n
\nstatus(String, required): The status of the mastery test result. \n
\nsentAt(String, optional): The timestamp when the result was sent. \n
\nsubmittedAt(String, optional): The timestamp when the result was submitted. \n
\nurl(String, optional): The URL related to the mastery test result. \n
\nscore(Int, optional): The score obtained in the mastery test. \n
\ngrade(String, optional): The grade associated with the mastery test result. \n
\ngradePercentage(Int, optional): The grade percentage achieved in the mastery test. \n
\n
Output
\nThe output is an object of type UpsertMasteryTestResultOutput.
UpsertMasteryTestResultOutput Object
\n- \n
platformMasteryTestResultId(ID, required): The unique identifier for the mastery test result on the platform. \n
Description
\nThis mutation allows users to create or update a mastery test with the provided input data. It returns an identifier for the successfully processed mastery test.
\nInput
\n- \n
- input (UpsertMasteryTestInput, required): The input object containing details about the mastery test that needs to be created or updated. \n
UpsertMasteryTestInput Object
\n- \n
\nmasteryTestId(String, required): The unique identifier of the mastery test. \n
\nname(String, required): The name of the mastery test. \n
\ncourse(String, required): The course associated with the mastery test. \n
\nsubject(String, required): The subject of the mastery test. \n
\nlearningAppName(String, required): The name of the learning application. \n
\ntype(String, required): The type of mastery test. Must be one of: 'diagnostic', 'targeted', 'carelessness', 'general', 'placement', or 'spaced_repetition'. \n
\nappSpecificType(String, required): The application-specific type of the mastery test. \n
\nstatus(String, required): The status of the mastery test. Must be either 'active' or 'deprecated'. \n
\nurl(String, required): The URL associated with the mastery test. \n
\nmaxScore(Int, optional): The maximum score possible for the mastery test. \n
\ntotalQuestions(Int, optional): The total number of questions in the mastery test. \n
\nmasteryUpdateMode(MasteryUpdateMode, optional): The mode for updating mastery. Defaults to \"onQuestionSubmission\" if not provided \n
Output
\n- \n
- The output is an object of type UpsertMasteryTestOutput. \n
UpsertMasteryTestOutput Object
\n- \n
- platformMasteryTestId (String, required): The unique identifier for the mastery test on the platform. \n
Documentation for upsertMasteryTestQuestionResult endpoint
\nThis mutation allows consumers to upsert (create or update) the result of a mastery test question for a student. This includes details about the student's response to a specific question in a mastery test, as well as timing and score information.
\nInput
\n- \n
input(UpsertMasteryTestQuestionResultInput, required): The input object containing information about the mastery test question result to be upserted. \n
UpsertMasteryTestQuestionResultInput Object
\n- \n
\nmasteryTestId(ID, required): The unique identifier of the mastery test associated with the question result. \n
\nmasteryTestResultId(String, optional): The identifier for the mastery test result. \n
\nlearningAppName(String, required): The name of the learning application associated with the mastery test. \n
\nplatformStudentId(ID, optional): The platform-specific identifier of the student who answered the question. \n
\nschoolStudentId(ID, optional): The identifier of the student within the school who answered the question. \n
\nplatformSchoolId(ID, optional): The platform-specific identifier of the school. \n
\nemail(String, optional): The email address of the student who answered the question. \n
\nquestionId(ID, required): The unique identifier of the question. \n
\nresult(QuestionResult, required): The result of the mastery test question.- \n
- Values:
correct,incorrect,skipped,skipped_optional. \n
\n- Values:
\nanswer(String, optional): The answer provided by the student. \n
\nquestionShownAt(AWSDateTime, optional): The date and time the question was shown to the student. \n
\nquestionAnsweredAt(AWSDateTime, optional): The date and time the question was answered. \n
\nquestionExplanationShownAt(AWSDateTime, optional): The date and time the explanation for the question was shown to the student. \n
\nquestionFinishedReadingExplanationAt(AWSDateTime, optional): The date and time the student finished reading the explanation for the question. \n
\nstudentAccountId(String, optional): The account identifier for the student in the learning application. \n
\nscore(Int, optional): The score the student obtained for this question. \n
\nrubricItemResults([RubricItemResultInput], optional): List of rubric item results associated with this question. \n
Output
\nThe output consists of an upserted mastery test question result, encapsulated in an UpsertMasteryTestQuestionResultOutput object.
UpsertMasteryTestQuestionResultOutput Object
\n- \n
\nplatformMasteryTestQuestionResultId(ID, required): The platform-specific identifier for the mastery test question result. \n
\nisLevelMastered(Boolean, required): A boolean that indicates whether the level associated with this question is mastered by the student. \n
Related Enums
\n- \n
- QuestionResult: An enum representing the possible outcomes of a mastery test question. The possible values are:
- \n
\ncorrect: The student's answer was correct. \n
\nincorrect: The student's answer was incorrect. \n
\nskipped: The question was skipped by the student. \n
\nskipped_optional: The question was an optional one and was skipped by the student. \n
\n
Documentation for upsertMasteryTestQuestionResults endpoint
\nThis mutation allows consumers to upsert (create or update) the results of mastery test questions for a student. This includes details about the student's response to a specific question in a mastery test, as well as timing and score information.
\nInput
\n- \n
input(UpsertMasteryTestQuestionResultsInput, required): The input object containing information about the mastery test question results to be upserted. \n
UpsertMasteryTestQuestionResultsInput Object
\n- \n
\nmasteryTestId(ID, required): The unique identifier of the mastery test associated with the question result. \n
\nmasteryTestResultId(String, optional): The identifier for the mastery test result. \n
\nlearningAppName(String, required): The name of the learning application associated with the mastery test. \n
\nplatformStudentId(ID, optional): The platform-specific identifier of the student who answered the question. \n
\nschoolStudentId(ID, optional): The identifier of the student within the school who answered the question. \n
\nplatformSchoolId(ID, optional): The platform-specific identifier of the school. \n
\nemail(String, optional): The email address of the student who answered the question. \n
\nquestionResults([UpsertMasteryTestQuestionResultsQuestionInput]): The list of question results with the fields available below \n
UpsertMasteryTestQuestionResultsQuestionInput object
\n- \n
\nquestionId(ID, required): The unique identifier of the question. \n
\nresult(QuestionResult, required): The result of the mastery test question.- \n
- Values:
correct,incorrect,skipped,skipped_optional. \n
\n- Values:
\nanswer(String, optional): The answer provided by the student. \n
\nquestionShownAt(AWSDateTime, optional): The date and time the question was shown to the student. \n
\nquestionAnsweredAt(AWSDateTime, optional): The date and time the question was answered. \n
\nquestionExplanationShownAt(AWSDateTime, optional): The date and time the explanation for the question was shown to the student. \n
\nquestionFinishedReadingExplanationAt(AWSDateTime, optional): The date and time the student finished reading the explanation for the question. \n
\nstudentAccountId(String, optional): The account identifier for the student in the learning application. \n
\nscore(Int, optional): The score the student obtained for this question. \n
\nrubricItemResults([RubricItemResultInput], optional): List of rubric item results associated with this question. \n
Output
\nThe output consists of an upserted mastery test question result, encapsulated in an UpsertMasteryTestQuestionResultsOutput object.
UpsertMasteryTestQuestionResultsOutput Object
\n- \n
results([UpsertMasteryTestQuestionsResultOutput], required): The results of each question that was submitted. \n
UpsertMasteryTestQuestionsResultOutput Object
\n- \n
\nquestionId(ID, required): The ID of the question this result pertains to. \n
\nplatformMasteryTestQuestionResultId(ID, required): The platform-specific identifier for the mastery test question result. \n
\nisLevelMastered(Boolean, required): A boolean that indicates whether the level associated with this question is mastered by the student. \n
Related Enums
\n- \n
QuestionResult: An enum representing the possible outcomes of a mastery test question. The possible values are:
\n- \n
\ncorrect: The student's answer was correct. \n
\nincorrect: The student's answer was incorrect. \n
\nskipped: The question was skipped by the student. \n
\nskipped_optional: The question was an optional one and was skipped by the student. \n
\n
Description
\nThe upsertMasteryTestQuestion mutation allows consumers to create or update a question in the mastery test associated with a specific learning application. This endpoint supports adding details about the question including its difficulty, associated standards, and rubric items, as well as optional metadata such as URLs and answers. The operation returns an identifier for the question on the platform, ensuring that the question is properly indexed and associated with the correct mastery test.
Input
\n- \n
input(UpsertMasteryTestQuestionInput, required): Contains details required to create or update a mastery test question. \n
UpsertMasteryTestQuestionInput Object
\n- \n
\nlearningAppName(String, required): The name of the learning application to which the mastery test question belongs. \n
\nquestionId(String, required): The unique identifier for the question. \n
\nname(String, required): The name of the question. \n
\ndifficulty(UpsertMasteryTestQuestionDifficulty, required): The difficulty level of the question.- \n
- Possible values:
easy,moderate,difficult,unknown. \n
\n- Possible values:
\nurl(String, optional): A URL linking to additional resources for the question. \n
\nanswer(String, optional): The correct answer for the question. \n
\nmaxScore(Int, optional): The maximum score that can be achieved for the question. \n
\nlevelId(String, optional): The identifier for the level associated with the question. \n
\ntopicId(String, optional): The identifier for the topic associated with the question. \n
\ncourseId(String, optional): The identifier for the course associated with the question. \n
\nstandards([UpsertMasteryTestQuestionStandard], optional): A list of standards associated with the question. \n
\nrubricItems([RubricItemInput], optional): A list of rubric items to evaluate the question. \n
\ngroupId(String, optional): The identifier for the group associated with the question. \n
UpsertMasteryTestQuestionStandard Object
\n- \n
\nstandardId(String, optional): The identifier for the standard. \n
\nplatformStandardId(String, optional): The platform-specific identifier for the standard. \n
\nstatus(MasteryTestQuestionStandardStatus, required): The status of the standard.- \n
- Possible values:
active,inactive. \n
\n- Possible values:
RubricItemInput Object
\n- \n
\nname(String, required): The name of the rubric item. \n
\ndescription(String, optional): A description of the rubric item. \n
\nmaxScore(Int, required): The maximum score available for the rubric item. \n
\nplatformStandardId(String, optional): Platform-specific identifier for the standard if applicable. \n
Output
\nThe output for this mutation includes an object with a single property containing the platform-specific identifier for the newly created or updated mastery test question.
\nUpsertMasteryTestQuestionOutput Object
\n- \n
\nplatformQuestionId(String, required): The platform-specific identifier for the mastery test question. \n
\nrubricItems([UpsertMasteryTestQuestionRubricItem], required): A list of rubric items associated with the mastery test question, encapsulating details such as the name, description, maximum score, and platform standard id. \n
UpsertMasteryTestQuestionRubricItem Object
\n- \n
\nname(String, required): The name of the rubric item. \n
\ndescription(String, optional): A description of the rubric item. \n
\nmaxScore(Int, required): The maximum score available for the rubric item. \n
\nplatformStandardId(String, optional): Platform-specific identifier for the standard if applicable. \n
Description
\nThe upsertMasteryTestQuestions mutation enables consumers to create or update multiple questions in a mastery test simultaneously. This endpoint supports bulk operations for managing mastery test questions, their associated standards, and rubric items. It automatically handles sequence numbering for questions.
Input
\n- \n
input(`UpsertMasteryTestQuestionsInput` , required): Contains details required to create or update a mastery test and its associated questions. \n
UpsertMasteryTestQuestionsInput Object
\n- \n
\nlearningAppName(String, required): The name of the learning application. \n
\nsubject(String, required): The subject name for the mastery test. \n
\nacademicCourseName(String, required): The name of the academic course. \n
\nmasteryTestId(String, required): External identifier for the mastery test. \n
\nmasteryTestName(String, optional): Name of the mastery test. Defaults to \"{masteryTestType} - {learningAppName}\" if not provided. \n
\nmasteryTestType(String enum, required): Type of the mastery test. - Possible values: diagnostic, targeted, carelessness, general, placement, or spaced_repetition \n
\nmasteryTestAppSpecificType(String, optional): Application-specific type. Defaults to masteryTestType if not provided. \n
\nmasteryTestUrl(String, optional): URL for the mastery test. Defaults to empty string if not provided. \n
\nmasteryTestStatus(String enum, optional): Status of the test. - Possible values: active, deprecated - Defaults to \"active\" if not provided \n
\nmasteryUpdateMode(MasteryUpdateMode, optional): The mode for updating mastery. Defaults to \"onQuestionSubmission\" if not provided \n
\nmaxScore(Int, optional): Maximum score for the test. \n
\nmasteryTestQuestions(Array[MasteryTestQuestion], required): Array of questions to be created or updated. - Maximum 50 questions per request \n
MasteryTestQuestion Object
\n- \n
\nquestionId(String, required): External identifier for the question. \n
\nname(String, optional): Name of the question. Defaults to questionId if not provided. \n
\ndifficulty(String enum, optional): Difficulty level of the question.- \n
Possible values: easy, moderate, difficult, unknown
\n \nDefaults to \"unknown\" if not provided
\n \n
\n
\nurl(String, optional): URL for the question. Defaults to empty string if not provided. \n
\nanswer(String, optional): Answer for the question. Defaults to empty string if not provided. \n
\nplatformStandardId(String, optional): Platform identifier for the associated standard. \n
\nmaxScore(Int, optional): Maximum score for the question. \n
\nlevelId(String, optional): The identifier for the level associated with the question. \n
\ntopicId(String, optional): The identifier for the topic associated with the question. \n
\ncourseId(String, optional): The identifier for the course associated with the question. \n
\nrubricItems(Array[RubricItemInput], optional): Array of rubric items for evaluating the question. \n
RubricItemInput Object
\n- \n
\nname(String, required): The name of the rubric item. \n
\ndescription(String, optional): A description of the rubric item. \n
\nmaxScore(Int, required): The maximum score available for the rubric item. \n
\nplatformStandardId(String, optional): Platform-specific identifier for the standard if applicable. \n
Output
\nThe mutation returns an object containing the platform identifier for the mastery test and identifiers of the processed questions.
\nUpsertMasteryTestQuestionsOutput Object
\n- \n
\nplatformMasteryTestId(String, required): Platform identifier for the mastery test. \n
\nmasteryTestQuestions(Array[MasteryTestQuestionOutput], required): Array of processed questions. \n
MasteryTestQuestionOutput Object
\n- \n
\nid(String, required): External identifier of the question. \n
\nplatformMasteryTestQuestionId(String, required): Platform identifier for the question. \n
UpsertMasteryTestStudentActivities Mutation
\nThis mutation facilitates the updating or inserting of activities related to student engagement with mastery tests within a learning application. It captures details about the student's actions and status for each mastery test question attempted, allowing for the holistic tracking of their performance and progress.
\nInput
\n- \n
input(UpsertMasteryTestStudentActivitiesInput, required): The input object containing details about the student activity to be upserted. \n
UpsertMasteryTestStudentActivitiesInput Object
\n- \n
\nplatformStudentId(ID, optional): The platform identifier for the student. \n
\nemail(String, optional): The email of the student. \n
\nschoolStudentId(ID, optional): The identifier of the student within the school. \n
\nplatformSchoolId(ID, optional): The platform identifier for the school. \n
\nstudentAccountId(String, optional): The account ID of the student within the platform, required to identify them uniquely. \n
\nlearningAppName(String, required): The name of the learning application handling the mastery test. \n
\nsubject(String, required): The subject field for the mastery test. \n
\nacademicCourseName(String, required): The academic course associated with the mastery test. \n
\nmasteryTestId(ID, required): The identifier for the mastery test. \n
\nmasteryTestResultId(String, optional): The identifier for the mastery test result. \n
\nmasteryTestName(String, optional): The name of the mastery test. \n
\nmasteryTestType(UpsertMasteryTestType enum, required): Type of the mastery test. - Possible values: general, diagnostic, carelessness, targeted, placement, or spaced_repetition. \n
\nmasteryTestAppSpecificType(String, optional): An application-specific categorization of the mastery test. \n
\nmasteryTestUrl(String, optional): The URL link to access the mastery test. \n
\nmasteryTestStatus(MasteryTestStatus, optional): The current status of the mastery test (active, deprecated). \n
\nmasteryUpdateMode(MasteryUpdateMode, optional): The mode for updating mastery. Possible values: onQuestionSubmission, onMasteryTestCompletion. Defaults to \"onQuestionSubmission\" if not provided \n
\nmaxScore(Int, optional): The maximum possible score for the mastery test. \n
\nscore(Int, optional): The actual score achieved by the student. \n
\ngrade(String, optional): The grade equating to the student's performance in the test. \n
\ngradePercentage(Int, optional): The percentage grade achieved. \n
\nmasteryTestResultStatus(String, optional): The success or completion status of the test result from the student's engagement. \n
\ntimestamp(String, required): The time at which the student activity was recorded. \n
\nmasteryTestQuestionResults(array of MasteryTestQuestionResultInput, required): A collection detailing each question result part of the mastery test. \n
MasteryTestQuestionResultInput Object
\n- \n
\nquestionId(String, required): The identifier for the question. \n
\ngroupId(String, optional): The group identifier for the question. \n
\nname(String, optional): The name or title of the question. \n
\nurl(String, optional): A URL link associated with the question. \n
\nanswer(String, optional): The student's answer to the question. \n
\nplatformStandardId(String, optional): The platform-specific standard ID related to the question. \n
\nresult(QuestionResult, required): The outcome of the student's answer to the question. Possible values: \"correct\", \"incorrect\", \"skipped\", \"skipped_optional\". \n
\nscore(Int, optional): Score awarded for the question. \n
\nmaxScore(Int, optional): Maximum possible score for the question. \n
\nquestionShownAt(AWSDateTime, optional): Date and time the question was displayed to the student. \n
\nquestionAnsweredAt(AWSDateTime, optional): Date and time the student's answer to the question was recorded. \n
\nquestionExplanationShownAt(AWSDateTime, optional): Date and time the explanation for the question was first shown. \n
\nquestionFinishedReadingExplanationAt(AWSDateTime, optional): Date and time when the student finished reviewing the explanation. \n
\nrubricItemResults(array of MasteryTestRubricItemResultInput, optional): Details of scored rubric items associated with the question. \n
MasteryTestRubricItemResultInput Object
\n- \n
\nname(String, required): The specific rubric item name. \n
\ndescription(String, optional): Description of the rubric item. \n
\nmaxScore(Int, required): Maximum score possible for this rubric item. \n
\nscore(Int, required): Score awarded for this rubric item. \n
\nplatformStandardId(String, optional): Platform-specific standard identifier related to this rubric item. \n
\nfeedback(String, optional): Feedback related to this rubric item. \n
Output
\nThe result of this operation is encapsulated in an UpsertMasteryTestStudentActivitiesOutput object, containing identifiers and results generated from the operation.
UpsertMasteryTestStudentActivitiesOutput Object
\n- \n
\nplatformMasteryTestId(String, required): The platform's unique identifier for the mastery test. \n
\nplatformMasteryTestResultId(String, required): The platform's unique identifier for the mastery test result. \n
\nmasteryTestQuestionResults(array of MasteryTestQuestionResultOutput, required): An array of objects detailing the results for each question. \n
MasteryTestQuestionResultOutput Object
\n- \n
\nquestionId(String, required): The unique identifier of the question. \n
\nplatformMasteryTestQuestionId(String, required): The platform's unique identifier for the question. \n
\nplatformMasteryTestQuestionResultId(String, required): The platform's unique identifier for the question result. \n
The getMasteryTestQuestion query retrieves detailed information about a specific mastery test question, including its characteristics such as difficulty, associated standards, and any rubric items. This information helps educators and administrators to evaluate the question structure and its relevance in the assessment.
Input
\n- \n
\ninput(GetMasteryTestQuestionInput, required): The input object containing details about the question to retrieve.GetMasteryTestQuestionInput Object
\n- \n
\nquestionId(String, required): The unique identifier of the question. \n
\nlearningAppName(String, required): The name of the learning application associated with the question. \n
\n
Output
\nThe output is an object providing comprehensive details about the mastery test question encapsulated in a GetMasteryTestQuestionOutput object.
GetMasteryTestQuestionOutput Object
\n- \n
\nplatformId(String, required): The platform-specific identifier of the question. \n
\nname(String, required): The name or title of the question. \n
\ndifficulty(String, required): The difficulty level of the question. Possible values include:- \n
\neasy\n
\nmoderate\n
\ndifficult\n
\nunknown\n
\n
\nurl(String, optional): The URL pointing to the question content or location, if applicable. \n
\nanswer(String, optional): The answer to the question, if available. \n
\nmaxScore(Int, optional): The maximum score possible for this question. \n
\nmasteryTests([QuestionMasteryTestMapping!], required): A list ofQuestionMasteryTestMappingobjects mapping the question to various mastery tests.QuestionMasteryTestMapping Object
\n- \n
\nplatformId(String, required): The platform-specific identifier of the mastery test question. \n
\nid(String, required): The identifier of the particular mastery test question. \n
\nsequenceNumber(Int, required): The sequence order of this question within the test. \n
\n
\nstandards([MasteryTestQuestionStandard!], required): A list of standards associated with the question, each being aMasteryTestQuestionStandardobject.MasteryTestQuestionStandard Object
\n- \n
\nstandardId(String, required): The identifier for the standard associated with the question. \n
\nstatus(MasteryTestQuestionStandardStatus, required): The current status of the standard.Possible values are:
\n- \n
\nactive\n
\ninactive\n
\n
\n
\nappLevel(PlatformResourceWithName, optional): Indicates the app level resource associated with the question if available. Structure as:- \n
\nid(String, required): Identifier for the app level resource. \n
\nplatformId(String, required): Platform-specific identifier for the app level resource. \n
\nname(String, optional): Name of the app level resource. \n
\nRubricItem Object
\n- \n
\nname(String, required): The name of this rubric item. \n
\ndescription(String, optional): The description providing details about the rubric item. \n
\nmaxScore(Int, required): The maximum score assignable via this rubric item. \nMasteryTestQuestionRubricItemStandard Object
\n- \n
\nplatformStandardId(String, optional): Platform-specific standard identifier. \n
\nstandardId(String, optional): The general identifier for the standard. \n
\n
\n
This output enables a comprehensive understanding of the question's characteristics and its alignment with standards, aiding the assessment design and review.
\n","urlObject":{"host":["GRAPHQL_URL"],"query":[],"variable":[]}},"response":[],"_postman_id":"d755715f-5f60-487b-b9c9-4e853f76c43c"}],"id":"9c025172-9172-4391-ba63-00d70e457418","description":"The mastery tests module lets consumers perform several operations on the mastery tests entities to allow external apps to add and update their own mastery tests and results seamlessly
\n","_postman_id":"9c025172-9172-4391-ba63-00d70e457418"},{"name":"Payments","item":[{"name":"createStripePaymentIntent","id":"69540624-822c-4df5-96cd-acda656118e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"AUTO_GEN_GRAPHQL_ID_TOKEN"}],"body":{"mode":"graphql","graphql":{"query":"mutation CreateStripePaymentIntent($input: CreateStripePaymentIntentInput!) {\n createStripePaymentIntent(input: $input) {\n requiresAction\n clientSecret\n success\n id\n nextAction {\n type\n }\n error\n status\n }\n}","variables":"{\n \"input\": {\n \"priceId\": \"price_1PU5M3G3m7zXBg5p16Yb3iik\",\n \"email\": \"ayrton.senna@test.com\",\n \"name\": \"Test User\",\n \"program\": \"ma_grade_advancement\",\n \"voucherType\": \"Unlimited Subscription\",\n \"returnUrl\": \"https://magicacademy.learnwith.ai/payment-confirmation?session_id={CHECKOUT_SESSION_ID}\",\n \"paymentMethodId\": \"pm_1PnicrG3m7zXBg5pjCPN4EPX\",\n \"metadata\": \"{\\\"studentID\\\": \\\"ce5bd590-75f2-11ea-b707-067ee555162f\\\"}\"\n }\n}"}},"url":"GRAPHQL_URL","description":"This endpoint creates a Stripe payment intent for processing payments. It takes payment details as input and returns the created payment intent information. It also can create Stripe subscriptions if the the subscribe parameter is sent as true. For this cases, we will use the customerId provided as input, if any, otherwise, we will try to fetch it from Stripe, or ultimately create a new customer if none is found. In this case the paymentMethodId provided in the request will be attached to the customer we created or retrieved.
Input
\nThe input is an object of type CreateStripePaymentIntentInput with the following properties:
- \n
\npriceId: Stripe price ID for the product/service \n
\nemail(string): The customer's email address. \n
\nname(string, optional): The customer's name. \n
\nprogram(string): The program associated with the payment. \n
\nvoucherType(string): The type of voucher for the payment. \n
\nreturnUrl(string): The URL to redirect the user after the payment process. \n
\ncustomerId(string, optional): The stripe customer id owning the payment method. Required for subscriptions \n
\npaymentMethodId(string): The ID of the payment method to be used. \n
\nstudentName(string, optional): The name of the student, if different from the customer. \n
\nstudentEmail(string, optional): The email of the student, if different from the customer. \n
\nplatformStudentId(string, optional): An identifier for the student on the platform. \n
\nsubscribe(boolean, optional): Indicates if this is a subscription payment. \n
\nstartCourseName(string, optional): The name of the starting course for enrollment. \n
\nendCourseName(string, optional): The name of the ending course for enrollment. \n
\nsubject(string, optional): The subject of the course(s). \n
\nenrollmentStartDate(string, optional): The start date for the enrollment. \n
\nmetadata(JSON, optional): Additional metadata for the payment intent. \n
Output
\n- \n
\nrequiresAction(boolean): Indicates if further action is required to complete the payment. \n
\nclientSecret(string, optional): The client secret for the payment intent, used for client-side confirmation. \n
\nsuccess(boolean): Indicates if the payment intent creation was successful. \n
\nid(string): The ID of the created payment intent. \n
\nnextAction(object, optional): Information about the next action required, if any.- \n
\ntype(string): The type of action required. \n
\nredirect_to_url(object, optional): Contains a URL for redirection if needed.- \n
url(string): The URL to redirect to. \n
\n
\n
\nerror(string, optional): Error message if the payment intent creation failed. \n
\nstatus(string, optional): The status of the payment intent. \n
This endpoint is used to create a checkout session for a either a one time purchase or a subscription creation in stripe and configure the voucher that will be generated after purchase
\nInput
\n- \n
\npriceId(string): The stripe priceId of the item to purchase \n
\nsuccessUrl(string): The url to redirect the user on succesful purchase \n
\ncancelUrl(string): The url to redirect the user on canceled purchase \n
\nprogram(string): The program the purchased voucher will be linked to \n
\nvoucherType(string): The voucher type the purchased voucher will have \n
\nstartCourseName(string, optional): The course name the automatic enrollment will start from, if provided \n
\nendCourseName(string, optional): The course name the automatic enrollment will end at, if provided \n
\nsubject(string, optional): The subject for the enrollment courses. Needs to be provided if either startCourseName or endCourseName are provided. \n
\nenrollmentStartDate(string, optional): The date the automatic enrollment will start. \n
\nmode(string enum, optional): The checkout session mode, defaulting to 'payment'. Valid value:- \n
\nsubscription\n
\npayment\n
\n
\nplatformStudentId(string, optional): Id of the student the voucher is for \n
\nstudentEmail(string, optional): Email fo the student the voucher is for \n
\nstudentName(string, optional): Name of the student the voucher is for \n
\nparentEmail(string, optional): Email of the parent purchasing the voucher \n
\nparentName(string, optional): Name of the parent purchasing the voucher. \n
Note: Either platformStudentId or studentEmail can be provided. It's not possible to provide both at the same time. If provided, the related form fields will be removed. Likewise, for the parent email, if provided, it will be locked on the form as customer email.
\nOutput
\nThe output consists of an object having the following attribute:
\n- \n
checkoutSessionId(string): The id of the created checkout session \n
This endpoint is used to fetch the enrollment status attached to a particular voucher purchase by payment gateway and transaction id
\nInput
\n- \n
\npaymentProvider(string, required): The name of the payment provider used to perform the purchase. \n
\ntransactionId(string, required): The unique id of the purchase transaction \n
Output
\nThe output consists of an object having the following attribute:
\n- \n
\ncheckoutSessionId(string): The id of the created checkout session \n
\nparentEmail(string): The email of the parent making the purchase \n
\nstudentEmail(string, optional): The email of the student the purchase was made in behalf of \n
\nstudentExists(boolean): Whether the student exists or not \n
\nisEnrolled(boolean): Whether the student is enrolled or not \n
\nprogram(string): Program key the voucher purchase is attached to \n
\nstartDate(string, optional): If student exists and is enrolled, iso formatted date when the enrollment started \n
\nendDate(string, optional): If student exists and is enrolled, and enrollment is not unlimited, iso formatted date when the enrollment ended \n
\nvoucher(string): Code of the purchased voucher \n
\nvoucherType(string): Type of the purchased voucher \n
\nmetadata(string): Metadata for the purchase \n
This endpoint is used to manage a Stripe payment intent, allowing for checking the status or confirming the payment.
\nInput
\nThe input is defined by the ManageStripePaymentIntentInput schema:
- \n
\npaymentIntentId(string): The ID of the Stripe payment intent to manage. \n
\naction(enum): The action to perform on the payment intent. Can be either:- \n
\ncheck_status: Check the current status of the payment intent. \n
\nconfirm: Confirm the payment intent. \n
\n
\nreturnUrl(string, optional): The URL to return to after confirming the payment. This is required when the action ischeck_status. \n
Output
\nThe output is defined by the ManageStripePaymentIntentOutput interface:
- \n
\nstatus(string): The current status of the payment intent. \n
\namount(number, optional): The amount of the payment. \n
\ncurrency(string, optional): The currency of the payment. \n
\nmetadata(Record, optional): Any metadata associated with the payment intent. \n
\nrequiresAction(boolean, optional): Indicates if further action is required to complete the payment. \n
\nclientSecret(string, optional): The client secret of the payment intent, used for handling the payment on the client side. \n
\nnextAction(object, optional): Information about the next action required, if any:- \n
\ntype(string): The type of the next action. \n
\nredirect_to_url(object, optional):- \n
url(string): The URL to redirect to for the next action. \n
\n
\n
\nerror(string, optional): Error message, if any. \n
\ntype(string, optional): The type of the error, if any. \n
\ncode(string, optional): The error code, if any. \n
\ndeclineCode(string, optional): The decline code, if the payment was declined. \n
\nparam(string, optional): The parameter related to the error, if any. \n
This endpoint allows to get the details for all the payments related to a student, optionally filtering by program key.
\nInput
\n- \n
Valid student identifier: Please refer to the Student Identification section
\n \n
\nprogram(string, optional): The key for the program we want to filter, if any. \n
Output
\nThe output consists of an object with a single property \"payments\" which is an array of objects having the following attributes that will be returned if available:
\n- \n
\npaymentProvider(string): The provider related to the payment \n
\ntransactionId(string): The transaction id for the payment \n
\nparentEmail(string): The parent email for the payment \n
\nstudentEmail(string): The student email for the payment \n
\nstudentId(string): The studentId for the payment \n
\nvoucherId(string): The voucher id for the payment \n
\nstartCourseId(string): The id for the course the enrollment for this payment was set to start with \n
\nendCourseId(string): The id for the course the enrollment for this payment was set to end with \n
\nsubjectName(string): The name of the subject the enrollment for this payment was set to be for \n
\nenrollmentStartDate(string): The selected date for enrollment starting for the purchase \n
\npurchaseSource(string): The source of the purchase \n
\nmetadata(string): The metadata for the purchase \n
\nvoucherRedemptionDate(string): The date the related voucher was redeemed at \n
\nprogram(string): The key for the program this purchase belongs to \n
\nprogramEnrollmentStartDate(string): The start date for the enrollment associated to this purchase \n
\nprogramEnrollmentEndDate(string): The end date for the enrollment associated to this purchase \n
The payments module contains all endpoints around payments creation and management
\n","_postman_id":"9086d8ce-d56d-418a-bb12-d7034cd0c009"},{"name":"Quiz","item":[{"name":"getStandardsForQuiz","id":"fe0b593c-7d6c-43de-b7e6-8cde4c04be84","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"AUTO_GEN_GRAPHQL_ID_TOKEN"}],"body":{"mode":"graphql","graphql":{"query":"query GetStandardsForQuiz($input: GetStandardsForQuizInput!) {\n getStandardsForQuiz(\n input: $input\n ) {\n standards {\n standardId\n platformStandardId\n }\n }\n}","variables":"{\n \"input\": {\n \"academicCourse\": \"Geometry\",\n \"subject\": \"Math\",\n \"domain\": \"CO\",\n \"quizAlgorithm\": \"EXAM_WEIGHTED_DOMAIN_TEST\"\n }\n}\n"}},"url":"GRAPHQL_URL","description":"Use this endpoint to get standards recommended to be used for building a quiz for a specific course, subject and domain, optionally providing a learning app name filter and a quiz algorithm.
\nInput
\n- \n
\nacademicCourse(string, required): The name of the course the quiz is for \n
\nsubject(string, required): The name of the subject the quiz is for \n
\ndomain(string, required): The external id of the domain the quiz is for \n
\nlearningAppName(string, optional): The app the quiz is for \n
\nquizAlgorithm(enum, optional): The algorithm applied to calculate the standards involved. If not provided it defaults to \"EXAM_WEIGHTED_DOMAIN_TEST\".- \n
Allowed values
\n- \n
EXAM_WEIGHTED_DOMAIN_TEST
\n \nDOMAIN_WEIGHTED_TEST
\n \nINITIAL_STATIC_PLACEMENT_TEST
\n \n
\n
\n
Quiz Algorithms
\nEXAM_WEIGHTED_DOMAIN_TEST
\nThe EXAM_WEIGHTED_DOMAIN_TEST algorithm generates a tailored list of standards for creating quizzes. Here's how the algorithm operates:
\n- \n
Get the number of question configurations at a standard level. Based on that, if a standard is designated to have multiple questions, it appears multiple times in the list.
\n \nOrders the standards according to their sequence in the curriculum to reflect educational priorities.
\n \nIf the total number of questions (including repeated standards) is less than 5, the API doubles the occurrence of each standard.
\n \n
DOMAIN_WEIGHTED_TEST
\nThe DOMAIN_WEIGHTED_TEST algorithm generates a tailored list of standards aligned with questions required at a domain level. Here's how it works:
\n- \n
The algorithm identifies the number of questions needed for the domain based on a predefined configuration at the Domain level.
\n \nIt gathers all standards associated with the domain and gets the number of questions for each standard based on a configuration at a Standard level.
\n \nSelect Standards:
\n- \n
If Required Questions โค Available Questions:
\n- \n
Randomly select the needed standards from the available ones.
\n \nStandards that offer more questions are more likely to be selected.
\n \nAfter a standard is chosen, its likelihood of being picked again is adjusted to reflect the remaining questions it can provide.
\n \n
\nIf Required Questions > Available Questions:
\n- \n
Include all available standards according to their question counts.
\n \nFor the additional required questions, randomly select from the standards again.
\n \n
\n
\nAssign Difficulties:
\n- \n
If external test weights are defined:
\n- \n
Calculate the number of questions for each difficulty level (easy, medium, hard) based on the weights.
\n \nAssign difficulties to the selected standards proportionally according to these weights.
\n \n
\nIf external test weights are not defined (total weight is 0):
\n- \n
- Distribute the questions evenly across the three difficulty levels (easy, medium, hard). \n
\nIf no external test is linked to the domain:
\n- \n
- No difficulty will be assigned to the standards. \n
\n
\n
INITIAL_STATIC_PLACEMENT_TEST
\nThe INITIAL_STATIC_PLACEMENT_TEST algorithm returns all standards with Medium difficulty.
If the number of standards is less than 10, additional standards are selected based on their weights to ensure a minimum of 10 questions.
This ensures a comprehensive assessment by leveraging standard weightings to fill the gap when a domain has fewer standards.
Output
\nThe output consists of an object with a single property standards holding a list of StandardForQuiz objects.
A StandardRecommendation object has the following structure:
- \n
\nstandardId(string): The external id for the standard \n
\nplatformStandardId(string): The platform id for the standard \n
\ndifficulty(QuizDifficulty, optional): The difficulty level of the standard. \n
QuizDifficulty Enum
\n- \n
easy
\n \nmedium
\n \nhard
\n \n
Note: The output is a list of standards, where each occurrence represents a single question for that standard in the quiz. If the quiz requires multiple questions for a particular standard, the standard will appear multiple times in the list.
\n","urlObject":{"host":["GRAPHQL_URL"],"query":[],"variable":[]}},"response":[{"id":"792a9837-0c4e-4b27-8211-53fa0f9ea937","name":"Mandatory Parameters","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"AUTO_GEN_GRAPHQL_ID_TOKEN"}],"body":{"mode":"graphql","graphql":{"query":"query GetStandardsForQuiz($input: GetStandardsForQuizInput!) {\n getStandardsForQuiz(\n input: $input\n ) {\n standards {\n standardId\n platformStandardId\n difficulty\n }\n }\n}","variables":"{\n \"input\": {\n \"academicCourse\": \"AP US Government and Politics\",\n \"subject\": \"Government\",\n \"domain\": \"AP USGOV Unit 5\"\n }\n}\n"}},"url":"GRAPHQL_URL"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"data\": {\r\n \"getStandardsForQuiz\": {\r\n \"standards\": [\r\n {\r\n \"standardId\": \"EK 5.6.B.1\",\r\n \"platformStandardId\": \"8131dcae-f528-40e4-ac64-a4e84e4f4370\"\r\n },\r\n {\r\n \"standardId\": \"EK 5.4.A.2\",\r\n \"platformStandardId\": \"73ec5ca9-0ba3-4a97-bb34-128d675b340a\"\r\n },\r\n {\r\n \"standardId\": \"EK 5.12.A.2\",\r\n \"platformStandardId\": \"9abefd7d-214a-4718-8daf-dee04939dff4\"\r\n },\r\n {\r\n \"standardId\": \"EK 5.6.A.2\",\r\n \"platformStandardId\": \"3f58ccbf-cdfb-413f-981d-28a700acf497\"\r\n },\r\n {\r\n \"standardId\": \"EK 5.6.A.1\",\r\n \"platformStandardId\": \"6812ef0c-e5a7-4555-a60f-20afd8b286ba\"\r\n },\r\n {\r\n \"standardId\": \"EK 5.2.A.3\",\r\n \"platformStandardId\": \"20a06d5e-1b5f-4089-a757-349536c3c90a\"\r\n },\r\n {\r\n \"standardId\": \"EK 5.2.A.3\",\r\n \"platformStandardId\": \"20a06d5e-1b5f-4089-a757-349536c3c90a\"\r\n },\r\n {\r\n \"standardId\": \"EK 5.2.A.1\",\r\n \"platformStandardId\": \"94aa23cc-8210-4c45-bd96-23c1f88cca1e\"\r\n },\r\n {\r\n \"standardId\": \"EK 5.2.A.2\",\r\n \"platformStandardId\": \"bbedad3e-47ca-4db6-bc9f-708a3511d977\"\r\n },\r\n {\r\n \"standardId\": \"EK 5.3.B.1\",\r\n \"platformStandardId\": \"bbb6da58-ee25-4474-8b54-f1035dac992b\"\r\n },\r\n {\r\n \"standardId\": \"EK 5.8.B.1\",\r\n \"platformStandardId\": \"6c37d928-ea90-44ba-a55b-2ab66c0df104\"\r\n },\r\n {\r\n \"standardId\": \"EK 5.8.A.1\",\r\n \"platformStandardId\": \"bf8b0a80-2f7b-482d-aa15-d44ab29eb855\"\r\n },\r\n {\r\n \"standardId\": \"EK 5.13.A.2\",\r\n \"platformStandardId\": \"82331a29-ae98-41d5-9702-7933448f60d6\"\r\n },\r\n {\r\n \"standardId\": \"EK 5.13.A.3\",\r\n \"platformStandardId\": \"ee982e22-8f65-48b3-9eb8-e73fed8cb1d4\"\r\n },\r\n {\r\n \"standardId\": \"EK 5.7.A.1\",\r\n \"platformStandardId\": \"64fa4e27-aa8d-487f-a543-46b9889fdf4f\"\r\n },\r\n {\r\n \"standardId\": \"EK 5.1.A.1\",\r\n \"platformStandardId\": \"3395453d-9249-4a8a-913f-45945ee28f05\"\r\n },\r\n {\r\n \"standardId\": \"EK 5.1.B.1\",\r\n \"platformStandardId\": \"761e7617-3ff0-447a-9912-70d7d2473923\"\r\n }\r\n ]\r\n }\r\n }\r\n}"},{"id":"ffcd1472-209f-4990-adda-cb14a4162747","name":"All Parameters","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"AUTO_GEN_GRAPHQL_ID_TOKEN"}],"body":{"mode":"graphql","graphql":{"query":"query GetStandardsForQuiz($input: GetStandardsForQuizInput!) {\n getStandardsForQuiz(\n input: $input\n ) {\n standards {\n standardId\n platformStandardId\n }\n }\n}","variables":"{\n \"input\": {\n \"academicCourse\": \"AP US Government and Politics\",\n \"subject\": \"Government\",\n \"domain\": \"AP USGOV Unit 5\",\n \"learningAppName\": \"TeachTap\",\n \"quizAlgorithm\": \"EXAM_WEIGHTED_DOMAIN_TEST\",\n \"numberOfQuestions\": 5\n }\n}\n"}},"url":"GRAPHQL_URL"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"fe0b593c-7d6c-43de-b7e6-8cde4c04be84"}],"id":"42044abb-926b-440b-b80d-ad512edb1a10","description":"The quiz module contains all endpoints around quiz creation and consultation
\n","_postman_id":"42044abb-926b-440b-b80d-ad512edb1a10"},{"name":"Rewards","item":[{"name":"createStudentCurrencyTransaction","id":"89ed6b1a-246b-419f-bbb2-c4b9f25b6188","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"AUTO_GEN_GRAPHQL_ID_TOKEN"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"graphql","graphql":{"query":"mutation CreateStudentCurrencyTransaction($input: CreateStudentCurrencyTransactionInput!) {\r\n createStudentCurrencyTransaction(input: $input) {\r\n platformStudentCurrencyTransactionId\r\n }\r\n}","variables":"{\r\n \"input\": {\r\n \"platformStudentId\": \"c9b595ae-db50-11eb-81cb-976ec8547a05\",\r\n \"learningAppName\": \"TeachTower\",\r\n \"amount\": 10,\r\n \"currencyKey\": \"points\",\r\n \"transactionId\": \"external_id\",\r\n \"transactionDetails\": \"{\\\"something\\\": \\\"Something\\\"}\"\r\n }\r\n}"}},"url":"GRAPHQL_URL","description":"This API allows the creation of a student currency transaction, recording the details of the transaction for a specific student.
\nInput
\n- \n
input(CreateStudentCurrencyTransactionInput, required): The details of the student currency transaction to be created. \n
CreateStudentCurrencyTransactionInput
\n- \n
\nplatformStudentId(String, optional): Valid student identifier. Please refer to the Student Identification section. \n
\nschoolStudentId(String, optional): Valid student identifier. Please refer to the Student Identification section. \n
\nplatformSchoolId(String, optional): Valid student identifier. Please refer to the Student Identification section. \n
\nemail(String, optional): Valid student identifier. Please refer to the Student Identification section. \n
\nlearningAppName(String, required): The name of the learning application. \n
\namount(Float, required): The amount of currency involved in the transaction. \n
\ncurrencyKey(String, required): The key representing the type of currency. \n
\ntransactionId(String, optional): This should be unique to ensure we donโt process same reward for the student twice. If not passed we would use UUID. \n
\ntransactionDetails(AWSJSON, optional): Additional details about the transaction in JSON format. \n
Output
\nThe output is a StudentCurrencyTransaction object, which contains the details of the created student currency transaction.
StudentCurrencyTransaction
\n- \n
platformStudentCurrencyTransactionId(String, required): The unique identifier of the student currency transaction. \n
This API endpoint retrieves the reward configurations for a specified learning application. It returns both asset and currency rewards associated with the application.
\nInput
\n- \n
learningAppName(String, required): The name of the learning application for which to fetch reward configurations. \n
Output
\nThe output is an object of type GetRewardConfigurationsOutput, which contains lists of asset and currency rewards.
GetRewardConfigurationsOutput Object
\n- \n
\nassetRewards(Array of AssetReward, required): A list of asset rewards. \n
\ncurrencyRewards(Array of CurrencyReward, required): A list of currency rewards. \n
AssetReward Object
\n- \n
\neventType(String, required): The type of event triggering the reward. \n
\nrewardFrequencyType(String, required): The frequency type of the reward. \n
\nasset(String, required): The asset associated with the reward. \n
\nassetStatus(String, required): The status of the asset. \n
\nassetCategory(String, required): The category of the asset. \n
\namount(Int, required): The amount of the reward. \n
\nprogram(String, optional): The program associated with the reward. \n
\nprogramKey(String, optional): The key of the program. \n
\ncheckCourse(Boolean, required): Whether to check the course. \n
\nrewardsGroupKey(String, optional): The key of the rewards group. \n
\nexpectedEventData(AWSJSON, optional): The expected event data in JSON format. \n
CurrencyReward Object
\n- \n
\neventType(String, required): The type of event triggering the reward. \n
\nrewardFrequencyType(String, required): The frequency type of the reward. \n
\ncurrency(String, required): The currency associated with the reward. \n
\ncurrencyKey(String, required): The key of the currency. \n
\namount(Int, required): The amount of the reward. \n
\nprogram(String, optional): The program associated with the reward. \n
\nprogramKey(String, optional): The key of the program. \n
\ncheckCourse(Boolean, required): Whether to check the course. \n
\nrewardsGroupKey(String, optional): The key of the rewards group. \n
\nexpectedEventData(AWSJSON, optional): The expected event data in JSON format. \n
Input
\n- \n
learningAppName(String, required): The name of the learning application for which to fetch reward configurations. \n
Output
\nThe output is an object of type GetRewardConfigurationsOutput, which contains lists of asset and currency rewards.
GetRewardConfigurationsOutput Object
\n- \n
\nassetRewards(Array of AssetReward, required): A list of asset rewards. \n
\ncurrencyRewards(Array of CurrencyReward, required): A list of currency rewards. \n
AssetReward Object
\n- \n
\neventType(String, required): The type of event triggering the reward. \n
\nrewardFrequencyType(String, required): The frequency type of the reward. \n
\nasset(String, required): The asset associated with the reward. \n
\nassetStatus(String, required): The status of the asset. \n
\nassetCategory(String, required): The category of the asset. \n
\namount(Int, required): The amount of the reward. \n
\nprogram(String, required): The program associated with the reward. \n
\nprogramKey(String, required): The key of the program. \n
\ncheckCourse(Boolean, required): Whether to check the course. \n
\nrewardsGroupKey(String, optional): The key of the rewards group. \n
\nexpectedEventData(AWSJSON, optional): The expected event data in JSON format. \n
CurrencyReward Object
\n- \n
\neventType(String, required): The type of event triggering the reward. \n
\nrewardFrequencyType(String, required): The frequency type of the reward. \n
\ncurrency(String, required): The currency associated with the reward. \n
\ncurrencyKey(String, required): The key of the currency. \n
\namount(Int, required): The amount of the reward. \n
\nprogram(String, required): The program associated with the reward. \n
\nprogramKey(String, required): The key of the program. \n
\ncheckCourse(Boolean, required): Whether to check the course. \n
\nrewardsGroupKey(String, optional): The key of the rewards group. \n
\nexpectedEventData(AWSJSON, optional): The expected event data in JSON format. \n
\nrewardCalculationConfig(AWSJSON, optional): The dynamic reward calculation config in JSON format. \n
The getStudentOrders query retrieves a list of student orders based on various identifiers. This query is useful for fetching order details for a specific student.
\nInput
\ninput (GetStudentOrdersInput!, required): The input object containing the identifiers to fetch student orders.
GetStudentOrdersInput Object
\n- \n
\nplatformStudentId(String, optional): Valid student identifier. Please refer to the Student Identification section. \n
\nschoolStudentId(String, optional): Valid student identifier. Please refer to the Student Identification section. \n
\nplatformSchoolId(String, optional): Valid student identifier. Please refer to the Student Identification section. \n
\nemail(String, optional): Valid student identifier. Please refer to the Student Identification section. \n
Output
\nThe output is a list of StudentOrder objects.
\nStudentOrder Object
\n- \n
\nstudentOrderId(String, required): The unique identifier for the order. \n
\nstatus(String, required): The current status of the order. \n
\ncreatedOn(String, required): The date and time when the order was created. \n
\nlastModifiedOn(String, required): The date and time when the order was last modified. \n
\nassets([StudentOrderAsset!]!, required): A list of assets included in the order. \n
\nshippingDetails(ShippingDetails, optional): The shipping details for the order. \n
StudentOrderAsset Object
\n- \n
\nassetId(String, required): The unique identifier for the asset. \n
\nassetName(String, required): The name of the asset. \n
\nassetStoreItemId(String, required): The store item ID associated with the asset. \n
\namount(Int, required): The quantity of the asset. \n
\nprice(Float, required): The price of the asset. \n
\ncurrencyKey(String, required): The currency key for the asset. \n
\ncurrency(String, required): The currency used for the asset. \n
ShippingDetails Object
\n- \n
\nfullName(String, required): The full name of the recipient. \n
\naddressLine1(String, required): The first line of the address. \n
\naddressLine2(String, optional): The second line of the address. \n
\nphoneNumber(String, required): The phone number of the recipient. \n
\ncity(String, required): The city of the address. \n
\nzip(String, required): The ZIP code of the address. \n
\nstate(String, required): The state of the address. \n
Initiates a refund for a student's order. This mutation processes the refund and returns the details of the transactions involved.
\nInput
\n- \n
Valid student identifier: Please refer to the Student Identification section.
\n \n
\nstudentOrderId(String, required): The unique identifier of the student's order to be refunded. \n
Output
\nThe output is an InitiateRefundOutput object containing details of the currency and asset transactions involved in the refund.
InitiateRefundOutput Object
\n- \n
\ncurrencyTransactions([StudentCurrencyTransaction!], required): List of currency transactions involved in the refund. \n
\nassetTransactions([StudentAssetTransaction!], required): List of asset transactions involved in the refund. \n
StudentCurrencyTransaction Object
\n- \n
\nid(String, required): The unique identifier of the currency transaction. \n
\nstudentId(String, required): The unique identifier of the student. \n
\namount(Int, required): The amount involved in the transaction. \n
\nexternalKey(String, required): An external key associated with the transaction. \n
\ntransactionDetails(AWSJSON, optional): Additional details of the transaction in JSON format. \n
\ncreatedOn(String, required): The creation date of the transaction. \n
\nlastModifiedOn(String, required): The last modification date of the transaction. \n
StudentAssetTransaction Object
\n- \n
\nid(String, required): The unique identifier of the asset transaction. \n
\nstudentId(String, required): The unique identifier of the student. \n
\nassetId(String, required): The unique identifier of the asset. \n
\namount(Int, required): The amount involved in the transaction. \n
\nexternalKey(String, required): An external key associated with the transaction. \n
\ntransactionDetails(AWSJSON, optional): Additional details of the transaction in JSON format. \n
\ncreatedOn(String, required): The creation date of the transaction. \n
\nlastModifiedOn(String, required): The last modification date of the transaction. \n
This mutation allows a student to purchase items from the store. It processes the purchase and returns the result, including currency and asset transactions.
\nInput
\n- \n
\nstudentId(String, optional): The ID of the student making the purchase. \n
\ncartItems([CartItem], optional): A list of items to be purchased.- \n
\nid(String, required): The ID of the cart item. \n
\namount(Int, required): The quantity of the cart item. \n
\n
\nlearningAppName(String, optional): The name of the learning application. \n
\ncurrency(String, optional): The currency used for the purchase. \n
\nshippingDetails(ShippingDetailsInput, optional): The shipping details for the purchase.- \n
\nfullName(String, required): The full name of the recipient. \n
\naddressLine1(String, required): The first line of the address. \n
\naddressLine2(String, optional): The second line of the address. \n
\nphoneNumber(String, required): The phone number of the recipient. \n
\ncity(String, required): The city of the address. \n
\nzip(String, required): The ZIP code of the address. \n
\nstate(String, required): The state of the address. \n
\n
\nmetadata(AWSJSON, optional): Additional metadata for the purchase. \n
Output
\nThe output is a PurchaseResult object containing details of the currency and asset transactions.
PurchaseResult
\n- \n
\ncurrencyTransaction(StudentCurrencyTransaction, required): Details of the currency transaction.- \n
\nid(String, required): The ID of the transaction. \n
\nstudentId(String, required): The ID of the student. \n
\namount(Int, required): The amount of currency involved. \n
\nexternalKey(String, required): An external key for the transaction. \n
\ntransactionDetails(AWSJSON, optional): Additional details of the transaction. \n
\ncreatedOn(String, required): The creation date of the transaction. \n
\nlastModifiedOn(String, required): The last modification date of the transaction. \n
\n
\nassetTransactions([StudentAssetTransaction], required): A list of asset transactions.- \n
\nid(String, required): The ID of the transaction. \n
\nstudentId(String, required): The ID of the student. \n
\nassetId(String, required): The ID of the asset. \n
\namount(Int, required): The amount of the asset involved. \n
\nexternalKey(String, required): An external key for the transaction. \n
\ntransactionDetails(AWSJSON, optional): Additional details of the transaction. \n
\ncreatedOn(String, required): The creation date of the transaction. \n
\nlastModifiedOn(String, required): The last modification date of the transaction. \n
\n
This API endpoint retrieves the balance and gains of a student for an optional date range.
\n- \n
If no date range is provided, total balance (amount) and gains (periodGains) of a student will be returned.
\n \nIf a date range is provided:
\n- \n
The balance will be closing balance by the end of the given range.
\n \nGains of the user within that range will be returned.
\n \n
\nIf there aren't any transactions for the given range (or even totally) both of the returned balance and gains will be zero.
\n \n
Input
\n- \n
\nstudentId(String, required): The ID of the student. \n
\nstartDate(String, optional): The start date of the desired range. \n
\nendDate(String, optional): The end date of the desired range. \n
Output
\nThe output is a StudentBalance object containing the balance and periodic gains of the student.
StudentBalance Object
\n- \n
\namount(Int, required): Total balance of a student (or closing balance if a date range is provided). \n
\nperiodGains(Int, required): Gains of a student in a given date range (or total gains if no range is provided). \n
Description
\nThis endpoint allows to tetrieve a student's balances across different currencies with an optional constraint for a time period.
\nInput
\nThe GetStudentBalancesInput object having the following fields:
- \n
Valid student identifier: Please refer to the Student Identification section
\n \n
\nstartDate(String, optional): The start date for the gains calculation, formatted as a string. If not provided, data is from start of time. \n
\nendDate(String, optional): The end date for the gains calculation, formatted as a string. If not provided, data is until end of time. \n
Output
\nThe response is structured as a GetStudentBalancesOutput object, which contains:
- \n
balancesByCurrency(
[CurrencyBalance!]!): A list indicating the balance status of the student, broken down by currency. Each currency balance provides detailed insights into the student's financial activities. \n
CurrencyBalance Object
\n- \n
\ncurrency(String!): The code of the currency for which the balance is provided. \n
\namount(Int!): The total amount the student holds or is credited within this currency. \n
\nperiodGains(Int!): The gains made within the specified time period for this currency, indicating any transactions that were completed in the given date range. \n
The getStudentCurrencyTransactions endpoint retrieves the history of currency transactions for a student within a given set of parameters. This can include details about the transactions such as amount, currency type, and additional transaction details.
Input
\n- \n
input(GetStudentCurrencyTransactionsInput, required): This input object is essential for querying the currency transactions of a student. \n
GetStudentCurrencyTransactionsInput Object
\n- \n
\nplatformStudentId(String, optional): The platform-specific ID of the student. \n
\nschoolStudentId(String, optional): The student's ID within their respective school. \n
\nplatformSchoolId(String, optional): The platform-specific ID of the school. \n
\nemail(String, optional): The email address associated with the student. \n
\nlearningAppName(String, required): The name of the learning application as context for this request. \n
\neventKey(String, required): A key representing specific event parameters to filter transactions. \n
Note: To identify the student, at least one of the following combinations must be included:
\n- \n
platformStudentId\nemail\nschoolStudentId+platformSchoolId\n
Output
\nThe output is an object consisting of a list of student currency transaction details.
\nGetStudentCurrencyTransactionsOutput
\n- \n
currencyTransactions: An array of StudentCurrencyTransactionOutput objects representing individual transaction details. \n
StudentCurrencyTransactionOutput Object
\n- \n
\nid(String, required): The unique identifier for the currency transaction. \n
\namount(Int, required): The amount of currency involved in the transaction. \n
\ncurrencyId(String, required): The identifier for the currency type used in the transaction. \n
\ntransactionDetails(AWSJSON, optional): Additional details about the transaction in JSON format. \n
This endpoint is typically accessed by users with roles such as \"Student\", \"Guide\", or \"Admin\", allowing them to track and analyze student transaction records comprehensively.
\n","urlObject":{"host":["GRAPHQL_URL"],"query":[],"variable":[]}},"response":[],"_postman_id":"1f775e7e-2a8d-4b3a-94c7-f55c71df4a1c"}],"id":"ed895397-dcce-468f-875f-7153d99ca3c5","_postman_id":"ed895397-dcce-468f-875f-7153d99ca3c5","description":""},{"name":"Recommender","item":[{"name":"getStandardBasedStudentRecommendations","id":"3f92fa8b-ce80-4497-8293-1cd40431365c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"AUTO_GEN_GRAPHQL_ID_TOKEN"}],"body":{"mode":"graphql","graphql":{"query":"query getStandardBasedStudentRecommendations($input: GetStandardBasedStudentRecommendationsInput!) {\n getStandardBasedStudentRecommendations(input: $input) {\n recommendations {\n standardId\n platformStandardId\n state\n dataSources {\n internalTest {\n timestamp\n signal\n }\n externalTest {\n timestamp\n signal\n }\n app {\n timestamp\n signal\n masteryPercentage\n }\n }\n organizationName\n studentGrade\n confidenceLevel\n order\n academicCourse {\n name\n order\n masteryPercentage\n studentGrade\n }\n cluster {\n name\n platformClusterId\n clusterId\n order\n organizationName\n masteryPercentage\n studentGrade\n }\n domain {\n name\n platformDomainId\n domainId\n order\n organizationName\n masteryPercentage\n studentGrade\n }\n }\n }\n}\n","variables":"{\n \"input\": {\n \"recommendationAlgorithm\": \"(Optional) breadthFirstMastery\", \n \"platformStudentId\": \"(Optional) Platform Student Id\", \n \"email\" : \"(Optional) Student Email\",\n \"schoolStudentId\": \"(Optional) School Student Id\",\n \"platformSchoolId\": \"(Optional) Platform School Id\",\n \"subject\": \"Subject Name\", \n \"academicCourses\": [\"(Optional) Academic Course Name\"],\n \"clusters\": [\"(Optional) Cluster External Id\"],\n \"domains\": [\"(Optional) Domain External Id\"],\n \"standardOrganizations\": [\"(Optional) Standard Organization Name\"],\n \"learningAppName\": \"(Optional) Learning App Name\",\n \"numberOfRecommendations\": (Int, Optional) Max number of recommendations to return,\n \"excludedPlatformStandardIds\": [\"(Optional) Platform Standard Id to Exclude from Recommendations\"]\n }\n}"}},"url":"GRAPHQL_URL","description":"This endpoint allows consumers to get standard recommendations for a particular student.
\nInput
\n- \n
\nrecommendationAlgorithm(string, optional): The algorithm to use for determining the recommendations
Default value: \"breadthFirstMastery\" \n
\nplatformStudentId(string, optional): The platform id of the student \n
\nemail(string, optional): The email of the student \n
\nschoolStudentId(string, optional): The id of the student within the school \n
\nplatformSchoolId(string, optional): The platform id of the school \n
\nsubject(string, required): The name of the subject \n
\nacademicCourses(string array, optional): An array of course names to filter by \n
\nclusters(string array, optional): An array of cluster external ids to filter by \n
\ndomains(string array, optional): An array of domain external ids to filter by \n
\nstandardOrganizations(string array, optional): An array of organization names to filter by \n
\nlearningAppName(string, optional): The name of the learning app \n
\nnumberOfRecommendations(int, optional): The maximum number of recommendations to return
Default value: 1 \n
\nexcludedPlatformStandardIds(string array, optional): The platform standard ids to exclude from the recommendations \n
\nadaptivePlacementTestMode(string, optional): The adaptive placement test mode to use (Defaults tonone)- \n
Allowed values
\n- \n
\ninitialOnly:Signifies an adaptive placement test that ends after the first iteration when placement is determined. \n
\ncontinuous:Signifies multiple adaptive placement tests. \n
\nnone: Signifies that the adaptive test should not be considered at all. \n
\n
\n
Note: for identifying the student, one (and ONLY one) of the following must be included in the input:
\n- \n
\nplatformStudentId\n
\nemail\n
\nschoolStudentId+platformSchoolId\n
Adaptive Placement Test
\nFor learning apps that support placement tests, the recommender provides two types of recommendations:
\n- \n
Intent as 'Test': This indicates that the recommendation is for the placement test.
\n \nIntent as 'Learn': This signifies that the placement test is complete, and the student should now begin learning the standard.
\n \n
The placement test is considered ended under the following conditions:
\n- \n
A standard is identified as not learned, and all its pre-requisites are learned.
\n \nA standard is identified as not learned, but have no pre-requisites.
\n \n
Recommendation Algorithms
\nbreadthFirstMastery
\nThe Breadth-First Mastery recommendation algorithm is designed to enhance students' learning journeys by guiding them through educational standards with an emphasis on building a broad base of knowledge before taking deep dives into particular topics. This approach ensures that students acquire a well-rounded understanding of the subject matter, laying a solid foundation that prepares them for deeper, more complex learning experiences.
\nOutput
\nThe output consists of an object with two properties recommendations holding a list of StandardRecommendation objects and intent.
intent indicates whether the recommendation is for the placement test or for learning.
Values:
\n- \n
'Test'
\n \n'Learn'
\n \n
A StandardRecommendation object has the following structure:
- \n
\nstandardId(string): The external id for the standard \n
\nplatformStandardId(string): The platform id for the standard \n
\nstate(enum, string): The learning state of the standard
Values:- \n
'LEARNED'
\n \n'LEARNED_CONFIRMED'
\n \n'LEARNING'
\n \n'UNKNOWN'
\n \n
\n
\norganizationName(string): The name of the organization for the standard \n
\nstudentGrade(string): The calculated student grade for the standard \n
\nconfidenceLevel(enum, string): The confidence level of student for the related level.
Values:- \n
'LOW'
\n \n'MEDIUM'
\n \n'HIGH'
\n \n
\n
\norder(int): The sorting order for the standard \n
\ntype(RecommendationType): Type of recommendation.
Values:- \n
'Placement'
\n \n'Struggle'
\n \n'General'
\n \n
\n
\ndataSources(object): Contains the data sources for the Standard Based Skills Stack that the recomendations are built from- \n
\ninternalTest(object): Contains details about the internal test- \n
\ntimestamp(timestamp): The timestamp of the most recentsignalfor the internal test \n
\nsignal(enum, string): The passed/not passed signal for the internal test
Values:- \n
'UNKNOWN'
\n \n'NOT_PASSED'
\n \n'PASSED'
\n \n
\n
\n
\nexternalTest(object): Contains details about the external test- \n
\ntimestamp(timestamp): The timestamp of the most recentsignalfor the external test \n
\nsignal(enum, string): The passed/not passed signal for the external test
Values:- \n
'UNKNOWN'
\n \n'NOT_PASSED'
\n \n'PASSED'
\n \n
\n
\n
\napp(Object): Contains details about the learning app- \n
\ntimestamp(timestamp): The timestamp of the most recentsignalfor the learning app \n
\nsignal(enum, string): The passed/not passed signal for the learning app
Values:- \n
'UNKNOWN'
\n \n'NOT_PASSED'
\n \n'PASSED'
\n \n
\n
\nmasteryPercentage(float): The mastery percentage for the learning app \n
\n
\n
\nacademicCourse(Object): Contains details about the academic course the standard belongs to- \n
\nname(string): The academic course name \n
\norder(int): The sorting order for the academic course \n
\nmasteryPercentage(float): The mastery percentage for the academic course \n
\nstudentGrade(string): The calculated student grade for the academic course (based onmasteryPercentagefor the academic course) \n
\n
\ncluster(object): Contains details about the cluster the standard belongs to- \n
\nname(string): The name of the cluster \n
\nplatformClusterId(string): The platform id of the cluster \n
\nclusterId(string): The external id of the cluster \n
\norder(int): The sorting order of the cluster \n
\norganizationName(string): The name of the organization for the cluster \n
\nmasteryPercentage(float): The mastery percentage for the cluster \n
\nstudentGrade(string): The calculated student grade for the cluster (based onmasteryPercentagefor the cluster) \n
\n
\ndomain(object): Contains details about the domain the standard belongs to- \n
\nname(string): The name of the domain \n
\nplatformDomainId(string): The platform id of the domain \n
\ndomainId(string): The external id of the domain \n
\norder(int): The sorting order of the domain \n
\norganizationName(string): The name of the organization for the domain \n
\nmasteryPercentage(float): The mastery percentage for the domain \n
\nstudentGrade(string): The calculated student grade for the domain (based onmasteryPercentagefor the domain) \n
\n
This query retrieves struggle recommendations for a student based on their interaction with a specific standard in a learning app.
\nInput
\n- \n
Valid student identifier: Please refer to the Student Identification section
\n \n
\ntutorConversation(string, optional): The conversation context with the tutor \n
\nlearningAppName(string, required): The name of the learning application \n
\nplatformStandardId(string, required): The platform identifier for the standard \n
Output
\nThe output provides details about the recommended standard and includes:
\n- \n
\nplatformStandardId(string): The platform identifier of the standard \n
\nstandardId(string): The external identifier of the standard \n
\ndescription(string): A description of the standard \n
\nreason(string, optional): The reasoning behind the recommendation \n
This endpoint is used to upsert student's placement grade for a particular subject
Input
\n- \n
Valid student identifier: Please refer to the Student Identification section
\n \n
\nplacementGrade(string, required): The new placement grade to be upserted- \n
Allowed values: 'PK', 'K', '1', '2', '3', '4', '5', '6', '7', '8', '9', '10', '11', '12', 'AP' \n
\n
\nsubject(string, required): The subject for which placementGrade is being upserted \n
Output
\nThe output consists of an object having following attributes:
\n- \n
\nplatformStudentId(string): The platform id of the student \n
\nplacementGrade(string): The upserted grade of the student \n
This API allows to get the recommended difficulty for the next question we should ask to a student for a specific standard and learning app based on the current progression of the student through that standard. The thresholds for the different difficulties can be configured per application for maximum flexibility.
\nInput
\n- \n
Valid student identifier: Please refer to the Student Identification section.
\n \n
\nlearningAppName(string, required): Name of the learning app the question is for. \n
\nplatformStandardId(string, required): Platform id of the standard the question is for. \n
\nalgorithm(QuestionDifficultyRecommendationAlgorithm, optional): Algorithm used for determining question difficulty. Possible values:- \n
\nthresholdBased(used if none provided) \n
\nadaptiveDifficultySelection\n
\n
Output
\nThe output is an object with a single field:
\n- \n
\ndifficulty(enum, required): Recommended difficulty for the next question. Valid values:- \n
\neasy\n
\nmedium\n
\nhard\n
\n
The recommender module allows the consumer to query for recommendations on what content to provide to a student for the best learning experience. Recommendations generally will be standard based, resource based, or in early cases, test/quiz based to asses the student's expected grading.
\n","_postman_id":"73ec9f0c-2972-4ed2-86cc-964ead890626"},{"name":"Skills Stack","item":[{"name":"getStandardBasedSkillsStack","id":"48c53870-4d9a-4791-8926-318f7390865e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"AUTO_GEN_GRAPHQL_ID_TOKEN"}],"body":{"mode":"graphql","graphql":{"query":"query getStandardBasedSkillsStack($input: GetStandardBasedSkillsStackInput!) {\n getStandardBasedSkillsStack(input:$input) {\n grades {\n order\n name\n academicCourses {\n studentGrade\n order\n name\n masteryPercentage\n domains {\n studentGrade\n platformDomainId\n organizationName\n order\n name\n masteryPercentage\n domainId\n clusters {\n studentGrade\n standards {\n studentGrade\n confidenceLevel\n state\n standardId\n platformStandardId\n organizationName\n order\n dataSources {\n internalTest {\n timestamp\n signal\n }\n externalTest {\n signal\n timestamp\n }\n app {\n signal\n timestamp\n masteryPercentage\n }\n }\n }\n platformClusterId\n organizationName\n order\n name\n masteryPercentage\n clusterId\n }\n }\n }\n }\n }\n}\n","variables":"{\r\n \"input\": {\r\n \"subject\": \"Subject name\",\r\n \"platformStudentId\": \"Platform student id\",\r\n \"standardOrganizations\": [\"StandardOrganizationName\"],\r\n \"clusters\": [\"ClusterExternalId\"],\r\n \"domains\": [\"DomainExternalId\"],\r\n \"academicCourses\": [\"CourseName\"],\r\n \"learningAppName\": \"AppName\"\r\n }\r\n}"}},"url":"GRAPHQL_URL","description":"The standard based skills stack will contain the current learning state for a student and a particular subject on a hierarchical composition down from grades to academic courses, domains, clusters and standards, including the mastery percentage and expected grade for the student in each entity.
\nIt supports filtering the response by learning app name, cluster external ids, domain external ids, standard organization names and academic course names.
\nInput
\n- \n
\nplatformStudentId(string, optional): The platform id of the student \n
\nemail(string, optional): The email of the student \n
\nschoolStudentId(string, optional): The id of the student within the school \n
\nplatformSchoolId(string, optional): The platform id of the school \n
\nsubject(string, required): The name of the subject \n
\nacademicCourses(string array, optional): An array of course names to filter by \n
\nclusters(string array, optional): An array of cluster external ids to filter by \n
\ndomains(string array, optional): An array of domain external ids to filter by \n
\nstandardOrganizations(string array, optional): An array of organization names to filter by \n
\nlearningAppName(string, optional): The name of the learning app \n
Note: for identifying the student, one (and ONLY one) of the following must be included in the input:
\n- \n
\nplatformStudentId\n
\nemail\n
\nschoolStudentId+platformSchoolId\n
Output
\nThe output consists of an object with a single property \"grades\" holding a list of StandardBasedSkillsStackGradeOutput objects.
A StandardBasedSkillsStackGradeOutput object has the following structure:
- \n
\nname(string): The name of the grade \n
\ngrade(String): The grade itself, between PK and 12 \n
\norder(int): The order of this grade \n
\nacademicCourses: A list ofStandardBasedSkillsStackAcademicCourseOutputobjects \n
A StandardBasedSkillsStackAcademicCourseOutput object has the following structure:
- \n
\nname(string): The name of the course \n
\norder(int): The order of this course within the grade \n
\nmasteryPercentage(float, optional): The mastery percentage the student has on this course \n
\nstudentGrade(string, optional): The predicted grade for the student on this course \n
\ndomains: A list ofStandardBasedSkillsStackDomainOutputobjects \n
A StandardBasedSkillsStackDomainOutput object has the following structure:
- \n
\nname(string): The name of the domain \n
\ndomainId(string): The external id of the domain \n
\nplatformDomainId(string): The platform id of the domain \n
\norder(int, optional): The order of this domain within the course \n
\norganizationName(string, optional): Name of the organization the domain belongs to \n
\nmasteryPercentage(float, optional): The mastery percentage the student has on this domain \n
\nstudentGrade(string, optional): The predicted grade for the student on this domain \n
\nclusters: A list ofStandardBasedSkillsStackClusterOutputobjects \n
A StandardBasedSkillsStackClusterOutput object has the following structure:
- \n
\nname(string): The name of the cluster \n
\nclusterId(string): The external id of the cluster \n
\nplatformClusterId(string): The platform id of the cluster \n
\norder(int, optional): The order of this cluster within the domain \n
\norganizationName(string, optional): Name of the organization the cluster belongs to \n
\nmasteryPercentage(float, optional): The mastery percentage the student has on this cluster \n
\nstudentGrade(string, optional): The predicted grade for the student on this cluster \n
\nstandards: A list ofStandardBasedSkillsStackStandardOutputobjects \n
A StandardBasedSkillsStackStandardOutput object has the following structure:
- \n
\nstandardId(string): The external id of the standard \n
\nplatformStandardId(string): The platform id of the standard \n
\norder(int, optional): The order of this standard within the cluster \n
\nstate(enum, string): The state of this standard.
Values:- \n
'LEARNED'
\n \n'LEARNED_CONFIRMED'
\n \n'LEARNING'
\n \n'UNKNOWN'
\n \n
\n
\norganizationName(string, optional): Name of the organization the standard belongs to \n
\nstudentGrade(string, optional): The predicted grade for the student on this standard \n
\nconfidenceLevel(enum, string): The confidence level of student for the related level.
Values:- \n
'LOW'
\n \n'MEDIUM'
\n \n'HIGH'
\n \n
\n
\ndataSources(object): Contains the data sources for the standard calculated state- \n
\ninternalTest(object): Contains details about the internal test- \n
\ntimestamp(timestamp): The timestamp of the most recentsignalfor the internal test \n
\nsignal(enum, string): The passed/not passed signal for the internal test
Values:- \n
'UNKNOWN'
\n \n'NOT_PASSED'
\n \n'PASSED'
\n \n
\n
\n
\nexternalTest(object): Contains details about the external test- \n
\ntimestamp(timestamp): The timestamp of the most recentsignalfor the external test \n
\nsignal(enum, string): The passed/not passed signal for the external test
Values:- \n
'UNKNOWN'
\n \n'NOT_PASSED'
\n \n'PASSED'
\n \n
\n
\n
\napp(Object): Contains details about the learning app- \n
\ntimestamp(timestamp): The timestamp of the most recentsignalfor the learning app \n
\nsignal(enum, string): The passed/not passed signal for the learning app
Values:- \n
'UNKNOWN'
\n \n'NOT_PASSED'
\n \n'PASSED'
\n \n
\n
\nmasteryPercentage(float): The mastery percentage for the learning app \n
\n
\n
This endpoint allows consumers to retrieve the list of existing academic course grade thresholds, optionally filtering by subject name, or by subject name and course name.
\nInput
\n- \n
academicCourseName(string, optional): The name of the course to filter thresholds for. If provided,subjectneeds to be provided as well. \nsubject(string, optional): The name of the subject to filter for \n
Output
\nThe output is a list of GetAcademicCourseGradeThresholdsOutput objects.
A GetAcademicCourseGradeThresholdsOutput object has the following structure:
- \n
academicCourseName(string): The name of the course \nplatformAcademicCourseId(string): The platform id of the course \nsubject(string): The name of the subject \nstudentGradeThresholds: A list of StudentGradeThreshold objects \n
A StudentGradeThreshold object has the following structure:
- \n
studentGrade(string): The grade this threshold grants \nmasteryPercentageThreshold(float): The actual percentage threshold, with 2 decimals \n
The skills stack module lets consumers fetch the stack for a particular student, either standard based or learning resource based, filtered by certain sets of criteria.
\n","_postman_id":"8b441211-275e-42f7-8384-c5fe70dde425"},{"name":"User Management","item":[{"name":"checkExtendedStudentAttributeAvailability","id":"586d8bf2-d482-4467-98de-5153e175138f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"AUTO_GEN_GRAPHQL_ID_TOKEN"}],"body":{"mode":"graphql","graphql":{"query":"query CheckExtendedStudentAttributeAvailability($input: CheckExtendedStudentAttributeAvailabilityInput!) {\n checkExtendedStudentAttributeAvailability(input: $input) {\n isAvailable\n }\n}\n","variables":"{\r\n \"input\": {\r\n \"learningAppName\": \"Platform\",\r\n \"attributeKey\": \"key\",\r\n \"attributeValue\": \"value\"\r\n }\r\n}"}},"url":"GRAPHQL_URL","description":"This API checks the availability of an extended student attribute.
\nInput
\nThe input for this API is a CheckExtendedStudentAttributeAvailabilityInput object, which includes
- \n
\nlearningAppName(string, required): The name of the learning app. \n
\nattributeKey(string, required): The key of the extended student attribute. \n
\nattributeValue(string, required): The value of the extended student attribute. \n
Output
\nThe output is a CheckExtendedStudentAttributeAvailabilityOutput object, which includes:
CheckExtendedStudentAttributeAvailabilityOutput
\n- \n
isAvailable(boolean): Whether the extended student attribute is available. \n
This endpoint allows to check if a username is already used or not for a particular school, and if it's appropriate or not.
\nInput
\n- \n
\nusername(String): The username to check \n
\nplatformSchoolId(String): The platform school id to check the username against \n
Output
\nThe output is an object of type CheckUsernameAvailabilityOutput.
CheckUsernameAvailabilityOutput
\n- \n
\nisAvailable(Boolean): Indicates whether the username is available or not for the chosen school \n
\nisAppropriate(Boolean): Indicates whether the username is appropriate or not. \n
This endpoint allows for the claiming of an anonymous user account by providing personal details to create a more permanent user profile.
\nInput
\n- \n
\nfirstName(String, required): The first name of the user. \n
\nlastName(String, required): The last name of the user. \n
\nemail(String, required): The email address to associate with the user account. \n
\npassword(String, required): The password for the user account. \n
\npreferredName(String, optional): A preferred nickname or alias for the user. \n
\nlocale(String, optional): The locale or region for the user, influencing language and regional settings. \n
\ngrade(String, optional): The grade level of the user if applicable. \n
\nschool(String, optional): The school identifier the user is associated with. \n
\nstudentId(String, optional): A unique student identifier. \n
\ndateOfBirth(Date, optional): The user's date of birth. \n
\ngender(StudentGender, optional): The gender of the user. Can be 'MALE', 'FEMALE', or 'OTHER'. \n
\nlearningLevel(String, optional): The educational or skill level of the user. \n
\ncampusId(String, optional): The campus identifier if the user is associated with a specific campus. \n
\nusername(String, optional): The username of the student, it will be autogenerated of not provided \n
\nemailOptIn(Boolean, optional): Email opt in flag for the user \n
Output
\nThe output confirms the successful claim of the anonymous user account and provides a user-specific message.
\nClaimAnonymousUserOutput
\n- \n
\nuserId(String): The unique identifier for the user after claiming the account. \n
\nmessage(String): A message confirming the successful account claim \n
This endpoint is used to generate a voucher for enrollment in a particular program. If the program has autoenrollment enabled, and we provide the student email, it will perform the autoenrollment if possible. In any case, if at least one of parent email, student email, payment provider + transaction id or subject are provided, we will store a voucher purchase for later on.
\nWhen providing payment metadata (provider + transaction id) they both need to be provided together, or not provided at all. Providing only one of them will result in an error.
\nInput
\n- \n
\nprogram(string): The key for the program the voucher is for \n
\ntype(string enum): The type of enrollment voucher to create. Valid values:- \n
\nSeven Days Subscription\n
\nFifteen Days Subscription\n
\nOne Month Subscription\n
\nThree Months Subscription\n
\nSix Months Subscription\n
\nOne Year Subscription\n
\nUnlimited Subscription\n
\n
\nstudentEmail(string, optional): The email of the student the voucher is being created for \n
\nplatformStudentId(string, optional): The platform student id of the student the voucher is being created for \n
\nparentEmail(string, optional): The email of the parent of the student the voucher is being created for \n
\nstartCourseName(string, optional): The course name to start the enrollment on \n
\nendCourseName(string, optional): The course name to end the enrollment on \n
\nsubject(string, optional): The subject for the enrollment \n
\nenrollmentStartDate(string, ptional): The start date of student enrollment. If voucher is created for some student, this date will be stored in voucher purchase data and used while auto-enrolling student. \n
\npaymentProvider(string, optional): The payment provider used for the voucher purchase. \n
\ntransactionId(string, optional): The transaction ID of the voucher purchase. \n
\nsource(string enum, optional): The source of the purchase to generate. Valid values:- \n
\npaid\n
\ninternal\n
\nmarketing\n
\npromotion\n
\n
Output
\nThe output consists of an object having following attribute:
\n- \n
\nvoucherCode(string): The code related to the created voucher so it can be redeemed. \n
\nstudentExists(boolean): Whether the student exists or not \n
\nisEnrolled(boolean): Whether the student is enrolled or not \n
\nstartDate(string, optional): If student exists and is enrolled, iso formatted date when the enrollment started \n
\nendDate(string, optional): If student exists and is enrolled, and enrollment is not unlimited, iso formatted date when the enrollment ended \n
This API processes a referral in the Teach Tower system, handling both the referrer and the referred student identities.
\nInput
\nThe input for this API is a ProcessTeachTowerReferralInput object, which includes the referrer and referred student identities.
- \n
\nreferrer(ProcessTeachTowerReferralStudentIdentity, required): The identity of the student who is making the referral. \n
\nreferred(ProcessTeachTowerReferralStudentIdentity, optional): The identity of the student who is being referred. If not provided, then current student (who makes request) will be used as referred. \n
ProcessTeachTowerReferralStudentIdentity
\n- \n
- Valid student identifier: Please refer to the Student Identification section. \n
Output
\nThe output is a ProcessTeachTowerReferralOutput object, which includes the result of the referral process and the rewards for both the referrer and the referred student.
ProcessTeachTowerReferralOutput
\n- \n
\nresult(ProcessTeachTowerReferralResult, required): The result of the referral process. \n
\nreferrerRewards(ProcessTeachTowerReferralRewards, optional): The rewards for the referrer. \n
\nreferredRewards(ProcessTeachTowerReferralRewards, optional): The rewards for the referred student. \n
ProcessTeachTowerReferralRewards
\n- \n
currencyRewards([ProcessTeachTowerReferralCurrencyReward], optional): A list of currency rewards. \n
ProcessTeachTowerReferralCurrencyReward
\n- \n
\namount(Int, required): The amount of the reward. \n
\ncurrency(String, required): The currency of the reward. \n
deleteUserProfileImage Endpoint
\nDeletes the profile image for a specified user.
\nInput
\n- \n
userId: string (required) - The ID of the user whose profile image should be deleted. \n
Output
\nReturns the updated user details after deleting the profile image.
\n","urlObject":{"host":["GRAPHQL_URL"],"query":[],"variable":[]}},"response":[{"id":"67d027b6-2a97-497b-87e2-76d26c690a8d","name":"deleteUserProfileImage successfully","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"AUTO_GEN_GRAPHQL_ID_TOKEN"}],"body":{"mode":"graphql","graphql":{"query":"mutation DeleteUserProfileImage($input: DeleteUserProfileImageInput!) {\n deleteUserProfileImage(input: $input) {\n email\n profileImageURL\n }\n}","variables":"{\n \"input\": {\n \"userId\": \"394e05c4-1522-40eb-ae08-c0fcb499da1c\"\n }\n}"}},"url":"GRAPHQL_URL"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Content-Length","value":"89"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 18 Aug 2024 12:56:42 GMT"},{"key":"x-amzn-RequestId","value":"12d3c34e-b1fd-4f15-86e8-bf7f8361ffb9"},{"key":"x-amzn-appsync-TokensConsumed","value":"17"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 1ac532da7db85d551ad10ca7bd9957b8.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P1"},{"key":"X-Amz-Cf-Id","value":"LFbQVZdBDyLsT5v2dkZNoI4InkAgX0YMNXt6GSwXxcBX596Rs7MENg=="}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"deleteUserProfileImage\": {\n \"email\": \"test.123@alpha.com\",\n \"profileImageURL\": null\n }\n }\n}"},{"id":"696d481c-c692-4453-9833-978d831cd539","name":"deleteUserProfileImage for user without a profile image","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"AUTO_GEN_GRAPHQL_ID_TOKEN"}],"body":{"mode":"graphql","graphql":{"query":"mutation DeleteUserProfileImage($input: DeleteUserProfileImageInput!) {\n deleteUserProfileImage(input: $input) {\n email\n profileImageURL\n }\n}","variables":"{\n \"input\": {\n \"userId\": \"394e05c4-1522-40eb-ae08-c0fcb499da1c\"\n }\n}"}},"url":"GRAPHQL_URL"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Content-Length","value":"254"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 18 Aug 2024 12:40:27 GMT"},{"key":"x-amzn-RequestId","value":"9ef303aa-d7f9-420b-af06-9b57fd44c164"},{"key":"x-amzn-appsync-TokensConsumed","value":"80"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 69323cc81a35966f2e018b11a9d4a8e6.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P1"},{"key":"X-Amz-Cf-Id","value":"B4T2EHMnkwhOS-nz5NYpKfhCfwyI0j3izoDoRb7MDH4BEIY0nVJq5w=="}],"cookie":[],"responseTime":null,"body":"{\n \"data\": null,\n \"errors\": [\n {\n \"path\": [\n \"deleteUserProfileImage\"\n ],\n \"data\": null,\n \"errorType\": \"Lambda:Unhandled\",\n \"errorInfo\": null,\n \"locations\": [\n {\n \"line\": 2,\n \"column\": 5,\n \"sourceName\": null\n }\n ],\n \"message\": \"Profile image not set for user 394e05c4-1522-40eb-ae08-c0fcb499da1c\"\n }\n ]\n}"},{"id":"6d8fe481-86c0-4ee2-99c9-b4ccbfe2117e","name":"deleteUserProfileImage with an invalid user id","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"AUTO_GEN_GRAPHQL_ID_TOKEN"}],"body":{"mode":"graphql","graphql":{"query":"mutation DeleteUserProfileImage($input: DeleteUserProfileImageInput!) {\n deleteUserProfileImage(input: $input) {\n email\n profileImageURL\n }\n}","variables":"{\n \"input\": {\n \"userId\": \"invalidUserId\"\n }\n}"}},"url":"GRAPHQL_URL"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Content-Length","value":"258"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 18 Aug 2024 12:41:22 GMT"},{"key":"x-amzn-RequestId","value":"765817b6-cfa4-4135-ab9d-de4e947a283d"},{"key":"x-amzn-appsync-TokensConsumed","value":"6"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 b3bc6011219d758c8763878f39b43b9e.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P1"},{"key":"X-Amz-Cf-Id","value":"NdpKJP7-GcEOd8WILD5U8AdoeZ3XKWnfCRLJ_LlHKAZCxg-n3IcxAg=="}],"cookie":[],"responseTime":null,"body":"{\n \"data\": null,\n \"errors\": [\n {\n \"path\": [\n \"deleteUserProfileImage\"\n ],\n \"data\": null,\n \"errorType\": \"Lambda:Unhandled\",\n \"errorInfo\": null,\n \"locations\": [\n {\n \"line\": 2,\n \"column\": 5,\n \"sourceName\": null\n }\n ],\n \"message\": \"Could not find any entity of type \\\"Users\\\" matching: \\\"invalidUserId\\\"\"\n }\n ]\n}"}],"_postman_id":"0e1a01e1-4929-432d-ba5c-1eba56a4c412"},{"name":"enrollStudentInProgram","id":"f0a216cf-2d2e-4f5f-b34b-bfd39462f096","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"AUTO_GEN_GRAPHQL_ID_TOKEN"}],"body":{"mode":"graphql","graphql":{"query":"mutation MyMutation($platformStudentId: String, $program: String) {\r\n enrollStudentInProgram(studentId: $platformStudentId, program: $program) {\r\n studentId\r\n programId\r\n startDate\r\n endDate\r\n }\r\n}","variables":"{\r\n \"platformStudentId\": \"a6baae29-7533-4a5d-8260-5f9eb1b36551\", \r\n \"program\": \"TeachTower\"\r\n}"}},"url":"GRAPHQL_URL","description":"This endpoint enrolls a student in a specified program. Optionally, a voucher code can be applied to the subscription. Additionally, if start and/or end course names are provided along with a subject name, the enrollment will be tied to that range of courses. Otherwise it will remain unbound as currently.
\nInput
\n- \n
Valid student identifier: Please refer to the Student Identification section
\n \n
\nstudentId(string, optional, deprecated): The unique identifier of the student to be enrolled.DEPRECATED: Use the standard valid student identifiers as refered above instead \n
\nprogram(string, optional): The key representing the program for enrollment. If not provided, a voucher must be provided, and the program will be retrieved from the voucher. \n
\nvoucher(string, optional): The voucher code to apply for the subscription. \n
\nstartCourseName(string, optional): The name of the starting course for the subscription. Defaults to the endCourse if not provided and endCourse is provided. \n
\nendCourseName(string, optional): The name of the ending course for the subscription. Defaults to the startCourse if not provided and startCourse is provided. \n
\nsubject(string, optional): The subject name the courses belong to. Mandatory if any course is provided \n
\nenrollmentStartDate(string, ptional): The custom start date of student enrollment \n
Output
\nThe response is a JSON object containing the following attributes:
\n- \n
\nstudentId(string): The unique identifier of the student enrolled \n
\nprogramId(string): The unique identifier of the program the student enrolled in \n
\nstartDate(string): The start date of the subscription \n
\nendDate(string): The end date of the subscription \n
This API retrieves extended attributes for a student.
\nInput
\nThe input for this API is a GetExtendedStudentAttributesInput object, which includes
- \n
Valid student identifier: Please refer to the Student Identification section
\n \n
\nlearningAppName(string, required): The name of the learning app. \n
Output
\nThe output is a GetExtendedStudentAttributesOutput object, which includes:
GetExtendedStudentAttributesOutput
\n- \n
attributes(array ofStudentExtendedAttributeobjects): An array of student extended attributes. \n
StudentExtendedAttribute
\n- \n
\nattributeKey(string): The key of the attribute. \n
\nattributeValue(string): The value of the attribute. \n
The getStudent API endpoint retrieves detailed information about a student, including their personal details, program enrollments, and placement grades.
Input
\nThe getStudent query requires the following input parameters:
- \n
\nstudentId(String, optional, deprecated): Use other identifiers instead. \n
\nplatformStudentId(String, optional): Valid student identifier: Please refer to the Student Identification section. \n
\nemail(String, optional): Valid student identifier: Please refer to the Student Identification section. \n
\nplatformSchoolId(String, optional): Valid student identifier: Please refer to the Student Identification section. \n
\nschoolStudentId(String, optional): Valid student identifier: Please refer to the Student Identification section. \n
\nusername(String, optional): Valid student identifier. Please refer to the Student Identification section. \n
\nincludeInactiveEnrollments(Boolean, optional): Whether to include inactive enrollments. Default isfalse. \n
Output
\nThe output is an object of type GetStudentOutput, which includes detailed information about the student.
GetStudentOutput Object
\n- \n
\nuser_id(String, required): The unique identifier of the user. \n
\nfirst_name(String, required): The first name of the student. \n
\nlast_name(String, required): The last name of the student. \n
\nemail(String, optional): The email address of the student. \n
\nrole_name(String, required): The role of the user, typically \"Student\". \n
\nstudent_id(String, required): The unique identifier of the student. \n
\ncampus_id(String, required): The identifier of the campus the student is associated with. \n
\nalpha_student_id(String, required, deprecated): The deprecated identifier of the student. Useexternal_student_idinstead. \n
\nexternal_student_id(String, required): The external identifier of the student. \n
\nalpha_learning_level(String, required, deprecated): The deprecated learning level of the student. Uselearning_levelinstead. \n
\nlearning_level(String, required): The current learning level of the student. \n
\ndate_of_birth(String, optional): The date of birth of the student. \n
\npreferred_name(String, optional): The preferred name of the student. \n
\nmap_grade_level(String, optional): The mapped grade level of the student. \n
\ngender(String, optional): The gender of the student. \n
\nis_active(Boolean, optional): Whether the student is currently active. \n
\nprofile_image(String, optional): The URL of the student's profile image. \n
\ncover_image(String, optional): The URL of the student's cover image. \n
\nschool_id(String, optional): The identifier of the school the student is associated with. \n
\nschool_name(String, optional): The name of the school the student is associated with. \n
\nprogram_enrollments(Array ofGetStudentProgramEnrollment, optional): A list of the student's program enrollments. \n
\nplacement_grades(Array ofGetStudentPlacementGrade, optional): A list of the student's placement grades. \n
GetStudentProgramEnrollment Object
\n- \n
\nprogramEnrollmentId(String, required): The unique identifier of the program enrollment. \n
\nprogramId(String, required): The unique identifier of the program. \n
\nprogramKey(String, required): The key of the program. \n
\nstartDate(String, required): The start date of the program enrollment. \n
\nendDate(String, optional): The end date of the program enrollment. \n
\nstartCourseName(String, optional): The name of the starting course in the program. \n
\nendCourseName(String, optional): The name of the ending course in the program. \n
\nsubjectName(String, optional): The name of the subject associated with the program. \n
\nisUpdateAllowed(Boolean, optional): Indicates if the user can update this enrollment. \n
\npurchaseSource(string enum, optional): The source of the purchase related to this voucher. Valid values:- \n
\npaid\n
\ninternal\n
\npromotional\n
\nmarketing\n
\n
GetStudentPlacementGrade Object
\n- \n
\ngrade(String, required): The value of the grade. \n
\ngradeId(String, required): The unique identifier of the grade. \n
\ngradeName(String, required): The name of the grade. \n
\nsubject(String, required): The name of the subject. \n
\nsubjectId(String, required): The unique identifier of the subject. \n
This endpoint allows consumers to fetch detailed information about a user. This includes personal details, role information, and associated permissions, as well as enrollments for the user and it's agent relationships.
\nThe request can either be based on userId, platformSchoolId+schoolStudentId or email. Only one of the three options should be provided in a request.
\nInput
\n- \n
\nuserId(String, optional): The unique identifier of the user for whom details are being retrieved. \n
\nschoolStudentId(String, optional): The id of the school of the user for whom details are being retrieved. \n
\nplatformSchoolId(String, optional): The external/school student id of the user for whom details are being retrieved. \n
\nemail(String, optional): The email of the user for whom details are being retrieved. \n
Output
\nThe output provides detailed information about the user encapsulated in a User object.
User Object
\n- \n
\nid(String, required): The unique identifier of the user. \n
\nfirstName(String, required): The first name of the user. \n
\nlastName(String, required): The last name of the user. \n
\npreferredName(String, optional): A preferred nickname or alias for the user. \n
\nemail(String, optional): The email address associated with the user account. \n
\nplatformStudentId(String, optional): The student id for this user, if available. \n
\nroleName(String, deprecated): The role name of the user. Userolesinstead. \n
\nroles([String], required): A list of roles associated with the user. \n
\nlocale(String, optional): The locale or region for the user, influencing language and regional settings. \n
\nprofileImageURL(String, optional): URL of the user's profile image. \n
\ncoverImageURL(String, optional): URL of the user's cover image. \n
\nacceptedTerms(Boolean, optional): Indicates whether the user has accepted the terms and conditions. \n
\npermissions([String], optional): A list of permissions granted to the user. \n
\nreferredUserIds([String], optional): A list of Ids of users that were referred by current user. \n
\nuserEnrollments([UserEnrollment], optional): A list of enrollments associated with the user. \n
\nagents([Agent], optional): A list of agents associated with the user. \n
\nemailOptIn(Boolean, optional): Email opt in flag for the user \n
UserEnrollment Object
\n- \n
\nschool(String, required): The school identifier the user is associated with. \n
\nrole(String, required): The role of the user within the school. \n
\nbeginDate(String, required): The start date of the enrollment. \n
\nendDate(String, optional): The end date of the enrollment. \n
\nstudentId(String, optional): A unique student identifier. \n
\nusername(String, optional): The username of the student. \n
\nreferredByUserId(String, optional): Id of user that referred the student. \n
\nverified(Boolean): Indicates whether the user enrollment is verified or not. \n
Agent Object
\n- \n
\nid(ID, required): The unique identifier of the agent. \n
\nfirstName(String, required): The first name of the agent. \n
\nlastName(String, required): The last name of the agent. \n
\nemail(String, optional): The email address of the agent. \n
\npreferredName(String, optional): A preferred nickname or alias for the agent. \n
\nroles([String], required): A list of roles associated with the agent. \n
\nuserEnrollments([UserEnrollment], optional): A list of enrollments associated with the agent. \n
\nplatformStudentId(String, optional): The student id for this agent, if available. \n
This endpoint is used to get the details of a specific voucher by code.
\nInput
\n- \n
voucherCode(string, required): The voucher code to check \n
Output
\nThe output consists of an object having following attributes:
\n- \n
\ntype(string enum): The type of voucher. Valid values:- \n
\nSeven Days Subscription\n
\nFifteen Days Subscription\n
\nOne Month Subscription\n
\nThree Months Subscription'\n
\nSix Months Subscription\n
\nOne Year Subscription\n
\nUnlimited Subscription\n
\n
\nprogram(string): Name of the program the voucher is linked to \n
\nredemptionDate(string): If the voucher is redeemed, this is the UTC redemption date in ISO format. \n
\npurchaseSource(string enum, optional): The source of the purchase related to this voucher. Valid values:- \n
\npaid\n
\ninternal\n
\nmarketing\n
\npromotion\n
\n
This endpoint provisions an anonymous user for a specified school, generating temporary credentials for initial access.
\nInput
\n- \n
school(String, required): The identifier of the school for which the anonymous user is being provisioned. \n
Output
\nThe output provides the temporary credentials for the anonymous user.
\nProvisionAnonymousUserOutput
\n- \n
email(String): The temporary email assigned to the anonymous user. \npassword(String): The temporary password assigned to the anonymous user. \n
This API endpoint allows the creation of a student, user, and Cognito user based on the provided input.
\nInput
\n- \n
\nfirstName(String, required): The first name of the user. \n
\nlastName(String, required): The last name of the user. \n
\nemail(String, optional): The email address of the user. \n
\npassword(String, optional): The password for the user. \n
\npreferredName(String, optional): The preferred name of the user. \n
\nlocale(String, optional): The locale of the user. \n
\ngrade(String, optional): The grade level of the user. \n
\nschool(String, optional): The school of the user. \n
\nstudentId(String, optional): The student ID of the user. \n
\ndateOfBirth(Date, optional): The date of birth of the user. \n
\ngender(StudentGender, optional): The gender of the user. Possible values areMALE,FEMALE,OTHER. \n
\nlearningLevel(String, optional): The learning level of the user. \n
\ncampusId(String, optional): The campus ID of the user. \n
\nroles([UserEnrollmentRole!], optional): The roles assigned to the user. Possible values areStudent,Guide,Admin,Parent,Guardian. \n
\nusername(String, optional): The username of the user. \n
\nreferredByStudent(SignUpReferredByStudentIdentityInput, optional): Information about the student who referred this user. \n
\nemailOptIn(Boolean, optional): Email opt in flag for the user, false if not provided \n
SignUpReferredByStudentIdentityInput
\n- \n
\nplatformStudentId(String, optional): Valid student identifier. Please refer to the Student Identification section. \n
\nemail(String, optional): Valid student identifier. Please refer to the Student Identification section. \n
\nschoolStudentId(String, optional): Valid student identifier. Please refer to the Student Identification section. \n
\nplatformSchoolId(String, optional): Valid student identifier. Please refer to the Student Identification section. Ifusernameprovided butplatformSchoolIdnot provided, then new user's UserEnrollment school will be used. \n
\nusername(String, optional): The username of the referring student. \n
Output
\nThe output is a string indicating that the user was created.
\n","urlObject":{"host":["GRAPHQL_URL"],"query":[],"variable":[]}},"response":[{"id":"d108db76-8265-4edf-9cd2-d9cd3f57f26d","name":"signUp (Alpha)","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"GRAPHQL_API_KEY"}],"body":{"mode":"graphql","graphql":{"query":"mutation signUp($firstName: String!, $lastName: String!, $email: AWSEmail!, $password: String!, $preferredName: String, $grade: String, $school: String, $dateOfBirth: AWSDate, $gender: StudentGender) {\r\nsignUp(firstName: $firstName, lastName: $lastName, email: $email, password: $password, preferredName: $preferredName, grade: $grade, school: $school, dateOfBirth: $dateOfBirth, gender: $gender)\r\n}\r\n","variables":"{\r\n \"firstName\": \"DDD\",\r\n \"lastName\": \"DDD\",\r\n \"email\": \"test.1234@alpha.com\",\r\n \"password\": \"123123123\",\r\n \"preferredName\": \"DDD\",\r\n \"grade\": \"5\",\r\n \"school\": \"alpha\",\r\n \"dateOfBirth\": \"2013-01-01\",\r\n \"gender\": \"MALE\"\r\n \r\n}"}},"url":"GRAPHQL_URL"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Content-Length","value":"34"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Fri, 02 Aug 2024 19:53:34 GMT"},{"key":"x-amzn-RequestId","value":"085d97bd-4a1d-46c0-bc5e-a31bc99d6964"},{"key":"x-amzn-appsync-TokensConsumed","value":"220"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 a47a23f37fc6f8e50c6d5f0b1b9273c6.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P1"},{"key":"X-Amz-Cf-Id","value":"ehho3Xz7I2rPi8AV1EBUxrsyIkQb8gFW0xUxA_tN0t-ATd7vLHd0ZQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"signUp\": \"User created\"\n }\n}"},{"id":"4f21fb60-526b-4da1-90d4-557f9ff5a5e4","name":"signUp with role Parent","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"GRAPHQL_API_KEY"}],"body":{"mode":"graphql","graphql":{"query":"mutation signUp($firstName: String!, $lastName: String!, $email: AWSEmail!, $password: String!, $preferredName: String, $grade: String, $school: String, $dateOfBirth: AWSDate, $gender: StudentGender, $roles: [UserEnrollmentRole!]) {\r\nsignUp(firstName: $firstName, lastName: $lastName, email: $email, password: $password, preferredName: $preferredName, grade: $grade, school: $school, dateOfBirth: $dateOfBirth, gender: $gender, roles: $roles)\r\n}\r\n","variables":"{\r\n \"firstName\": \"Parent\",\r\n \"lastName\": \"Parent\",\r\n \"email\": \"test+parent@alpha.com\",\r\n \"password\": \"123123123\",\r\n \"preferredName\": \"DDD\",\r\n \"grade\": \"5\",\r\n \"school\": \"alpha\",\r\n \"dateOfBirth\": \"2013-01-01\",\r\n \"gender\": \"MALE\",\r\n \"roles\": [\"Parent\"]\r\n}"}},"url":"GRAPHQL_URL"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Content-Length","value":"34"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Fri, 02 Aug 2024 19:54:57 GMT"},{"key":"x-amzn-RequestId","value":"91ec7334-18f9-4fa1-8667-5df1344157cd"},{"key":"x-amzn-appsync-TokensConsumed","value":"47"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 69323cc81a35966f2e018b11a9d4a8e6.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P1"},{"key":"X-Amz-Cf-Id","value":"5FXF_Q1tGNmuh8_Q7XepBDQ_gUy9EUaYFNIpcDdS2ZOAV133o99Pzg=="}],"cookie":[],"responseTime":null,"body":""},{"id":"7ccf3b9f-3fc8-4539-b823-945cba8c0b2b","name":"signUp with role Guardian","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"GRAPHQL_API_KEY"}],"body":{"mode":"graphql","graphql":{"query":"mutation signUp($firstName: String!, $lastName: String!, $email: AWSEmail!, $password: String!, $preferredName: String, $grade: String, $school: String, $dateOfBirth: AWSDate, $gender: StudentGender, $roles: [UserEnrollmentRole!]) {\r\nsignUp(firstName: $firstName, lastName: $lastName, email: $email, password: $password, preferredName: $preferredName, grade: $grade, school: $school, dateOfBirth: $dateOfBirth, gender: $gender, roles: $roles)\r\n}\r\n","variables":"{\r\n \"firstName\": \"Parent\",\r\n \"lastName\": \"Parent\",\r\n \"email\": \"test+guardian@alpha.com\",\r\n \"password\": \"123123123\",\r\n \"preferredName\": \"DDD\",\r\n \"grade\": \"5\",\r\n \"school\": \"alpha\",\r\n \"dateOfBirth\": \"2013-01-01\",\r\n \"gender\": \"MALE\",\r\n \"roles\": [\"Guardian\"]\r\n}"}},"url":"GRAPHQL_URL"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Content-Length","value":"34"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Fri, 02 Aug 2024 19:55:52 GMT"},{"key":"x-amzn-RequestId","value":"0f438e25-4e90-48e7-8a44-1d5ce70e328f"},{"key":"x-amzn-appsync-TokensConsumed","value":"34"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 e2e847b082ff9d1bdd61dc9c27ca0786.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P1"},{"key":"X-Amz-Cf-Id","value":"3vnsxrnjMC2C9ZJ-aLsRcsS0i_xq6X1NcTiYG4YSXSwpR2BA40Cp4Q=="}],"cookie":[],"responseTime":null,"body":""},{"id":"3a58458c-a48e-4482-9ac5-83e45b1a7990","name":"signUp with role Student and externalStudentId","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"GRAPHQL_API_KEY"}],"body":{"mode":"graphql","graphql":{"query":"mutation signUp($firstName: String!, $lastName: String!, $email: AWSEmail, $password: String, $preferredName: String, $grade: String, $school: String, $dateOfBirth: AWSDate, $gender: StudentGender, $studentId: String, $roles:ย [UserEnrollmentRole!]) {\r\nsignUp(firstName: $firstName, lastName: $lastName, email: $email, password: $password, preferredName: $preferredName, grade: $grade, school: $school, dateOfBirth: $dateOfBirth, gender: $gender, studentId: $studentId, roles: $roles)\r\n}\r\n","variables":"{\r\n \"firstName\": \"Student\",\r\n \"lastName\": \"Student\",\r\n \"email\": \"student_with_external_id@alpha.com\",\r\n \"password\": \"123123123\",\r\n \"preferredName\": \"DDD\",\r\n \"grade\": \"5\",\r\n \"school\": \"alpha\",\r\n \"dateOfBirth\": \"2013-01-01\",\r\n \"gender\": \"MALE\",\r\n \"studentId\": \"externalStudentId\",\r\n \"roles\": [\"Student\"]\r\n}"}},"url":"GRAPHQL_URL"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Content-Length","value":"34"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Fri, 02 Aug 2024 22:31:20 GMT"},{"key":"x-amzn-RequestId","value":"2c2ba3e0-cdf3-4b42-9feb-446d6d1e03a2"},{"key":"x-amzn-appsync-TokensConsumed","value":"45"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 3c324ded5bb9b770378ef373690c8a34.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P1"},{"key":"X-Amz-Cf-Id","value":"Nhpryj_y94l__Pg5Fj-8PW5J3vKMkCcqirOy4ORPRcLq8LPb9apnAw=="}],"cookie":[],"responseTime":null,"body":""},{"id":"ff06347a-9ea3-4eb0-977c-681dd2d17cce","name":"signUp with multiple roles Parent and Student","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"GRAPHQL_API_KEY"}],"body":{"mode":"graphql","graphql":{"query":"mutation signUp($firstName: String!, $lastName: String!, $email: AWSEmail!, $password: String!, $preferredName: String, $grade: String, $school: String, $dateOfBirth: AWSDate, $gender: StudentGender, $roles: [UserEnrollmentRole!]) {\r\nsignUp(firstName: $firstName, lastName: $lastName, email: $email, password: $password, preferredName: $preferredName, grade: $grade, school: $school, dateOfBirth: $dateOfBirth, gender: $gender, roles: $roles)\r\n}\r\n","variables":"{\r\n \"firstName\": \"Parent\",\r\n \"lastName\": \"Parent\",\r\n \"email\": \"test+parent_student@alpha.com\",\r\n \"password\": \"123123123\",\r\n \"preferredName\": \"DDD\",\r\n \"grade\": \"5\",\r\n \"school\": \"alpha\",\r\n \"dateOfBirth\": \"2013-01-01\",\r\n \"gender\": \"MALE\",\r\n \"roles\": [\"Parent\", \"Student\"]\r\n}"}},"url":"GRAPHQL_URL"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Content-Length","value":"34"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Fri, 02 Aug 2024 19:56:49 GMT"},{"key":"x-amzn-RequestId","value":"a7988d8a-3aa7-4769-b5b3-768887a84f24"},{"key":"x-amzn-appsync-TokensConsumed","value":"40"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 9bba1485ff47cf63bc393925f38d12fc.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P1"},{"key":"X-Amz-Cf-Id","value":"ZhFzCCYqp-qbIBMmwEW9LjlgHEi8xRvOjtBL5y7hvdzvRW4-dhuORg=="}],"cookie":[],"responseTime":null,"body":""},{"id":"90162461-273b-4788-8927-0248792bb799","name":"signUp with role Student while authenticated as a Parent","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"GRAPHQL_API_KEY","disabled":true},{"key":"Authorization","value":"AUTO_GEN_GRAPHQL_ID_TOKEN"}],"body":{"mode":"graphql","graphql":{"query":"mutation signUp($firstName: String!, $lastName: String!, $email: AWSEmail, $password: String, $preferredName: String, $grade: String, $school: String, $dateOfBirth: AWSDate, $gender: StudentGender, $studentId: String, $roles:ย [UserEnrollmentRole!]) {\r\nsignUp(firstName: $firstName, lastName: $lastName, email: $email, password: $password, preferredName: $preferredName, grade: $grade, school: $school, dateOfBirth: $dateOfBirth, gender: $gender, studentId: $studentId, roles: $roles)\r\n}\r\n","variables":"{\r\n \"firstName\": \"Student\",\r\n \"lastName\": \"Student\",\r\n \"email\": \"parent_creates_student@alpha.com\",\r\n \"password\": \"123123123\",\r\n \"preferredName\": \"DDD\",\r\n \"grade\": \"5\",\r\n \"school\": \"alpha\",\r\n \"dateOfBirth\": \"2013-01-01\",\r\n \"gender\": \"MALE\",\r\n \"studentId\": \"externalStudentId\",\r\n \"roles\": [\"Student\"]\r\n}"}},"url":"GRAPHQL_URL"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Content-Length","value":"34"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sat, 03 Aug 2024 09:38:26 GMT"},{"key":"x-amzn-RequestId","value":"3ee57642-d404-4487-8f6b-99c719ec7afa"},{"key":"x-amzn-appsync-TokensConsumed","value":"190"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 e4938fc434947f57a79af6b9b403df6e.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P1"},{"key":"X-Amz-Cf-Id","value":"Vu6Yi-qfPShmVBCsH9pgPY_1gpmqfPcoeb3s0lJDBwLwK67WQCrjHA=="}],"cookie":[],"responseTime":null,"body":""},{"id":"7bc00624-b817-44c8-bd75-93686a4e0060","name":"signUp with role Student while authenticated as a Guardian","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"GRAPHQL_API_KEY","disabled":true},{"key":"Authorization","value":"AUTO_GEN_GRAPHQL_ID_TOKEN"}],"body":{"mode":"graphql","graphql":{"query":"mutation signUp($firstName: String!, $lastName: String!, $email: AWSEmail, $password: String, $preferredName: String, $grade: String, $school: String, $dateOfBirth: AWSDate, $gender: StudentGender, $studentId: String, $roles:ย [UserEnrollmentRole!]) {\r\nsignUp(firstName: $firstName, lastName: $lastName, email: $email, password: $password, preferredName: $preferredName, grade: $grade, school: $school, dateOfBirth: $dateOfBirth, gender: $gender, studentId: $studentId, roles: $roles)\r\n}\r\n","variables":"{\r\n \"firstName\": \"Student\",\r\n \"lastName\": \"Student\",\r\n \"email\": \"guardian_creates_student@alpha.com\",\r\n \"password\": \"123123123\",\r\n \"preferredName\": \"DDD\",\r\n \"grade\": \"5\",\r\n \"school\": \"alpha\",\r\n \"dateOfBirth\": \"2013-01-01\",\r\n \"gender\": \"MALE\",\r\n \"studentId\": \"externalStudentId2\",\r\n \"roles\": [\"Student\"]\r\n}"}},"url":"GRAPHQL_URL"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Content-Length","value":"34"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sat, 03 Aug 2024 09:42:31 GMT"},{"key":"x-amzn-RequestId","value":"43344092-aacb-461d-8523-eecad26690a3"},{"key":"x-amzn-appsync-TokensConsumed","value":"56"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 64c95802ff188dd41dd32c313bef089c.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P1"},{"key":"X-Amz-Cf-Id","value":"1z-7OnPoNsk9JpKhoLqg2oSwAE1M0E6gD2iMTHYmGVI6kVzrpAYNQA=="}],"cookie":[],"responseTime":null,"body":""},{"id":"8b938e57-02f4-4354-9e2c-bb159771c740","name":"signUp fails for duplicated email and school","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"GRAPHQL_API_KEY"}],"body":{"mode":"graphql","graphql":{"query":"mutation signUp($firstName: String!, $lastName: String!, $email: AWSEmail!, $password: String!, $preferredName: String, $grade: String, $school: String, $dateOfBirth: AWSDate, $gender: StudentGender, $roles: [UserEnrollmentRole!]) {\r\nsignUp(firstName: $firstName, lastName: $lastName, email: $email, password: $password, preferredName: $preferredName, grade: $grade, school: $school, dateOfBirth: $dateOfBirth, gender: $gender, roles: $roles)\r\n}\r\n","variables":"{\r\n \"firstName\": \"Parent\",\r\n \"lastName\": \"Parent\",\r\n \"email\": \"test+parent@alpha.com\",\r\n \"password\": \"123123123\",\r\n \"preferredName\": \"DDD\",\r\n \"grade\": \"5\",\r\n \"school\": \"alpha\",\r\n \"dateOfBirth\": \"2013-01-01\",\r\n \"gender\": \"MALE\",\r\n \"roles\": [\"Parent\"]\r\n}"}},"url":"GRAPHQL_URL"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Content-Length","value":"238"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sat, 03 Aug 2024 09:57:32 GMT"},{"key":"x-amzn-RequestId","value":"683bfc58-93ef-4872-826d-09e98effe3e3"},{"key":"x-amzn-appsync-TokensConsumed","value":"12"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 38fe40c6774277cdcda429bb053fbc1e.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P1"},{"key":"X-Amz-Cf-Id","value":"-8ozyU8NE-RkafO3s7aRJ0w4fRPnDbqECU3s3HAk4R_1d3DCeOioXg=="}],"cookie":[],"responseTime":null,"body":""},{"id":"73fc8819-cc8d-4e73-8086-69446b013403","name":"signUp with username","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"GRAPHQL_API_KEY"}],"body":{"mode":"graphql","graphql":{"query":"mutation signUp($firstName: String!, $lastName: String!, $email: AWSEmail!, $password: String!, $preferredName: String, $grade: String, $school: String, $dateOfBirth: AWSDate, $gender: StudentGender, $username: String) {\r\nsignUp(firstName: $firstName, lastName: $lastName, email: $email, password: $password, preferredName: $preferredName, grade: $grade, school: $school, dateOfBirth: $dateOfBirth, gender: $gender, username: $username)\r\n}\r\n","variables":"{\r\n \"firstName\": \"Test\",\r\n \"lastName\": \"User\",\r\n \"email\": \"test-user-01@test.com\",\r\n \"password\": \"123123123\",\r\n \"preferredName\": \"DDD\",\r\n \"grade\": \"5\",\r\n \"school\": \"gt-school\",\r\n \"dateOfBirth\": \"2013-01-01\",\r\n \"gender\": \"MALE\",\r\n \"username\": \"ab\"\r\n}"}},"url":"GRAPHQL_URL"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"f594efca-69bc-4bff-8a01-02b58bf270f4","name":"signUp with referral","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"GRAPHQL_API_KEY"}],"body":{"mode":"graphql","graphql":{"query":"mutation signUp($firstName: String!, $lastName: String!, $email: AWSEmail!, $password: String!, $preferredName: String, $grade: String, $school: String, $dateOfBirth: AWSDate, $gender: StudentGender, $username: String, $referredByStudent: SignUpReferredByStudentIdentityInput) {\r\nsignUp(firstName: $firstName, lastName: $lastName, email: $email, password: $password, preferredName: $preferredName, grade: $grade, school: $school, dateOfBirth: $dateOfBirth, gender: $gender, username: $username, referredByStudent: $referredByStudent)\r\n}\r\n","variables":"{\r\n \"firstName\": \"Test\",\r\n \"lastName\": \"User\",\r\n \"email\": \"test-user-01@test.com\",\r\n \"password\": \"123123123\",\r\n \"preferredName\": \"DDD\",\r\n \"grade\": \"5\",\r\n \"school\": \"gt-school\",\r\n \"dateOfBirth\": \"2013-01-01\",\r\n \"gender\": \"MALE\",\r\n \"username\": \"ab\",\r\n \"referredByStudent\": {\r\n \"username\": \"$4980856296_b709bbe3e6\"\r\n }\r\n}"}},"url":"GRAPHQL_URL"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"7b7e1de6-ab03-4380-95ea-5686429eae66"},{"name":"signUpV2","id":"084260ba-c665-4228-a9a3-b7458399852f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"GRAPHQL_API_KEY"}],"body":{"mode":"graphql","graphql":{"query":"mutation signUpV2($input: SignUpInput!) {\r\n signUpV2(input: $input) {\r\n status\r\n userId\r\n }\r\n}\r\n","variables":"{\r\n \"input\": {\r\n \"firstName\": \"John\",\r\n \"lastName\": \"Smith\",\r\n \"email\": \"john.smith.01@example.com\",\r\n \"password\": \"123123123\",\r\n \"school\": \"alpha\",\r\n \"emailOptIn\": false,\r\n \"roles\": [\r\n \"Student\"\r\n ]\r\n }\r\n}"}},"url":"GRAPHQL_URL","description":"This API endpoint allows the creation of a student, user, and Cognito user based on the provided input.
\nInput
\n- \n
\nfirstName(String, required): The first name of the user. \n
\nlastName(String, required): The last name of the user. \n
\nemail(String, optional): The email address of the user. \n
\npassword(String, optional): The password for the user. \n
\npreferredName(String, optional): The preferred name of the user. \n
\nlocale(String, optional): The locale of the user. \n
\ngrade(String, optional): The grade level of the user. \n
\nschool(String): The school of the user. \n
\nstudentId(String, optional): The student ID of the user. \n
\ndateOfBirth(Date, optional): The date of birth of the user. \n
\ngender(StudentGender, optional): The gender of the user. Possible values areMALE,FEMALE,OTHER. \n
\nlearningLevel(String, optional): The learning level of the user. \n
\ncampusId(String, optional): The campus ID of the user. \n
\nroles([UserEnrollmentRole!], optional): The roles assigned to the user. Possible values areStudent,Guide,Admin,Parent,Guardian. \n
\nusername(String, optional): The username of the user. \n
\nreferredByStudent(SignUpReferredByStudentIdentityInput, optional): Information about the student who referred this user. \n
\nemailOptIn(Boolean, optional): Email opt in flag for the user, false if not provided \n
\nrequireEmailVerification(Boolean, optional): Used to verify user enrollment \n
SignUpReferredByStudentIdentityInput
\n- \n
\nplatformStudentId(String, optional): Valid student identifier. Please refer to the Student Identification section. \n
\nemail(String, optional): Valid student identifier. Please refer to the Student Identification section. \n
\nschoolStudentId(String, optional): Valid student identifier. Please refer to the Student Identification section. \n
\nplatformSchoolId(String, optional): Valid student identifier. Please refer to the Student Identification section. Ifusernameprovided butplatformSchoolIdnot provided, then new user's UserEnrollment school will be used. \n
\nusername(String, optional): The username of the referring student. \n
Output
\nThe output consists of an object having following attributes:
\n- \n
\nstatus(enum, string): The status of user creation
Values:- \n
'USER_CREATED'
\n \n'USER_CREATED_PASSWORD_NOT_SET'
\n \n'USER_CREATED_VERIFICATION_PENDING'
\n \n
\n
\nuserId(string): The unique identifier of the user \n
\nverificationCode(string): Email verification code \n
softDeleteUser
\nThe softDeleteUser endpoint is responsible for soft-deleting a user account in the system. It supports multiple ways of identifying the user to be deleted and implements role-based access control.
Input
\nThe function accepts a ResolverInput object with the following optional arguments in the input field:
interface SoftDeleteUserInput {\n userId?: string;\n schoolStudentId?: string;\n platformSchoolId?: string;\n email?: string;\n}\n\nIf no arguments are provided, the function attempts to delete the currently authenticated user.
\nOutput
\nThe function returns a SoftDeleteUserOutput object:
interface SoftDeleteUserOutput {\n userId: string;\n}\n\nThis object contains the userId of the soft-deleted user.
Behavior
\n- \n
Admins can soft-delete any user.
\n \nParents and guardians can soft-delete their own user or their students' users.
\n \nStudents can only soft-delete their own user.
\n \nIf no user identifier is provided, the function attempts to soft-delete the currently authenticated user.
\n \nThe function throws an error if the user is not authorized to perform the deletion.
\n \n
This endpoint is used to update grade level of a particular student.
Input
\n- \n
Valid student identifier: Please refer to the Student Identification section
\n \n
\ngradeLevel(string, required): The new grade level to be assigned to the student- \n
Allowed values: 'PK', 'K', '1', '2', '3', '4', '5', '6', '7', '8', '9', '10', '11', '12'. \n
\n
Output
\nThe output consists of an object having following attributes:
\n- \n
\nplatformStudentId(string): The platform id of the student \n
\ngradeLevel(string): The updated grade level assigned to the student \n
This mutation allows updating the program enrollment details of a student.
\nInput
\nThe input for this mutation is an object of type UpdateStudentProgramEnrollmentInput. Below are the details of the input parameters:
- \n
\nprogramEnrollmentId(String, required): The ID of the program enrollment. \n
\nsubject(String, required): The subject of the program enrollment. \n
\nstartCourseName(String, optional): The starting course name of the program enrollment. \n
\nendCourseName(String, optional): The ending course name of the program enrollment. \n
Output
\nThe output of this mutation is an object of type StudentProgramEnrollment. Below are the details of the output structure:
StudentProgramEnrollment Object
\n- \n
\nprogramEnrollmentId(String, required): The ID of the program enrollment. \n
\nprogramId(String, required): The ID of the program the student is enrolled in. \n
\nprogramKey(String, required): The key of the program. \n
\nstartDate(String, required): The start date of the program enrollment. \n
\nendDate(String, optional): The end date of the program enrollment. \n
\nstartCourseName(String, optional): The name of the starting course. \n
\nendCourseName(String, optional): The name of the ending course. \n
\nsubjectName(String, required): The name of the subject. \n
\nisUpdateAllowed(Boolean, required): Indicates whether updates to the enrollment are allowed. \n
This mutation allows consumers to update details for a user based on the provided input. It returns the updated user information.
\nInput
\n- \n
input(UpdateUserDetailsInput, required): The input object containing user details that need to be updated. \n
UpdateUserDetailsInput Object
\n- \n
\nuserId(String, required): The unique identifier of the user to update. \n
\npreferredName(String, optional): A preferred nickname or alias for the user. \n
\nusername(String, optional): A username of the user to update \n
\nfirstName(String, optional): First name for the user \n
\nlastName(String, optional): Last name for the user \n
\ncampusId(String, optional): Campus id for the student \n
\ndateOfBirth(Date, optional): Date of birth for the student \n
\ngender(String, optional): Gender for the student \n
\ngrade(String, optional): Grade for the student \n
\nlearningLevel(String, optional): Learning level for the student \n
\nlocale(String, optional): Locale for the user \n
\nemailOptIn(Boolean, optional): Email opt in flag for the user \n
Output
\nThe output provides detailed information about the updated user encapsulated in a User object.
User Object
\n- \n
\nid(String, required): The unique identifier of the user. \n
\nfirstName(String, required): The first name of the user. \n
\nlastName(String, required): The last name of the user. \n
\npreferredName(String, optional): A preferred nickname or alias for the user. \n
\nemail(String, optional): The email address associated with the user account. \n
\nroleName(String, deprecated): The role name of the user. Userolesinstead. \n
\nroles([String], required): A list of roles associated with the user. \n
\nlocale(String, optional): The locale or region for the user, influencing language and regional settings. \n
\nprofileImageURL(String, optional): URL of the user's profile image. \n
\ncoverImageURL(String, optional): URL of the user's cover image. \n
\nacceptedTerms(Boolean, optional): Indicates whether the user has accepted the terms and conditions. \n
\npermissions([String], optional): A list of permissions granted to the user. \n
\nuserEnrollments([UserEnrollment], optional): A list of enrollments associated with the user. \n
\nagents([Agent], optional): A list of agents associated with the user. \n
\nemailOptIn(boolean): Whether the user has opted in for emails or not \n
UserEnrollment Object
\n- \n
\nschool(String, required): The school identifier the user is associated with. \n
\nrole(String, required): The role of the user within the school. \n
\nbeginDate(String, required): The start date of the enrollment. \n
\nendDate(String, optional): The end date of the enrollment. \n
\nstudentId(String, optional): A unique student identifier. \n
\nusername(String, optional): The username of the student. \n
Agent Object
\n- \n
\nid(ID, required): The unique identifier of the agent. \n
\nfirstName(String, required): The first name of the agent. \n
\nlastName(String, required): The last name of the agent. \n
\nemail(String, optional): The email address of the agent. \n
\npreferredName(String, optional): A preferred nickname or alias for the agent. \n
\nroles([String], required): A list of roles associated with the agent. \n
This API upserts extended attributes for a student.
\nInput
\nThe input for this API is a UpsertExtendedStudentAttributesInput object, which includes
- \n
Valid student identifier: Please refer to the Student Identification section
\n \n
\nlearningAppName(string, required): The name of the learning app. \n
\nattributes(array ofStudentExtendedAttributeobjects): An array of student extended attributes. \n
Output
\nThe output is a UpsertExtendedStudentAttributesOutput object, which includes:
UpsertExtendedStudentAttributesOutput
\n- \n
attributes(array ofStudentExtendedAttributeobjects): An array of student extended attributes. \n
StudentExtendedAttribute
\n- \n
\nattributeKey(string): The key of the attribute. \n
\nattributeValue(string): The value of the attribute. \n
This mutation validates if a voucher exists and has no redemption date. If a program is provided, it also validates if the voucher is for the given program.
\nInput
\n- \n
\nvoucher(String, required): The voucher code to be validated. \n
\nprogram(String, optional): The program to validate the voucher against. \n
Output
\nThe output is an object of type ValidateVoucherOutput.
ValidateVoucherOutput
\n- \n
valid(Boolean, required): Indicates whether the voucher is valid. \n
Description
\nThis mutation verifies the user enrollment based on the provided input parameters. It ensures whether a user is verified in a specific school by matching the verification code.
\nInput
\n- \n
\nschool(String, required): The identifier of the school where the user is enrolled. \n
\nemail(String, required): The email of the user seeking verification. \n
\nverificationCode(String, required): The code used to verify the user's enrollment. \n
Output
\nThe output encapsulates the verification status within a VerifyUserEnrollmentOutput object.
VerifyUserEnrollmentOutput Object
\n- \n
verified(Boolean): Indicates whether the user enrollment is verified or not. \n
Description
\nThis query creates a new verification code for user enrollment in a specified school using an email.
\nInput
\n- \n
\nschool(String, required): The name of the school for which the enrollment verification code is being requested. \n
\nemail(String, required): The email address associated with the user enrollment. \n
Output
\nThe output consists of an object with the following structure:
\n- \n
verificationCode(String, required): A code used to verify the user's enrollment in the specified school. \n
Introduction
\nThis document outlines the principles and processes behind our innovative approach to education, designed to optimize each student's learning journey. Our educational platform is at the core of a data-driven, AI-powered approach to highly adaptive, personalized learning. It serves as a comprehensive solution for learning app developers, educational institutions, and students alike.
\nOur learning platform is built on several core principles that drive its design and functionality, some of those key principles are:
\n- \n
Data-Driven Approach: Our platform collects and analyzes student performance data, similar to how one would monitor an elite athlete. This data-driven approach allows for precise tracking of progress and enables timely interventions when needed.
\n \nPersonalized Learning: Every student has unique strengths and weaknesses. Our system adapts to each individual's needs, providing tailored content and recommendations based on their current knowledge.
\n \nAdaptive Learning: Our platform continuously assesses student knowledge and adjusts the learning path accordingly, ensuring optimal challenge and growth. This approach helps maintain student engagement and motivation.
\n \nBottom-Up Knowledge Building: We focus on building knowledge from the ground up, ensuring there are no gaps in a student's understanding.
\n \n
This guide is intended for learning app developers, educators, and administrators who want to leverage our platform to support academics for their students.
\nUse Cases
\nGetting the Next Recommendation for the Student
\nThe platform provides the getStandardBasedStudentRecommendations API, which recommends the next standard that student should work. Below are details about the API's inner workings.
1. Intent of the Recommendation
\nThe API returns two types of recommendations, indicated by the intent as either Test or Learn.
- \n
Intent as 'Test': This indicates that the recommendation is for the adaptive placement test. For more information on how the placement grade affects the adaptive placement test, refer to the
\nAdaptive Placement Testsection. \nIntent as 'Learn': This signifies that the placement test is complete (or not applicable), and the student should now begin learning the standard.
\n \n
2. Recommendation Algorithms
\nThe API currently supports only the breadthFirstMastery algorithm.
The breadth-first mastery recommendation algorithm is designed to enhance students' learning journeys by guiding them through educational standards with an emphasis on building a broad base of knowledge before diving into specific topics. This approach ensures students acquire a well-rounded understanding of the subject matter, laying a solid foundation for more complex learning experiences. The recommender suggests a standard until it reaches a certain threshold, then moves to the next standard, continuing this process until all standards in an academic course are at the same threshold. The cycle repeats for the next threshold and continues until all standards are mastered.
\nNote: To determine the thresholds for each subject, you need to set them in platform. If these are not set, the recommender will automatically suggest resources in a bottom-up fashion. To set these thresholds, you can use NocoDB or contact the platform team.
\n3. Placement grade
\nThe placement grade determines the starting point for the API to recommend standards for students. It differs from the student's current academic grade and should be set before using the API. Without setting the placement grade, the API will default to recommending standards from the lowest possible grade, which may not be desirable. For more details on setting placement grade refer to Setting the Placement Grade section.
4. Additional Details
\nFor more details about the getStandardBasedStudentRecommendations endpoint, please refer to the API documentation.
\n
Adaptive Placement Test
\nThe Adaptive Placement Test is a key feature of our recommendation system, designed to accurately assess student proficiency and ensure appropriate placement. It dynamically adjusts recommendations based on student responses. This ensures an accurate assessment of student proficiency and appropriate placement within a learning program.
\nWe have two types of Adaptive Placement Test:
\n- \n
One time Adaptive Placement Test: A one-time adative test that assesses a student's current knowledge level in a subject. This could be used for establishing an accurate initial starting point in a student's educational journey.
\n \nContinuous Adaptive Placement Test: An ongoing adaptive test that regularly reassesses a student's knowledge as they learn. This should be used for maintaining the relevance and effectiveness of a student's learning path over time. It prevents learning plateaus, keeps students engaged with appropriately challenging material.
\n \n
Process Overview
\nHere's a detailed breakdown of how adaptive Placement works:
\nInitiation
\n- \n
The student begins their journey in the Learning App.
\n \nThe Learning App sets the placement grade for the student via invoking the API
\nupsertStudentPlacementGrade- \n
- This is important because the adaptive placement recommendations will begin from this grade level. For example, for a 5th grade student whose placement grade is set as 3rd Grade, the testing would start from 3rd grade to identify any potential learning gaps. \n
\n
One Time Adaptive Testing
\n- \n
The learning app requests recommendations using the
\ngetStandardBasedStudentRecommendationsAPI with adaptivePlacementTestMode set asinitialOnly. \nThe API returns a recommendation considering two lowest grades from student's knowledge stack that they have not yet completed, with the intent set to \"Test.\"
\n \nThe student answers the question on the recommended standard.
\n \nThe learning app sends the student's responses via
\nupsertMasteryTestActivity API, which would also update mastery for the level and applicable pre-requisites and dependencies and marking the standards as learned or not learned respectively. \nThe learning app requests another recommendation. The process repeats with Intent = 'Test' until the placement test ends. If the test has ended, the Intent will be โLearnโ.
\n- \n
Placement test would end based on below conditions:
\n- \n
If a standard is marked as NOT_LEARNED and all its prerequisites are marked as LEARNED.
\n \nIf a standard is marked as NOT_LEARNED and has no prerequisites.
\n \n
\n
\nOnce the Intent is โLearnโ, the learning app sends the standard activity via
\nupsetLearningAppActivity\n
Continuous Adaptive Testing
\n- \n
The learning app requests recommendations using the
\ngetStandardBasedStudentRecommendationsAPI with adaptivePlacementTestMode set ascontinuous. \nThe process is similar to One Time Adaptive Testing.
\n \nOnce the student masters the recommended standard sent with Intent = โLearnโ, the adaptive placement test process restarts.
\n \nCall the
\ngetStandardBasedStudentRecommendationsAPI which would recommend now a standard with Intent = โTestโ and when the placement test ends again, it recommends resources with Intent = โLearnโ. \n
\n
Setting the Placement Grade
\nThe Placement Grade determines the grade level from which the learning app wants to start recommending content for the student. Any skills or standards below the Placement Grade are considered mastered unless there is explicit activity by the student that indicates that the student does not know a particular standard. The getStandardBasedStudentRecommendations API only recommends non-mastered standards, so setting the Placement Grade ensures that the recommender will not suggest any standards below this grade unless they are explicitly marked as NOT_LEARNED/LEARNING.
Recommendations for Setting the Placement Grade:
\n- \n
Current Grade - 2: It is recommended to set the Placement Grade as the student's current grade minus two. This approach allows the learning app to identify any knowledge gaps in the previous two grades.
\n \nCurrent Grade - 1: If the learning app is confident that the student knows the concepts from previous grades, it can set the Placement Grade as the current grade minus one.
\n \n
Important Note:
\n- \n
- Avoid setting the Placement Grade as the student's current grade. This may cause the adaptive placement test to recommend standards above the student's current grade, which might not be desirable. To know how placement grade effect the Adaptive placement test refer
Adaptive Placement Testsection. \n
To set the Placement Grade for a student, use the upsertStudentPlacementGrade endpoint.
Overview
\nThis guide explains how to enroll students in specific programs using our platform. Enrollment may require a voucher for some programs, while others allow direct enrollment.
\nEnrollment Methods
\n1. Voucher Purchase Enrollment
\nThis method is suitable when there's a need to integrate payment into the enrollment process.
\nProcess:
\n- \n
Purchase a voucher for the student.
\n \nEnrollment occurs based on student status:
\n- \n
Existing students: May be automatically enrolled
\n \nNew students: Enrolled upon signup
\n \n
\n
Note: Auto-enrollment for students is configurable. If not set, auto-enrollment won't occur.
\nFor detailed information on how to integrate payment, refer to the Payment Flow user guide.
2. Direct Enrollment via API
\nThis method is ideal when there is no need to integrate payment into the enrollment process. It can also be used for in-app purchases, as the learning app handles the payment in these scenarios, and the platform does not play a role in the payment process.
\nProcess:
Use GraphQL endpoints to:
- \n
Generate a voucher & enroll (
\ncreateEnrollmentVoucher)- \n
Use this to generate a voucher.
\n \nSupports auto-enrolling the student while generating a voucher or once the student signs up. (Configurable)
\n \n
\nEnroll the student (
\nenrollStudentInProgram)- \n
Use this if a program doesn't need a voucher or if you don't want to auto-enroll the student.
\n \nUsing this you can later(after the voucher generation) enroll the student using the voucher.
\n \n
\n
Program Configurations
\n- \n
Voucher Required:
\n- \n
- Makes a voucher mandatory for program enrollment. \n
\nCourse Enrollment:
\n- \n
- Program enrollment can be linked to courses. \n
\nAuto Determine Enrollment Grade:
\n- \n
- Courses linked to program enrollment can be automatically determined using the higher of the placement grade or the student's current grade minus 1. \n
\n
Note: To set any configuration, please contact the platform team.
\n","_postman_id":"09ee7528-1aee-49fb-a867-e148e36ce6e9"},{"name":"Payment Flow","item":[],"id":"04c400cf-d145-4f93-b7cf-448a30c853f4","description":"Overview
\nThis guide explains how to integrate voucher purchases into your system using our platform. The process now supports two payment flows: Stripe Checkout and Stripe Elements. Both methods allow for voucher purchases which can be used to enroll students into programs.
\nNote: Currently we support only stripe as a payment provider for purchasing vouchers which could be then used to enroll students into the programs.
\nStripe Checkout Flow
\nStep 1: Creating the Checkout Session
\nTo initiate the purchase flow, create a checkout session for Stripe (our current payment provider) using the createCheckoutSession endpoint. Both regular payments and subscriptions are supported and configurable via a mode parameter, which defaults to payment
Key Points:
\n- \n
Endpoint:
\ncreateCheckoutSession(found in thePaymentssection of the documentation) \nRequired Parameters:
\n- \n
Success URL: Where the user is redirected after successful purchase
\n \nCancel URL: Where the user is redirected if they cancel the purchase
\n \n
\nOptional Parameters:
\n- \n
Voucher type
\n \nProgram name
\n \nCheckout session mode (payment or subscription)
\n \nOther information needed for voucher creation or program enrollment
\n \n
\n
Step 2: Handling the Stripe Webhook
\nAfter the checkout session is succesfully completed, our platform automatically handles a Stripe webhook that performs the following actions:
\n- \n
Creates the purchased voucher with the required specifications
\n \nCreates parent and student contacts in the main HubSpot account (if they don't exist)
\n- \n
- Only email, first name, and last name are added \n
\nIf the student already exists in our database and the program is set for auto-enrollment, enroll the student into the program.
\n \n
Stripe Elements Flow
\nStep 1: Creating a Payment Intent
\nTo initiate the Stripe Elements purchase flow, create a payment intent after user initiate a transaction on the payments page, using the `createStripePaymentIntent` endpoint.
\nPre requisite:
\n- \n
- Frontend creates a payment method and pass it as an input to
createStripePaymentIntent.\n
Key Points:
\n- \n
Endpoint:
\ncreateStripePaymentIntent(definition can be found in thePaymentssection of the documentation) \nRequired Parameters:
\n- \n
\npriceId\n
\nemail\n
\nprogram\n
\nvoucherType\n
\nreturnUrl\n
\npaymentMethodId\n
\nOptional Parameters:
\n- \n
\nname\n
\nstudentName\n
\nstudentEmail\n
\nplatformStudentId\n
\nsubscribe\n
\nstartCourseName\n
\nendCourseName\n
\nsubject\n
\nenrollmentStartDate\n
\nmetadata\n
\n
Step 2: Managing the Payment Intent
\nAfter creating the payment intent, you may need to manage it, especially if 3D Secure authentication is required.
\nKey Points:
\n- \n
Endpoint:
\nmanageStripePaymentIntent(definition can be found in thePaymentssection of the documentation) \nRequired Parameters:
\n- \n
\npaymentIntentId: Stripe PaymentIntent ID to be confirmed \n
\naction: Action to perform ('check_status' or 'confirm')- \n
If action is 'check_status':
\n- \n
- Returns the current status and PaymentIntent ID. \n
\nIf action is 'confirm':
\n- \n
Attempts to confirm the PaymentIntent with Stripe.
\n \nHandle any required additional actions (e.g., 3D Secure).
\n \nReturn the updated PaymentIntent details based on its status.
\n \n
\n
\n
\nOptional Parameters:
\n- \n
returnUrl: URL to redirect after payment completion (required for 'confirm' action) \n
\n
Checking Voucher Enrollment/Purchase Status
\nOnce payment is completed then use the getVoucherEnrollmentStatus endpoint to check the status of the purchase and enrollment. This could be used as a polling endpoint to determine that if the voucher creation and program enrollment has gone through after the voucher purchase.
Endpoint Details:
\n- \n
Name:
\ngetVoucherEnrollmentStatus\nParameters:
\n- \n
Payment gateway (currently always \"Stripe\")
\n \nTransaction ID (received as a query parameter in the success URL)
\n \n
\n
Information Provided:
\n- \n
Student existence in the database
\n \nAuto-enrollment status (if applicable)
\n \nEnrollment start date and optional end date (if auto-enrolled)
\n \nReference information:
\n- \n
Parent email
\n \nStudent email
\n \nProgram name
\n \nVoucher code
\n \nVoucher type
\n \nMetadata
\n \n
\n
How to Retrieve the Transaction ID:
\nStripe Checkout Flow:
\n- \n
The success url would include the transaction id, for example: https:///success?session_id={CHECKOUT_SESSION_ID}
\n \nRetrieve the
\nsession_idquery parameter from the success URL, which would be used astransaction_id. \n
Stripe Elements Flow:
\n- \n
- The transaction Id is the payment intent id. \n
Important Notes:
\n- \n
The voucher creation and enrollment processes are sequential. There may be a brief delay between these actions.
\n \nIf enrollment status is not as expected, wait a second and check again before deciding on the next action.
\n \nUse the data from the final status check to determine your next steps.
\n \n
Sequence Diagram
\nStripe Checkout Flow:
\nStripe Elements Flow:
\nIntroduction
\nThis guide focuses on how to add an event to the Rewards Module and how that event is processed to potentially trigger a reward. Understanding this workflow is crucial for implementing an effective reward system in your learning application.
\nAdding an Event
\nEvents can be added to the system in two ways:
\n- \n
Automatic Events: The system automatically creates certain events, such as
\nLEVEL_MASTERED. \nCustom Events: Learning apps can create their own events using the
\npublishApplicationEventAPI. \n
Automatic Events
\nThe system automatically creates a LEVEL_MASTERED event when a student masters a level. This event includes the following properties:
- \n
\ncourseId: Academic Course ID of the mastered level \n
\nsubjectId: Subject ID of the mastered level \n
\nisRecommendation: Indicates if the mastered level was a recommendation \n
\nthirdPartyLevelId: Third Party Level ID for the learning app level that was mastered \n
\nlearningResourceId: Learning Resource ID attached to the level \n
Custom Events
\nTo add a custom event:
\n- \n
Use the
\npublishApplicationEventAPI endpoint. \nProvide the necessary event details, including a unique event name and any relevant properties.
\n \n
Event Processing for Rewards
\nOnce an event is added to the system, it's processed for potential rewards as follows:
\n- \n
The system checks for matching configurations in:
\n- \n
\nlearning_app_event_asset_reward_configurations\n
\nlearning_app_event_currency_reward_configurations\n
\nThe system compares the event details with the configuration:
\n- \n
Via configuration you check specific criteria in the event data (e.g.,
\n{\"quizResult\": \"all_correct\"}for aquiz_submittedevent), the event must match these criteria for the reward to be given. \nIf no specific criteria is defined in the configuration, then reward would be processed just based on event matching the configuration (e.g.,
\nlevel_masteredevent matcheslevel_masteredconfiguration.) \n
\nIf a matching configuration is found following validation would also be done:
\n- \n
The system verifies if the student is enrolled in the program associated with the configuration.
\n \nIf the configuration requires course-level enrollment, the system checks if the level was mastered in the specific courses.
\n \n
\nIf all conditions are met, the reward is awarded to the student.
\n \n
Note: We also have reward groups which could help in giving multiple rewards for a single event. So a event matching any number of configuration in 1 reward group would give only 1 reward, but if it matches a configuration in another reward group then it would get another reward.
\nExample Workflow
\nLet's walk through an example of adding a custom event and processing it for a reward:
\n- \n
Adding the Event:
\n- \n
Your learning app calls the
\npublishApplicationEventAPI when a student completes a quiz. \nEvent Key: \"QUIZ_SUBMITTED\"
\n \nDetails:
\n{\"quizResult\": \"all_correct\", \"quizId\": \"12345\"}\n
\nEvent Processing:
\n- \n
The system receives the \"QUIZ_SUBMITTED\" event.
\n \nIt checks the reward configuration tables for a matching configuration.
\n \nLet's say a configuration exists that awards 50 \"points\" for this event when all answers are correct.
\n \n
\nReward Awarding:
\n- \n
The system verifies that the student is enrolled in the program associated with this reward configuration.
\n \nThe system checks that the event details match the configuration (in this case,
\n\"quizResult\": \"all_correct\"). \nIf all conditions are met, the system awards 50 \"points\" to the student.
\n \nIf learning app requested the reward at the time adding the event then they receive the rewards synchronusly.
\n \n
\nNotification:
\n- \n
Once the reward is applied, a notification is sent via the 'onCreateLearningAppMessage' subscription.
\n \nYour learning app, subscribed to this notification, receives the update and can display the new balance to the student.
\n \n
\n