wactbprot / vl-agwt

vlagwt

An agwt to vl REST interface.

Table of Contents

• vlagwt
  • Installation
  • Start server
  • API
    • available calibration procedures (ToDo)
    • convert a calibration request
    • request a calibration
    • planning request
    • request the dcc(s)

Installation

Download latest standalone jar from http://a75438.berlin.ptb.de/vlagwt/

Start server

java -jar vlagwt-x.y.z-standalone.jar

systemd

cd /path/to/vlagwt
sudo mkdir /usr/local/share/vlagwt
sudo cp vlagwt.jar /usr/local/share/vlagwt
sudo cp vlagwt.service  /etc/systemd/system/
sudo systemctl enable vlagwt.service
sudo systemctl start vlagwt.service
sudo systemctl status vlagwt.service

API

Set:

URL=http://localhost:9099

if the server runs at localhost. For PUT or POST of json data set the content type by:

H="Content-Type: application/json"

available calibration procedures (ToDo)

curl $URL/todo

convert a calibration request

The /convert endpoint returns the planning document generated from the calibration request.

curl -H "$H" -d @resources/calibration-request.json -X POST $URL/convert

request a calibration

Use the json file under resources/calibration-request.json and send the request:

curl -H "$H" -d @resources/calibration-request.json -X POST $URL/request

which leads to the following steps:

• input data (inquiry short inq) checks
• convert inq to a planning document (short pla)
• sends a notification email
• stores the document (pla) in the vl database

If everything goes right the reply is:

{"ok":true,"error":null}

in case of an error:

{"error":"<description of reason for error>", "ok":false}

planning request

The /planning/<RequestId> endpoint returns the planning document belonging to the <RequestId>.

curl $URL/planning/<RequestId>

Example:

curl $URL/planning/34330b0e9f16c21007b37f2d56bf1804

returns

{"_id":"pla-2021-05-29-zenit","_rev":"1-7b647b22286b4de0dafeb36c023094f3","Planning":{"RequestId":"34330b0e9f16c21007b37f2d56bf1804" ...}

curl $URL/planning/foo

returns

{"error":"Not found","ok":false}

request the dcc(s)

curl $URL/dcc/<RequestId>