To inform your platform-app about a deactivation or deletion of the app in WebUntis-Platform, you must provide a specific endpoint.
Deactivation API Specification
|
POST |
JSON string with the data, for example: { |
Headers used to verify WU identity: Authorization - base64 encoded signature
|
-
Values for "type":
- DEACTIVATION: The app was deactivated, but not deleted.
- DELETION: The app was deleted.
-
Values for "reasonType":
- NO_REASON: No reason known.
- SCHOOL_DEACTIVATION: The whole WebUntis-School was deactivated.
- SCHOOL_DELETION: The whole WebUntis-School was deleted.
Example HTTP request:
POST {partner.credentials.api} HTTP/1.1
Host: api.webuntis.integration.com
Content-Type: application/json; charset=utf-8
Content-Length: length
Connection: Keep-Alive
Authorization: zGPyG3bdqDbfJLk3s8jlRcbpreaCPhTJDywgh1JdqQYie5Aus0bzV/PjuFml1j+7B/6bEKI4xY+dh71dDJyvQWBkeS0DRxY883TPkvfMnfVr6vucTVjph5AARA9YXQw3OfGA5oDp9VXmBI22f4TFvanEWTqo5KD6pBM9FE+FUgEzDqXnB9FOogJ5xrfa8f0iU6Si3V0W3J20rIO71jf4V8Hvj9a9vs1p50ldi63SWeNAwO2wH+rxZXVtZ6RJqWkp720wgwIacfMezaw6lI0dodp0uDQnCmxarT07M4BbsvRciabe4tDJVuKd0JIpos4VargBtBPpgfXbPxWlSF6cTQ==
Algorithm: SHA256withRSA
{
"tenantId": "12345",
"type": "DEACTIVATION",
"reasonType": "NO_REASON",
"reasonText": "The tenant requested deactivation."
}