Nutzungsrechte im Kontext

GET 
/policies-info

Nutzungsrechte-Informationen (Policies)

Dieser API-Endpunkt dient dem Abruf von Nutzungsrechte-Informationen (Policies) für Medienobjekte im aktuellen Autorisierungskontext. Die zurückgegebene Antwort-Nutzlast ist eine Liste von ODRL-Zuweisungen (Policies).

Dieser API-Endpunkt ermöglicht optional auch die Anforderung von Zugangsdaten, die den jeweiligen Medienobjekten und Nutzungsrechten (Policies) zugeordnet sind. Werden Zugangsdaten angefordert, so sind sie im Attribut scx:access_control der Antwortnutzlast enthalten.

Der API-Endpunkt unterstützt die Client-seitige Content-Negotiation mittels des Accept-Headers. Dies erlaubt es dem Client, das gewünschte Datenmodell der Antwort-Nutzlast zu spezifizieren, sofern dieses vom Server unterstützt wird.

Request

Query Parameters

target.uid string

Die UID eines spezifische Medienobjekts als Filter-Parameter

target.partOf string

Der Name eines spezifischen Medienkatalogs als Filter-Parameter

access_control boolean

Mit dem Parameter wird die optionale Auslieferung des access_control-Objekts angefordert.

Header Parameters

Accept string
Possible values: [application/ld+json, application/json]
Default value: application/json
Legt den Content-Type der Antwort fest (JSON oder JSON-LD).
Example: application/json

Responses

200

OK

application/json

Schema

Schema

pid string

Pseudonymisierte ID. Referenziert ein bestehendes Objekt des Schulconnex-Servers.

data

object[]

Array [

policy objectrequired

Das Nutzungsrechteobjekt entsprechend der ODRL-Spezifikation

access_control

object

Ein gültiges Zugangsdatenobjekt

type stringrequired

Der Typ (Klasse) des Zugangsdatenobjekts

value

object

required

Das Zugangsdatenobjekt entsprechend dem Schema des Typs

anyOf

license_key

licenseKey string

Der Lizenzschlüssel

components-policies-Zugriffsinfo-object

property name* any

Beliebige Anzahl und Typ von weiteren Properties mit beliebigem Namen

]

status

services

object[]

Array [

service stringrequired

Der Names des Backend-Services

status intrequired

Der Http-Statuscode des Backend-Services für den aktuellen Aufruf

error

message string

]

Example (from schema)

{
  "pid": "df6588cf8dc649ef79fcc852e1064761442a32bf3496ecd9bde0f66a18685aaa",
  "data": [
    {
      "policy": {
        "id": "https://example.com/v1/policies-info/9230294b-68da-4f4f-aa63-ad9040122aa7,",
        "target": {
          "uid": "urn:issuer:medium:123456789,",
          "partOf": "urn:issuer:catalogue"
        },
        "permission": [
          {
            "action": [
              "execute"
            ]
          }
        ]
      },
      "access_control": {
        "type": "license_key",
        "value": {
          "licenseKey": "5f49ff7f-76a6-4d8b-ae40-e1aba0d57f21"
        }
      }
    }
  ],
  "status": {
    "services": [
      {
        "service": "Beispiel-Mediendienst",
        "status": 500,
        "error": {
          "message": "Time-out"
        }
      }
    ]
  }
}

application/ld+json

Schema

Schema

@context

Der Context gemäß JSON-LD-Spezfikation

pid string

Pseudonymisierte ID. Referenziert ein bestehendes Objekt des Schulconnex-Servers.

data

object[]

Array [

policy objectrequired

Das Nutzungsrechteobjekt entsprechend der ODRL-Spezifikation

access_control

object

Ein gültiges Zugangsdatenobjekt

type stringrequired

Der Typ (Klasse) des Zugangsdatenobjekts

value

object

required

Das Zugangsdatenobjekt entsprechend dem Schema des Typs

anyOf

license_key

licenseKey string

Der Lizenzschlüssel

components-policies-Zugriffsinfo-object

property name* any

Beliebige Anzahl und Typ von weiteren Properties mit beliebigem Namen

]

status

services

object[]

Array [

service stringrequired

Der Names des Backend-Services

status intrequired

Der Http-Statuscode des Backend-Services für den aktuellen Aufruf

error

message string

]

Example (from schema)

{
  "@context": [
    "http://schulconnex.de/policies.jsonld",
    {
      "odrl": "http://www.w3.org/ns/odrl.jsonld"
    },
    {
      "type": "@type"
    }
  ],
  "pid": "df6588cf8dc649ef79fcc852e1064761442a32bf3496ecd9bde0f66a18685aaa",
  "data": [
    {
      "policy": {
        "odrl:id": "https://example.com/v1/policies-info/9230294b-68da-4f4f-aa63-ad9040122aa7,",
        "odrl:target": {
          "odrl:uid": "urn:issuer:medium:123456789,",
          "odrl:partOf": "urn:issuer:catalogue"
        },
        "odrl:permission": [
          {
            "odrl:action": [
              "odrl:execute"
            ]
          }
        ]
      },
      "access_control": {
        "type": "license_key",
        "value": {
          "licenseKey": "5f49ff7f-76a6-4d8b-ae40-e1aba0d57f21"
        }
      }
    }
  ],
  "status": {
    "services": [
      {
        "service": "Beispiel-Mediendienst",
        "status": 500,
        "error": {
          "message": "Time-out"
        }
      }
    ]
  }
}

401

Unauthorized

Siehe Fehlerbehandlung

Loading...