APIs
Last updated
Was this helpful?
Last updated
Was this helpful?
Refer to **** the below various API documentation related to all the different APIs that are being consumed with in all the batch jobs.
POST
This API gives the collection summary, like the total number of enrolments, completion count, count of certificates issued.
request*
Object
filters*
Object
Search filters
collectionId*
String
Id of the collection
batchId*
String
Id of the batch
group_by
String Array
"state", "dist"
intervals
String
2019-09-23T00:00:00.000Z/2019-09-24T00:00:00.000Z" StartDate - Batch Start Date and Default EndDate - Current Date
The UserEnrolmentList api provides the detail of a user's all enrolled CourseBatches The endpoint for UserEnrolment List is /user/enrollment/list/{{user-id}}
The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
Id of user for whom enrolment details we want
Org details related with course
orgName,emailLicense details related with course
name,description,urlDifferent course related details can be passed
contentType,topic,name,channelBatch details can be passed to filter
name,endDate,startDate,status,enrollmentType,createdBy,certificatesThe batch data got updated in cache after sometime to get updated details immediately we can pass cache false
cache=falseThe Content Type entity is the media type of the resource.Possible media types can be:- Application/json
application/jsonTo make use of the API, you require authorization. Raise a request to the administrator for the use of the API. You will receive the authorization key. Specify the key received, here.
{{api-key}}The alphanumeric string for accessing the API
{{authToken}}The API associated with user enrolment into a courseBatch. The endpoint for Course Enrol is /enrol
The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
To make use of the API, you require authorization. Raise a request to the administrator for the use of the API. You will receive the authorization key. Specify the key received, here.
{{api-key}}The alphanumeric string for accessing the API
{{authToken}}The Course Unenrol API is associated with unenrol of a user from a CourseBatch. The endpoint for Course Unenrol is /unenrol
The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
To make use of the API, you require authorization. Raise a request to the administrator for the use of the API. You will receive the authorization key. Specify the key received, here.
{{api-key}}The alphanumeric string for accessing the API
{{authToken}}This API is associated with fetching specific resources.
/read/{pageName}Please append a valid Section Id to the request URL
The Content Type entity is the media type of the resource. Possible media types can be:-
This Id Uniquely identifies a request if the same API is executed multiple times.
Time Stamp at which get specific page resources request was sent.
All User APIs require authorization for use. Specify the authorization key received from the administrator when placing the request for use of the API.
The token/key used to execute the API
Page Read Response
This API is associated with fetching specific section details.
/section/read/{sectionId}Please append a valid Section Id to the request URL
The Content Type entity is the media type of the resource. Possible media types can be:-
This Id Uniquely identifies a request if the same API is executed multiple times.
Time Stamp at which Fetch Section Details request was sent.
All User APIs require authorization for use. Specify the authorization key received from the administrator when placing the request for use of the API.
The token/key used to execute the API
Create Content Response
This API is associated with fetching the settings of a page.
/section/listThe Content Type entity is the media type of the resource. Possible media types can be:-
This Id Uniquely identifies a request if the same API is executed multiple times.
Time Stamp at which fetch settings request was sent.
All User APIs require authorization for use. Specify the authorization key received from the administrator when placing the request for use of the API.
The token/key used to execute the API
Create Content Response
This API allows you to attach certificate templates.
The Content Type entity is the media type of the resource.Possible media types can be Application/json
The timestamp at which the Add certificate template request was sent.
A unique ID that identifies the request, in case the same API is executed multiple times.
The access token of the registered user sending the given API request. This is an alphanumeric string.
To make use of the API, you require authorization. Raise a request to the administrator for the use of the API. You will receive the authorization key. Specify the key received here.
This API is associated with detaching certificate templates.
The Content Type entity is the media type of the resource.Possible media types can be Application/json
The timestamp at which the remove certificate template request was sent.
A unique ID that identifies the request in case the same API is executed multiple times.
The access token of the registered user sending the given API request. This is an alphanumeric string.
To make use of the API, you require authorization. Raise a request to the administrator for the use of the API. You will receive the authorization key. Specify the key received here.
This API is associated with creating a new page. To create a page first create the page section using section create api.make page name unique.
/createThe Content Type entity is the media type of the resource. Possible media types can be:-
This Id Uniquely identifies a request if the same API is executed multiple times.
Time Stamp at which creating page request was sent.
All User APIs require authorization for use. Specify the authorization key received from the administrator when placing the request for use of the API.
The token/key used to execute the API
unique API ID2013/10/15 16:16:39Create Content Response
This API is associated with updating the page information
/updateThe Content Type entity is the media type of the resource. Possible media types can be:-
This Id Uniquely identifies a request if the same API is executed multiple times.
Time Stamp at which update page information request was sent.
All User APIs require authorization for use. Specify the authorization key received from the administrator when placing the request for use of the API.
The token/key used to execute the API
unique API ID2013/10/15 16:16:39Create Content Response
This API is associated with creating a new section on a page.
/section/createThe Content Type entity is the media type of the resource. Possible media types can be:-
This Id Uniquely identifies a request if the same API is executed multiple times.
Time Stamp at which create section request was sent.
All User APIs require authorization for use. Specify the authorization key received from the administrator when placing the request for use of the API.
The token/key used to execute the API
unique API ID2013/10/15 16:16:39Create Content Response
This API is associated with updating content of a section on a page.
/section/updateThe Content Type entity is the media type of the resource. Possible media types can be:-
This Id Uniquely identifies a request if the same API is executed multiple times.
Time Stamp at which updating page section request was sent.
All User APIs require authorization for use. Specify the authorization key received from the administrator when placing the request for use of the API.
The token/key used to execute the API
unique API ID2013/10/15 16:16:39Create Content Response
This API will internally call ‘/dataset/v1/request/list API in Obsrv ‘On Demand Data Exhaust API’, to list all the requests that are specific to a tag
User token
{{auth_token}}API Key
{{kong_api_key}}application/jsonOrganisation id of the requestor
{{organisation_id}}UserId of the requester - ORG_ADMIN, COURSE_MENTOR
{{requested_user_id}}Successful response
No content
This API will internally call ‘/dataset/v1/request/submit’ API in SB-Obsrv ‘On Demand Data Exhaust API’, to submit the on demand exhaust job request. The job status will be in the submitted state.
User token
{{auth_token}}API key
{{kong_api_key}}application/jsonOrganisation id of the requestor
{{organisation_id}}UserId of the requester - ORG_ADMIN, COURSE_MENTOR
{{requested_user_id}}{"request":{"tag":"do_2137002173427875841205_01370023185341644821","requestedBy":"fca2925f-1eee-4654-9177-fece3fd6afc9","dataset":"response-exhaust","datasetConfig":{"batchId":"01370023185341644821"},"output_format":"csv","encryptionKey":"encryption-keyencryption-keyencryption-keyencryption-keyencryption-key"}}Successful response
No content