active archive – document retrieval via REST service
With version 3.6 of our active archive services, we have expanded our extensive service portfolio for you.
With this version, it is even easier for you, as a customer of our archive service, to retrieve document data in a safe and high-performance way and to link our service even more closely to your in-house systems.
Document retrieval without consignment data? – No problem
From this version, it is also easy to retrieve your document data interface-based without you having to submit the corresponding consignment data to us beforehand. The reference number is sufficient.
Please note that in this case you will need to carry out additional checks on your side before passing on the documents to third parties. We can only carry out an authorization check on the basis of the archiving company/depot.
(1) The registration
The registration at the REST service is done by standard HTTP-BASIC-AUTH operation. (https://de.wikipedia.org/wiki/HTTP-Authentifizierung#Basic_Authentication). Simply use your login credentials, which you have previously used to access the archive. If you don’t have a user yet, you will receive an account with our support as an archive customer.
The HTTP header with the BASIC-AUTH login credentials must be sent with each request. There is no long-running session on the system.
(2.1) Search for documents by consignment data
Document retrieval can be made using terms of the associated consignment. The prerequisite for this is that the consignement data are stored for archiving in the central database. This is the case, for example, with all our active tracking ng customers.
GET
https://dms.active-logistics.com/optarchive/rest/v1/consignment/documents?consignmentYear=2019&docType=ALL&senderDepot=1234&consignmentNumberSender=1234567890123
Concerning the parameters for the consignment, you can use either the parameters of the sending partner (alternative A) or the parameters of the receiving partner (alternative B), but one of the two pairs of parameters must be present.
|
Parameter |
Description |
|
|
consigmentYear |
The consignment year in format YYYY |
|
|
consignmentNumberSender |
Consignment number of the sending partner |
Alternative A |
|
senderDepot |
Depot number of the sending partner |
Alternative A |
|
consignmentNumberRecipient |
Consignment number of the receiving partner |
Alternative B |
|
recipientDepot |
Depot number of the receiving partner |
Alternative B |
|
docType |
Desired document types ALL – Alle documents POD – Only proofs of delivery DAMAGE – Only documents concerning damages DELIVERYNOTE – Only delivery notes |
|
As a result of the query, you will receive a list in JSON format with the appropriate documents. For each document, you will receive the ID to retrieve the document (step (3)).
| [ { “docType”: “POD”, “docID”: “2019012809513941200087139FEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEE” } ] |
(2.2) Search for documents by reference number
Alternatively, a document can be searched using the reference number. The reference term will be agreed when you set up active archive. As a rule, it is the consignment number of the receiving partner of the shipment.
GET
https://dms.active-logistics.com/optarchive/rest/v1/documents?searchTerm=12345678&year=2019&depot=1234&docType=POD
|
Parameter |
Beschreibung |
|
searchTerm |
The reference number. Usually the consignment number of the receiving partner. |
|
year |
The archiving year in format YYYY |
|
depot |
Depot number of the archiving company. |
|
docType |
Desired document types ALL – All documents POD – Only proofs of delivery DAMAGE – Only documents concerning damages DELIVERYNOTE – Only delivery notes |
As a result of the query, you will receive a list in JSON format with the appropriate documents. For each document, you will receive the ID to retrieve the document (step (3)).
| [ { “docType”: “POD”, “docID”: “2019012809513941200087139FEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEE” } ] |
(3) Retrieve documents by docID
The docID from step 2.1 resp. 2.2 can then be used to retrieve the documents. To do this, simply attach the docID to the URL. Parameters are not necessary.
GET
https://dms.active-logistics.com/optarchive/rest/v1/documents/2019012809513941200087139FEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEE
In response to the request, you will directly receive the data stream of the document.