You are on page 1of 57

Document Control

Reference Code Kitaboo Cloud
Security
Classifcation
Company Confdential
Version 1.0
Author Arvind Pandey
Revision History
Version Revision Date Change Description
1.0 1th !ay" 01# Created
$
rd
may Added authnticate%ser service.
&istribution and order related services added.
https is replaced by http
'
th
may !odifed re(uest format of class )add*update*delete+
$0
th
!ay ,e- services added.
1. assi.n/oo0
. fetch/oo0Analytics
$. fetch/oo0&etails
Kitaboo Cloud
Service &ocument
#. fetch1nrichmentAnalytics
2. fetch%ser&etailAnalytics
Contents
1. re.ister1ducator.................................................................................................. $
. authenticate%ser................................................................................................. 2
$. activate%serAccount............................................................................................ '
#. add%ser................................................................................................................ 3
2. update%ser.......................................................................................................... 4
'. delete%ser.......................................................................................................... 11
3. fetch%ser&etails................................................................................................. 1
5. fetch%sers.......................................................................................................... 1#
4. disable%ser........................................................................................................ 15
10. enable%ser......................................................................................................... 14
11. save%ser,otes................................................................................................... 0
1. delete%ser,ote.................................................................................................. 1
1$. fetch%ser,otes.................................................................................................. $
1#. rene-Pass-ord.................................................................................................. #
12. fetchClass6ist..................................................................................................... 2
1'. fetchClass&etails............................................................................................... 3
13. fetchClass%sers.................................................................................................. 4
15. addClass............................................................................................................ $1
14. updateClass....................................................................................................... $
0. deleteClass........................................................................................................ $#
1. assi.n%sers7oClasses......................................................................................... $2
. unassi.n%sers8romClass.................................................................................... $'
$. fetch%nassi.nedStudent6ist..............................................................................$3
#. create9rder........................................................................................................ $4
2. assi.n/oo0......................................................................................................... #0
'. fetch/oo0Analytics............................................................................................. #1
3. fetch/oo0&etails................................................................................................ ##
5. fetch1nrichmentAnalytics.................................................................................. #'
4. fetch%ser&etailAnalytics.................................................................................... #5
$0. Appendi:;........................................................................................................... 21
1.registerEducator
Service URL http:conte!tURLservicesapieducatoruser"device#D$
<device%ype$registerEducator
&escription Service is used to re.ister educator -ith its information. Also an
email -ould be sent to admin email =& re.ardin. activation of the
account.
7ype Post
Re(uest
Parameters
,ame 7ype !andator
y
&escription
institution,a
me
Strin
.
> ,ame of =nstitiute
user > &etails of admin user
of educator
frst,ame Strin
.
> %ser?s frst name
last,ame Strin
.
> %ser?s last name
email Strin
.
> %ser?s email =&
user,ame Strin
.
, =f not provided" email
-ill be considered as
s*her user name.
pass-ord Strin
.
> Pass-ord of the user
contact,o Strin
.
> Contact number of
admin user
Street Strin
.
> Street info of admin
user
@ip =nte.
er
> Aip code
city Strin
.
> City name
state Strin
.
> State name
country Strin
.
> Country name
device=& Strin
.
> %ni(ue =& of device
device7ype Strin
.
> 7ype of &evice
1:ample
Values; B=PA&?"
BA,&R9=&?"?9,6=,1?
Re(uest
8ormat
<
Cinstitution,ameC; C=ndian =nstitute of 7echnolo.yC"
CuserC; <
Cfrst,ameC; CArvindC"
Clast,ameC; CPandeyC"
CemailC; Carvind.pandeyDhuri:.comC"
Cpass-ordC; CarvindE1$C"
Cuser,ameC; Carvind.pandeyDhuri:.comC"
Ccontact,oC; C41F5511$$##C"
CStreetC; C!ira roadC"
C@ipC; C#01103C"
CcityC; C7haneC"
CstateC; C!GC"
CcountryC; C=ndiaC
H
H
Response
Attributes
,ame 7ype &escription
responseC
ode
=nte.
er
%ni(ue code.
response!
s.
Strin
.
!essa.e.
timeStamp Strin
.
Server?s date I time.
invalid8ield
s
6ist 6ist of invalid*empty felds.
Response 8ailed Response;
8ormat <
C responseCode C ; C#00C"
C response!s. C ; C8ailed ; Value)s+ of feld)s+ are either
empty or invalid.C"
C timeStamp C ; C;0#;01# 1#;$;#2C"
Jinvalid8ieldsK ; <
Jfrst,ameK ; J100K"
JemailK ; J101K"
Jdevice7ypeK ; J10K
H
H
Success Response;
<
C responseCode C ; C00C"
C response!s. C ; C9KC"
C timeStamp C ; C;0#;01# 1#;$;#2C
H

&.authenticateUser
Service URL http:conte!tURLservicesapieducatoruser "device#D$
"device%ype$authenticateUser
&escription Service is used to authenticate user. 7his Service is valid for those
users havin. roles e:cept Blearner? and Binstructor?.
7ype Post
Re(uest
Parameters
,ame 7ype !andator
y
&escription
user,am
e
Strin
.
> %ser=& of user.
pass-or
d
Strin
.
> Pass-ord of user.
device=& Strin
.
> %ni(ue =& of device
device7y
pe
Strin
.
> 7ype of &evice
1:ample Values; B=PA&?"
BA,&R9=&?"?9,6=,1?
Re(uest
8ormat
<
CuserC; <
Cuser,ameC ; Carvind.pandeyDhuri:.comC"
Cpass-ordC ; Cpass-ordD1$C
H
H
Response
Attributes
,ame 7ype &escription
frst,ame Strin
.
%ser?s frst name
last,ame Strin
.
%ser?s frst name
email Strin
.
%ser?s email =&
user,ame Strin
.
email=& -ill be considered as
username if it -as not provided
durin. re.istration.
roles list 6ist of roles)its attributes are self
e:planatory+
user7o0en Strin
.
Authentication to0en.
1:ample Values; 1K6LS$s-#ty2
responseC
ode
=nte.
er
%ni(ue code.
response!
s.
Strin
.
!essa.e.
timeStamp Strin
.
Server?s date I time.
invalid8ield
s
6ist 6ist of invalid*empty felds.
client=& inte.
er
=& of the client -hich has to be
part each service %R6 e:cept
authenticate and reister%ser
services.
Response
8ormat 8ailed Response;
<
C responseCode C ; C#00C"
C response!s. C ; C8ailed ; Value)s+ of feld)s+ are either
empty or invalid.C"
C timeStamp C ; C;0#;01# 1#;$;#2C"
Jinvalid8ieldsK ; <
Juser,ameK ; J100K"
Jpass-ordK ; J101K
H
H
Success Response;
<
CuserC; <
CidC ; C1$C"
Cfrst,ameC ; CArvindC"
Clast,ameC ; CPandeyC"
CemailC ; Carvind.pandeyDhuri:.comC"
Cuser,ameC ;
Carvind.pandeyDhuri:.comC"
CrolesC ; M <
CidC ; #"
CnameC ; CC6=1,7
A&!=,C"
CdescC ; C!ana.e
accountsC
H N
H"
Cclient=&C ; 1"
Cuser7o0enC ; Ca'LG#rtO035uiyC"
CresponseCodeC ; C00C"
Cresponse!s.C ; C9KC"
CtimeStampC ; C;0#;01# 1#;$;#2C
H
'.activateUser(ccount
Service URL http:conte!tURLservicesapieducatoruser "device#D$
"device%ype$activateUser(ccount)user#D*encryptedUser#D
&escription Service is used to activate user account.
After successful creation of a user" he*she receives mail containin.
%R6" once clic0ed he*she -ill be activated.
7ype Let
Re(uest
Parameters
,ame 7ype !andator
y
&escription
device=& Strin
.
> %ni(ue =& of device )this
-ill be 9,6=,1 in case its
bro-ser+
device7y
pe
Strin
.
> 7ype of &evice
1:ample Values; B=PA&?"
BA,&R9=&?"?9,6=,1?
Puery Params user=&; it contains encrypted value of user=& -hich -ould be
decrypted at server and if its valid user=& then his*her account -ill
be activated. 7his %R6 -ill be valid for 1 hours from the time it -as
.enerated.
Re(uest
8ormat
Response
Attributes
,ame 7ype &escription
responseC
ode
=nte.
er
%ni(ue code.
response!
s.
Strin
.
!essa.e.
timeStamp Strin Server?s date I time.
.
invalid8ield
s
6ist 6ist of invalid*empty felds.
Response
8ormat Response;
<
C responseCode C ; C00C"
C response!s. C ; C9KC"
C timeStamp C ; C;0#;01# 1#;$;#2C
H
+.addUser
Service URL http:conte!tURLservicesapieducatoruser"device#D$
<device%ype$addUser
&escription 7o add a user to the system.
7ype Post
Re(uest
Parameters
,ame 7ype !andator
y
&escription
user > &etails of user
frst,ame Strin
.
> %ser?s frst name
last,ame Strin
.
> %ser?s last name
email Strin
.
> %ser?s email =&
user,ame Strin
.
, =f not provided" email
-ill be considered as
s*her user name.
contact,o Strin
.
> Contact number of
admin user
Street Strin
.
> Street info of admin
user
@ip =nte.
er
> Aip code
city Strin
.
> City name
state Strin
.
> State name
country Strin
.
> Country name
roles 6ist , 6ist of roles
=f roles are not there
in the re(uest then
default learner -ould
be considered.
id =nte.
er
> =& of the role
device=& Strin
.
> %ni(ue =& of device
device7ype Strin
.
> 7ype of &evice
1:ample
Values; B=PA&?"
BA,&R9=&?"?9,6=,1?
Header
parametrs
Juserto0enK;KsadOs3'yuda.sad53'K
After successful authentication system -ould .enerate uni(ue to0en
for each user. 7his user to0en has to be e:chan.ed bet-een each
re(uest and response.
Re(uest
8ormat
<
CuserC; <
Cfrst,ameC; CArvindC"
Clast,ameC; CPandeyC"
CemailC; Carvind.pandeyDhuri:.comC"
Cuser,ameC; Carvind.pandeyDhuri:.comC"
Ccontact,oC; C41F5511$$##C"
CStreetC; C!ira roadC"
C@ipC; C#01103C"
CcityC; C7haneC"
CstateC; C!GC"
CcountryC; C=ndiaC"
CrolesC; M
<
CidC; C1C
H"
<
CidC; CC
H
N
H
H
Response
Attributes
,ame 7ype &escription
responseC
ode
=nte.
er
%ni(ue code.
response!
s.
Strin
.
!essa.e.
timeStamp Strin
.
Server?s date I time.
invalid8ield
s
6ist 6ist of invalid*empty felds.
user %ser detail
id =nte.
er
=& of the user
Response
8ormat
8ailed Response;
<
C responseCode C ; C#00C"
C response!s. C ; C8ailed ; Value)s+ of feld)s+ are either
empty or invalid.C"
C timeStamp C ; C;0#;01# 1#;$;#2C"
Jinvalid8ieldsK ; <
Jfrst,ameK ; J100K"
JemailK ; J101K"
Jdevice7ypeK ; J10K
H
H
Success Response;
<
C responseCode C; C00C"
C response!s. C; C9KC"
C timeStamp C; C;0#;01# 1#;$;#2C"
Cuser C; <
CidC; C1$#2C
H
H

,.updateUser
Service URL http:conte!tURLservicesapieducatoruser"device#D$
<device%ype$updateUser
&escription 7o update a user to the system.
7ype Post
Re(uest
Parameters
,ame 7ype !andator
y
&escription
user > &etails of user
id =nte.
er
> =& of the user
frst,ame Strin
.
> %ser?s frst name
last,ame Strin
.
> %ser?s last name
email Strin
.
> %ser?s email =&
user,ame Strin , =f not provided" email
. -ill be considered as
s*her user name.
contact,o Strin
.
> Contact number of
admin user
Street Strin
.
> Street info of admin
user
@ip =nte.
er
> Aip code
city Strin
.
> City name
state Strin
.
> State name
country Strin
.
> Country name
roles 6ist , 6ist of roles
=f roles are not there
in the re(uest then
default learner -ould
be considered.
id =nte.
er
> =& of the role
device7ype Strin
.
> 7ype of &evice
1:ample
Values; B=PA&?"
BA,&R9=&?"?9,6=,1?
Header
parametrs
Juserto0enK;KsadOs3'yuda.sad53'K
After successful authentication system -ould .enerate uni(ue to0en
for each user. 7his user to0en has to be e:chan.ed bet-een each
re(uest and response.
Re(uest
8ormat
<
CuserC; <
Cfrst,ameC; CArvindC"
Clast,ameC; CPandeyC"
CemailC; Carvind.pandeyDhuri:.comC"
Cuser,ameC; Carvind.pandeyDhuri:.comC"
Ccontact,oC; C41F5511$$##C"
CStreetC; C!ira roadC"
C@ipC; C#01103C"
CcityC; C7haneC"
CstateC; C!GC"
CcountryC; C=ndiaC"
CrolesC; M
<
CidC; C1C
H"
<
CidC; CC
H
N
H
H
Response
Attributes
,ame 7ype &escription
responseC
ode
=nte.
er
%ni(ue code.
response!
s.
Strin
.
!essa.e.
timeStamp Strin
.
Server?s date I time.
invalid8ield
s
6ist 6ist of invalid*empty felds.
user %ser detail
id =nte.
er
=& of the user
Response
8ormat
8ailed Response;
<
C responseCode C ; C#00C"
C response!s. C ; C8ailed ; Value)s+ of feld)s+ are either
empty or invalid.C"
C timeStamp C ; C;0#;01# 1#;$;#2C"
Jinvalid8ieldsK ; <
Jfrst,ameK ; J100K"
JemailK ; J101K"
Jdevice7ypeK ; J10K
H
H
Success Response;
<
C responseCode C; C00C"
C response!s. C; C9KC"
C timeStamp C; C;0#;01# 1#;$;#2C"
Cuser C; <
CidC; C1$#2C
H
H

-.deleteUser
Service URL http:conte!tURLservicesapieducatoruser"device#D$
<device%ype$deleteUser
&escription 7o delete a user to the system.
7ype Post
Re(uest
Parameters
,ame 7ype !andator
y
&escription
user > &etails of user
id =nte.
er
> =& of the user
device=& Strin
.
> %ni(ue =& of device
device7ype Strin
.
> 7ype of &evice
1:ample
Values; B=PA&?"
BA,&R9=&?"?9,6=,1?
Header
parametrs
Juserto0enK;KsadOs3'yuda.sad53'K
After successful authentication system -ould .enerate uni(ue to0en
for each user. 7his user to0en has to be e:chan.ed bet-een each
re(uest and response.
Re(uest
8ormat
<
CuserC; <
CidC; C101C
H
H
Response
Attributes
,ame 7ype &escription
responseC
ode
=nte.
er
%ni(ue code.
response!
s.
Strin
.
!essa.e.
timeStamp Strin
.
Server?s date I time.
invalid8ield
s
6ist 6ist of invalid*empty felds.
Response
8ormat
8ailed Response;
<
C responseCode C ; C#00C"
C response!s. C ; C8ailed ; Value)s+ of feld)s+ are either
empty or invalid.C"
C timeStamp C ; C;0#;01# 1#;$;#2C"
Jinvalid8ieldsK ; <
Jfrst,ameK ; J100K"
JemailK ; J101K"
Jdevice7ypeK ; J10K
H
H
Success Response;
<
C responseCode C; C00C"
C response!s. C; C9KC"
C timeStamp C; C;0#;01# 1#;$;#2C
H

../etchUserDetails
Service URL http:conte!tURLservicesapieducator"client#D$user
"device#D$"device%ype$"user#D$/etchUserDetails
Description 7o fetch users of a client or institute
%ype Let
Re0uest
1arameters
,ame 7ype !andator
y
&escription
device=& Strin
.
> %ni(ue =& of device
device7ype Strin
.
> 7ype of &evice
1:ample Values; B=PA&?"
BA,&R9=&?"?9,6=,1?
client=& Strin
.
> =& of the client.
user=& =nte.
er
> =& of the user -hose
details has to fetched.
Header
parametrs
Juserto0enK;KsadOs3'yuda.sad53'K
After successful authentication system -ould .enerate uni(ue to0en
for each user. 7his user to0en has to be e:chan.ed bet-een each
re(uest and response.
Re0uest
2ormat
Response
(ttri3utes
,ame 7ype &escription
user7o0en Strin
.
Authentication to0en.
1:ample Values; 1K6LS$s-#ty2
responseC
ode
=nte.
er
%ni(ue code.
response!
s.
Strin
.
!essa.e.
timeStamp Strin
.
Server?s date I time.
invalid8ield
s
6ist 6ist of invalid*empty felds.
user &etails of user
frst,ame Strin
.
%ser?s frst name
last,ame Strin
.
%ser?s last name
email Strin
.
%ser?s email =&
user,ame Strin
.
=f not provided" email -ill be
considered as s*her user name.
created9n &ate Created date of the user
contact,o Strin
.
Contact number of admin user
Street Strin
.
Street info of admin user
@ip =nte.
er
Aip code
city Strin
.
City name
state Strin
.
State name
country Strin
.
Country name
classes 6ist 6ist of classes a user belon.s to
and its attributes are self
e:planatory.
Response
2ormat 8ailed Response;
<
C responseCode C ; C#00C"
C response!s. C ; C8ailed ; Value)s+ of feld)s+ are either
empty or invalid.C"
C timeStamp C ; C;0#;01# 1#;$;#2C"
Jinvalid8ieldsK ; <
Juser,ameK ; J100K"
Jpass-ordK ; J101K
H
H
Success Response;
<
C responseCode C ; C00C"
C response!s. C ; C9KC"
C timeStamp C ; C;0#;01# 1#;$;#2C"
CuserC; <
CidC; C1C"
Cfrst,ameC; CArvindC"
Clast,ameC; CPandeyC"
CemailC; Carvind.pandeyDhuri:.comC"
Cuser,ameC; Carvind.pandeyDhuri:.comC"
Ccreated9nC; C$F0#F01C"
CcontactC; C4502321'#1C"
CstreetC; CStreet 1C"
C@ipC; C#00051C"
CcityC; C!umbaiC"
CstateC; C!GC"
CcountryC; C=ndiaC"
CclassesC; M
<
CidC; C1C"
CnameC; CGistoryC
H"
<
CidC; CC"
CnameC; CLeo.raphyC
H"
<
CidC; C$C"
CnameC; CPhysicsC
H
N
H
H
4./etchUsers
Service URL http:conte!tURLservicesapieducator"client#D$user
"device#D$"device%ype$/etchUsers)institute#D*5
16pagination7um*&6 pageSi8e*&,6 searchString*arv
Description 7o fetch users of a client or institute
%ype Let
Re0uest
1arameters
,ame 7ype !andator
y
&escription
device=& Strin
.
> %ni(ue =& of device
device7ype Strin
.
> 7ype of &evice
1:ample Values; B=PA&?"
BA,&R9=&?"?9,6=,1?
client=& Strin
.
> =& of the client.
Header
parametrs
Juserto0enK;KsadOs3'yuda.sad53'K
After successful authentication system -ould .enerate uni(ue to0en
for each user. 7his user to0en has to be e:chan.ed bet-een each
re(uest and response.
9uery
1arams
institute=& ; if value is F1 then return users of client else users of
institute.
pa.ination,um; pa.ination,umQR0 means all users
pa.ination,umS0 means ; e.; if its and
pa.eSi@eR2 then this
method should return records from 'th to 20th
in &/ table.
default value is 1.
pa.eSi@e; ,umber of records to be sho-n per pa.e. &efault
value is 2
searchStrin.; =f empty returns all users else searched result based
on search Strin..
Re0uest
2ormat
Response
(ttri3utes
,ame 7ype &escription
responseC
ode
=nte.
er
%ni(ue code.
response!
s.
Strin
.
!essa.e.
timeStamp Strin
.
Server?s date I time.
invalid8ield
s
6ist 6ist of invalid*empty felds.
user &etails of admin user of educator
frst,ame Strin
.
%ser?s frst name
last,ame Strin
.
%ser?s last name
email Strin
.
%ser?s email =&
user,ame Strin
.
=f not provided" email -ill be
considered as s*her user name.
created9n &ate Created date of the user.
contact,o Strin
.
Contact number of admin user
Street Strin
.
Street info of admin user
@ip =nte.
er
Aip code
city Strin
.
City name
state Strin
.
State name
country Strin
.
Country name
classes 6ist 6ist of classes a user belon.s to
and its attributes are self
e:planatory.
totalPa.es =nte.
er
,umber of pa.es )useful for
pa.ination+
Response
2ormat 8ailed Response;
<
C responseCode C ; C#00C"
C response!s. C ; C8ailed ; Value)s+ of feld)s+ are either
empty or invalid.C"
C timeStamp C ; C;0#;01# 1#;$;#2C"
Jinvalid8ieldsK ; <
Juser,ameK ; J100K"
Jpass-ordK ; J101K
H
H
Success Response;
<
C responseCode C ; C00C"
C response!s. C ; C9KC"
C timeStamp C ; C;0#;01# 1#;$;#2C"
CtotalPa.esC; C12C"
CusersC; M
<
CidC; C1C"
Cfrst,ameC; CArvindC"
Clast,ameC; CPandeyC"
CemailC; Carvind.pandeyDhuri:.comC"
Cuser,ameC; Carvind.pandeyDhuri:.comC"
Ccreated9nC; C$F0#F01C"
CcontactC; C4502321'#1C"
CstreetC; CStreet 1C"
C@ipC; C#00051C"
CcityC; C!umbaiC"
CstateC; C!GC"
CcountryC; C=ndiaC"
CclassesC; M
<
CidC; C1C"
CnameC; CGistoryC
H"
<
CidC; CC"
CnameC; CLeo.raphyC
H"
<
CidC; C$C"
CnameC; CPhysicsC
H
N
H"
<
CidC; CC"
Cfrst,ameC; CKanchanC"
Clast,ameC; CSa-arde0arC"
CemailC; C0anchan.sDhuri:.comC"
Cuser,ameC; C0anchan.sDhuri:.comC"
Ccreated9nC; C$F0#F01C"
CcontactC; C45023#2'#1C"
CstreetC; CStreet C"
C@ipC; C#00051C"
CcityC; C!umbaiC"
CstateC; C!GC"
CcountryC; C=ndiaC"
CclassesC; M
<
CidC; C1C"
CnameC; CGistoryC
H"
<
CidC; CC"
CnameC; CLeo.raphyC
H"
<
CidC; C$C"
CnameC; CPhysicsC
H
N
H"
<
CidC; C$C"
Cfrst,ameC; CAnuradhaC"
Clast,ameC; CSrivastavaC"
CemailC; Canuradha.srivastavDhuri:.comC"
Cuser,ameC; Canuradha.srivastavDhuri:.comC"
Ccreated9nC; C$F0#F01C"
CcontactC; C2'02321'#1C"
CstreetC; CStreet 1C"
C@ipC; C#00051C"
CcityC; C!umbaiC"
CstateC; C!GC"
CcountryC; C=ndiaC"
CclassesC; M
<
CidC; C1C"
CnameC; CGistoryC
H"
<
CidC; CC"
CnameC; CLeo.raphyC
H"
<
CidC; C$C"
CnameC; CPhysicsC
H
N
H
N
H
:.disa3leUser
Service URL http:conte!tURLservicesapieducator"client#D$user
"device#D$"device%ype$disa3leUser
Description 7o disable a user.
9nly enabled users are allo-ed in system.
%ype Post
Re0uest
1arameters
,ame 7ype !andator
y
&escription
user > %ser details containin.
id and ne- pass-ord
id =nte.
er
> =& of the user -ho needs
to be enabled.
device=& Strin
.
> %ni(ue =& of device
device7yp
e
Strin
.
> 7ype of &evice
1:ample Values; B=PA&?"
BA,&R9=&?"?9,6=,1?
client=& Strin > =& of the client.
.
Header
parametrs
Juserto0enK;KsadOs3'yuda.sad53'K
After successful authentication system -ould .enerate uni(ue to0en
for each user. 7his user to0en has to be e:chan.ed bet-een each
re(uest and response.
Re0uest
2ormat
<
Cuser C; <
CidC; C1$#2C
H
H
Response
(ttri3utes
,ame 7ype &escription
responseC
ode
=nte.
er
%ni(ue code.
response!
s.
Strin
.
!essa.e.
timeStamp Strin
.
Server?s date I time.
invalid8ield
s
6ist 6ist of invalid*empty felds.
Response
2ormat 8ailed Response;
<
C responseCode C ; C#00C"
C response!s. C ; C8ailed ; Value)s+ of feld)s+ are either
empty or invalid.C"
C timeStamp C ; C;0#;01# 1#;$;#2C"
Jinvalid8ieldsK ; <
Juser,ameK ; J100K
H
H
Success Response;
<
C responseCode C ; C00C"
C response!s. C ; C9KC"
C timeStamp C ; C;0#;01# 1#;$;#2C
H
1;. ena3leUser
Service URL http:conte!tURLservicesapieducator"client#D$user
"device#D$"device%ype$ena3leUser
Description 7o enable a user.
9nly enabled users are allo-ed in system.
%ype Post
Re0uest
1arameters
,ame 7ype !andator
y
&escription
user > %ser details containin.
id and ne- pass-ord
id =nte.
er
> =& of the user -ho needs
to be enabled.
device=& Strin
.
> %ni(ue =& of device
device7yp
e
Strin
.
> 7ype of &evice
1:ample Values; B=PA&?"
BA,&R9=&?"?9,6=,1?
client=& Strin
.
> =& of the client.
Header
parametrs
Juserto0enK;KsadOs3'yuda.sad53'K
After successful authentication system -ould .enerate uni(ue to0en
for each user. 7his user to0en has to be e:chan.ed bet-een each
re(uest and response.
Re0uest
2ormat
<
Cuser C; <
CidC; C1$#2C
H
H
Response
(ttri3utes
,ame 7ype &escription
responseC
ode
=nte.
er
%ni(ue code.
response!
s.
Strin
.
!essa.e.
timeStamp Strin
.
Server?s date I time.
invalid8ield
s
6ist 6ist of invalid*empty felds.
Response
2ormat 8ailed Response;
<
C responseCode C ; C#00C"
C response!s. C ; C8ailed ; Value)s+ of feld)s+ are either
empty or invalid.C"
C timeStamp C ; C;0#;01# 1#;$;#2C"
Jinvalid8ieldsK ; <
Juser,ameK ; J100K
H
H
Success Response;
<
C responseCode C ; C00C"
C response!s. C ; C9KC"
C timeStamp C ; C;0#;01# 1#;$;#2C
H
11. saveUser7otes
Service URL http:conte!tURLservicesapieducator"client#D$user
"device#D$"device%ype$saveUser7ote
Description 7o save a note for a user by teacher.
%ype Post
Re0uest
1arameters
,ame 7ype !andator
y
&escription
user > %ser details containin.
id and ne- pass-ord
id =nte.
er
> =& of the user -ho needs
to be enabled.
note Strin
.
> ,ote details
note7e:t > 7e:t of ,ote created for
the user.
device=& Strin
.
> %ni(ue =& of device
device7yp
e
Strin
.
> 7ype of &evice
1:ample Values; B=PA&?"
BA,&R9=&?"?9,6=,1?
client=& Strin
.
> =& of the client.
Header
parametrs
Juserto0enK;KsadOs3'yuda.sad53'K
After successful authentication system -ould .enerate uni(ue to0en
for each user. 7his user to0en has to be e:chan.ed bet-een each
re(uest and response.
Re0uest
2ormat
<
Cuser C; <
CidC; C1$#2C
H"
CnoteC; <
Cnote7e:tC; C,ote1C
H
H
Response
(ttri3utes
,ame 7ype &escription
responseC
ode
=nte.
er
%ni(ue code.
response!
s.
Strin
.
!essa.e.
timeStamp Strin
.
Server?s date I time.
invalid8ield
s
6ist 6ist of invalid*empty felds.
Response
2ormat 8ailed Response;
<
C responseCode C ; C#00C"
C response!s. C ; C8ailed ; Value)s+ of feld)s+ are either
empty or invalid.C"
C timeStamp C ; C;0#;01# 1#;$;#2C"
Jinvalid8ieldsK ; <
Juser,ameK ; J100K
H
H
Success Response;
<
C responseCode C ; C00C"
C response!s. C ; C9KC"
C timeStamp C ; C;0#;01# 1#;$;#2C
H
1&. deleteUser7ote
Service URL http:conte!tURLservicesapieducator"client#D$user
"device#D$"device%ype$deleteUser7ote
Description 7o delete a note of a user by teacher.
%ype Post
Re0uest
1arameters
,ame 7ype !andator
y
&escription
user > %ser details containin.
id and ne- pass-ord
id =nte.
er
> =& of the user -ho needs
to be enabled.
note Strin
.
> ,ote details
id =nte.
er
> =d of the note to be
deleted.
device=& Strin
.
> %ni(ue =& of device
device7yp
e
Strin
.
> 7ype of &evice
1:ample Values; B=PA&?"
BA,&R9=&?"?9,6=,1?
client=& Strin
.
> =& of the client.
Header
parametrs
Juserto0enK;KsadOs3'yuda.sad53'K
After successful authentication system -ould .enerate uni(ue to0en
for each user. 7his user to0en has to be e:chan.ed bet-een each
re(uest and response.
Re0uest <
2ormat Cuser C; <
CidC; C1$#2C
H"
CnoteC; <
CidC; C10C
H
H
Response
(ttri3utes
,ame 7ype &escription
responseC
ode
=nte.
er
%ni(ue code.
response!
s.
Strin
.
!essa.e.
timeStamp Strin
.
Server?s date I time.
invalid8ield
s
6ist 6ist of invalid*empty felds.
Response
2ormat 8ailed Response;
<
C responseCode C ; C#00C"
C response!s. C ; C8ailed ; Value)s+ of feld)s+ are either
empty or invalid.C"
C timeStamp C ; C;0#;01# 1#;$;#2C"
Jinvalid8ieldsK ; <
Juser,ameK ; J100K
H
H
Success Response;
<
C responseCode C ; C00C"
C response!s. C ; C9KC"
C timeStamp C ; C;0#;01# 1#;$;#2C
H
1'. /etchUser7otes
Service URL http:conte!tURLservicesapieducator"client#D$user
"device#D$"device%ype$/etchUser7otes
Description 7o fetch notes of a user by teacher.
%ype Let
Re0uest
1arameters
,ame 7ype !andator
y
&escription
user > %ser details containin.
id and ne- pass-ord
id =nte.
er
> =& of the user -ho needs
to be enabled.
device=& Strin
.
> %ni(ue =& of device
device7yp
e
Strin
.
> 7ype of &evice
1:ample Values; B=PA&?"
BA,&R9=&?"?9,6=,1?
client=& Strin
.
> =& of the client.
Header
parametrs
Juserto0enK;KsadOs3'yuda.sad53'K
After successful authentication system -ould .enerate uni(ue to0en
for each user. 7his user to0en has to be e:chan.ed bet-een each
re(uest and response.
Re0uest
2ormat
<
Cuser C; <
CidC; C1$#2C
H
H
Response
(ttri3utes
,ame 7ype &escription
responseC
ode
=nte.
er
%ni(ue code.
response!
s.
Strin
.
!essa.e.
timeStamp Strin
.
Server?s date I time.
invalid8ield
s
6ist 6ist of invalid*empty felds.
notes 6ist 6ist of notes
id =nte.
er
=& of the note
note7e:t Strin
.
,ote
created9n &ate
I
7ime
Then the note -as created.
Response
2ormat 8ailed Response;
<
C responseCode C ; C#00C"
C response!s. C ; C8ailed ; Value)s+ of feld)s+ are either
empty or invalid.C"
C timeStamp C ; C;0#;01# 1#;$;#2C"
Jinvalid8ieldsK ; <
Juser,ameK ; J100K
H
H
Success Response;
<
C responseCode C ; C00C"
C response!s. C ; C9KC"
C timeStamp C ; C;0#;01# 1#;$;#2C"
CnotesC; M
<
CidC; C10C"
Cnote7e:tC; C,ote1C"
Ccreated9nC; C$F02F11 1;$0 P!C
H"
<
CidC; C11C"
Cnote7e:tC; C,oteC"
Ccreated9nC; C$F02F11 1;$0 P!C
H"
<
CidC; C1C"
Cnote7e:tC; C,ote$C"
Ccreated9nC; C$F02F11 1;$0 P!C
H
N
H
1+. rene<1ass<ord
Service URL http:conte!tURLservicesapieducator"client#D$user
"device#D$"device%ype$rene<1ass<ord
Description 7o rene- pass-ord of a learner by admin.
%ype Post
Re0uest
1arameters
,ame 7ype !andator
y
&escription
learner > %ser details containin.
id and ne- pass-ord
id =nte.
er
> =d of the user -hose
pass-ord has to be
rene-ed.
pass-ord Strin
.
> ,e- pass-ord for the
user.
device=& Strin
.
> %ni(ue =& of device
device7yp
e
Strin
.
> 7ype of &evice
1:ample Values; B=PA&?"
BA,&R9=&?"?9,6=,1?
client=& Strin
.
> =& of the client.
Header
parametrs
Juserto0enK;KsadOs3'yuda.sad53'K
After successful authentication system -ould .enerate uni(ue to0en
for each user. 7his user to0en has to be e:chan.ed bet-een each
re(uest and response.
Re0uest
2ormat
<
Clearner C; <
CidC; C1$#2C"
Cpass-ordC; CarvindE1$C
H
H
Response
(ttri3utes
,ame 7ype &escription
responseC
ode
=nte.
er
%ni(ue code.
response!
s.
Strin
.
!essa.e.
timeStamp Strin
.
Server?s date I time.
invalid8ield
s
6ist 6ist of invalid*empty felds.
Response
2ormat 8ailed Response;
<
C responseCode C ; C#00C"
C response!s. C ; C8ailed ; Value)s+ of feld)s+ are either
empty or invalid.C"
C timeStamp C ; C;0#;01# 1#;$;#2C"
Jinvalid8ieldsK ; <
Juser,ameK ; J100K
H
H
Success Response;
<
C responseCode C ; C00C"
C response!s. C ; C9KC"
C timeStamp C ; C;0#;01# 1#;$;#2C
H
1,. /etchClassList
Service
URL
http:conte!tURLservicesapieducatordistri3ution"device#D$
"device%ype$"institute#D$
/etchClassList)searchString*arv
Descript
ion
7o fetch classes of a institute.
%ype Let
Re0uest
1aramet
ers
,ame 7ype !andator
y
&escription
device=& Strin
.
> %ni(ue =& of device
device7ype Strin
.
> 7ype of &evice
1:ample Values; B=PA&?"
BA,&R9=&?"?9,6=,1?
institute=& =nte.
er
> =& of the institute
Header
paramet
rs
Juserto0enK;KsadOs3'yuda.sad53'K
After successful authentication system -ould .enerate uni(ue to0en for each
user. 7his user to0en has to be e:chan.ed bet-een each re(uest and
response.
9uery
1arams
searchStrin.; =f empty returns all classes else searched result based on
search Strin..
Re0uest
2ormat
Respons
e
(ttri3ut
es
,ame 7ype &escription
responseC
ode
=nte.
er
%ni(ue code.
response!
s.
Strin
.
!essa.e.
timeStamp Strin
.
Server?s date I time.
invalid8ield
s
6ist 6ist of invalid*empty felds.
class6ist 6ist 6ist of classes of a =nstitute.
id =nte.
er
=d of the class.
name Strin
.
,ame of class.
usersCount =nte.
er
,umber of users of the class.
Respons
e
2ormat
8ailed Response;
<
C responseCode C ; C#00C"
C response!s. C ; C8ailed ; Value)s+ of feld)s+ are either empty
or invalid.C"
C timeStamp C ; C;0#;01# 1#;$;#2C"
Jinvalid8ieldsK ; <
Jdevice7ypeK ; J101K
H
H
Success Response;
<
C responseCode C ; C00C"
C response!s. C ; C9KC"
C timeStamp C ; C;0#;01# 1#;$;#2C"
C class6ist C; M
<
CidC; C1C"
CnameC; CGistoryC"
CusersCountC; C2C
H"
<
CidC; CC"
CnameC; CLeo.raphyC"
CusersCountC; C21C
H"
<
CidC; C$C"
CnameC; CPhysicsC"
CusersCountC; C12C
H
N
H
1-. /etchClassDetails
Service
URL
http:conte!tURLservicesapieducatordistri3ution"device#D$
"device%ype$"class#D$
/etchClassDetails
Descript
ion
7o fetch classe details of a class.
%ype Let
Re0uest
1aramet
ers
,ame 7ype !andator
y
&escription
device=& Strin
.
> %ni(ue =& of device
device7ype Strin
.
> 7ype of &evice
1:ample Values; B=PA&?"
BA,&R9=&?"?9,6=,1?
class=& =nte.
er
> =& of the class
Header
paramet
rs
Juserto0enK;KsadOs3'yuda.sad53'K
After successful authentication system -ould .enerate uni(ue to0en for
each user. 7his user to0en has to be e:chan.ed bet-een each re(uest
and response.
Re0uest
2ormat
Respons
e
(ttri3ut
es
,ame 7ype &escription
responseC
ode
=nte.
er
%ni(ue code.
response!
s.
Strin
.
!essa.e.
timeStamp Strin
.
Server?s date I time.
invalid8ield
s
6ist 6ist of invalid*empty felds.
class6ist 6ist &etails of a sin.le class.
user %ser details
id =nte.
er
=d of the class.
name Strin
.
,ame of class.
instructors 6ist 6ist of =nstructors -ith their details
and roles
learners 6ist 6ist of learners -ith their details
and roles
Respons
e
2ormat
8ailed Response;
<
C responseCode C ; C#00C"
C response!s. C ; C8ailed ; Value)s+ of feld)s+ are either
empty or invalid.C"
C timeStamp C ; C;0#;01# 1#;$;#2C"
Jinvalid8ieldsK ; <
Jdevice7ypeK ; J101K
H
H
Success Response;
<
CresponseCodeC; C00C"
Cresponse!s.C; C9KC"
CtimeStampC; C;0#;01# 1#;$;#2C"
Cclass6istC; M
<
CidC; C1C"
CnameC; CGistoryC"
CinstructorsC; M
<
CuserC; <
CidC; 24"
Cfrst,ameC; C!athsC"
Clast,ameC; C7eacherC"
Cuser,ameC; CmathsDtest.comC
H
H
N"
ClearnersC; M
<
CuserC; <
CidC; 2#"
Cfrst,ameC; ConeC"
Clast,ameC; ClearnerC"
Cuser,ameC; ConeDtest.comC
H
H"
<
CuserC; <
CidC; 22"
Cfrst,ameC; Ct-oC"
Clast,ameC; ClearnerC"
Cuser,ameC; Ct-oDtest.comC
H
H"
<
CuserC; <
CidC; 2'"
Cfrst,ameC; CthreeC"
Clast,ameC; CleanerC"
Cuser,ameC; CthreeDtest.comC
H
H"
<
CuserC; <
CidC; 23"
Cfrst,ameC; CfourC"
Clast,ameC; ClearnerC"
Cuser,ameC; CfourDtest.comC
H
H"
<
CuserC; <
CidC; 25"
Cfrst,ameC; CfveC"
Clast,ameC; CleanerC"
Cuser,ameC; CfveDtest.comC
H
H
N
H
N
H
1.. /etchClassUsers
Service
URL
http:conte!tURLservicesapieducatordistri3ution"device#D$
"device%ype$"class#D$"3oo=#D$
/etchClassDetails
Descript
ion
7o fetch users of a class.
%ype Let
Re0uest
1aramet
ers
,ame 7ype !andator
y
&escription
device=& Strin
.
> %ni(ue =& of device
device7ype Strin
.
> 7ype of &evice
1:ample Values; B=PA&?"
BA,&R9=&?"?9,6=,1?
class=& =nte.
er
> =& of the class
boo0=& =nte.
er
, 7his is optional. =f value
is provided then it -ill
return all users of the
class -ho are
associated -ith the
boo0.
1lse all the users of the
class.
Header
paramet
rs
Juserto0enK;KsadOs3'yuda.sad53'K
After successful authentication system -ould .enerate uni(ue to0en for each user.
7his user to0en has to be e:chan.ed bet-een each re(uest and response.
Re0uest
2ormat
Respons
e
(ttri3ut
es
,ame 7ype &escription
responseC
ode
=nte.
er
%ni(ue code.
response!
s.
Strin
.
!essa.e.
timeStamp Strin
.
Server?s date I time.
invalid8ield
s
6ist 6ist of invalid*empty felds.
class6ist 6ist &etails of a sin.le class.
instructors 6ist 6ist of =nstructors -ith their
details.
learners 6ist 6ist of learners -ith their details.
Respons
e
2ormat
8ailed Response;
<
C responseCode C ; C#00C"
C response!s. C ; C8ailed ; Value)s+ of feld)s+ are either empty or
invalid.C"
C timeStamp C ; C;0#;01# 1#;$;#2C"
Jinvalid8ieldsK ; <
Jdevice7ypeK ; J101K
H
H
Success Response;
<
CresponseCodeC; C00C"
Cresponse!s.C; C9KC"
CtimeStampC; C;0#;01# 1#;$;#2C"
Cclass6istC; M
<
CinstructorsC; M
<
CuserC; <
CidC; 24"
Cfrst,ameC; C!athsC"
Clast,ameC; C7eacherC"
Cuser,ameC; CmathsDtest.comC
H
H
N"
ClearnersC; M
<
CuserC; <
CidC; 2#"
Cfrst,ameC; ConeC"
Clast,ameC; ClearnerC"
Cuser,ameC; ConeDtest.comC
H
H"
<
CuserC; <
CidC; 22"
Cfrst,ameC; Ct-oC"
Clast,ameC; ClearnerC"
Cuser,ameC; Ct-oDtest.comC
H
H
N
H
N
H
14. addClass
Service URL http:conte!tURLservicesapieducatordistri3ution
"device#D$"device%ype$
addClass
Description 7o add a class.
%ype Post
Re0uest
1arameters
,ame 7ype !andator
y
&escription
class > &etails of the class.
name Strin
.
> ,ame of the class.
descriptio
n
Strin
.
> &escription of the class
device=& Strin
.
> %ni(ue =& of device
device7yp
e
Strin
.
> 7ype of &evice
1:ample Values; B=PA&?"
BA,&R9=&?"?9,6=,1?
Header
parametrs
Juserto0enK;KsadOs3'yuda.sad53'K
After successful authentication system -ould .enerate uni(ue to0en
for each user. 7his user to0en has to be e:chan.ed bet-een each
re(uest and response.
Re0uest <
2ormat CnameC; CGistoryC"
CdescriptionC; C&escription of the classC
H
Response
(ttri3utes
,ame 7ype &escription
responseC
ode
=nte.
er
%ni(ue code.
response!
s.
Strin
.
!essa.e.
timeStamp Strin
.
Server?s date I time.
invalid8ield
s
6ist 6ist of invalid*empty felds.
Response
2ormat 8ailed Response;
<
C responseCode C ; C#00C"
C response!s. C ; C8ailed ; Value)s+ of feld)s+ are either
empty or invalid.C"
C timeStamp C ; C;0#;01# 1#;$;#2C"
Jinvalid8ieldsK ; <
Jdevice7ypeK ; J100K
H
H
Success Response;
<
C responseCode C ; C00C"
C response!s. C ; C9KC"
C timeStamp C ; C;0#;01# 1#;$;#2C
H
1:. updateClass
Service URL http:conte!tURLservicesapieducatordistri3ution
"device#D$"device%ype$
addClass
Description 7o add a class.
%ype Post
Re0uest
1arameters
,ame 7ype !andator
y
&escription
class > &etails of the class.
id =nte.
er
> Thich needs to be
updated
name Strin
.
> ,ame of the class.
descriptio
n
Strin
.
> &escription of the class
device=& Strin
.
> %ni(ue =& of device
device7yp
e
Strin
.
> 7ype of &evice
1:ample Values; B=PA&?"
BA,&R9=&?"?9,6=,1?
Header
parametrs
Juserto0enK;KsadOs3'yuda.sad53'K
After successful authentication system -ould .enerate uni(ue to0en
for each user. 7his user to0en has to be e:chan.ed bet-een each
re(uest and response.
Re0uest
2ormat
<
CidC; C1C"
CnameC; CGistoryC"
CdescriptionC; C&escription of the classC
H
Response
(ttri3utes
,ame 7ype &escription
responseC
ode
=nte.
er
%ni(ue code.
response!
s.
Strin
.
!essa.e.
timeStamp Strin
.
Server?s date I time.
invalid8ield
s
6ist 6ist of invalid*empty felds.
Response
2ormat 8ailed Response;
<
C responseCode C ; C#00C"
C response!s. C ; C8ailed ; Value)s+ of feld)s+ are either
empty or invalid.C"
C timeStamp C ; C;0#;01# 1#;$;#2C"
Jinvalid8ieldsK ; <
Jdevice7ypeK ; J100K
H
H
Success Response;
<
C responseCode C ; C00C"
C response!s. C ; C9KC"
C timeStamp C ; C;0#;01# 1#;$;#2C
H
&;. deleteClass
Service URL http:conte!tURLservicesapieducatordistri3ution
"device#D$"device%ype$
addClass
Description 7o add a class.
%ype Post
Re0uest
1arameters
,ame 7ype !andator
y
&escription
class > &etails of the class.
id =nte.
er
> Thich needs to be
updated
device=& Strin
.
> %ni(ue =& of device
device7yp
e
Strin
.
> 7ype of &evice
1:ample Values; B=PA&?"
BA,&R9=&?"?9,6=,1?
Header
parametrs
Juserto0enK;KsadOs3'yuda.sad53'K
After successful authentication system -ould .enerate uni(ue to0en
for each user. 7his user to0en has to be e:chan.ed bet-een each
re(uest and response.
Re0uest
2ormat
<
CidC; C1C
H
Response
(ttri3utes
,ame 7ype &escription
responseC
ode
=nte.
er
%ni(ue code.
response!
s.
Strin
.
!essa.e.
timeStamp Strin
.
Server?s date I time.
invalid8ield
s
6ist 6ist of invalid*empty felds.
Response
2ormat 8ailed Response;
<
C responseCode C ; C#00C"
C response!s. C ; C8ailed ; Value)s+ of feld)s+ are either
empty or invalid.C"
C timeStamp C ; C;0#;01# 1#;$;#2C"
Jinvalid8ieldsK ; <
Jdevice7ypeK ; J100K
H
H
Success Response;
<
C responseCode C ; C00C"
C response!s. C ; C9KC"
C timeStamp C ; C;0#;01# 1#;$;#2C
H
&1. assignUsers%oClasses
Service URL http:conte!tURLservicesapieducatordistri3ution
"device#D$"device%ype$
assignUsers%oClasses
Description 7o assi.n users to classes.
%ype Post
Re0uest
1arameters
,ame 7ype !andator
y
&escription
user=&s 6ist of
=nete.
er
> 6ist of user =&s to be
associated -ith class
class=ds 6ist of
=nete.
er
> 6ist of classes to -hich
users are to be
associated.
device=& Strin. > %ni(ue =& of device
device7y
pe
Strin. > 7ype of &evice
1:ample Values; B=PA&?"
BA,&R9=&?"?9,6=,1?
Header
parametrs
Juserto0enK;KsadOs3'yuda.sad53'K
After successful authentication system -ould .enerate uni(ue to0en
for each user. 7his user to0en has to be e:chan.ed bet-een each
re(uest and response.
Re0uest
2ormat
<
Cuser=&sC; M
'35"
2'3"
1$"
#2'
N"
Cclass=dsC; M
$0
N
H
Response
(ttri3utes
,ame 7ype &escription
responseC =nte. %ni(ue code.
ode er
response!
s.
Strin
.
!essa.e.
timeStamp Strin
.
Server?s date I time.
invalid8ield
s
6ist 6ist of invalid*empty felds.
Response
2ormat 8ailed Response;
<
C responseCode C ; C#00C"
C response!s. C ; C8ailed ; Value)s+ of feld)s+ are either
empty or invalid.C"
C timeStamp C ; C;0#;01# 1#;$;#2C"
Jinvalid8ieldsK ; <
Jdevice7ypeK ; J100K
H
H
Success Response;
<
C responseCode C ; C00C"
C response!s. C ; C9KC"
C timeStamp C ; C;0#;01# 1#;$;#2C
H
&&. unassignUsers2romClass
Service URL http:conte!tURLservicesapieducatordistri3ution
"device#D$"device%ype$
unassignUsers2romClass
Description 7o disassociate users from classes.
%ype Post
Re0uest
1arameters
,ame 7ype !andator
y
&escription
user=&s 6ist of
=nete.
er
> 6ist of user =&s to be
disassociated from the
class
class=ds 6ist of
=nete.
er
> 6ist of classes from
-hich users are to be
disassociated.
device=& Strin. > %ni(ue =& of device
device7y
pe
Strin. > 7ype of &evice
1:ample Values; B=PA&?"
BA,&R9=&?"?9,6=,1?
Header
parametrs
Juserto0enK;KsadOs3'yuda.sad53'K
After successful authentication system -ould .enerate uni(ue to0en
for each user. 7his user to0en has to be e:chan.ed bet-een each
re(uest and response.
Re0uest
2ormat
<
Cuser=&sC; M
'35"
2'3"
1$"
#2'
N"
Cclass=dsC; M
$0
N
H
Response
(ttri3utes
,ame 7ype &escription
responseC
ode
=nte.
er
%ni(ue code.
response!
s.
Strin
.
!essa.e.
timeStamp Strin
.
Server?s date I time.
invalid8ield
s
6ist 6ist of invalid*empty felds.
Response
2ormat 8ailed Response;
<
C responseCode C ; C#00C"
C response!s. C ; C8ailed ; Value)s+ of feld)s+ are either
empty or invalid.C"
C timeStamp C ; C;0#;01# 1#;$;#2C"
Jinvalid8ieldsK ; <
Jdevice7ypeK ; J100K
H
H
Success Response;
<
C responseCode C ; C00C"
C response!s. C ; C9KC"
C timeStamp C ; C;0#;01# 1#;$;#2C
H
&'. /etchUnassignedStudentList
Service
URL
http:conte!tURLservicesapieducatordistri3ution"device#D$
"device%ype$"class#D$
/etchUnassignedStudentList
Descript
ion
7o fetch unassi.ned users of the class.
%ype Let
Re0uest
1aramet
ers
,ame 7ype !andator
y
&escription
device=& Strin
.
> %ni(ue =& of device
device7ype Strin
.
> 7ype of &evice
1:ample Values; B=PA&?"
BA,&R9=&?"?9,6=,1?
class=& =nte.
er
> =& of the class
Header
paramet
rs
Juserto0enK;KsadOs3'yuda.sad53'K
After successful authentication system -ould .enerate uni(ue to0en for
each user. 7his user to0en has to be e:chan.ed bet-een each re(uest
and response.
Re0uest
2ormat
Respons
e
(ttri3ut
es
,ame 7ype &escription
responseC
ode
=nte.
er
%ni(ue code.
response!
s.
Strin
.
!essa.e.
timeStamp Strin
.
Server?s date I time.
invalid8ield
s
6ist 6ist of invalid*empty felds.
user6ist 6ist 6ist of %sers.
id =nte.
er
=& of the user.
frst,ame Strin
.
8irst ,ame of the student.
last,ame Strin
.
6ast ,ame of the student.
Respons
e
2ormat
8ailed Response;
<
C responseCode C ; C#00C"
C response!s. C ; C8ailed ; Value)s+ of feld)s+ are either
empty or invalid.C"
C timeStamp C ; C;0#;01# 1#;$;#2C"
Jinvalid8ieldsK ; <
Jdevice7ypeK ; J101K
H
H
Success Response;
<
CresponseCodeC; C00C"
Cresponse!s.C; C9KC"
CtimeStampC; C;0#;01# 1#;$;#2C"
Cuser6istC; M
<
CidC; 24"
Cfrst,ameC; C!athsC"
Clast,ameC; C6earnerC
H"
<
CidC; 2#"
Cfrst,ameC; ConeC"
Clast,ameC; ClearnerC
H"
<
CidC; 22"
Cfrst,ameC; Ct-oC"
Clast,ameC; ClearnerC
H
N
H
&+. create>rder
Service URL http:conte!tURLservicesapieducatordistri3ution
"device#D$"device%ype$
create>rder
Description 7o create 9rder for institute.
%ype Post
Re0uest
1arameters
,ame 7ype !andator
y
&escription
order > &etails of 9rder
created/y =nete.
er
> =& of the user -ho is
creatin. the 9rder.
order,o Strin. > %ser defned 9rder
,umber
type =nte.e
r
> 7ype of order.
1. %n6imited
6icense
. 6imited license
order&etail
s
6ist > !ore details of the
order for each boo0
boo0=& =nte.e
r
> =& of the boo0 for
-hich order re(uired
activation&
ate
&ate > &ate of activation of
the order
duration =nte.e
r
> &uration of the 9rder
total6icens
es
=nte.e
r
> 7otal licenses re(uired
for each boo0
formats 6ist > 6ist of formats.
1:ample
Values; B=PA&?"
BA,&R9=&?"?9,6=,1?
accessCode /oolea
n
> =f access codes are
re(uired.
device=& Strin. > %ni(ue =& of device
device7ype Strin. > 7ype of &evice
1:ample
Values; B=PA&?"
BA,&R9=&?"?9,6=,1?
Header
parametrs
Juserto0enK;KsadOs3'yuda.sad53'K
After successful authentication system -ould .enerate uni(ue to0en
for each user. 7his user to0en has to be e:chan.ed bet-een each
re(uest and response.
Re0uest
2ormat
<
CresponseCodeC; C00C"
Cresponse!s.C; C9KC"
CtimeStampC; C;0#;01# 1#;$;#2C"
CorderC; <
Ccreated/yC; C24C"
Corder,oC; C9rder 1C"
CtypeC; C1C"
Corder&etailsC; M
<
Cboo0=&C; C$C"
Cactivation&ateC; C01#F0#F#C"
CdurationC; C$'2C"
Ctotal6icensesC; C10C"
CformatsC; M
C=PA&C"
CPCC
N"
CaccessCodeC; C8C
H
N
H
H
Response
(ttri3utes
,ame 7ype &escription
responseC
ode
=nte.
er
%ni(ue code.
response!
s.
Strin
.
!essa.e.
timeStamp Strin
.
Server?s date I time.
invalid8ield
s
6ist 6ist of invalid*empty felds.
Response
2ormat 8ailed Response;
<
C responseCode C ; C#00C"
C response!s. C ; C8ailed ; Value)s+ of feld)s+ are either
empty or invalid.C"
C timeStamp C ; C;0#;01# 1#;$;#2C"
Jinvalid8ieldsK ; <
Jdevice7ypeK ; J100K
H
H
Success Response;
<
C responseCode C ; C00C"
C response!s. C ; C9KC"
C timeStamp C ; C;0#;01# 1#;$;#2C
H
&,. assign?oo=
Service
URL
http:conte!tURLservicesapieducatorlicense
"device#D$"device%ype$
"user#Ds$"3oo=#Ds$assign?oo=
Description 7o assi.n/oo0 for institute.
%ype Let
Re0uest
1arameters
,ame 7ype !andator
y
&escription
user=&s =nte.e
r
> Comma separated
user=&s
boo0=&s =nte.e
r
> Comma separated
boo0=&s
device=& Strin. > %ni(ue =& of device
device7ype Strin. > 7ype of &evice
1:ample
Values; B=PA&?"
BA,&R9=&?"?9,6=,1?
Header
parametrs
Juserto0enK;KsadOs3'yuda.sad53'K
After successful authentication system -ould .enerate uni(ue
to0en for each user. 7his user to0en has to be e:chan.ed bet-een
each re(uest and response.
Re0uest
2ormat
Response
(ttri3utes
,ame 7ype &escription
responseC
ode
=nte.
er
%ni(ue code.
response!
s.
Strin
.
!essa.e.
timeStamp Strin
.
Server?s date I time.
invalid8ield
s
6ist 6ist of invalid*empty felds.
Response
2ormat
8ailed Response;
<
C responseCode C ; C#00C"
C response!s. C ; C8ailed ; Value)s+ of feld)s+ are
either empty or invalid.C"
C timeStamp C ; C;0#;01# 1#;$;#2C"
Jinvalid8ieldsK ; <
Jdevice7ypeK ; J100K
H
H
Success Response;
<
C responseCode C ; C00C"
C response!s. C ; C9KC"
C timeStamp C ; C;0#;01# 1#;$;#2C
H
&-. /etch?oo=(nalytics
Service
URL
http:conte!tURLservicesapieducatoranalytics
"device#D$"device%ype$
/etch?oo=(nalytics
Description 7o fetch analytics of all the boo0s for the institute.
%ype Let
Re0uest
1arameters
,ame 7ype !andator
y
&escription
device=& Strin. > %ni(ue =& of device
device7ype Strin. > 7ype of &evice
1:ample
Values; B=PA&?"BA,&R
9=&?"?9,6=,1?
Header
1arameters
Juserto0enK;KsadOs3'yuda.sad53'K
After successful authentication system -ould .enerate uni(ue
to0en for each user. 7his user to0en has to be e:chan.ed bet-een
each re(uest and response.
Re0uest
2ormat
Response
(ttri3utes
,ame 7ype &escription
responseCode =nte.er %ni(ue code.
response!s. Strin. !essa.e.
timeStamp Strin. Server?s date I time.
invalid8ields 6ist 6ist of invalid*empty
felds.
boo0Analytics 6ist 6ist of boo0s -ith
analytics
boo0 /oo0 details
id =nte.er =& of the boo0.
title Strin. 7itle of the boo0.
enrichmentsCount =nte.er Count of resources
used to enrich the
boo0
created9n &ate /oo0 creation date
pa.eCount =nte.er Count of the pa.es
assi.nmentCount =nte.er Count of the boo0.
do-nloadCount =nte.er Count of the
do-nload boo0s.
covera.e =nte.er U of boo0 read as of
no-.
timeSpent =nte.er 7otal time spent for
the boo0 analytics.
Response
2ormat
8ailed Response;
<
C responseCode C ; C#00C"
C response!s. C ; C8ailed ; Value)s+ of feld)s+ are
either empty or invalid.C"
C timeStamp C ; C;0#;01# 1#;$;#2C"
Jinvalid8ieldsK ; <
JisbnK ; J100K"
JtitleK ; J101K"
Jdevice7ypeK ; J10K
H
H
Success Response;
<
CresponseCodeC ; 00"
Cresponse!s.C ; C9KC"
CtimestampC ; C01#F02F4 15;13;2.5#2C"
Cboo0AnalyticsC ; M <
Cboo0C ; <
CidC ; 24"
CtitleC ; Cboo00anchanC
H"
CenrichmentsCountC ; 10"
Ccreated9nC ; C5F02F01# 1;00;00C"
Cpa.eCountC ; 1#"
Cassi.nmentCountC ; 3"
Cdo-nloadCountC ; 5"
Ccovera.eC ; 1"
CtimeSpentC ; C00#.0C
H" <
Cboo0C ; <
CidC ; '#"
CtitleC ; C!eine 8reundeC
H"
Ccreated9nC ; C5F02F01# 1;00;00C"
Cpa.eCountC ; 2"
Cassi.nmentCountC ; 11"
Cdo-nloadCountC ; 15"
Ccovera.eC ; "
CtimeSpentC ; C2413.0C
H" <
Cboo0C ; <
CidC ; '2"
CtitleC ; CT=,LSC
H"
Ccreated9nC ; C5F02F01# 1;00;00C"
Cpa.eCountC ; 11"
Cassi.nmentCountC ; 11"
Cdo-nloadCountC ; 4"
Ccovera.eC ; #"
CtimeSpentC ; C1114.0C
H" <
Cboo0C ; <
CidC ; ''"
CtitleC ; C7he GeartC
H"
Ccreated9nC ; C5F02F01# 1;00;00C"
Cpa.eCountC ; 1"
Cassi.nmentCountC ; 11"
Cdo-nloadCountC ; 2"
CtimeSpentC ; C13043.0C
H
&.. /etch?oo=Details
Service
URL
http:conte!tURLservicesapieducatorlicense
"device#D$"device%ype$
"3oo=#D$/etch?oo=Details
Description 7o fetch the details of the boo0.
%ype Let
Re0uest
1arameters
,ame 7ype !andatory &escription
boo0=& =nte.er > %ni(ue =& of the
boo0.
device=& Strin. > %ni(ue =& of device
device7ype Strin. > 7ype of &evice
1:ample
Values; B=PA&?"BA,&
R9=&?"?9,6=,1?
Header
1arameters
Juserto0enK;KsadOs3'yuda.sad53'K
After successful authentication system -ould .enerate uni(ue
to0en for each user. 7his user to0en has to be e:chan.ed bet-een
each re(uest and response.
Re0uest
2ormat
Response
(ttri3utes
,ame 7ype &escription
responseCode =nte.er %ni(ue code.
response!s. Strin. !essa.e.
timeStamp Strin. Server?s date I time.
invalid8ields 6ist 6ist of invalid*empty
felds.
boo06ist 6ist 6ist of boo0)s+.
boo0 /oo0 details
id =nte.er &isplay the =& of the
boo0.
isbn Strin. =S/, of the boo0
title Strin. 7itle of the boo0
thumb%R6 Strin. %R6 path of the boo0
cover pa.e.
pa.es =nte.er ,umber of pa.es in
the boo0.
author Strin. ,ame of the author
publisher Strin. ,ame of the
publisher.
enrichments 6ist Consist of the list of
values li0e ima.e"
VvWs" videoWs
formats 6ist 6ist of formats.
1:ample
Values; B=PA&?"
BA,&R9=&?"?9,6=,1?
classAssociation /oolean =t provides either
true or false.
Response
2ormat
8ailed Response;
<
C responseCode C ; C#00C"
C response!s. C ; C8ailed ; Value)s+ of feld)s+ are
either empty or invalid.C"
C timeStamp C ; C;0#;01# 1#;$;#2C"
Jinvalid8ieldsK ; <
JisbnK ; J100K"
JtitleK ; J101K"
Jdevice7ypeK ; J10K
H
H
Success Response;
<
CresponseCodeC ; 00"
Cresponse!s.C ; C9KC"
CtimestampC ; C01#F02F4 1$;;2'C"
Cboo06istC ; M <
Cboo0C ; <
CidC ; 5"
CisbnC ; C435021135''1C"
CtitleC ; C1SS1,7=A6 !A7G1!A7=CS >ear 10 and 10AC"
Cthumb%R6C ;
Chttp;**cloud.0itaboo.com;50*test*thumbnails*435021135''1.pn.
C"
Cpa.esC ; 344"
CauthorC ; CasdC"
CpublisherC ; Cedsoft.adminD0itaboo.comC"
CenrichmentsC ; <
H"
CformatsC ; M <
CidC ; $"
CnameC ; CA,&R9=&C
H" <
CidC ; 1"
CnameC ; CPCC
H" <
CidC ; "
CnameC ; C=PA&C
H N
H"
CclassAssociationC ; false
H N
H
&4. /etchEnrichment(nalytics
Service
URL
http:conte!tURLservicesapieducatoranalytics
"device#D$"device%ype$
"3oo=#D$/etchEnrichment(nalytics
Description 7o fetch details of enrichments of the boo0.
%ype Let
Re0uest
1arameters
,ame 7ype !andatory &escription
boo0=& =nte.er > %ni(ue =& of
the boo0.
device=& Strin. > %ni(ue =& of
device
device7ype Strin. > 7ype of &evice
1:ample
Values; B=PA&?"B
A,&R9=&?"?9,6
=,1?
Header
1arameters
Juserto0enK;KsadOs3'yuda.sad53'K
After successful authentication system -ould .enerate uni(ue
to0en for each user. 7his user to0en has to be e:chan.ed bet-een
each re(uest and response.
Re0uest
2ormat
Response
(ttri3utes
,ame 7ype &escription
responseCode =nte.er %ni(ue code.
response!s. Strin. !essa.e.
timeStamp Strin. Server?s date I time.
invalid8ields 6ist 6ist of invalid*empty
felds.
title Strin. 7itle of the boo0.
pa.es =nte.er ,umber of pa.es in
the boo0
author Strin. Author of the boo0.
enrichments 6ist 6ist of enrichments
of the boo0 li0e
ima.es" audios"
videos etc.
created9n &ate /oo0 created date
Response
2ormat
8ailed Response;
<
C responseCode C ; C#00C"
C response!s. C ; C8ailed ; Value)s+ of feld)s+ are
either empty or invalid.C"
C timeStamp C ; C;0#;01# 1#;$;#2C"
Jinvalid8ieldsK ; <
Juserto0enK ; J100K"
JtitleK ; J101K"
Jdevice7ypeK ; J10K"

H
H
Success Response;
<
CresponseCodeC ; 00"
Cresponse!s.C ; C9KC"
CtimestampC ; C01#F02F4 15;2;.#3C"
CtitleC ; CdhfrfC"
Cpa.esC ; 00"
CauthorC ; Csales learner10C"
CenrichmentsC ; <
CvideoC ; 10"
Cima.eC ; 0"
CaudioC ; 10"
CnotesC ; 10
H"
Ccreated9nC ; C1F0$F01# 01;12;'C
H
&:. /etchUserDetail(nalytics
Service
URL
http:conte!tURLservicesapieducatoranalytics
"device#D$"device%ype$
"3oo=#D$/etchUserDetail(nalytics
Description 7o fetch userF-ise detailed analytics of the boo0.
%ype Let
Re0uest
1arameters
,ame 7ype !andatory &escription
boo0=& =nte.er > %ni(ue =& of
the boo0.
device=& Strin. > %ni(ue =& of
device
device7ype Strin. > 7ype of &evice
1:ample
Values; B=PA&?"B
A,&R9=&?"?9,6
=,1?
Header
1arameters
Juserto0enK;KsadOs3'yuda.sad53'K
After successful authentication system -ould .enerate uni(ue
to0en for each user. 7his user to0en has to be e:chan.ed bet-een
each re(uest and response.
Re0uest
2ormat
Response
(ttri3utes
7ame %ype Description
responseCode =nte.er %ni(ue code.
response!s. Strin. !essa.e.
timeStamp Strin. Server?s date I time.
invalid8ields 6ist 6ist of invalid*empty
felds.
boo0&etailAnalytics 6ist &etails of the
boo0Analytics.
user &etails of user
frst,ame Strin. 8irst name of the
user
user,ame Strin. %ser name of the
user
created9n &ate &isplay the created
date.
contact,o =nte.er Contact number of
the user.
class&tl Class details
name Strin. ,ame of the class
do-nload&ate &ate &ate of the
do-nload of the
boo0.
covera.e =nte.er &isplays the reader
pa.es out of total
pa.es.
timeSpent =nte.er 7otal time spent
displayed.
Response
2ormat
8ailed Response;
<
C responseCode C ; C#00C"
C response!s. C ; C8ailed ; Value)s+ of feld)s+ are
either empty or invalid.C"
C timeStamp C ; C;0#;01# 1#;$;#2C"
Jinvalid8ieldsK ; <
Juserto0enK ; J100K"
JusernameK ; J101K"
Jdevice7ypeK ; J10K"

H
H
Success Response;
<
CresponseCodeC ; 00"
Cresponse!s.C ; C9KC"
CtimestampC ; C01#F02F4 14;1';01.'2C"
Cboo0&etailAnalyticsC ; M <
CuserC ; <
Cfrst,ameC ; Csales instructorC"
Cuser,ameC ; Csales.instructorD0itaboo.comC"
Ccreated9nC ; C1F0$F01# 01;1';11C"
Ccontact,oC ; C0C"
CdeletedC ; false"
CdisabledC ; false
H"
Cclass&tlC ; <
CnameC ; C&emo ClassC
H"
Cdo-nload&ateC ; C13F0#F01# 0';$0;##C"
Ccovera.eC ; 5"
CtimeSpentC ; 10223
H" <
CuserC ; <
Cfrst,ameC ; Csales learner1C"
Cuser,ameC ; Csales.learner1D0itaboo.comC"
Ccreated9nC ; C1F0$F01# 01;04;04C"
Ccontact,oC ; C0C"
CdeletedC ; false"
CdisabledC ; false
H"
Cclass&tlC ; <
CnameC ; C&emo ClassC
H"
Cdo-nload&ateC ; C13F0#F01# 0';$0;##C"
Ccovera.eC ; 1"
CtimeSpentC ; 10$1
H" <
CuserC ; <
Cfrst,ameC ; Csales learnerC"
Cuser,ameC ; Csales.learnerD0itaboo.comC"
Ccreated9nC ; C1F0$F01# 01;04;##C"
Ccontact,oC ; C0C"
CdeletedC ; false"
CdisabledC ; false
H"
Cclass&tlC ; <
CnameC ; C&emo ClassC
H"
Cdo-nload&ateC ; C13F0#F01# 0';$0;##C"
Ccovera.eC ; 5"
CtimeSpentC ; 550
H
';. (ppendi!:
Code Description
&;; SUCCESS
+;; FAILURE
1;; EMPTY_FIELD
1;1 INVALID_FIELD
1;& INVALID_TYPE
1;' TOKEN_EXPIRED
1;+ MULTIPLE_CLIENTS
1;, MULTIPLE_INSTITUTES
1;- DUPLICATE_EMAIL
-;1 ACCESS_CODE_INVALID
-;& ACCESS_CODE_WITH_OTHER_USER
-;' ACCESS_CODE_WITH_SAME_USER
-;+ ACCESS_CODE_WITH_OTHER_INSTITUTE
-;, ACCESS_CODE_DISTRIBUTION_FAILED
.;; CLIENT_INVALID