Dependencies
Dependency Services:
Group Service connects to Notification Service to fetch all the notifications for the particular user by using notification feed APIs. Dependency API: /notification/v1/feed/{{CRUD-operation}}
Group Service connects to UserOrg Service to fetch user/member information. Any other service which has user information in a similar schema can be plugged in instead of this dependency. Dependency API: /api/user/v5/read/{{userId}} API Method: GET
Sample Response Payload
{
"id": "api.user.read",
"ver": "v4",
"ts": "2021-04-09 21:09:05:331+0530",
"params": {
"resmsgid": null,
"msgid": "a1d3d756-0f9b-4ec6-95a6-6560896d5294",
"err": null,
"status": "success",
"errmsg": null
},
"responseCode": "OK",
"result": {
"response": {
"maskedPhone": null,
"tcStatus": null,
"channel": "channel1",
"updatedDate": "2021-04-07 05:09:45:607+0000",
"managedBy": null,
"flagsValue": 2,
"id": "96102c3f-2c22-4614-8dcc-6b130cefe586",
"recoveryEmail": "co**************@yopmail.com",
"identifier": "96102c3f-2c22-4614-8dcc-6b130cefe586",
"updatedBy": "96102c3f-2c22-4614-8dcc-6b130cefe586",
"externalIds": [],
"rootOrgId": "0126796199493140480",
"prevUsedEmail": null,
"firstname": "first name",
"tncAcceptedOn": 1617265216047,
"allTncAccepted": {},
"phone": null,
"dob": null,
"userType": "student",
"status": 1,
"lastName": null,
"tncLatestVersion": "3.5.0",
"roles": [
{
"role": "COURSE_CREATOR",
"userId": "96102c3f-2c22-4614-8dcc-6b130cefe586",
"scope": [
{
"organisationId": "0126796199493140480"
}
],
"createdDate": "2021-06-07 11:29:41:606+0530",
"updatedBy": null,
"createdBy": "96102c3f-2c22-4614-8dcc-6b130cefe586",
"updatedDate": null
}
],
"prevUsedPhone": null,
"stateValidated": false,
"isDeleted": false,
"organisations": [
{
"organisationId": "0126796199493140480",
"updatedBy": null,
"orgName": "org1",
"addedByName": null,
"addedBy": null,
"approvedBy": null,
"channel": "channel1",
"locationIds": "027f81d8-0a2c-4fc6-96ac-59fe4cea3abf 8250d58d-f1a2-4397-bfd3-b2e688ba7141",
"orgLocation": [
{
"type": "state",
"id": "027f81d8-0a2c-4fc6-96ac-59fe4cea3abf"
},
{
"type": "district",
"id": "8250d58d-f1a2-4397-bfd3-b2e688ba7141"
}
],
"externalId": 101010,
"updatedDate": null,
"isSelfDeclared": true,
"associationtype": 2,
"isSystemUpload": false,
"isSSO": false,
"userId": "96102c3f-2c22-4614-8dcc-6b130cefe586",
"approvaldate": null,
"isSchool": false,
"isDeleted": false,
"hashTagId": "0126796199493140480",
"isRejected": null,
"locations": [
{
"code": 29,
"name": "state1",
"id": "027f81d8-0a2c-4fc6-96ac-59fe4cea3abf",
"type": "state",
"parentId": null
},
{
"code": 2901,
"name": "district1",
"id": "8250d58d-f1a2-4397-bfd3-b2e688ba7141",
"type": "district",
"parentId": "027f81d8-0a2c-4fc6-96ac-59fe4cea3abf"
}
],
"id": "01324864401294131212",
"position": null,
"isApproved": null,
"orgjoindate": "2021-04-01 08:19:53:343+0000",
"orgLeftDate": null
},
{
"organisationId": "0127419693630996481321",
"updatedBy": "96102c3f-2c22-4614-8dcc-6b130cefe586",
"orgName": "org2",
"addedByName": null,
"addedBy": "96102c3f-2c22-4614-8dcc-6b130cefe586",
"approvedBy": null,
"channel": "tn",
"locationIds": "91d9baae-14f1-477a-955c-f91bd9037f0b 107c9472-a950-4768-bcd6-f882910177c4 ba31e7c2-fac9-472a-8867-1582c73bcca8 5c8876b5-981c-4c6a-b23d-20c9e17428e1",
"orgLocation": [
{
"id": "91d9baae-14f1-477a-955c-f91bd9037f0b",
"type": "state"
},
{
"id": "107c9472-a950-4768-bcd6-f882910177c4",
"type": "district"
},
{
"id": "ba31e7c2-fac9-472a-8867-1582c73bcca8",
"type": "block"
},
{
"id": "5c8876b5-981c-4c6a-b23d-20c9e17428e1",
"type": "cluster"
}
],
"externalId": 33100800608,
"updatedDate": "2021-04-07 05:09:38:366+0000",
"userId": "96102c3f-2c22-4614-8dcc-6b130cefe586",
"approvaldate": null,
"isSchool": true,
"isDeleted": false,
"hashTagId": "0127419693630996481321",
"isRejected": false,
"locations": [
{
"code": 31,
"name": "state2",
"id": "91d9baae-14f1-477a-955c-f91bd9037f0b",
"type": "state",
"parentId": null
},
{
"code": 3110,
"name": "district2",
"id": "107c9472-a950-4768-bcd6-f882910177c4",
"type": "district",
"parentId": "91d9baae-14f1-477a-955c-f91bd9037f0b"
},
{
"code": 31100169,
"name": "block1",
"id": "ba31e7c2-fac9-472a-8867-1582c73bcca8",
"type": "block",
"parentId": "107c9472-a950-4768-bcd6-f882910177c4"
},
{
"code": 3110016901,
"name": "block1 Cluster",
"id": "5c8876b5-981c-4c6a-b23d-20c9e17428e1",
"type": "cluster",
"parentId": "ba31e7c2-fac9-472a-8867-1582c73bcca8"
}
],
"id": "0132527931586969602",
"position": null,
"isApproved": false,
"orgjoindate": "2021-04-07 05:09:45:655+0000",
"orgLeftDate": "2021-04-07 05:09:38:366+0000"
}
],
"provider": null,
"countryCode": null,
"tncLatestVersionUrl": "https://organisation2.blob.core.windows.net/termsandcondtions/terms-and-conditions-v9.html#termsOfUse",
"maskedEmail": "k1**@yopmail.com",
"email": "k1**@yopmail.com",
"rootOrg": {
"dateTime": null,
"preferredLanguage": null,
"keys": null,
"approvedBy": null,
"channel": "channel1",
"description": "org3",
"updatedDate": "2021-03-31 17:31:19:346+0000",
"addressId": null,
"organisationType": 5,
"orgType": null,
"isTenant": true,
"provider": null,
"locationId": null,
"orgCode": null,
"theme": null,
"id": "0126796199493140480",
"communityId": null,
"isApproved": null,
"email": null,
"slug": "channel1",
"isSSOEnabled": null,
"orgName": "org1",
"updatedBy": null,
"locationIds": "027f81d8-0a2c-4fc6-96ac-59fe4cea3abf 8250d58d-f1a2-4397-bfd3-b2e688ba7141",
"externalId": 101010,
"orgLocation": [
{
"type": "state",
"id": "027f81d8-0a2c-4fc6-96ac-59fe4cea3abf"
},
{
"type": "district",
"id": "8250d58d-f1a2-4397-bfd3-b2e688ba7141"
}
],
"isRootOrg": true,
"rootOrgId": "0126796199493140480",
"approvedDate": null,
"imgUrl": null,
"homeUrl": null,
"orgTypeId": null,
"isDefault": null,
"createdDate": "2019-01-18 09:48:13:428+0000",
"createdBy": "system",
"parentOrgId": null,
"hashTagId": "0126796199493140480",
"noOfMembers": null,
"status": 1
},
"phoneVerified": false,
"tcUpdatedDate": null,
"userLocations": [
{
"code": 3110,
"name": "district2",
"id": "107c9472-a950-4768-bcd6-f882910177c4",
"type": "district",
"parentId": "91d9baae-14f1-477a-955c-f91bd9037f0b"
},
{
"code": 3110016901,
"name": "block1 Cluster",
"id": "5c8876b5-981c-4c6a-b23d-20c9e17428e1",
"type": "cluster",
"parentId": "ba31e7c2-fac9-472a-8867-1582c73bcca8"
},
{
"code": 31,
"name": "state2",
"id": "91d9baae-14f1-477a-955c-f91bd9037f0b",
"type": "state",
"parentId": null
},
{
"code": 31100169,
"name": "block1",
"id": "ba31e7c2-fac9-472a-8867-1582c73bcca8",
"type": "block",
"parentId": "107c9472-a950-4768-bcd6-f882910177c4"
},
{
"identifier": "2e4a420e-a6b8-4688-b12e-0e5f5141d175",
"code": 31100800608,
"name": "org2",
"id": "2e4a420e-a6b8-4688-b12e-0e5f5141d175",
"type": "school",
"parentId": "5c8876b5-981c-4c6a-b23d-20c9e17428e1"
}
],
"recoveryPhone": null,
"userName": "username 2",
"userId": "96102c3f-2c22-4614-8dcc-6b130cefe586",
"userSubType": null,
"promptTnC": false,
"emailVerified": true,
"createdDate": "2021-04-01 08:19:50:971+0000",
"framework": {
"board": "State state3",
"gradeLevel": "Class 1",
"id": "ap_k-12_1",
"medium": "English",
"subject": "English"
},
"createdBy": null,
"profileUserType": {
"subType": null,
"type": "student"
},
"profileUserTypes": [
{
"subType": null,
"type": "student"
}
],
"tncAcceptedVersion": "3.5.0"
}
}
}
/api/course/v1/batch/list API Method: GET
Sample Response Payload
{
"id": "api.course.batch.search",
"ver": "v1",
"ts": "2020-11-23 15:31:47:895+0000",
"params": {
"resmsgid": null,
"msgid": "3b07f74d-59af-494c-8d41-c8b665fa75ea",
"err": null,
"status": "success",
"errmsg": null
},
"responseCode": "OK",
"result": {
"response": {
"count": 15,
"content": [
{
"identifier": "0131440087048683528",
"createdFor": [],
"endDate": "2020-11-30",
"description": "batch description1",
"updatedDate": null,
"cert_templates": {
"Test_Template_prad": {
"identifier": "Test_Template_prad",
"criteria": {
"enrollment": {
"status": 2
}
},
"name": "Updated Asset",
"notifyTemplate": {
"emailTemplateType": "defaultCertTemp",
"subject": "Completion certificate",
"stateImgUrl": "https://sunbirddev.blob.core.windows.net/orgemailtemplate/img/File-0128212938260643843.png",
"regards": "Minister of Gujarat",
"regardsperson": "Chairperson"
},
"issuer": {
"name": "Gujarat Council of Educational Research and Training",
"url": "https://gcert.gujarat.gov.in/gcert/"
},
"url": "https://sunbirddev.blob.core.windows.net/sunbird-content-dev/content/test_template_prad/artifact/file-0130860005482086401.svg",
"signatoryList": [
{
"image": "https://cdn.pixabay.com/photo/2014/11/09/08/06/signature-523237__340.jpg",
"name": "CEO Gujarat",
"id": "CEO",
"designation": "CEO"
}
]
}
},
"batchId": "0131440087048683528",
"tandc": null,
"createdDate": "2020-11-04 12:26:38:668+0000",
"createdBy": "95e4942d-cbe8-477d-aebd-ad8e6de4bfc8",
"mentors": [],
"name": "test cert scalability",
"id": "0131440087048683528",
"enrollmentType": "open",
"enrollmentEndDate": null,
"courseId": "do_1131396442662912001425",
"collectionId": "do_1131396442662912001425",
"startDate": "2020-11-04",
"status": 1
},
{
"identifier": "0131439524674273284",
"createdFor": [],
"endDate": "2020-12-30",
"description": "batch description1",
"updatedDate": null,
"cert_templates": {
"Test_Template_prad": {
"identifier": "Test_Template_prad",
"criteria": {
"enrollment": {
"status": 2
}
},
"name": "Updated Asset",
"notifyTemplate": {
"emailTemplateType": "defaultCertTemp",
"subject": "Completion certificate",
"stateImgUrl": "https://sunbirddev.blob.core.windows.net/orgemailtemplate/img/File-0128212938260643843.png",
"regards": "Minister of Gujarat",
"regardsperson": "Chairperson"
},
"issuer": {
"name": "Gujarat Council of Educational Research and Training",
"url": "https://gcert.gujarat.gov.in/gcert/"
},
"url": "https://sunbirddev.blob.core.windows.net/sunbird-content-dev/content/test_template_prad/artifact/file-0130860005482086401.svg",
"signatoryList": [
{
"image": "https://cdn.pixabay.com/photo/2014/11/09/08/06/signature-523237__340.jpg",
"name": "CEO Gujarat",
"id": "CEO",
"designation": "CEO"
}
]
}
},
"batchId": "0131439524674273284",
"tandc": null,
"createdDate": "2020-11-04 10:24:25:778+0000",
"createdBy": "95e4942d-cbe8-477d-aebd-ad8e6de4bfc8",
"mentors": [],
"name": "test cert scalability",
"id": "0131439524674273284",
"enrollmentType": "open",
"enrollmentEndDate": null,
"courseId": "do_1131396442662912001425",
"collectionId": "do_1131396442662912001425",
"startDate": "2020-11-04",
"status": 1
}
]
}
}
}
/api/user/v3/search API Method: GET
Sample Response Payload
{
"id": "api.user.search",
"ver": "v2",
"ts": "2020-11-23 09:16:58:628+0000",
"params": {
"resmsgid": null,
"msgid": "ad7135b8-ef64-44bd-adaa-0b131a657689",
"err": null,
"status": "success",
"errmsg": null
},
"responseCode": "OK",
"result": {
"response": {
"count": 1,
"content": [
{
"maskedPhone": null,
"tcStatus": null,
"channel": "channel1",
"updatedDate": "2021-04-07 05:09:45:607+0000",
"managedBy": null,
"flagsValue": 2,
"id": "96102c3f-2c22-4614-8dcc-6b130cefe586",
"recoveryEmail": "co**************@yopmail.com",
"identifier": "96102c3f-2c22-4614-8dcc-6b130cefe586",
"updatedBy": "96102c3f-2c22-4614-8dcc-6b130cefe586",
"externalIds": [],
"rootOrgId": "0126796199493140480",
"prevUsedEmail": null,
"firstname": "first name",
"tncAcceptedOn": 1617265216047,
"allTncAccepted": {},
"phone": null,
"dob": null,
"userType": "student",
"status": 1,
"lastName": null,
"tncLatestVersion": "3.5.0",
"roles": [
{
"role": "COURSE_CREATOR",
"userId": "96102c3f-2c22-4614-8dcc-6b130cefe586",
"scope": [
{
"organisationId": "0126796199493140480"
}
],
"createdDate": "2021-06-07 11:29:41:606+0530",
"updatedBy": null,
"createdBy": "96102c3f-2c22-4614-8dcc-6b130cefe586",
"updatedDate": null
}
],
"prevUsedPhone": null,
"stateValidated": false,
"isDeleted": false,
"organisations": [
{
"organisationId": "0126796199493140480",
"updatedBy": null,
"orgName": "org1",
"addedByName": null,
"addedBy": null,
"approvedBy": null,
"channel": "channel1",
"locationIds": "027f81d8-0a2c-4fc6-96ac-59fe4cea3abf 8250d58d-f1a2-4397-bfd3-b2e688ba7141",
"orgLocation": [
{
"type": "state",
"id": "027f81d8-0a2c-4fc6-96ac-59fe4cea3abf"
},
{
"type": "district",
"id": "8250d58d-f1a2-4397-bfd3-b2e688ba7141"
}
],
"externalId": 101010,
"updatedDate": null,
"userId": "96102c3f-2c22-4614-8dcc-6b130cefe586",
"approvaldate": null,
"isSchool": false,
"isDeleted": false,
"hashTagId": "0126796199493140480",
"isRejected": null,
"locations": [
{
"code": 29,
"name": "state1",
"id": "027f81d8-0a2c-4fc6-96ac-59fe4cea3abf",
"type": "state",
"parentId": null
},
{
"code": 2901,
"name": "district1",
"id": "8250d58d-f1a2-4397-bfd3-b2e688ba7141",
"type": "district",
"parentId": "027f81d8-0a2c-4fc6-96ac-59fe4cea3abf"
}
],
"id": "01324864401294131212",
"position": null,
"isApproved": null,
"orgjoindate": "2021-04-01 08:19:53:343+0000",
"orgLeftDate": null
},
{
"organisationId": "0127419693630996481321",
"updatedBy": "96102c3f-2c22-4614-8dcc-6b130cefe586",
"orgName": "org2",
"addedByName": null,
"addedBy": "96102c3f-2c22-4614-8dcc-6b130cefe586",
"approvedBy": null,
"channel": "tn",
"locationIds": "91d9baae-14f1-477a-955c-f91bd9037f0b 107c9472-a950-4768-bcd6-f882910177c4 ba31e7c2-fac9-472a-8867-1582c73bcca8 5c8876b5-981c-4c6a-b23d-20c9e17428e1",
"orgLocation": [
{
"id": "91d9baae-14f1-477a-955c-f91bd9037f0b",
"type": "state"
},
{
"id": "107c9472-a950-4768-bcd6-f882910177c4",
"type": "district"
},
{
"id": "ba31e7c2-fac9-472a-8867-1582c73bcca8",
"type": "block"
},
{
"id": "5c8876b5-981c-4c6a-b23d-20c9e17428e1",
"type": "cluster"
}
],
"externalId": 33100800608,
"updatedDate": "2021-04-07 05:09:38:366+0000",
"userId": "96102c3f-2c22-4614-8dcc-6b130cefe586",
"approvaldate": null,
"isSchool": true,
"isDeleted": false,
"hashTagId": "0127419693630996481321",
"isRejected": false,
"locations": [
{
"code": 31,
"name": "state2",
"id": "91d9baae-14f1-477a-955c-f91bd9037f0b",
"type": "state",
"parentId": null
},
{
"code": 3110,
"name": "district2",
"id": "107c9472-a950-4768-bcd6-f882910177c4",
"type": "district",
"parentId": "91d9baae-14f1-477a-955c-f91bd9037f0b"
},
{
"code": 31100169,
"name": "block1",
"id": "ba31e7c2-fac9-472a-8867-1582c73bcca8",
"type": "block",
"parentId": "107c9472-a950-4768-bcd6-f882910177c4"
},
{
"code": 3110016901,
"name": "block1 Cluster",
"id": "5c8876b5-981c-4c6a-b23d-20c9e17428e1",
"type": "cluster",
"parentId": "ba31e7c2-fac9-472a-8867-1582c73bcca8"
}
],
"id": "0132527931586969602",
"position": null,
"isApproved": false,
"orgjoindate": "2021-04-07 05:09:45:655+0000",
"orgLeftDate": "2021-04-07 05:09:38:366+0000"
}
],
"provider": null,
"countryCode": null,
"tncLatestVersionUrl": "https://organisation2.blob.core.windows.net/termsandcondtions/terms-and-conditions-v9.html#termsOfUse",
"maskedEmail": "k1**@yopmail.com",
"email": "k1**@yopmail.com",
"rootOrg": {
"dateTime": null,
"preferredLanguage": null,
"keys": null,
"approvedBy": null,
"channel": "channel1",
"description": "org3",
"updatedDate": "2021-03-31 17:31:19:346+0000",
"addressId": null,
"organisationType": 5,
"orgType": null,
"isTenant": true,
"provider": null,
"locationId": null,
"orgCode": null,
"theme": null,
"id": "0126796199493140480",
"communityId": null,
"isApproved": null,
"email": null,
"slug": "channel1",
"isSSOEnabled": null,
"orgName": "org1",
"updatedBy": null,
"locationIds": "027f81d8-0a2c-4fc6-96ac-59fe4cea3abf 8250d58d-f1a2-4397-bfd3-b2e688ba7141",
"externalId": 101010,
"orgLocation": [
{
"type": "state",
"id": "027f81d8-0a2c-4fc6-96ac-59fe4cea3abf"
},
{
"type": "district",
"id": "8250d58d-f1a2-4397-bfd3-b2e688ba7141"
}
],
"isRootOrg": true,
"rootOrgId": "0126796199493140480",
"approvedDate": null,
"imgUrl": null,
"homeUrl": null,
"orgTypeId": null,
"isDefault": null,
"createdDate": "2019-01-18 09:48:13:428+0000",
"createdBy": "system",
"parentOrgId": null,
"hashTagId": "0126796199493140480",
"noOfMembers": null,
"status": 1
},
"phoneVerified": false,
"tcUpdatedDate": null,
"userLocations": [
{
"code": 3110,
"name": "district2",
"id": "107c9472-a950-4768-bcd6-f882910177c4",
"type": "district",
"parentId": "91d9baae-14f1-477a-955c-f91bd9037f0b"
},
{
"code": 3110016901,
"name": "block1 Cluster",
"id": "5c8876b5-981c-4c6a-b23d-20c9e17428e1",
"type": "cluster",
"parentId": "ba31e7c2-fac9-472a-8867-1582c73bcca8"
},
{
"code": 31,
"name": "state2",
"id": "91d9baae-14f1-477a-955c-f91bd9037f0b",
"type": "state",
"parentId": null
},
{
"code": 31100169,
"name": "block1",
"id": "ba31e7c2-fac9-472a-8867-1582c73bcca8",
"type": "block",
"parentId": "107c9472-a950-4768-bcd6-f882910177c4"
},
{
"identifier": "2e4a420e-a6b8-4688-b12e-0e5f5141d175",
"code": 31100800608,
"name": "org2",
"id": "2e4a420e-a6b8-4688-b12e-0e5f5141d175",
"type": "school",
"parentId": "5c8876b5-981c-4c6a-b23d-20c9e17428e1"
}
],
"recoveryPhone": null,
"userName": "username 2",
"userId": "96102c3f-2c22-4614-8dcc-6b130cefe586",
"userSubType": null,
"promptTnC": false,
"emailVerified": true,
"createdDate": "2021-04-01 08:19:50:971+0000",
"framework": {
"board": "State state3",
"gradeLevel": "Class 1",
"id": "ap_k-12_1",
"medium": "English",
"subject": "English"
},
"createdBy": null,
"profileUserType": {
"subType": null,
"type": "student"
},
"profileUserTypes": [
{
"subType": null,
"type": "student"
}
],
"tncAcceptedVersion": "3.5.0"
}
]
}
}
}
/api/course/v1/hierarchy/{{content_id}} API Method: GET
Sample Response Payload
{
"id": "api.course.hierarchy",
"ver": 1,
"ts": "2020-12-31T05:40:05.182Z",
"params": {
"resmsgid": "a27e2de0-4b2a-11eb-9b0c-abcfbdf41bc3",
"msgid": "a27c5920-4b2a-11eb-9b0c-abcfbdf41bc3",
"status": "successful",
"err": null,
"errmsg": null
},
"responseCode": "OK",
"result": {