Skip to content

Changes

Page history
Update tekninendokumentaatio authored by K9412's avatar K9412
Show whitespace changes
Inline Side-by-side
tekninendokumentaatio.md
View page @ 95404e4c
...@@ -161,33 +161,37 @@ Backendissä on 11 eri reittiä. ...@@ -161,33 +161,37 @@ Backendissä on 11 eri reittiä.
] ]
} }
``` ```
**GET /api/reference -- Yksittäisen referenssin haku projectId:n perusteella, tai kaikkien referenssien haku ilman parametrejä** **GET /api/reference**
* Palauttaa yksityiskohtaiset tiedot referenssistä annetun idValuen perusteella olettaen, että käyttäjällä on oikeus nähdä kyseinen referenssi
* Mikäli idValueta ei määritetä, palauttaa yksityiskohtaisen listan kaikista referensseistä, joihin käyttäjällä on oikeus
* UserEmail ja UserPhone viittaavat portfoliomanagerin yhteystietoihin
* Name on asiakkaan nimi, RefName on projektin nimi
* Esimerkkikutsu: * Esimerkkikutsu:
`/api/reference?idValue=Q5` `/api/reference?idValue=Q5`
* Esimerkkivastaus: * Esimerkkivastaus:
```json ```json
[ [
{ {
"Name": "dgfdfg", "Name": "Iso asiakas",
"BusinessId": "3", "BusinessId": "3",
"CustomerEmail": "qergerg", "CustomerEmail": "asiakas@email.fi",
"CustomerPhone": "18797881", "CustomerPhone": "187-97881",
"DepartmentName": "jgdfdu", "DepartmentName": "DevOps",
"UserId": 1, "UserId": 1,
"FirstName": "masa", "FirstName": "Portfoliomanagerin etunimi",
"LastName": "asdasd", "LastName": "Portfoliomanagerin sukunimi",
"UserEmail": "matti@mail.net", "UserEmail": "portman@mail.net",
"UserPhone": "12312313", "UserPhone": "123-12313",
"ProjectId": "5", "ProjectId": "5",
"RefName": "qweqweqwe", "RefName": "Hieno rojekti",
"ProjectManager": "dfgdfg", "ProjectManager": "Esala, Esa",
"StartDate": "2019-10-09T21:00:00.000Z", "StartDate": "2016-10-09T21:00:00.000Z",
"EndDate": "2019-11-10T22:00:00.000Z", "EndDate": "2019-11-10T22:00:00.000Z",
"Htp": "123123123", "Htp": "80",
"Price": "12312312312312321", "Price": "60000",
"Permission": "1", "Permission": "1",
"Description": "dfhghfghfghfg fgh fgh fg hfgh", "Description": "Kuvaus hienosta rojektista",
"Approved": false, "Approved": true,
"Tags": [ "Tags": [
"React", "React",
"Javascript", "Javascript",
...@@ -196,7 +200,8 @@ Backendissä on 11 eri reittiä. ...@@ -196,7 +200,8 @@ Backendissä on 11 eri reittiä.
} }
] ]
``` ```
**POST /api/reference/edit -- Referenssin muokkausreitti** **POST /api/reference/edit**
* Muokkaa projectId:n mukaista referenssiä annetuilla arvoilla, ei ota vastaan tyhjiä kenttiä newTagsia lukuunottamatta
* Esimerkkikutsu: * Esimerkkikutsu:
```json ```json
{ {
...@@ -215,7 +220,8 @@ Backendissä on 11 eri reittiä. ...@@ -215,7 +220,8 @@ Backendissä on 11 eri reittiä.
"selectedTags": ["2","6"] "selectedTags": ["2","6"]
} }
``` ```
**POST /api/reference/approve -- Referenssin hyväksymisreitti** **POST /api/reference/approve**
* Asettaa valitun referenssin approved-tilan arvoksi true, jolloin se näkyy käyttäjille, jotka eivät ole referenssin portfoliomanager
* Esimerkkikutsu: * Esimerkkikutsu:
```json ```json
{ {
...@@ -223,7 +229,8 @@ Backendissä on 11 eri reittiä. ...@@ -223,7 +229,8 @@ Backendissä on 11 eri reittiä.
} }
``` ```
**POST /api/reference/hide -- Referenssin piilotusreitti** **POST /api/reference/hide**
* Asettaa valitun referenssin hidden-tilan arvoksi true, jolloin se ei näy enää käyttäjille
* Esimerkkikutsu: * Esimerkkikutsu:
```json ```json
{ {
...@@ -231,7 +238,8 @@ Backendissä on 11 eri reittiä. ...@@ -231,7 +238,8 @@ Backendissä on 11 eri reittiä.
} }
``` ```
**GET /api/references -- Kaikkien referenssien vähimmäistietojen haku hakutuloslistaan** **GET /api/references**
* Kaikkien referenssien vähimmäistietojen haku hakutuloslistaan
* Esimerkkikutsu: * Esimerkkikutsu:
`/api/references?searchValue=rojekti&idValue&minHtp&maxHtp&startDate&endDate&selectedTags` `/api/references?searchValue=rojekti&idValue&minHtp&maxHtp&startDate&endDate&selectedTags`
searchValue hakee referenssiä projektin nimen mukaan ja idValue projektin id:n mukaan. searchValue hakee referenssiä projektin nimen mukaan ja idValue projektin id:n mukaan.
...@@ -270,7 +278,8 @@ searchValue hakee referenssiä projektin nimen mukaan ja idValue projektin id:n ...@@ -270,7 +278,8 @@ searchValue hakee referenssiä projektin nimen mukaan ja idValue projektin id:n
} }
] ]
``` ```
**GET /api/customer -- Asiakkaiden hakureitti** **GET /api/customer**
* Ei ota vastaan parametreja, palauttaa listan asiakkaista (Customer-taulukko)
* Esimerkkivastaus: * Esimerkkivastaus:
```json ```json
[ [
...@@ -284,7 +293,8 @@ searchValue hakee referenssiä projektin nimen mukaan ja idValue projektin id:n ...@@ -284,7 +293,8 @@ searchValue hakee referenssiä projektin nimen mukaan ja idValue projektin id:n
} }
] ]
``` ```
**GET /api/tag -- Tagien hakureitti** **GET /api/tag**
* Ei ota vastaan parametreja, palauttaa listan tageista (Tag-taulukko)
* Esimerkkivastaus: * Esimerkkivastaus:
```json ```json
[ [
...@@ -298,7 +308,8 @@ searchValue hakee referenssiä projektin nimen mukaan ja idValue projektin id:n ...@@ -298,7 +308,8 @@ searchValue hakee referenssiä projektin nimen mukaan ja idValue projektin id:n
} }
] ]
``` ```
**GET /api/department -- Osastojen hakureitti** **GET /api/department**
* Ei ota vastaan parametreja, palauttaa listan osastoista (Department-taulukko)
* Esimerkkivastaus * Esimerkkivastaus
```json ```json
[ [
...@@ -312,7 +323,8 @@ searchValue hakee referenssiä projektin nimen mukaan ja idValue projektin id:n ...@@ -312,7 +323,8 @@ searchValue hakee referenssiä projektin nimen mukaan ja idValue projektin id:n
} }
] ]
``` ```
**GET /api/portfolio -- Portfoliomanagerien hakureitti** **GET /api/portfolio**
* Ei ota vastaan parametreja, palauttaa listan käyttäjistä (User-taulukko), joita voidaan käyttää portfoliomanagereina
* Esimerkkivastaus * Esimerkkivastaus
```json ```json
[ [
... ...
......