CommunicationAPI - loveapple Wiki - loveapple

Outline

1. Loveapple Communication API
   1. Data Types
   2. API
      1. generalAPI.initConnection
      2. member.register
      3. member.getBaseInfo
      4. member.getProfile
      5. contents.addCategory
      6. contents.editCategory
      7. contents.findCategory
      8. contents.addContents
      9. contents.editContents
      10. contents.findContents
   3. Struct/JSON Object
      1. Response POJO
      2. Entity POJO

Loveapple Communication API

Loveapple Communication API is base on JSON REST API(or XML REST API) XML-RPC protocol, but it's a REST(Representational State Transfer) web service.
And must addition parameter of jsessionid for request every time, except generalAPI.initConnection

example: http://www.loveapple.cn/xmlrpc/api;jsessionid=XXX
example: http://www.loveapple.cn/api/json;jsessionid=XXX

Data Types

API

generalAPI.initConnection

Returns the session-id and token for the fist access in a session.
Parameters

Type	Name	Requeid
string	id	Y
string	password	Y

Return Values

Type	Name
struct	token(string),session-id(string)

---

member.register

Parameters

Type	Name	Requeid
string	nickName	Y
string	passwd	Y
string	mail	Y
string	msn	N
string	qqNo	N

Return Values

Type	Name
struct	member

---

member.getBaseInfo

Parameters

string	token	Y
string	session-id	Y

Return Values

Type	Name
struct	member

---

member.getProfile

Parameters

string	token	Y
string	session-id	Y

Return Values

struct

profile

---

contents.addCategory

Create a new category. Parameters

Type	Name	Requeid
string	token	Y
array	sub-list(struct category)	N
array	super-list(struct category)	N
struct	category	Y

Return Values

Type	Name
string	added category ID

---

contents.editCategory

Edit category info. Parameters

Type	Name	Requeid
string	token	Y
array	sub-list(struct category)	N
array	super-list(struct category)	N
struct	category	Y

Return Values

Type	Name
int	updated category counts

---

contents.findCategory

Find category list. Parameters

Type	Name	Requeid
string	token	Y
array	sub-list(struct category)	N
array	super-list(struct category)	N
struct	category	Y

Return Values

Type	Name
list	category(struct)

---

contents.addContents

Create a new category. Parameters

Type	Name	Requeid
string	token	Y
array	super-list(struct category)	N
struct	contents	Y

Return Values

Type	Name
string	added contents ID

---

contents.editContents

Edit contents info. Parameters

Type	Name	Requeid
string	token	Y
array	super-list(struct category)	N
struct	contents	Y

Return Values

Type	Name
int	updated contents counts

---

contents.findContents

Find contents list

Type	Name	Requeid
string	token	Y
array	super-list(struct category)	N
struct	contents	Y

Return Values

Type	Name
list	contents(struct)

---

Struct/JSON Object

Structs be definition by schema and struct is same to JSON object.
Version: 2008/8/11

Response POJO

Type	Name
string	token
string	code
string	message
any type

Entity POJO