forked from michelangelomo/Classeviva-Official-Endpoints
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
5b79354
commit d76d25e
Showing
1 changed file
with
11 additions
and
48 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 | ||
| } | ||
| } | ||
| ``` |