Skip to content

Static API Documentation

Jump to bottom
StephanHagge edited this page Jan 19, 2020 · 1 revision

Stand: 19.01.2020

demenziell-erkrankter-controller

getKontaktpersonById

GET /demenziell-erkrankte/{demenziellErkrankterId}/kontaktpersonen/{kontaktPersonId}

Kontaktperson mit ID eines Demenziell Erkrankten ausgeben

Parameters

Name In Type Required Description
demenziellErkrankterId path string true ID des Demenziell Erkrankten
kontaktPersonId path string true ID der Kontaktperson

Example responses

200 Response

{
  "id": "string",
  "name": "string",
  "vorname": "string",
  "telefonnummer": "string",
  "aktiv": true
}

404 Response

Responses

Status Meaning Description Schema
200 OK Kontaktpersonen mit gegebener ID eines Demenziell Erkrankten wird ausgegeben Kontaktperson
404 Not Found Demenziell Erkrankter mit gegebener ID existiert nicht oder Kontaktperson mit gegebener ID existiert für Demenziell Erkrankten nicht string
This operation does not require authentication

updateKontaktpersonForDemenziellErkrankten

PUT /demenziell-erkrankte/{demenziellErkrankterId}/kontaktpersonen/{kontaktPersonId}

Kontaktpersonen für Demenziell Erkrankten aktualisieren

Body parameter

Parameters

Name In Type Required Description
kontaktperson undefined any true Kontaktperson des Demenziell Erkrankten
demenziellErkrankterId path string true ID des Demenziell Erkrankten
kontaktPersonId path string true ID der Kontaktperson
body body KontaktpersonDTO false none
» id body string false none
» name body string false none
» vorname body string false none
» telefonnummer body string false none
» aktiv body boolean false none

Example responses

200 Response

{
  "id": "string",
  "name": "string",
  "vorname": "string",
  "telefonnummer": "string",
  "aktiv": true
}

404 Response

Responses

Status Meaning Description Schema
200 OK Kontaktperson wird aktualisiert und ausgegeben Kontaktperson
201 Created Kontaktperson wird angelegt und ausgegeben Kontaktperson
404 Not Found Demenziell Erkrankter mit gegebener ID existiert nicht string
This operation does not require authentication

deleteKontaktpersonForDemenziellErkrankten

DELETE /demenziell-erkrankte/{demenziellErkrankterId}/kontaktpersonen/{kontaktPersonId}

Kontaktpersonen für Demenziell Erkrankten löschen

Parameters

Name In Type Required Description
demenziellErkrankterId path string true ID des Demenziell Erkrankten
kontaktPersonId path string true ID der Kontaktperson

Example responses

404 Response

Responses

Status Meaning Description Schema
204 No Content Kontaktperson wird gelöscht None
404 Not Found Demenziell Erkrankter mit gegebener ID existiert nicht string
This operation does not require authentication

getPositionssenderById

GET /demenziell-erkrankte/{demenziellErkrankterId}/positionssender/{positionssenderId}

Positionssender mit ID eines Demenziell Erkrankten ausgeben

Parameters

Name In Type Required Description
demenziellErkrankterId path string true ID des Demenziell Erkrankten
positionssenderId path string true ID des Positionssenders

Example responses

200 Response

{
  "id": "string",
  "letzteWartung": "2020-01-19T18:25:24Z"
}

404 Response

Responses

Status Meaning Description Schema
200 OK Positionssender mit gegebener ID eines Demenziell Erkrankten wird ausgegeben Positionssender
404 Not Found Demenziell Erkrankter mit gegebener ID existiert nicht oder Positionssender mit gegebener ID existiert für Demenziell Erkrankten nicht string
This operation does not require authentication

updatePositionssenderForDemenziellErkrankten

PUT /demenziell-erkrankte/{demenziellErkrankterId}/positionssender/{positionssenderId}

Positionssender für Demenziell Erkrankten aktualisieren

Body parameter

Parameters

Name In Type Required Description
positionssender undefined any true Positionssender des Demenziell Erkrankten
demenziellErkrankterId path string true ID des Demenziell Erkrankten
positionssenderId path string true ID des Positionssenders
body body PositionssenderDTO false none
» id body string false none
» letzteWartung body string(date-time) false none

Example responses

200 Response

{
  "id": "string",
  "letzteWartung": "2020-01-19T18:25:24Z"
}

404 Response

Responses

Status Meaning Description Schema
200 OK Positionssender wird aktualisiert und ausgegeben Positionssender
201 Created Positionssender wird angelegt und ausgegeben Positionssender
404 Not Found Demenziell Erkrankter mit gegebener ID existiert nicht string
This operation does not require authentication

deletePositionssenderForDemenziellErkrankten

DELETE /demenziell-erkrankte/{demenziellErkrankterId}/positionssender/{positionssenderId}

Positionssender für Demenziell Erkrankten löschen

Parameters

Name In Type Required Description
demenziellErkrankterId path string true ID des Demenziell Erkrankten
positionssenderId path string true ID des Positionssenders

Example responses

404 Response

Responses

Status Meaning Description Schema
204 No Content Positionssender wird gelöscht None
404 Not Found Demenziell Erkrankter mit gegebener ID existiert nicht string
This operation does not require authentication

getAllPositionssenderForDemenziellErkrankten

GET /demenziell-erkrankte/{demenziellErkrankterId}/positionssender

Alle Positionssender eines Demenziell Erkrankten ausgeben

Parameters

Name In Type Required Description
demenziellErkrankterId path string true ID des Demenziell Erkrankten

Example responses

200 Response

[
  {
    "id": "string",
    "letzteWartung": "2020-01-19T18:25:24Z"
  }
]

404 Response

Responses

Status Meaning Description Schema
200 OK Liste aller Positionssender eines Demenziell Erkrankten wird ausgegeben Inline
404 Not Found Demenziell Erkrankter mit gegebener ID existiert nicht string

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [Positionssender] false none none
» id string false none none
» letzteWartung string(date-time) false none none
This operation does not require authentication

createPositionssenderForDemenziellErkrankten

POST /demenziell-erkrankte/{demenziellErkrankterId}/positionssender

Positionssender für Demenziell Erkrankten anlegen

Body parameter

Parameters

Name In Type Required Description
positionssender undefined any true Positionssender des Demenziell Erkrankten
demenziellErkrankterId path string true ID des Demenziell Erkrankten
body body PositionssenderDTO false none
» id body string false none
» letzteWartung body string(date-time) false none

Example responses

201 Response

{
  "id": "string",
  "letzteWartung": "2020-01-19T18:25:24Z"
}

404 Response

Responses

Status Meaning Description Schema
201 Created Positionssender wird angelegt und ausgegeben Positionssender
404 Not Found Demenziell Erkrankter mit gegebener ID existiert nicht string
This operation does not require authentication

getAllKontaktpersonenForDemenziellErkrankten

GET /demenziell-erkrankte/{demenziellErkrankterId}/kontaktpersonen

Alle Kontaktpersonen eines Demenziell Erkrankten ausgeben

Parameters

Name In Type Required Description
demenziellErkrankterId path string true ID des Demenziell Erkrankten

Example responses

200 Response

[
  {
    "id": "string",
    "name": "string",
    "vorname": "string",
    "telefonnummer": "string",
    "aktiv": true
  }
]

404 Response

Responses

Status Meaning Description Schema
200 OK Liste aller Kontaktpersonen eines Demenziell Erkrankten wird ausgegeben Inline
404 Not Found Demenziell Erkrankter mit gegebener ID existiert nicht string

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [Kontaktperson] false none none
» id string false none none
» name string false none none
» vorname string false none none
» telefonnummer string false none none
» aktiv boolean false none none
This operation does not require authentication

createKontaktpersonForDemenziellErkrankten

POST /demenziell-erkrankte/{demenziellErkrankterId}/kontaktpersonen

Kontaktpersonen für Demenziell Erkrankten anlegen

Body parameter

Parameters

Name In Type Required Description
kontaktperson undefined any true Kontaktperson des Demenziell Erkrankten
demenziellErkrankterId path string true ID des Demenziell Erkrankten
body body KontaktpersonDTO false none
» id body string false none
» name body string false none
» vorname body string false none
» telefonnummer body string false none
» aktiv body boolean false none

Example responses

201 Response

{
  "id": "string",
  "name": "string",
  "vorname": "string",
  "telefonnummer": "string",
  "aktiv": true
}

404 Response

Responses

Status Meaning Description Schema
201 Created Kontaktperson wird angelegt und ausgegeben Kontaktperson
404 Not Found Demenziell Erkrankter mit gegebener ID existiert nicht string
This operation does not require authentication

getAllDemenziellErkrankte

GET /demenziell-erkrankte

Alle Demenziell Erkrankten ausgeben

Example responses

200 Response

[
  {
    "id": "string",
    "name": "string",
    "vorname": "string",
    "zustimmung": true,
    "kontaktpersonen": [
      {
        "id": "string",
        "name": "string",
        "vorname": "string",
        "telefonnummer": "string",
        "aktiv": true
      }
    ],
    "positionssender": [
      {
        "id": "string",
        "letzteWartung": "2020-01-19T18:25:24Z"
      }
    ]
  }
]

Responses

Status Meaning Description Schema
200 OK Liste aller Demenziell Erkrankten wir ausgegeben Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [DemenziellErkrankter] false none none
» id string false none none
» name string false none none
» vorname string false none none
» zustimmung boolean false none none
» kontaktpersonen [Kontaktperson] false none none
»» id string false none none
»» name string false none none
»» vorname string false none none
»» telefonnummer string false none none
»» aktiv boolean false none none
» positionssender [Positionssender] false none none
»» id string false none none
»» letzteWartung string(date-time) false none none
This operation does not require authentication

createDemenziellErkrankter

POST /demenziell-erkrankte

Demenziell Erkrankten anlegen

Body parameter

Parameters

Name In Type Required Description
DemenziellErkrankter undefined any true Demenziell Erkrankter
body body DemenziellErkrankterDTO false none
» id body string false none
» name body string false none
» vorname body string false none
» zustimmung body boolean false none
» kontaktpersonen body [Kontaktperson] false none
»» id body string false none
»» name body string false none
»» vorname body string false none
»» telefonnummer body string false none
»» aktiv body boolean false none
» positionssender body [Positionssender] false none
»» id body string false none
»» letzteWartung body string(date-time) false none

Example responses

201 Response

{
  "id": "string",
  "name": "string",
  "vorname": "string",
  "zustimmung": true,
  "kontaktpersonen": [
    {
      "id": "string",
      "name": "string",
      "vorname": "string",
      "telefonnummer": "string",
      "aktiv": true
    }
  ],
  "positionssender": [
    {
      "id": "string",
      "letzteWartung": "2020-01-19T18:25:24Z"
    }
  ]
}

Responses

Status Meaning Description Schema
201 Created Demenziell Erkrankter wird angelegt und ausgegeben DemenziellErkrankter
This operation does not require authentication

getDemenziellErkrankterById

GET /demenziell-erkrankte/{id}

Demenziell Erkrankten mit ID ausgeben

Parameters

Name In Type Required Description
id path string true ID des Demenziell Erkrankten

Example responses

200 Response

{
  "id": "string",
  "name": "string",
  "vorname": "string",
  "zustimmung": true,
  "kontaktpersonen": [
    {
      "id": "string",
      "name": "string",
      "vorname": "string",
      "telefonnummer": "string",
      "aktiv": true
    }
  ],
  "positionssender": [
    {
      "id": "string",
      "letzteWartung": "2020-01-19T18:25:24Z"
    }
  ]
}

404 Response

Responses

Status Meaning Description Schema
200 OK Demenziell Erkrankter mit gegebener ID wird ausgegeben DemenziellErkrankter
404 Not Found Demenziell Erkrankter mit gegebener ID existiert nicht string
This operation does not require authentication

updateDemenziellErkrankter

PUT /demenziell-erkrankte/{id}

Demenziell Erkrankten mit ID aktualisieren

Body parameter

Parameters

Name In Type Required Description
DemenziellErkrankter undefined any true Demenziell Erkrankter
id path string true ID des Demenziell Erkrankten
body body DemenziellErkrankterDTO false none
» id body string false none
» name body string false none
» vorname body string false none
» zustimmung body boolean false none
» kontaktpersonen body [Kontaktperson] false none
»» id body string false none
»» name body string false none
»» vorname body string false none
»» telefonnummer body string false none
»» aktiv body boolean false none
» positionssender body [Positionssender] false none
»» id body string false none
»» letzteWartung body string(date-time) false none

Example responses

200 Response

{
  "id": "string",
  "name": "string",
  "vorname": "string",
  "zustimmung": true,
  "kontaktpersonen": [
    {
      "id": "string",
      "name": "string",
      "vorname": "string",
      "telefonnummer": "string",
      "aktiv": true
    }
  ],
  "positionssender": [
    {
      "id": "string",
      "letzteWartung": "2020-01-19T18:25:24Z"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Demenziell Erkrankter mit gegebener ID wird aktualisiert und ausgegeben DemenziellErkrankter
201 Created Demenziell Erkrankter mit gegebener ID wird angelegt und ausgegeben DemenziellErkrankter
This operation does not require authentication

deleteDemenziellErkrankterById

DELETE /demenziell-erkrankte/{id}

Demenziell Erkrankten mit ID löschen

Parameters

Name In Type Required Description
id path string true ID des Demenziell Erkrankten

Responses

Status Meaning Description Schema
204 No Content Demenziell Erkrankter mit gegebener ID wird gelöscht None
This operation does not require authentication

Schemas

Positionssender

{
  "id": "string",
  "letzteWartung": "2020-01-19T18:25:24Z"
}

Properties

Name Type Required Restrictions Description
id string false none none
letzteWartung string(date-time) false none none

PositionssenderDTO

{
  "id": "string",
  "letzteWartung": "2020-01-19T18:25:24Z"
}

Properties

Name Type Required Restrictions Description
id string false none none
letzteWartung string(date-time) false none none

Kontaktperson

{
  "id": "string",
  "name": "string",
  "vorname": "string",
  "telefonnummer": "string",
  "aktiv": true
}

Properties

Name Type Required Restrictions Description
id string false none none
name string false none none
vorname string false none none
telefonnummer string false none none
aktiv boolean false none none

KontaktpersonDTO

{
  "id": "string",
  "name": "string",
  "vorname": "string",
  "telefonnummer": "string",
  "aktiv": true
}

Properties

Name Type Required Restrictions Description
id string false none none
name string false none none
vorname string false none none
telefonnummer string false none none
aktiv boolean false none none

DemenziellErkrankter

{
  "id": "string",
  "name": "string",
  "vorname": "string",
  "zustimmung": true,
  "kontaktpersonen": [
    {
      "id": "string",
      "name": "string",
      "vorname": "string",
      "telefonnummer": "string",
      "aktiv": true
    }
  ],
  "positionssender": [
    {
      "id": "string",
      "letzteWartung": "2020-01-19T18:25:24Z"
    }
  ]
}

Properties

Name Type Required Restrictions Description
id string false none none
name string false none none
vorname string false none none
zustimmung boolean false none none
kontaktpersonen [Kontaktperson] false none none
positionssender [Positionssender] false none none

DemenziellErkrankterDTO

{
  "id": "string",
  "name": "string",
  "vorname": "string",
  "zustimmung": true,
  "kontaktpersonen": [
    {
      "id": "string",
      "name": "string",
      "vorname": "string",
      "telefonnummer": "string",
      "aktiv": true
    }
  ],
  "positionssender": [
    {
      "id": "string",
      "letzteWartung": "2020-01-19T18:25:24Z"
    }
  ]
}

Properties

Name Type Required Restrictions Description
id string false none none
name string false none none
vorname string false none none
zustimmung boolean false none none
kontaktpersonen [Kontaktperson] false none none
positionssender [Positionssender] false none none
Clone this wiki locally