Kalenterirajapinta
Kalenterirajapinnan resurssit
Kalenteri -rajapinnan kautta voidaan lukea, kirjata ja päivittää kalenteritapahtumia. Tämä rajapinta ei vielä tässä vaiheessa tue kontaktin tai asiakkaan liittämistä kalenteritapahtumaan, vaan se tulee toteuttaa erikseen.
Kalenterirajapinnan resurssien osoitteet
Osoite on muotoa:
https://rest.valueframe.com/rest/v2/Calendar
REST-resurssien osoitteet ovat seuraavat:
| REST-resurssi | GET | PUT | POST | DELETE | KUVAUS |
| Calendar | X | X | POST: uuden kalenteritapahtuman lisääminen | ||
| Calendar/ID | X | X |
GET: palauttaa kalenteritapahtuman id=ID PUT: kalenteritapahtuman id=ID tietojen päivitys
|
||
| Calendar/ID | x | DELETE: kalenteritapahtuman id=ID poistaminen |
Calendar-resurssi
| Kentän nimi | Tyyppi | Kuvaus |
| userId * | INTEGER | Käyttäjän ID |
| start * | STRING (ISO8601) | Tapahtuman aloitusajankohta ISO8601-formaatissa |
| end | STRING (ISO8601) | Tapahtuman päättymisajankohta ISO8601-formaatissa |
| duration * | NUMBER | Tapahtuman kesto minuuteissa |
| title * | STRING | Tapahtuman otsikko |
| description | STRING | Kuvaus |
| calendarEventType | INTEGER | Tapahtumalaji |
| createdBy | INTEGER | Lisääjän ID |
| createdAt | STRING (ISO8601) | Lisäysajankohta |
| modifiedBy | INTEGER | Muokkausajankohta |
| modifiedAt | STRING (ISO8601) | Muokkaajan ID |
| state * | INTEGER | Status: 0 = aktiivinen / 2 = poistettu |
| private * | BOOLEAN | 0 = julkinen tapahtuma / 1 = yksityinen tapahtuma |
| location | STRING | Paikka |
* Pakollinen tieto