Guideline for Web Services

This document is a guideline to design of web services toward integration.

• REST
  • For a database service, REST services to get entries and search by a keyword should be provided.
  • To unify a format of a query, a query language should conform to Common Query Language.
  • A method to get the number of hits for a keyword should be provided.
  • A method to get the list of hit entries for a keyword should be provided.
  • A method to get the entry from an ID should be provided.

• SOAP
  • A manual for each method should be prepared.
    • The manual should include an example of parameters such that the method works well by them.