Difference between revisions of "Description of the software interfaces"
Jump to navigation
Jump to search
| (3 intermediate revisions by 3 users not shown) | |||
| Line 2: | Line 2: | ||
[[Category:wip]] | [[Category:wip]] | ||
This page contains a description of the different software interfaces created for the DE4A project. The information provided can be used as a reference on the development and integration process to each pilot. | This page contains a description of the different software interfaces created for the DE4A project. The information provided can be used as a reference on the development and integration process to each pilot. | ||
| + | |||
| + | This page is only relevant for '''Iteration 1'''. The respective list for Iteration 2 can be found at [[Summary of software interfaces.]] | ||
== Available interfaces == | == Available interfaces == | ||
| Line 8: | Line 10: | ||
!Component | !Component | ||
!Pattern | !Pattern | ||
| − | |||
!Service | !Service | ||
!Referenced API | !Referenced API | ||
| Line 22: | Line 23: | ||
|XML REST | |XML REST | ||
|Synchronous | |Synchronous | ||
| − | |RequestForwardEvidenceType | + | |[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L567 RequestForwardEvidenceType] |
| − | |ACK | + | |[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L191 ACK] |
|- | |- | ||
|Response user redirection | |Response user redirection | ||
| Line 29: | Line 30: | ||
|XML REST | |XML REST | ||
|Synchronous | |Synchronous | ||
| − | |ResponseUserRedirectionType | + | |[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L601 ResponseUserRedirectionType] |
|HTTP Status 302/303 (Http/1 Http/2) | |HTTP Status 302/303 (Http/1 Http/2) | ||
|- | |- | ||
| Line 38: | Line 39: | ||
|XML REST | |XML REST | ||
|Synchronous | |Synchronous | ||
| − | | | + | |[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L523 RequestExtractEvidenceIMType] |
| − | |ResponseExtractEvidenceType | + | |[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L537 ResponseExtractEvidenceType] |
|- | |- | ||
| rowspan="2" |[https://github.com/de4a-wp5/xml-schemas/blob/iteration1/XSD/DO1-USI.xsd USI] | | rowspan="2" |[https://github.com/de4a-wp5/xml-schemas/blob/iteration1/XSD/DO1-USI.xsd USI] | ||
| Line 46: | Line 47: | ||
|XML REST | |XML REST | ||
|Synchronous | |Synchronous | ||
| − | | | + | |[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L509 RequestExtractEvidenceUSIType] |
| − | |ResponseErrorType | + | |[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L608 ResponseErrorType] |
|- | |- | ||
|RequestUserRedirection | |RequestUserRedirection | ||
| Line 53: | Line 54: | ||
|XML REST | |XML REST | ||
|Synchronous | |Synchronous | ||
| − | |RequestUserRedirectionType | + | |[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L595 RequestUserRedirectionType] |
| − | |HTTP Status 302 | + | |HTTP Status 302/303 (Http/1 Http/2) |
|- | |- | ||
| rowspan="3" |Data Requestor (Connector) | | rowspan="3" |Data Requestor (Connector) | ||
| [https://github.com/de4a-wp5/xml-schemas/blob/iteration1/XSD/DR-DT1-IDK.xsd IM/USI] | | [https://github.com/de4a-wp5/xml-schemas/blob/iteration1/XSD/DR-DT1-IDK.xsd IM/USI] | ||
| − | |Lookup | + | |Lookup Routing Information |
|/lookupRountingInformation | |/lookupRountingInformation | ||
|XML REST | |XML REST | ||
|Synchronous | |Synchronous | ||
| − | |RequestLookupRoutingInformationType | + | |[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L580 RequestLookupRoutingInformationType] |
| − | |ResponseLookupRoutingInformationType | + | |[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L589 ResponseLookupRoutingInformationType] |
|- | |- | ||
|[https://github.com/de4a-wp5/xml-schemas/blob/iteration1/XSD/DR-DE1-IM.xsd IM] | |[https://github.com/de4a-wp5/xml-schemas/blob/iteration1/XSD/DR-DE1-IM.xsd IM] | ||
| Line 70: | Line 71: | ||
|XML REST | |XML REST | ||
|Synchronous | |Synchronous | ||
| − | |RequestTransferEvidenceType | + | |[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L495 RequestTransferEvidenceType] |
| − | |ResponseTransferEvidenceType | + | |[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L546 ResponseTransferEvidenceType] |
|- | |- | ||
|[https://github.com/de4a-wp5/xml-schemas/blob/iteration1/XSD/DR-DE1-IM.xsd USI] | |[https://github.com/de4a-wp5/xml-schemas/blob/iteration1/XSD/DR-DE1-IM.xsd USI] | ||
| Line 78: | Line 79: | ||
|XML REST | |XML REST | ||
|Asynchronous | |Asynchronous | ||
| − | |RequestTransferEvidenceType | + | |[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L495 RequestTransferEvidenceType] |
| − | |ResponseErrorType | + | |[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L608 ResponseErrorType] |
|- | |- | ||
|Data Transferor (Connector) | |Data Transferor (Connector) | ||
| Line 87: | Line 88: | ||
|XML REST | |XML REST | ||
|Synchronous | |Synchronous | ||
| − | |RequestTransferEvidenceUSIDTType | + | |[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L477 RequestTransferEvidenceUSIDTType] |
| − | |ResponseErrorType | + | |[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L608 ResponseErrorType] |
|} | |} | ||
Latest revision as of 12:41, 4 October 2022
This page contains a description of the different software interfaces created for the DE4A project. The information provided can be used as a reference on the development and integration process to each pilot.
This page is only relevant for Iteration 1. The respective list for Iteration 2 can be found at Summary of software interfaces.
Available interfaces
| Component | Pattern | Service | Referenced API | Interface type | Communication | Input message | Output |
|---|---|---|---|---|---|---|---|
| Data Evaluator | USI | Forward evidence | /requestForwardEvidence | XML REST | Synchronous | RequestForwardEvidenceType | ACK |
| Response user redirection | /responseUserRedirection | XML REST | Synchronous | ResponseUserRedirectionType | HTTP Status 302/303 (Http/1 Http/2) | ||
| Data Owner | IM | Extract evidence IM | /requestExtractEvidenceIM | XML REST | Synchronous | RequestExtractEvidenceIMType | ResponseExtractEvidenceType |
| USI | Extract evidence USI | /requestExtractEvidenceUSI | XML REST | Synchronous | RequestExtractEvidenceUSIType | ResponseErrorType | |
| RequestUserRedirection | /requestUserRedirection | XML REST | Synchronous | RequestUserRedirectionType | HTTP Status 302/303 (Http/1 Http/2) | ||
| Data Requestor (Connector) | IM/USI | Lookup Routing Information | /lookupRountingInformation | XML REST | Synchronous | RequestLookupRoutingInformationType | ResponseLookupRoutingInformationType |
| IM | Request transfer evidence | /requestTransferEvidenceIM | XML REST | Synchronous | RequestTransferEvidenceType | ResponseTransferEvidenceType | |
| USI | Request transfer evidence USI | /requestTransferEvidenceUSI | XML REST | Asynchronous | RequestTransferEvidenceType | ResponseErrorType | |
| Data Transferor (Connector) | USI | Response transfer evidence USI | /requestTransferEvidenceUSIDT | XML REST | Synchronous | RequestTransferEvidenceUSIDTType | ResponseErrorType |