Async API for redispatching 0.0.1

Specyfikacja asynchronicznego API na potrzeby redysponowania

Servers

  • amqps://${PSE_AMQP}/amqps 1.0amqp-cluster

    B2B AMQP broker

    Security:
    • OAuth2

      OAuth2 dla publikacji komunikatów

    object

Operations

  • RECEIVE redispatch.order.{entityId}

    Kanał z poleceniami redysponowania dla danego podmiotu (OSD lub przedstawiciela MWE przyłączonego do sieci przesyłowej - MWEp)

    Odebranie przez podmiot polecenia redysponowania

    Operation IDreceiveRedispatchOrder

    Available only on servers:

    object
    entityId
    required
    string

    Unikalny 5-znakowy identyfikator podmiotu.

    Additional security requirements:
    • OAuth2

      OAuth2 dla publikacji komunikatów

    object

    Accepts the following message:

    Polecenie redysponowania
    Message IDRedispatchOrderMessage
    Correlation ID$message.payload#/header/tsoMsgId

    Korelacja na podstawie tsoMsgId z nagłówka.

    object

    Examples

  • SEND redispatch.acknowledgement

    Kanał z odpowiedziami na polecenia redysponowania

    Wysłanie przez podmiot potwierdzenia na polecenie redysponowania

    Operation IDsendRedispatchAcknowledgement

    Available only on servers:

    Additional security requirements:
    • OAuth2

      OAuth2 dla publikacji komunikatów

    object

    Accepts the following message:

    Potwierdzenie do wydanego polecenie redysponowania
    Message IDRedispatchAcknowledgementMessage
    Correlation ID$message.header#/tsoMsgId

    Korelacja na podstawie tsoMsgId z nagłówka.

    object

    Odpowiedź na wydane polecenie redysponowania. Spodziewane są 2 dopowiedzi - najpierw RECEIVED a potem ACCEPTED/REJECTED

    Examples

  • RECEIVE redispatch.information.{entityId}

    Kanał z informacjami o zaplanowanych redysponowaniach

    Odebranie przez podmiot informacji o redysponowaniu

    Operation IDreceiveRedispatchInformation

    Available only on servers:

    object
    entityId
    required
    string

    Unikalny 5-znakowy identyfikator podmiotu.

    Additional security requirements:
    • OAuth2

      OAuth2 dla publikacji komunikatów

    object

    Accepts the following message:

    Informacja o redysponowaniu
    Message IDRedispatchInformationMessage
    Correlation ID$message.payload#/header/tsoMsgId

    Korelacja na podstawie tsoMsgId z nagłówka.

    object

    Examples

  • SEND redispatch.failed

    Kanał typu DLQ dla komunikatów redysponowania od OSP, które nie mogły zostać przetworzone z przyczyn technicznych przez podmioty

    Wysłanie przez podmiot informacji o błędnym komunikacie z OSP

    Operation IDsendGenericFailureMessage

    Available only on servers:

    Additional security requirements:
    • OAuth2

      OAuth2 dla publikacji komunikatów

    object

    Accepts the following message:

    Komunikat o błędzie przetwarzania
    Message IDGenericFailureMessage
    Correlation ID$message.payload#/refMsgId

    Korelacja na podstawie tsoMsgId lub entityMsgId z nagłówka.

    object

    Generyczny komunikat o błędzie przetwarzania

    Examples

  • RECEIVE redispatch.failure.{entityId}

    Kanał typu DLQ dla komunikatów redysponowania od podmiotów, które nie mogły zostać przetworzone z przyczyn technicznych przez OSP

    Odebranie przez podmiot informacji o błednym komunikacie z podmiotu

    Operation IDreceiveGenericFailureMessage

    Available only on servers:

    Additional security requirements:
    • OAuth2

      OAuth2 dla publikacji komunikatów

    object

    Accepts the following message:

    Komunikat o błędzie przetwarzania
    Message IDGenericFailureMessage
    Correlation ID$message.payload#/refMsgId

    Korelacja na podstawie tsoMsgId lub entityMsgId z nagłówka.

    object

    Generyczny komunikat o błędzie przetwarzania

    Examples

  • SEND redispatch.dso-redispatches

    Kanał do wysyłania informacji o wydanych przez OSD poleceniach redysponowania w związku z wydanymi przez OSP poleceniami redysponowania

    Nadanie komunikatu z informacją o wydanych poleceniach redysponowania

    Operation IDsendDSORedispatches

    Available only on servers:

    Additional security requirements:
    • OAuth2

      OAuth2 dla publikacji komunikatów

    object

    Accepts the following message:

    Informacja o wydanych poleceniach redysponowania
    Message IDPsdiRedispatchRealizationMessage
    Correlation ID$message.header#/serverMsqId

    Korelacja na podstawie serverMsqId z nagłówka.

    array<object>
    object

    Examples

  • RECEIVE redispatch.request-status.{entityId}

    Kanał do odbioru przez podmioty potwierdzenia przetworzenia komunikatów przez OSP

    Odebranie komunikatu potwierdzenia przetworzenia informacji przesłanych do OSP

    Operation IDreceiveRequest-status

    Available only on servers:

    Additional security requirements:
    • OAuth2

      OAuth2 dla publikacji komunikatów

    object

    Accepts the following message:

    Informacja o przetworzeniu informacji o wydanym przez OSD poleceniu redysponowania
    Message IDPsdiRequestStatusMessage
    Correlation ID$message.payload#/serverMsqId

    Korelacja na podstawie serverMsqId z nagłówka.

    object

    Examples

  • SEND redispatch.network-contraints

    Kanał do wysyłania informacji o ograniczeniach w sieci OSD niezwiązanych z wydanym poleceniem OSP

    Nadanie komunikatu z informacją o wydanych poleceniach redysponowania

    Operation IDsendDispatchNetworkContraints

    Available only on servers:

    Additional security requirements:
    • OAuth2

      OAuth2 dla publikacji komunikatów

    object

    Accepts the following message:

    Informacja o ograniczeniach w sieci OSD
    Message IDNetworkContraintsMessage
    Correlation ID$message.header#/serverMsqId

    Korelacja na podstawie serverMsqId z nagłówka.

    array<object>
    object

    Examples

  • SEND redispatch.generated-energy-withsupport

    Kanał do wysyłania informacji o E_wyk_cert dla MWE, które były redysponowane przez OSD w związku z wydanym poleceniem OSP

    Nadanie komunikatu z informacją o E_wyk_cert

    Operation IDsendGeneratedEnergyWithSupport

    Available only on servers:

    Additional security requirements:
    • OAuth2

      OAuth2 dla publikacji komunikatów

    object

    Accepts the following message:

    Informacja o E_wyk_cert
    Message IDPsdiEWykCertMessage
    Correlation ID$message.header#/serverMsqId

    Korelacja na podstawie serverMsqId z nagłówka.

    array<object>
    object

    Examples

  • SEND redispatch.auction-support-request

    Kanał do wysyłania do OSP informacji o zgłoszeniach wynikających z art. 93 ust. 18 Ustawy o OZE, , które złożyli Wytwórcy w aplikacji WOZE po wydanym poleceniu przez OSP

    Nadanie komunikatu z informacją o zgłoszeniach uOze

    Operation IDsendAuctionSupportRequest

    Available only on servers:

    Additional security requirements:
    • OAuth2

      OAuth2 dla publikacji komunikatów

    object

    Accepts the following message:

    Informacja o zgłoszeniach uOze
    Message IDPsdiUOzeMessage
    Correlation ID$message.header#/serverMsqId

    Korelacja na podstawie serverMsqId z nagłówka.

    array<object>
    object

    Examples

  • RECEIVE redispatch.auction-support-request.{entityId}

    Kanał do wysyłania do OSD informacji o zgłoszeniach wynikających z art. 93 ust. 18 Ustawy o OZE, , które złożyli Wytwórcy poza aplikacją WOZE po wydanym poleceniu przez OSP

    Pobranie komunikatu z informacją o zgłoszeniach uOze

    Operation IDreceiveAuctionSupportRequest

    Available only on servers:

    Additional security requirements:
    • OAuth2

      OAuth2 dla publikacji komunikatów

    object

    Accepts the following message:

    Informacja o zgłoszeniach uOze
    Message IDPsdiUOzeMessage
    Correlation ID$message.header#/serverMsqId

    Korelacja na podstawie serverMsqId z nagłówka.

    array<object>
    object

    Examples

  • SEND redispatch.responsible-subject-for-generator

    Kanał do przekazania do OSP informacji o zmianie przypisania POB do pojedynczego MWE

    Nadanie komunikatu z informacją o zgłoszeniach uOze

    Operation IDsendResponsibleSubjectForGenerator

    Available only on servers:

    Additional security requirements:
    • OAuth2

      OAuth2 dla publikacji komunikatów

    object

    Accepts the following message:

    Informacja o POB
    Message IDPsdiPOBMessage
    Correlation ID$message.header#/serverMsqId

    Korelacja na podstawie serverMsqId z nagłówka.

    array<object>
    object

    Examples

Messages

  • #1Polecenie redysponowania
    Message IDRedispatchOrder
    Correlation ID$message.payload#/header/tsoMsgId

    Korelacja na podstawie tsoMsgId z nagłówka.

    object
  • #2Potwierdzenie do wydanego polecenie redysponowania
    Message IDRedispatchAcknowledgement
    Correlation ID$message.header#/tsoMsgId

    Korelacja na podstawie tsoMsgId z nagłówka.

    object

    Odpowiedź na wydane polecenie redysponowania. Spodziewane są 2 dopowiedzi - najpierw RECEIVED a potem ACCEPTED/REJECTED

  • #3Informacja o redysponowaniu
    Message IDRedispatchInformation
    Correlation ID$message.payload#/header/tsoMsgId

    Korelacja na podstawie tsoMsgId z nagłówka.

    object
  • #4Komunikat o błędzie przetwarzania
    Message IDGenericFailure
    Correlation ID$message.payload#/refMsgId

    Korelacja na podstawie tsoMsgId lub entityMsgId z nagłówka.

    object

    Generyczny komunikat o błędzie przetwarzania

  • #5Informacja o wydanych poleceniach redysponowania
    Message IDPsdiRedispatch
    Correlation ID$message.header#/serverMsqId

    Korelacja na podstawie serverMsqId z nagłówka.

    array<object>
  • #6Informacja o wydanych poleceniach redysponowania
    Message IDPsdiRedispatchRealizationMessage
    Correlation ID$message.header#/serverMsqId

    Korelacja na podstawie serverMsqId z nagłówka.

    array<object>
    object
  • #7Informacja o zgłoszeniach uOze
    Message IDPsdiUOzeMessage
    Correlation ID$message.header#/serverMsqId

    Korelacja na podstawie serverMsqId z nagłówka.

    array<object>
    object
  • #8Informacja o POB
    Message IDPsdiPOBMessage
    Correlation ID$message.header#/serverMsqId

    Korelacja na podstawie serverMsqId z nagłówka.

    array<object>
    object
  • #9Informacja o E_wyk_cert
    Message IDPsdiEwykCertMessage
    Correlation ID$message.header#/serverMsqId

    Korelacja na podstawie serverMsqId z nagłówka.

    array<object>
    object
  • #10Informacja o ograniczeniach w sieci OSD
    Message IDNetworkContraintsMessage
    Correlation ID$message.header#/serverMsqId

    Korelacja na podstawie serverMsqId z nagłówka.

    array<object>
    object
  • #11Informacja o przetworzeniu informacji o wydanym przez OSD poleceniu redysponowania
    Message IDPsdiRedispatchRealizationResult
    Correlation ID$message.payload#/serverMsqId

    Korelacja na podstawie serverMsqId z nagłówka.

    object

Schemas

  • object
  • object
  • object
  • object
  • object

    Okres wydanego polecenia redysponowania

  • object

    Odpowiedź na wydane polecenie redysponowania. Spodziewane są 2 dopowiedzi - najpierw RECEIVED a potem ACCEPTED/REJECTED

  • object

    Generyczny komunikat o błędzie przetwarzania

  • object
  • object
  • object

    Komunikat informujący o wydanym przez OSP poleceniu redysponowania

  • object

    Komunikat informujący o wydanym przez OSD poleceniu redysponowania

  • object

    Komunikat informujący o Przekazanie informacji o zgłoszeniach wynikających z art. 93 ust. 18 Ustawy o OZE, , które złożyli Wytwórcy w aplikacji WOZE po wydanym poleceniu przez OSP

  • object

    Komunikat informujący o zmianie przypisania POB do pojedynczego MWE

  • object

    Komunikat informujący o E_wyk_cert dla MWE, które były redysponowane przez OSD w związku z wydanym poleceniem OSP

  • object

    Komunikat informujący o ograniczeniach w sieci OSD nie będących efektem wydanego przez OSP polecenia redysponowania

  • object

    Tabela przedziałów czasowych polecenia redysponowania

  • object

    Tabela przedziałów czasowych polecenia redysponowania

  • object

    Tabela przedziałów czasowych e-wyk-cert

  • object

    Tabela przedziałów czasowych polecenia redysponowania