...
HWS are a secure, highly-available, reliable, HTTPS/REST API-based protocol for exchanging data exchanging data with the Hague System, based on an asymmetric key signature that is part of the Financial-grade API Security Profile 1.0. They can be used for sending or receiving data through a through a set of endpoints that require secure authentication, as explained in details in the documentation below.
HWS is the preferred Hague data exchange channel.
...
For all these reasons, Offices already exchanging data with Hague via EDI are encouraged to migrate to the HWS.
Click here to discover to find out how to transition from EDI to HWS.
...
Office to IB: importing decisions and indirect applications
As detailed at Office to IB, data transmitted from an IPO to the Hague System is ZIP files containing XML bibliographic data and document/images, called packagesSending applications and decisions to Hague is done through a POST request, where the payload is the import package (see here).
The workflow for shipping packages to Hague is the following:
- An import ID per package is returned on success, meaning that that the import package was received and will be processed by the IB.
- This package import ID can later be used to retrieve the Service Request Number (GET request/import), and in turn the SRN can be used to retrieve the request status (GET request).
The above sequence diagram pictures the first 3 HWS endpoint calls listed earlier in this document:
- Send decisions or indirect applications: POST /request
- response: import status + import ID
- Check import status: GET /request/import/{importid}
- response: import status + SRN
- Query processing status: GET /request/{ServiceRequestId}
- response: SR status
Those are described in details in the HWS API guide.
...