Newer
Older
openapi: 3.0.0
info:
version: '1.0.0-alpha'
title: API Spezifikation Zustelldienst (Gesamt)
description: Übergreifende API Schnittstelle des Zustelldienstes.
contact:
name: FITKO
url: 'https://www.fitko.de/'
license:
url: 'https://creativecommons.org/licenses/by-sa/4.0/'
name: Creative Commons Attribution Share Alike 4.0 (CC BY-SA 4.0)
servers:
- url: 'https://sender-test.fiep-poc.de/beta8'
description: Testsystem
tags:
- name: Destination Management
- name: Application Transfer
- name: Application Retrieval
paths:
/destinations:
$ref: './endpoints/destinations/index.yml'
/destinations/{destinationId}:
$ref: './endpoints/destinations/uuid.yml'
/applications:
$ref: './endpoints/applications/index.yml'
/applications/{applicationId}:
$ref: './endpoints/applications/uuid.yml'
/applications/{applicationId}/documents/{documentId}:
$ref: './endpoints/documents/uuid.yml'
/info:
$ref: './endpoints/info/get-info.yml'
components:
securitySchemes:
OAuth20:
$ref: './security/oauth2.yml'
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
parameters:
applicationId:
$ref: './parameters/applicationId.yml'
destinationId:
$ref: './parameters/destinationId.yml'
documentId:
$ref: './parameters/documentId.yml'
schemas:
GetDestinationResponse:
$ref: './schemas/get-destination-response.yml'
GetAllDestinationsResponse:
$ref: './schemas/get-all-destinations-response.yml'
GetDocumentResponse:
$ref: './schemas/get-document-response.yml'
ApplicationSchema:
$ref: './schemas/application-schema.yml'
CreateDestinationRequest:
$ref: './schemas/create-destination-request.yml'
ListOfApplicationIds:
$ref: './schemas/list-of-application-ids.yml'
TechnicalContact:
$ref: './schemas/technical-contact.yml'
CreateApplicationRequest:
$ref: './schemas/create-application-request.yml'
CreateDocumentRequest:
$ref: './schemas/create-document-request.yml'
EmptyBody:
$ref: './schemas/empty-body.yml'
SubmitApplicationRequest:
$ref: './schemas/submit-application-request.yml'
StateTransition:
$ref: './schemas/state-transition.yml'
JWK:
$ref: './schemas/jwk.yml'
ApplicationState:
$ref: './schemas/application-state.yml'
ApplicationCreatedResponse:
$ref: './schemas/application-created-response.yml'
ErrorResponse:
$ref: './schemas/error-response.yml'
GetApplicationResponse:
$ref: './schemas/get-application-response.yml'
GetInfoResponse:
$ref: './schemas/get-info-response.yml'
GetVersionResponse:
$ref: './schemas/get-version-response.yml'
UpdateDestinationRequest:
$ref: './schemas/update-destination-request.yml'
examples:
ApplicationCreatedResponse:
$ref: './examples/application-created-response.yml'
ApplicationResponse:
$ref: './examples/application-response.yml'
CreateApplicationRequest:
$ref: './examples/create-application-request.yml'
DestinationList:
$ref: './examples/destination-list.yml'
DestinationRequest:
$ref: './examples/destination-request.yml'
DestinationResponse:
$ref: './examples/destination-response.yml'
EmptyBody:
$ref: './examples/empty-body.yml'
EncryptedMessage:
$ref: './examples/encrypted-message.yml'
GetInfoResponse:
$ref: './examples/get-info-response.yml'