Program Configuration
- Venkateshwaran Selvaraj
Owned by Venkateshwaran Selvaraj
Feb 04, 2020
12 min read
Loading data...
Creation API
curl --location --request POST 'https://dev.sunbirded.org/plugin/program/v1/create' \
--header 'Content-Type: application/json' \
--data-raw '{
"request": {
"config": {
"_comments": "",
"loginReqired": true,
"framework": "NCFCOPY",
"roles": [
{
"id": 1,
"name": "CONTRIBUTOR",
"default": true,
"defaultTab": 1,
"tabs": [
1
]
},
{
"id": 2,
"name": "REVIEWER",
"defaultTab": 2,
"tabs": [
2
]
}
],
"header": {
"id": "ng.sunbird.header",
"ver": "1.0",
"compId": "headerComp",
"author": "Venkat",
"description": "",
"publishedDate": "",
"data": {},
"config": {
"tabs": [
{
"index": 1,
"label": "Contribute",
"onClick": "collectionComponent"
},
{
"index": 2,
"label": "Review",
"onClick": "collectionComponent"
},
{
"index": 3,
"label": "Dashboard",
"onClick": "dashboardComponent"
}
]
}
},
"components": [
{
"id": "ng.sunbird.collection",
"ver": "1.0",
"compId": "collectionComponent",
"author": "Venkat",
"description": "",
"publishedDate": "",
"data": {},
"config": {
"filters": {
"implicit": [
{
"code": "framework",
"defaultValue": "NCFCOPY",
"label": "Framework"
},
{
"code": "board",
"defaultValue": "NCERT",
"label": "Board"
},
{
"code": "medium",
"defaultValue": [
"English"
],
"label": "Medium"
}
],
"explicit": [
{
"code": "gradeLevel",
"range": [
"Kindergarten",
"Grade 1",
"Grade 2",
"Grade 3"
],
"label": "Class",
"multiselect": false,
"defaultValue": [
"Kindergarten",
"Grade 1"
],
"visibility": true
},
{
"code": "subject",
"range": [
"English",
"Mathematics",
"Hindi"
],
"label": "Subject",
"multiselect": false,
"defaultValue": [
"English"
],
"visibility": true
}
]
},
"groupBy": {
"value": "subject",
"defaultValue": "subject"
},
"collectionType": "Textbook",
"collectionList": [],
"status": [
"Draft",
"Live"
]
}
},
{
"id": "ng.sunbird.chapterList",
"ver": "1.0",
"compId": "chapterListComponent",
"author": "Kartheek",
"description": "",
"publishedDate": "",
"data": {},
"config": {
"contentTypes": {
"value": [
{
"id": "explanationContent",
"label": "Explanation",
"onClick": "uploadComponent",
"mimeType": [
"application/pdf"
],
"metadata": {
"name": "Explanation Resource",
"description": "ExplanationResource",
"resourceType": "Read",
"contentType": "ExplanationResource",
"audience": [
"Learner"
],
"appIcon": "https://ntpstagingall.blob.core.windows.net/ntp-content-staging/content/do_21291553051403878414/artifact/explanation.thumb_1576602846206.png",
"marks": 5
},
"filesConfig": {
"accepted": "pdf",
"size": "50"
}
},
{
"id": "experientialContent",
"label": "Experiential",
"onClick": "uploadComponent",
"mimeType": [
"video/mp4"
],
"metadata": {
"name": "Experiential Resource",
"description": "ExperientialResource",
"resourceType": "Read",
"contentType": "ExperientialResource",
"audience": [
"Learner"
],
"appIcon": "https://ntpstagingall.blob.core.windows.net/ntp-content-staging/content/do_21291553051403878414/artifact/explanation.thumb_1576602846206.png",
"marks": 5
},
"filesConfig": {
"accepted": "mp4",
"size": "50"
}
},
{
"id": "focusSpotContent",
"label": "FocusSpot",
"onClick": "uploadComponent",
"mimeType": [
"application/pdf"
],
"metadata": {
"name": "FocusSpot Resource",
"description": "FocusSpot",
"resourceType": "Read",
"contentType": "FocusSpot",
"audience": [
"Learner"
],
"appIcon": "https://ntpstagingall.blob.core.windows.net/ntp-content-staging/content/do_21291553100098764812/artifact/focus-spot_1561727473311.thumb_1576602905573.png",
"marks": 5
},
"filesConfig": {
"accepted": "pdf",
"size": "50"
}
},
{
"id": "vsaPracticeQuestionContent",
"label": "VSA - Practice Sets",
"onClick": "questionSetComponent",
"mimeType": [
"application/vnd.ekstep.ecml-archive"
],
"metadata": {
"name": "Practice QuestionSet",
"description": "Practice QuestionSet",
"resourceType": "Learn",
"contentType": "PracticeQuestionSet",
"audience": [
"Learner"
],
"appIcon": "",
"marks": 5
},
"questionCategories": [
"vsa"
]
},
{
"id": "saPracticeQuestionContent",
"label": "SA - Practice Sets",
"onClick": "questionSetComponent",
"mimeType": [
"application/vnd.ekstep.ecml-archive"
],
"metadata": {
"name": "Practice QuestionSet",
"description": "Practice QuestionSet",
"resourceType": "Learn",
"contentType": "PracticeQuestionSet",
"audience": [
"Learner"
],
"appIcon": "",
"marks": 5
},
"questionCategories": [
"sa"
]
},
{
"id": "laPracticeQuestionContent",
"label": "LA - Practice Sets",
"onClick": "questionSetComponent",
"mimeType": [
"application/vnd.ekstep.ecml-archive"
],
"metadata": {
"name": "Practice QuestionSet",
"description": "Practice QuestionSet",
"resourceType": "Learn",
"contentType": "PracticeQuestionSet",
"audience": [
"Learner"
],
"appIcon": "",
"marks": 5
},
"questionCategories": [
"la"
]
},
{
"id": "mcqPracticeQuestionContent",
"label": "MCQ - Practice Sets",
"onClick": "questionSetComponent",
"mimeType": [
"application/vnd.ekstep.ecml-archive"
],
"metadata": {
"name": "Practice QuestionSet",
"description": "Practice QuestionSet",
"resourceType": "Learn",
"contentType": "PracticeQuestionSet",
"audience": [
"Learner"
],
"appIcon": "",
"marks": 5
},
"questionCategories": [
"mcq"
]
},
{
"id": "curiositySetContent",
"label": "Curiosity Sets",
"onClick": "curiositySetComponent",
"mimeType": [
"application/vnd.ekstep.ecml-archive"
],
"metadata": {
"name": "Curiosity QuestionSet",
"description": "Curiosity QuestionSet",
"resourceType": "Learn",
"contentType": "CuriosityQuestionSet",
"audience": [
"Learner"
],
"appIcon": "",
"marks": 5
},
"questionCategories": [
"curiosity"
]
}
],
"defaultValue": [
{
"id": "vsaPracticeQuestionContent",
"label": "Practice Sets",
"onClick": "questionSetComponent",
"mimeType": [
"application/vnd.ekstep.ecml-archive"
],
"metadata": {
"name": "Practice QuestionSet",
"description": "Practice QuestionSet",
"resourceType": "Learn",
"contentType": "PracticeQuestionSet",
"audience": [
"Learner"
],
"appIcon": "",
"marks": 5
},
"questionCategories": [
"vsa"
]
}
]
}
}
},
{
"id": "ng.sunbird.uploadComponent",
"ver": "1.0",
"compId": "uploadContentComponent",
"author": "Kartheek",
"description": "",
"publishedDate": "",
"data": {},
"config": {
"filesConfig": {
"accepted": "pdf, mp4, webm, youtube",
"size": "50"
},
"formConfiguration": [
{
"code": "learningOutcome",
"dataType": "list",
"description": "Learning Outcomes For The Content",
"editable": true,
"inputType": "multiselect",
"label": "Learning Outcome",
"name": "LearningOutcome",
"placeholder": "Select Learning Outcomes",
"required": false,
"visible": true
},
{
"code": "bloomslevel",
"dataType": "list",
"description": "Learning Level For The Content",
"editable": true,
"inputType": "select",
"label": "Learning Level",
"name": "LearningLevel",
"placeholder": "Select Learning Levels",
"required": true,
"visible": true,
"defaultValue": [
"remember",
"understand",
"apply",
"analyse",
"evaluate",
"create"
]
},
{
"code": "creator",
"dataType": "text",
"description": "Enter The Author Name",
"editable": true,
"inputType": "text",
"label": "Author",
"name": "Author",
"placeholder": "Enter Author Name",
"required": true,
"visible": true
},
{
"code": "license",
"dataType": "list",
"description": "License For The Content",
"editable": true,
"inputType": "select",
"label": "License",
"name": "License",
"placeholder": "Select License",
"required": true,
"visible": true
}
],
"resourceTitleLength": "200",
"tenantName": "SunbirdEd"
}
},
{
"id": "ng.sunbird.practiceSetComponent",
"ver": "1.0",
"compId": "practiceSetComponent",
"author": "Kartheek",
"description": "",
"publishedDate": "",
"data": {},
"config": {
"No of options": 4,
"solutionType": [
"Video",
"Text & image"
],
"questionCategory": [
"vsa",
"sa",
"ls",
"mcq",
"curiosity"
],
"formConfiguration": [
{
"code": "learningOutcome",
"dataType": "list",
"description": "Learning Outcomes For The Content",
"editable": true,
"inputType": "multiselect",
"label": "Learning Outcome",
"name": "LearningOutcome",
"placeholder": "Select Learning Outcomes",
"required": false,
"visible": true
},
{
"code": "bloomsLevel",
"dataType": "list",
"description": "Learning Level For The Content",
"editable": true,
"inputType": "multiselect",
"label": "Learning Level",
"name": "LearningLevel",
"placeholder": "Select Learning Levels",
"required": true,
"visible": true,
"defaultValue": [
"remember",
"understand",
"apply",
"analyse",
"evaluate",
"create"
]
},
{
"code": "creator",
"dataType": "text",
"description": "Enter The Author Name",
"editable": true,
"inputType": "text",
"label": "Author",
"name": "Author",
"placeholder": "Enter Author Name",
"required": true,
"visible": true
},
{
"code": "license",
"dataType": "list",
"description": "License For The Content",
"editable": true,
"inputType": "select",
"label": "License",
"name": "License",
"placeholder": "Select License",
"required": true,
"visible": true
}
],
"resourceTitleLength": "200",
"tenantName": "",
"assetConfig": {
"image": {
"size": "50"
},
"video": {
"size": "50",
"accepted": "pdf, mp4, webm, youtube"
}
}
}
},
{
"id": "ng.sunbird.dashboard",
"ver": "1.0",
"compId": "dashboardComp",
"author": "Venkanna Gouda",
"description": "",
"publishedDate": "",
"data": {},
"config": {}
}
],
"actions": {
"showCountPanel": {
"roles": [
1,
2
]
},
"showContribution": {
"roles": [
1
]
},
"showUpforReview": {
"roles": [
2
]
},
"showTotalContribution": {
"roles": [
1
]
},
"showMyContribution": {
"roles": [
1
]
},
"showRejected": {
"roles": [
1
]
},
"showUnderReview": {
"roles": [
1
]
},
"showTotalUnderReview": {
"roles": [
2
]
},
"showAawaitingReview": {
"roles": [
2
]
},
"showFilters": {
"roles": [
1,
2,
3
]
},
"showAddResource": {
"roles": [
1
]
},
"showEditResource": {
"roles": [
1
]
},
"showMoveResource": {
"roles": [
1
]
},
"showDeleteResource": {
"roles": [
1
]
},
"showPreviewResource": {
"roles": [
2
]
},
"showDashboard": {
"roles": [
3
]
},
"showCert": {
"roles": [
4
]
},
"showSave": {
"roles": [
1
]
},
"showEdit": {
"roles": [
1
]
},
"showChangeFile": {
"roles": [
1
]
},
"showRequestChanges": {
"roles": [
2
]
},
"showPublish": {
"roles": [
2
]
},
"showSubmit": {
"roles": [
1
]
},
"showCreatorView": {
"roles": [
1
]
},
"showReviewerView": {
"roles": [
2
]
},
"showCreateQuestion": {
"roles": [
1
]
},
"showDeleteQuestion": {
"roles": [
1
]
}
},
"onBoardingForm": {
"templateName": "onBoardingForm",
"action": "onboard",
"fields": [
{
"code": "school",
"dataType": "text",
"name": "School",
"label": "School",
"description": "School",
"inputType": "select",
"required": false,
"displayProperty": "Editable",
"visible": true,
"range": [
{
"identifier": "my_school",
"code": "my_school",
"name": "My School",
"description": "My School",
"index": 1,
"category": "school",
"status": "Live"
}
],
"index": 1
}
]
},
"sharedContext": [
"channel",
"framework",
"board",
"medium",
"gradeLevel",
"subject",
"topic"
]
},
"defaultRoles": [
"CONTRIBUTOR"
],
"description": "hello program",
"imagePath": null,
"name": "State Rajasthan Program",
"rootOrgId": "0124511394914140160",
"rootOrgName": null,
"slug": "sunbird",
"startDate": "2019-02-03T12:50:30.000Z",
"type": "public"
}
}'
Program Read API
curl --location --request GET '{{host}}/plugin/program/v1/read/:programID' \
--header 'Content-Type: application/json' \
--data-raw ''
Program Participant Update API
curl --location --request PATCH '{{host}}/plugin/program/v1/update/participant' \
--header 'Content-Type: application/json' \
--data-raw '{
"request": {
"programId": <programID>,
"userId": <userID>,
"roles": [
"PUBLISHER"
],
"onBoarded": true
}
}'
Program Update API
Creation configuration explanation
Conclusion