API Specification

[lvergergsk]

General

• Backend DEV server: http://localhost:3001
• Basic header:

  Accept:application/json
  Content-Type:application/json

  Sign up:

• Target: "/register"
• Request body:
  • All field is required

    {
    "username": "testUsername",
    "password": "testPassword",
    "email": "test@email.com"
    }

• Response body:

  {
  "success": true,
  "JWT": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6InRlc3RVc2VybmFtZSIsImlhdCI6MTUyMjM1NjI4NiwiZXhwIjoxNTIyMzU5ODg2fQ.XdO1IvCbRSOhvcKG0CjWWsew0U2u2feIvPsF3Ilumtc"
  }

  Sign in:

• Target: "/login"
• Request body:
  • All fields are required

    {
    "username": "testUsername",
    "password": "testPassword"
    }

• Response body (success):

  {
  "success": true,
  "JWT": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6InRlc3RVc2VybmFtZSIsImlhdCI6MTUyMjM1ODYzNCwiZXhwIjoxNTIyMzYyMjM0fQ.awouQAFe9CI7HkqPTe9JVO6SzGw1dwFrhQfMwLro1qk"
  }

• Response body (fail):

  {
  "success": false,
  "error": "Username or password is not correct."
  }

[kenkangxgwe]

Queries

Publications (Updated 23:52 04/23/18)

• Target: /search
• Request body:
  • type should be pub
  • pubtype is an array of types. Query all pub types if not specified.
  • params are string to be replaced in SQL.
  • title of publication
  • proceedingid, bookid, journal: specify the collection that you want to search.
  • person specify the keyword of person's name.
  • yearbegin and yearend specified the time range. Both are optional.
  • offset and num specified the pagination.
  • order now only supports type: year, order can be either ASC or DESC (Capitalized).
  • Do not add unnessary keys into params, but you are free to add other keys into body.

    {
    "type":"pub",
    "pubtype": ["incollection", "book"],
    "params":{
    "title": "TITLE_KEYWORD",
    "proceedingid": "PROCEEDINGID",
    "bookid": "BOOKID",
    "journal": "JOURNALNAME",
    "person": "PERSON_KEYWORD",
    "personid": "PERSON_ID",
    "yearbegin":1999,
    "yearend": 2000,
    "offset": 0,
    "num" : 10
    },
    "order": {
    "type": "year",
    "order": "ASC"
    }
    }

• Response body (succeeded)
  • RN stands for rownum

    {
    "success": true,
    "count": 1,
    "result": [
    {
        "PUBLICATION_ID": "journals/tkde/Osborn89",
        "JOURNAL": "IEEE Trans. Knowl. Data Eng.",
        "PAGES": "[\"310-317\"]",
        "VOLUME": "1",
        "EE": "[\"https://doi.org/10.1109/69.87977\",\"http://doi.ieeecomputersociety.org/10.1109/69.87977\"]",
        "URL": "[\"db/journals/tkde/tkde1.html#Osborn89\"]",
        "RN": 1,
        "ID": "journals/tkde/Osborn89",
        "TITLE": "The Role of Polymorphism in Schema Evolution in an Object-Oriented Database.",
        "YEAR": 1989,
        "TYPE": "article",
        "AUTHOR": [
            {
                "NAME": "Sylvia L. Osborn",
                "ID": "homepages/o/SylviaLOsborn"
            }
        ],
        "CITATION": [
            "Identity, Equality and Query Optimization.",
            "Storage and Access Structures to Support a Semantic Data Model.",
            "Object-Oriented Programming: Themes and Variations.",
            "Object Identity.",
            "Class Modification in the GemStone Object-Oriented DBMS.",
            "Data Model Issues for Object-Oriented Applications.",
            "Queries in Object-Oriented Databases.",
            "Database Abstractions: Aggregation.",
            "Database Abstractions: Aggregation and Generalization.",
            "The Entity-Relationship Model - Toward a Unified View of Data.",
            "The Functional Data Model and the Data Language DAPLEX."
        ]
    }
    ]
    }

• Request body (failed)

  {
  "success": false
  }

Person

• Target: /search

• Tequest body

  {
  "type":"per",
  "pubtype": [],  
  "params":{
   "yearbegin": 1999,
  "person": "Markus Schneider",
  "proceedingid": "conf/IEEEares/2007",
  "yearend": 2010,
  "title": "Polymorphism in Schema Evolution",
  "offset": 0,
  "num" : 10
  },
  "order": {
  "type": "year",
  "order": "DESC"
  }
  }

• Response body (succeeded) (temporary)

  {
  "success": true,
  "count": 78268,
  "result": [
      {
          "RN": 4,
          "ID": "homepages/00/7961",
          "AFFILIATION": null,
          "HOMEPAGE": null,
          "PUBLICATION": [
              {
                  "NAME": "Developments of novel vertically integrated pixel sensors in the high energy physics community.",
                  "ID": "conf/3dic/DemarteauAMR09"
              },
              {
                  "NAME": "Pixel detectors in 3D technologies for high energy physics.",
                  "ID": "conf/3dic/DeptuchDHLSYZ10"
              }
          ],
          "SYNONYM": [
              {
                  "NAME": "Marcel Demarteau",
                  "ID": "homepages/00/7961"
              }
          ],
          "COAUTHOR": [
              {
                  "NAME": "Ronald Lipton",
                  "ID": "homepages/57/10013"
              }
          ]
      }
  ]

• Response body (failed)

  {
  "success": false
  }