Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

This form will be used to populate the activity types that can be added for a group. If there is no form created we won’t be able to create any activity.

End Point:

Code Block
POST: /data/v1/form/create 

...

Code Block
{
    "request": {
        "type": "group",
        "subType": "supported_activities",
        "action": "list",
        "data": {
            "templateName": "supported_activities",
            "action": "list",
            "fields": [
                {
                    "index": 0,
                    "activityType": "Explanation Content",
                    "objectType": "Content",
                    "isEnabled": true,
                    "sortBy": [
                        {
                            "name": "asc"
                        }
                    ],
                    "searchQuery": "{\"request\":{\"filters\":{\"primaryCategory\":[\"Explanation Content\"],\"status\":[\"Live\"],\"objectType\":[\"Content\"]},\"fields\":[\"name\",\"appIcon\",\"contentType\",\"identifier\",\"objectType\",\"createdBy\"]}}",
                    "title": "Explanation Content",
                    "translations": "{\"en\":\"Explanation Content\"}"
                },
                {
                    "index": 1,
                    "activityType": "Learning Resource",
                    "objectType": "Content",
                    "isEnabled": true,
                    "sortBy": [
                        {
                            "name": "asc"
                        }
                    ],
                    "searchQuery": "{\"request\":{\"filters\":{\"primaryCategory\":[\"Learning Resource\"],\"status\":[\"Live\"],\"objectType\":[\"Content\"]},\"fields\":[\"name\",\"appIcon\",\"contentType\",\"identifier\",\"objectType\",\"createdBy\"]}}",
                    "title": "Learning Resource",
                    "translations": "{\"en\":\"Learning Resource\"}"
                },
                {
                    "index": 2,
                    "activityType": "Course",
                    "objectType": "Content",
                    "isEnabled": true,
                    "sortBy": [
                        {
                            "name": "asc"
                        }
                    ],
                    "searchQuery": "{\"request\":{\"filters\":{\"primaryCategory\":[\"Course\"],\"batches.status\":1,\"batches.enrollmentType\":\"open\",\"objectType\":[\"Content\"],\"status\":[\"Live\"]},\"fields\":[\"name\",\"appIcon\",\"contentType\",\"identifier\",\"objectType\",\"createdBy\"]}}",
                    "title": "Course",
                    "translations": "{\"en\": \"Course\", \"as\": \"পাঠ্যক্ৰমসমুহ\", \"bn\": \"পাঠ্যধারাগুলি\", \"gu\":\"કોર્સ\", \"hi\":\"कोर्स\", \"kn\":\"ಕೋರ್ಸ್ ಗಳು\", \"mr\":\"कोर्सेस\", \"or\":\"ପାଠ୍ୟକ୍ରମଗୁଡ଼ିକ\", \"pa\":\"ਕੋਰਸਿਸ\", \"ta\":\"பாடநெறிகள்\", \"te\":\"కోర్సులు\", \"ur\":\"کورسز\"}"
                },
                {
                    "index": 3,
                    "activityType": "Practice Question Set",
                    "objectType": "Content",
                    "isEnabled": true,
                    "sortBy": [
                        {
                            "name": "asc"
                        }
                    ],
                    "searchQuery": "{\"request\":{\"filters\":{\"primaryCategory\":[\"Practice Question Set\"],\"status\":[\"Live\"],\"objectType\":[\"Content\"]},\"fields\":[\"name\",\"appIcon\",\"contentType\",\"identifier\",\"objectType\",\"createdBy\"]}}",
                    "title": "Practice Question Set",
                    "translations": "{\"en\":\"Practice Question Set\"}"
                },
            ]
   {     }
    }
          "index": 4,
                    "activityType": "eTextBook",
                    "objectType": "Content",
                    "isEnabled": true,
                    "sortBy": [
                        {
                            "name": "asc"
                        }
                    ],
                    "searchQuery": "{\"request\":{\"filters\":{\"primaryCategory\":[\"eTextBook\"],\"status\":[\"Live\"],\"objectType\":[\"Content\"]},\"fields\":[\"name\",\"appIcon\",\"contentType\",\"identifier\",\"objectType\",\"createdBy\"]}}",
                    "title": "eTextBook",
                    "translations": "{\"en\":\"eTextBook\"}"
                },
                {
                    "index": 5,
                    "activityType": "Teacher Resource",
                    "objectType": "Content",
                    "isEnabled": true,
                    "sortBy": [
                        {
                            "name": "asc"
                        }
                    ],
                    "searchQuery": "{\"request\":{\"filters\":{\"primaryCategory\":[\"Teacher Resource\"],\"status\":[\"Live\"],\"objectType\":[\"Content\"]},\"fields\":[\"name\",\"appIcon\",\"contentType\",\"identifier\",\"objectType\",\"createdBy\"]}}",
                    "title": "Teacher Resource",
                    "translations": "{\"en\":\"Teacher Resource\"}"
                },
                {
                    "index": 6,
                    "activityType": "Digital Textbook",
                    "objectType": "Content",
                    "isEnabled": true,
                    "sortBy": [
                        {
                            "name": "asc"
                        }
                    ],
                    "searchQuery": "{\"request\":{\"filters\":{\"primaryCategory\":[\"Digital Textbook\"],\"status\":[\"Live\"],\"objectType\":[\"Content\"]},\"fields\":[\"name\",\"appIcon\",\"contentType\",\"identifier\",\"objectType\",\"createdBy\"]}}",
                    "title": "Digital Textbook",
                    "translations": "{\"en\":\"Digital Textbook\"}"
                },
                {
                    "index": 7,
                    "activityType": "Content Playlist",
                    "objectType": "Content",
                    "isEnabled": true,
                    "sortBy": [
                        {
                            "name": "asc"
                        }
                    ],
                    "searchQuery": "{\"request\":{\"filters\":{\"primaryCategory\":[\"Content Playlist\"],\"status\":[\"Live\"],\"objectType\":[\"Content\"]},\"fields\":[\"name\",\"appIcon\",\"contentType\",\"identifier\",\"objectType\",\"createdBy\"]}}",
                    "title": "Content Playlist",
                    "translations": "{\"en\":\"Content Playlist\"}"
                },
                {
                    "index": 8,
                    "activityType": "TV Lesson",
                    "objectType": "Content",
                    "isEnabled": true,
                    "sortBy": [
                        {
                            "name": "asc"
                        }
                    ],
                    "searchQuery": "{\"request\":{\"filters\":{\"primaryCategory\":[\"Explanation Content\"],\"additionalCategories\":[\"TV Lesson\"],\"status\":[\"Live\"],\"objectType\":[\"Content\"]},\"fields\":[\"name\",\"appIcon\",\"contentType\",\"identifier\",\"objectType\",\"createdBy\"]}}",
                    "title": "TV Lesson",
                    "translations": "{\"en\":\"TV Lesson\"}"
                },
                {
                    "index": 9,
                    "activityType": "Previous Board Exam Papers",
                    "objectType": "Content",
                    "isEnabled": true,
                    "sortBy": [
                        {
                            "name": "asc"
                        }
                    ],
                    "searchQuery": "{\"request\":{\"filters\":{\"primaryCategory\":[\"Learning Resource\"],\"additionalCategories\":[\"Previous Board Exam Papers\"],\"status\":[\"Live\"],\"objectType\":[\"Content\"]},\"fields\":[\"name\",\"appIcon\",\"contentType\",\"identifier\",\"objectType\",\"createdBy\"]}}",
                    "title": "Previous Board Exam Papers",
                    "translations": "{\"en\":\"Previous Board Exam Papers\"}"
                }
            ]
        }
    }
}
}

Refer the below table to find more about the fields

Field

type

description

index

number

For sorting in frontend

activityType

string

Activity type which needs to be added to group

objectType

string

Type of the object

isEnabled

boolean

Indicates whether the activityType is to be displayed

searchQuery

stringified object

query needs to be called with search API when a activity is selected

title

string

Activity types title which is used to display in front end

translations

stringified object

provide the translations to handle localisation

Steps for adding activity for group

...