Project

General

Profile

Actions

Web Services Definition » History » Revision 4

« Previous | Revision 4/40 (diff) | Next »
Kurt Gerber, 25 Jan 2016 17:27


API / Web Services Definition

1. General Requirements

1.1. The API is based on RESTful web services

1.2. No authentification is needed to query/download published data

1.3. The API has a version

This can either be done through a parameter or a path. Preferably part of the path to force version idication.

1.4. Output/Answer

The Output formats should selectable between JSON,XML and CSV with JSON as default.

2. Configuration queries

2.1. All configurations

  • Request
GET .../configurations
  • Parameters:
  • Returns:
    • List of all configurations and all their versions
  • Answer items:
    • Configuration name (identifier)
    • Configuration version
    • Date of creation / last update
    • (Short description ?)

2.2. Single configuration

  • Returns:
    • A single configuration
  • Items

h3.

Updated by Kurt Gerber almost 9 years ago · 4 revisions