educator_services_1 0.doc

8/11/2019 Educator_services_1 0.doc

1/57

Document Control

Reference Code Kitaboo Cloud

Security

ClassicationCompany Condential

Version 1.0

Author Arvind Pandey

Revision History

Version Revision Date Change Description

1.0 1th !ay" 01# Created

$rdmay Added authnticate%ser service.

&istribution and order related services added.

https is replaced by http

'thmay !odied re(uest format of class )add*update*delete+

$0th!ay ,e- services added.

1. assin/oo

. fetch/ooAnalytics

$. fetch/oo&etails

Kitaboo Cloud

Service &ocument


2/57

#. fetchnrichmentAnalytics

2. fetch%ser&etailAnalytics

Contents

1. reisterducator..................................................................................................$

. 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....................................................................................................... $


3/57

0. deleteClass........................................................................................................$#

1. assin%sers7oClasses.........................................................................................$2

. unassin%sers8romClass....................................................................................$'

$. fetch%nassinedStudent6ist..............................................................................$3

#. create9rder........................................................................................................ $4

2. assin/oo.........................................................................................................#0

'. fetch/ooAnalytics.............................................................................................#1

3. fetch/oo&etails................................................................................................ ##

5. fetchnrichmentAnalytics..................................................................................#'

4. fetch%ser&etailAnalytics....................................................................................#5

$0. Appendi:;........................................................................................................... 21

1.registerEducatorService URL http:conte!tURLservicesapieducatoruser"device#D$

,ame of =nstitiute

user > &etails of admin userof educator

rst,ame Strin

> %ser?s rst name

last,ame Strin

> %ser?s last name

email Strin

> %ser?s email =&


4/57

user,ame Strin

, =f not provided" email-ill be considered ass*her user name.

pass-ord Strin

> Pass-ord of the user

contact,o Strin

> Contact number ofadmin user

Street Strin

> Street info of adminuser

@ip =nteer

> ip code

city Strin

> City name

state Strin

> State name

country Strin

> Country name

device=& Strin > %ni(ue =& of device

device7ype Strin

> 7ype of &evice:ampleValues; B=PA&?"BA,&R9=&?"?9,6=,?

Re(uest8ormat

< institution,ame; =ndian =nstitute of 7echnoloy" user; < rst,ame; Arvind" last,ame; Pandey" email; arvind.pandeyDhuri:.com"

pass-ord; arvindE1$" user,ame; arvind.pandeyDhuri:.com" contact,o; 41F5511$$##" Street; !ira road" @ip; #01103" city; 7hane" state; !G" country; =ndia HH

ResponseAttributes

,ame 7ype &escriptionresponseC

ode

=nte

er

%ni(ue code.

response!s

Strin

!essae.

timeStamp Strin

Server?s date I time.

invalid8ields

6ist 6ist of invalid*empty elds.

Response 8ailed Response;


5/57

8ormat < responseCode ; #00" response!s ; 8ailed ; Value)s+ of eld)s+ are either

empty or invalid." timeStamp ; ;0#;01# 1#;$;#2"

Jinvalid8ields ; Pass-ord of user.

device=& Strin

> %ni(ue =& of device

device7y

pe

Strin

> 7ype of &evice

:ample Values; B=PA&?"BA,&R9=&?"?9,6=,?

Re(uest8ormat

< user; %ni(ue =& of device )this-ill be 9,6=, in case itsbro-ser+

device7ype

Strin

> 7ype of &evice:ample Values; B=PA&?"BA,&R9=&?"?9,6=,?

uery Params user=&; it contains encrypted value of user=& -hich -ould bedecrypted at server and if its valid user=& then his*her account -illbe activated. 7his %R6 -ill be valid for 1 hours from the time it -asenerated.

Re(uest8ormatResponseAttributes

,ame 7ype &escriptionresponseCode

=nteer

%ni(ue code.

response!s

Strin

!essae.

timeStamp Strin Server?s date I time.


8/57

invalid8ields


Response8ormat Response;

< responseCode ; 00" response!s ; 9K" timeStamp ; ;0#;01# 1#;$;#2

H

+.addUser

Service URL http:conte!tURLservicesapieducatoruser"device#D$ &etails of userrst,ame Strin

> %ser?s rst name

last,ame Strin

> %ser?s last name

email Strin

> %ser?s email =&

user,ame Strin

, =f not provided" email-ill be considered ass*her user name.

contact,o Strin

> Contact number ofadmin user

Street Strin


@ip =nteer

> ip code

city Strin

> City name

state Strin

> State name

country Strin

> Country name


9/57

roles 6ist , 6ist of roles=f roles are not therein the re(uest thendefault learner -ouldbe considered.

id =nte

er

> =& of the role

device=& Strin


device7ype Strin


Headerparametrs

Jusertoen;sadOs3'yudasad53'After successful authentication system -ould enerate uni(ue toenfor each user. 7his user toen has to be e:chaned bet-een eachre(uest and response.

Re(uest8ormat


10/57

id =nteer

=& of the user

Response8ormat

8ailed Response; Contact number ofadmin user

Street Strin


@ip =nteer

> ip code

city Strin

> City name

state Strin

> State name

country Strin

> Country name

roles 6ist , 6ist of roles=f roles are not therein the re(uest then

default learner -ouldbe considered.id =nte

er> =& of the role

device7ype Strin


Headerparametrs


Re(uest8ormat

< user; < rst,ame; Arvind" last,ame; Pandey" email; arvind.pandeyDhuri:.com" user,ame; arvind.pandeyDhuri:.com" contact,o; 41F5511$$##" Street; !ira road" @ip; #01103" city; 7hane" state; !G" country; =ndia"

roles; M < id; 1 H" < id; H N H


12/57

HResponseAttributes


=nteer

%ni(ue code.

response!s

Strin

!essae.

timeStamp Strin


invalid8ields


user %ser detailid =nte

er=& of the user

Response8ormat

8ailed Response; %ni(ue =& of device

device7ype Strin


client=& Strin > =& of the client.

user=& =nteer

> =& of the user -hosedetails has to fetched.

Headerparametrs


Re0uest2ormat


15/57


16/57

Success Response;< responseCode ; 00" response!s ; 9K"

timeStamp ; ;0#;01# 1#;$;#2" user; < id; 1" rst,ame; Arvind" last,ame; Pandey" email; arvind.pandeyDhuri:.com" user,ame; arvind.pandeyDhuri:.com" created9n; $F0#F01" contact; 4502321'#1" street; Street 1" @ip; #00051" city; !umbai"

state; !G" country; =ndia" classes; M < id; 1" name; Gistory H" < id; " name; Leoraphy H" < id; $" name; Physics H N HH

4./etchUsers

Service URL http:conte!tURLservicesapieducator"client#D$user "device#D$"device%ype$/etchUsers)institute#D*516pagination7um*&6 pageSi8e*&,6 searchString*arv

Description 7o fetch users of a client or institute


17/57

%ype Let

Re0uestarameters

,ame 7ype !andatory

&escription

device=& Strin


device7ype Strin


client=& Strin

> =& of the client.

Headerparametrs


9ueryarams

institute=& ; if value is F1 then return users of client else users ofinstitute.paination,um; paination,umQ0 means all users

paination,um0 means ; e; if its andpaeSi@e2 then this

method should return records from 'th to 20thin &/ table.

default value is 1.paeSi@e; ,umber of records to be sho-n per pae. &efaultvalue is 2searchStrin; =f empty returns all users else searched result basedon search Strin.

Re0uest2ormatResponse

(ttri3utes

,ame 7ype &escription

responseCode

=nteer

%ni(ue code.

response!s

Strin

!essae.

timeStamp Strin


invalid8ields


user &etails of admin user of educatorrst,ame Strin

%ser?s rst name

last,ame Strin %ser?s last name

email Strin

%ser?s email =&

user,ame Strin

=f not provided" email -ill beconsidered as s*her user name.

created9n &ate Created date of the user.contact,o Strin

Contact number of admin user


18/57

Street Strin

Street info of admin user

@ip =nteer

ip code

city Strin

City name

state Strin

State name

country Strin

Country name

classes 6ist 6ist of classes a user belons toand its attributes are selfe:planatory.

totalPaes =nteer

,umber of paes )useful forpaination+

Response2ormat 8ailed Response;

< responseCode ; #00" response!s ; 8ailed ; Value)s+ of eld)s+ are either


Jinvalid8ields ; < Juser,ame ; J100" Jpass-ord ; J101 HH

Success Response;< responseCode ; 00" response!s ; 9K" timeStamp ; ;0#;01# 1#;$;#2" totalPaes; 12" users; M < id; 1" rst,ame; Arvind" last,ame; Pandey" email; arvind.pandeyDhuri:.com"

user,ame; arvind.pandeyDhuri:.com" created9n; $F0#F01" contact; 4502321'#1" street; Street 1" @ip; #00051" city; !umbai" state; !G" country; =ndia" classes; M


19/57

< id; 1" name; Gistory H" < id; "

name; Leoraphy H" < id; $" name; Physics H N H" < id; " rst,ame; Kanchan" last,ame; Sa-ardear"

email; anchan.sDhuri:.com" user,ame; anchan.sDhuri:.com" created9n; $F0#F01" contact; 45023#2'#1" street; Street " @ip; #00051" city; !umbai" state; !G" country; =ndia" classes; M < id; 1" name; Gistory H" < id; " name; Leoraphy H" < id; $" name; Physics H N H" < id; $" rst,ame; Anuradha" last,ame; Srivastava" email; anuradha.srivastavDhuri:.com" user,ame; anuradha.srivastavDhuri:.com" created9n; $F0#F01" contact; 2'02321'#1"


20/57

street; Street 1" @ip; #00051" city; !umbai" state; !G" country; =ndia" classes; M

< id; 1" name; Gistory H" < id; " name; Leoraphy H" < id; $" name; Physics H

N H NH

.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

Re0uestarameters

,ame 7ype !andatory

&escription

user > %ser details containinid and ne- pass-ord

id =nteer

> =& of the user -ho needsto be enabled.

device=& Strin


device7ype

Strin


client=& Strin > =& of the client.


21/57

Headerparametrs


Re0uest2ormat

< user ; < id; 1$#2 HH

Response(ttri3utes


=nteer

%ni(ue code.

response!s

Strin

!essae.

timeStamp Strin


invalid8ields





Jinvalid8ields ; < Juser,ame ; J100

HH

Success Response; %ser details containinid and ne- pass-ord

id =nteer

> =& of the user -ho needsto be enabled.


26/57


27/57

response!s ; 9K" timeStamp ; ;0#;01# 1#;$;#2" notes; M < id; 10" note7e:t; ,ote1"

created9n; $F02F11 1;$0 P! H" < id; 11" note7e:t; ,ote" created9n; $F02F11 1;$0 P! H" < id; 1" note7e:t; ,ote$" created9n; $F02F11 1;$0 P! H

NH

1+. rene


28/57

client=& Strin

> =& of the client.

Headerparametrs


Re0uest2ormat

< learner ; < id; 1$#2" pass-ord; arvindE1$ HH

Response(ttri3utes


=nteer

%ni(ue code.

response!

s

Strin

!essae.

timeStamp Strin


invalid8ields





Jinvalid8ields ; < Juser,ame ; J100 HH

Success Response; %ni(ue =& of device

device7ype Strin


class=& =nteer

> =& of the class

Headerparametrs

Jusertoen;sadOs3'yudasad53'After successful authentication system -ould enerate uni(ue toen foreach user. 7his user toen has to be e:chaned bet-een each re(uestand response.

Re0uest2ormatResponse

(ttri3utes

,ame 7ype &escriptionresponseC

ode

=nte

er

%ni(ue code.

response!s

Strin

!essae.

timeStamp Strin


invalid8ields


class6ist 6ist &etails of a sinle class.user %ser detailsid =nte

er=d of the class.

name Strin

,ame of class.

instructors 6ist 6ist of =nstructors -ith their detailsand roles

learners 6ist 6ist of learners -ith their detailsand roles

Response2ormat

8ailed Response; %ni(ue =& of device

device7ype Strin


class=& =nteer

> =& of the class

Headerparametrs

Jusertoen;sadOs3'yudasad53'After successful authentication system -ould enerate uni(ue toen foreach user. 7his user toen has to be e:chaned bet-een each re(uestand response.

Re0uest2ormatResponse(ttri3utes


=nteer

%ni(ue code.

response!s

Strin

!essae.

timeStamp Strin


invalid8ields


user6ist 6ist 6ist of %sers.id =nte

er=& of the user.

rst,ame Strin

8irst ,ame of the student.

last,ame Strin

6ast ,ame of the student.


43/57

Response2ormat

8ailed Response;rder

Service URL http:conte!tURLservicesapieducatordistri3ution"device#D$"device%ype$create>rder

Description 7o create 9rder for institute.

%ype Post


44/57

Re0uestarameters

,ame 7ype !andatory

&escription

order > &etails of 9rdercreated/y =nete

er> =& of the user -ho is

creatin the 9rder.order,o Strin > %ser dened 9rder

,umbertype =ntee

r> 7ype of order.

1. %n6imited6icense

. 6imited licenseorder&etails

6ist > !ore details of theorder for each boo

boo=& =nteer

> =& of the boo for-hich order re(uired

activation&ate

&ate > &ate of activation ofthe order

duration =nteer > &uration of the 9rder

total6icenses

=nteer

> 7otal licenses re(uiredfor each boo

formats 6ist > 6ist of formats.:ampleValues; B=PA&?"BA,&R9=&?"?9,6=,?

accessCode /oolean

> =f access codes arere(uired.

device=& Strin > %ni(ue =& of devicedevice7ype Strin > 7ype of &evice

:ampleValues; B=PA&?"BA,&R9=&?"?9,6=,?

Headerparametrs


Re0uest2ormat

< responseCode; 00" response!s; 9K" timeStamp; ;0#;01# 1#;$;#2" order; Comma separatedboo=&s

device=& Strin > %ni(ue =& of devicedevice7ype Strin > 7ype of &evice

:ampleValues; B=PA&?"BA,&R9=&?"?9,6=,?

Headerparametrs

Jusertoen;sadOs3'yudasad53'After successful authentication system -ould enerate uni(uetoen for each user. 7his user toen has to be e:chaned bet-een

each re(uest and response.Re0uest2ormat

Response(ttri3utes


=nteer

%ni(ue code.

response!s

Strin

!essae.

timeStamp Strin


invalid8ield

s


Response2ormat

8ailed Response; %ni(ue =& of the

boo.

device=& Strin > %ni(ue =& of device

device7ype Strin > 7ype of &evice:ampleValues; B=PA&?"BA,&R9=&?"?9,6=,?


50/57

Headerarameters

Jusertoen;sadOs3'yudasad53'After successful authentication system -ould enerate uni(uetoen for each user. 7his user toen has to be e:chaned bet-eeneach re(uest and response.

Re0uest2ormatResponse(ttri3utes

,ame 7ype &escription

responseCode =nteer %ni(ue code.

response!s Strin !essae.


invalid8ields 6ist 6ist of invalid*emptyelds.

boo6ist 6ist 6ist of boo)s+.

boo /oo detailsid =nteer &isplay the =& of the

boo.

isbn Strin =S/, of the boo

title Strin 7itle of the boo

thumb%R6 Strin %R6 path of the boo

cover pae.

paes =nteer ,umber of paes inthe boo.

author Strin ,ame of the author

publisher Strin ,ame of the

publisher.

enrichments 6ist Consist of the list of

values lie imae"

vWs" videoWs

formats 6ist 6ist of formats.:ampleValues; B=PA&?"BA,&R9=&?"?9,6=,?

classAssociation /oolean =t provides either


51/57

true or false.

Response2ormat

8ailed Response;

< responseCode ; #00" response!s ; 8ailed ; Value)s+ of eld)s+ are

either empty or invalid." timeStamp ; ;0#;01# 1#;$;#2"

Jinvalid8ields ; < Jisbn ; J100" Jtitle ; J101" Jdevice7ype ; J10 HH

Success Response;

< responseCode ; 00" response!s ; 9K" timestamp ; 01#F02F4 1$;;2'" boo6ist ; M < boo ; < id ; 5" isbn ; 435021135''1"

title ; SS,7=A6 !A7G!A7=CS >ear 10 and 10A" thumb%R6 ;http;**cloud.itaboo.com;50*test*thumbnails*435021135''1.pn" paes ; 344" author ; asd" publisher ; edsoft.adminDitaboo.com" enrichments ; < H" formats ; M < id ; $" name ; A,&R9=&

H"


52/57

H NH

&4. /etchEnrichment(nalytics

ServiceURL

http:conte!tURLservicesapieducatoranalytics"device#D$"device%ype$"3oo=#D$/etchEnrichment(nalytics

Description 7o fetch details of enrichments of the boo.

%ype Let

Re0uestarameters ,ame 7ype !andatory &escription

boo=& =nteer > %ni(ue =& ofthe boo.

device=& Strin > %ni(ue =& ofdevice

device7ype Strin > 7ype of &evice:ample

Values; B=PA&?"BA,&R9=&?"?9,6=,?

Headerarameters

Jusertoen;sadOs3'yudasad53'After successful authentication system -ould enerate uni(uetoen for each user. 7his user toen has to be e:chaned bet-eeneach re(uest and response.

Re0uest2ormat

Response(ttri3utes ,ame 7ype &escription

responseCode =nteer %ni(ue code.

response!s Strin !essae.



53/57

invalid8ields 6ist 6ist of invalid*emptyelds.

title Strin 7itle of the boo.

paes =nteer ,umber of paes inthe boo

author Strin Author of the boo.

enrichments 6ist 6ist of enrichmentsof the boo lieimaes" audios"videos etc.

created9n &ate /oo created date

Response2ormat

8ailed Response;

< responseCode ; #00" response!s ; 8ailed ; Value)s+ of eld)s+ are

either empty or invalid." timeStamp ; ;0#;01# 1#;$;#2"

Jinvalid8ields ; < Jusertoen ; J100" Jtitle ; J101" Jdevice7ype ; J10"

HH

Success Response;

< responseCode ; 00" response!s ; 9K" timestamp ; 01#F02F4 15;2;.#3" title ; dhfrf" paes ; 00" author ; sales learner10" enrichments ;

educator_services_1 0.doc

Documents