Back to top

Mainzelliste

Patients

Create a patient and retrieve the ID

POST/patients/

Create a new patient.

Request
HideShow
  • Parameters

    • tokenId: the ID of an addPatient token
Headers
Content-Type: application/x-www-form-urlencoded
Accept: application/json
Response  201
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "idType": "pid",
    "idString": "000GR0W0",
    "tentative": false,
    "uri": "http:\\/\\/example.org\\/mainzelliste\\/patients\\/pid\\/000GR0W0"
  }
]
Schema
{to be added}
Response  400
HideShow
Headers
Content-Type: text/html
Response  401
Response  409

GET/patients/{tokenId}

Retrieve a list of all patients.

Parameters
HideShow
tokenId
string (required) Example: the ID of an addPatient token
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "geburtsjahr": 1980,
    "wohnort": "Frankfurt a. M.",
    "ids": [
      "idType: labid",
      "idString: 54321"
    ]
  }
]
Schema
{to be added}

Modify a patient

PUT/patients/tokenId/

Modify a patient.

Request
HideShow
  • Parameters

    • tokenId: the ID of an addPatient token
Headers
Content-Type: application/x-www-form-urlencoded
Accept: application/json
Schema
{to be added}
Response  204
Response  200
HideShow
Headers
Content-Type: text/html
Response  400
HideShow
Headers
Content-Type: text/html
Response  401
Response  404

Sessions

Create a session

POST/sessions

Create a new session.

Request
HideShow
Headers
Accept: application/json
Schema
{to be added}
Response  201
HideShow
Headers
Content-Type: application/json
Location: https:\/\/some.mainzelliste.de\/bsp\/sessions\/d81793a2-bad3-44d1-9496-65ae16814979
Body
{
  "sessionId": "d81793a2-bad3-44d1-9496-65ae16814979",
  "uri": "https:\\/\\/some.mainzelliste.de\\/bsp\\/sessions\\/d81793a2-bad3-44d1-9496-65ae16814979",
  "tokens": [
    {
      "id": "``",
      "uri": "``"
    },
    {
      "id": "``",
      "uri": "``"
    }
  ]
}
Schema
{to be added}
Response  401

Retrieve a session

GET/sessions/

Retrieve a specific session.

Request
HideShow
  • Parameters

    • session: the ID of a session
Headers
Accept: application/json
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "sessionId": "d81793a2-bad3-44d1-9496-65ae16814979",
  "uri": "https:\\/\\/some.mainzelliste.de\\/bsp\\/sessions\\/d81793a2-bad3-44d1-9496-65ae16814979",
  "tokens": [
    {
      "id": "``",
      "uri": "``"
    },
    {
      "id": "``",
      "uri": "``"
    }
  ]
}
Schema
{to be added}
Response  404

Delete a session

DELETE/sessions/{sid}

Delete a specific session.

Parameters
HideShow
sid
string (required) Example: the ID of a session
Response  204

Tokens

Create a token

POST/sessions//tokens

Create a new token.

Request
HideShow
  • Parameters

    • sid: the ID of a session
Headers
Content-Type: application/json
Accept: application/json
mainzellisteApiKey: 65ae16814979
Body
{
  "id": "97d2424f-dd3d-42de-ad9f-8b604b1c57ad",
  "type": "addPatient",
  "data": {
    "idtypes": [
      "pid"
    ],
    "fields": {
      "aufnahmedatum": "12.1.2014",
      "aufnahmeort": "Mainz",
      "sureness": true
    },
    "callback": "https:\\/\\/example.org/mdat/patientCreated.php",
    "redirect": "https:\\/\\/example.org/mdat/addNewPatientMDAT.php?pid={pid}&tid={tokenId}"
  },
  "uri": "http:\\/\\/localhost:8080\\/mainzelliste\\/sessions\\/7629d1dd-5d9b-4c4c-8b90-7f64b44a3159\\/tokens\\/97d2424f-dd3d-42de-ad9f-8b604b1c57ad"
}
Schema
{to be added}
Response  201
HideShow
Headers
Location: https:\/\/some.mainzelliste.de\/bsp\/sessions\/d81793a2-bad3-44d1-9496-65ae16814979
Response  400
HideShow
Headers
Content-Type: text/html
Response  401
Response  404

Get a token

GET/sessions//tokens/

Retrieve an existing token.

Request
HideShow
  • Parameters

    • sid: the ID of a session
    • tid: the ID of a token
Headers
Accept: application/json
mainzellisteApiKey: 65ae16814979
Schema
{to be added}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "tokenId": "93edf7-2a86-4c34-a6d7-46a5935adb1e",
  "ids": [
    "idType: pid",
    "idString: 000LP0WE"
  ]
}
Schema
{to be added}
Response  404

DELETE/sessions//tokens/

Delete an existing token.

Request
HideShow
  • Parameters

    • sid: the ID of a session
    • tid: the ID of a token
Headers
Accept: application/json
mainzellisteApiKey: 65ae16814979
Schema
{to be added}
Response  204
Response  404

Generated by aglio on 11 Sep 2015