Käyttäjärajapinta
Käyttäjä-rajapinnan resurssit
Käyttäjä-rajapinnan kautta voidaan lukea kaikki tai yksittäinen käyttäjä sekä lisätä uusia käyttäjiä ja päivittää olemassa olevien käyttäjien tietoja.
Käyttäjä-rajapinnan resurssien osoitteet
Osoite on muotoa:
https://rest.valueframe.com/rest/v2/{REST_resurssi}/
REST-resurssien osoitteet ovat seuraavat:
| REST-resurssi | GET | PUT | POST | DELETE | KUVAUS |
| Employee | x | x |
GET: palauttaa kaikki käyttäjät |
||
| POST: lisää uuden käyttäjän | |||||
| Employee/ID | x | x |
GET: palauttaa käyttäjän id=ID
|
||
| PUT: käyttäjän id=ID tietojen päivitys |
Employee-resurssi
Käyttäjiin liittyvät tiedot:
| Kentän nimi | Tyyppi | Kuvaus |
| id | INTEGER | Käyttäjän uniikki id |
| firstName | STRING | Käyttäjän etunimi |
| surName | STRING | Käyttäjän sukunimi |
| companyId | INTEGER | Käyttäjän yhtiön ID |
| emailAddress1 | Käyttäjän 1 sähköpostiosoite | |
| emailAddress2 | Käyttäjän 2 sähköpostiosoite | |
| streetAddress | STRING | Käyttäjän osoite, katu |
| streetPostalCode | STRING | Käyttäjän osoite, postinumero |
| streetCity | STRING | Käyttäjän osoite, kaupunki |
| streetCountry | STRING | Käyttäjän osoite, maa |
| phoneCountryCode | COUNTRY_CODE | Käyttäjän lankanumero, maakoodi |
| phoneAreaCode | STRING | Käyttäjän lankanumero, suuntanumero |
| phoneNumber | STRING | Käyttäjän lankanumero, numero |
| mobileCountryCode | COUNTRY_CODE | Käyttäjän kännykkänumero, maakoodi |
| mobileAreaCode | STRING | Käyttäjän kännykkänumero, suuntanumero |
| mobileNumber | STRING | Käyttäjän kännykkänumero, numero |
| faxCountryCode | COUNTRY_CODE | Käyttäjän faksinumero, maakoodi |
| faxAreaCode | STRING | Käyttäjän faksinumero, suuntanumero |
| faxNumber | STRING | Käyttäjän faksinumero, numero |
| addedDateTime | STRING (ISO8601) | Päivämäärä kun käyttäjä on lisätty järjestelmään |
| addedById | INTEGER | Käyttäjän järjestelmään lisänneen henkilön ID |
| modifiedDateTime | STRING (ISO8601) | Päivämäärä kun käyttäjän tietoja on viimeksi muokattu |
| modifiedById | INTEGER | Käyttäjän tietoja päivittäneen henkilön ID |
| isPassive | BOOLEAN | Onko käyttäjä aktiivinen vai passiivinen |