Profile update API failing if we are giving values other than BMGS(Board, Medium, GradeLevel, Subject)

[swayangjit]

We are trying to make the SunbirdED code base independent of BMGS, so while our analysis we figured out if we are sending any value
other than BMGS the profile update API is throwing an error. The request and response is as follows
Request:

{
    "userId": "225d0748-e4ae-4c7f-844e-37a92b7af78f",
    "framework": {
        "id": [
            "ap_k-12_1"
        ],
        "category1": [
            "cateroy-1"
        ]
    }
}

Response:

{
    "resmsgid": "9d4c204453c90f245d4ad5bf244e6b52",
    "msgid": "9d4c204453c90f245d4ad5bf244e6b52",
    "err": "UOS_USRUPD0051",
    "status": "FAILED",
    "errmsg": "Unsupported field framework.category1."
}

As an adopter how will someone configure these categories for the APIs to support?

@AmiableAnil @reshmi-nair

[Krishnaj20]

@AmiableAnil - any update on this issue?

[Jayaprakash8887]

@reshmi-nair Pls confirm if the above request format is the correct format to update framework to user profile

[Jayaprakash8887]

@swayangjit Please let us know if the issue is resolved. Else, please verify all configurations.

1. System settings for "userProfileConfig"

2. If the framework is published and redis is populated with the framework data (for "framework1")
3. Please check if user-org service is able to connect with learning service - config: "sunbird_api_base_url"

[Ajoymaity]

@Jayaprakash8887 @swayangjit I'm looking this issue, actually facing some other issue in dev environment. I'll update you once it's tested

[Jayaprakash8887]

@swayangjit Please let us know if your query is resolved.

[Ajoymaity]

@swayangjit @Jayaprakash8887 now profile is updating with non BMGS framework after updating System Settings of "userProfileConfig"

[amitpriyadarshi]

@swayangjit As per the discussion with @Ajoymaity and @Jayaprakash8887 sharing the details for introducing new categories into the framework system and use them.

To introduce any new framework category into the system we need to follow below steps:

1. Add the categories into the master category list by calling below api. Currently this API is not exposed, you need call it directly into the learning service. Also you need to update the naming convention accordingly in the below request payload. One should be very careful while this API.

curl --location 'http://localhost:8080/learning-service/framework/v3/category/master/create' \
--header 'Content-Type: application/json' \
--data '{
    "request": {
        "category": {
            "code": "category1",
            "targetIdFieldName": "targetCategory1Ids",
            "channel": "in.ekstep",
            "searchLabelFieldName": "se_category1s",
            "description": "Category1",
            "name": "Category1",
            "orgIdFieldName": "category1Ids",
            "searchIdFieldName": "se_category1Ids"
        }
    }
}'

2. Once category is added into master category list, add those categories into system setting against userProfileConfig by calling below API.

• Read API for userProfileConfig:

curl --location '{{host}}/api/data/v1/system/settings/get/userProfileConfig' \
--header 'Content-Type: json' \
--header 'Authorization: Bearer <api-key>'

NOTE: take the value data from read call, add the newly introduced categories into them and call update api.

• Update API for userProfileConfig:

curl --location '{{host}}/api/data/v1/system/settings/set' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <api-key>' \
--header 'x-authenticated-user-token: <user-token>' \
--data '{
    "request": {
        "id": "userProfileConfig",
        "field": "userProfileConfig",
        "value": "{\"fields\":[\"firstName\",\"lastName\",\"profileSummary\",\"avatar\",\"countryCode\",\"dob\",\"email\",\"gender\",\"grade\",\"language\",\"location\",\"phone\",\"subject\",\"userName\",\"webPages\",\"jobProfile\",\"address\",\"education\",\"skills\",\"badgeAssertions\"],\"publicFields\":[\"firstName\",\"lastName\",\"profileSummary\",\"userName\"],\"privateFields\":[\"email\",\"phone\"],\"csv\":{\"supportedColumns\":{\"NAME\":\"firstName\",\"MOBILE PHONE\":\"phone\",\"EMAIL\":\"email\",\"SCHOOL ID\":\"orgId\",\"USER_TYPE\":\"userType\",\"ROLES\":\"roles\",\"USER ID\":\"userId\",\"SCHOOL EXTERNAL ID\":\"orgExternalId\"},\"outputColumns\":{\"userId\":\"USER ID\",\"firstName\":\"NAME\",\"phone\":\"MOBILE PHONE\",\"email\":\"EMAIL\",\"orgId\":\"SCHOOL ID\",\"orgName\":\"SCHOOL NAME\",\"userType\":\"USER_TYPE\",\"orgExternalId\":\"SCHOOL EXTERNAL ID\"},\"outputColumnsOrder\":[\"userId\",\"firstName\",\"phone\",\"email\",\"organisationId\",\"orgName\",\"userType\",\"orgExternalId\"],\"mandatoryColumns\":[\"firstName\",\"userType\",\"roles\"]},\"read\":{\"excludedFields\":[\"avatar\",\"jobProfile\",\"address\",\"education\",\"webPages\",\"skills\"]},\"framework\":{\"fields\":[\"board\",\"gradeLevel\",\"medium\",\"subject\",\"id\",\"category1\",\"category2\",\"category3\",\"category4\"],\"mandatoryFields\":[\"id\"]}}"
    }
}'

NOTE: Here newly added categories are added at the bottom.

3. Create the framework with newly introduced categories, their terms and associations. Post framework creation publish the framework. Refer framework APIs document link.

4. Once framework is created, add the newly created framework in framework list of the respective channel.

cc: @Krishnaj20

[Jayaprakash8887]

@swayangjit Please mark this thread as answered if you do not have further queries