Difference between revisions of "Summary of software interfaces"
Jump to navigation
Jump to search
Hugo.berdon (talk | contribs) |
|||
| (5 intermediate revisions by 4 users not shown) | |||
| Line 11: | Line 11: | ||
!Output | !Output | ||
|- | |- | ||
| − | | rowspan=" | + | | rowspan="4" |Data Evaluator |
| − | + | |[https://wiki.de4a.eu/index.php/User-supported_intermediation_pattern_communication_diagram USI] | |
| − | | | + | [https://wiki.de4a.eu/index.php/Intermediation_pattern_communication_diagram IM] |
| − | |/ | + | |
| + | [https://wiki.de4a.eu/index.php/Lookup_pattern_communication_diagram LU] | ||
| + | |Response transfer evidence | ||
| + | |/response/evidence | ||
|XML REST | |XML REST | ||
|Asynchronous | |Asynchronous | ||
| Line 20: | Line 23: | ||
|[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L191 ACK] | |[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L191 ACK] | ||
|- | |- | ||
| − | | | + | |[https://wiki.de4a.eu/index.php/User-supported_intermediation_pattern_communication_diagram USI] |
| − | |/ | + | |Response user redirection |
| + | |/response/usi/redirectUser | ||
|XML REST | |XML REST | ||
|Asynchronous | |Asynchronous | ||
|[https://wiki.de4a.eu/index.php/Data_Dictionary#RedirectUserType RedirectUserType] | |[https://wiki.de4a.eu/index.php/Data_Dictionary#RedirectUserType RedirectUserType] | ||
|HTTP Status 302/303 (Http/1 Http/2) | |HTTP Status 302/303 (Http/1 Http/2) | ||
| + | |- | ||
| + | |S&N | ||
| + | |Event Subscription | ||
| + | |/response/subscription | ||
| + | |XML REST | ||
| + | |Asynchronous | ||
| + | |[https://wiki.de4a.eu/index.php/Data_Dictionary#ResponseEventSubscriptionType ResponseEventSubscriptionType] | ||
| + | |[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L191 ACK] | ||
|- | |- | ||
|S&N | |S&N | ||
| Line 33: | Line 45: | ||
|Asynchronous | |Asynchronous | ||
|[https://wiki.de4a.eu/index.php/Data_Dictionary#EventNotificationType EventNotificationType] | |[https://wiki.de4a.eu/index.php/Data_Dictionary#EventNotificationType EventNotificationType] | ||
| − | |[https:// | + | |[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L191 ACK] |
|- | |- | ||
| − | | rowspan=" | + | | rowspan="4" |Data Owner |
|[https://wiki.de4a.eu/index.php/Intermediation_pattern_communication_diagram IM] | |[https://wiki.de4a.eu/index.php/Intermediation_pattern_communication_diagram IM] | ||
|Extract evidence IM | |Extract evidence IM | ||
| Line 42: | Line 54: | ||
|Asynchronous | |Asynchronous | ||
|[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestExtractMultiEvidenceIMType RequestExtractMultiEvidenceIMType] | |[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestExtractMultiEvidenceIMType RequestExtractMultiEvidenceIMType] | ||
| − | |[https:// | + | |[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L191 ACK] |
|- | |- | ||
| − | + | |[https://wiki.de4a.eu/index.php/User-supported_intermediation_pattern_communication_diagram USI] | |
|Extract evidence USI | |Extract evidence USI | ||
|/request/usi/ | |/request/usi/ | ||
| Line 50: | Line 62: | ||
|Asynchronous | |Asynchronous | ||
|[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestExtractMultiEvidenceUSIType RequestExtractMultiEvidenceUSIType] | |[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestExtractMultiEvidenceUSIType RequestExtractMultiEvidenceUSIType] | ||
| − | |[https:// | + | |[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L191 ACK] |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|- | |- | ||
|[https://wiki.de4a.eu/index.php/Lookup_pattern_communication_diagram LU] | |[https://wiki.de4a.eu/index.php/Lookup_pattern_communication_diagram LU] | ||
| Line 65: | Line 70: | ||
|Asynchronous | |Asynchronous | ||
|[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestExtractMultiEvidenceLUType RequestExtractMultiEvidenceLUType] | |[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestExtractMultiEvidenceLUType RequestExtractMultiEvidenceLUType] | ||
| − | |[https:// | + | |[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L191 ACK] |
|- | |- | ||
|S&N | |S&N | ||
| Line 73: | Line 78: | ||
|Asynchronous | |Asynchronous | ||
|[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestEventSubscriptionType RequestEventSubscriptionType] | |[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestEventSubscriptionType RequestEventSubscriptionType] | ||
| − | |[https:// | + | |[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L191 ACK] |
|- | |- | ||
| rowspan="5" |Data Requestor (Connector) | | rowspan="5" |Data Requestor (Connector) | ||
| − | |[https:// | + | |[https://wiki.de4a.eu/index.php/Intermediation_pattern_communication_diagram IM] |
[https://wiki.de4a.eu/index.php/User-supported_intermediation_pattern_communication_diagram USI] | [https://wiki.de4a.eu/index.php/User-supported_intermediation_pattern_communication_diagram USI] | ||
|Lookup Routing Information | |Lookup Routing Information | ||
|/service/ial/ | |/service/ial/ | ||
|XML REST | |XML REST | ||
| − | | | + | |Synchronous |
|All the necessary parameters will be in the URL. It will be a comma-separated canonical evidence identifier collection (up to 20) followed by the AtuCode. | |All the necessary parameters will be in the URL. It will be a comma-separated canonical evidence identifier collection (up to 20) followed by the AtuCode. | ||
|[https://wiki.de4a.eu/index.php/Data_Dictionary#ResponseLookupRoutingInformationType ResponseLookupRoutingInformationType] | |[https://wiki.de4a.eu/index.php/Data_Dictionary#ResponseLookupRoutingInformationType ResponseLookupRoutingInformationType] | ||
| Line 91: | Line 96: | ||
|Asynchronous | |Asynchronous | ||
|[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestExtractMultiEvidenceIMType RequestExtractMultiEvidenceIMType] | |[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestExtractMultiEvidenceIMType RequestExtractMultiEvidenceIMType] | ||
| − | |[https:// | + | |[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L191 ACK] |
|- | |- | ||
|[https://wiki.de4a.eu/index.php/User-supported_intermediation_pattern_communication_diagram USI] | |[https://wiki.de4a.eu/index.php/User-supported_intermediation_pattern_communication_diagram USI] | ||
| Line 99: | Line 104: | ||
|Asynchronous | |Asynchronous | ||
|[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestExtractMultiEvidenceUSIType RequestExtractMultiEvidenceUSIType] | |[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestExtractMultiEvidenceUSIType RequestExtractMultiEvidenceUSIType] | ||
| − | |[https:// | + | |[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L191 ACK] |
|- | |- | ||
|[https://wiki.de4a.eu/index.php/Lookup_pattern_communication_diagram LU] | |[https://wiki.de4a.eu/index.php/Lookup_pattern_communication_diagram LU] | ||
| Line 107: | Line 112: | ||
|Asynchronous | |Asynchronous | ||
|[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestExtractMultiEvidenceLUType RequestExtractMultiEvidenceLUType] | |[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestExtractMultiEvidenceLUType RequestExtractMultiEvidenceLUType] | ||
| − | |[https:// | + | |[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L191 ACK] |
|- | |- | ||
|S&N | |S&N | ||
|Event Subscription | |Event Subscription | ||
| − | |/ | + | |/request/subscription |
|XML REST | |XML REST | ||
|Asynchronous | |Asynchronous | ||
|[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestEventSubscriptionType RequestEventSubscriptionType] | |[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestEventSubscriptionType RequestEventSubscriptionType] | ||
| − | |[https:// | + | |[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L191 ACK] |
|- | |- | ||
| rowspan="4" |Data Transferor (Connector) | | rowspan="4" |Data Transferor (Connector) | ||
| Line 123: | Line 128: | ||
[https://wiki.de4a.eu/index.php/Lookup_pattern_communication_diagram LU] | [https://wiki.de4a.eu/index.php/Lookup_pattern_communication_diagram LU] | ||
|Response transfer evidence | |Response transfer evidence | ||
| − | |/ | + | |/response/evidence |
|XML REST | |XML REST | ||
|Asynchronous | |Asynchronous | ||
| Line 130: | Line 135: | ||
|- | |- | ||
|[https://wiki.de4a.eu/index.php/User-supported_intermediation_pattern_communication_diagram USI] | |[https://wiki.de4a.eu/index.php/User-supported_intermediation_pattern_communication_diagram USI] | ||
| − | | | + | |Response user redirection |
| − | |/ | + | |/response/usi/redirectUser |
|XML REST | |XML REST | ||
|Asynchronous | |Asynchronous | ||
| Line 139: | Line 144: | ||
|S&N | |S&N | ||
|Event Subscription | |Event Subscription | ||
| − | |/ | + | |/response/subscription |
|XML REST | |XML REST | ||
|Asynchronous | |Asynchronous | ||
| Line 147: | Line 152: | ||
|S&N | |S&N | ||
|Event Notificacion | |Event Notificacion | ||
| − | |/ | + | |/event/notification |
|XML REST | |XML REST | ||
|Asynchronous | |Asynchronous | ||
|[https://wiki.de4a.eu/index.php/Data_Dictionary#EventNotificationType EventNotificationType] | |[https://wiki.de4a.eu/index.php/Data_Dictionary#EventNotificationType EventNotificationType] | ||
| − | |[https:// | + | |[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L191 ACK] |
|} | |} | ||
Latest revision as of 14:10, 20 December 2022
Available interfaces
| Component | Pattern | Service | Referenced API | Interface type | Communication | Input message | Output |
|---|---|---|---|---|---|---|---|
| Data Evaluator | USI | Response transfer evidence | /response/evidence | XML REST | Asynchronous | ResponseExtractMultiEvidenceType | ACK |
| USI | Response user redirection | /response/usi/redirectUser | XML REST | Asynchronous | RedirectUserType | HTTP Status 302/303 (Http/1 Http/2) | |
| S&N | Event Subscription | /response/subscription | XML REST | Asynchronous | ResponseEventSubscriptionType | ACK | |
| S&N | Event Notificacion | /notificationEvent | XML REST | Asynchronous | EventNotificationType | ACK | |
| Data Owner | IM | Extract evidence IM | /request/im/ | XML REST | Asynchronous | RequestExtractMultiEvidenceIMType | ACK |
| USI | Extract evidence USI | /request/usi/ | XML REST | Asynchronous | RequestExtractMultiEvidenceUSIType | ACK | |
| LU | Lookup | /requestExtractMultiEvidenceLU | XML REST | Asynchronous | RequestExtractMultiEvidenceLUType | ACK | |
| S&N | Event Subscription | /requestEventSubscription | XML REST | Asynchronous | RequestEventSubscriptionType | ACK | |
| Data Requestor (Connector) | IM | Lookup Routing Information | /service/ial/ | XML REST | Synchronous | All the necessary parameters will be in the URL. It will be a comma-separated canonical evidence identifier collection (up to 20) followed by the AtuCode. | ResponseLookupRoutingInformationType |
| IM | Extract evidence IM | /request/im/ | XML REST | Asynchronous | RequestExtractMultiEvidenceIMType | ACK | |
| USI | Extract evidence USI | /request/usi/ | XML REST | Asynchronous | RequestExtractMultiEvidenceUSIType | ACK | |
| LU | Lookup | /requestTransferEvidenceLU | XML REST | Asynchronous | RequestExtractMultiEvidenceLUType | ACK | |
| S&N | Event Subscription | /request/subscription | XML REST | Asynchronous | RequestEventSubscriptionType | ACK | |
| Data Transferor (Connector) | USI | Response transfer evidence | /response/evidence | XML REST | Asynchronous | ResponseExtractMultiEvidenceType | ACK |
| USI | Response user redirection | /response/usi/redirectUser | XML REST | Asynchronous | RedirectUserType | ACK | |
| S&N | Event Subscription | /response/subscription | XML REST | Asynchronous | ResponseEventSubscriptionType | ACK | |
| S&N | Event Notificacion | /event/notification | XML REST | Asynchronous | EventNotificationType | ACK |