From d76d25ef450363d415f8f55468bbc69f3524ed46 Mon Sep 17 00:00:00 2001 From: ItzLuk3 <43378701+ItzLuk3@users.noreply.github.com> Date: Tue, 16 Apr 2019 17:42:16 +0200 Subject: [PATCH] Changed from template to final --- Documents/check document.md | 59 +++++++------------------------------ 1 file changed, 11 insertions(+), 48 deletions(-) diff --git a/Documents/check document.md b/Documents/check document.md index 56fba6a..9210b72 100644 --- a/Documents/check document.md +++ b/Documents/check document.md @@ -1,67 +1,30 @@ -# Enter Resource Name +# Document check - POST **endpoint name** + POST **rest/v1/students/{studentId}/documents/check/{hash}** ## Description -Enter description of resource +This endpoint checks the status of a certain documet ## Required Header * Z-Dev-ApiKey * Z-Auth-Token -* ... +* User-Agent: zorro/1.0 +* Z-Auth-Token: token ## Parameters -- **type** _(required)_ — *type* is an example parameter which is required: -- **active** _(required)_ — *active* is an example parameter which is *default:false*: - -## Response -- **success** — Boolean value. +- **studentId** _(required)_ — your student id obtained with the login +- **hash** _(required)_ — the hash code of the document ## Example **Request** - https://web.spaggiari.eu/rest/v1/students/{studentId}/noticeboard + https://web.spaggiari.eu/rest/v1/students/{studentId}/documents/check/{hash} **Return** __shortened response__ ``` json { - "items": [ - { - "pubId": 799423, - "pubDT": "2017-09-24T17:09:45+02:00", - "readStatus": false, - "evtCode": "CF", - "cntId": 351708, - "cntValidFrom": "2017-09-24", - "cntValidTo": "2017-10-31", - "cntValidInRange": true, - "cntStatus": "active", - "cntTitle": "VACCINI E SCUOLA: COSA FARE ", - "cntCategory": "Scuola\/famiglia", - "cntHasChanged": false, - "cntHasAttach": true, - "needJoin": false, - "needReply": false, - "needFile": false - }, - { - "pubId": 796212, - "pubDT": "2017-09-24T15:49:59+02:00", - "readStatus": false, - "evtCode": "CF", - "cntId": 351672, - "cntValidFrom": "2017-09-24", - "cntValidTo": "2017-09-30", - "cntValidInRange": true, - "cntStatus": "active", - "cntTitle": "VARIAZIONE ORARIO PROVVISORIO - LIEVI MODIFICHE", - "cntCategory": "Scuola\/famiglia", - "cntHasChanged": false, - "cntHasAttach": true, - "needJoin": false, - "needReply": false, - "needFile": false - }, - ] + "document":{ + "available":true + } } ```