Skip to content
Snippets Groups Projects
index.yml 3.06 KiB
Newer Older
parameters:
  - $ref: '../../../parameters/submissionId.yml'

get:
  operationId: get-submission-events
  summary: Event Log auslesen
  description: >
    Über diesen Endpunkt kann der [Event Log](https://docs.fitko.de/fit-connect/details/event-log) einer Einreichung
    abgerufen werden, um den Status der Einreichung zu überprüfen.
  tags:
    - Einreichungsempfang
    - Einreichungsübermittlung
  security:
    - OAuth20:
        - 'subscribe:destination:<id>'
  responses:
    '200':
      description: OK
      content:
        application/json:
          schema:
            $ref: '../../../schemas/event-log.yml'
          examples:
            Beispiel:
              $ref: '../../../examples/event-log.yml'
    '400':
      description: Bad Request
      content:
        application/problem+json:
          schema:
            $ref: ../../../schemas/error.yml
    '401':
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            $ref: ../../../schemas/error.yml
    '403':
      description: Forbidden
      content:
        application/problem+json:
          schema:
            $ref: ../../../schemas/error.yml
    '404':
      description: Submission not found
      content:
        application/problem+json:
          schema:
            $ref: ../../../schemas/error.yml

post:
  operationId: send-submission-event
  summary: Event senden
  description: >
    Als empfangendes System ist es notwendig die Einreichung entweder zu akzeptieren oder abzulehnen und dadurch die Zustellung abzuschließen.
    Hierfür muss ein entsprechendes Event, die Einreichung betreffend an den Zustelldienst gesendet werden.
    Dieses Event kann nach der Validierung der Rahmenstruktur der Einreichung durchgeführt werden, wie
    [hier](https://docs.fitko.de/fit-connect/getting-started/receiving/process-and-acknowledge) beschrieben ist.
  tags:
    - Einreichungsempfang
  security:
    - OAuth20:
        - 'subscribe:destination:<id>'
  requestBody:
    required: true
    content:
      application/octet-stream:
        schema:
          $ref: '../../../schemas/security-event-token.yml'
        examples:
          Beispiel:
            $ref: '../../../examples/security-event-token.yml'
  responses:
      description: OK
      content:
        application/json:
          schema:
            $ref: '../../../schemas/empty-body.yml'
          examples:
            Beispiel:
              $ref: '../../../examples/empty-body.yml'
    '400':
      description: Bad Request
      content:
        application/problem+json:
          schema:
            $ref: ../../../schemas/error.yml
    '401':
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            $ref: ../../../schemas/error.yml
    '403':
      description: Forbidden
      content:
        application/problem+json:
          schema:
            $ref: ../../../schemas/error.yml
    '404':
      description: Submission not found
      content:
        application/problem+json:
          schema:
            $ref: ../../../schemas/error.yml