Difference between revisions of "Summary of software interfaces"
Jump to navigation
Jump to search
Hugo.berdon (talk | contribs) |
Hugo.berdon (talk | contribs) |
||
| Line 11: | Line 11: | ||
!Output | !Output | ||
|- | |- | ||
| − | | rowspan=" | + | | rowspan="3" |Data Evaluator |
| rowspan="2" |[https://github.com/de4a-wp5/xml-schemas/blob/iteration1/XSD/DE1-USI.xsd USI] | | rowspan="2" |[https://github.com/de4a-wp5/xml-schemas/blob/iteration1/XSD/DE1-USI.xsd USI] | ||
|* Forward evidence | |* Forward evidence | ||
| Line 27: | Line 27: | ||
|HTTP Status 302/303 (Http/1 Http/2) | |HTTP Status 302/303 (Http/1 Http/2) | ||
|- | |- | ||
| − | | rowspan=" | + | |S&N |
| + | |Event Notificacion | ||
| + | |/notificationEvent | ||
| + | |XML REST | ||
| + | |Asynchronous | ||
| + | |EventNotificationType | ||
| + | | | ||
| + | |- | ||
| + | | rowspan="5" |Data Owner | ||
|[https://github.com/de4a-wp5/xml-schemas/blob/iteration1/XSD/DT-DO1-IM.xsd IM] | |[https://github.com/de4a-wp5/xml-schemas/blob/iteration1/XSD/DT-DO1-IM.xsd IM] | ||
|Extract evidence IM | |Extract evidence IM | ||
| Line 51: | Line 59: | ||
|HTTP Status 302/303 (Http/1 Http/2) | |HTTP Status 302/303 (Http/1 Http/2) | ||
|- | |- | ||
| − | | rowspan=" | + | |LU |
| − | | [https://github.com/de4a-wp5/xml-schemas/blob/iteration1/XSD/DR-DT1-IDK.xsd IM/USI] | + | |Lookup |
| + | |/requestExtractMultiEvidenceLU | ||
| + | |XML REST | ||
| + | |Asynchronous | ||
| + | |RequestExtractMultiEvidenceLUType | ||
| + | | | ||
| + | |- | ||
| + | |S&N | ||
| + | |Event Subscription | ||
| + | |/requestEventSubscription | ||
| + | |XML REST | ||
| + | |Asynchronous | ||
| + | |RequestEventSubscriptionType | ||
| + | | | ||
| + | |- | ||
| + | | rowspan="5" |Data Requestor (Connector) | ||
| + | |[https://github.com/de4a-wp5/xml-schemas/blob/iteration1/XSD/DR-DT1-IDK.xsd IM/USI] | ||
|Lookup Routing Information | |Lookup Routing Information | ||
|/service/ial/ | |/service/ial/ | ||
| Line 76: | Line 100: | ||
|[https://wiki.de4a.eu/index.php/Data_Dictionary#ResponseExtractMultiEvidenceType ResponseExtractMultiEvidenceType] | |[https://wiki.de4a.eu/index.php/Data_Dictionary#ResponseExtractMultiEvidenceType ResponseExtractMultiEvidenceType] | ||
|- | |- | ||
| − | |Data Transferor (Connector) | + | |LU |
| + | |Lookup | ||
| + | |/requestTransferEvidenceLU | ||
| + | |XML REST | ||
| + | |Asynchronous | ||
| + | |RequestExtractMultiEvidenceLUType | ||
| + | | | ||
| + | |- | ||
| + | |S&N | ||
| + | |Event Subscription | ||
| + | |/requestEventSubscription | ||
| + | |XML REST | ||
| + | |Asynchronous | ||
| + | |RequestEventSubscriptionType | ||
| + | | | ||
| + | |- | ||
| + | | rowspan="4" |Data Transferor (Connector) | ||
|[https://github.com/de4a-wp5/xml-schemas/blob/iteration1/XSD/DT1-USI.xsd USI] | |[https://github.com/de4a-wp5/xml-schemas/blob/iteration1/XSD/DT1-USI.xsd USI] | ||
| − | |Response transfer evidence | + | IM |
| − | |/ | + | |
| + | LU | ||
| + | |Response transfer evidence | ||
| + | |/responseTransferEvidence | ||
|XML REST | |XML REST | ||
|Asynchronous | |Asynchronous | ||
| − | |[https:// | + | |ResponseExtractMultiEvidenceType |
| − | |[https://wiki.de4a.eu/index.php/Data_Dictionary# | + | |[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L191 ACK] |
| + | |- | ||
| + | |USI | ||
| + | |* Response user redirection | ||
| + | |/usiRedirectUser | ||
| + | |XML REST | ||
| + | |Asynchronous | ||
| + | |[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L601 ResponseUserRedirectionType] | ||
| + | |[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L191 ACK] | ||
| + | |- | ||
| + | |S&N | ||
| + | |Event Subscription | ||
| + | |/responseEventSubscription | ||
| + | |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 | ||
| + | |Event Notificacion | ||
| + | |/notificationEvent | ||
| + | |XML REST | ||
| + | |Asynchronous | ||
| + | |EventNotificationType | ||
| + | | | ||
|} | |} | ||
Revision as of 10:36, 23 May 2022
Available interfaces
| Component | Pattern | Service | Referenced API | Interface type | Communication | Input message | Output |
|---|---|---|---|---|---|---|---|
| Data Evaluator | USI | * Forward evidence | /requestForwardEvidence | XML REST | Asynchronous | ResponseExtractMultiEvidenceType | ACK |
| * Response user redirection | /responseUserRedirection | XML REST | Asynchronous | ResponseUserRedirectionType | HTTP Status 302/303 (Http/1 Http/2) | ||
| S&N | Event Notificacion | /notificationEvent | XML REST | Asynchronous | EventNotificationType | ||
| Data Owner | IM | Extract evidence IM | /request/im/ | XML REST | Asynchronous | RequestExtractMultiEvidenceIMType | ResponseExtractMultiEvidenceType |
| USI | Extract evidence USI | /request/usi/ | XML REST | Asynchronous | RequestExtractMultiEvidenceUSIType | ResponseExtractMultiEvidenceType | |
| RequestUserRedirection | /requestUserRedirection | XML REST | Asynchronous | RedirectUserType | HTTP Status 302/303 (Http/1 Http/2) | ||
| LU | Lookup | /requestExtractMultiEvidenceLU | XML REST | Asynchronous | RequestExtractMultiEvidenceLUType | ||
| S&N | Event Subscription | /requestEventSubscription | XML REST | Asynchronous | RequestEventSubscriptionType | ||
| Data Requestor (Connector) | IM/USI | Lookup Routing Information | /service/ial/ | XML REST | Asynchronous | 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 | ResponseExtractMultiEvidenceType | |
| USI | Extract evidence USI | /request/usi/ | XML REST | Asynchronous | RequestExtractMultiEvidenceUSIType | ResponseExtractMultiEvidenceType | |
| LU | Lookup | /requestTransferEvidenceLU | XML REST | Asynchronous | RequestExtractMultiEvidenceLUType | ||
| S&N | Event Subscription | /requestEventSubscription | XML REST | Asynchronous | RequestEventSubscriptionType | ||
| Data Transferor (Connector) | USI
IM LU |
Response transfer evidence | /responseTransferEvidence | XML REST | Asynchronous | ResponseExtractMultiEvidenceType | ACK |
| USI | * Response user redirection | /usiRedirectUser | XML REST | Asynchronous | ResponseUserRedirectionType | ACK | |
| S&N | Event Subscription | /responseEventSubscription | XML REST | Asynchronous | ResponseEventSubscriptionType | ACK | |
| S&N | Event Notificacion | /notificationEvent | XML REST | Asynchronous | EventNotificationType |