Difference between revisions of "Description of the software interfaces"
Jump to navigation
Jump to search
| Line 5: | Line 5: | ||
== Available interfaces == | == Available interfaces == | ||
{| class="wikitable" | {| class="wikitable" | ||
| − | |+DE4A Components interfaces description | + | |+DE4A Components interfaces description (Iteration 1) |
!Component | !Component | ||
| − | |||
!Pattern | !Pattern | ||
| + | (xsd ref.) | ||
!Service | !Service | ||
!Referenced API | !Referenced API | ||
| Line 16: | Line 16: | ||
!Output | !Output | ||
|- | |- | ||
| − | | rowspan=" | + | | rowspan="2" |Data Evaluator |
| − | + | | rowspan="2" |[https://github.com/de4a-wp5/xml-schemas/blob/iteration1/XSD/DE1-USI.xsd USI] | |
| − | | rowspan=" | ||
|Forward evidence | |Forward evidence | ||
|/requestForwardEvidence | |/requestForwardEvidence | ||
| Line 26: | Line 25: | ||
|ACK | |ACK | ||
|- | |- | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|Response user redirection | |Response user redirection | ||
|/responseUserRedirection | |/responseUserRedirection | ||
| Line 42: | Line 32: | ||
|HTTP Status 302/303 (Http/1 Http/2) | |HTTP Status 302/303 (Http/1 Http/2) | ||
|- | |- | ||
| − | | rowspan=" | + | | rowspan="3" |Data Owner |
| − | | | + | |[https://github.com/de4a-wp5/xml-schemas/blob/iteration1/XSD/DT-DO1-IM.xsd IM] |
| − | |||
|Extract evidence IM | |Extract evidence IM | ||
|/requestExtractEvidenceIM | |/requestExtractEvidenceIM | ||
| Line 52: | Line 41: | ||
|ResponseExtractEvidenceType | |ResponseExtractEvidenceType | ||
|- | |- | ||
| − | + | | rowspan="2" |[https://github.com/de4a-wp5/xml-schemas/blob/iteration1/XSD/DO1-USI.xsd USI] | |
| − | | rowspan=" | ||
|Extract evidence USI | |Extract evidence USI | ||
|/requestExtractEvidenceUSI | |/requestExtractEvidenceUSI | ||
| Line 61: | Line 49: | ||
|ResponseErrorType | |ResponseErrorType | ||
|- | |- | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|RequestUserRedirection | |RequestUserRedirection | ||
|/requestUserRedirection | |/requestUserRedirection | ||
| Line 78: | Line 57: | ||
|- | |- | ||
| 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] |
| − | |||
|Lookup Rounting Information | |Lookup Rounting Information | ||
|/lookupRountingInformation | |/lookupRountingInformation | ||
| Line 87: | Line 65: | ||
|ResponseLookupRoutingInformationType | |ResponseLookupRoutingInformationType | ||
|- | |- | ||
| − | | | + | |[https://github.com/de4a-wp5/xml-schemas/blob/iteration1/XSD/DR-DE1-IM.xsd IM] |
| − | |||
|Request transfer evidence | |Request transfer evidence | ||
|/requestTransferEvidenceIM | |/requestTransferEvidenceIM | ||
| Line 96: | Line 73: | ||
|ResponseTransferEvidenceType | |ResponseTransferEvidenceType | ||
|- | |- | ||
| − | | | + | |[https://github.com/de4a-wp5/xml-schemas/blob/iteration1/XSD/DR-DE1-IM.xsd USI] |
| − | |||
|Request transfer evidence USI | |Request transfer evidence USI | ||
|/requestTransferEvidenceUSI | |/requestTransferEvidenceUSI | ||
| Line 106: | Line 82: | ||
|- | |- | ||
|Data Transferor (Connector) | |Data Transferor (Connector) | ||
| − | | | + | |[https://github.com/de4a-wp5/xml-schemas/blob/iteration1/XSD/DT1-USI.xsd USI] |
| − | |||
|Response transfer evidence USI | |Response transfer evidence USI | ||
|/requestTransferEvidenceUSIDT | |/requestTransferEvidenceUSIDT | ||
Revision as of 15:56, 22 February 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.
Available interfaces
| Component | Pattern
(xsd ref.) |
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 | RequestExtractEvidence | ResponseExtractEvidenceType |
| USI | Extract evidence USI | /requestExtractEvidenceUSI | XML REST | Synchronous | RequestExtractEvidence | ResponseErrorType | |
| RequestUserRedirection | /requestUserRedirection | XML REST | Synchronous | RequestUserRedirectionType | HTTP Status 302 | ||
| Data Requestor (Connector) | IM/USI | Lookup Rounting 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 |