Difference between revisions of "Summary of software interfaces"

From DE4A
Jump to navigation Jump to search
Line 33: Line 33:
 
|Asynchronous
 
|Asynchronous
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#EventNotificationType EventNotificationType]
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#EventNotificationType EventNotificationType]
|EventNotificationType
+
|[https://wiki.de4a.eu/index.php/Data_Dictionary#EventNotificationType EventNotificationType]
 
|-
 
|-
 
| rowspan="5" |Data Owner
 
| rowspan="5" |Data Owner
Line 64: Line 64:
 
|XML REST
 
|XML REST
 
|Asynchronous
 
|Asynchronous
|RequestExtractMultiEvidenceLUType
+
|[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestExtractMultiEvidenceLUType RequestExtractMultiEvidenceLUType]
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#ResponseExtractMultiEvidenceType ResponseExtractMultiEvidenceType]
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#ResponseExtractMultiEvidenceType ResponseExtractMultiEvidenceType]
 
|-
 
|-
Line 72: Line 72:
 
|XML REST
 
|XML REST
 
|Asynchronous
 
|Asynchronous
|RequestEventSubscriptionType
+
|[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestEventSubscriptionType RequestEventSubscriptionType]
|ResponseEventSubscriptionType
+
|[https://wiki.de4a.eu/index.php/Data_Dictionary#ResponseEventSubscriptionType ResponseEventSubscriptionType]
 
|-
 
|-
 
| rowspan="5" |Data Requestor (Connector)
 
| rowspan="5" |Data Requestor (Connector)
Line 82: Line 82:
 
|Asynchronous
 
|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.
 
|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://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L589 ResponseLookupRoutingInformationType]
+
|[https://wiki.de4a.eu/index.php/Data_Dictionary#ResponseLookupRoutingInformationType 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 105: Line 105:
 
|XML REST
 
|XML REST
 
|Asynchronous
 
|Asynchronous
|RequestExtractMultiEvidenceLUType
+
|[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestExtractMultiEvidenceLUType RequestExtractMultiEvidenceLUType]
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#ResponseExtractMultiEvidenceType ResponseExtractMultiEvidenceType]
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#ResponseExtractMultiEvidenceType ResponseExtractMultiEvidenceType]
 
|-
 
|-
Line 113: Line 113:
 
|XML REST
 
|XML REST
 
|Asynchronous
 
|Asynchronous
|RequestEventSubscriptionType
+
|[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestEventSubscriptionType RequestEventSubscriptionType]
|ResponseEventSubscriptionType
+
|[https://wiki.de4a.eu/index.php/Data_Dictionary#ResponseEventSubscriptionType ResponseEventSubscriptionType]
 
|-
 
|-
 
| rowspan="4" |Data Transferor (Connector)
 
| rowspan="4" |Data Transferor (Connector)
Line 125: Line 125:
 
|XML REST
 
|XML REST
 
|Asynchronous
 
|Asynchronous
|ResponseExtractMultiEvidenceType
+
|[https://wiki.de4a.eu/index.php/Data_Dictionary#ResponseExtractMultiEvidenceType ResponseExtractMultiEvidenceType]
 
|[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]
 
|-
 
|-
Line 150: Line 150:
 
|Asynchronous
 
|Asynchronous
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#EventNotificationType EventNotificationType]
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#EventNotificationType EventNotificationType]
|EventNotificationType
+
|[https://wiki.de4a.eu/index.php/Data_Dictionary#EventNotificationType EventNotificationType]
 
|}
 
|}

Revision as of 12:03, 23 May 2022

Available interfaces

DE4A Components interfaces description (Iteration 2)
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 RedirectUserType HTTP Status 302/303 (Http/1 Http/2)
S&N Event Notificacion /notificationEvent XML REST Asynchronous EventNotificationType 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 ResponseExtractMultiEvidenceType
S&N Event Subscription /requestEventSubscription XML REST Asynchronous RequestEventSubscriptionType ResponseEventSubscriptionType
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 ResponseExtractMultiEvidenceType
S&N Event Subscription /requestEventSubscription XML REST Asynchronous RequestEventSubscriptionType ResponseEventSubscriptionType
Data Transferor (Connector) USI

IM

LU

Response transfer evidence /responseTransferEvidence XML REST Asynchronous ResponseExtractMultiEvidenceType ACK
USI * Response user redirection /usiRedirectUser XML REST Asynchronous RedirectUserType ACK
S&N Event Subscription /responseEventSubscription XML REST Asynchronous ResponseEventSubscriptionType ACK
S&N Event Notificacion /notificationEvent XML REST Asynchronous EventNotificationType EventNotificationType