Versions Compared

Key

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

...

/course/v1/user/enrollment/list/{‌{userId}‌}?fields=[comma-seperated-valid-fieldsfields in tree structure]&orgDetails=name,email

e.g. fields=relatedEntity1{field1,field2},relatedEntity2{field1,field2}

Response will be under key relatedEntity1 as key-value map

Approaches

Approach 1

API will accept a new query parameter as fields, where user can specify which batch fields need to be fetched along with enrolled courses.

...

Get  ../course/v1/user/enrollment/list/{‌{userId}‌}?fields=batch{name,startDate,endDate,status.}

Resopnse :

Code Block
languagejs
{
  "id": "api.user.courses.list",
  "ver": "v1",
  "ts": "2018-11-15 09:17:31:909+0000",
  "params": {
    "resmsgid": null,
    "msgid": "9db786d3-45c2-447d-b657-f9768da15652",
    "err": null,
    "status": "success",
    "errmsg": null
  },
  "responseCode": "OK",
  "result": {
    "courses": [
      {
        "dateTime": "2018-07-04 09:31:22:294+0000",
        "status": 1,
         ...
        "batch": {
          "name": "batchName",
          "startDate": "2018-01-02",
          "endDate": "2018-01-22",
          "status": "1"
        }
      },
      {
        ...
        }
      }
    ]
  }
}

...

2. Get  ../course/v1/user/enrollment/list/{‌{userId}‌}?orgDetails=name,status&fields=batch{name,someUnsupportedFieldstartDate,endDate,status}.   Here we  already have  batch start date , end date and status is standard batch data.

...