Skip to content

Commit

Permalink
Added document read template
Browse files Browse the repository at this point in the history
  • Loading branch information
DevNull-00 authored Apr 16, 2019
1 parent 4c898f6 commit 5b79354
Showing 1 changed file with 67 additions and 0 deletions.
67 changes: 67 additions & 0 deletions Documents/read document.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
# Enter Resource Name

POST **endpoint name**

## Description
Enter description of resource

## Required Header
* Z-Dev-ApiKey
* Z-Auth-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.

## Example
**Request**

https://web.spaggiari.eu/rest/v1/students/{studentId}/noticeboard

**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
},
]
}
```

0 comments on commit 5b79354

Please sign in to comment.