Schulconnex

Additionally to our IDM API, we support the schulconnex specification. We are providing IDM endpoints for other services. Therefore, we implement the “Dienste API”

API

`GET /person-info`

Path	Authentication	Required Scope
`/idm/schulconnex/v1/person-info`	Access Token in the user context (Auth Code Flow)	`urn:eduplaces:idm:v1:people:read`


HTTP/1.1 200
Content-Type: application/json
 
{
  "pid": "fab48086-5723-4829-bd94-14a0755b7bd9",
  "person": {
    "name": { "vorname": "Stephanie", "familienname": "Schuster" },
    "stammorganisation": {
      "id": "f5a22699-a5cf-4982-9190-4c47ec459c0e",
      "name": "Schloss Einstein Internat",
      "kennung": "DE-NI-123456",
      "anschrift": { "ort": "Musterstadt", "postleitzahl": "38100" },
      "typ": "SCHULE"
    }
  },
  "personenkontexte": [
    {
      "id": "fab48086-5723-4829-bd94-14a0755b7bd9",
      "loeschung": null,
      "rolle": "LEHR",
      "organisation": {
        "id": "f5a22699-a5cf-4982-9190-4c47ec459c0e",
        "name": "Schloss Einstein Internat",
        "kennung": "DE-NI-123456",
        "anschrift": { "ort": "Musterstadt", "postleitzahl": "38100" },
        "typ": "SCHULE"
      },
      "gruppen": [
        {
          "gruppe": {
            "id": "92ab13cf-031e-474e-8e1c-f2b152926f78",
            "bezeichnung": "Klasse 5a",
            "typ": "Sonstig",
            "orgid": "f5a22699-a5cf-4982-9190-4c47ec459c0e"
          }
        }
      ]
    }
  ]
}

`GET /personen-info`

Path	Authentication	Required Scope
`/idm/schulconnex/v1/personen-info`	Access Token in the apps context (Client Credentials)	`urn:eduplaces:idm:v1:people:read`


HTTP/1.1 200
Content-Type: application/json
 
[
  {
    "pid": "eb74e464-b9a8-479f-9c02-67a8fe66b99a",
    "person": {
      "name": { "vorname": "Wilma Johanna Sophie", "familienname": "Becker" },
      "stammorganisation": {
        "id": "f5a22699-a5cf-4982-9190-4c47ec459c0e",
        "name": "Schloss Einstein Internat",
        "kennung": "DE-NI-123456",
        "anschrift": { "ort": "Musterstadt", "postleitzahl": "38100" },
        "typ": "SCHULE"
      }
    },
    "personenkontexte": [
      {
        "id": "eb74e464-b9a8-479f-9c02-67a8fe66b99a",
        "loeschung": null,
        "rolle": "LEHR",
        "organisation": {
          "id": "f5a22699-a5cf-4982-9190-4c47ec459c0e",
          "name": "Schloss Einstein Internat",
          "kennung": "DE-NI-123456",
          "anschrift": { "ort": "Musterstadt", "postleitzahl": "38100" },
          "typ": "SCHULE"
        },
        "gruppen": [
          {
            "gruppe": {
              "id": "304c5841-36f6-4331-81e1-93edde5b2448",
              "bezeichnung": "Alle Lehrkräfte",
              "typ": "Sonstig",
              "orgid": "f5a22699-a5cf-4982-9190-4c47ec459c0e"
            }
          }
        ]
      }
    ]
  },
  {
    "pid": "42c12a1d-8e02-4898-95e2-7ca04fa18b67",
    "person": {
      "name": { "vorname": "Norbert Dieter", "familienname": "Graf" },
      "stammorganisation": {
        "id": "f5a22699-a5cf-4982-9190-4c47ec459c0e",
        "name": "Schloss Einstein Internat",
        "kennung": "DE-NI-123456",
        "anschrift": { "ort": "Musterstadt", "postleitzahl": "38100" },
        "typ": "SCHULE"
      }
    },
    "personenkontexte": [
      {
        "id": "42c12a1d-8e02-4898-95e2-7ca04fa18b67",
        "loeschung": null,
        "rolle": "LEHR",
        "organisation": {
          "id": "f5a22699-a5cf-4982-9190-4c47ec459c0e",
          "name": "Schloss Einstein Internat",
          "kennung": "DE-NI-123456",
          "anschrift": { "ort": "Musterstadt", "postleitzahl": "38100" },
          "typ": "SCHULE"
        },
        "gruppen": [
          {
            "gruppe": {
              "id": "decc0cb1-87bb-43ab-aec0-75148888cea3",
              "bezeichnung": "Alle Lehrkräfte",
              "typ": "Sonstig",
              "orgid": "f5a22699-a5cf-4982-9190-4c47ec459c0e"
            }
          }
        ]
      }
    ]
  }
]