From e77a8b5c5eae76a5a4882b64cf4447e80f83d64e Mon Sep 17 00:00:00 2001
From: trinitas <gydani2@gmail.com>
Date: Sun, 11 Oct 2020 17:07:38 +0000
Subject: [PATCH] Add 'API.md'

First few elements of API contract
---
 API.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 49 insertions(+)
 create mode 100644 API.md

diff --git a/API.md b/API.md
new file mode 100644
index 0000000..900aecc
--- /dev/null
+++ b/API.md
@@ -0,0 +1,49 @@
+# API
+
+CoviDok API accepts and sends JSON objects. The basic response structure is composed of three fields, as seen below;
+
+{
+  "version" : "1"
+  "status": "OK/ERR"
+  "response" : "Description/data"
+}
+
+The "response" field contains the actual content of the answer, while "status" indicates if the request was successful (value is either ERR or OK).
+
+# Accepted calls
+
+## Auth
+
+### GET /api/Auth
+Login authentication. Requires account login info, returns a session ID and the ientity of the logged in entity.
+|Request|{<br>  "email" : string,<br>  "password": string<br>}|
+|Response|{<br>  "id" : SessionID,<br>  "firstName": x.Firstname,<br>  "lastName": x.Lastname,<br>  "role": "Doc|Ast|Par"<br>}|
+
+### POST /api/Auth
+Registration call.
+|Request|{<br>  "firstName": string,<br>  "lastName": string,<br>  "email": string,<br>  "password": string,<br>  "role": "Doc|Ast|Par"<br>}|
+|Response|None|
+
+## Doc
+
+### GET /api/Doc
+Lists all registered doctors in the system. Might be filterable in the future.
+|Request|{<br>  "id": sessionID<br>}|
+|Response|{[[doc.Firstname, doc.Lastname, doc.Id], ...]}
+
+### GET /api/Doc/{id}/assistants
+Lists assistants for a specific doctor.
+|Request|{<br> "id": sessionID<br>}|
+|Response|{[<br>  "firstName": Assistant.Firstname,<br>  "lastName" : Assistant.Lastname,<br>  "id" : Assistant.Id], ...<br>}|
+
+### GET /api/Doc/{id}/children
+Lists childern with onging or finished cases assigned to a doctor.
+|Request|{<br> "id": sessionID<br>}|
+|Response|{[<br>  "firstName": Child.Firstname,<br>  "lastName" : Child.Lastname,<br>  "id" : Child.Id], ...<br>}|
+
+## Parent
+
+### POST /api/Parent/child
+Adds a child to a parent. A parent can only add children to its own account (Enforced on server side).
+|Request|{<br> "id": sessionID,<br> "firstName": string,<br> "lastName": string<br>}|
+|Response|{<br> "ChildID": Child.Id<br>}|
\ No newline at end of file