Difference between revisions of "Summary of software interfaces"

From DE4A
Jump to navigation Jump to search
Line 12: Line 12:
 
|-
 
|-
 
| rowspan="3" |Data Evaluator
 
| rowspan="3" |Data Evaluator
| rowspan="2" |[https://github.com/de4a-wp5/xml-schemas/blob/iteration1/XSD/DE1-USI.xsd USI]
+
| rowspan="2" |[https://wiki.de4a.eu/index.php/User-supported_intermediation_pattern_communication_diagram USI]
 
|* Forward evidence
 
|* Forward evidence
 
|/requestForwardEvidence
 
|/requestForwardEvidence
Line 36: Line 36:
 
|-
 
|-
 
| rowspan="5" |Data Owner
 
| rowspan="5" |Data Owner
|[https://github.com/de4a-wp5/xml-schemas/blob/iteration1/XSD/DT-DO1-IM.xsd IM]
+
|[https://wiki.de4a.eu/index.php/Intermediation_pattern_communication_diagram IM]
 
|Extract evidence IM
 
|Extract evidence IM
 
|/request/im/
 
|/request/im/
Line 44: Line 44:
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#ResponseExtractMultiEvidenceType ResponseExtractMultiEvidenceType]
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#ResponseExtractMultiEvidenceType ResponseExtractMultiEvidenceType]
 
|-
 
|-
| rowspan="2" |[https://github.com/de4a-wp5/xml-schemas/blob/iteration1/XSD/DO1-USI.xsd USI]
+
| rowspan="2" |[https://wiki.de4a.eu/index.php/User-supported_intermediation_pattern_communication_diagram USI]
 
|Extract evidence USI
 
|Extract evidence USI
 
|/request/usi/
 
|/request/usi/
Line 59: Line 59:
 
|HTTP Status 302/303 (Http/1 Http/2)
 
|HTTP Status 302/303 (Http/1 Http/2)
 
|-
 
|-
|LU
+
|[https://wiki.de4a.eu/index.php/Lookup_pattern_communication_diagram LU]
 
|Lookup
 
|Lookup
 
|/requestExtractMultiEvidenceLU
 
|/requestExtractMultiEvidenceLU
Line 76: Line 76:
 
|-
 
|-
 
| rowspan="5" |Data Requestor (Connector)
 
| rowspan="5" |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]
 +
[https://wiki.de4a.eu/index.php/User-supported_intermediation_pattern_communication_diagram USI]
 
|Lookup Routing Information
 
|Lookup Routing Information
 
|/service/ial/
 
|/service/ial/
Line 84: Line 85:
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#ResponseLookupRoutingInformationType 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://wiki.de4a.eu/index.php/Intermediation_pattern_communication_diagram IM]
 
|Extract evidence IM
 
|Extract evidence IM
 
|/request/im/
 
|/request/im/
Line 92: Line 93:
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#ResponseExtractMultiEvidenceType ResponseExtractMultiEvidenceType]
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#ResponseExtractMultiEvidenceType ResponseExtractMultiEvidenceType]
 
|-
 
|-
|[https://github.com/de4a-wp5/xml-schemas/blob/iteration1/XSD/DR-DE1-IM.xsd USI]
+
|[https://wiki.de4a.eu/index.php/User-supported_intermediation_pattern_communication_diagram USI]
 
|Extract evidence USI
 
|Extract evidence USI
 
|/request/usi/
 
|/request/usi/
Line 100: Line 101:
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#ResponseExtractMultiEvidenceType ResponseExtractMultiEvidenceType]
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#ResponseExtractMultiEvidenceType ResponseExtractMultiEvidenceType]
 
|-
 
|-
|LU
+
|[https://wiki.de4a.eu/index.php/Lookup_pattern_communication_diagram LU]
 
|Lookup
 
|Lookup
 
|/requestTransferEvidenceLU
 
|/requestTransferEvidenceLU
Line 117: Line 118:
 
|-
 
|-
 
| rowspan="4" |Data Transferor (Connector)
 
| rowspan="4" |Data Transferor (Connector)
|[https://github.com/de4a-wp5/xml-schemas/blob/iteration1/XSD/DT1-USI.xsd USI]
+
|[https://wiki.de4a.eu/index.php/User-supported_intermediation_pattern_communication_diagram USI]
IM
+
[https://wiki.de4a.eu/index.php/Intermediation_pattern_communication_diagram IM]
  
LU
+
[https://wiki.de4a.eu/index.php/Lookup_pattern_communication_diagram LU]
 
|Response transfer evidence
 
|Response transfer evidence
 
|/responseTransferEvidence
 
|/responseTransferEvidence
Line 128: Line 129:
 
|[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]
 
|-
 
|-
|USI
+
|[https://wiki.de4a.eu/index.php/User-supported_intermediation_pattern_communication_diagram USI]
 
|* Response user redirection
 
|* Response user redirection
 
|/usiRedirectUser
 
|/usiRedirectUser

Revision as of 12:35, 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