Introduction

---

The following functions on Arnetminer are provided as RESTful web services here.

- Expert Search

- Publication Search

- Conference Search

- get Person Profile

- get Publication Information (in Progress)

- get Conference Information (in Progress)

Debugs

---

Oct 11, 2010

Enable to get id in search-conference.

Enable options in search-expert, more profile can be return by o=tttt.

Enable customize service.

Thanks Whale for testing. ^o^nnmn

2.1 Common Parameters

---

These parameters are Included in every RESTful Web Services Function

Category	Name	Description	Type	Example	Default
QueryParam	u	user name for access	String	u=oyster	null
QueryParam	outputjs	directly assign as JAVA Script's variable if true	Boolean	outputjs=true	false
QueryParam	varname	variable name for outputjs's assign	String	varname=jsvar	ws_result

2.2 Expert Search

---

This function can return a related expert's list by keyword

URI Format

arnetminer.org/services/search-expert?q=[q]&u=[u]&start=[start]&num=[num]&outputjs=[outputjs]&varname=[varname]

Category	Name	Description	Type	Example	Default
Function	search-expert	return a list of experts that related to the keywords	String (in Json format)
QueryParam	u	user name for access	String	u=oyster	null
QueryParam	q	search keyword	String	q=data mining	null
QueryParam	start	start index of result	Integer	start=0	0
QueryParam	num	number of results return	Integer	num=20	20
QueryParam	outputjs	directly assign as JAVA Script's variable if true	Boolean	outputjs=true	false
QueryParam	varname	variable name for outputjs's assign	String	varname=jsvar	ws_result

Sample Input

http://arnetminer.org/services/search-expert?q=factor graph&u=oyster&start=3&num=2&outputjs=true&varname=esresult

Sample Output

{
    "time_elapsed":153.0,
    "total_result_count":8804,
    "results":
    [
        {
            "id":1158861,
            "name":"M. Irani"
        },
        {
            "id":123223,
            "name":"Andrew Ng"
        }
    ],
    "start_index":3,
    "result_count":2
}

Output Describtion

time_elapsed: time spent in search (in ms)

total_result_count: total result number of the keyword

results: search result list

results.id: expert's id in database

results.name: expert's name

start_index: result's start index

result_count: result's number

2.3 Publication Search

---

This function can return a related publication's list by keyword

URI Format

arnetminer.org/services/search-publication?q=[q]&u=[u]&start=[start]&num=[num]

Category	Name	Description	Type	Example	Default
Function	search-publication	return a list of publications that related to the keywords	String (in Json format)
QueryParam	u	user name for access	String	u=oyster	null
QueryParam	q	search keyword	String	q=data mining	null
QueryParam	start	start index of result	Integer	start=0	0
QueryParam	num	number of results return	Integer	num=20	20

Sample Input

http://arnetminer.org/services/search-publication?q=factor graph&u=oyster&start=3&num=2

Sample Output

{
    "time_elapsed":0.173,
    "total_result_count":4917,
    "results":
    [
        {
            "id":1107013,
            "title":"Factor graphs and the sum-product algorithm",
            "startpage":498,
            "endpage":519,
            "pubyear":2001,
            "authors":"Frank R. Kschischang,Brendan J. Frey,Hans-Andrea Loeliger",
            "citedby":2265,
            "pubkey":"journals/tit/KschischangFL01",
            "jconfname":"IEEE Transactions on Information Theory"
        },
        {
            "id":610541,
            "title":"Random graphs",
            "startpage":960,
            "endpage":960,
            "pubyear":2006,
            "authors":"Alan M. Frieze",
            "citedby":4028,
            "pubkey":"conf/soda/Frieze06",
            "jconfname":"SODA"
        }
    ],
    "start_index":0,
    "result_count":2
}

Output Describtion

time_elapsed: time spent in search (in ms)

total_result_count: total result number of the keyword

results: search result list

results.id: publication's id in database

results.title: publication's title

results.startpage: publication's start page in corpus

results.endpage: publication's end page in corpus

resutls.pubyear: publication's publish year

results.authors: publication's authors, split by comma if more than one

results.citedby: publication's citation number

results.pubkey: publication's search key

results.jconfname: journal/conference's name of the publication

start_index: result's start index

result_count: result's number

2.4 Conference Search

---

This function can return a related conference's list by keyword

URI Format

arnetminer.org/services/search-conference?q=[q]&u=[u]&start=[start]&num=[num]

Category	Name	Description	Type	Example	Default
Function	search-conference	return a list of conferences that related to the keywords	String (in Json format)
QueryParam	u	user name for access	String	u=oyster	null
QueryParam	q	search keyword	String	q=data mining	null
QueryParam	start	start index of result	Integer	start=0	0
QueryParam	num	number of results return	Integer	num=20	20

Sample Input

http://arnetminer.org/services/search-conference?q=factor graph&u=oyster&start=3&num=2

Sample Output

{
    "time_elapsed":0.105,
    "total_result_count":1359,
    "results":
    [
        {
            "id":0,
            "name":"ACM Trans. Graph."
        },
        {
            "id":0,
            "name":"SIAM J. Comput."
        }
    ],
    "start_index":3,
    "result_count":2
}

Output Describtion

time_elapsed: time spent in search (in ms)

total_result_count: total result number of the keyword

results: search result list

results.id: conference's id in database

results.name: conference's name

start_index: result's start index

result_count: result's number

2.5 get Person Profile

---

This function can return a person's profile by name or id

URI Format

arnetminer.org/services/person/[name]?u=[u]&o=[o]

arnetminer.org/services/person/[id]?u=[u]&o=[o]

Category	Name	Description	Type	Example	Default
Function	person	return a person's profile by name or id	String (in Json format)
PathParam	name	person's name for search	String (A-Za-z)	bo wang	null
PathParam	id	person's id for search	Integer	79160	null
QueryParam	u	user name for access	String	u=oyster	null
QueryParam	o	options for getting detail profile	String	q=ttf	tff

 

Sample Input

http://arnetminer.org/services/person/bo wang?u=oyster&o=ttf

http://arnetminer.org/services/person/79160?u=oyster&o=ttf

Sample Output

{
    "id":79181,
    "alias":
    [
        "Bo Wang"
    ],
    "name":"Bo Wang",
    "picture_url":"http://arnetminer.org/images/no_photo.jpg"
}

Output Describtion

id: person's id in database

alias: person's coauthors, a list of names

name: person's name

picture_url: person's picture

Notice

A Lucky result may present if it is ambiguity