@salesforce/lds-adapters-industries-education 0.1.0-dev1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE.txt +82 -0
- package/dist/es/es2018/industries-education.js +10254 -0
- package/dist/es/es2018/types/src/generated/adapters/adapter-utils.d.ts +62 -0
- package/dist/es/es2018/types/src/generated/adapters/createCarePlans.d.ts +16 -0
- package/dist/es/es2018/types/src/generated/adapters/createLearnings.d.ts +15 -0
- package/dist/es/es2018/types/src/generated/adapters/createPreliminaryApplicationReferences.d.ts +16 -0
- package/dist/es/es2018/types/src/generated/adapters/createTask.d.ts +22 -0
- package/dist/es/es2018/types/src/generated/adapters/getAcademicTerms.d.ts +27 -0
- package/dist/es/es2018/types/src/generated/adapters/getApplicationDetails.d.ts +27 -0
- package/dist/es/es2018/types/src/generated/adapters/getApplications.d.ts +26 -0
- package/dist/es/es2018/types/src/generated/adapters/getAptsTasksPlans.d.ts +28 -0
- package/dist/es/es2018/types/src/generated/adapters/getAvailableTimeSlots.d.ts +28 -0
- package/dist/es/es2018/types/src/generated/adapters/getAvailableTopics.d.ts +26 -0
- package/dist/es/es2018/types/src/generated/adapters/getIndividualApplicationTask.d.ts +27 -0
- package/dist/es/es2018/types/src/generated/adapters/getLearnerProgress.d.ts +28 -0
- package/dist/es/es2018/types/src/generated/adapters/getLearning.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/adapters/getNewApplicationPreliminaryData.d.ts +27 -0
- package/dist/es/es2018/types/src/generated/adapters/getPersonPublicProfile.d.ts +28 -0
- package/dist/es/es2018/types/src/generated/adapters/getPicklistValues.d.ts +27 -0
- package/dist/es/es2018/types/src/generated/adapters/getPreviewLearningProgramPlan.d.ts +27 -0
- package/dist/es/es2018/types/src/generated/adapters/getProgramTermApplicationTimelines.d.ts +28 -0
- package/dist/es/es2018/types/src/generated/adapters/getSuccessTeam.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/adapters/postBenefitAssignment.d.ts +16 -0
- package/dist/es/es2018/types/src/generated/adapters/postMatchingSelector.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/adapters/postPublishLearningProgramPlan.d.ts +16 -0
- package/dist/es/es2018/types/src/generated/adapters/postValidateLearningFoundationList.d.ts +28 -0
- package/dist/es/es2018/types/src/generated/adapters/updateLearnings.d.ts +15 -0
- package/dist/es/es2018/types/src/generated/adapters/updateTaskStatus.d.ts +23 -0
- package/dist/es/es2018/types/src/generated/artifacts/main.d.ts +25 -0
- package/dist/es/es2018/types/src/generated/artifacts/sfdc.d.ts +43 -0
- package/dist/es/es2018/types/src/generated/resources/getConnectEducationAcademicOperationsLearningsByRecordId.d.ts +19 -0
- package/dist/es/es2018/types/src/generated/resources/getConnectEducationApplications.d.ts +12 -0
- package/dist/es/es2018/types/src/generated/resources/getConnectEducationApplicationsByPreliminaryApplicationRefId.d.ts +15 -0
- package/dist/es/es2018/types/src/generated/resources/getConnectEducationAppointmentBookingAvailableTopics.d.ts +12 -0
- package/dist/es/es2018/types/src/generated/resources/getConnectEducationCampusSetupLearnerLearnerProgressByContactId.d.ts +18 -0
- package/dist/es/es2018/types/src/generated/resources/getConnectEducationCampusSetupLearningProgramPlanPreviewByLearningProgramPlanId.d.ts +15 -0
- package/dist/es/es2018/types/src/generated/resources/getConnectEducationIndividualApplicationTasksByIndividualApplicationTaskId.d.ts +15 -0
- package/dist/es/es2018/types/src/generated/resources/getConnectEducationNewApplicationAcademicTerms.d.ts +15 -0
- package/dist/es/es2018/types/src/generated/resources/getConnectEducationNewApplicationPreliminaryData.d.ts +15 -0
- package/dist/es/es2018/types/src/generated/resources/getConnectEducationNewApplicationProgramTermApplicationTimelines.d.ts +16 -0
- package/dist/es/es2018/types/src/generated/resources/getConnectEducationPersonPublicProfileByContactIdAndUsageType.d.ts +16 -0
- package/dist/es/es2018/types/src/generated/resources/getConnectEducationStudentActionCentreAptsTasksPlansByContactId.d.ts +18 -0
- package/dist/es/es2018/types/src/generated/resources/getConnectEducationStudentActionCentreTaskPicklistValues.d.ts +15 -0
- package/dist/es/es2018/types/src/generated/resources/getConnectEducationSuccessTeamByAccountId.d.ts +19 -0
- package/dist/es/es2018/types/src/generated/resources/patchConnectEducationAcademicOperationsLearnings.d.ts +12 -0
- package/dist/es/es2018/types/src/generated/resources/patchConnectEducationStudentActionCentreTaskByTaskId.d.ts +22 -0
- package/dist/es/es2018/types/src/generated/resources/postConnectEducationAcademicOperationsLearnings.d.ts +12 -0
- package/dist/es/es2018/types/src/generated/resources/postConnectEducationAppointmentBookingAvailableTimeSlots.d.ts +16 -0
- package/dist/es/es2018/types/src/generated/resources/postConnectEducationCampusSetupLearningProgramPlanPublish.d.ts +13 -0
- package/dist/es/es2018/types/src/generated/resources/postConnectEducationCampusSetupLearningValidateFoundationItems.d.ts +16 -0
- package/dist/es/es2018/types/src/generated/resources/postConnectEducationCareplanBulk.d.ts +13 -0
- package/dist/es/es2018/types/src/generated/resources/postConnectEducationMentoringBenefitAssignmentProviderByBenefitAssignmentId.d.ts +15 -0
- package/dist/es/es2018/types/src/generated/resources/postConnectEducationMentoringMatchingSelectorByBenefitAssignmentId.d.ts +19 -0
- package/dist/es/es2018/types/src/generated/resources/postConnectEducationNewApplicationPreliminaryApplicationReferences.d.ts +13 -0
- package/dist/es/es2018/types/src/generated/resources/postConnectEducationStudentActionCentreTask.d.ts +19 -0
- package/dist/es/es2018/types/src/generated/types/AbstractAchievementMapping.d.ts +28 -0
- package/dist/es/es2018/types/src/generated/types/AcademicCredential.d.ts +34 -0
- package/dist/es/es2018/types/src/generated/types/AcademicTerm.d.ts +34 -0
- package/dist/es/es2018/types/src/generated/types/AcademicTermsOutputRepresentation.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/AchievementContributor.d.ts +34 -0
- package/dist/es/es2018/types/src/generated/types/ActionPlan.d.ts +49 -0
- package/dist/es/es2018/types/src/generated/types/ActionPlanTemplate.d.ts +53 -0
- package/dist/es/es2018/types/src/generated/types/ActionPlanTemplateItem.d.ts +49 -0
- package/dist/es/es2018/types/src/generated/types/AdditionalEducation.d.ts +37 -0
- package/dist/es/es2018/types/src/generated/types/AdditionalFields.d.ts +32 -0
- package/dist/es/es2018/types/src/generated/types/Applicant.d.ts +34 -0
- package/dist/es/es2018/types/src/generated/types/Application.d.ts +65 -0
- package/dist/es/es2018/types/src/generated/types/ApplicationAcademicLevel.d.ts +31 -0
- package/dist/es/es2018/types/src/generated/types/ApplicationDetailsOutputRepresentation.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/ApplicationRenderMethod.d.ts +37 -0
- package/dist/es/es2018/types/src/generated/types/ApplicationsOutputRepresentation.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/AptsTasksPlansOutputRepresentation.d.ts +53 -0
- package/dist/es/es2018/types/src/generated/types/AvailableStaff.d.ts +62 -0
- package/dist/es/es2018/types/src/generated/types/AvailableTeam.d.ts +53 -0
- package/dist/es/es2018/types/src/generated/types/AvailableTimeSlotsInputRepresentation.d.ts +46 -0
- package/dist/es/es2018/types/src/generated/types/AvailableTimeSlotsInputRepresentationData.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/AvailableTimeSlotsOuputRepresentation.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/AvailableTopic.d.ts +41 -0
- package/dist/es/es2018/types/src/generated/types/AvailableTopicsOutputRepresentation.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/BenefitAssignmentInputRepresentation.d.ts +71 -0
- package/dist/es/es2018/types/src/generated/types/BenefitAssignmentListInputRepresentation.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/BenefitDisbursementForBenefitSessionInputRepresentation.d.ts +46 -0
- package/dist/es/es2018/types/src/generated/types/BenefitDisbursementListInputRepresentation.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/CarePlan.d.ts +49 -0
- package/dist/es/es2018/types/src/generated/types/CarePlanBulkInputRepresentation.d.ts +28 -0
- package/dist/es/es2018/types/src/generated/types/CarePlanBulkInputWrapperRepresentation.d.ts +28 -0
- package/dist/es/es2018/types/src/generated/types/CarePlanBulkOutputRepresentation.d.ts +44 -0
- package/dist/es/es2018/types/src/generated/types/CarePlanInputRepresentation.d.ts +67 -0
- package/dist/es/es2018/types/src/generated/types/CarePlanListInputRepresentation.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/CarePlanTaskInputRepresentation.d.ts +49 -0
- package/dist/es/es2018/types/src/generated/types/ConcreteAchievementMapping.d.ts +41 -0
- package/dist/es/es2018/types/src/generated/types/ContactInformation.d.ts +34 -0
- package/dist/es/es2018/types/src/generated/types/CreateLearningInputRepresentation.d.ts +53 -0
- package/dist/es/es2018/types/src/generated/types/CreateLearningOutputRepresentation.d.ts +50 -0
- package/dist/es/es2018/types/src/generated/types/CreateLearningsInputRepresentation.d.ts +28 -0
- package/dist/es/es2018/types/src/generated/types/CreateLearningsOutputRepresentation.d.ts +48 -0
- package/dist/es/es2018/types/src/generated/types/CustomFieldInputRepresentation.d.ts +34 -0
- package/dist/es/es2018/types/src/generated/types/CustomFieldListInputRepresentation.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/EducationApiErrorDetails.d.ts +31 -0
- package/dist/es/es2018/types/src/generated/types/ElectiveCourseRequirement.d.ts +32 -0
- package/dist/es/es2018/types/src/generated/types/FilterConfig.d.ts +37 -0
- package/dist/es/es2018/types/src/generated/types/GetApplicationDetailsResult.d.ts +72 -0
- package/dist/es/es2018/types/src/generated/types/GetApplicationsResult.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/GetLearningOutputRepresentation.d.ts +61 -0
- package/dist/es/es2018/types/src/generated/types/GetNewApplicationPreliminaryDataResult.d.ts +33 -0
- package/dist/es/es2018/types/src/generated/types/GetSuccessTeamResult.d.ts +39 -0
- package/dist/es/es2018/types/src/generated/types/GoalAssignmentInputRepresentation.d.ts +67 -0
- package/dist/es/es2018/types/src/generated/types/GoalAssignmentListInputRepresentation.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/IndividualApplicationTask.d.ts +62 -0
- package/dist/es/es2018/types/src/generated/types/IndividualApplicationTaskOutputRepresentation.d.ts +30 -0
- package/dist/es/es2018/types/src/generated/types/LearnerProgram.d.ts +86 -0
- package/dist/es/es2018/types/src/generated/types/LearnerProgramRequirement.d.ts +53 -0
- package/dist/es/es2018/types/src/generated/types/LearnerProgressOutputRepresentation.d.ts +33 -0
- package/dist/es/es2018/types/src/generated/types/Learning.d.ts +61 -0
- package/dist/es/es2018/types/src/generated/types/LearningAchievement.d.ts +53 -0
- package/dist/es/es2018/types/src/generated/types/LearningCourse.d.ts +48 -0
- package/dist/es/es2018/types/src/generated/types/LearningCourseOutput.d.ts +55 -0
- package/dist/es/es2018/types/src/generated/types/LearningEquivalency.d.ts +34 -0
- package/dist/es/es2018/types/src/generated/types/LearningFoundationItemOutput.d.ts +74 -0
- package/dist/es/es2018/types/src/generated/types/LearningFoundationItemValidationInput.d.ts +34 -0
- package/dist/es/es2018/types/src/generated/types/LearningFoundationItemValidationInputRepresentation.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/LearningFoundationItemValidationOutput.d.ts +38 -0
- package/dist/es/es2018/types/src/generated/types/LearningFoundationItemValidationOutputRepresentation.d.ts +30 -0
- package/dist/es/es2018/types/src/generated/types/LearningFoundationValidationInfo.d.ts +40 -0
- package/dist/es/es2018/types/src/generated/types/LearningFulfiller.d.ts +42 -0
- package/dist/es/es2018/types/src/generated/types/LearningOutcomeItemOutput.d.ts +52 -0
- package/dist/es/es2018/types/src/generated/types/LearningOutput.d.ts +70 -0
- package/dist/es/es2018/types/src/generated/types/LearningPolicyRuleId.d.ts +28 -0
- package/dist/es/es2018/types/src/generated/types/LearningPolicyRuleOutput.d.ts +37 -0
- package/dist/es/es2018/types/src/generated/types/LearningPolicyRuleUpdate.d.ts +33 -0
- package/dist/es/es2018/types/src/generated/types/LearningPolicyRules.d.ts +34 -0
- package/dist/es/es2018/types/src/generated/types/LearningProgram.d.ts +39 -0
- package/dist/es/es2018/types/src/generated/types/LearningProgramOutput.d.ts +43 -0
- package/dist/es/es2018/types/src/generated/types/LearningProgramPlan.d.ts +62 -0
- package/dist/es/es2018/types/src/generated/types/LearningProgramPlanInputRepresentation.d.ts +32 -0
- package/dist/es/es2018/types/src/generated/types/LearningProgramPlanInputRepresentationData.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/LearningProgramPlanOutputRepresentation.d.ts +38 -0
- package/dist/es/es2018/types/src/generated/types/LearningProgramPlanRequirement.d.ts +44 -0
- package/dist/es/es2018/types/src/generated/types/LearningProgramPlanRequirementOutput.d.ts +56 -0
- package/dist/es/es2018/types/src/generated/types/LearningStatus.d.ts +80 -0
- package/dist/es/es2018/types/src/generated/types/MentoringBenefitAssignment.d.ts +91 -0
- package/dist/es/es2018/types/src/generated/types/MentoringBenefitAssignmentInputRepresentation.d.ts +28 -0
- package/dist/es/es2018/types/src/generated/types/MentoringBenefitAssignmentOutputRepresentation.d.ts +38 -0
- package/dist/es/es2018/types/src/generated/types/MentoringMatchingSelectorInputRepresentation.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/MentoringMatchingSelectorOutputRepresentation.d.ts +30 -0
- package/dist/es/es2018/types/src/generated/types/MentoringProfileOption.d.ts +28 -0
- package/dist/es/es2018/types/src/generated/types/NewApplicationPreliminaryDataOutputRepresentation.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/PersonPublicProfileInformation.d.ts +46 -0
- package/dist/es/es2018/types/src/generated/types/PersonPublicProfileOutputRepresentation.d.ts +48 -0
- package/dist/es/es2018/types/src/generated/types/PreliminaryApplicationReferencesInputInputWrapperRepresentation.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/PreliminaryApplicationReferencesInputListWrapper.d.ts +28 -0
- package/dist/es/es2018/types/src/generated/types/PreliminaryApplicationReferencesInputRepresentation.d.ts +31 -0
- package/dist/es/es2018/types/src/generated/types/PreliminaryApplicationReferencesOutputRepresentation.d.ts +44 -0
- package/dist/es/es2018/types/src/generated/types/PreviewLearningProgramPlanOutputRepresentation.d.ts +38 -0
- package/dist/es/es2018/types/src/generated/types/ProfessionalExperience.d.ts +46 -0
- package/dist/es/es2018/types/src/generated/types/ProgramTermApplicationTimeline.d.ts +34 -0
- package/dist/es/es2018/types/src/generated/types/ProgramTermApplicationTimelineOutputRepresentation.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/RequiredCourseRequirement.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/Requirement.d.ts +31 -0
- package/dist/es/es2018/types/src/generated/types/RequirementDuration.d.ts +40 -0
- package/dist/es/es2018/types/src/generated/types/RequirementUpdateItem.d.ts +31 -0
- package/dist/es/es2018/types/src/generated/types/ReusableCollectionRequirement.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/ServiceAppointment.d.ts +37 -0
- package/dist/es/es2018/types/src/generated/types/ServiceLocation.d.ts +31 -0
- package/dist/es/es2018/types/src/generated/types/SharedAchievementMapping.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/SkillAchievementMapping.d.ts +35 -0
- package/dist/es/es2018/types/src/generated/types/Submitter.d.ts +31 -0
- package/dist/es/es2018/types/src/generated/types/SuccessTeamOutputRepresentation.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/Task.d.ts +64 -0
- package/dist/es/es2018/types/src/generated/types/TaskInputRepresentation.d.ts +49 -0
- package/dist/es/es2018/types/src/generated/types/TaskPicklistOutputRepresentation.d.ts +33 -0
- package/dist/es/es2018/types/src/generated/types/TaskPriority.d.ts +34 -0
- package/dist/es/es2018/types/src/generated/types/TaskStatus.d.ts +34 -0
- package/dist/es/es2018/types/src/generated/types/TimeSlot.d.ts +40 -0
- package/dist/es/es2018/types/src/generated/types/UpdateLearningInputRepresentation.d.ts +51 -0
- package/dist/es/es2018/types/src/generated/types/UpdateLearningsInputRepresentation.d.ts +28 -0
- package/dist/es/es2018/types/src/generated/types/WorkType.d.ts +34 -0
- package/dist/es/es2018/types/src/generated/types/type-utils.d.ts +32 -0
- package/package.json +78 -0
- package/sfdc/index.d.ts +1 -0
- package/sfdc/index.js +10468 -0
- package/src/raml/api.raml +3531 -0
- package/src/raml/luvio.raml +167 -0
|
@@ -0,0 +1,3531 @@
|
|
|
1
|
+
#%RAML 1.0
|
|
2
|
+
securedBy:
|
|
3
|
+
- OAuth2
|
|
4
|
+
title: Salesforce Connect API
|
|
5
|
+
version: '60.0'
|
|
6
|
+
mediaType: application/json
|
|
7
|
+
protocols:
|
|
8
|
+
- https
|
|
9
|
+
baseUri: /services/data/v66.0
|
|
10
|
+
securitySchemes:
|
|
11
|
+
OAuth2:
|
|
12
|
+
type: OAuth 2.0
|
|
13
|
+
settings:
|
|
14
|
+
authorizationUri: https://example.com/oauth/authorize
|
|
15
|
+
accessTokenUri: ''
|
|
16
|
+
authorizationGrants:
|
|
17
|
+
- implicit
|
|
18
|
+
annotationTypes:
|
|
19
|
+
oas-readOnly:
|
|
20
|
+
type: boolean
|
|
21
|
+
allowedTargets: TypeDeclaration
|
|
22
|
+
oas-collectionFormat:
|
|
23
|
+
type: string
|
|
24
|
+
oas-body-name:
|
|
25
|
+
type: string
|
|
26
|
+
allowedTargets: TypeDeclaration
|
|
27
|
+
types:
|
|
28
|
+
AbstractAchievementMapping:
|
|
29
|
+
description: An abstract mapping to a given achievement, containing the shared
|
|
30
|
+
attributes across mapping types
|
|
31
|
+
discriminator: type
|
|
32
|
+
type: object
|
|
33
|
+
properties:
|
|
34
|
+
type:
|
|
35
|
+
description: Achievement mapping type
|
|
36
|
+
type: string
|
|
37
|
+
enum:
|
|
38
|
+
- ConcreteAchievement
|
|
39
|
+
- SharedAchievement
|
|
40
|
+
- SkillAchievement
|
|
41
|
+
AcademicCredential:
|
|
42
|
+
description: List of the user's academic credentials.
|
|
43
|
+
type: object
|
|
44
|
+
properties:
|
|
45
|
+
credentialName:
|
|
46
|
+
description: Name of the credential acquired by the user.
|
|
47
|
+
type: string
|
|
48
|
+
required: false
|
|
49
|
+
credentialType:
|
|
50
|
+
description: Type of credential acquired by the user.
|
|
51
|
+
type: string
|
|
52
|
+
required: false
|
|
53
|
+
yearAchieved:
|
|
54
|
+
description: Academic year in which the user completed the degree.
|
|
55
|
+
type: string
|
|
56
|
+
required: false
|
|
57
|
+
AcademicTerm:
|
|
58
|
+
description: Representation of the academic term.
|
|
59
|
+
type: object
|
|
60
|
+
properties:
|
|
61
|
+
id:
|
|
62
|
+
description: The ID of the academic term.
|
|
63
|
+
type: string
|
|
64
|
+
required: false
|
|
65
|
+
name:
|
|
66
|
+
description: The name of the academic term.
|
|
67
|
+
type: string
|
|
68
|
+
required: false
|
|
69
|
+
startDate:
|
|
70
|
+
description: The start date of the academic term.
|
|
71
|
+
type: string
|
|
72
|
+
required: false
|
|
73
|
+
AcademicTermsOutputRepresentation:
|
|
74
|
+
description: Representation of the output for the academic term request.
|
|
75
|
+
type: object
|
|
76
|
+
properties:
|
|
77
|
+
academicTerms:
|
|
78
|
+
description: List of academic terms.
|
|
79
|
+
type: array
|
|
80
|
+
required: false
|
|
81
|
+
items:
|
|
82
|
+
type: AcademicTerm
|
|
83
|
+
AchievementContributor:
|
|
84
|
+
description: Contributor for a shared achievement mapping.
|
|
85
|
+
type: object
|
|
86
|
+
properties:
|
|
87
|
+
id:
|
|
88
|
+
description: The id which contributes to this shared achievement
|
|
89
|
+
type: string
|
|
90
|
+
minimumGrade:
|
|
91
|
+
description: The minimum grade required for given achievement
|
|
92
|
+
format: double
|
|
93
|
+
type: number
|
|
94
|
+
required: false
|
|
95
|
+
type:
|
|
96
|
+
description: The type of contributor for given shared achievement
|
|
97
|
+
type: string
|
|
98
|
+
enum:
|
|
99
|
+
- Learning
|
|
100
|
+
ActionPlan:
|
|
101
|
+
description: Representation of the Action Plan.
|
|
102
|
+
type: object
|
|
103
|
+
properties:
|
|
104
|
+
allowOverride:
|
|
105
|
+
description: Action plan should allow override or not
|
|
106
|
+
type: boolean
|
|
107
|
+
required: false
|
|
108
|
+
endDate:
|
|
109
|
+
description: Action plan end date
|
|
110
|
+
type: string
|
|
111
|
+
required: false
|
|
112
|
+
id:
|
|
113
|
+
description: ID of the action plan
|
|
114
|
+
type: string
|
|
115
|
+
required: false
|
|
116
|
+
name:
|
|
117
|
+
description: Action plan name
|
|
118
|
+
type: string
|
|
119
|
+
required: false
|
|
120
|
+
numberOfTasks:
|
|
121
|
+
description: No of tasks in the action plan
|
|
122
|
+
type: integer
|
|
123
|
+
required: false
|
|
124
|
+
numberOfOverdueTasks:
|
|
125
|
+
description: No of overdue tasks in the action plan
|
|
126
|
+
type: integer
|
|
127
|
+
required: false
|
|
128
|
+
startDate:
|
|
129
|
+
description: Action plan start date
|
|
130
|
+
type: string
|
|
131
|
+
required: false
|
|
132
|
+
status:
|
|
133
|
+
description: Action plan status
|
|
134
|
+
type: string
|
|
135
|
+
required: false
|
|
136
|
+
ActionPlanTemplate:
|
|
137
|
+
description: Representation of the Action Plan Template.
|
|
138
|
+
type: object
|
|
139
|
+
properties:
|
|
140
|
+
aptType:
|
|
141
|
+
description: Type of the action plan template
|
|
142
|
+
type: string
|
|
143
|
+
required: false
|
|
144
|
+
aptVersionId:
|
|
145
|
+
description: ID of the action plan template version
|
|
146
|
+
type: string
|
|
147
|
+
required: false
|
|
148
|
+
assocCaseRecordTypeName:
|
|
149
|
+
description: Name of the case record type to which action plan template is
|
|
150
|
+
associated
|
|
151
|
+
type: string
|
|
152
|
+
required: false
|
|
153
|
+
assocProgramName:
|
|
154
|
+
description: Name of the program to which action plan template is associated
|
|
155
|
+
type: string
|
|
156
|
+
required: false
|
|
157
|
+
description:
|
|
158
|
+
description: Action plan template description
|
|
159
|
+
type: string
|
|
160
|
+
required: false
|
|
161
|
+
id:
|
|
162
|
+
description: ID of the action plan template
|
|
163
|
+
type: string
|
|
164
|
+
required: false
|
|
165
|
+
name:
|
|
166
|
+
description: Action plan template name
|
|
167
|
+
type: string
|
|
168
|
+
required: false
|
|
169
|
+
targetId:
|
|
170
|
+
description: ID of the record to which action plan is to be linked
|
|
171
|
+
type: string
|
|
172
|
+
required: false
|
|
173
|
+
templateItems:
|
|
174
|
+
description: List of items in the action plan templates i.e tasks
|
|
175
|
+
type: array
|
|
176
|
+
required: false
|
|
177
|
+
items:
|
|
178
|
+
type: ActionPlanTemplateItem
|
|
179
|
+
ActionPlanTemplateItem:
|
|
180
|
+
description: Representation of the Action Plan Template Item.
|
|
181
|
+
type: object
|
|
182
|
+
properties:
|
|
183
|
+
daysToComplete:
|
|
184
|
+
description: No of days to complete the item
|
|
185
|
+
type: integer
|
|
186
|
+
required: false
|
|
187
|
+
displayOrder:
|
|
188
|
+
description: Action plan template item display order
|
|
189
|
+
type: string
|
|
190
|
+
required: false
|
|
191
|
+
id:
|
|
192
|
+
description: ID of the Action plan template item
|
|
193
|
+
type: string
|
|
194
|
+
required: false
|
|
195
|
+
isRequired:
|
|
196
|
+
description: Action plan template item required or not
|
|
197
|
+
type: string
|
|
198
|
+
required: false
|
|
199
|
+
itemObjectType:
|
|
200
|
+
description: Action plan template item object type
|
|
201
|
+
type: string
|
|
202
|
+
required: false
|
|
203
|
+
prerequisites:
|
|
204
|
+
description: Action plan template item prerequisites
|
|
205
|
+
type: array
|
|
206
|
+
required: false
|
|
207
|
+
items:
|
|
208
|
+
type: any #Hand-rolled due to @W-10034467 type: ActionPlanTemplateItem
|
|
209
|
+
priority:
|
|
210
|
+
description: Action plan template item priority
|
|
211
|
+
type: string
|
|
212
|
+
required: false
|
|
213
|
+
subject:
|
|
214
|
+
description: Action plan template item subject
|
|
215
|
+
type: string
|
|
216
|
+
required: false
|
|
217
|
+
AdditionalEducation:
|
|
218
|
+
description: List of the user education qualifications, shown in their additional
|
|
219
|
+
education history.
|
|
220
|
+
type: object
|
|
221
|
+
properties:
|
|
222
|
+
educationLevel:
|
|
223
|
+
description: Education level in the user's field of study.
|
|
224
|
+
type: string
|
|
225
|
+
required: false
|
|
226
|
+
endYear:
|
|
227
|
+
description: End year of the user's education record.
|
|
228
|
+
type: string
|
|
229
|
+
required: false
|
|
230
|
+
name:
|
|
231
|
+
description: Name of the education record.
|
|
232
|
+
type: string
|
|
233
|
+
required: false
|
|
234
|
+
institution:
|
|
235
|
+
description: Institution that offers the degree.
|
|
236
|
+
type: string
|
|
237
|
+
required: false
|
|
238
|
+
AdditionalFields:
|
|
239
|
+
description: Input representation for Map of additionalFields
|
|
240
|
+
type: object
|
|
241
|
+
properties:
|
|
242
|
+
customFields:
|
|
243
|
+
description: Set Additional Fields.
|
|
244
|
+
type: object
|
|
245
|
+
required: false
|
|
246
|
+
properties:
|
|
247
|
+
//:
|
|
248
|
+
type: object
|
|
249
|
+
Applicant:
|
|
250
|
+
description: Representation of the related applicants result.
|
|
251
|
+
type: object
|
|
252
|
+
properties:
|
|
253
|
+
contactId:
|
|
254
|
+
description: The ID of the Contact record for an available applicant.
|
|
255
|
+
type: string
|
|
256
|
+
required: false
|
|
257
|
+
email:
|
|
258
|
+
description: The email address from the applicant's contact record.
|
|
259
|
+
type: string
|
|
260
|
+
required: false
|
|
261
|
+
name:
|
|
262
|
+
description: The name of the applicant from their contact record.
|
|
263
|
+
type: string
|
|
264
|
+
required: false
|
|
265
|
+
Application:
|
|
266
|
+
description: Representation of the application.
|
|
267
|
+
type: object
|
|
268
|
+
properties:
|
|
269
|
+
academicLevel:
|
|
270
|
+
description: The academic level associated with an application.
|
|
271
|
+
type: string
|
|
272
|
+
required: false
|
|
273
|
+
applicant:
|
|
274
|
+
description: Data for the applicant associated with an application.
|
|
275
|
+
type: Applicant
|
|
276
|
+
required: false
|
|
277
|
+
applicationCategory:
|
|
278
|
+
description: The application category associated with an application.
|
|
279
|
+
type: string
|
|
280
|
+
required: false
|
|
281
|
+
applicationCloseDate:
|
|
282
|
+
description: The date the application closes.
|
|
283
|
+
type: string
|
|
284
|
+
required: false
|
|
285
|
+
appliedDate:
|
|
286
|
+
description: The date when an applicant submitted an application.
|
|
287
|
+
type: string
|
|
288
|
+
required: false
|
|
289
|
+
id:
|
|
290
|
+
description: The ID of the application.
|
|
291
|
+
type: string
|
|
292
|
+
required: false
|
|
293
|
+
programName:
|
|
294
|
+
description: The name of the program associated with an application.
|
|
295
|
+
type: string
|
|
296
|
+
required: false
|
|
297
|
+
requiredItemsCompleted:
|
|
298
|
+
description: The number of completed required individual application tasks
|
|
299
|
+
associated with an application.
|
|
300
|
+
type: integer
|
|
301
|
+
required: false
|
|
302
|
+
status:
|
|
303
|
+
description: The status of an application.
|
|
304
|
+
type: string
|
|
305
|
+
required: false
|
|
306
|
+
statusLabel:
|
|
307
|
+
description: The status label of an application.
|
|
308
|
+
type: string
|
|
309
|
+
required: false
|
|
310
|
+
submitter:
|
|
311
|
+
description: Data for the submitter of an application.
|
|
312
|
+
type: Submitter
|
|
313
|
+
required: false
|
|
314
|
+
termName:
|
|
315
|
+
description: The name of the academic term associated with an application.
|
|
316
|
+
type: string
|
|
317
|
+
required: false
|
|
318
|
+
totalRequiredItems:
|
|
319
|
+
description: The number of required individual application tasks associated
|
|
320
|
+
with an application.
|
|
321
|
+
type: integer
|
|
322
|
+
required: false
|
|
323
|
+
ApplicationAcademicLevel:
|
|
324
|
+
description: Representation of the academic levels result.
|
|
325
|
+
type: object
|
|
326
|
+
properties:
|
|
327
|
+
apiName:
|
|
328
|
+
description: The API name of the picklist option for the academic level.
|
|
329
|
+
type: string
|
|
330
|
+
required: false
|
|
331
|
+
label:
|
|
332
|
+
description: The label of the picklist option for the academic level.
|
|
333
|
+
type: string
|
|
334
|
+
required: false
|
|
335
|
+
ApplicationDetailsOutputRepresentation:
|
|
336
|
+
description: Output of the get application details data request.
|
|
337
|
+
type: object
|
|
338
|
+
properties:
|
|
339
|
+
result:
|
|
340
|
+
description: Representation of the get application details request.
|
|
341
|
+
type: GetApplicationDetailsResult
|
|
342
|
+
required: false
|
|
343
|
+
ApplicationsOutputRepresentation:
|
|
344
|
+
description: Output of the get application list data request.
|
|
345
|
+
type: object
|
|
346
|
+
properties:
|
|
347
|
+
result:
|
|
348
|
+
description: Application data
|
|
349
|
+
type: GetApplicationsResult
|
|
350
|
+
required: false
|
|
351
|
+
ApplicationRenderMethod:
|
|
352
|
+
description: Representation of the related application render method.
|
|
353
|
+
type: object
|
|
354
|
+
properties:
|
|
355
|
+
id:
|
|
356
|
+
description: The ID of the application render method.
|
|
357
|
+
type: string
|
|
358
|
+
required: false
|
|
359
|
+
methodName:
|
|
360
|
+
description: The Method Name of the Application Render Method associated with
|
|
361
|
+
the Individual Application Task.
|
|
362
|
+
type: string
|
|
363
|
+
required: false
|
|
364
|
+
methodRecordId:
|
|
365
|
+
description: The Method Record ID of the Application Render Method associated
|
|
366
|
+
with the Individual Application Task.
|
|
367
|
+
type: string
|
|
368
|
+
required: false
|
|
369
|
+
methodType:
|
|
370
|
+
description: The type of the Application Render Method associated with the
|
|
371
|
+
Individual Application Task.
|
|
372
|
+
type: string
|
|
373
|
+
required: false
|
|
374
|
+
AptsTasksPlansOutputRepresentation:
|
|
375
|
+
description: Output representation of the AptsTasksPlans.
|
|
376
|
+
type: object
|
|
377
|
+
properties:
|
|
378
|
+
actionPlanTemplates:
|
|
379
|
+
description: List of action plan templates
|
|
380
|
+
type: array
|
|
381
|
+
items:
|
|
382
|
+
type: ActionPlanTemplate
|
|
383
|
+
actionPlans:
|
|
384
|
+
description: List of action plans
|
|
385
|
+
type: array
|
|
386
|
+
items:
|
|
387
|
+
type: ActionPlan
|
|
388
|
+
carePlans:
|
|
389
|
+
description: List of care plans
|
|
390
|
+
type: array
|
|
391
|
+
items:
|
|
392
|
+
type: CarePlan
|
|
393
|
+
contactId:
|
|
394
|
+
description: The contact Id of the student
|
|
395
|
+
type: string
|
|
396
|
+
required: true
|
|
397
|
+
tasks:
|
|
398
|
+
description: List of tasks
|
|
399
|
+
type: array
|
|
400
|
+
items:
|
|
401
|
+
type: Task
|
|
402
|
+
AvailableStaff:
|
|
403
|
+
description: Representation of the available staff result.
|
|
404
|
+
type: object
|
|
405
|
+
properties:
|
|
406
|
+
caseId:
|
|
407
|
+
description: The ID of the case that’s available to the staff member.
|
|
408
|
+
type: string
|
|
409
|
+
required: false
|
|
410
|
+
caseRecordTypeName:
|
|
411
|
+
description: The record type name of the case that's available to the staff
|
|
412
|
+
member.
|
|
413
|
+
type: string
|
|
414
|
+
required: false
|
|
415
|
+
caseTeamMemberId:
|
|
416
|
+
description: The identifier for the staff member assigned to the case.
|
|
417
|
+
type: string
|
|
418
|
+
required: false
|
|
419
|
+
caseTeamRole:
|
|
420
|
+
description: The staff member's case team role.
|
|
421
|
+
type: string
|
|
422
|
+
required: false
|
|
423
|
+
email:
|
|
424
|
+
description: The staff member's email.
|
|
425
|
+
type: string
|
|
426
|
+
required: false
|
|
427
|
+
lastServiceAppointment:
|
|
428
|
+
description: The last appointment completed by the staff member for the associated
|
|
429
|
+
account.
|
|
430
|
+
type: ServiceAppointment
|
|
431
|
+
required: false
|
|
432
|
+
locations:
|
|
433
|
+
description: The service locations in the staff member’s service territories
|
|
434
|
+
that are available for scheduling.
|
|
435
|
+
type: object
|
|
436
|
+
required: false
|
|
437
|
+
properties:
|
|
438
|
+
//:
|
|
439
|
+
type: any
|
|
440
|
+
name:
|
|
441
|
+
description: The name of the staff member.
|
|
442
|
+
type: string
|
|
443
|
+
required: false
|
|
444
|
+
phone:
|
|
445
|
+
description: The staff member's phone number.
|
|
446
|
+
type: string
|
|
447
|
+
required: false
|
|
448
|
+
profilePhotoUrl:
|
|
449
|
+
description: The URL for the staff member's photo.
|
|
450
|
+
type: string
|
|
451
|
+
required: false
|
|
452
|
+
serviceResourceId:
|
|
453
|
+
description: The service resource ID for the staff.
|
|
454
|
+
type: string
|
|
455
|
+
required: false
|
|
456
|
+
AvailableTeam:
|
|
457
|
+
description: Representation of the available team result.
|
|
458
|
+
type: object
|
|
459
|
+
properties:
|
|
460
|
+
canSelfSchedule:
|
|
461
|
+
description: Indicates that a team is available for scheduling by the associated
|
|
462
|
+
account through Experience Cloud.
|
|
463
|
+
type: boolean
|
|
464
|
+
required: false
|
|
465
|
+
caseId:
|
|
466
|
+
description: The ID of the case that's related to the support of the associated
|
|
467
|
+
account.
|
|
468
|
+
type: string
|
|
469
|
+
required: false
|
|
470
|
+
caseRecordTypeName:
|
|
471
|
+
description: The record type name of the open case that's associated with
|
|
472
|
+
the account.
|
|
473
|
+
type: string
|
|
474
|
+
required: false
|
|
475
|
+
caseTeamTemplateRecordId:
|
|
476
|
+
description: The identifier for the case team template record associated with the case and case team template.
|
|
477
|
+
type: string
|
|
478
|
+
required: false
|
|
479
|
+
members:
|
|
480
|
+
description: List of staff members on the available team.
|
|
481
|
+
type: object
|
|
482
|
+
required: false
|
|
483
|
+
properties:
|
|
484
|
+
//:
|
|
485
|
+
type: any
|
|
486
|
+
name:
|
|
487
|
+
description: The name of the team that's available to support the associated
|
|
488
|
+
account.
|
|
489
|
+
type: string
|
|
490
|
+
required: false
|
|
491
|
+
resourceAssignmentType:
|
|
492
|
+
description: The resource assignment type for this team.
|
|
493
|
+
type: string
|
|
494
|
+
required: false
|
|
495
|
+
teamId:
|
|
496
|
+
description: The ID of the team that's available to support the associated
|
|
497
|
+
account.
|
|
498
|
+
type: string
|
|
499
|
+
required: false
|
|
500
|
+
AvailableTimeSlotsInputRepresentation:
|
|
501
|
+
description: Contains the information to search for available appointment time
|
|
502
|
+
slots.
|
|
503
|
+
type: object
|
|
504
|
+
properties:
|
|
505
|
+
automaticResourceAssignment:
|
|
506
|
+
description: Whether the service resource assignment type is automatic
|
|
507
|
+
type: boolean
|
|
508
|
+
required: false
|
|
509
|
+
endTime:
|
|
510
|
+
description: Latest time that an appointment can end.
|
|
511
|
+
type: string
|
|
512
|
+
required: false
|
|
513
|
+
engagementChannelTypeIds:
|
|
514
|
+
description: The IDs of the engagement channel type records. Time slot availability
|
|
515
|
+
is based on the selected engagement channel types.
|
|
516
|
+
type: array
|
|
517
|
+
items:
|
|
518
|
+
type: string
|
|
519
|
+
serviceResourceIds:
|
|
520
|
+
description: List of service resource IDs to filter the API response.
|
|
521
|
+
type: array
|
|
522
|
+
items:
|
|
523
|
+
type: string
|
|
524
|
+
serviceTerritoryIds:
|
|
525
|
+
description: List of IDs for the service territories where the work will be
|
|
526
|
+
performed.
|
|
527
|
+
type: array
|
|
528
|
+
items:
|
|
529
|
+
type: string
|
|
530
|
+
startTime:
|
|
531
|
+
description: Earliest time that an appointment can begin. If empty, the default
|
|
532
|
+
is the time of the request.
|
|
533
|
+
type: string
|
|
534
|
+
required: false
|
|
535
|
+
workTypeGroupId:
|
|
536
|
+
description: ID of the work type group containing the work types that are
|
|
537
|
+
being performed.
|
|
538
|
+
type: string
|
|
539
|
+
AvailableTimeSlotsInputRepresentationData: #TODO: hand-rolled
|
|
540
|
+
description: A wrapper around AvailableTimeSlotsInputRepresentation
|
|
541
|
+
type: object
|
|
542
|
+
properties:
|
|
543
|
+
availableTimeSlotsInput:
|
|
544
|
+
description: The Oas Body name for get available time slots
|
|
545
|
+
type: AvailableTimeSlotsInputRepresentation
|
|
546
|
+
AvailableTimeSlotsOuputRepresentation:
|
|
547
|
+
description: Output of the post available time slots request.
|
|
548
|
+
type: object
|
|
549
|
+
properties:
|
|
550
|
+
timeSlots:
|
|
551
|
+
description: List of time slots that are available for scheduling.
|
|
552
|
+
type: array
|
|
553
|
+
items:
|
|
554
|
+
type: TimeSlot
|
|
555
|
+
AvailableTopic:
|
|
556
|
+
description: Representation of the available topic.
|
|
557
|
+
type: object
|
|
558
|
+
properties:
|
|
559
|
+
parentWorkTypeGroupName:
|
|
560
|
+
description: The name of the parent work type group of the topic that represents
|
|
561
|
+
the available topic.
|
|
562
|
+
type: string
|
|
563
|
+
required: false
|
|
564
|
+
serviceTerritoryWorkTypes:
|
|
565
|
+
description: Details about the topic that's available for scheduling for the
|
|
566
|
+
related service territories.
|
|
567
|
+
type: object
|
|
568
|
+
required: false
|
|
569
|
+
properties:
|
|
570
|
+
//:
|
|
571
|
+
type: any
|
|
572
|
+
workTypeGroupId:
|
|
573
|
+
description: The ID of the work type group that represents the available topic.
|
|
574
|
+
type: string
|
|
575
|
+
required: false
|
|
576
|
+
workTypeGroupName:
|
|
577
|
+
description: The name of the work type group that represents the available
|
|
578
|
+
topic.
|
|
579
|
+
type: string
|
|
580
|
+
required: false
|
|
581
|
+
AvailableTopicsOutputRepresentation:
|
|
582
|
+
description: Output representation of the get available topics request.
|
|
583
|
+
type: object
|
|
584
|
+
properties:
|
|
585
|
+
topics:
|
|
586
|
+
description: List of topics that are available for scheduling.
|
|
587
|
+
type: array
|
|
588
|
+
items:
|
|
589
|
+
type: AvailableTopic
|
|
590
|
+
CarePlan:
|
|
591
|
+
description: Representation of the Care Plan.
|
|
592
|
+
type: object
|
|
593
|
+
properties:
|
|
594
|
+
description:
|
|
595
|
+
description: Care plan description
|
|
596
|
+
type: string
|
|
597
|
+
required: false
|
|
598
|
+
endDate:
|
|
599
|
+
description: Care plan end date
|
|
600
|
+
type: string
|
|
601
|
+
required: false
|
|
602
|
+
id:
|
|
603
|
+
description: ID of the care plan
|
|
604
|
+
type: string
|
|
605
|
+
required: false
|
|
606
|
+
name:
|
|
607
|
+
description: Care plan name
|
|
608
|
+
type: string
|
|
609
|
+
required: false
|
|
610
|
+
numberOfTasks:
|
|
611
|
+
description: No of tasks in the care plan
|
|
612
|
+
type: integer
|
|
613
|
+
required: false
|
|
614
|
+
overdueTasks:
|
|
615
|
+
description: No of overdue tasks in the care plan
|
|
616
|
+
type: integer
|
|
617
|
+
required: false
|
|
618
|
+
startDate:
|
|
619
|
+
description: Care plan start date
|
|
620
|
+
type: string
|
|
621
|
+
required: false
|
|
622
|
+
status:
|
|
623
|
+
description: Care plan status
|
|
624
|
+
type: string
|
|
625
|
+
required: false
|
|
626
|
+
CarePlanBulkInputWrapperRepresentation:
|
|
627
|
+
#TODO Hand rolled due to W-8334626
|
|
628
|
+
description: Wrapper for careplan record input representation
|
|
629
|
+
type: object
|
|
630
|
+
properties:
|
|
631
|
+
carePlanBulkRecord:
|
|
632
|
+
type: CarePlanBulkInputRepresentation
|
|
633
|
+
description: Careplan bulk input representation
|
|
634
|
+
CarePlanBulkInputRepresentation:
|
|
635
|
+
description: Input representation for Care Plan Bulk
|
|
636
|
+
type: object
|
|
637
|
+
properties:
|
|
638
|
+
carePlans:
|
|
639
|
+
description: List of Care Plans for bulk
|
|
640
|
+
type: CarePlanListInputRepresentation
|
|
641
|
+
CarePlanBulkOutputRepresentation:
|
|
642
|
+
description: Bulk Output Representation
|
|
643
|
+
type: object
|
|
644
|
+
properties:
|
|
645
|
+
errorMessage:
|
|
646
|
+
description: API message
|
|
647
|
+
type: string
|
|
648
|
+
required: false
|
|
649
|
+
numberOfCarePlans:
|
|
650
|
+
description: Number of careplans submitted
|
|
651
|
+
type: integer
|
|
652
|
+
required: false
|
|
653
|
+
statusCode:
|
|
654
|
+
description: API code
|
|
655
|
+
type: string
|
|
656
|
+
CarePlanListInputRepresentation:
|
|
657
|
+
description: Input representation for List of Care Plans
|
|
658
|
+
type: object
|
|
659
|
+
properties:
|
|
660
|
+
records:
|
|
661
|
+
description: List of Care Plans
|
|
662
|
+
type: array
|
|
663
|
+
items:
|
|
664
|
+
type: CarePlanInputRepresentation
|
|
665
|
+
CarePlanInputRepresentation:
|
|
666
|
+
description: Input representation for Care Plan
|
|
667
|
+
type: object
|
|
668
|
+
properties:
|
|
669
|
+
benefitAssignments:
|
|
670
|
+
description: BenefitAssignments of the CarePlan
|
|
671
|
+
# TODO Hand-Rolled due to issue #16 in in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
|
|
672
|
+
type: BenefitAssignmentListInputRepresentation
|
|
673
|
+
required: false # TODO Hand-rolled W-9314597
|
|
674
|
+
carePlanTasks:
|
|
675
|
+
description: Tasks for a Care Plan
|
|
676
|
+
type: CarePlanTaskInputRepresentation
|
|
677
|
+
required: false # TODO Hand-rolled W-9314597
|
|
678
|
+
carePlanTemplateId:
|
|
679
|
+
description: CarePlanTemplateId of the CarePlan
|
|
680
|
+
type: string
|
|
681
|
+
required: false # TODO Hand-rolled W-9314597
|
|
682
|
+
caseId:
|
|
683
|
+
description: CaseId of the CarePlan
|
|
684
|
+
type: string
|
|
685
|
+
customFields:
|
|
686
|
+
description: CustomFields of the CarePlan
|
|
687
|
+
type: CustomFieldListInputRepresentation
|
|
688
|
+
required: false # TODO Hand-rolled W-9314597
|
|
689
|
+
description:
|
|
690
|
+
description: Description of the CarePlan
|
|
691
|
+
type: string
|
|
692
|
+
required: false # TODO Hand-rolled W-9314597
|
|
693
|
+
endDate:
|
|
694
|
+
description: EndDate of the CarePlan
|
|
695
|
+
type: string
|
|
696
|
+
required: false # TODO Hand-rolled W-9314597
|
|
697
|
+
goalAssignments:
|
|
698
|
+
description: GoalAssignments of the CarePlan
|
|
699
|
+
# TODO Hand-Rolled due to issue #16 in in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
|
|
700
|
+
type: GoalAssignmentListInputRepresentation
|
|
701
|
+
required: false # TODO Hand-rolled W-9314597
|
|
702
|
+
id:
|
|
703
|
+
description: Id of the CarePlan
|
|
704
|
+
type: string
|
|
705
|
+
required: false # TODO Hand-rolled W-9314597
|
|
706
|
+
medicationTherapyReview:
|
|
707
|
+
description: MedicationTherapyReview of the CarePlan
|
|
708
|
+
type: string
|
|
709
|
+
required: false # TODO Hand-rolled W-9314597
|
|
710
|
+
name:
|
|
711
|
+
description: Name of the CarePlan
|
|
712
|
+
type: string
|
|
713
|
+
participantId:
|
|
714
|
+
description: Participant of the CarePlan
|
|
715
|
+
type: string
|
|
716
|
+
startDate:
|
|
717
|
+
description: StartDate of the CarePlan
|
|
718
|
+
type: string
|
|
719
|
+
required: false # TODO Hand-rolled W-9314597
|
|
720
|
+
status:
|
|
721
|
+
description: Status of the CarePlan
|
|
722
|
+
type: string
|
|
723
|
+
ContactInformation:
|
|
724
|
+
description: Contact information of the user, for example their email, phone,
|
|
725
|
+
or website URL.
|
|
726
|
+
type: object
|
|
727
|
+
properties:
|
|
728
|
+
email:
|
|
729
|
+
description: Email address of the user.
|
|
730
|
+
type: string
|
|
731
|
+
required: false
|
|
732
|
+
phone:
|
|
733
|
+
description: Phone number of the user.
|
|
734
|
+
type: string
|
|
735
|
+
required: false
|
|
736
|
+
website:
|
|
737
|
+
description: Website of the user.
|
|
738
|
+
type: string
|
|
739
|
+
required: false
|
|
740
|
+
GoalAssignmentInputRepresentation:
|
|
741
|
+
description: Input representation for GoalAssignment
|
|
742
|
+
type: object
|
|
743
|
+
properties:
|
|
744
|
+
completionDate:
|
|
745
|
+
description: CompletionDate of the GoalAssignment
|
|
746
|
+
type: string
|
|
747
|
+
required: false # TODO Hand-rolled W-9314597
|
|
748
|
+
completionPercentage:
|
|
749
|
+
description: CompletionPercentage of the GoalAssignment
|
|
750
|
+
format: double
|
|
751
|
+
type: number
|
|
752
|
+
required: false # TODO Hand-rolled W-9314597
|
|
753
|
+
customFields:
|
|
754
|
+
description: CustomFields of the GoalAssignment
|
|
755
|
+
type: CustomFieldListInputRepresentation
|
|
756
|
+
required: false # TODO Hand-rolled W-9314597
|
|
757
|
+
description:
|
|
758
|
+
description: Description of the Goal Assignment
|
|
759
|
+
type: string
|
|
760
|
+
required: false # TODO Hand-rolled W-9314597
|
|
761
|
+
goalAssigneeId:
|
|
762
|
+
description: GoalAssigneeId of the GoalAssignment
|
|
763
|
+
type: string
|
|
764
|
+
required: false # TODO Hand-rolled W-9314597
|
|
765
|
+
goalAssignmentTasks:
|
|
766
|
+
description: Tasks for Goal Assignment
|
|
767
|
+
type: CarePlanTaskInputRepresentation
|
|
768
|
+
required: false # TODO Hand-rolled W-9314597
|
|
769
|
+
goalDefinitionId:
|
|
770
|
+
description: GoalDefinitionId of the GoalAssignment
|
|
771
|
+
type: string
|
|
772
|
+
id:
|
|
773
|
+
description: Id of the GoalAssignment
|
|
774
|
+
type: string
|
|
775
|
+
required: false # TODO Hand-rolled W-9314597
|
|
776
|
+
priority:
|
|
777
|
+
description: Priority of the GoalAssignment
|
|
778
|
+
type: string
|
|
779
|
+
required: false # TODO Hand-rolled W-9314597
|
|
780
|
+
startDate:
|
|
781
|
+
description: StartDate of the GoalAssignment
|
|
782
|
+
type: string
|
|
783
|
+
required: false # TODO Hand-rolled W-9314597
|
|
784
|
+
status:
|
|
785
|
+
description: Status of the GoalAssignment
|
|
786
|
+
type: string
|
|
787
|
+
required: false # TODO Hand-rolled W-9314597
|
|
788
|
+
targetCompletionDate:
|
|
789
|
+
description: TargetCompletionDate of the GoalAssignment
|
|
790
|
+
type: string
|
|
791
|
+
required: false # TODO Hand-rolled W-9314597
|
|
792
|
+
associatedBenefitAssignments:
|
|
793
|
+
description: Associated SubBenefit Assignments
|
|
794
|
+
type: BenefitAssignmentListInputRepresentation
|
|
795
|
+
required: false
|
|
796
|
+
associatedSubGoalAssignments:
|
|
797
|
+
description: Associated Sub Goal Assignments
|
|
798
|
+
type: GoalAssignmentListInputRepresentation
|
|
799
|
+
required: false
|
|
800
|
+
GoalAssignmentListInputRepresentation:
|
|
801
|
+
description: Input representation for List of GoalAssignment
|
|
802
|
+
type: object
|
|
803
|
+
properties:
|
|
804
|
+
records:
|
|
805
|
+
description: List of GoalAssignments
|
|
806
|
+
type: array
|
|
807
|
+
items:
|
|
808
|
+
# TODO Hand-Rolled due to issue #16 in in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
|
|
809
|
+
type: GoalAssignmentInputRepresentation
|
|
810
|
+
CarePlanTaskInputRepresentation:
|
|
811
|
+
description: Input representation for Care Plan Task
|
|
812
|
+
type: object
|
|
813
|
+
properties:
|
|
814
|
+
assignedTo:
|
|
815
|
+
description: Care Plan Task assignee
|
|
816
|
+
type: string
|
|
817
|
+
required: false # TODO Hand-rolled W-9314597
|
|
818
|
+
comment:
|
|
819
|
+
description: Care Plan Task comment
|
|
820
|
+
type: string
|
|
821
|
+
required: false # TODO Hand-rolled W-9314597
|
|
822
|
+
dueDate:
|
|
823
|
+
description: Care Plan Task due date
|
|
824
|
+
type: string
|
|
825
|
+
required: false # TODO Hand-rolled W-9314597
|
|
826
|
+
id:
|
|
827
|
+
description: Id of the Task
|
|
828
|
+
type: string
|
|
829
|
+
required: false # TODO Hand-rolled W-9314597
|
|
830
|
+
priority:
|
|
831
|
+
description: Care Plan Task priority
|
|
832
|
+
type: string
|
|
833
|
+
required: false # TODO Hand-rolled W-9314597
|
|
834
|
+
status:
|
|
835
|
+
description: Care Plan Task Status
|
|
836
|
+
type: string
|
|
837
|
+
required: false # TODO Hand-rolled W-9314597
|
|
838
|
+
subject:
|
|
839
|
+
description: Care Plan Task subject
|
|
840
|
+
type: string
|
|
841
|
+
required: false # TODO Hand-rolled W-9314597
|
|
842
|
+
isRequired:
|
|
843
|
+
description: isRequired field for Task record
|
|
844
|
+
type: boolean
|
|
845
|
+
required: false
|
|
846
|
+
BenefitAssignmentInputRepresentation:
|
|
847
|
+
description: Input representation for BenefitAssignment
|
|
848
|
+
type: object
|
|
849
|
+
properties:
|
|
850
|
+
benefitAssignmentTasks:
|
|
851
|
+
description: Tasks for Benefit Assignment
|
|
852
|
+
type: CarePlanTaskInputRepresentation
|
|
853
|
+
required: false # TODO Hand-rolled W-9314597
|
|
854
|
+
benefitDisbursements:
|
|
855
|
+
description: Benefit disbursements of the Benefit Assignment
|
|
856
|
+
type: BenefitDisbursementListInputRepresentation
|
|
857
|
+
required: false # TODO Hand-rolled W-9314597
|
|
858
|
+
benefitFrequency:
|
|
859
|
+
description: BenefitFrequency of the BenefitAssignment
|
|
860
|
+
type: string
|
|
861
|
+
required: false # TODO Hand-rolled W-9314597
|
|
862
|
+
benefitId:
|
|
863
|
+
description: Benefit Id of the Benefit
|
|
864
|
+
type: string
|
|
865
|
+
customFields:
|
|
866
|
+
description: CustomFields of the BenefitAssignment
|
|
867
|
+
type: CustomFieldListInputRepresentation
|
|
868
|
+
required: false # TODO Hand-rolled W-9314597
|
|
869
|
+
endDate:
|
|
870
|
+
description: EndDate of the BenefitAssignment
|
|
871
|
+
type: string
|
|
872
|
+
required: false # TODO Hand-rolled W-9314597
|
|
873
|
+
enrollmentCount:
|
|
874
|
+
description: EnrollmentCount of the BenefitAssignment
|
|
875
|
+
type: integer
|
|
876
|
+
required: false # TODO Hand-rolled W-9314597
|
|
877
|
+
entitlementAmount:
|
|
878
|
+
description: EntitlementAmount of the BenefitAssignment
|
|
879
|
+
format: double
|
|
880
|
+
type: number
|
|
881
|
+
required: false # TODO Hand-rolled W-9314597
|
|
882
|
+
id:
|
|
883
|
+
description: Id of the BenefitAssignment
|
|
884
|
+
type: string
|
|
885
|
+
required: false # TODO Hand-rolled W-9314597
|
|
886
|
+
maximumAmount:
|
|
887
|
+
description: MaximumAmount of the BenefitAssignment
|
|
888
|
+
format: double
|
|
889
|
+
type: number
|
|
890
|
+
required: false # TODO Hand-rolled W-9314597
|
|
891
|
+
participantId:
|
|
892
|
+
description: ParticipantId of the BenefitAssignment
|
|
893
|
+
type: string
|
|
894
|
+
payoutFrequency:
|
|
895
|
+
description: PayoutFrequency of the BenefitAssignment
|
|
896
|
+
type: string
|
|
897
|
+
required: false # TODO Hand-rolled W-9314597
|
|
898
|
+
priority:
|
|
899
|
+
description: Priority of the BenefitAssignment
|
|
900
|
+
type: string
|
|
901
|
+
required: false # TODO Hand-rolled W-9314597
|
|
902
|
+
startDate:
|
|
903
|
+
description: StartDate of BenefitAssignment
|
|
904
|
+
type: string
|
|
905
|
+
required: false # TODO Hand-rolled W-9314597
|
|
906
|
+
status:
|
|
907
|
+
description: Status of the BenefitAssignment
|
|
908
|
+
type: string
|
|
909
|
+
required: false # TODO Hand-rolled W-9314597
|
|
910
|
+
BenefitAssignmentListInputRepresentation:
|
|
911
|
+
description: Input representation for List of BenefitAssignments
|
|
912
|
+
type: object
|
|
913
|
+
properties:
|
|
914
|
+
records:
|
|
915
|
+
description: List of BenefitAssignments
|
|
916
|
+
type: array
|
|
917
|
+
items:
|
|
918
|
+
# TODO Hand-Rolled due to issue #16 in in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
|
|
919
|
+
type: BenefitAssignmentInputRepresentation
|
|
920
|
+
CustomFieldInputRepresentation:
|
|
921
|
+
description: Input representation for Custom Field
|
|
922
|
+
type: object
|
|
923
|
+
properties:
|
|
924
|
+
dataType:
|
|
925
|
+
description: Data Type of custom field
|
|
926
|
+
type: string
|
|
927
|
+
required: false # TODO Hand-rolled W-9314597
|
|
928
|
+
enum:
|
|
929
|
+
- Boolean
|
|
930
|
+
- DateOnly
|
|
931
|
+
- DateTime
|
|
932
|
+
- MultiEnum
|
|
933
|
+
- Number
|
|
934
|
+
- String
|
|
935
|
+
- TimeOnly
|
|
936
|
+
fieldName:
|
|
937
|
+
description: Field Name of custom field
|
|
938
|
+
type: string
|
|
939
|
+
fieldValue:
|
|
940
|
+
description: Field Value of custom field
|
|
941
|
+
type: any
|
|
942
|
+
CustomFieldListInputRepresentation:
|
|
943
|
+
description: Input representation for List of CustomFields
|
|
944
|
+
type: object
|
|
945
|
+
properties:
|
|
946
|
+
records:
|
|
947
|
+
description: List of CustomFields
|
|
948
|
+
type: array
|
|
949
|
+
items:
|
|
950
|
+
# TODO Hand-Rolled due to issue #16 in in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
|
|
951
|
+
type: CustomFieldInputRepresentation
|
|
952
|
+
BenefitDisbursementForBenefitSessionInputRepresentation:
|
|
953
|
+
description: Input representation for Benefit Disbursement
|
|
954
|
+
type: object
|
|
955
|
+
properties:
|
|
956
|
+
actualCompletionDate:
|
|
957
|
+
description: date at which disbursement happened
|
|
958
|
+
type: string
|
|
959
|
+
benefitCategory:
|
|
960
|
+
description: Category of Benefit
|
|
961
|
+
type: string
|
|
962
|
+
required: false # TODO Hand-rolled W-9314597
|
|
963
|
+
benefitSessionId:
|
|
964
|
+
description: Benefit Session Id
|
|
965
|
+
type: string
|
|
966
|
+
description:
|
|
967
|
+
description: Description for Benefit Disbursement
|
|
968
|
+
type: string
|
|
969
|
+
required: false # TODO Hand-rolled W-9314597
|
|
970
|
+
disbursementStatus:
|
|
971
|
+
description: Benefit Disbursement Status
|
|
972
|
+
type: string
|
|
973
|
+
required: false # TODO Hand-rolled W-9314597
|
|
974
|
+
endDate:
|
|
975
|
+
description: date at which disbursement Ends
|
|
976
|
+
type: string
|
|
977
|
+
required: false # TODO Hand-rolled W-9314597
|
|
978
|
+
startDate:
|
|
979
|
+
description: date at which disbursement Starts
|
|
980
|
+
type: string
|
|
981
|
+
required: false # TODO Hand-rolled W-9314597
|
|
982
|
+
BenefitDisbursementListInputRepresentation:
|
|
983
|
+
description: Input representation for List of BenefitDisbursements
|
|
984
|
+
type: object
|
|
985
|
+
properties:
|
|
986
|
+
records:
|
|
987
|
+
description: List of Benefit Disbursements
|
|
988
|
+
type: array
|
|
989
|
+
items:
|
|
990
|
+
# TODO Hand-Rolled due to issue #16 in in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
|
|
991
|
+
type: BenefitDisbursementForBenefitSessionInputRepresentation
|
|
992
|
+
CreateLearningsInputRepresentation:
|
|
993
|
+
description: Provides details of the request to create learnings.
|
|
994
|
+
type: object
|
|
995
|
+
properties:
|
|
996
|
+
learnings:
|
|
997
|
+
description: Provides details of the request to create learnings.
|
|
998
|
+
type: array
|
|
999
|
+
items:
|
|
1000
|
+
type: any
|
|
1001
|
+
CreateLearningsOutputRepresentation:
|
|
1002
|
+
description: Create learning output.
|
|
1003
|
+
type: object
|
|
1004
|
+
properties:
|
|
1005
|
+
details:
|
|
1006
|
+
description: Creates the details of the learning response.
|
|
1007
|
+
type: array
|
|
1008
|
+
items:
|
|
1009
|
+
type: CreateLearningOutputRepresentation
|
|
1010
|
+
required: false
|
|
1011
|
+
failureCount:
|
|
1012
|
+
description: Specifies the number of transactions that failed to be created.
|
|
1013
|
+
type: integer
|
|
1014
|
+
required: false
|
|
1015
|
+
successCount:
|
|
1016
|
+
description: Specifies the number of transactions that were created.
|
|
1017
|
+
type: integer
|
|
1018
|
+
required: false
|
|
1019
|
+
status:
|
|
1020
|
+
description: Specifies the status of whole bulk transaction.
|
|
1021
|
+
type: string
|
|
1022
|
+
CreateLearningInputRepresentation:
|
|
1023
|
+
description: Input wrapper containing the Learning alongside related outcomes
|
|
1024
|
+
& foundations
|
|
1025
|
+
type: object
|
|
1026
|
+
properties:
|
|
1027
|
+
corequisites:
|
|
1028
|
+
description: List of AchievementMappings which are part of the corequisite
|
|
1029
|
+
set
|
|
1030
|
+
type: array
|
|
1031
|
+
items:
|
|
1032
|
+
type: object
|
|
1033
|
+
required: false
|
|
1034
|
+
learning:
|
|
1035
|
+
description: Learning record to be created.
|
|
1036
|
+
type: object
|
|
1037
|
+
learningPolicyRules:
|
|
1038
|
+
description: List of Learning Policy Rules that are part of learning
|
|
1039
|
+
type: array
|
|
1040
|
+
items:
|
|
1041
|
+
type: LearningPolicyRules
|
|
1042
|
+
outcomes:
|
|
1043
|
+
description: List of AchievementMappings which are part of the outcomes set
|
|
1044
|
+
type: array
|
|
1045
|
+
items:
|
|
1046
|
+
type: object
|
|
1047
|
+
required: false
|
|
1048
|
+
prerequisites:
|
|
1049
|
+
description: List of AchievementMappings which are part of the prerequisite
|
|
1050
|
+
set
|
|
1051
|
+
type: array
|
|
1052
|
+
items:
|
|
1053
|
+
type: object
|
|
1054
|
+
required: false
|
|
1055
|
+
recommended:
|
|
1056
|
+
description: List of AchievementMappings which are part of the recommended
|
|
1057
|
+
set
|
|
1058
|
+
type: array
|
|
1059
|
+
items:
|
|
1060
|
+
type: object
|
|
1061
|
+
required: false
|
|
1062
|
+
linked:
|
|
1063
|
+
description: List of AchievementMappings that are part of the linked courses set
|
|
1064
|
+
set
|
|
1065
|
+
type: array
|
|
1066
|
+
items:
|
|
1067
|
+
type: any
|
|
1068
|
+
required: false
|
|
1069
|
+
preOrCorequisites:
|
|
1070
|
+
description:
|
|
1071
|
+
List of AchievementMappings that are part of the prerequisite or co-requisite set
|
|
1072
|
+
set
|
|
1073
|
+
type: array
|
|
1074
|
+
items:
|
|
1075
|
+
type: any
|
|
1076
|
+
required: false
|
|
1077
|
+
skills:
|
|
1078
|
+
description: List of SkillAchievementMappings that are part of LearningAchievement of type Skill
|
|
1079
|
+
type: array
|
|
1080
|
+
items:
|
|
1081
|
+
type: object
|
|
1082
|
+
required: false
|
|
1083
|
+
ConcreteAchievementMapping:
|
|
1084
|
+
description: A mapping which corresponds to an existing Learning Achievement Record
|
|
1085
|
+
type: AbstractAchievementMapping
|
|
1086
|
+
properties:
|
|
1087
|
+
duration:
|
|
1088
|
+
description: The allocated length of time for completion of this Achievement
|
|
1089
|
+
via Learning
|
|
1090
|
+
format: double
|
|
1091
|
+
type: number
|
|
1092
|
+
required: false
|
|
1093
|
+
durationUnit:
|
|
1094
|
+
description: The unit of measurement for completion of this Achievement via
|
|
1095
|
+
Learning
|
|
1096
|
+
type: string
|
|
1097
|
+
required: false
|
|
1098
|
+
learningAchievementId:
|
|
1099
|
+
description: The learning achievement id which fulfills this concrete achievement
|
|
1100
|
+
type: string
|
|
1101
|
+
required: false
|
|
1102
|
+
learningId:
|
|
1103
|
+
description: The learning id which fulfills this concrete achievement
|
|
1104
|
+
type: string
|
|
1105
|
+
required: false
|
|
1106
|
+
minimumGrade:
|
|
1107
|
+
description: The minimum grade required for given Achievement
|
|
1108
|
+
format: double
|
|
1109
|
+
type: number
|
|
1110
|
+
required: false
|
|
1111
|
+
CreateLearningOutputRepresentation:
|
|
1112
|
+
description: Output representation from the Create Learning operation
|
|
1113
|
+
type: object
|
|
1114
|
+
properties:
|
|
1115
|
+
learningAchievementIds:
|
|
1116
|
+
description: Learning Achievement Ids created which relate to the Learning.
|
|
1117
|
+
type: array
|
|
1118
|
+
required: false
|
|
1119
|
+
items:
|
|
1120
|
+
type: string
|
|
1121
|
+
learningCourseId:
|
|
1122
|
+
description: Created Learning Course Id.
|
|
1123
|
+
type: string
|
|
1124
|
+
required: false
|
|
1125
|
+
learningFoundationItemIds:
|
|
1126
|
+
description: Learning Foundation Ids created which relate to the Learning.
|
|
1127
|
+
type: array
|
|
1128
|
+
required: false
|
|
1129
|
+
items:
|
|
1130
|
+
type: string
|
|
1131
|
+
learningId:
|
|
1132
|
+
description: Created Learning Id.
|
|
1133
|
+
type: string
|
|
1134
|
+
required: false
|
|
1135
|
+
learningOutcomeItemIds:
|
|
1136
|
+
description: Learning Outcome Ids created which relate to the Learning.
|
|
1137
|
+
type: array
|
|
1138
|
+
required: false
|
|
1139
|
+
items:
|
|
1140
|
+
type: string
|
|
1141
|
+
learningProgramId:
|
|
1142
|
+
description: Created Learning Program Id.
|
|
1143
|
+
type: string
|
|
1144
|
+
required: false
|
|
1145
|
+
errors:
|
|
1146
|
+
description: Error Code.
|
|
1147
|
+
type: array
|
|
1148
|
+
required: false
|
|
1149
|
+
items:
|
|
1150
|
+
type: EducationApiErrorDetails
|
|
1151
|
+
success:
|
|
1152
|
+
description: Success flag.
|
|
1153
|
+
type: boolean
|
|
1154
|
+
required: false
|
|
1155
|
+
EducationApiErrorDetails:
|
|
1156
|
+
description: Education API Error Details.
|
|
1157
|
+
type: object
|
|
1158
|
+
properties:
|
|
1159
|
+
field:
|
|
1160
|
+
description: Field name that has error.
|
|
1161
|
+
type: string
|
|
1162
|
+
message:
|
|
1163
|
+
description: Failed process error message.
|
|
1164
|
+
type: string
|
|
1165
|
+
ElectiveCourseRequirement:
|
|
1166
|
+
description: Elective course requirements to complete the learning program plan.
|
|
1167
|
+
type: Requirement
|
|
1168
|
+
properties:
|
|
1169
|
+
learningAchievement:
|
|
1170
|
+
description: Learning achievement to be created for elective requirement types.
|
|
1171
|
+
type: object
|
|
1172
|
+
learningIds:
|
|
1173
|
+
description: Learning identifiers of the learning program plan requirement.
|
|
1174
|
+
Elective types have one or more.
|
|
1175
|
+
type: array
|
|
1176
|
+
items:
|
|
1177
|
+
type: string
|
|
1178
|
+
FilterConfig:
|
|
1179
|
+
description: Representation of the filter config.
|
|
1180
|
+
type: object
|
|
1181
|
+
properties:
|
|
1182
|
+
apiName:
|
|
1183
|
+
description: The API Name of the field to be filtered
|
|
1184
|
+
type: string
|
|
1185
|
+
fieldType:
|
|
1186
|
+
description: The data type of the field to be filtered
|
|
1187
|
+
type: string
|
|
1188
|
+
operator:
|
|
1189
|
+
description: The operator for filtering the field
|
|
1190
|
+
type: string
|
|
1191
|
+
filterValue:
|
|
1192
|
+
description: The values to filter the field by
|
|
1193
|
+
type: array
|
|
1194
|
+
items:
|
|
1195
|
+
type: string
|
|
1196
|
+
GetApplicationDetailsResult:
|
|
1197
|
+
description: Representation of the get application details request.
|
|
1198
|
+
type: object
|
|
1199
|
+
properties:
|
|
1200
|
+
academicLevel:
|
|
1201
|
+
description: The academic level associated with an application.
|
|
1202
|
+
type: string
|
|
1203
|
+
required: false
|
|
1204
|
+
applicant:
|
|
1205
|
+
description: Data for the applicant associated with an application.
|
|
1206
|
+
type: Applicant
|
|
1207
|
+
required: false
|
|
1208
|
+
applicationCategory:
|
|
1209
|
+
description: The application category associated with an application.
|
|
1210
|
+
type: string
|
|
1211
|
+
required: false
|
|
1212
|
+
applicationCloseDate:
|
|
1213
|
+
description: The date the application closes.
|
|
1214
|
+
type: string
|
|
1215
|
+
required: false
|
|
1216
|
+
appliedDate:
|
|
1217
|
+
description: The date when an applicant submitted an application.
|
|
1218
|
+
type: string
|
|
1219
|
+
required: false
|
|
1220
|
+
id:
|
|
1221
|
+
description: The ID of the application.
|
|
1222
|
+
type: string
|
|
1223
|
+
required: false
|
|
1224
|
+
individualApplicationTasks:
|
|
1225
|
+
description: The Individual Application Tasks related to the application.
|
|
1226
|
+
type: array
|
|
1227
|
+
required: false
|
|
1228
|
+
items:
|
|
1229
|
+
type: IndividualApplicationTask
|
|
1230
|
+
isSubmitted:
|
|
1231
|
+
description: An indicator of whether the Application is submitted.
|
|
1232
|
+
type: boolean
|
|
1233
|
+
required: false
|
|
1234
|
+
programName:
|
|
1235
|
+
description: The name of the program associated with an application.
|
|
1236
|
+
type: string
|
|
1237
|
+
required: false
|
|
1238
|
+
requiredItemsCompleted:
|
|
1239
|
+
description: The number of completed required individual application tasks
|
|
1240
|
+
associated with an application.
|
|
1241
|
+
type: integer
|
|
1242
|
+
required: false
|
|
1243
|
+
status:
|
|
1244
|
+
description: The status of an application.
|
|
1245
|
+
type: string
|
|
1246
|
+
required: false
|
|
1247
|
+
statusLabel:
|
|
1248
|
+
description: The status label of an application.
|
|
1249
|
+
type: string
|
|
1250
|
+
required: false
|
|
1251
|
+
submitter:
|
|
1252
|
+
description: Data for the submitter of an application.
|
|
1253
|
+
type: Submitter
|
|
1254
|
+
required: false
|
|
1255
|
+
termName:
|
|
1256
|
+
description: The name of the academic term associated with an application.
|
|
1257
|
+
type: string
|
|
1258
|
+
required: false
|
|
1259
|
+
totalRequiredItems:
|
|
1260
|
+
description: The number of required individual application tasks associated
|
|
1261
|
+
with an application.
|
|
1262
|
+
type: integer
|
|
1263
|
+
required: false
|
|
1264
|
+
GetApplicationsResult:
|
|
1265
|
+
description: Representation of the get applications list request.
|
|
1266
|
+
type: object
|
|
1267
|
+
properties:
|
|
1268
|
+
applications:
|
|
1269
|
+
description: List of available applications associated with a user.
|
|
1270
|
+
type: array
|
|
1271
|
+
required: false
|
|
1272
|
+
items:
|
|
1273
|
+
type: Application
|
|
1274
|
+
GetLearningOutputRepresentation:
|
|
1275
|
+
description: Learning output.
|
|
1276
|
+
type: object
|
|
1277
|
+
properties:
|
|
1278
|
+
corequisites:
|
|
1279
|
+
description: Corequisites
|
|
1280
|
+
type: array
|
|
1281
|
+
required: false
|
|
1282
|
+
items:
|
|
1283
|
+
type: LearningFoundationItemOutput
|
|
1284
|
+
errors:
|
|
1285
|
+
description: Specifies the validation errors for the API parameters.
|
|
1286
|
+
type: array
|
|
1287
|
+
required: false
|
|
1288
|
+
items:
|
|
1289
|
+
type: EducationApiErrorDetails
|
|
1290
|
+
learning:
|
|
1291
|
+
description: Learning
|
|
1292
|
+
type: LearningOutput
|
|
1293
|
+
required: false
|
|
1294
|
+
learningPolicyRules:
|
|
1295
|
+
description: Learning Policies Output.
|
|
1296
|
+
type: array
|
|
1297
|
+
required: false
|
|
1298
|
+
items:
|
|
1299
|
+
type: LearningPolicyRuleOutput
|
|
1300
|
+
outcomes:
|
|
1301
|
+
description: Outcomes
|
|
1302
|
+
type: array
|
|
1303
|
+
required: false
|
|
1304
|
+
items:
|
|
1305
|
+
type: LearningOutcomeItemOutput
|
|
1306
|
+
prerequisites:
|
|
1307
|
+
description: Prerequisites
|
|
1308
|
+
type: array
|
|
1309
|
+
required: false
|
|
1310
|
+
items:
|
|
1311
|
+
type: LearningFoundationItemOutput
|
|
1312
|
+
recommended:
|
|
1313
|
+
description: Recommended
|
|
1314
|
+
type: array
|
|
1315
|
+
required: false
|
|
1316
|
+
items:
|
|
1317
|
+
type: LearningFoundationItemOutput
|
|
1318
|
+
linked:
|
|
1319
|
+
description: Linked courses
|
|
1320
|
+
type: array
|
|
1321
|
+
required: false
|
|
1322
|
+
items:
|
|
1323
|
+
type: LearningFoundationItemOutput
|
|
1324
|
+
preOrCorequisites:
|
|
1325
|
+
description: Prerequisite or co-requisite courses
|
|
1326
|
+
type: array
|
|
1327
|
+
required: false
|
|
1328
|
+
items:
|
|
1329
|
+
type: LearningFoundationItemOutput
|
|
1330
|
+
success:
|
|
1331
|
+
description: Specifies the success of the API.
|
|
1332
|
+
type: boolean
|
|
1333
|
+
required: false
|
|
1334
|
+
GetNewApplicationPreliminaryDataResult:
|
|
1335
|
+
description: Representation of the get new application preliminary data request.
|
|
1336
|
+
type: object
|
|
1337
|
+
properties:
|
|
1338
|
+
academicLevels:
|
|
1339
|
+
description: List of available academic levels.
|
|
1340
|
+
type: array
|
|
1341
|
+
required: false
|
|
1342
|
+
items:
|
|
1343
|
+
type: ApplicationAcademicLevel
|
|
1344
|
+
applicants:
|
|
1345
|
+
description: List of records for available applicants.
|
|
1346
|
+
type: array
|
|
1347
|
+
required: false
|
|
1348
|
+
items:
|
|
1349
|
+
type: Applicant
|
|
1350
|
+
GetSuccessTeamResult:
|
|
1351
|
+
description: Representation of the get success team request.
|
|
1352
|
+
type: object
|
|
1353
|
+
properties:
|
|
1354
|
+
assignedStaff:
|
|
1355
|
+
description: List of staff members who are assigned to the case and are available
|
|
1356
|
+
to support the associated account.
|
|
1357
|
+
type: object
|
|
1358
|
+
properties:
|
|
1359
|
+
//:
|
|
1360
|
+
type: any
|
|
1361
|
+
assignedTeams:
|
|
1362
|
+
description: List of teams that are assigned to the case for the associated
|
|
1363
|
+
account.
|
|
1364
|
+
type: array
|
|
1365
|
+
items:
|
|
1366
|
+
type: AvailableTeam
|
|
1367
|
+
unassignedTeams:
|
|
1368
|
+
description: List of teams that aren't assigned to the case and are available
|
|
1369
|
+
to support the associated account.
|
|
1370
|
+
type: array
|
|
1371
|
+
items:
|
|
1372
|
+
type: AvailableTeam
|
|
1373
|
+
IndividualApplicationTask:
|
|
1374
|
+
description: Representation of the individual application task.
|
|
1375
|
+
type: object
|
|
1376
|
+
properties:
|
|
1377
|
+
applicationRenderMethods:
|
|
1378
|
+
description: The application render methods associated with an individual
|
|
1379
|
+
application task.
|
|
1380
|
+
type: array
|
|
1381
|
+
required: false
|
|
1382
|
+
items:
|
|
1383
|
+
type: ApplicationRenderMethod
|
|
1384
|
+
dueDate:
|
|
1385
|
+
description: The due date of the Individual Application Task.
|
|
1386
|
+
type: string
|
|
1387
|
+
required: false
|
|
1388
|
+
id:
|
|
1389
|
+
description: The ID of the Individual Application Task.
|
|
1390
|
+
type: string
|
|
1391
|
+
required: false
|
|
1392
|
+
isRequired:
|
|
1393
|
+
description: An indicator of whether the Individual Application Task is required.
|
|
1394
|
+
type: boolean
|
|
1395
|
+
required: false
|
|
1396
|
+
name:
|
|
1397
|
+
description: The name of the Individual Application Task.
|
|
1398
|
+
type: string
|
|
1399
|
+
required: false
|
|
1400
|
+
renderMethodName:
|
|
1401
|
+
description: The Method Name of the Application Render Method associated with
|
|
1402
|
+
the Individual Application Task.
|
|
1403
|
+
type: string
|
|
1404
|
+
required: false
|
|
1405
|
+
renderMethodRecordId:
|
|
1406
|
+
description: The Method Record ID of the Application Render Method associated
|
|
1407
|
+
with the Individual Application Task.
|
|
1408
|
+
type: string
|
|
1409
|
+
required: false
|
|
1410
|
+
renderMethodType:
|
|
1411
|
+
description: The type of the Application Render Method associated with the
|
|
1412
|
+
Individual Application Task.
|
|
1413
|
+
type: string
|
|
1414
|
+
required: false
|
|
1415
|
+
stageDescription:
|
|
1416
|
+
description: The description of the Individual Application Task's Application
|
|
1417
|
+
Stage Definition.
|
|
1418
|
+
type: string
|
|
1419
|
+
required: false
|
|
1420
|
+
stageName:
|
|
1421
|
+
description: The name of the Individual Application Task's Application Stage
|
|
1422
|
+
Definition.
|
|
1423
|
+
type: string
|
|
1424
|
+
required: false
|
|
1425
|
+
status:
|
|
1426
|
+
description: The status of the Individual Application Task.
|
|
1427
|
+
type: string
|
|
1428
|
+
required: false
|
|
1429
|
+
statusLabel:
|
|
1430
|
+
description: The translated status label of an individual application task.
|
|
1431
|
+
type: string
|
|
1432
|
+
required: false
|
|
1433
|
+
IndividualApplicationTaskOutputRepresentation:
|
|
1434
|
+
description: Representation of the output for the get individual application task
|
|
1435
|
+
request.
|
|
1436
|
+
type: object
|
|
1437
|
+
properties:
|
|
1438
|
+
result:
|
|
1439
|
+
description: Representation of the get individual application task request.
|
|
1440
|
+
type: IndividualApplicationTask
|
|
1441
|
+
required: false
|
|
1442
|
+
LearnerProgram:
|
|
1443
|
+
description: Represents information about a program enrolled by learner.
|
|
1444
|
+
type: object
|
|
1445
|
+
properties:
|
|
1446
|
+
description:
|
|
1447
|
+
description: Description of the learner program
|
|
1448
|
+
type: string
|
|
1449
|
+
required: false
|
|
1450
|
+
endDate:
|
|
1451
|
+
description: End date of the learner program
|
|
1452
|
+
type: string
|
|
1453
|
+
required: false
|
|
1454
|
+
learnerAccountId:
|
|
1455
|
+
description: Learner account Id
|
|
1456
|
+
type: string
|
|
1457
|
+
required: false
|
|
1458
|
+
learnerContactId:
|
|
1459
|
+
description: Learner contact Id
|
|
1460
|
+
type: string
|
|
1461
|
+
required: false
|
|
1462
|
+
learnerProgramId:
|
|
1463
|
+
description: Learner program Id
|
|
1464
|
+
type: string
|
|
1465
|
+
required: false
|
|
1466
|
+
learningId:
|
|
1467
|
+
description: Learning Id for the associated learning program
|
|
1468
|
+
type: string
|
|
1469
|
+
required: false
|
|
1470
|
+
learningOutcomeItem:
|
|
1471
|
+
description: Learning Outcome Item
|
|
1472
|
+
type: LearningOutcomeItemOutput
|
|
1473
|
+
required: false
|
|
1474
|
+
learningProgramAcademicLevel:
|
|
1475
|
+
description: Learning Program Academic Level
|
|
1476
|
+
type: string
|
|
1477
|
+
required: false
|
|
1478
|
+
learningProgramCipCode:
|
|
1479
|
+
description: Learning Program Cip Code
|
|
1480
|
+
type: string
|
|
1481
|
+
required: false
|
|
1482
|
+
learningProgramId:
|
|
1483
|
+
description: Learning program Id for the associated learning program plan
|
|
1484
|
+
type: string
|
|
1485
|
+
required: false
|
|
1486
|
+
learningProgramName:
|
|
1487
|
+
description: Learning Program Name
|
|
1488
|
+
type: string
|
|
1489
|
+
required: false
|
|
1490
|
+
learningProgramPlanId:
|
|
1491
|
+
description: Learning program plan Id for this learner program
|
|
1492
|
+
type: string
|
|
1493
|
+
required: false
|
|
1494
|
+
learningProgramPlanName:
|
|
1495
|
+
description: Learning Program Plan Name
|
|
1496
|
+
type: string
|
|
1497
|
+
required: false
|
|
1498
|
+
learningProgramProviderId:
|
|
1499
|
+
description: Learning Program Provider Id
|
|
1500
|
+
type: string
|
|
1501
|
+
required: false
|
|
1502
|
+
learningProgramProviderName:
|
|
1503
|
+
description: Learning Program Provider Name
|
|
1504
|
+
type: string
|
|
1505
|
+
required: false
|
|
1506
|
+
name:
|
|
1507
|
+
description: Name of the learner program
|
|
1508
|
+
type: string
|
|
1509
|
+
required: false
|
|
1510
|
+
parentLearnerProgramId:
|
|
1511
|
+
description: Parent learner program Id
|
|
1512
|
+
type: string
|
|
1513
|
+
required: false
|
|
1514
|
+
requirements:
|
|
1515
|
+
description: Status of the learner program
|
|
1516
|
+
required: false
|
|
1517
|
+
type: array
|
|
1518
|
+
items:
|
|
1519
|
+
type: LearnerProgramRequirement
|
|
1520
|
+
startDate:
|
|
1521
|
+
description: Start date of the learner program
|
|
1522
|
+
type: string
|
|
1523
|
+
required: false
|
|
1524
|
+
status:
|
|
1525
|
+
description: Status of the learner program
|
|
1526
|
+
type: string
|
|
1527
|
+
required: false
|
|
1528
|
+
LearnerProgramRequirement:
|
|
1529
|
+
description: Represents information about a learner program requirement.
|
|
1530
|
+
type: object
|
|
1531
|
+
properties:
|
|
1532
|
+
description:
|
|
1533
|
+
description: Description of the learner program requirement
|
|
1534
|
+
type: string
|
|
1535
|
+
required: false
|
|
1536
|
+
learnerProgramId:
|
|
1537
|
+
description: Learner program Id
|
|
1538
|
+
type: string
|
|
1539
|
+
learnerProgramRequirementId:
|
|
1540
|
+
description: Learner program requirement Id
|
|
1541
|
+
type: string
|
|
1542
|
+
required: false
|
|
1543
|
+
learningProgramPlanRequirement:
|
|
1544
|
+
description: Learning program plan requirement.
|
|
1545
|
+
type: LearningProgramPlanRequirementOutput
|
|
1546
|
+
required: false
|
|
1547
|
+
learningProgramPlanRequirementId:
|
|
1548
|
+
description: Learning program plan requirement Id
|
|
1549
|
+
type: string
|
|
1550
|
+
required: false
|
|
1551
|
+
name:
|
|
1552
|
+
description: Name of the learner program requirement
|
|
1553
|
+
type: string
|
|
1554
|
+
requirementDurationsByUnit:
|
|
1555
|
+
description: Requirement durations by duration unit type
|
|
1556
|
+
type: object
|
|
1557
|
+
required: false
|
|
1558
|
+
properties:
|
|
1559
|
+
//:
|
|
1560
|
+
type: any
|
|
1561
|
+
status:
|
|
1562
|
+
description: Status of the learner program requirement
|
|
1563
|
+
type: string
|
|
1564
|
+
required: false
|
|
1565
|
+
LearnerProgressOutputRepresentation:
|
|
1566
|
+
description: Learner progress output.
|
|
1567
|
+
type: object
|
|
1568
|
+
properties:
|
|
1569
|
+
learnerPrograms:
|
|
1570
|
+
description: List of learner programs enrolled by a student
|
|
1571
|
+
type: array
|
|
1572
|
+
required: false
|
|
1573
|
+
items:
|
|
1574
|
+
type: LearnerProgram
|
|
1575
|
+
nonRequiredLearnings:
|
|
1576
|
+
description: List of non required learnings completed or enrolled by a student
|
|
1577
|
+
type: array
|
|
1578
|
+
required: false
|
|
1579
|
+
items:
|
|
1580
|
+
type: LearningFulfiller
|
|
1581
|
+
Learning:
|
|
1582
|
+
description: Represents information that defines an instructional object that
|
|
1583
|
+
can be made available as a course, program, or on-site experience, for a contact.
|
|
1584
|
+
discriminator: type
|
|
1585
|
+
type: object
|
|
1586
|
+
properties:
|
|
1587
|
+
academicLevel:
|
|
1588
|
+
description: Academic level of the learning.
|
|
1589
|
+
type: string
|
|
1590
|
+
required: false
|
|
1591
|
+
active:
|
|
1592
|
+
description: Indicates whether the learning is active.
|
|
1593
|
+
type: boolean
|
|
1594
|
+
required: false
|
|
1595
|
+
activeFromDate:
|
|
1596
|
+
description: Start date of the learning's active period.
|
|
1597
|
+
type: string
|
|
1598
|
+
required: false
|
|
1599
|
+
activeToDate:
|
|
1600
|
+
description: End date of the learning's active period.
|
|
1601
|
+
type: string
|
|
1602
|
+
required: false
|
|
1603
|
+
cipCode:
|
|
1604
|
+
description: Classification of Instructional Programming code that identifies
|
|
1605
|
+
the program or field of study.
|
|
1606
|
+
type: string
|
|
1607
|
+
description:
|
|
1608
|
+
description: Description of the learning.
|
|
1609
|
+
type: string
|
|
1610
|
+
required: false
|
|
1611
|
+
duration:
|
|
1612
|
+
description: Allocated duration to complete the learning.
|
|
1613
|
+
format: double
|
|
1614
|
+
type: number
|
|
1615
|
+
required: false
|
|
1616
|
+
durationUnit:
|
|
1617
|
+
description: Unit of the duration allocated to complete the learning.
|
|
1618
|
+
type: string
|
|
1619
|
+
required: false
|
|
1620
|
+
learningId:
|
|
1621
|
+
description: Learning id.
|
|
1622
|
+
type: string
|
|
1623
|
+
required: false
|
|
1624
|
+
name:
|
|
1625
|
+
description: Name of the Learning
|
|
1626
|
+
type: string
|
|
1627
|
+
required: false
|
|
1628
|
+
provider:
|
|
1629
|
+
description: Account foreign key identifier of the institution that provides
|
|
1630
|
+
the learning.
|
|
1631
|
+
type: string
|
|
1632
|
+
required: false
|
|
1633
|
+
type:
|
|
1634
|
+
description: Learning record type. Possible values are Learning Program and
|
|
1635
|
+
Learning Course.
|
|
1636
|
+
type: string
|
|
1637
|
+
enum:
|
|
1638
|
+
- LearningCourse
|
|
1639
|
+
- LearningProgram
|
|
1640
|
+
LearningAchievement:
|
|
1641
|
+
description: Learning achievement accomplished by completing the requirement.
|
|
1642
|
+
type: object
|
|
1643
|
+
properties:
|
|
1644
|
+
abbreviation:
|
|
1645
|
+
description: Abbreviation of the learning achievement.
|
|
1646
|
+
type: string
|
|
1647
|
+
required: false
|
|
1648
|
+
academicLevel:
|
|
1649
|
+
description: Academic level of the learning achievement.
|
|
1650
|
+
type: string
|
|
1651
|
+
required: false
|
|
1652
|
+
additionalField:
|
|
1653
|
+
description: Custom field on the learning achievement.
|
|
1654
|
+
type: object
|
|
1655
|
+
required: false
|
|
1656
|
+
properties:
|
|
1657
|
+
//:
|
|
1658
|
+
type: object
|
|
1659
|
+
description:
|
|
1660
|
+
description: Description of the learning achievement.
|
|
1661
|
+
type: string
|
|
1662
|
+
required: false
|
|
1663
|
+
fieldOfStudy:
|
|
1664
|
+
description: Field of study of the learning achievement.
|
|
1665
|
+
type: string
|
|
1666
|
+
required: false
|
|
1667
|
+
issuer:
|
|
1668
|
+
description: Issuer of the learning achievement.
|
|
1669
|
+
type: string
|
|
1670
|
+
required: false
|
|
1671
|
+
name:
|
|
1672
|
+
description: Name of the learning achievement.
|
|
1673
|
+
type: string
|
|
1674
|
+
specialization:
|
|
1675
|
+
description: Specialization of the learning achievement.
|
|
1676
|
+
type: string
|
|
1677
|
+
required: false
|
|
1678
|
+
LearningCourse:
|
|
1679
|
+
description: Represents information about a course that’s required in a learning
|
|
1680
|
+
framework.
|
|
1681
|
+
type: Learning
|
|
1682
|
+
properties:
|
|
1683
|
+
courseLevelDescription:
|
|
1684
|
+
description: General type or level of instruction provided by the learning
|
|
1685
|
+
course.
|
|
1686
|
+
type: string
|
|
1687
|
+
required: false
|
|
1688
|
+
courseNumber:
|
|
1689
|
+
description: Numeric identifier of the course.
|
|
1690
|
+
type: string
|
|
1691
|
+
required: false
|
|
1692
|
+
fieldOfStudy:
|
|
1693
|
+
description: Field of study of the learning course.
|
|
1694
|
+
type: string
|
|
1695
|
+
required: false
|
|
1696
|
+
learningCourseCustomFields:
|
|
1697
|
+
description: Custom fields on the learning course.
|
|
1698
|
+
type: object
|
|
1699
|
+
required: false
|
|
1700
|
+
properties:
|
|
1701
|
+
//:
|
|
1702
|
+
type: any
|
|
1703
|
+
learningCourseId:
|
|
1704
|
+
description: Learning course id.
|
|
1705
|
+
type: string
|
|
1706
|
+
required: false
|
|
1707
|
+
subjectAbbreviation:
|
|
1708
|
+
description: Abbreviation for the subject of the learning course.
|
|
1709
|
+
type: string
|
|
1710
|
+
required: false
|
|
1711
|
+
LearningCourseOutput:
|
|
1712
|
+
description: Represents information about a course that’s required in a learning
|
|
1713
|
+
framework.
|
|
1714
|
+
type: LearningOutput
|
|
1715
|
+
discriminatorValue: LearningCourse
|
|
1716
|
+
properties:
|
|
1717
|
+
courseLevelDescription:
|
|
1718
|
+
description: Learning course level description.
|
|
1719
|
+
type: string
|
|
1720
|
+
required: false
|
|
1721
|
+
courseNumber:
|
|
1722
|
+
description: Learning course number.
|
|
1723
|
+
type: string
|
|
1724
|
+
required: false
|
|
1725
|
+
fieldOfStudy:
|
|
1726
|
+
description: Learning field of study.
|
|
1727
|
+
type: string
|
|
1728
|
+
required: false
|
|
1729
|
+
learningCourseCustomFields:
|
|
1730
|
+
description: Learning course custom fields.
|
|
1731
|
+
type: object
|
|
1732
|
+
required: false
|
|
1733
|
+
properties:
|
|
1734
|
+
//:
|
|
1735
|
+
type: any
|
|
1736
|
+
learningCourseId:
|
|
1737
|
+
description: Learning course id.
|
|
1738
|
+
type: string
|
|
1739
|
+
required: false
|
|
1740
|
+
subjectAbbreviation:
|
|
1741
|
+
description: Learning subject abbreviation.
|
|
1742
|
+
type: string
|
|
1743
|
+
required: false
|
|
1744
|
+
linkedOnly:
|
|
1745
|
+
description: Indicates if this is a linked-only course.
|
|
1746
|
+
type: boolean
|
|
1747
|
+
required: false
|
|
1748
|
+
courseType:
|
|
1749
|
+
description: Type of the course.
|
|
1750
|
+
type: string
|
|
1751
|
+
required: false
|
|
1752
|
+
LearningFoundationItemOutput:
|
|
1753
|
+
description: Representation of a learning foundation item output.
|
|
1754
|
+
type: object
|
|
1755
|
+
properties:
|
|
1756
|
+
category:
|
|
1757
|
+
description: Category
|
|
1758
|
+
type: string
|
|
1759
|
+
required: false
|
|
1760
|
+
duration:
|
|
1761
|
+
description: Duration
|
|
1762
|
+
format: double
|
|
1763
|
+
type: number
|
|
1764
|
+
required: false
|
|
1765
|
+
durationUnit:
|
|
1766
|
+
description: The unit of duration.
|
|
1767
|
+
type: string
|
|
1768
|
+
required: false
|
|
1769
|
+
fulfilledBy:
|
|
1770
|
+
description: List of learning fulfillers that provide more information about
|
|
1771
|
+
how the foundation item can be fulfilled.
|
|
1772
|
+
type: array
|
|
1773
|
+
required: false
|
|
1774
|
+
items:
|
|
1775
|
+
type: LearningFulfiller
|
|
1776
|
+
fulfilledDuration:
|
|
1777
|
+
description: The completed duration towards fulfilling the learning foundation
|
|
1778
|
+
item.
|
|
1779
|
+
format: double
|
|
1780
|
+
type: number
|
|
1781
|
+
required: false
|
|
1782
|
+
isFulfilled:
|
|
1783
|
+
description: Specifies whether the learning foundation item is fulfilled (true)
|
|
1784
|
+
or unfulfilled (false).
|
|
1785
|
+
type: boolean
|
|
1786
|
+
required: false
|
|
1787
|
+
learningAchievementConfigName:
|
|
1788
|
+
description: The name of the learning achievement config record
|
|
1789
|
+
type: string
|
|
1790
|
+
required: false
|
|
1791
|
+
learningAchievementName:
|
|
1792
|
+
description: The name of the learning achievement
|
|
1793
|
+
type: string
|
|
1794
|
+
required: false
|
|
1795
|
+
learningAchievementId:
|
|
1796
|
+
description: Learning Achievement Id
|
|
1797
|
+
type: string
|
|
1798
|
+
required: false
|
|
1799
|
+
learningAchievementType:
|
|
1800
|
+
description: Type of Learning Achievement
|
|
1801
|
+
type: string
|
|
1802
|
+
required: false
|
|
1803
|
+
learningFoundationItemId:
|
|
1804
|
+
description: The ID of the learning foundation item.
|
|
1805
|
+
type: string
|
|
1806
|
+
learningId:
|
|
1807
|
+
description: Learning Id
|
|
1808
|
+
type: string
|
|
1809
|
+
required: false
|
|
1810
|
+
minimumNumericGrade:
|
|
1811
|
+
description: The minimum numeric grade required to fulfill the learning foundation
|
|
1812
|
+
item.
|
|
1813
|
+
format: double
|
|
1814
|
+
type: number
|
|
1815
|
+
required: false
|
|
1816
|
+
name:
|
|
1817
|
+
description: Name
|
|
1818
|
+
type: string
|
|
1819
|
+
required: false
|
|
1820
|
+
remainingDuration:
|
|
1821
|
+
description: The remaining duration required to fulfill the learning foundation
|
|
1822
|
+
item.
|
|
1823
|
+
format: double
|
|
1824
|
+
type: number
|
|
1825
|
+
required: false
|
|
1826
|
+
type:
|
|
1827
|
+
description: Type
|
|
1828
|
+
type: string
|
|
1829
|
+
required: false
|
|
1830
|
+
LearningFoundationItemValidationInput:
|
|
1831
|
+
description: Representation of the input validating a learning's foundation items.
|
|
1832
|
+
type: object
|
|
1833
|
+
properties:
|
|
1834
|
+
concurrentLearnings:
|
|
1835
|
+
description: List of learnings that could be taken at the same time as the
|
|
1836
|
+
learning that is being validated.
|
|
1837
|
+
type: array
|
|
1838
|
+
items:
|
|
1839
|
+
type: object
|
|
1840
|
+
learningId:
|
|
1841
|
+
description: The ID of the learning foundation item to be validated.
|
|
1842
|
+
type: string
|
|
1843
|
+
precedingLearnings:
|
|
1844
|
+
description: List of learnings that could be taken before the learning that
|
|
1845
|
+
is being validated.
|
|
1846
|
+
type: array
|
|
1847
|
+
items:
|
|
1848
|
+
type: object
|
|
1849
|
+
LearningFoundationItemValidationInputRepresentation:
|
|
1850
|
+
description: Representation of the learning foundation item validation input request.
|
|
1851
|
+
type: object
|
|
1852
|
+
properties:
|
|
1853
|
+
learningFoundationItemValidationInputList:
|
|
1854
|
+
description: Learning foundation item validation input list.
|
|
1855
|
+
type: array
|
|
1856
|
+
items:
|
|
1857
|
+
type: LearningFoundationItemValidationInput
|
|
1858
|
+
LearningFoundationItemValidationOutput:
|
|
1859
|
+
description: Representation of output for each individual learning foundation
|
|
1860
|
+
item validation request.
|
|
1861
|
+
type: object
|
|
1862
|
+
properties:
|
|
1863
|
+
corequisites:
|
|
1864
|
+
description: List of required corequisites for the validated learning.
|
|
1865
|
+
type: array
|
|
1866
|
+
items:
|
|
1867
|
+
type: LearningFoundationItemOutput
|
|
1868
|
+
isValid:
|
|
1869
|
+
description: Specifies whether the provided learning satisfies the learning
|
|
1870
|
+
dependencies, subsequently making the learning valid (true) or invalid (false).
|
|
1871
|
+
type: boolean
|
|
1872
|
+
learningId:
|
|
1873
|
+
description: The ID of the validated learning.
|
|
1874
|
+
type: string
|
|
1875
|
+
prerequisites:
|
|
1876
|
+
description: List of required prerequisites for the validated learning.
|
|
1877
|
+
type: array
|
|
1878
|
+
items:
|
|
1879
|
+
type: LearningFoundationItemOutput
|
|
1880
|
+
LearningFoundationItemValidationOutputRepresentation:
|
|
1881
|
+
description: The output representation that corresponds to the learning foundation
|
|
1882
|
+
item validation request.
|
|
1883
|
+
type: object
|
|
1884
|
+
properties:
|
|
1885
|
+
validateLearningsOutput:
|
|
1886
|
+
description: Learning foundation item validation output list.
|
|
1887
|
+
type: array
|
|
1888
|
+
items:
|
|
1889
|
+
type: LearningFoundationItemValidationOutput
|
|
1890
|
+
LearningFoundationValidationInfo:
|
|
1891
|
+
description: Representation of the information necessary to validate a learning's
|
|
1892
|
+
foundation.
|
|
1893
|
+
type: object
|
|
1894
|
+
properties:
|
|
1895
|
+
duration:
|
|
1896
|
+
description: The duration of the learning foundation validation info.
|
|
1897
|
+
format: double
|
|
1898
|
+
type: number
|
|
1899
|
+
durationUnit:
|
|
1900
|
+
description: The duration unit of the learning foundation validation info.
|
|
1901
|
+
type: string
|
|
1902
|
+
id:
|
|
1903
|
+
description: The ID of the record that represents the learning foundation
|
|
1904
|
+
validation info.
|
|
1905
|
+
type: string
|
|
1906
|
+
numericGrade:
|
|
1907
|
+
description: The numeric grade of the learning foundation validation info.
|
|
1908
|
+
format: double
|
|
1909
|
+
type: number
|
|
1910
|
+
required: false
|
|
1911
|
+
type:
|
|
1912
|
+
description: The type of learning foundation validation info.
|
|
1913
|
+
type: string
|
|
1914
|
+
enum:
|
|
1915
|
+
- CompletedLearning
|
|
1916
|
+
- LearningProgramPlanRequirement
|
|
1917
|
+
- PlannedLearning
|
|
1918
|
+
LearningFulfiller:
|
|
1919
|
+
description: Representation of Learning Fulfiller.
|
|
1920
|
+
type: object
|
|
1921
|
+
properties:
|
|
1922
|
+
isRepeat:
|
|
1923
|
+
description: Is Repeat
|
|
1924
|
+
type: boolean
|
|
1925
|
+
required: false
|
|
1926
|
+
learning:
|
|
1927
|
+
description: Learning of the learning fulfiller
|
|
1928
|
+
type: LearningOutput
|
|
1929
|
+
required: false
|
|
1930
|
+
learningOutcomeItem:
|
|
1931
|
+
description: Learning Outcome Item
|
|
1932
|
+
type: LearningOutcomeItemOutput
|
|
1933
|
+
required: false
|
|
1934
|
+
learningStatus:
|
|
1935
|
+
description: Learning Status
|
|
1936
|
+
type: LearningStatus
|
|
1937
|
+
required: false
|
|
1938
|
+
otherLearningStatus:
|
|
1939
|
+
description: Other Learning Status
|
|
1940
|
+
type: array
|
|
1941
|
+
required: false
|
|
1942
|
+
items:
|
|
1943
|
+
type: LearningStatus
|
|
1944
|
+
|
|
1945
|
+
LearningOutcomeItemOutput:
|
|
1946
|
+
description: Representation of Learning Outcome Item.
|
|
1947
|
+
type: object
|
|
1948
|
+
properties:
|
|
1949
|
+
category:
|
|
1950
|
+
description: The category associated with the Learning Outcome Item.
|
|
1951
|
+
type: string
|
|
1952
|
+
required: false
|
|
1953
|
+
duration:
|
|
1954
|
+
description: Learning outcome duration.
|
|
1955
|
+
format: double
|
|
1956
|
+
type: number
|
|
1957
|
+
required: false
|
|
1958
|
+
durationUnit:
|
|
1959
|
+
description: Learning outcome duration unit.
|
|
1960
|
+
type: string
|
|
1961
|
+
required: false
|
|
1962
|
+
isPrimary:
|
|
1963
|
+
description: Indicates whether the Learning Outcome Item is the primary outcome (true) or not (false)
|
|
1964
|
+
type: boolean
|
|
1965
|
+
required: false
|
|
1966
|
+
learningAchievementId:
|
|
1967
|
+
description: Learning Achievement Id
|
|
1968
|
+
type: string
|
|
1969
|
+
required: false
|
|
1970
|
+
learningId:
|
|
1971
|
+
description: Learning Id
|
|
1972
|
+
type: string
|
|
1973
|
+
required: false
|
|
1974
|
+
learningOutcomeId:
|
|
1975
|
+
description: Learning outcome id.
|
|
1976
|
+
type: string
|
|
1977
|
+
required: false
|
|
1978
|
+
minimumNumericGrade:
|
|
1979
|
+
description: The minimum numeric grade that is required to achieve the learning outcome.
|
|
1980
|
+
format: double
|
|
1981
|
+
type: number
|
|
1982
|
+
required: false
|
|
1983
|
+
name:
|
|
1984
|
+
description: Name
|
|
1985
|
+
type: string
|
|
1986
|
+
required: false
|
|
1987
|
+
LearningOutput:
|
|
1988
|
+
description: Represents information that defines an instructional object that
|
|
1989
|
+
can be made available as a course, program, or on-site experience, for a contact.
|
|
1990
|
+
discriminator: type
|
|
1991
|
+
type: object
|
|
1992
|
+
properties:
|
|
1993
|
+
academicLevel:
|
|
1994
|
+
description: Learning academic level.
|
|
1995
|
+
type: string
|
|
1996
|
+
required: false
|
|
1997
|
+
active:
|
|
1998
|
+
description: Learning active details.
|
|
1999
|
+
type: boolean
|
|
2000
|
+
required: false
|
|
2001
|
+
activeFromDate:
|
|
2002
|
+
description: Learning active from date.
|
|
2003
|
+
type: string
|
|
2004
|
+
required: false
|
|
2005
|
+
activeToDate:
|
|
2006
|
+
description: Learning active to date.
|
|
2007
|
+
type: string
|
|
2008
|
+
required: false
|
|
2009
|
+
cipCode:
|
|
2010
|
+
description: Learning cip code.
|
|
2011
|
+
type: string
|
|
2012
|
+
required: false
|
|
2013
|
+
description:
|
|
2014
|
+
description: Learning description.
|
|
2015
|
+
type: string
|
|
2016
|
+
required: false
|
|
2017
|
+
duration:
|
|
2018
|
+
description: Learning duration.
|
|
2019
|
+
format: double
|
|
2020
|
+
type: number
|
|
2021
|
+
required: false
|
|
2022
|
+
durationUnit:
|
|
2023
|
+
description: Learning duration unit.
|
|
2024
|
+
type: string
|
|
2025
|
+
required: false
|
|
2026
|
+
learningId:
|
|
2027
|
+
description: Learning id.
|
|
2028
|
+
type: string
|
|
2029
|
+
required: false
|
|
2030
|
+
name:
|
|
2031
|
+
description: Learning name.
|
|
2032
|
+
type: string
|
|
2033
|
+
required: false
|
|
2034
|
+
provider:
|
|
2035
|
+
description: Learning provider.
|
|
2036
|
+
type: string
|
|
2037
|
+
required: false
|
|
2038
|
+
providerName:
|
|
2039
|
+
description: Provider Name.
|
|
2040
|
+
type: string
|
|
2041
|
+
required: false
|
|
2042
|
+
type:
|
|
2043
|
+
description: Learning type.
|
|
2044
|
+
type: string
|
|
2045
|
+
enum:
|
|
2046
|
+
- LearningCourse
|
|
2047
|
+
- LearningProgram
|
|
2048
|
+
LearningPolicyRuleId:
|
|
2049
|
+
type: object
|
|
2050
|
+
description: Learning Policy Rules Ids
|
|
2051
|
+
properties:
|
|
2052
|
+
learningPolicyRuleId:
|
|
2053
|
+
description: Provides details of the learning policy rule id.
|
|
2054
|
+
type: string
|
|
2055
|
+
LearningPolicyRuleOutput:
|
|
2056
|
+
type: object
|
|
2057
|
+
description: Learning Policy Rules Output
|
|
2058
|
+
discriminator: type
|
|
2059
|
+
properties:
|
|
2060
|
+
description:
|
|
2061
|
+
description: Description
|
|
2062
|
+
type: string
|
|
2063
|
+
learningPolicyRuleId:
|
|
2064
|
+
description: Policy Rule Id
|
|
2065
|
+
type: string
|
|
2066
|
+
policyRule:
|
|
2067
|
+
description: Policy Rule
|
|
2068
|
+
type: string
|
|
2069
|
+
type:
|
|
2070
|
+
description: Type
|
|
2071
|
+
type: string
|
|
2072
|
+
LearningPolicyRuleUpdate:
|
|
2073
|
+
type: object
|
|
2074
|
+
description: Collection of Learning Policy Rules.
|
|
2075
|
+
properties:
|
|
2076
|
+
createRecords:
|
|
2077
|
+
description: Provides details of the request to create achievements.
|
|
2078
|
+
type: array
|
|
2079
|
+
items:
|
|
2080
|
+
type: LearningPolicyRules
|
|
2081
|
+
deleteRecords:
|
|
2082
|
+
description: Provides details of the request to create achievements.
|
|
2083
|
+
type: array
|
|
2084
|
+
items:
|
|
2085
|
+
type: LearningPolicyRuleId
|
|
2086
|
+
LearningPolicyRules:
|
|
2087
|
+
type: object
|
|
2088
|
+
description: Learning Policy Rules definition
|
|
2089
|
+
properties:
|
|
2090
|
+
description:
|
|
2091
|
+
description: Description
|
|
2092
|
+
type: string
|
|
2093
|
+
policyRule:
|
|
2094
|
+
description: Policy Rule
|
|
2095
|
+
type: string
|
|
2096
|
+
type:
|
|
2097
|
+
description: Type
|
|
2098
|
+
type: string
|
|
2099
|
+
LearningProgram:
|
|
2100
|
+
description: Represents information about one or more trainings in a program that’s
|
|
2101
|
+
required to obtain a credential.
|
|
2102
|
+
type: Learning
|
|
2103
|
+
properties:
|
|
2104
|
+
learningProgramCustomFields:
|
|
2105
|
+
description: Custom fields on the learning program.
|
|
2106
|
+
type: object
|
|
2107
|
+
required: false
|
|
2108
|
+
properties:
|
|
2109
|
+
//:
|
|
2110
|
+
type: any
|
|
2111
|
+
learningProgramId:
|
|
2112
|
+
description: General type or level of instruction provided by the learning
|
|
2113
|
+
course.
|
|
2114
|
+
type: string
|
|
2115
|
+
required: false
|
|
2116
|
+
topLevelProgram:
|
|
2117
|
+
description: Applies only to learning programs. Identifies whether the
|
|
2118
|
+
learning program is a top-level program (true) or not (false).
|
|
2119
|
+
type: boolean
|
|
2120
|
+
required: false
|
|
2121
|
+
LearningProgramOutput:
|
|
2122
|
+
description: Represents information about one or more trainings in a program that’s
|
|
2123
|
+
required to obtain a credential.
|
|
2124
|
+
type: LearningOutput
|
|
2125
|
+
discriminatorValue: LearningProgram
|
|
2126
|
+
properties:
|
|
2127
|
+
learningProgramCustomFields:
|
|
2128
|
+
description: Learning Program custom fields.
|
|
2129
|
+
type: object
|
|
2130
|
+
required: false
|
|
2131
|
+
properties:
|
|
2132
|
+
//:
|
|
2133
|
+
type: any
|
|
2134
|
+
learningProgramId:
|
|
2135
|
+
description: Learning program id.
|
|
2136
|
+
type: string
|
|
2137
|
+
required: false
|
|
2138
|
+
productId:
|
|
2139
|
+
description: The product id associated with the learning program.
|
|
2140
|
+
type: string
|
|
2141
|
+
topLevelProgram:
|
|
2142
|
+
description: Applies only to learning programs. Identifies whether the learning
|
|
2143
|
+
program is a top-level program (true) or not (false).
|
|
2144
|
+
type: boolean
|
|
2145
|
+
required: false
|
|
2146
|
+
LearningProgramPlan:
|
|
2147
|
+
description: Learning program plan to be published.
|
|
2148
|
+
type: object
|
|
2149
|
+
properties:
|
|
2150
|
+
activeFromDate:
|
|
2151
|
+
description: Start date of the learning program plan's active period.
|
|
2152
|
+
type: string
|
|
2153
|
+
required: false
|
|
2154
|
+
activeToDate:
|
|
2155
|
+
description: End date of the learning program plan's active period.
|
|
2156
|
+
type: string
|
|
2157
|
+
required: false
|
|
2158
|
+
additionalFields:
|
|
2159
|
+
description: Custom field on the learning program plan.
|
|
2160
|
+
type: object
|
|
2161
|
+
required: false
|
|
2162
|
+
properties:
|
|
2163
|
+
//:
|
|
2164
|
+
type: object
|
|
2165
|
+
description:
|
|
2166
|
+
description: Description of the learning program plan.
|
|
2167
|
+
type: string
|
|
2168
|
+
required: false
|
|
2169
|
+
id:
|
|
2170
|
+
description: Identifier of the learning program plan.
|
|
2171
|
+
type: string
|
|
2172
|
+
isActive:
|
|
2173
|
+
description: Indicates whether the learning program plan is active.
|
|
2174
|
+
type: boolean
|
|
2175
|
+
required: false
|
|
2176
|
+
learningProgramId:
|
|
2177
|
+
description: Identifier of the related learning program.
|
|
2178
|
+
type: string
|
|
2179
|
+
minimumGradePointAvg:
|
|
2180
|
+
description: Minimum grade point average for the learning program plan.
|
|
2181
|
+
type: string
|
|
2182
|
+
required: false
|
|
2183
|
+
name:
|
|
2184
|
+
description: Name of the learning program plan.
|
|
2185
|
+
type: string
|
|
2186
|
+
required: false
|
|
2187
|
+
providerId:
|
|
2188
|
+
description: Provider's account identifier for learning program plan.
|
|
2189
|
+
type: string
|
|
2190
|
+
required: false
|
|
2191
|
+
versionNumber:
|
|
2192
|
+
description: Version number of the learning program plan.
|
|
2193
|
+
format: double
|
|
2194
|
+
type: number
|
|
2195
|
+
required: false
|
|
2196
|
+
LearningProgramPlanInputRepresentation:
|
|
2197
|
+
description: Input for the publication learning program plan request.
|
|
2198
|
+
type: object
|
|
2199
|
+
properties:
|
|
2200
|
+
learningProgramPlan:
|
|
2201
|
+
description: Learning program plan record.
|
|
2202
|
+
type: object
|
|
2203
|
+
requirement:
|
|
2204
|
+
description: List of requirements for the learning program plan.
|
|
2205
|
+
type: array
|
|
2206
|
+
items:
|
|
2207
|
+
type: Requirement
|
|
2208
|
+
LearningProgramPlanInputRepresentationData:
|
|
2209
|
+
description: A wrapper around LearningProgramPlanInputRepresentation.
|
|
2210
|
+
type: object
|
|
2211
|
+
properties:
|
|
2212
|
+
publishLearningProgramPlan:
|
|
2213
|
+
description: The Oas Body name for LearningProgramPlanInputRepresentation.
|
|
2214
|
+
type: LearningProgramPlanInputRepresentation
|
|
2215
|
+
LearningProgramPlanOutputRepresentation:
|
|
2216
|
+
description: Output representation from the Learning Program Plan operation
|
|
2217
|
+
type: object
|
|
2218
|
+
properties:
|
|
2219
|
+
learningProgramPlanId:
|
|
2220
|
+
description: Learning Program Plan Id created from the Learning Program Plan
|
|
2221
|
+
Builder.
|
|
2222
|
+
type: string
|
|
2223
|
+
LearningProgramPlanRequirement:
|
|
2224
|
+
description: Requirement for a learning program plan.
|
|
2225
|
+
type: object
|
|
2226
|
+
properties:
|
|
2227
|
+
additionalField:
|
|
2228
|
+
description: Custom field on the learning program plan requirement.
|
|
2229
|
+
type: object
|
|
2230
|
+
required: false
|
|
2231
|
+
properties:
|
|
2232
|
+
//:
|
|
2233
|
+
type: object
|
|
2234
|
+
category:
|
|
2235
|
+
description: Category of the learning program plan requirement.
|
|
2236
|
+
type: string
|
|
2237
|
+
required: false
|
|
2238
|
+
duration:
|
|
2239
|
+
description: Allocated duration to complete the learning program plan requirement.
|
|
2240
|
+
type: string
|
|
2241
|
+
required: false
|
|
2242
|
+
durationUnit:
|
|
2243
|
+
description: Unit of the allocated duration to complete the learning program
|
|
2244
|
+
plan requirement.
|
|
2245
|
+
type: string
|
|
2246
|
+
required: false
|
|
2247
|
+
name:
|
|
2248
|
+
description: Name of the learning program plan requirement.
|
|
2249
|
+
type: string
|
|
2250
|
+
LearningProgramPlanRequirementOutput:
|
|
2251
|
+
description: Output representation of Learning Program Plan Requirement.
|
|
2252
|
+
type: object
|
|
2253
|
+
properties:
|
|
2254
|
+
category:
|
|
2255
|
+
description: Program plan requirement category.
|
|
2256
|
+
type: string
|
|
2257
|
+
required: false
|
|
2258
|
+
displayName:
|
|
2259
|
+
description: Program plan requirement display name.
|
|
2260
|
+
type: string
|
|
2261
|
+
required: false
|
|
2262
|
+
duration:
|
|
2263
|
+
description: Program plan requirement duration.
|
|
2264
|
+
format: double
|
|
2265
|
+
type: number
|
|
2266
|
+
required: false
|
|
2267
|
+
durationUnit:
|
|
2268
|
+
description: Program plan requirement duration unit.
|
|
2269
|
+
type: string
|
|
2270
|
+
required: false
|
|
2271
|
+
fulfilledBy:
|
|
2272
|
+
description: Program plan requirement fulfilled by.
|
|
2273
|
+
type: array
|
|
2274
|
+
required: false
|
|
2275
|
+
items:
|
|
2276
|
+
type: LearningFulfiller
|
|
2277
|
+
groupName:
|
|
2278
|
+
description: The name of a group of courses.
|
|
2279
|
+
type: string
|
|
2280
|
+
required: false
|
|
2281
|
+
learningAchievementId:
|
|
2282
|
+
description: Program plan requirement learning achievement id.
|
|
2283
|
+
type: string
|
|
2284
|
+
required: false
|
|
2285
|
+
learningAchievementType:
|
|
2286
|
+
description: Program plan requirement learning achievement type.
|
|
2287
|
+
type: string
|
|
2288
|
+
required: false
|
|
2289
|
+
learningProgramPlanRequirementId:
|
|
2290
|
+
description: Program plan requirement id.
|
|
2291
|
+
type: string
|
|
2292
|
+
required: false
|
|
2293
|
+
name:
|
|
2294
|
+
description: Program plan requirement name.
|
|
2295
|
+
type: string
|
|
2296
|
+
required: false
|
|
2297
|
+
LearningStatus:
|
|
2298
|
+
description: Representation of Learning Status.
|
|
2299
|
+
type: object
|
|
2300
|
+
properties:
|
|
2301
|
+
academicSeason:
|
|
2302
|
+
description: The season in which this learning is taken or will be taken
|
|
2303
|
+
type: string
|
|
2304
|
+
required: false
|
|
2305
|
+
academicSessionId:
|
|
2306
|
+
description: Academic Session Id
|
|
2307
|
+
type: string
|
|
2308
|
+
required: false
|
|
2309
|
+
academicTermEnrollmentId:
|
|
2310
|
+
description: Specifies the ID for academic term enrollment.
|
|
2311
|
+
type: string
|
|
2312
|
+
required: false
|
|
2313
|
+
academicTermId:
|
|
2314
|
+
description: Specifies the ID for academic term.
|
|
2315
|
+
type: string
|
|
2316
|
+
required: false
|
|
2317
|
+
academicYear:
|
|
2318
|
+
description: The year in which this learning is taken or will be taken
|
|
2319
|
+
type: string
|
|
2320
|
+
required: false
|
|
2321
|
+
durationUnit:
|
|
2322
|
+
description: The unit of measurement for completion of the course
|
|
2323
|
+
type: string
|
|
2324
|
+
required: false
|
|
2325
|
+
learningId:
|
|
2326
|
+
description: Learning Id
|
|
2327
|
+
type: string
|
|
2328
|
+
required: false
|
|
2329
|
+
courseOfferingId:
|
|
2330
|
+
description: Learning course offering id.
|
|
2331
|
+
type: string
|
|
2332
|
+
courseOfferingParticipantId:
|
|
2333
|
+
description: Learning course offering participant id.
|
|
2334
|
+
type: string
|
|
2335
|
+
isAlternativeGradeRelated:
|
|
2336
|
+
description: Can be fulfilled by External Learning.
|
|
2337
|
+
type: boolean
|
|
2338
|
+
learningEquivalencies:
|
|
2339
|
+
description: List of equivalencies like Transfer credit, Work Equivalency, etc.
|
|
2340
|
+
type: array
|
|
2341
|
+
items:
|
|
2342
|
+
type: LearningEquivalency
|
|
2343
|
+
letterGrade:
|
|
2344
|
+
description: The letter grade awarded to the learner for completing the course
|
|
2345
|
+
type: string
|
|
2346
|
+
required: false
|
|
2347
|
+
mappedStatusDefinition:
|
|
2348
|
+
description: Specifies the List of values from Picklist values present in
|
|
2349
|
+
type: array
|
|
2350
|
+
items:
|
|
2351
|
+
type: string
|
|
2352
|
+
numericGrade:
|
|
2353
|
+
description: The numeric grade awarded to the learner for completing the course
|
|
2354
|
+
format: double
|
|
2355
|
+
type: number
|
|
2356
|
+
required: false
|
|
2357
|
+
participantStatusValue:
|
|
2358
|
+
description: Specifies the default Picklist definition
|
|
2359
|
+
type: string
|
|
2360
|
+
resultStatus:
|
|
2361
|
+
description: Specifies the type or status of the learner's result. For example,
|
|
2362
|
+
Pass or Fail.
|
|
2363
|
+
type: string
|
|
2364
|
+
required: false
|
|
2365
|
+
status:
|
|
2366
|
+
description: Learning status - Completed, Enrolled, Planned, Unplanned
|
|
2367
|
+
type: string
|
|
2368
|
+
required: false
|
|
2369
|
+
unitsEarned:
|
|
2370
|
+
description: The units of value awarded for completing the course
|
|
2371
|
+
format: double
|
|
2372
|
+
type: number
|
|
2373
|
+
required: false
|
|
2374
|
+
LearningEquivalency:
|
|
2375
|
+
description: Equivalency like Transfer credit, Work Equivalency, etc.
|
|
2376
|
+
type: object
|
|
2377
|
+
properties:
|
|
2378
|
+
equivalencyName:
|
|
2379
|
+
description: Name of the Equivalency
|
|
2380
|
+
type: string
|
|
2381
|
+
required: false
|
|
2382
|
+
equivalencyId:
|
|
2383
|
+
description: ID of the Equivalency
|
|
2384
|
+
type: string
|
|
2385
|
+
required: false
|
|
2386
|
+
typeLabel:
|
|
2387
|
+
description: type of the Equivalency
|
|
2388
|
+
type: string
|
|
2389
|
+
required: false
|
|
2390
|
+
MentoringBenefitAssignment:
|
|
2391
|
+
description: Representation of the benefit assignment record updated with provider information.
|
|
2392
|
+
type: object
|
|
2393
|
+
properties:
|
|
2394
|
+
benefitId:
|
|
2395
|
+
description: The ID of the benefit associated with the benefit assignment.
|
|
2396
|
+
type: string
|
|
2397
|
+
required: false
|
|
2398
|
+
providerId:
|
|
2399
|
+
description: The contact ID of the provider associated with the benefit assignment.
|
|
2400
|
+
type: string
|
|
2401
|
+
required: false
|
|
2402
|
+
createdById:
|
|
2403
|
+
description: The ID of the user who created the benefit assignment.
|
|
2404
|
+
type: string
|
|
2405
|
+
required: false
|
|
2406
|
+
createdDate:
|
|
2407
|
+
description: The date that the benefit assignment was created.
|
|
2408
|
+
type: string
|
|
2409
|
+
required: false
|
|
2410
|
+
endDateTime:
|
|
2411
|
+
description: The last date and time that the benefit assignment is available.
|
|
2412
|
+
type: string
|
|
2413
|
+
required: false
|
|
2414
|
+
enrolleeId:
|
|
2415
|
+
description: The ID of the enrollee assoicated with the benefit assignment.
|
|
2416
|
+
type: string
|
|
2417
|
+
required: false
|
|
2418
|
+
enrollmentCount:
|
|
2419
|
+
description: The default quantity associated with the benefit assignment.
|
|
2420
|
+
type: string
|
|
2421
|
+
required: false
|
|
2422
|
+
entitlementAmount:
|
|
2423
|
+
description: The amount of the entitlement associated with the benefit assignment.
|
|
2424
|
+
type: string
|
|
2425
|
+
required: false
|
|
2426
|
+
id:
|
|
2427
|
+
description: The ID of the benefit assignment.
|
|
2428
|
+
type: string
|
|
2429
|
+
lastModifiedById:
|
|
2430
|
+
description: The ID of the user who updated the benefit assignment.
|
|
2431
|
+
type: string
|
|
2432
|
+
required: false
|
|
2433
|
+
lastModifiedDate:
|
|
2434
|
+
description: The date of the most recent update to the benefit assignment.
|
|
2435
|
+
type: string
|
|
2436
|
+
required: false
|
|
2437
|
+
maximumBenefitAmount:
|
|
2438
|
+
description: The maximum amount of the benefit associated with the benefit
|
|
2439
|
+
assignment.
|
|
2440
|
+
type: string
|
|
2441
|
+
required: false
|
|
2442
|
+
minimumBenefitAmount:
|
|
2443
|
+
description: The minimum amount of the benefit associated with the benefit.
|
|
2444
|
+
type: string
|
|
2445
|
+
required: false
|
|
2446
|
+
name:
|
|
2447
|
+
description: The name of the benefit assignment.
|
|
2448
|
+
type: string
|
|
2449
|
+
required: false
|
|
2450
|
+
parentRecordId:
|
|
2451
|
+
description: The ID of the parent record associated with the benefit assignment.
|
|
2452
|
+
type: string
|
|
2453
|
+
required: false
|
|
2454
|
+
priority:
|
|
2455
|
+
description: The priority associated with the benefit assignment.
|
|
2456
|
+
type: string
|
|
2457
|
+
required: false
|
|
2458
|
+
programEnrollmentId:
|
|
2459
|
+
description: The ID of the program enrollment created for the participant
|
|
2460
|
+
to whom you want to assign this benefit.
|
|
2461
|
+
type: string
|
|
2462
|
+
required: false
|
|
2463
|
+
startDateTime:
|
|
2464
|
+
description: The date and time when the benefit assignment is first available.
|
|
2465
|
+
type: string
|
|
2466
|
+
required: false
|
|
2467
|
+
status:
|
|
2468
|
+
description: The status associated with the benefit assignment.
|
|
2469
|
+
type: string
|
|
2470
|
+
required: false
|
|
2471
|
+
taskJobStatus:
|
|
2472
|
+
description: The status of the task job associated with the benefit assignment.
|
|
2473
|
+
type: string
|
|
2474
|
+
required: false
|
|
2475
|
+
taskJobStatusMessage:
|
|
2476
|
+
description: The status message of the task job associated with the benefit
|
|
2477
|
+
assignment.
|
|
2478
|
+
type: string
|
|
2479
|
+
required: false
|
|
2480
|
+
unitOfMeasureId:
|
|
2481
|
+
description: The ID of the unit of measure associated with the benefit assignment.
|
|
2482
|
+
type: string
|
|
2483
|
+
required: false
|
|
2484
|
+
MentoringBenefitAssignmentInputRepresentation:
|
|
2485
|
+
description: Representation of the input for the benefit assignment request.
|
|
2486
|
+
type: object
|
|
2487
|
+
properties:
|
|
2488
|
+
providerId:
|
|
2489
|
+
description: The ID of the provider associated with the benefit assignment.
|
|
2490
|
+
type: string
|
|
2491
|
+
MentoringBenefitAssignmentOutputRepresentation:
|
|
2492
|
+
description: Representation of the output for the benefit assignment request.
|
|
2493
|
+
type: object
|
|
2494
|
+
properties:
|
|
2495
|
+
mentoringBenefitAssignment:
|
|
2496
|
+
description: The benefit assignment record that contains provider
|
|
2497
|
+
information.
|
|
2498
|
+
type: MentoringBenefitAssignment
|
|
2499
|
+
MentoringMatchingSelectorInputRepresentation:
|
|
2500
|
+
description: Representation of the input for the matching selector request.
|
|
2501
|
+
type: object
|
|
2502
|
+
properties:
|
|
2503
|
+
filtersConfig:
|
|
2504
|
+
description: The filters to apply to the Mentoring Profiles query
|
|
2505
|
+
type: array
|
|
2506
|
+
items:
|
|
2507
|
+
type: FilterConfig
|
|
2508
|
+
MentoringMatchingSelectorOutputRepresentation:
|
|
2509
|
+
description: Output representation of mentoring matching selector
|
|
2510
|
+
type: object
|
|
2511
|
+
properties:
|
|
2512
|
+
mentoringProfiles:
|
|
2513
|
+
description: List of mentoring profiles
|
|
2514
|
+
type: array
|
|
2515
|
+
items:
|
|
2516
|
+
type: MentoringProfileOption
|
|
2517
|
+
MentoringProfileOption:
|
|
2518
|
+
description: The Mentoring Profile record that contains contact information
|
|
2519
|
+
type: object
|
|
2520
|
+
properties:
|
|
2521
|
+
id:
|
|
2522
|
+
description: The ID of the mentoring profile
|
|
2523
|
+
type: string
|
|
2524
|
+
NewApplicationPreliminaryDataOutputRepresentation:
|
|
2525
|
+
description: Output of the get new application preliminary data request.
|
|
2526
|
+
type: object
|
|
2527
|
+
properties:
|
|
2528
|
+
result:
|
|
2529
|
+
description: Preliminary data that's used for creating a new Preliminary Application
|
|
2530
|
+
Reference.
|
|
2531
|
+
type: GetNewApplicationPreliminaryDataResult
|
|
2532
|
+
required: false
|
|
2533
|
+
PersonPublicProfileInformation:
|
|
2534
|
+
description: Set of user data, for example the name, photo, academic year, degree,
|
|
2535
|
+
location, or pronouns.
|
|
2536
|
+
type: object
|
|
2537
|
+
properties:
|
|
2538
|
+
credentialName:
|
|
2539
|
+
description: Field of study chosen by the user, shown in their education record.
|
|
2540
|
+
type: string
|
|
2541
|
+
required: false
|
|
2542
|
+
credentialType:
|
|
2543
|
+
description: Education level in the user's field of study.
|
|
2544
|
+
type: string
|
|
2545
|
+
required: false
|
|
2546
|
+
currentLocation:
|
|
2547
|
+
description: Current location of the user.
|
|
2548
|
+
type: string
|
|
2549
|
+
required: false
|
|
2550
|
+
name:
|
|
2551
|
+
description: Preferred name set by the user.
|
|
2552
|
+
type: string
|
|
2553
|
+
required: false
|
|
2554
|
+
photoUrl:
|
|
2555
|
+
description: URL of the user's photo.
|
|
2556
|
+
type: string
|
|
2557
|
+
required: false
|
|
2558
|
+
pronouns:
|
|
2559
|
+
description: Pronouns set by the user.
|
|
2560
|
+
type: string
|
|
2561
|
+
required: false
|
|
2562
|
+
yearAchieved:
|
|
2563
|
+
description: 'Academic year in which the user graduated. '
|
|
2564
|
+
type: string
|
|
2565
|
+
required: false
|
|
2566
|
+
PersonPublicProfileOutputRepresentation:
|
|
2567
|
+
description: Output of the get person public profile request.
|
|
2568
|
+
type: object
|
|
2569
|
+
properties:
|
|
2570
|
+
academicCredential:
|
|
2571
|
+
description: List of the user's academic credentials.
|
|
2572
|
+
type: array
|
|
2573
|
+
required: false
|
|
2574
|
+
items:
|
|
2575
|
+
type: AcademicCredential
|
|
2576
|
+
additionalEducation:
|
|
2577
|
+
description: List of the user education qualifications, shown in their additional
|
|
2578
|
+
education history.
|
|
2579
|
+
type: array
|
|
2580
|
+
required: false
|
|
2581
|
+
items:
|
|
2582
|
+
type: AdditionalEducation
|
|
2583
|
+
contactInformation:
|
|
2584
|
+
description: Contact information of the user, for example their email, phone,
|
|
2585
|
+
or website URL.
|
|
2586
|
+
type: ContactInformation
|
|
2587
|
+
required: false
|
|
2588
|
+
personPublicProfileInformation:
|
|
2589
|
+
description: Set of user data, for example the name, photo, academic year,
|
|
2590
|
+
degree, location, or pronouns.
|
|
2591
|
+
type: PersonPublicProfileInformation
|
|
2592
|
+
required: false
|
|
2593
|
+
professionalExperience:
|
|
2594
|
+
description: List of the user's professional experiences.
|
|
2595
|
+
type: array
|
|
2596
|
+
required: false
|
|
2597
|
+
items:
|
|
2598
|
+
type: ProfessionalExperience
|
|
2599
|
+
summary:
|
|
2600
|
+
description: Description provided by the user for their profile.
|
|
2601
|
+
type: string
|
|
2602
|
+
required: false
|
|
2603
|
+
PreliminaryApplicationReferencesInputListWrapper:
|
|
2604
|
+
description: List Wrapper of program term application timeline Ids.
|
|
2605
|
+
type: object
|
|
2606
|
+
properties:
|
|
2607
|
+
programTrmAppTmlnIds:
|
|
2608
|
+
description: List of IDs for the program term application timelines associated
|
|
2609
|
+
with the preliminary application references.
|
|
2610
|
+
type: array
|
|
2611
|
+
items:
|
|
2612
|
+
type: string
|
|
2613
|
+
PreliminaryApplicationReferencesInputRepresentation:
|
|
2614
|
+
description: Representation of the input for the save preliminary application
|
|
2615
|
+
reference request.
|
|
2616
|
+
type: object
|
|
2617
|
+
properties:
|
|
2618
|
+
applicantId:
|
|
2619
|
+
description: The ID of the contact record associated with the applicant.
|
|
2620
|
+
type: string
|
|
2621
|
+
programTrmAppTmlnListWrapper:
|
|
2622
|
+
description: List of IDs for the program term application timelines associated
|
|
2623
|
+
with the preliminary application references.
|
|
2624
|
+
type: array
|
|
2625
|
+
items:
|
|
2626
|
+
type: string
|
|
2627
|
+
PreliminaryApplicationReferencesInputInputWrapperRepresentation:
|
|
2628
|
+
#TODO Hand rolled due to W-8334626
|
|
2629
|
+
description: Wrapper for the save preliminary application reference input representation
|
|
2630
|
+
type: object
|
|
2631
|
+
properties:
|
|
2632
|
+
preliminaryAppRefInput:
|
|
2633
|
+
type: PreliminaryApplicationReferencesInputRepresentation
|
|
2634
|
+
description: Preliminary application reference input representation
|
|
2635
|
+
PreliminaryApplicationReferencesOutputRepresentation:
|
|
2636
|
+
description: Representation of the output for the save preliminary application
|
|
2637
|
+
reference request.
|
|
2638
|
+
type: object
|
|
2639
|
+
properties:
|
|
2640
|
+
message:
|
|
2641
|
+
description: The message that's displayed after successfully creating preliminary
|
|
2642
|
+
application references.
|
|
2643
|
+
type: string
|
|
2644
|
+
preliminaryAppRefIds:
|
|
2645
|
+
description: List of IDs for the preliminary application references that were
|
|
2646
|
+
created.
|
|
2647
|
+
type: array
|
|
2648
|
+
required: false
|
|
2649
|
+
items:
|
|
2650
|
+
type: string
|
|
2651
|
+
success:
|
|
2652
|
+
description: Indicates if the request was successful (true) or not (false).
|
|
2653
|
+
type: boolean
|
|
2654
|
+
required: false
|
|
2655
|
+
PreviewLearningProgramPlanOutputRepresentation:
|
|
2656
|
+
description: Output representation for Learning Program Plan Preview.
|
|
2657
|
+
type: object
|
|
2658
|
+
properties:
|
|
2659
|
+
description:
|
|
2660
|
+
description: Learning program plan result description.
|
|
2661
|
+
type: string
|
|
2662
|
+
required: false
|
|
2663
|
+
learningProgramPlanId:
|
|
2664
|
+
description: Learning program plan id.
|
|
2665
|
+
type: string
|
|
2666
|
+
name:
|
|
2667
|
+
description: Learning program plan result name.
|
|
2668
|
+
type: string
|
|
2669
|
+
required: false
|
|
2670
|
+
programPlanRequirements:
|
|
2671
|
+
description: List of program plan requirements.
|
|
2672
|
+
type: array
|
|
2673
|
+
required: false
|
|
2674
|
+
items:
|
|
2675
|
+
type: LearningProgramPlanRequirementOutput
|
|
2676
|
+
ProfessionalExperience:
|
|
2677
|
+
description: List of the user's professional experiences.
|
|
2678
|
+
type: object
|
|
2679
|
+
properties:
|
|
2680
|
+
city:
|
|
2681
|
+
description: City of the user's job position.
|
|
2682
|
+
type: string
|
|
2683
|
+
required: false
|
|
2684
|
+
country:
|
|
2685
|
+
description: Country of the user's job position.
|
|
2686
|
+
type: string
|
|
2687
|
+
required: false
|
|
2688
|
+
employer:
|
|
2689
|
+
description: Current or former employer of the user.
|
|
2690
|
+
type: string
|
|
2691
|
+
required: false
|
|
2692
|
+
endDate:
|
|
2693
|
+
description: End date of the user's job position.
|
|
2694
|
+
type: string
|
|
2695
|
+
required: false
|
|
2696
|
+
position:
|
|
2697
|
+
description: Job position of the user.
|
|
2698
|
+
type: string
|
|
2699
|
+
required: false
|
|
2700
|
+
startDate:
|
|
2701
|
+
description: Start date of the user's job position.
|
|
2702
|
+
type: string
|
|
2703
|
+
required: false
|
|
2704
|
+
state:
|
|
2705
|
+
description: State of the user's job position.
|
|
2706
|
+
type: string
|
|
2707
|
+
required: false
|
|
2708
|
+
ProgramTermApplicationTimeline:
|
|
2709
|
+
description: Representation of the program term application timeline.
|
|
2710
|
+
type: object
|
|
2711
|
+
properties:
|
|
2712
|
+
applicationCategory:
|
|
2713
|
+
description: The application category value from the associated application
|
|
2714
|
+
timeline.
|
|
2715
|
+
type: string
|
|
2716
|
+
required: false
|
|
2717
|
+
programName:
|
|
2718
|
+
description: The name of the learning program associated with the program
|
|
2719
|
+
term application timeline.
|
|
2720
|
+
type: string
|
|
2721
|
+
required: false
|
|
2722
|
+
programTrmAppTmlnId:
|
|
2723
|
+
description: The ID of the program term application timeline.
|
|
2724
|
+
type: string
|
|
2725
|
+
required: false
|
|
2726
|
+
ProgramTermApplicationTimelineOutputRepresentation:
|
|
2727
|
+
description: Representation of the output for the program term application timeline
|
|
2728
|
+
request.
|
|
2729
|
+
type: object
|
|
2730
|
+
properties:
|
|
2731
|
+
programs:
|
|
2732
|
+
description: List of program term application timelines.
|
|
2733
|
+
type: array
|
|
2734
|
+
required: false
|
|
2735
|
+
items:
|
|
2736
|
+
type: ProgramTermApplicationTimeline
|
|
2737
|
+
RequiredCourseRequirement:
|
|
2738
|
+
description: Required course requirements to complete the learning program plan.
|
|
2739
|
+
type: Requirement
|
|
2740
|
+
properties:
|
|
2741
|
+
learningId:
|
|
2742
|
+
description: Learning identifiers of the learning program plan requirement.
|
|
2743
|
+
Elective types have one or more.
|
|
2744
|
+
type: string
|
|
2745
|
+
Requirement:
|
|
2746
|
+
description: Requirements to complete the learning program plan.
|
|
2747
|
+
discriminator: type
|
|
2748
|
+
type: object
|
|
2749
|
+
properties:
|
|
2750
|
+
learningProgramPlanRequirement:
|
|
2751
|
+
description: Learning program plan requirement record.
|
|
2752
|
+
type: object
|
|
2753
|
+
type:
|
|
2754
|
+
description: 'Type of requirement for the learning program plan. Possible
|
|
2755
|
+
values: Elective, Required, or Reusable_Collection.'
|
|
2756
|
+
type: string
|
|
2757
|
+
enum:
|
|
2758
|
+
- Elective
|
|
2759
|
+
- Required
|
|
2760
|
+
- Reusable_Collection
|
|
2761
|
+
RequirementDuration:
|
|
2762
|
+
description: Representation of requirement duration.
|
|
2763
|
+
type: object
|
|
2764
|
+
properties:
|
|
2765
|
+
completed:
|
|
2766
|
+
description: Completed requirement duration
|
|
2767
|
+
format: double
|
|
2768
|
+
type: number
|
|
2769
|
+
required: false
|
|
2770
|
+
enrolled:
|
|
2771
|
+
description: Enrolled requirement duration
|
|
2772
|
+
format: double
|
|
2773
|
+
type: number
|
|
2774
|
+
required: false
|
|
2775
|
+
planned:
|
|
2776
|
+
description: Planned requirement duration
|
|
2777
|
+
format: double
|
|
2778
|
+
type: number
|
|
2779
|
+
required: false
|
|
2780
|
+
required:
|
|
2781
|
+
description: Required requirement duration
|
|
2782
|
+
format: double
|
|
2783
|
+
type: number
|
|
2784
|
+
required: false
|
|
2785
|
+
unplanned:
|
|
2786
|
+
description: Unplanned requirement duration
|
|
2787
|
+
format: double
|
|
2788
|
+
type: number
|
|
2789
|
+
required: false
|
|
2790
|
+
RequirementUpdateItem:
|
|
2791
|
+
description: Requirements - prerequisites, corequisites, recommendations during
|
|
2792
|
+
the update.
|
|
2793
|
+
type: object
|
|
2794
|
+
properties:
|
|
2795
|
+
createRecords:
|
|
2796
|
+
description: Requirements - prerequisites, corequisites, recommendations to
|
|
2797
|
+
be created during the update.
|
|
2798
|
+
type: array
|
|
2799
|
+
required: false
|
|
2800
|
+
items:
|
|
2801
|
+
type: object
|
|
2802
|
+
deleteRecords:
|
|
2803
|
+
description: Requirements - prerequisites, corequisites, recommendations to
|
|
2804
|
+
be deleted during the update.
|
|
2805
|
+
type: array
|
|
2806
|
+
required: false
|
|
2807
|
+
items:
|
|
2808
|
+
type: string
|
|
2809
|
+
ReusableCollectionRequirement:
|
|
2810
|
+
description: Reusable collection requirements to complete the learning program plan.
|
|
2811
|
+
type: Requirement
|
|
2812
|
+
properties:
|
|
2813
|
+
learningAchievementId:
|
|
2814
|
+
description: The existing learning achievement, which is required for the completion of this program plan
|
|
2815
|
+
type: string
|
|
2816
|
+
ServiceAppointment:
|
|
2817
|
+
description: Representation of the service appointment.
|
|
2818
|
+
type: object
|
|
2819
|
+
properties:
|
|
2820
|
+
appointmentDate:
|
|
2821
|
+
description: The date of the last service appointment.
|
|
2822
|
+
type: string
|
|
2823
|
+
required: false
|
|
2824
|
+
serviceAppointmentId:
|
|
2825
|
+
description: The ID of the last service appointment.
|
|
2826
|
+
type: string
|
|
2827
|
+
required: false
|
|
2828
|
+
workTypeId:
|
|
2829
|
+
description: The work type ID of the last service appointment.
|
|
2830
|
+
type: string
|
|
2831
|
+
required: false
|
|
2832
|
+
workTypeName:
|
|
2833
|
+
description: The work type name of the last service appointment.
|
|
2834
|
+
type: string
|
|
2835
|
+
required: false
|
|
2836
|
+
ServiceLocation:
|
|
2837
|
+
description: Representation of the service location result.
|
|
2838
|
+
type: object
|
|
2839
|
+
properties:
|
|
2840
|
+
name:
|
|
2841
|
+
description: The name of a service location in a service territory.
|
|
2842
|
+
type: string
|
|
2843
|
+
required: false
|
|
2844
|
+
parentLocations:
|
|
2845
|
+
description: List of parent locations associated with a location.
|
|
2846
|
+
type: array
|
|
2847
|
+
required: false
|
|
2848
|
+
items:
|
|
2849
|
+
type: string
|
|
2850
|
+
SharedAchievementMapping:
|
|
2851
|
+
description: A mapping which will generate new Achievements corresponding to the
|
|
2852
|
+
provided achievement contributors
|
|
2853
|
+
type: AbstractAchievementMapping
|
|
2854
|
+
properties:
|
|
2855
|
+
achievementContributors:
|
|
2856
|
+
description: Achievement contributors that fulfill the achievement requirement.
|
|
2857
|
+
type: array
|
|
2858
|
+
items:
|
|
2859
|
+
type: object
|
|
2860
|
+
SkillAchievementMapping:
|
|
2861
|
+
description: A mapping that corresponds to an existing skill or one that needs to be created as a Learning Achievement
|
|
2862
|
+
type: AbstractAchievementMapping
|
|
2863
|
+
properties:
|
|
2864
|
+
description:
|
|
2865
|
+
description: Description of the skill and the learning achievement
|
|
2866
|
+
type: string
|
|
2867
|
+
learningAchievementId:
|
|
2868
|
+
description: The ID of the learning achievement that fulfills this skill achievement
|
|
2869
|
+
type: string
|
|
2870
|
+
required: false
|
|
2871
|
+
name:
|
|
2872
|
+
description: Name of the skill and the learning achievement
|
|
2873
|
+
type: string
|
|
2874
|
+
Submitter:
|
|
2875
|
+
description: Representation of the related submitters result.
|
|
2876
|
+
type: object
|
|
2877
|
+
properties:
|
|
2878
|
+
contactId:
|
|
2879
|
+
description: The ID of the Contact record for the submitter of an application..
|
|
2880
|
+
type: string
|
|
2881
|
+
required: false
|
|
2882
|
+
name:
|
|
2883
|
+
description: The full name from the Contact record for the submitter of an
|
|
2884
|
+
application.
|
|
2885
|
+
type: string
|
|
2886
|
+
required: false
|
|
2887
|
+
SuccessTeamOutputRepresentation:
|
|
2888
|
+
description: Output of the get success team request.
|
|
2889
|
+
type: object
|
|
2890
|
+
properties:
|
|
2891
|
+
result:
|
|
2892
|
+
description: Staff members and teams who are available to support the associated
|
|
2893
|
+
account.
|
|
2894
|
+
type: GetSuccessTeamResult
|
|
2895
|
+
Task:
|
|
2896
|
+
description: Representation of the Task
|
|
2897
|
+
type: object
|
|
2898
|
+
properties:
|
|
2899
|
+
completedDate:
|
|
2900
|
+
description: Completed date of the task
|
|
2901
|
+
type: string
|
|
2902
|
+
required: false
|
|
2903
|
+
createdDate:
|
|
2904
|
+
description: Created date of the task
|
|
2905
|
+
type: string
|
|
2906
|
+
required: false
|
|
2907
|
+
description:
|
|
2908
|
+
description: Description of the task
|
|
2909
|
+
type: string
|
|
2910
|
+
required: false
|
|
2911
|
+
dueDate:
|
|
2912
|
+
description: Due date of the task
|
|
2913
|
+
type: string
|
|
2914
|
+
required: false
|
|
2915
|
+
id:
|
|
2916
|
+
description: ID of the task
|
|
2917
|
+
type: string
|
|
2918
|
+
required: true
|
|
2919
|
+
priority:
|
|
2920
|
+
description: Priority of the task
|
|
2921
|
+
type: string
|
|
2922
|
+
required: false
|
|
2923
|
+
relatedTo:
|
|
2924
|
+
description: Related entity of the task
|
|
2925
|
+
type: string
|
|
2926
|
+
required: false
|
|
2927
|
+
status:
|
|
2928
|
+
description: Status of the task
|
|
2929
|
+
type: string
|
|
2930
|
+
required: false
|
|
2931
|
+
subject:
|
|
2932
|
+
description: Subject of the task
|
|
2933
|
+
type: string
|
|
2934
|
+
required: false
|
|
2935
|
+
taskParentName:
|
|
2936
|
+
description: Name of the entity record to which this task belongs to
|
|
2937
|
+
type: string
|
|
2938
|
+
required: false
|
|
2939
|
+
TaskInputRepresentation:
|
|
2940
|
+
description: Input representation for Task
|
|
2941
|
+
type: object
|
|
2942
|
+
properties:
|
|
2943
|
+
description:
|
|
2944
|
+
description: Task object description
|
|
2945
|
+
type: string
|
|
2946
|
+
required: false
|
|
2947
|
+
dueDate:
|
|
2948
|
+
description: Task object due date
|
|
2949
|
+
type: string
|
|
2950
|
+
required: false
|
|
2951
|
+
ownerId:
|
|
2952
|
+
description: Task object owner
|
|
2953
|
+
type: string
|
|
2954
|
+
required: false
|
|
2955
|
+
priority:
|
|
2956
|
+
description: Task object priority
|
|
2957
|
+
type: string
|
|
2958
|
+
required: false
|
|
2959
|
+
relatedToId:
|
|
2960
|
+
description: Task object related to object
|
|
2961
|
+
type: string
|
|
2962
|
+
required: false
|
|
2963
|
+
status:
|
|
2964
|
+
description: Task object status
|
|
2965
|
+
type: string
|
|
2966
|
+
required: false
|
|
2967
|
+
subject:
|
|
2968
|
+
description: Task object subject
|
|
2969
|
+
type: string
|
|
2970
|
+
required: false
|
|
2971
|
+
whoId:
|
|
2972
|
+
description: Task object name
|
|
2973
|
+
type: string
|
|
2974
|
+
required: false
|
|
2975
|
+
TaskPicklistOutputRepresentation:
|
|
2976
|
+
description: Representation of the Task Picklists
|
|
2977
|
+
type: object
|
|
2978
|
+
properties:
|
|
2979
|
+
taskPriorities:
|
|
2980
|
+
description: List of Task priority values
|
|
2981
|
+
type: array
|
|
2982
|
+
required: false
|
|
2983
|
+
items:
|
|
2984
|
+
type: TaskPriority
|
|
2985
|
+
taskStatuses:
|
|
2986
|
+
description: List of TaskStatus values
|
|
2987
|
+
type: array
|
|
2988
|
+
required: false
|
|
2989
|
+
items:
|
|
2990
|
+
type: TaskStatus
|
|
2991
|
+
TaskPriority:
|
|
2992
|
+
description: Representation of the Task Priority
|
|
2993
|
+
type: object
|
|
2994
|
+
properties:
|
|
2995
|
+
apiName:
|
|
2996
|
+
description: Api name for the priority value
|
|
2997
|
+
type: string
|
|
2998
|
+
isDefault:
|
|
2999
|
+
description: Whether this priority value is default
|
|
3000
|
+
type: boolean
|
|
3001
|
+
masterLabel:
|
|
3002
|
+
description: Master label for the priority value
|
|
3003
|
+
type: string
|
|
3004
|
+
TaskStatus:
|
|
3005
|
+
description: Representation of the Task status
|
|
3006
|
+
type: object
|
|
3007
|
+
properties:
|
|
3008
|
+
isClosed:
|
|
3009
|
+
description: Closed status for the status value
|
|
3010
|
+
type: boolean
|
|
3011
|
+
isDefault:
|
|
3012
|
+
description: Whether this is the default status
|
|
3013
|
+
type: boolean
|
|
3014
|
+
masterLabel:
|
|
3015
|
+
description: Master label for the status value
|
|
3016
|
+
type: string
|
|
3017
|
+
TimeSlot:
|
|
3018
|
+
description: Representation of the time slot.
|
|
3019
|
+
type: object
|
|
3020
|
+
properties:
|
|
3021
|
+
endTime:
|
|
3022
|
+
description: The date and time that the time slot ends.
|
|
3023
|
+
type: string
|
|
3024
|
+
required: false
|
|
3025
|
+
engagementChannelTypeId:
|
|
3026
|
+
description: The engagement channel type of the time slot
|
|
3027
|
+
type: string
|
|
3028
|
+
required: false
|
|
3029
|
+
serviceResourceId:
|
|
3030
|
+
description: ID of the service resource that's associated with the time slot.
|
|
3031
|
+
type: string
|
|
3032
|
+
required: false
|
|
3033
|
+
serviceTerritoryId:
|
|
3034
|
+
description: ID of the service territory that's associated with the time slot.
|
|
3035
|
+
type: string
|
|
3036
|
+
required: false
|
|
3037
|
+
startTime:
|
|
3038
|
+
description: The date and time that the time slot starts.
|
|
3039
|
+
type: string
|
|
3040
|
+
required: false
|
|
3041
|
+
UpdateLearningsInputRepresentation:
|
|
3042
|
+
description: Provides details of the request to update learnings.
|
|
3043
|
+
type: object
|
|
3044
|
+
properties:
|
|
3045
|
+
learnings:
|
|
3046
|
+
description: Provides details of the request to update learnings.
|
|
3047
|
+
type: array
|
|
3048
|
+
items:
|
|
3049
|
+
type: any
|
|
3050
|
+
UpdateLearningInputRepresentation:
|
|
3051
|
+
description: Input wrapper containing the Learning alongside related outcomes
|
|
3052
|
+
& foundations for the update
|
|
3053
|
+
type: object
|
|
3054
|
+
properties:
|
|
3055
|
+
corequisites:
|
|
3056
|
+
description: Requirement update item which is part of the corequisite set
|
|
3057
|
+
type: object
|
|
3058
|
+
required: false
|
|
3059
|
+
learning:
|
|
3060
|
+
description: Learning record to be updated.
|
|
3061
|
+
type: object
|
|
3062
|
+
learningPolicyRules:
|
|
3063
|
+
description: List of Learning Policy Rules that are part of learning
|
|
3064
|
+
type: array
|
|
3065
|
+
items:
|
|
3066
|
+
type: LearningPolicyRuleUpdate
|
|
3067
|
+
outcomes:
|
|
3068
|
+
description: List of AchievementMappings which are part of the outcomes set
|
|
3069
|
+
type: array
|
|
3070
|
+
required: false
|
|
3071
|
+
items:
|
|
3072
|
+
type: object
|
|
3073
|
+
prerequisites:
|
|
3074
|
+
description: Requirement update item which is part of the prerequisite set
|
|
3075
|
+
type: object
|
|
3076
|
+
required: false
|
|
3077
|
+
recommended:
|
|
3078
|
+
description: Requirement update item which is part of the recommended set
|
|
3079
|
+
type: object
|
|
3080
|
+
required: false
|
|
3081
|
+
linked:
|
|
3082
|
+
description: Requirement update item which is part of the linked set
|
|
3083
|
+
type: RequirementUpdateItem
|
|
3084
|
+
required: false
|
|
3085
|
+
preOrCorequisites:
|
|
3086
|
+
description: Requirement update item which is part of the prerequisite or co-requisite set
|
|
3087
|
+
type: RequirementUpdateItem
|
|
3088
|
+
required: false
|
|
3089
|
+
WorkType:
|
|
3090
|
+
description: Representation of the work type.
|
|
3091
|
+
type: object
|
|
3092
|
+
properties:
|
|
3093
|
+
workDurationType:
|
|
3094
|
+
description: The units of time for the completion of the work.
|
|
3095
|
+
type: string
|
|
3096
|
+
required: false
|
|
3097
|
+
workEstimatedDuration:
|
|
3098
|
+
description: The length of time allocated for the completion of the work.
|
|
3099
|
+
format: double
|
|
3100
|
+
type: number
|
|
3101
|
+
required: false
|
|
3102
|
+
workTypeId:
|
|
3103
|
+
description: The ID of the type of work to be performed.
|
|
3104
|
+
type: string
|
|
3105
|
+
required: false
|
|
3106
|
+
/connect/education:
|
|
3107
|
+
/academic-operations/learnings/{recordId}:
|
|
3108
|
+
get:
|
|
3109
|
+
displayName: getLearning
|
|
3110
|
+
description: Get learning, achievements and their associations for Education
|
|
3111
|
+
Cloud
|
|
3112
|
+
responses:
|
|
3113
|
+
'200':
|
|
3114
|
+
description: Success
|
|
3115
|
+
body:
|
|
3116
|
+
application/json:
|
|
3117
|
+
type: GetLearningOutputRepresentation
|
|
3118
|
+
queryParameters:
|
|
3119
|
+
course_external_id_field:
|
|
3120
|
+
description: Learning course external ID field name
|
|
3121
|
+
type: string
|
|
3122
|
+
required: false
|
|
3123
|
+
program_external_id_field:
|
|
3124
|
+
description: Learning program external ID field name
|
|
3125
|
+
type: string
|
|
3126
|
+
required: false
|
|
3127
|
+
uriParameters:
|
|
3128
|
+
recordId:
|
|
3129
|
+
description: Specifies a learning ID or an external ID
|
|
3130
|
+
type: string
|
|
3131
|
+
required: true
|
|
3132
|
+
/academic-operations:
|
|
3133
|
+
/learnings:
|
|
3134
|
+
post:
|
|
3135
|
+
displayName: createLearnings
|
|
3136
|
+
description: Create learnings, achievements and their associations for Education
|
|
3137
|
+
Cloud
|
|
3138
|
+
responses:
|
|
3139
|
+
'200':
|
|
3140
|
+
description: Success
|
|
3141
|
+
body:
|
|
3142
|
+
application/json:
|
|
3143
|
+
type: CreateLearningsOutputRepresentation
|
|
3144
|
+
body:
|
|
3145
|
+
application/json:
|
|
3146
|
+
type: CreateLearningsInputRepresentation
|
|
3147
|
+
(oas-body-name): createLearningRecords
|
|
3148
|
+
patch:
|
|
3149
|
+
displayName: updateLearnings
|
|
3150
|
+
description: Update Learnings, achievements and their associations for Education
|
|
3151
|
+
Cloud
|
|
3152
|
+
responses:
|
|
3153
|
+
'200':
|
|
3154
|
+
description: Success
|
|
3155
|
+
body:
|
|
3156
|
+
application/json:
|
|
3157
|
+
type: CreateLearningsOutputRepresentation
|
|
3158
|
+
body:
|
|
3159
|
+
application/json:
|
|
3160
|
+
type: UpdateLearningsInputRepresentation
|
|
3161
|
+
(oas-body-name): updateLearningRecords
|
|
3162
|
+
/applications:
|
|
3163
|
+
get:
|
|
3164
|
+
displayName: getApplications
|
|
3165
|
+
description: Returns information about the user's applications.
|
|
3166
|
+
responses:
|
|
3167
|
+
'200':
|
|
3168
|
+
description: Success
|
|
3169
|
+
body:
|
|
3170
|
+
application/json:
|
|
3171
|
+
type: ApplicationsOutputRepresentation
|
|
3172
|
+
/applications/{preliminaryApplicationRefId}:
|
|
3173
|
+
get:
|
|
3174
|
+
displayName: getApplicationDetails
|
|
3175
|
+
description: Returns information about the application, including application
|
|
3176
|
+
tasks.
|
|
3177
|
+
responses:
|
|
3178
|
+
'200':
|
|
3179
|
+
description: Success
|
|
3180
|
+
body:
|
|
3181
|
+
application/json:
|
|
3182
|
+
type: ApplicationDetailsOutputRepresentation
|
|
3183
|
+
uriParameters:
|
|
3184
|
+
preliminaryApplicationRefId:
|
|
3185
|
+
type: string
|
|
3186
|
+
required: true
|
|
3187
|
+
/appointment-booking:
|
|
3188
|
+
/available-time-slots:
|
|
3189
|
+
post:
|
|
3190
|
+
description: Returns a list of available appointment time slots for a resource
|
|
3191
|
+
based on work type group and service territories.
|
|
3192
|
+
responses:
|
|
3193
|
+
'200':
|
|
3194
|
+
description: Success
|
|
3195
|
+
body:
|
|
3196
|
+
application/json:
|
|
3197
|
+
type: AvailableTimeSlotsOuputRepresentation
|
|
3198
|
+
body:
|
|
3199
|
+
application/json:
|
|
3200
|
+
type: AvailableTimeSlotsInputRepresentationData
|
|
3201
|
+
(oas-body-name): availableTimeSlotsInput
|
|
3202
|
+
/available-topics:
|
|
3203
|
+
get:
|
|
3204
|
+
description: Returns a list of available topics for scheduling.
|
|
3205
|
+
responses:
|
|
3206
|
+
'200':
|
|
3207
|
+
description: Success
|
|
3208
|
+
body:
|
|
3209
|
+
application/json:
|
|
3210
|
+
type: AvailableTopicsOutputRepresentation
|
|
3211
|
+
/campus-setup:
|
|
3212
|
+
/learner/{contactId}/learner-progress:
|
|
3213
|
+
get:
|
|
3214
|
+
displayName: getLearnerProgress
|
|
3215
|
+
description: Fetches the progress of a learner for all the enrolled programs.
|
|
3216
|
+
responses:
|
|
3217
|
+
'200':
|
|
3218
|
+
description: Success
|
|
3219
|
+
body:
|
|
3220
|
+
application/json:
|
|
3221
|
+
type: LearnerProgressOutputRepresentation
|
|
3222
|
+
queryParameters:
|
|
3223
|
+
learnerPathwayId:
|
|
3224
|
+
type: string
|
|
3225
|
+
required: false
|
|
3226
|
+
uriParameters:
|
|
3227
|
+
contactId:
|
|
3228
|
+
type: string
|
|
3229
|
+
required: true
|
|
3230
|
+
/learning/validate-foundation-items:
|
|
3231
|
+
post:
|
|
3232
|
+
displayName: postValidateLearningFoundationList
|
|
3233
|
+
description: The body of a learning foundation item validation request.
|
|
3234
|
+
responses:
|
|
3235
|
+
'200':
|
|
3236
|
+
description: Success
|
|
3237
|
+
body:
|
|
3238
|
+
application/json:
|
|
3239
|
+
type: LearningFoundationItemValidationOutputRepresentation
|
|
3240
|
+
body:
|
|
3241
|
+
application/json:
|
|
3242
|
+
type: LearningFoundationItemValidationInputRepresentation
|
|
3243
|
+
(oas-body-name): learningValidationRequestList
|
|
3244
|
+
/learning-program-plan/publish:
|
|
3245
|
+
post:
|
|
3246
|
+
displayName: postPublishLearningProgramPlan
|
|
3247
|
+
description: Post publish learning program plan request.
|
|
3248
|
+
responses:
|
|
3249
|
+
'200':
|
|
3250
|
+
description: Success
|
|
3251
|
+
body:
|
|
3252
|
+
application/json:
|
|
3253
|
+
type: LearningProgramPlanOutputRepresentation
|
|
3254
|
+
body:
|
|
3255
|
+
application/json:
|
|
3256
|
+
type: LearningProgramPlanInputRepresentationData
|
|
3257
|
+
(oas-body-name): publishLearningProgramPlan
|
|
3258
|
+
/learning-program-plan/{learningProgramPlanId}/preview:
|
|
3259
|
+
get:
|
|
3260
|
+
displayName: getPreviewLearningProgramPlan
|
|
3261
|
+
description: Returns a preview for Learning Program Plan.
|
|
3262
|
+
responses:
|
|
3263
|
+
'200':
|
|
3264
|
+
description: Success
|
|
3265
|
+
body:
|
|
3266
|
+
application/json:
|
|
3267
|
+
type: PreviewLearningProgramPlanOutputRepresentation
|
|
3268
|
+
uriParameters:
|
|
3269
|
+
learningProgramPlanId:
|
|
3270
|
+
type: string
|
|
3271
|
+
required: true
|
|
3272
|
+
/careplan/bulk:
|
|
3273
|
+
post:
|
|
3274
|
+
description: API to create CarePlans in bulk and it's related record
|
|
3275
|
+
responses:
|
|
3276
|
+
'200':
|
|
3277
|
+
description: Success
|
|
3278
|
+
body:
|
|
3279
|
+
application/json:
|
|
3280
|
+
type: CarePlanBulkOutputRepresentation
|
|
3281
|
+
body:
|
|
3282
|
+
#TODO Hand rolled due to W-8334626
|
|
3283
|
+
application/json:
|
|
3284
|
+
type: CarePlanBulkInputWrapperRepresentation
|
|
3285
|
+
(oas-body-name): carePlanBulkRecord
|
|
3286
|
+
/mentoring:
|
|
3287
|
+
/benefit-assignment/{benefitAssignmentId}/provider:
|
|
3288
|
+
post:
|
|
3289
|
+
displayName: postBenefitAssignment
|
|
3290
|
+
description: Return the benefit assignment record with updated provider
|
|
3291
|
+
record lookup.
|
|
3292
|
+
responses:
|
|
3293
|
+
'200':
|
|
3294
|
+
description: Success
|
|
3295
|
+
body:
|
|
3296
|
+
application/json:
|
|
3297
|
+
type: MentoringBenefitAssignmentOutputRepresentation
|
|
3298
|
+
body:
|
|
3299
|
+
application/json:
|
|
3300
|
+
description: Representation of the input for the benefit assignment request.
|
|
3301
|
+
type: MentoringBenefitAssignmentInputRepresentation
|
|
3302
|
+
(oas-body-name): mentoringBenefitAssignmentInput
|
|
3303
|
+
uriParameters:
|
|
3304
|
+
benefitAssignmentId:
|
|
3305
|
+
type: string
|
|
3306
|
+
required: true
|
|
3307
|
+
/matching-selector/{benefitAssignmentId}:
|
|
3308
|
+
post:
|
|
3309
|
+
displayName: postMatchingSelector
|
|
3310
|
+
description: Retrieve potential mentors and data on their profiles
|
|
3311
|
+
responses:
|
|
3312
|
+
'200':
|
|
3313
|
+
description: Success
|
|
3314
|
+
body:
|
|
3315
|
+
application/json:
|
|
3316
|
+
type: MentoringMatchingSelectorOutputRepresentation
|
|
3317
|
+
body:
|
|
3318
|
+
application/json:
|
|
3319
|
+
type: MentoringMatchingSelectorInputRepresentation
|
|
3320
|
+
(oas-body-name): mentoringMatchingSelectorInput
|
|
3321
|
+
uriParameters:
|
|
3322
|
+
benefitAssignmentId:
|
|
3323
|
+
type: string
|
|
3324
|
+
required: true
|
|
3325
|
+
/individual-application-tasks/{individualApplicationTaskId}:
|
|
3326
|
+
get:
|
|
3327
|
+
displayName: getIndividualApplicationTask
|
|
3328
|
+
description: Returns information about an individual application task.
|
|
3329
|
+
responses:
|
|
3330
|
+
'200':
|
|
3331
|
+
description: Success
|
|
3332
|
+
body:
|
|
3333
|
+
application/json:
|
|
3334
|
+
type: IndividualApplicationTaskOutputRepresentation
|
|
3335
|
+
uriParameters:
|
|
3336
|
+
individualApplicationTaskId:
|
|
3337
|
+
type: string
|
|
3338
|
+
required: true
|
|
3339
|
+
/new-application:
|
|
3340
|
+
/academic-terms:
|
|
3341
|
+
get:
|
|
3342
|
+
displayName: getAcademicTerms
|
|
3343
|
+
description: Returns a list of active academic terms that are filtered by
|
|
3344
|
+
academic level and sorted by academic term start date.
|
|
3345
|
+
responses:
|
|
3346
|
+
'200':
|
|
3347
|
+
description: Success
|
|
3348
|
+
body:
|
|
3349
|
+
application/json:
|
|
3350
|
+
type: AcademicTermsOutputRepresentation
|
|
3351
|
+
queryParameters:
|
|
3352
|
+
academicLevel:
|
|
3353
|
+
type: string
|
|
3354
|
+
required: true
|
|
3355
|
+
/preliminary-application-references:
|
|
3356
|
+
post:
|
|
3357
|
+
displayName: createPreliminaryApplicationReferences
|
|
3358
|
+
description: Saves preliminary application references.
|
|
3359
|
+
responses:
|
|
3360
|
+
'200':
|
|
3361
|
+
description: Success
|
|
3362
|
+
body:
|
|
3363
|
+
application/json:
|
|
3364
|
+
type: PreliminaryApplicationReferencesOutputRepresentation
|
|
3365
|
+
body:
|
|
3366
|
+
#TODO Hand rolled due to W-8334626. Original type: PreliminaryApplicationReferencesInputInputRepresentation
|
|
3367
|
+
application/json:
|
|
3368
|
+
type: PreliminaryApplicationReferencesInputInputWrapperRepresentation
|
|
3369
|
+
(oas-body-name): preliminaryAppRefInput
|
|
3370
|
+
/preliminary-data:
|
|
3371
|
+
get:
|
|
3372
|
+
displayName: getNewApplicationPreliminaryData
|
|
3373
|
+
description: Returns preliminary data required for creating a Preliminary
|
|
3374
|
+
Application Reference.
|
|
3375
|
+
responses:
|
|
3376
|
+
'200':
|
|
3377
|
+
description: Success
|
|
3378
|
+
body:
|
|
3379
|
+
application/json:
|
|
3380
|
+
type: NewApplicationPreliminaryDataOutputRepresentation
|
|
3381
|
+
queryParameters:
|
|
3382
|
+
context:
|
|
3383
|
+
type: string
|
|
3384
|
+
required: true
|
|
3385
|
+
/program-term-application-timelines:
|
|
3386
|
+
get:
|
|
3387
|
+
displayName: getProgramTermApplicationTimelines
|
|
3388
|
+
description: Returns a list of program term application timelines, and related
|
|
3389
|
+
learning programs, that are filtered by academic term.
|
|
3390
|
+
responses:
|
|
3391
|
+
'200':
|
|
3392
|
+
description: Success
|
|
3393
|
+
body:
|
|
3394
|
+
application/json:
|
|
3395
|
+
type: ProgramTermApplicationTimelineOutputRepresentation
|
|
3396
|
+
queryParameters:
|
|
3397
|
+
termId:
|
|
3398
|
+
type: string
|
|
3399
|
+
required: false
|
|
3400
|
+
academicLevel:
|
|
3401
|
+
type: string
|
|
3402
|
+
required: false
|
|
3403
|
+
/person-public-profile/{usageType}/{contactId}:
|
|
3404
|
+
get:
|
|
3405
|
+
displayName: getPersonPublicProfile
|
|
3406
|
+
description: Data that the user chooses to show on their public profile, for
|
|
3407
|
+
example their education information, professional experiences, or contact
|
|
3408
|
+
details.
|
|
3409
|
+
responses:
|
|
3410
|
+
'200':
|
|
3411
|
+
description: Success
|
|
3412
|
+
body:
|
|
3413
|
+
application/json:
|
|
3414
|
+
type: PersonPublicProfileOutputRepresentation
|
|
3415
|
+
uriParameters:
|
|
3416
|
+
contactId:
|
|
3417
|
+
type: string
|
|
3418
|
+
required: true
|
|
3419
|
+
usageType:
|
|
3420
|
+
type: string
|
|
3421
|
+
required: true
|
|
3422
|
+
/{accountId}/success-team:
|
|
3423
|
+
get:
|
|
3424
|
+
description: Returns a list of teams and staff that are available to support
|
|
3425
|
+
an account.
|
|
3426
|
+
responses:
|
|
3427
|
+
'200':
|
|
3428
|
+
description: Success
|
|
3429
|
+
body:
|
|
3430
|
+
application/json:
|
|
3431
|
+
type: SuccessTeamOutputRepresentation
|
|
3432
|
+
queryParameters:
|
|
3433
|
+
caseIds:
|
|
3434
|
+
description: The case identifiers associated with the account that are used to filter the results.
|
|
3435
|
+
type: array
|
|
3436
|
+
required: false
|
|
3437
|
+
items:
|
|
3438
|
+
type: string
|
|
3439
|
+
(oas-collectionFormat): csv
|
|
3440
|
+
teamTypes:
|
|
3441
|
+
description: The types of teams such as assignedTeams, unassignedTeams, and assignedStaff, that are used to filter the results.
|
|
3442
|
+
type: array
|
|
3443
|
+
required: false
|
|
3444
|
+
items:
|
|
3445
|
+
type: string
|
|
3446
|
+
enum:
|
|
3447
|
+
- AssignedStaff
|
|
3448
|
+
- AssignedTeams
|
|
3449
|
+
- UnassignedTeams
|
|
3450
|
+
(oas-collectionFormat): csv
|
|
3451
|
+
uriParameters:
|
|
3452
|
+
accountId:
|
|
3453
|
+
type: string
|
|
3454
|
+
required: true
|
|
3455
|
+
/student-action-centre:
|
|
3456
|
+
/task:
|
|
3457
|
+
post:
|
|
3458
|
+
displayName: createTask
|
|
3459
|
+
description: Creates a Task object with the given fields
|
|
3460
|
+
responses:
|
|
3461
|
+
'200':
|
|
3462
|
+
description: Success
|
|
3463
|
+
body:
|
|
3464
|
+
application/json:
|
|
3465
|
+
type: Task
|
|
3466
|
+
body:
|
|
3467
|
+
application/json:
|
|
3468
|
+
type: TaskInputRepresentation
|
|
3469
|
+
(oas-body-name): task
|
|
3470
|
+
/picklist-values:
|
|
3471
|
+
get:
|
|
3472
|
+
displayName: getPicklistValues
|
|
3473
|
+
description: Gets the available picklist values of the picklist fields of
|
|
3474
|
+
Task
|
|
3475
|
+
responses:
|
|
3476
|
+
'200':
|
|
3477
|
+
description: Success
|
|
3478
|
+
body:
|
|
3479
|
+
application/json:
|
|
3480
|
+
type: TaskPicklistOutputRepresentation
|
|
3481
|
+
queryParameters:
|
|
3482
|
+
fieldNames:
|
|
3483
|
+
description: Picklist fields of task object
|
|
3484
|
+
type: array
|
|
3485
|
+
required: false
|
|
3486
|
+
items:
|
|
3487
|
+
type: string
|
|
3488
|
+
(oas-collectionFormat): csv
|
|
3489
|
+
/{taskId}:
|
|
3490
|
+
patch:
|
|
3491
|
+
displayName: updateTaskStatus
|
|
3492
|
+
description: Updates the status of the Task Object
|
|
3493
|
+
responses:
|
|
3494
|
+
'200':
|
|
3495
|
+
description: Success
|
|
3496
|
+
body:
|
|
3497
|
+
application/json:
|
|
3498
|
+
type: Task
|
|
3499
|
+
body:
|
|
3500
|
+
application/json:
|
|
3501
|
+
type: TaskInputRepresentation
|
|
3502
|
+
(oas-body-name): task
|
|
3503
|
+
uriParameters:
|
|
3504
|
+
taskId:
|
|
3505
|
+
type: string
|
|
3506
|
+
required: true
|
|
3507
|
+
/{contactId}/apts-tasks-plans:
|
|
3508
|
+
get:
|
|
3509
|
+
displayName: getAptsTasksPlans
|
|
3510
|
+
description: Returns a list of tasks, action plans, care plans and action plan templates which are assigned to the student.
|
|
3511
|
+
responses:
|
|
3512
|
+
'200':
|
|
3513
|
+
description: Success
|
|
3514
|
+
body:
|
|
3515
|
+
application/json:
|
|
3516
|
+
type: AptsTasksPlansOutputRepresentation
|
|
3517
|
+
queryParameters:
|
|
3518
|
+
objectType:
|
|
3519
|
+
description: The type of object to be fetched
|
|
3520
|
+
type: string
|
|
3521
|
+
required: false
|
|
3522
|
+
enum:
|
|
3523
|
+
- ActionPlan
|
|
3524
|
+
- ActionPlanTemplate
|
|
3525
|
+
- All
|
|
3526
|
+
- CarePlan
|
|
3527
|
+
- Task
|
|
3528
|
+
uriParameters:
|
|
3529
|
+
contactId:
|
|
3530
|
+
type: string
|
|
3531
|
+
required: true
|