Rest API

Beschreibung der Rest-API f�r:

Angebot
Artikel und Artikel-Kategorie
Bedarf
Institution
Person

Angebot

�bersicht

Alle aktuelle Angebote laden

GET /angebot/suche
Alle Angebote meiner Institution laden

GET /angebot
Neues Angebot einstellen

POST /angebot
Angebot l�schen

DELETE /angebot/{angebotId}
Angebot anfragen

POST /angebot/{angebotId}/anfrage
Angebot-Anfrage l�schen

DELETE /angebot/{angebotId}/anfrage/{anfrageId}

Alle aktuelle Angebote laden

Liefert alle aktuelle (nicht bediente) Angebote.

Request:

GET /angebot/suche
URL Params

None
Data Params

None

Success Response:

Code: 200
Content:

[
  {
    "id": "5bc4f514-c591-470e-a056-933f3ea00421",
    "artikelVarianteId": "bbeac45e-e296-4fad-878d-7e9b6e85a3d8",
    "anzahl": 10000,
    "rest": 2000,
    "institutionId": "43d30ef8-852b-41ae-9e5d-8f6b35d7b5b2",
    "standort": { "..." },
    "haltbarkeit": "2022-01-25T21:34:55",
    "steril": false,
    "originalverpackt": true,
    "medizinisch": false,
    "kommentar": "Wir haben 10000 Masken �brig",
    "entfernung": 25014
  },
  ...
]

Error Response:
- Code: 401 UNAUTHORIZED
  Content: { error : "You are unauthorized to make this request." }

Sample Call:

 curl -i -H 'Accept: application/json' http://localhost:7000/angebot/suche

Alle Angebote meiner Institution laden

Liefert alle aktuelle (nicht bediente) Angebote, die Personen aus meiner Institution gemeldet haben.

Request:

GET /angebot
URL Params

None
Data Params

None

Success Response:

Code: 200
Content:

[
  {
    "id": "5bc4f514-c591-470e-a056-933f3ea00421",
    "artikelVarianteId": "bbeac45e-e296-4fad-878d-7e9b6e85a3d8",
    "anzahl": 10000,
    "rest": 2000,
    "institutionId": "43d30ef8-852b-41ae-9e5d-8f6b35d7b5b2",
    "standort": { "..." },
    "haltbarkeit": "2022-01-25T21:34:55",
    "steril": false,
    "originalverpackt": true,
    "medizinisch": false,
    "kommentar": "Wir haben 10000 Masken �brig",
    "entfernung": 25014
  },
  ...
]

Error Response:
- Code: 401 UNAUTHORIZED
  Content: { error : "You are unauthorized to make this request." }

Sample Call:

 curl -i -H 'Accept: application/json' http://localhost:7000/angebot

Neues Angebot einstellen

Neues Angebot melden.

Request:

POST /angebot
URL Params

None

Data Params

{
  "artikelVarianteId": "bbeac45e-e296-4fad-878d-7e9b6e85a3d8",
  "anzahl": 10000,
  "standortId": "6b0cd44b-5dfc-4475-8b48-491688bc0a34",
  "kommentar": "Wir haben 10000 Masken �brig",
  "haltbarkeit": "2022-01-25T21:34:55",
  "steril": false,
  "originalverpackt": true,
  "medizinisch": false
}

Success Response:

Code: 200
Content:

{
  "id": "5bc4f514-c591-470e-a056-933f3ea00421",
  "artikelVarianteId": "bbeac45e-e296-4fad-878d-7e9b6e85a3d8",
  "anzahl": 10000,
  "rest": 2000,
  "institutionId": "43d30ef8-852b-41ae-9e5d-8f6b35d7b5b2",
  "standort": { "..." },
  "haltbarkeit": "2022-01-25T21:34:55",
  "steril": false,
  "originalverpackt": true,
  "medizinisch": false,
  "kommentar": "Wir haben 10000 Masken �brig",
  "entfernung": 25014
}

Error Response:
- Code: 400 BAD REQUEST
  Content: { error : "..." }
OR
- Code: 401 UNAUTHORIZED
  Content: { error : "You are unauthorized to make this request." }
Sample Call:

Angebot l�schen

Angebot l�schen.

Request:

DELETE /angebot/{angebotId}
URL Params

Required:

angebotId=[UUID]
Data Params

None
Success Response:
- Code: 200
Error Response:
- Code: 400 BAD REQUEST
  Content: { error : "..." }
OR
- Code: 401 UNAUTHORIZED
  Content: { error : "You are unauthorized to make this request." }
OR
- Code: 404 NOT FOUND
  Content: { error : "Angebot nicht gefunden." }

Sample Call:

 curl -X DELETE http://localhost:7000/angebot/5bc4f514-c591-470e-a056-933f3ea00421

Angebot anfragen

Angebot anfragen.

Request:

POST /angebot/{angebotId}/anfrage
URL Params

Required:

angebotId=[UUID]

Data Params

{
  "standortId": "6b0cd44b-5dfc-4475-8b48-491688bc0a34",
  "anzahl": 3000,
  "kommentar": "Wir brauchen 3000 Masken"
}

Success Response:

Code: 200
Content:

{
  "id": "5bc4f514-c591-470e-a056-933f3ea00421",
  "angebot": { "..." },
  "institution": { "..." },
  "standort": { "..." },
  "anzahl": 3000,
  "kommentar": "Wir brauchen 3000 Masken"
  "prozessInstanzId": "...",
  "status": "Offen"
}

Error Response:
- Code: 400 BAD REQUEST
  Content: { error : "..." }
OR
- Code: 401 UNAUTHORIZED
  Content: { error : "You are unauthorized to make this request." }
OR
- Code: 404 NOT FOUND
  Content: { error : "Angebot nicht gefunden." }
Sample Call:

Angebot-Anfrage l�schen

Angebot-Anfrage l�schen.

Request:

DELETE /angebot/{angebotId}/anfrage/{anfrageId}
URL Params

Required:

angebotId=[UUID] anfrageId=[UUID]
Data Params

None
Success Response:
- Code: 200
Error Response:
- Code: 400 BAD REQUEST
  Content: { error : "..." }
OR
- Code: 401 UNAUTHORIZED
  Content: { error : "You are unauthorized to make this request." }
OR
- Code: 404 NOT FOUND
  Content: { error : "Angebot nicht gefunden." }

Sample Call:

 curl -X DELETE http://localhost:7000/angebot/5bc4f514-c591-470e-a056-933f3ea00421/anfrage/5bc4f514-c591-470e-a056-933f3ea00421

Artikel

�bersicht

Alle Artikel-Kategorien laden

GET /artikel/kategorie
Suche nach Artikeln

GET /artikel/suche
Alle Artikel laden

GET /artikel
Artikel laden

GET /artikel/{artikelId}

Alle Artikel-Kategorien laden

Alle Artikel-Kategorien laden.

Request:

GET /artikel/kategorie
URL Params

None
Data Params

None

Success Response:

Code: 200
Content:

[
  {
    "id": "77977887-78e8-4ee3-8a34-ec37fcfc5f8b",
    "name": "Atemschutzmasken",
    "icon": "maske.png"
  },
  {
    "id": "cd5c00ec-c328-4c8b-8278-098b4b5ea0dc",
    "name": "Overalls",
    "icon": "body.png"
  },
  
  ...
]

Error Response:
- Code: 401 UNAUTHORIZED
  Content: { error : "You are unauthorized to make this request." }

Sample Call:

 curl -i -H 'Accept: application/json' http://localhost:7000/artikel/kategorie

Alle Artikel laden

Alle Artikel laden.

Request:

GET /artikel
URL Params

None

Data Params

None

Success Response:

Code: 200
Content:

[
  {
    "id": "bbeac45e-e296-4fad-878d-7e9b6e85a3d8",
    "artikelKategorieId": "77977887-78e8-4ee3-8a34-ec37fcfc5f8b",
    "name": "Atemschutzmaske \"8812\" FFP1 NR D vorgeformte Partikelmaske mit Ausatemventil - 3M�",
    "beschreibung": "Atemschutzmaske \"8812\" FFP1 NR D vorgeformte Partikelmaske mit Ausatemventil - 3M� ..."
    "varianten": 
    [
      {
        "id": "bbeac45e-e296-4fad-878d-7e9b6e85a3d8",
        "artikelId": "77977887-78e8-4ee3-8a34-ec37fcfc5f8b",
        "variante": "Variante ",
        "norm": "Norm"
        "beschreibung": "Beschreibunf der Variante"
        "medizinischAuswaehlbar": true
      }
      ...
    ]
  },
  {
    "id": "atemschutzmaske_FFP2_M3",
    "artikelKategorieId": "77977887-78e8-4ee3-8a34-ec37fcfc5f8b",
    "name":	"Spezialmaske \"9926\" FFP2 NR D vorgeformte Partikelmaske mit Ausatemventil - 3M�",
    "beschreibung": "Spezialmaske \"9926\" FFP2 NR D vorgeformte Partikelmaske mit Ausatemventil - 3M� ..."
    "varianten": [ ... ]
  },
   
  ...
]

Error Response:
- Code: 401 UNAUTHORIZED
  Content: { error : "You are unauthorized to make this request." }

Sample Call:

 curl -i -H 'Accept: application/json' http://localhost:7000/artikel"

Artikel Suche

Suche nach Artikeln.

Request:

GET /artikel/suche
URL Params

Optional:

nameLike=[string]
Data Params

None

Success Response:

Code: 200
Content:

[
  {
    "id": "bbeac45e-e296-4fad-878d-7e9b6e85a3d8",
    "artikelKategorieId": "77977887-78e8-4ee3-8a34-ec37fcfc5f8b",
    "name": "Atemschutzmaske \"8812\" FFP1 NR D vorgeformte Partikelmaske mit Ausatemventil - 3M�",
    "beschreibung": "Atemschutzmaske \"8812\" FFP1 NR D vorgeformte Partikelmaske mit Ausatemventil - 3M� ..."
    "varianten": 
    [
      {
        "id": "bbeac45e-e296-4fad-878d-7e9b6e85a3d8",
        "artikelId": "77977887-78e8-4ee3-8a34-ec37fcfc5f8b",
        "variante": "Variante ",
        "norm": "Norm"
        "beschreibung": "Beschreibunf der Variante"
        "medizinischAuswaehlbar": true
      }
      ...
    ]
  },
  {
    "id": "atemschutzmaske_FFP2_M3",
    "artikelKategorieId": "77977887-78e8-4ee3-8a34-ec37fcfc5f8b",
    "name":	"Spezialmaske \"9926\" FFP2 NR D vorgeformte Partikelmaske mit Ausatemventil - 3M�",
    "beschreibung": "Spezialmaske \"9926\" FFP2 NR D vorgeformte Partikelmaske mit Ausatemventil - 3M� ..."
    "varianten": [ ... ]
  },
   
  ...
]

Error Response:
- Code: 401 UNAUTHORIZED
  Content: { error : "You are unauthorized to make this request." }

Sample Call:

 curl -i -H 'Accept: application/json' http://localhost:7000/artikel/suche?nameLike="maske"

Artikel lesen

Ein Artikel lesen.

Request:

GET /artikel/{artikelId}
Path Params

Required:

artikelId=[UUID]
Data Params

None

Success Response:

Code: 200
Content:

{
  "id": "bbeac45e-e296-4fad-878d-7e9b6e85a3d8",
  "artikelKategorieId": "77977887-78e8-4ee3-8a34-ec37fcfc5f8b",
  "name": "Atemschutzmaske \"8812\" FFP1 NR D vorgeformte Partikelmaske mit Ausatemventil - 3M�",
  "beschreibung": "Atemschutzmaske \"8812\" FFP1 NR D vorgeformte Partikelmaske mit Ausatemventil - 3M� ..."
  "varianten": 
  [
    {
      "id": "bbeac45e-e296-4fad-878d-7e9b6e85a3d8",
      "artikelId": "77977887-78e8-4ee3-8a34-ec37fcfc5f8b",
      "variante": "Variante ",
      "norm": "Norm"
      "beschreibung": "Beschreibunf der Variante"
      "medizinischAuswaehlbar": true
    }
    ...
  ]
}

Error Response:
- Code: 404 NOT FOUND
  Content: { error : "Artikel nicht gefunden." }
OR
- Code: 401 UNAUTHORIZED
  Content: { error : "You are unauthorized to make this request." }

Sample Call:

 curl -i -H 'Accept: application/json' http://localhost:7000/artikel/bbeac45e-e296-4fad-878d-7e9b6e85a3d8

Bedarf

�bersicht

Alle aktuelle Bedarfe laden

GET /bedarf/suche
Alle Bedarfe meiner Institution laden

GET /bedarf
Neues Bedarf melden

POST /bedarf
Bedarf l�schen

DELETE /bedarf/{bedarfId}
Bedarf bedienen

POST /bedarf/{bedarfId}/anfrage
Bedarf-Anfrage l�schen

DELETE /bedarf/{bedarfId}/anfrage/{anfrageId}

Alle aktuelle Bedarfe laden

Liefert alle aktuelle (nicht bediente) Bedarfe.

Request:

GET /bedarf/suche
URL Params

None
Data Params

None

Success Response:

Code: 200
Content:

[
  {
    "id": "5bc4f514-c591-470e-a056-933f3ea00421",
    "artikelId": "12e79aaf-1edc-41b3-a83d-6b4f871dd5e3",
    "artikelVarianteId": "bbeac45e-e296-4fad-878d-7e9b6e85a3d8",
    "anzahl": 10000,
    "rest": 2000,
    "institutionId": "43d30ef8-852b-41ae-9e5d-8f6b35d7b5b2",
    "standort": { "..." },
    "steril": false,
    "medizinisch": false,
    "kommentar": "Wir brauchen 5000 Masken",
    "entfernung": 25014
  },
  ...
]

Error Response:
- Code: 401 UNAUTHORIZED
  Content: { error : "You are unauthorized to make this request." }

Sample Call:

 curl -i -H 'Accept: application/json' http://localhost:7000/bedarf/suche

Alle Bedarfe meiner Institution laden

Liefert alle aktuelle (nicht bediente) Bedarfe, die Personen aus meiner Institution gemeldet haben.

Request:

GET /bedarf
URL Params

None
Data Params

None

Success Response:

Code: 200
Content:

[
  {
    "id": "5bc4f514-c591-470e-a056-933f3ea00421",
    "artikelId": "12e79aaf-1edc-41b3-a83d-6b4f871dd5e3",
    "artikelVarianteId": "bbeac45e-e296-4fad-878d-7e9b6e85a3d8",
    "anzahl": 10000,
    "rest": 2000,
    "institutionId": "43d30ef8-852b-41ae-9e5d-8f6b35d7b5b2",
    "standort": { "..." },
    "steril": false,
    "medizinisch": false,
    "kommentar": "Wir brauchen 5000 Masken",
    "entfernung": 25014
  },
  ...
]

Error Response:
- Code: 401 UNAUTHORIZED
  Content: { error : "You are unauthorized to make this request." }

Sample Call:

 curl -i -H 'Accept: application/json' http://localhost:7000/bedarf

Neues Bedarf einstellen

Neues Bedarf melden.

Request:

POST /bedarf
URL Params

None

Data Params

{
  "artikelId": "12e79aaf-1edc-41b3-a83d-6b4f871dd5e3",
  "artikelVarianteId": "bbeac45e-e296-4fad-878d-7e9b6e85a3d8",
  "anzahl": 10000,
  "standortId": "6b0cd44b-5dfc-4475-8b48-491688bc0a34",
  "kommentar": "Wir haben 10000 Masken �brig",
  "steril": false,
  "medizinisch": false
}

Success Response:

Code: 200
Content:

{
  "id": "5bc4f514-c591-470e-a056-933f3ea00421",
  "artikelId": "12e79aaf-1edc-41b3-a83d-6b4f871dd5e3",
  "artikelVarianteId": "bbeac45e-e296-4fad-878d-7e9b6e85a3d8",
  "anzahl": 10000,
  "rest": 2000,
  "institutionId": "43d30ef8-852b-41ae-9e5d-8f6b35d7b5b2",
  "standort": { "..." },
  "steril": false,
  "medizinisch": false,
  "kommentar": "Wir brauchen 5000 Masken",
  "entfernung": 25014
}

Error Response:
- Code: 400 BAD REQUEST
  Content: { error : "..." }
OR
- Code: 401 UNAUTHORIZED
  Content: { error : "You are unauthorized to make this request." }
Sample Call:

Bedarf l�schen

Bedarf l�schen.

Request:

DELETE /bedarf/{bedarfId}
URL Params

Required:

bedarfId=[UUID]
Data Params

None
Success Response:
- Code: 200
Error Response:
- Code: 400 BAD REQUEST
  Content: { error : "..." }
OR
- Code: 401 UNAUTHORIZED
  Content: { error : "You are unauthorized to make this request." }
OR
- Code: 404 NOT FOUND
  Content: { error : "Bedarf nicht gefunden." }

Sample Call:

 curl -X DELETE http://localhost:7000/bedarf/5bc4f514-c591-470e-a056-933f3ea00421

Bedarf bedienen

Bedarf bedienen.

Request:

POST /bedarf/{bedarfId}/anfrage
URL Params

Required:

bedarfId=[UUID]

Data Params

{
  "standortId": "6b0cd44b-5dfc-4475-8b48-491688bc0a34",
  "anzahl": 3000,
  "kommentar": "Wir haben 3000 Masken"
}

Success Response:

Code: 200
Content:

{
  "id": "5bc4f514-c591-470e-a056-933f3ea00421",
  "bedarf": { "..." },
  "institutionVon": { "..." },
  "standortVon": { "..." },
  "anzahl": 3000,
  "kommentar": "Wir brauchen 3000 Masken"
  "prozessInstanzId": "...",
  "status": "Offen"
}

Error Response:
- Code: 400 BAD REQUEST
  Content: { error : "..." }
OR
- Code: 401 UNAUTHORIZED
  Content: { error : "You are unauthorized to make this request." }
OR
- Code: 404 NOT FOUND
  Content: { error : "Bedarf nicht gefunden." }
Sample Call:

Bedarf-Anfrage l�schen

Bedarf-Anfrage l�schen.

Request:

DELETE /bedarf/{bedarfId}/anfrage/{anfrageId}
URL Params

Required:

bedarfId=[UUID] anfrageId=[UUID]
Data Params

None
Success Response:
- Code: 200
Error Response:
- Code: 400 BAD REQUEST
  Content: { error : "..." }
OR
- Code: 401 UNAUTHORIZED
  Content: { error : "You are unauthorized to make this request." }
OR
- Code: 404 NOT FOUND
  Content: { error : "Bedarf nicht gefunden." }

Sample Call:

 curl -X DELETE http://localhost:7000/bedarf/5bc4f514-c591-470e-a056-933f3ea00421/anfrage/5bc4f514-c591-470e-a056-933f3ea00421

Institution

Alle Institutionen laden

Liefert alle aktuelle Institutionen.

Request:

GET /institution
URL Params

None

Data Params

None

Success Response:

Code: 200
Content:

[
  {
    "id": "b8de7af3-05a2-4fe4-8b07-f74071eb71f1",
    "key": "isar_klinikum",
    "name":	"ISAR Klinikum�",
    "typ": "krankenhaus"
  },
  {
    "id": "b8de7af3-05a2-4fe4-8b07-f74071eb71f1",
    "key": "arzt_praxis_xyz",
    "name":	"Arzt Praxis XYZ�",
    "typ": "doktor"
  },
   
  ...
]

Error Response:
- Code: 401 UNAUTHORIZED
  Content: { error : "You are unauthorized to make this request." }

Sample Call:

 curl -i -H 'Accept: application/json' http://localhost:7000/institution

Institutionen Suche (noch nicht umgesetzt)

Suche nach Institutionen.

Request:

GET /institution/suche
URL Params

Optional:

nameLike=[string]
Data Params

None

Success Response:

Code: 200
Content:

[
  {
    "id": "b8de7af3-05a2-4fe4-8b07-f74071eb71f1",
    "key": "isar_klinikum",
    "name":	"ISAR Klinikum�",
    "typ": "krankenhaus"
  },
  {
    "id": "b8de7af3-05a2-4fe4-8b07-f74071eb71f1",
    "key": "arzt_praxis_xyz",
    "name":	"Arzt Praxis XYZ�",
    "typ": "doktor"
  },
   
  ...
]

Error Response:
- Code: 401 UNAUTHORIZED
  Content: { error : "You are unauthorized to make this request." }

Sample Call:

 curl -i -H 'Accept: application/json' http://localhost:7000/institution/suche?nameLike="xyz"

Institution lesen (noch nicht umgesetzt)

Eine Institution lesen.

Request:

GET /institution/{institutionKey}
Path Params

Required:

institutionKey=[string]
Data Params

None

Success Response:

Code: 200
Content:

{
  "id": "b8de7af3-05a2-4fe4-8b07-f74071eb71f1",
  "key": "isar_klinikum",
  "name":	"ISAR Klinikum�",
  "typ": "krankenhaus"
 }

Error Response:
- Code: 404 NOT FOUND
  Content: { error : "Institution nicht gefunden." }
OR
- Code: 401 UNAUTHORIZED
  Content: { error : "You are unauthorized to make this request." }

Sample Call:

 curl -i -H 'Accept: application/json' http://localhost:7000/institution/krankenhaus_xy

Institution hinzufugen (noch nicht umgesetzt)

Eine Institution hinzuf�gen.

Request:

POST /institution/
Path Params

Data Params

{
  "key": "isar_klinikum",
  "name":	"ISAR Klinikum�",
  "typ": "krankenhaus"
 }

** ** Typ ** krankenhaus / doktor

Success Response:

Code: 200
Content:

{
  "id": "b8de7af3-05a2-4fe4-8b07-f74071eb71f1",
  "key": "isar_klinikum",
  "name":	"ISAR Klinikum�",
  "typ": "krankenhaus"
 }

Error Response:
- Code: 400 BAD REQUEST
  Content: { error : "..." }
OR
- Code: 401 UNAUTHORIZED
  Content: { error : "You are unauthorized to make this request." }
Sample Call:

Institution aktualisieren (noch nicht umgesetzt)

Eine Institution aktualisieren.

Request:

POST /institution/{institutionKey}
Path Params

Required:

institutionKey=[string]

Data Params

{
  "id": "b8de7af3-05a2-4fe4-8b07-f74071eb71f1",
  "key": "isar_klinikum",
  "name":	"ISAR Klinikum�",
  "typ": "krankenhaus"
}

** ** Typ ** krankenhaus / doktor

Success Response:

Code: 200
Content:

{
  "id": "b8de7af3-05a2-4fe4-8b07-f74071eb71f1",
  "key": "isar_klinikum",
  "name":	"ISAR Klinikum�",
  "typ": "krankenhaus"
}

Error Response:
- Code: 400 BAD REQUEST
  Content: { error : "..." }
OR
- Code: 404 NOT FOUND
  Content: { error : "Institution nicht gefunden." }
OR
- Code: 401 UNAUTHORIZED
  Content: { error : "You are unauthorized to make this request." }
Sample Call:

Meine Institution lesen

Institution des angemeldetes Benutzer lesen.

Request:

GET /institution/assigned
Path Params

None

Data Params

None

Success Response:

Code: 200
Content:

{
  "id": "b8de7af3-05a2-4fe4-8b07-f74071eb71f1",
  "key": "isar_klinikum",
  "name":	"ISAR Klinikum�",
  "typ": "krankenhaus"
 }

Error Response:
- Code: 401 UNAUTHORIZED
  Content: { error : "You are unauthorized to make this request." }

Sample Call:

 curl -i -H 'Accept: application/json' http://localhost:7000/institution/assigned

Meine Institution aktualisieren

Institution des angemeldetes Benutzer aktualisieren.

Request:

PUT /institution/
Path Params

Required:

institutionKey=[string]

Data Params

{
  "key": "isar_klinikum",
  "name":	"ISAR Klinikum�",
  "typ": "krankenhaus"
}

** ** Typ ** krankenhaus / doktor

Success Response:

Code: 200
Content:

{
  "id": "b8de7af3-05a2-4fe4-8b07-f74071eb71f1",
  "key": "isar_klinikum",
  "name":	"ISAR Klinikum�",
  "typ": "krankenhaus"
}

Error Response:
- Code: 400 BAD REQUEST
  Content: { error : "..." }
OR
- Code: 401 UNAUTHORIZED
  Content: { error : "You are unauthorized to make this request." }
Sample Call:

Alle Angebote einer Institution laden

Liefert alle Angebote der Institution von angemeldeten User.

Request:

GET /institution/angebot
URL Params

None
Data Params

None

Success Response:

Code: 200
Content:

[
  {
    "id": "5bc4f514-c591-470e-a056-933f3ea00421",
    "artikel": {
      "id": "bbeac45e-e296-4fad-878d-7e9b6e85a3d8"
    },
    "anzahl": 10000,
    "kommentar": "Wir haben 10000 Masken �brig",
    "standort": "...",
    "haltbarkeit": "2022-01-25T21:34:55",
    "steril": false,
    "originalverpackt": true,
    "medizinisch": false
  },
  ...
]

Error Response:
- Code: 401 UNAUTHORIZED
  Content: { error : "You are unauthorized to make this request." }

Sample Call:

 curl -i -H 'Accept: application/json' http://localhost:7000/institution/angebot

Alle Bedarfe einer Institution laden

Liefert alle Bedarfe der Institution von angemeldeten User.

Request:

GET /institution/bedarf
URL Params

None
Data Params

None

Success Response:

Code: 200
Content:

[
  {
    "id": "b872561f-dab9-43c2-bec9-d4e3694a7ea1",
    "artikel": {
      "id": "bbeac45e-e296-4fad-878d-7e9b6e85a3d8"
    },
    "anzahl": 10000
  },
  ...
]

Error Response:
- Code: 401 UNAUTHORIZED
  Content: { error : "You are unauthorized to make this request." }

Sample Call:

 curl -i -H 'Accept: application/json' http://localhost:7000/institution/bedarf

Person

Alle Personen laden

Liefert alle Personen.

Request:

GET /person
URL Params

None

Data Params

None

Success Response:

Code: 200
Content:

[
  {
    "id": "b4e17bb0-8558-44b1-ad2a-ec97bb012d45",
    "username": "peterarzt",
    "vorname": "Peter",
    "nachname": "Arzt",
    "telefon": "049..."
  },
  {
    "id": "9c20eeb1-1c9f-433c-8a20-4a01eca30770",
    "username": "juliahatetwas",
    "vorname": "Julia",
    "nachname": "Hat-Etwas",
    "telefon": "049..."
  },
   
  ...
]

Error Response:
- Code: 401 UNAUTHORIZED
  Content: { error : "You are unauthorized to make this request." }

Sample Call:

 curl -i -H 'Accept: application/json' http://localhost:7000/person

Person hinzuf�gen

Person erstellen.

Request:

POST /person
URL Params

None

Data Params

{
  "username": "peterarzt",
  "vorname": "Peter",
  "nachname": "Arzt",
  "telefon": "049..."
}

Success Response:

Code: 200
Content:

{
  "id": "b4e17bb0-8558-44b1-ad2a-ec97bb012d45",
  "username": "peterarzt",
  "vorname": "Peter",
  "nachname": "Arzt",
  "telefon": "049..."
}

Error Response:
- Code: 400 BAD REQUEST
  Content: { error : "..." }
OR
- Code: 401 UNAUTHORIZED
  Content: { error : "You are unauthorized to make this request." }
Sample Call:

Person lesen (noch nicht umgesetzt)

Person lesen.

Request:

GET /person/{personId}
URL Params

Required:

personId=[UUID]
Data Params

None

Success Response:

Code: 200
Content:

{
  "id": "b4e17bb0-8558-44b1-ad2a-ec97bb012d45",
  "username": "peterarzt",
  "vorname": "Peter",
  "nachname": "Arzt",
  "telefon": "049..."
}

Error Response:
- Code: 401 UNAUTHORIZED
  Content: { error : "You are unauthorized to make this request." }
OR
- Code: 404 NOT FOUND
  Content: { error : "Person nicht gefunden." }

Sample Call:

 curl -i -H 'Accept: application/json' http://localhost:7000/person/b4e17bb0-8558-44b1-ad2a-ec97bb012d45

Meine Person lesen

Daten der angemeldeter Person lesen.

Request:

GET /person/userInfo
URL Params

None
Data Params

None

Success Response:

Code: 200
Content:

{
  "id": "b4e17bb0-8558-44b1-ad2a-ec97bb012d45",
  "username": "peterarzt",
  "vorname": "Peter",
  "nachname": "Arzt",
  "telefon": "049..."
}

Error Response:
- Code: 401 UNAUTHORIZED
  Content: { error : "You are unauthorized to make this request." }

Sample Call:

 curl -i -H 'Accept: application/json' http://localhost:7000/person/userInfo

FilesExpand file tree

API.md

Latest commit

History

API.md

File metadata and controls

Rest API

Angebot

�bersicht

Alle aktuelle Angebote laden

Alle Angebote meiner Institution laden

Neues Angebot einstellen

Angebot l�schen

Angebot anfragen

Angebot-Anfrage l�schen

Artikel

�bersicht

Alle Artikel-Kategorien laden

Alle Artikel laden

Artikel Suche

Artikel lesen

Bedarf

�bersicht

Alle aktuelle Bedarfe laden

Alle Bedarfe meiner Institution laden

Neues Bedarf einstellen

Bedarf l�schen

Bedarf bedienen

Bedarf-Anfrage l�schen

Institution

Alle Institutionen laden

Institutionen Suche (noch nicht umgesetzt)

Institution lesen (noch nicht umgesetzt)

Institution hinzufugen (noch nicht umgesetzt)

Institution aktualisieren (noch nicht umgesetzt)

Meine Institution lesen

Meine Institution aktualisieren

Alle Angebote einer Institution laden

Alle Bedarfe einer Institution laden

Person

Alle Personen laden

Person hinzuf�gen

Person lesen (noch nicht umgesetzt)

Meine Person lesen