Add pulsemap doc

2024-09-03 22:13:28 +02:00
parent 7a8d071c7a
commit 4cc0f65a0b
1 changed files with 11 additions and 0 deletions
--- a/apidoc/src/pulsemap.md
+++ b/apidoc/src/pulsemap.md
@@ -0,0 +1,11 @@
+# Map Pulse to Timestamp
+
+For SwissFEL, pulse-ids can be mapped to timestamps:
+
+```bash
+curl "https://data-api.psi.ch/api/4/map/pulse/sf-databuffer/PULSEID"
+```
+
+If the pulse can not be found, it returns http status 204.
+
+If the pulse and the corresponding timestamp was found, it returns the normal status 200.