blob: 8dd6ff9ea0f10e92dd7b8e7c030ad1d4fdbabc3b [file] [log] [blame]
swagger: '2.0'
info:
title: Anlagen-Eigentumsverhältnisse
description: Diese Schnittstelle ist Teil der [oK](http://www.openkonsequenz.de) Quellsystem-API.
version: Revision 3 (cim-profile openkonsequenz)
contact:
name: BTC AG
url: http://www.btc-ag.com
email: openk@btc-ag.com
license:
name: Eclipse Public License 1.0
url: https://www.eclipse.org/legal/epl-v10.html
host: api.openk.de
schemes:
- http
basePath: /source-system/electricity/asset-data
produces:
- application/xml
paths:
/asset-ownerships:
get:
summary: Die Schnittstelle gibt die Eigentumsverhältnisse aller Einspeise-Anlagen zurück. Die Eigentumsverhältnisse werden je Anlage in Prozent zurückgegeben und verweisen jeweils auf die Referenz des eigentumsberechtigten Unternehmens. Dies sind natürliche oder juristische Personen oder rechtlich unselbstständige Organisationseinheiten.
parameters:
- name: revision
in: query
description: Version, die den Nachrichtenaustausch definiert. Dies ist nicht die CIM-Version.
required: true
type: integer
format: int32
minimum: 3
maximum: 3
- name: timestamp
in: query
description: Zeitpunkt, an dem die Nachricht versendet wurde (in UTC gemäß ISO-8601-Format YYYY-MM-DDTHH:mm:ss.SSSZ).
required: false
type: string
format: date-time
pattern: '^([0-9]{4}-((0[1-9])|(1[0-2]))-((0[1-9])|([1-2][0-9])|30|31)T(([0-1][0-9])|(2[0-3]))(:[0-5][0-9]){2}\.[0-9]{3}Z)$'
- name: source
in: query
description: Eindeutige Bezeichnung des Senders der Nachricht.
required: false
type: string
- name: user-id
in: query
description: Eindeutige Kennung des angemeldeten Nutzers (Sender).
required: false
type: string
- name: message-id
in: query
description: Eindeutige Kennung dieser Nachricht. Generiert vom Sender der Nachricht.
required: false
type: string
format: uuid
pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$'
responses:
200:
description: Die Liste der Eigentumsverhältnisse aller Anlagen.
schema:
$ref: '#/definitions/ResponseMessage'
400:
description: Die Schnittstelle wurde mit ungültigen Parametern aufgerufen.
500:
description: Es trat ein allgemeiner Fehler bei der Verarbeitung der Anfrage auf.
definitions:
### specific definitions ######################################################
AssetOwnerships:
description: Auflistung der Eigentumsverhältnisse der Anlagen.
type: array
items:
$ref: '#/definitions/Ownership'
xml:
wrapped: true
Ownership:
description: Eigentumsverhältnis der Anlage.
type: object
properties:
mRID:
description: Eindeutige Kennung der Eigentumsverhältnisses der Anlage.
type: string
format: uuid
pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$'
share:
$ref: '#/definitions/Ownership.share'
Asset:
$ref: '#/definitions/Ownership.Asset'
AssetOwner:
$ref: '#/definitions/Ownership.AssetOwner'
required:
- mRID
- share
- Asset
- AssetOwner
xml:
name: Ownership
Ownership.Asset:
description: Anlage.
properties:
AssetOwner:
$ref: '#/definitions/Asset_Reference'
Ownership.AssetOwner:
description: Anlagenbetreiberrolle.
properties:
AssetOwner:
$ref: '#/definitions/AssetOwner'
Ownership.share:
type: object
allOf:
- $ref: '#/definitions/Share'
description: Prozentualer Anteil am Anlagen-Eigentum.
Payload:
description: Der Inhalt der CIM-Nachricht.
type: object
properties:
AssetOwnerships:
$ref: '#/definitions/AssetOwnerships'
required:
- AssetOwnerships
### common definitions ######################################################
AssetOwner:
description: Referenz auf das Unternehmen.
type: object
properties:
mRID:
description: Endeutige Kennung des Unternehmens.
type: string
format: uuid
pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$'
required:
- mRID
xml:
name: AssetOwner
Asset_Reference:
description: Referenz auf die Anlage.
type: object
properties:
mRID:
description: Eindeutige Kennung der Anlage.
type: string
format: uuid
pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$'
required:
- mRID
xml:
name: Asset
Header_Reply:
description: Der Kopf der CIM-Nachricht.
type: object
properties:
Verb:
description: Hinweis, um welche Art von Nachricht es sich handelt.
type: string
default: reply
Noun:
description: Hinweis auf den Nachrichteninhalt.
type: string
Revision:
description: Version, die den Nachrichtenaustausch definiert. Dies ist nicht die CIM-Version.
type: integer
format: int32
minimum: 2
maximum: 2
Timestamp:
description: Zeitpunkt, an dem die Nachricht versendet wurde (in UTC gemäß ISO-8601-Format YYYY-MM-DDThh:mm:ss.sssZ).
type: string
format: date-time
pattern: '^([0-9]{4}-((0[1-9])|(1[0-2]))-((0[1-9])|([1-2][0-9])|30|31)T(([0-1][0-9])|(2[0-3]))(:[0-5][0-9]){2}\.[0-9]{3}Z)$'
Source:
description: Eindeutige Bezeichnung des Senders der Nachricht.
type: string
User:
$ref: '#/definitions/User'
MessageID:
description: Eindeutige Kennung dieser Nachricht. Generiert vom Sender der Nachricht.
type: string
format: uuid
pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$'
required:
- Verb
- Noun
- Revision
- Timestamp
- Source
- MessageID
xml:
name: Header
Share:
description: Prozentwert
type: object
properties:
multiplier:
description: Multiplikator des Prozentwertes (CIM UnitMultiplier).
type: string
enum:
- none
unit:
description: Einheit des Prozentwertes (CIM UnitSymbol).
type: string
enum:
- none
value:
description: Prozentwert
type: number
format: float
minimum: 0
maximum: 100
required:
- value
xml:
name: share
Reply_OK:
description: Die Antwort der CIM-Nachricht.
type: object
properties:
Result:
description: Antworttext.
type: string
default: OK
required:
- Result
xml:
name: Reply
ResponseMessage:
description: Die CIM-Antwortnachricht.
type: object
properties:
Header:
$ref: '#/definitions/Header_Reply'
Reply:
$ref: '#/definitions/Reply_OK'
Payload:
$ref: '#/definitions/Payload'
required:
- Header
- Reply
- Payload
xml:
name: ResponseMessage
User:
properties:
userId:
description: Eindeutige Kennung des angemeldeten Nutzers (Empfänger).
type: string
xml:
name: UserID
required:
- UserID