VieTex JSON Server API Guide

Routes

GET    /persons
GET    /persons/:id
POST   /persons
PUT    /persons/:id
PATCH  /persons/:id
DELETE /persons/:id

Params & Conditions

==   equal
lt   <
lte  <=
gt   >
gte  >=
ne   !=

GET /persons?num_viewed_gt=100
GET /persons?indices.hindex_gte=50
GET /persons?indices.citations_lt=1000
GET /persons?bind=true
    

Range & Paginate

GET /persons?_start=10&_end=20
GET /persons?_start=10&_limit=10
GET /persons?_page=1&_per_page=25
    

Sort

GET /persons?_sort=name,-num_viewed
GET /persons?_sort=indices.hindex,-indices.citations
    

Nested & Array Fields

GET /persons?profile.gender=male
GET /persons?indices.hindex_gt=50
GET /persons?tags[0]=Collective Intelligence
GET /persons?links.gs.url_like=scholar.google
    

Search

GET /persons?name_like=Nguyen
GET /persons?profile.affiliation_like=University
GET /persons?tags_like=Intelligence
    

Fields in persons schema

Basic: id, name, name_zh, avatar, bind
Numbers: num_viewed, num_followed, num_upvoted
Indices: activity, citations, diversity, gindex, hindex, newStar, pubs, risingStar, sociability
Profile: affiliation, bio, email, gender, homepage, position, work, address
Others: tags, tags_score, links, papers, organizations, venues, source_ids

Embed

GET /persons?_embed=papers

Delete

DELETE /persons/:id
DELETE /persons/:id?_dependent=papers