-
Notifications
You must be signed in to change notification settings - Fork 9
/
coursebatchmanapi (1) (1) (2).yaml
1795 lines (1794 loc) · 63.7 KB
/
coursebatchmanapi (1) (1) (2).yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.1
info:
title: Course Batch Management APIs
description: |-
The Course Batch Management API allows you to manage course batches on the Sunbird platform. A batch is used to arrange courses for specific sets or groups.The basic operations for this API include Create, Update, Read, List(Search).
The URL for Coure Batch Management API(s) is /course/v1/batch.
- The backend URL for Coure Batch Management API(s) is /v1/course/batch.
- [TestCases](https://app.getpostman.com/run-collection/1122b59b7dc69b2b370b)
termsOfService: https://github.com/project-sunbird/sunbird-commons/blob/master/LICENSE
contact:
email: info@sunbird.org
version: '1.0'
servers:
- url: 'https://staging.open-sunbird.org/api'
paths:
'/course/v1/batch/read/{batch-id}':
get:
tags:
- Course Batch APIs
summary: CourseBatch Read
description: |-
Fetch a particular Batch
This API is associated with fetching a particular batch on the Sunbird Platform.
The endpoint for Fetch a particular Batch is /batch/read/{Batch_ID}
The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
operationId: CourseBatchRead
parameters:
- name: Authorization
in: header
description: '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.'
required: true
style: simple
schema:
type: string
example: '{{api-key}}'
- name: x-authenticated-user-token
in: header
description: 'The alphanumeric string to access the API'
required: true
style: simple
schema:
type: string
example: '{{authToken}}'
- name: Content-Type
in: header
description: 'The Content Type entity is the media type of the resource.Possible\
\ media types can be:- \n - application/json'
required: true
style: simple
schema:
type: string
example: application/json
- name: batch-id
in: path
description: 'Append a valid Batch ID To the Request URL'
required: true
style: simple
schema:
type: string
responses:
'200':
description: 'SUCCESS. The **Fetch a batch** operation was successful!'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/coursebatchmanapiCourseBatchRead-200OK'
example:
id: api.course.batch.read
ver: v1
ts: '2020-11-23 15:10:45:215+0000'
params:
resmsgid: null
msgid: aa240e09-4481-4cbd-a832-617a15e8e872
err: null
status: success
errmsg: null
responseCode: OK
result:
response:
identifier: 0131439667998310406
createdFor: []
endDate: 2020-12-30
description: batch description1
updatedDate:
cert_templates:
Test_Template_4:
identifier: Test_Template_4
criteria:
enrollment:
status: 2
name: Test_Template_4
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_4/artifact/cbse.svg
signatoryList:
- image: https://cdn.pixabay.com/photo/2014/11/09/08/06/signature-523237__340.jpg
name: CEO Gujarat
id: CEO
designation: CEO
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
template_01_dev_001:
identifier: template_01_dev_001
criteria:
enrollment:
status: 2
name: Course merit certificate
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: ''
signatoryList:
- image: https://cdn.pixabay.com/photo/2014/11/09/08/06/signature-523237__340.jpg
name: CEO Gujarat
id: CEO
designation: CEO
batchId: 0131439667998310406
tandc:
createdDate: 2020-11-04 10:54:31:731+0000
createdBy: 95e4942d-cbe8-477d-aebd-ad8e6de4bfc8
mentors: []
name: test cert scalability
id: 0131439667998310406
enrollmentType: open
enrollmentEndDate:
courseId: do_1131396442662912001425
collectionId: do_1131396442662912001425
startDate: 2020-11-04
status: 1
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/coursebatchmanapiCourseBatchCreate-400BadRequest-InvalidCourseId'
example:
id: api.course.batch.read
ver: v1
ts: '2020-11-23 06:48:19:128+0000'
params:
resmsgid: null
msgid: 50f76a53-4710-4333-936f-c043031eec03
err: SERVER_ERROR
status: SERVER_ERROR
errmsg: SERVER_ERROR
responseCode: SERVER_ERROR
result: {}
deprecated: false
security:
- bearer: []
/course/v1/batch/update:
patch:
tags:
- Course Batch APIs
summary: CourseBatch Update
description: |-
This API is associated with updating a batch on the Sunbird Platform.
The endpoint for Course Batch Update is /batch/update
The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
operationId: CourseBatchUpdate
parameters:
- name: Content-Type
in: header
description: 'The Content Type entity is the media type of the resource.Possible\
\ media types can be:- \n - application/json'
required: true
style: simple
schema:
type: string
example: application/json
- name: x-authenticated-user-token
in: header
description: 'The alphanumeric string for accessing the API'
required: true
style: simple
schema:
type: string
example: '{{authToken}}'
- name: Authorization
in: header
description: '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.'
required: true
style: simple
schema:
type: string
example: '{{api-key}}'
requestBody:
description: 'The body refers to the format of the request.
- The body contains metadata about the batch to be updated.'
content:
application/json:
schema:
$ref: '#/components/schemas/coursebatchmanapiCourseBatchUpdateRequest'
example:
request:
enrollmentType: open
startDate: '2020-11-23'
enrollmentEndDate: '2021-12-30'
status: 1
courseId: '{{course-id}}'
id: '{{batch-id}}'
required: true
responses:
'200':
description: 'SUCCESS. The **Update a batch** operation was successful!'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/coursebatchmanapiCourseBatchUpdate-200OK'
example:
id: api.course.batch.update
ver: v1
ts: '2020-11-23 06:59:52:152+0000'
params:
resmsgid: null
msgid: 8e27cbf5-e299-43b0-bca7-8347f7e5abcf
err: null
status: success
errmsg: null
responseCode: OK
result: {}
'400':
description: BAD REQUEST,**Update a batch** operation failed !The possible
reason for failure is that you may have missed providing input for a mandatory
parameter
content:
application/json:
schema:
$ref: '#/components/schemas/coursebatchmanapiCourseBatchCreate-400BadRequest-InvalidCourseId'
example:
id: api.course.batch.update
ver: v1
ts: '2020-11-23 06:57:38:160+0000'
params:
resmsgid: null
msgid: 8e27cbf5-e299-43b0-bca7-8347f7e5abcf
err: INVALID_BATCH_START_DATE_ERROR
status: INVALID_BATCH_START_DATE_ERROR
errmsg: Please provide valid Start Date.
responseCode: CLIENT_ERROR
result: {}
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/coursebatchmanapiCourseBatchCreate-500InternalServerError'
example:
id: api.course.batch.update
ver: v1
ts: '2020-11-23 15:15:18:331+0000'
params:
resmsgid: null
msgid: null
err: INTERNAL_ERROR
status: SERVER_ERROR
errmsg: 'Process failed,please try again later.'
responseCode: SERVER_ERROR
result: {}
deprecated: false
security:
- bearer: []
/course/v1/batch/list:
post:
tags:
- Course Batch APIs
summary: CourseBatch Search
description: |-
Lists the existing batches
This API is associated with fetching and listing existing batches
The endpoint for Lists the existing batches is /batch/list
The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
operationId: CourseBatchSearch
parameters:
- in: query
name: orgdetails
description: 'Extra data can be passed in query parameter with above mentioned key and comma separated value. Example,?orgdetails=email,name. Sunbird will take this query parameter and pass to content service as it is, and content service does the needful.'
schema:
type: string
required: true
- name: Content-Type
in: header
description: 'The Content Type entity is the media type of the resource.Possible\
\ media types can be:- \n - application/json'
required: true
style: simple
schema:
type: string
example: application/json
- name: Authorization
in: header
description: '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.'
required: true
style: simple
schema:
type: string
example: '{{api-key}}'
- name: x-authenticated-user-token
in: header
description: 'The alphanumeric string for accessing the API'
required: true
style: simple
schema:
type: string
example: '{{authToken}}'
requestBody:
description: 'The body refers to the format of the request.'
content:
application/json:
schema:
$ref: '#/components/schemas/coursebatchmanapiCourseBatchSearchRequest'
example:
request:
filters:
courseId: '{{course-id}}'
limit: 2
required: true
responses:
'200':
description: 'SUCCESS. The **Lists the existing batches** operation was successful!'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/coursebatchmanapiCourseBatchSearch-200OK'
example:
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
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/coursebatchmanapiCourseBatchCreate-500InternalServerError'
example:
id: api.course.batch.search
ver: v1
ts: '2020-11-23 15:15:18:331+0000'
params:
resmsgid: null
msgid: null
err: INTERNAL_ERROR
status: SERVER_ERROR
errmsg: 'Process failed,please try again later.'
responseCode: SERVER_ERROR
result: {}
deprecated: false
security:
- bearer: []
/course/v1/batch/create:
post:
tags:
- Course Batch APIs
summary: CourseBatch Create
description: |-
This API is associated with batch creation
The endpoint for Creates a Batch is /batch/create
The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
operationId: CourseBatchCreate
parameters:
- name: Content-Type
in: header
description: 'The Content Type entity is the media type of the resource.Possible\
\ media types can be:- \n - application/json'
required: true
style: simple
schema:
type: string
example: application/json
- name: x-authenticated-user-token
in: header
description: 'The alphanumeric string to access the API'
required: true
style: simple
schema:
type: string
example: '{{authToken}}'
- name: Authorization
in: header
description: '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.'
required: true
style: simple
schema:
type: string
example: '{{api-key}}'
requestBody:
description: The body refers to the format of the request.
- The body contains metadata about the new batch to be created.
content:
application/json:
schema:
$ref: '#/components/schemas/coursebatchmanapiCourseBatchCreateRequest'
example:
request:
courseId: '{{course-id}}'
name: test cert scalability
description: batch description1
enrollmentType: open
startDate: '2020-11-23'
endDate: '2021-12-30'
required: true
responses:
'200':
description: Success example for batch create
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/coursebatchmanapiCourseBatchCreate-200OK'
example:
id: api.course.batch.create
ver: v1
ts: '2020-11-23 06:42:39:001+0000'
params:
resmsgid: null
msgid: 8c244093-e19d-4694-a4ba-342bc0f8b721
err: null
status: success
errmsg: null
responseCode: OK
result:
response: SUCCESS
batchId: 01315728917531852810
'400':
description: BAD REQUEST,**create batch** operation failed !The possible
reason for failure is that you may have missed providing input for a mandatory
parameter
content:
application/json:
schema:
$ref: '#/components/schemas/coursebatchmanapiCourseBatchCreate-400BadRequest-InvalidCourseId'
examples:
a:
summary: Invalid_CourseId
description: Response example when invalid course id got passed into request
value:
id: api.course.batch.create
ver: v1
ts: '2020-11-23 06:40:48:878+0000'
params:
resmsgid: null
msgid: e85a4592-7458-4506-a3e3-0dc00d923616
err: INVALID_COURSE_ID
status: INVALID_COURSE_ID
errmsg: Course doesnot exist. Please provide a valid course identifier
responseCode: CLIENT_ERROR
result: {}
b:
summary: Mandatory_Parameter_Missing
description: Response example for any parameter is missing into request
value:
id: api.course.batch.create
ver: v1
ts: '2020-11-23 06:40:48:878+0000'
params:
resmsgid: null
msgid: 4bc18ba9-0f3a-44ad-884a-d8b15c5680d1
err: MANDATORY_PARAMETER_MISSING
status: MANDATORY_PARAMETER_MISSING
errmsg: Mandatory parameter courseId/collectionId is missing.
responseCode: CLIENT_ERROR
result: {}
c:
summary: Invalid_Batch_Start_Date
description: Response example for invalid batch start date
value:
id: api.course.batch.create
ver: v1
ts: '2020-11-23 06:40:48:878+0000'
params:
resmsgid: null
msgid: 358e9376-0eb4-426b-903f-42a0a5235c39
err: COURSE_BATCH_START_DATE_INVALID
status: COURSE_BATCH_START_DATE_INVALID
errmsg: Batch start date should be either today or future date.
responseCode: CLIENT_ERROR
result: {}
d:
summary: Invalid_Batch_End_Date
description: Response example for invalid batch end date
value:
id: api.course.batch.create
ver: v1
ts: '2020-11-23 06:40:48:878+0000'
params:
resmsgid: null
msgid: 40e5e6c9-3777-4a15-b820-124f974dc202
err: END_DATE_ERROR
status: END_DATE_ERROR
errmsg: End date should be greater than start date.
responseCode: CLIENT_ERROR
result: {}
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/coursebatchmanapiCourseBatchCreate-500InternalServerError'
example:
id: api.course.batch.create
ver: v1
ts: '2020-11-23 15:15:18:331+0000'
params:
resmsgid: null
msgid: null
err: INTERNAL_ERROR
status: SERVER_ERROR
errmsg: 'Process failed,please try again later.'
responseCode: SERVER_ERROR
result: {}
deprecated: false
security:
- bearer: []
components:
schemas:
coursebatchmanapiCourseBatchRead-200OK:
title: CourseBatchRead-200OK
required:
- id
- ver
- ts
- params
- responseCode
- result
type: object
properties:
id:
type: string
ver:
type: string
ts:
type: string
params:
$ref: '#/components/schemas/coursebatchmanapiParams1'
responseCode:
type: string
result:
$ref: '#/components/schemas/coursebatchmanapiResult'
example:
id: api.course.batch.read
ver: v1
ts: 2020-11-23 04:48:35:260+0000
params:
resmsgid:
msgid: 16824a40-389e-4008-aecc-f1d86be693c9
err:
status: success
errmsg:
responseCode: OK
result:
response:
identifier: 0131439667998310406
createdFor: []
endDate: 2020-12-30
description: batch description1
updatedDate:
cert_templates:
Test_Template_4:
identifier: Test_Template_4
criteria:
enrollment:
status: 2
name: Test_Template_4
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_4/artifact/cbse.svg
signatoryList:
- image: https://cdn.pixabay.com/photo/2014/11/09/08/06/signature-523237__340.jpg
name: CEO Gujarat
id: CEO
designation: CEO
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
template_01_dev_001:
identifier: template_01_dev_001
criteria:
enrollment:
status: 2
name: Course merit certificate
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: ''
signatoryList:
- image: https://cdn.pixabay.com/photo/2014/11/09/08/06/signature-523237__340.jpg
name: CEO Gujarat
id: CEO
designation: CEO
batchId: 0131439667998310406
tandc:
createdDate: 2020-11-04 10:54:31:731+0000
createdBy: 95e4942d-cbe8-477d-aebd-ad8e6de4bfc8
mentors: []
name: test cert scalability
id: 0131439667998310406
enrollmentType: open
enrollmentEndDate:
courseId: do_1131396442662912001425
collectionId: do_1131396442662912001425
startDate: 2020-11-04
status: 1
coursebatchmanapiCourseBatchRead-200InvalidBatchID:
title: CourseBatchRead-200InvalidBatchID
required:
- id
- ver
- ts
- params
- responseCode
- result
type: object
properties:
id:
type: string
ver:
type: string
ts:
type: string
params:
$ref: '#/components/schemas/coursebatchmanapiParams'
responseCode:
type: string
result:
$ref: '#/components/schemas/coursebatchmanapiResult'
example:
id: api.course.batch.read
ver: v1
ts: '2020-11-23 15:10:45:215+0000'
params:
resmsgid: null
msgid: aa240e09-4481-4cbd-a832-617a15e8e872
err: null
status: success
errmsg: null
responseCode: OK
result:
response: {}
coursebatchmanapiParams:
title: Params
required:
- resmsgid
- msgid
- err
- status
- errmsg
type: object
properties:
resmsgid:
type: string
nullable: true
msgid:
type: string
err:
type: string
nullable: true
status:
type: string
errmsg:
type: string
nullable: true
example:
resmsgid: null
msgid: aa240e09-4481-4cbd-a832-617a15e8e872
err: null
status: success
errmsg: null
coursebatchmanapiResult:
title: Result
required:
- response
type: object
properties:
response:
type: object
example:
response: {}
coursebatchmanapiParams1:
title: Params1
required:
- resmsgid
- msgid
- err
- status
- errmsg
type: object
properties:
resmsgid:
type: string
nullable: true
msgid:
type: string
err:
type: string
status:
type: string
errmsg:
type: string
coursebatchmanapiCourseBatchUpdateRequest:
title: CourseBatchUpdateRequest
required:
- request
type: object
properties:
request:
$ref: '#/components/schemas/coursebatchmanapiRequest'
example:
request:
enrollmentType: open
startDate: '2020-11-23'
enrollmentEndDate: '2021-12-30'
status: 1
courseId: '{{course-id}}'
id: '{{batch-id}}'
coursebatchmanapiRequest:
title: Request
required:
- startDate
- status
- courseId
- id
type: object
properties:
enrollmentType:
type: string
description: 'possible values are {invite-only and open}'
startDate:
type: string
description: 'Batch start date'
enrollmentEndDate:
type: string
description: 'Batch enrollment end date'
status:
type: integer
format: int32
description: 'Status of batch possible values are {0, 1 or 2}'
courseId:
type: string
description: 'Course id for which the user wants to update the batch'
id:
type: string
description: 'Batch id which the user wants to update'
endDate:
description: 'Batch end date can be updated if end date hasnt expired'
type: string
example:
enrollmentType: open
startDate: '2020-11-23'
enrollmentEndDate: '2021-12-30'
status: 1
courseId: '{{course-id}}'
id: '{{batch-id}}'
coursebatchmanapiParams2:
title: Params2
required:
- resmsgid
- msgid
- err
- status
- errmsg
type: object
properties:
resmsgid:
type: string
nullable: true
msgid:
type: string
nullable: true
err:
type: string
status:
type: string
errmsg:
type: string
coursebatchmanapiCourseBatchUpdate-200OK:
title: CourseBatchUpdate-200OK
required:
- id
- ver
- ts
- params
- responseCode
- result
type: object
properties:
id:
type: string
ver:
type: string
ts:
type: string
params:
$ref: '#/components/schemas/coursebatchmanapiParams'
responseCode:
type: string
result:
type: object
example:
id: api.course.batch.update
ver: v1
ts: '2020-11-23 06:59:52:152+0000'
params:
resmsgid: null
msgid: 8e27cbf5-e299-43b0-bca7-8347f7e5abcf
err: null
status: success
errmsg: null
responseCode: OK
result: {}
coursebatchmanapiCourseBatchSearchRequest:
title: CourseBatchSearchRequest
required:
- request
type: object
properties:
request:
$ref: '#/components/schemas/coursebatchmanapiRequest1'
example:
request:
filters:
courseId: '{{course-id}}'
limit: 2
coursebatchmanapiRequest1:
title: Request1
required:
- filters
type: object
properties:
query:
type: string
description: 'any text, it will do free text search eg. creatorDetails&orgDetails'
filters:
$ref: '#/components/schemas/coursebatchmanapiFilters'
limit: