Skip to Content
Last modified by Nico Lemaire on 2025/05/06 15:49
From version 26.5
edited by Nico Lemaire
on 2025/05/06 15:49
Change comment: There is no comment for this version
To version 15.1
edited by Robin Huisman
on 2024/04/05 16:15
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Setting up API communication by REST services with TerraIndex for laboratories
1 +Setting up Lab communication by REST services with TerraIndex
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.NicoLemaire
1 +XWiki.RobinHuisman
Content
... ... @@ -3,31 +3,21 @@
3 3  
4 4  = Digital Lab Exchange process =
5 5  
6 -The flow diagram gives a small overview of what the data flow of a lab assignment is.
7 -Every block shows a step of the lab assignment process. From top to bottom these steps are:
6 +The flow diagram gives a small overview of what the data flow of a lab assignment is. Every green block shows a step of the lab assignment process. From top to bottom these steps are:
8 8  
9 9  1. Showing the laboratory and all the analyses that can be requested as an option to the user.
10 10  1. The user creating a lab assignment and sending it to the lab trough TerraIndex.
11 -1. The lab delivering the analysis results back to the TerraIndex.
10 +1. The lab sending the analysis results back to the TerraIndex.
12 12  
13 -[[attach:Lab exchange.svg||rel="noopener noreferrer" target="_blank"]] [[attach:Lab exchange.txt||rel="noopener noreferrer" target="_blank"]]
12 +[[attach:Lab exchange.svg||rel=" noopener noreferrer" target="_blank"]]
14 14  
15 15  [[image:1712326465681-980.png||height="315" width="630"]]
16 16  
17 -
18 18  [[image:1712326492306-381.png||height="781" width="635"]]
19 19  
20 -~==> TODO; add option to confirm order based on the Order price PDF
21 -
22 -
23 23  [[image:1712326520488-924.png||height="312" width="632"]]
24 24  
25 -~==> TODO; add option download labcertificate
26 -
27 27  (% element-id="1884" %)
28 -= =
29 -
30 -(% element-id="1884" %)
31 31  = (% element-id="1883" %)Firewall IP-Addresses of TerraIndex(%%) =
32 32  
33 33  (% element-id="1882" %)
... ... @@ -34,41 +34,29 @@
34 34  Our IP-addresses:
35 35  
36 36  (% element-id="1881" %)
37 -__**inbound [[Web.terraindex.com>>url:http://Web.terraindex.com||element-id="1880"]]**__
27 +inbound [[Web.terraindex.com>>url:http://Web.terraindex.com||element-id="1880"]]
38 38  137.116.199.164
39 39  
40 40  (% element-id="1878" %)
41 -__**outbound [[Test.terraindex.com>>url:http://Test.terraindex.com||element-id="1877"]]**__
31 +outbound [[Test.terraindex.com>>url:http://Test.terraindex.com||element-id="1877"]]
42 42  104.45.9.128
43 43  
44 44  (% element-id="1875" %)
45 -__**Production outbound (http)**__
35 +Production outbound
46 46  40.115.34.64
47 47  
48 -__**Production outbound (ftp):**__
49 -
50 -13.93.123.234
51 -
52 52  (% element-id="1873" %)
53 -__**Test outbound (http, ftp)**__
39 +Test outbound
54 54  13.73.138.173
55 55  
56 -__**Test outbound (ftp: eurofins, eurofins spain):**__
57 -
58 -51.145.244.12
59 -
60 60  (% element-id="1871" %)
61 -__**CD/CI outbound**__
43 +CD/CI outbound
62 62  40.114.238.16
63 63  
64 64  (% element-id="1869" %)
65 -__**Office outbound**__
47 +Office outbound
66 66  213.124.115.132
67 67  
68 -(% element-id="1869" %)
69 -__**Deliveryservice**__
70 -Production: 13.93.123.234
71 -Test: 51.145.244.12
72 72  
73 73  (% element-id="1864" %)
74 74  = (% element-id="1863" %)Labdelivery (menu-card) files Exchange(%%) =
... ... @@ -117,9 +117,6 @@
117 117  
118 118  (% element-id="1752" %)
119 119  Besides SIKB 13.4.0, TerraIndex also supports 9.0.0/8.0.0 etc.
120 -
121 -(% element-id="1752" %)
122 -~==> nle Do you want to mention these old versions?
123 123  )))|(% element-id="1751" %)
124 124  (% element-id="1749" %)|(% element-id="1748" %)6|(% element-id="1747" %) |(% element-id="1745" %) |(% element-id="1743" %)Reveives a request to create a labdelivery file in a certain version of SIKB. It will generate the file.|(% element-id="1742" %) |(% element-id="1740" %) |(% element-id="1738" %)
125 125  (% element-id="1736" %)|(% element-id="1735" %)7|(% element-id="1734" %) |(% element-id="1732" %)<=|(% element-id="1731" %)Sends back the SIKB file, as a Base64 encoded string, with or without using a zipstream.|(% element-id="1730" %)ResultCode (),
... ... @@ -498,7 +498,7 @@
498 498  
499 499  
500 500  (% element-id="1366" %)
501 -Therefore we call a Webserice for ValidCredentials Check:
476 +Therefor we call a Webserice for ValidCredentials Check:
502 502  
503 503  
504 504  (% class="table-hover" element-id="1363" %)
... ... @@ -717,12 +717,12 @@
717 717  == (% element-id="1202" %)Solution/Design(%%) ==
718 718  
719 719  (% element-id="1201" %)
720 -For this we create a Webservice for CreateOrder to create the order in the lab system.
695 +For this we create a Webserice for CreateOrder to create the order in the lab system.
721 721  After the creation, we would like to show an order overview of the laboratory in the future in PDF. The user can see the prices and can confirm or cancel.
722 722  Depending on the user's choice at the laboratory, to support this or not, TerraIndex calls the ApproveOrder or the CancelOrder.
723 723  
724 724  (% element-id="0" %)
725 -For default we assume that we cannot do this yet, and TerraIndex sends needsApprovaIsSupported = false. If this becomes true in the future, the Lab can indicate whether or not it is necessary in the NeedsApprove field.
700 +For default we assume that we cannot do this yet, and TerraIndex sends needsApprovalIsSupported = false. If this becomes true in the future, the Lab can indicate whether or not it is necessary in the NeedsApprove field.
726 726  
727 727  
728 728  (% class="table-hover" element-id="1195" %)
... ... @@ -1261,23 +1261,14 @@
1261 1261  )))
1262 1262  
1263 1263  (% element-id="654" %)
1264 -= (% element-id="653" %)Get Order status and Results XML and with PDF(%%) =
1239 += (% element-id="653" %)Get Order status and Results(%%) =
1265 1265  
1266 1266  (% element-id="652" %)
1267 -== (% element-id="651" %)Solution/Design(%%) ==
1242 +== (% element-id="651" %)Soluion/Design(%%) ==
1268 1268  
1269 1269  (% element-id="650" %)
1270 1270  TerraIndex will request per license/customer which results are ready. These are queried if the latest changes are newer than the last check. This way we never download too much unnecessarily and it can always be requested again.
1271 1271  
1272 -
1273 -(% class="box infomessage" element-id="650" %)
1274 -(((
1275 -**Order status** we support as minimal:
1276 -3 = Reportnumber is known, no results yet, but it's the official report certificate number. This is optional to send.
1277 -4 = Conceptual, temporary results avaiable, but not final yet. This is optional to send.
1278 -5 = Final results are available. This is required to send.
1279 -)))
1280 -
1281 1281  (% class="table-hover" element-id="647" %)
1282 1282  (% element-id="645" %)|(% element-id="644" %)Action|(% element-id="643" %)TerraIndex|(% element-id="642" %) |(% element-id="640" %)Laboratorium|(% element-id="639" %)Parameters/Message|(% element-id="638" %)Remarks|(% element-id="637" %)ResultCodes
1283 1283  (% element-id="636" %)|(% element-id="635" %)1|(% element-id="634" %)Sends a request to the function: GetCustomers().|=(% element-id="633" %)>|(% element-id="632" %) |(% element-id="630" %)WebserviceUsername (string), 
... ... @@ -1284,7 +1284,7 @@
1284 1284  WebservicePassword (string),
1285 1285  CustomerUsername (string)|(% element-id="627" %)We want to skip the Password of the customer, and we introduce the WebserviceUsername + WebservicePassword.|(% element-id="626" %)
1286 1286  (% element-id="624" %)|(% element-id="623" %)2|(% element-id="622" %) |(% element-id="620" %) |(% element-id="618" %)Receives the request and check the customers this username and searches the dateLastChanged for this Customer.|(% element-id="617" %) |(% element-id="615" %) |(% element-id="613" %)
1287 -(% element-id="611" %)|(% element-id="610" %)3|(% element-id="609" %) |(% element-id="607" %)<=|(% element-id="606" %)Sends back the list of customers to check for orderStatuses|(% element-id="605" %)ResultCode (),
1253 +(% element-id="611" %)|(% element-id="610" %)3|(% element-id="609" %) |(% element-id="607" %)<=|(% element-id="606" %)Sends back the list of customers with the lastChangedTimestamp|(% element-id="605" %)ResultCode (),
1288 1288  ErrorMessage (string),
1289 1289  List<customer> , Customer:
1290 1290  CustomerCode (string),
... ... @@ -1401,240 +1401,6 @@
1401 1401  (% element-id="370" %)|(% element-id="369" %)12|(% element-id="368" %)Receives the PDF and stores it for reporting and downloading.|(% element-id="367" %) |(% element-id="365" %) |(% element-id="363" %) |(% element-id="361" %) |(% element-id="359" %)
1402 1402  
1403 1403  (% element-id="357" %)
1404 -== Request example Order Status ==
1405 -
1406 -public GetOrderStatusesCall.Response OrderStatuses(string WebserviceUsername, string WebservicePassword, string CustomerUsername, string customerid, DateTime? timestampSince)
1407 - {
1408 - GetOrderStatusesCall.Response set = new GetOrderStatusesCall.Response();
1409 - string responseMessage = null;
1410 -
1411 - if (timestampSince == null) timestampSince = DateTime.Now.AddHours(-3); ~/~/Now, minus 3 hours
1412 - var formattedTimestamp = System.Xml.XmlConvert.ToString((DateTime)timestampSince, System.Xml.XmlDateTimeSerializationMode.RoundtripKind);
1413 -
1414 - try
1415 - {
1416 - var content = new FormUrlEncodedContent(new[]
1417 - {
1418 - new KeyValuePair<string, string>("userName", WebserviceUsername),
1419 - new KeyValuePair<string, string>("password", WebservicePassword),
1420 - new KeyValuePair<string, string>("customerUsername", CustomerUsername),
1421 - new KeyValuePair<string, string>("clientId", customerid),
1422 - new KeyValuePair<string, string>("lastModified", formattedTimestamp),
1423 - });
1424 -
1425 - HttpResponseMessage response = _HttpClient.PostAsync(_HttpClient.BaseAddress + "/GetOrderStatuses", content).GetAwaiter().GetResult();
1426 - responseMessage = response.Content.ReadAsStringAsync().GetAwaiter().GetResult();
1427 - response.EnsureSuccessStatusCode();
1428 -
1429 - if (string.IsNullOrEmpty(responseMessage))
1430 - {
1431 - throw new Exception("Empty response from: [" + _HttpClient.BaseAddress + " /GetOrderStatuses" + "]");
1432 - }
1433 - using (var ms = new System.IO.MemoryStream(System.Text.Encoding.UTF8.GetBytes(responseMessage~)~)~)
1434 - {
1435 - XmlSerializer serializer = new XmlSerializer(typeof(GetOrderStatusesCall.Response));
1436 - set = (GetOrderStatusesCall.Response)serializer.Deserialize(ms);
1437 - }               
1438 -
1439 - }
1440 - catch (Exception ex)
1441 - {
1442 - #region handle exception
1443 -
1444 - set.Status = new BusinessEntities.LabRestService.GetOrderStatusesCall.ResponseStatus();
1445 - set.Status.StatusCode = ((int)ResultCodes.GeneralError).ToString();
1446 - set.Status.ErrorMessage = "Exception occurred in GetOrderStatuses (username: " + WebserviceUsername + ", password: " + WebservicePassword + ") with message: " + ex.ToString();
1447 -
1448 - ex.Data.Add("Response", responseMessage);
1449 - ex.Data.Add("WebserviceUsername", WebserviceUsername);
1450 - ex.Data.Add("WebservicePassword", WebservicePassword);
1451 - ex.Data.Add("CustomerUsername", CustomerUsername);
1452 - ex.Data.Add("customerid", customerid);
1453 - ex.Data.Add("lastModified", formattedTimestamp);
1454 - ex.Data.Add("Result", set);
1455 -
1456 - throw;
1457 - #endregion
1458 - }
1459 -
1460 - return set;
1461 - }       
1462 -
1463 -== Response Status XML Example ==
1464 -
1465 - <?xml version="1.0" encoding="UTF-8" standalone="no"?>
1466 - <Response>
1467 - <Orders>
1468 - <Order>
1469 - <OrderStatus>Reported</OrderStatus>
1470 - <SIKBOrderId></SIKBOrderId>
1471 - <SIKBOrderStatus>5</SIKBOrderStatus>
1472 - <OrderId>4855422</OrderId>
1473 - <RapportNummer>12193838</RapportNummer>
1474 - <IsDelayed>False</IsDelayed>
1475 - <ExpectedOn>09/10/2015 17:15:00</ExpectedOn>
1476 - </Order>
1477 - <Order>
1478 - <OrderStatus>New</OrderStatus>
1479 - <SIKBOrderId></SIKBOrderId>
1480 - <SIKBOrderStatus>3</SIKBOrderStatus>
1481 - <OrderId>7106525</OrderId>
1482 - <RapportNummer>02808304-0749-41ae-96eb-d62b0365ebe4</RapportNummer>
1483 - <IsDelayed>False</IsDelayed>
1484 - <ExpectedOn></ExpectedOn>
1485 - </Order>
1486 - <Order>
1487 - <OrderStatus>New</OrderStatus>
1488 - <SIKBOrderId></SIKBOrderId>
1489 - <SIKBOrderStatus>3</SIKBOrderStatus>
1490 - <OrderId>7108954</OrderId>
1491 - <RapportNummer>10776137-ef99-4947-9a6a-9a3b32cd2dec</RapportNummer>
1492 - <IsDelayed>False</IsDelayed>
1493 - <ExpectedOn></ExpectedOn>
1494 - </Order>
1495 - <Order>
1496 - <OrderStatus>New</OrderStatus>
1497 - <SIKBOrderId></SIKBOrderId>
1498 - <SIKBOrderStatus>3</SIKBOrderStatus>
1499 - <OrderId>7110401</OrderId>
1500 - <RapportNummer>7881575c-bee2-409f-b304-9e472e7ac702</RapportNummer>
1501 - <IsDelayed>False</IsDelayed>
1502 - <ExpectedOn>11/10/2018 00:00:00</ExpectedOn>
1503 - </Order>
1504 - </Orders>
1505 - <Status>
1506 - <StatusCode>1</StatusCode>
1507 - <StatusCodeDescription>OK</StatusCodeDescription>
1508 - <AtmisErrorCode>0</AtmisErrorCode>
1509 - <ErrorMessage></ErrorMessage>
1510 - </Status>
1511 - </Response>
1512 -
1513 -
1514 -== Request example Order XML ==
1515 -
1516 -
1517 -public GetOrderResultsCall.Response GetOrderResults(string WebserviceUsername, string WebservicePassword, string CustomerUsername, string customerid, string orderid, string sikbVersion)
1518 - {
1519 - GetOrderResultsCall.Response set = new GetOrderResultsCall.Response();
1520 - string responseMessage = null;
1521 - try
1522 - {
1523 - bool useZipstream = true;
1524 - var content = new FormUrlEncodedContent(new[]
1525 - {
1526 - new KeyValuePair<string, string>("userName", WebserviceUsername),
1527 - new KeyValuePair<string, string>("password", WebservicePassword),
1528 - new KeyValuePair<string, string>("customerUsername", CustomerUsername),
1529 - new KeyValuePair<string, string>("clientId", customerid),
1530 - new KeyValuePair<string, string>("orderId", orderid),
1531 - new KeyValuePair<string, string>("sikbVersion", sikbVersion),
1532 - new KeyValuePair<string, string>("useZip", useZipstream.ToString() ),
1533 - });
1534 -
1535 - HttpResponseMessage response = _HttpClient.PostAsync(_HttpClient.BaseAddress + "/GetOrderResults", content).GetAwaiter().GetResult();
1536 - responseMessage = response.Content.ReadAsStringAsync().GetAwaiter().GetResult();
1537 - response.EnsureSuccessStatusCode();
1538 -
1539 - if (string.IsNullOrEmpty(responseMessage))
1540 - {
1541 - throw new Exception("Empty response from: [" + _HttpClient.BaseAddress + " /GetOrderResults" + "]");
1542 - }
1543 - using (var ms = new System.IO.MemoryStream(System.Text.Encoding.UTF8.GetBytes(responseMessage~)~)~)
1544 - {
1545 - XmlSerializer serializer = new XmlSerializer(typeof(GetOrderResultsCall.Response));
1546 - set = (GetOrderResultsCall.Response)serializer.Deserialize(ms);
1547 - }
1548 -
1549 - if (useZipstream && !string.IsNullOrEmpty(set.FileContent))
1550 - {
1551 - ~/~/convert from base64 string back to normal
1552 - ~/~/first check for real Base64, by checking there is no 'xml' in it
1553 - ~/~/If encoded, it wont contain either of the root XML tags of SIKB
1554 - if (!set.FileContent.Contains("FeatureCollectionIMSIKB0101") && !set.FileContent.Contains("labresultaat"))
1555 - {
1556 - set.FileContent = ZipStreamHelper.DecompressBase64StringToString(set.FileContent);
1557 - }
1558 - }
1559 -
1560 - }
1561 - catch (Exception ex)
1562 - {
1563 - #region handle exception
1564 -
1565 - set.Status = new BusinessEntities.LabRestService.GetOrderResultsCall.ResponseStatus();
1566 - set.Status.StatusCode = ((int)ResultCodes.GeneralError).ToString();
1567 - set.Status.ErrorMessage = "Exception occurred in GetOrderResults (username: " + WebserviceUsername + ", password: " + WebservicePassword + ") with message: " + ex.ToString();
1568 -
1569 - ex.Data.Add("Response", responseMessage);
1570 - ex.Data.Add("WebserviceUsername", WebserviceUsername);
1571 - ex.Data.Add("WebservicePassword", WebservicePassword);
1572 - ex.Data.Add("CustomerUsername", CustomerUsername);
1573 - ex.Data.Add("sikbVersion", sikbVersion);
1574 - ex.Data.Add("customerid", customerid);
1575 - ex.Data.Add("orderId", orderid);
1576 - ex.Data.Add("Result", set);
1577 -
1578 - throw;
1579 - #endregion
1580 - }
1581 -
1582 - return set;
1583 -
1584 -
1585 -== Response Order XML Example ==
1586 -
1587 -
1588 -<?xml version="1.0" encoding="UTF-8" standalone="no"?>
1589 - <Response>
1590 - <FileContent>DhVn3Q1AA==</FileContent>  ~/~/BASE64 Zip Stream, SIKB0101 labresults xml file
1591 - <Status>
1592 - <StatusCode>1</StatusCode>
1593 - <StatusCodeDescription>OK</StatusCodeDescription>
1594 - <AtmisErrorCode>0</AtmisErrorCode>  
1595 - <ErrorMessage></ErrorMessage>
1596 - </Status>
1597 - </Response>
1598 -
1599 -
1600 -== Request example Order PDF File ==
1601 -
1602 -
1603 -
1604 - bool useZipstream = true; ~/~/ Always Supported, Keep it true!!
1605 - var content = new FormUrlEncodedContent(new[]
1606 - {
1607 - new KeyValuePair<string, string>("userName", WebserviceUsername),
1608 - new KeyValuePair<string, string>("password", WebservicePassword),
1609 - new KeyValuePair<string, string>("customerUsername", CustomerUsername),
1610 - new KeyValuePair<string, string>("clientId", customerid),
1611 - new KeyValuePair<string, string>("orderId", orderid),
1612 - new KeyValuePair<string, string>("useZip", useZipstream.ToString()), ~/~/ Always Supported, Keep it true!!.
1613 - new KeyValuePair<string, string>("languageCode", languageCode)
1614 - });
1615 -
1616 - HttpResponseMessage response = _HttpClient.PostAsync("GetOrderPdf", content).GetAwaiter().GetResult();
1617 - responseMessage = response.Content.ReadAsStringAsync().GetAwaiter().GetResult();
1618 - response.EnsureSuccessStatusCode();
1619 -
1620 -
1621 -== Response Order PDF Example ==
1622 -
1623 - <Response>
1624 - <OrderId>7113737</OrderId>
1625 - <FileContent>
1626 - BASE64 encoded file
1627 - </FileContent>
1628 - <Status>
1629 - <StatusCode>1</StatusCode>
1630 - <StatusCodeDescription>OK</StatusCodeDescription>
1631 - <ErrorMessage></ErrorMessage>
1632 - </Status>
1633 - </Response>
1634 -
1635 -
1636 -
1637 -(% element-id="357" %)
1638 1638  = (% element-id="356" %)Customer wants to see real time information about the status in the interface(%%) =
1639 1639  
1640 1640  (% element-id="354" %)
Lab exchange.txt
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.RobinHuisman
Size
... ... @@ -1,1 +1,0 @@
1 -2.2 KB
Content
... ... @@ -1,50 +1,0 @@
1 -title Digital Lab exchange Process
2 -
3 -participant Lab
4 -participant TerraIndex
5 -participant TerraIndex_User
6 -
7 -
8 -==**Labdelivery data**==
9 -note over Lab,TerraIndex_User:TerraIndex retrieves the 'menu-card' so the user can order analysis.
10 -TerraIndex->Lab:Request the Client codes for a Customer
11 -Lab->TerraIndex:return the active Client codes
12 -TerraIndex->Lab:LabDelivery Data/File for a Customer Client Code
13 -Lab->TerraIndex:return the Labdelivery SIKB0101 File.
14 -TerraIndex->TerraIndex:Store and import into User database.
15 -
16 -==**Labassignment**==
17 -note over Lab,TerraIndex_User:TerraIndex sends the 'order' so the lab can process the samples.
18 -TerraIndex->TerraIndex_User:Show available Lab and Client codes
19 -TerraIndex_User->TerraIndex_User:Select Lab and Client code
20 -TerraIndex->TerraIndex_User:Show available Analysis Sets and Urgencies
21 -TerraIndex_User->TerraIndex_User:Select the samples
22 -TerraIndex_User->TerraIndex_User:Select the needed analysis sets
23 -TerraIndex_User->TerraIndex:Store/Save the labassignment
24 -TerraIndex_User->TerraIndex:Send to the lab
25 -TerraIndex->TerraIndex:Generate SIKB0101 Labassignment file
26 -TerraIndex->Lab:Send file to the Lab
27 -note over Lab,TerraIndex:Option A
28 -Lab->TerraIndex:Acknowledge a success received
29 -TerraIndex->TerraIndex:Save status
30 -TerraIndex->TerraIndex_User:Show status and prevent further editing
31 -note over Lab,TerraIndex:Option B
32 -Lab->TerraIndex:Return Order price PDF
33 -TerraIndex->TerraIndex_User:Show Price and PDF
34 -TerraIndex_User->TerraIndex:Approve Order
35 -TerraIndex->Lab:Approve Order
36 -Lab->TerraIndex:Acknowledge a success received
37 -TerraIndex->TerraIndex:Save status
38 -TerraIndex->TerraIndex_User:Show status and prevent further editing
39 -
40 -==**Labresults**==
41 -note over Lab,TerraIndex_User:TerraIndex retrieves the 'results' so the user can order report.
42 -TerraIndex->Lab:Requests the Changed assignments since last asking
43 -Lab->TerraIndex:return the changed orders with status
44 -TerraIndex->Lab:Request the results of a Ready order
45 -Lab->TerraIndex:return the Analysisresults SIKB0101 File.
46 -TerraIndex->TerraIndex:Store and import into User database.
47 -TerraIndex->TerraIndex_User:
48 -TerraIndex_User->TerraIndex_User:Asessments and Report results
49 -
50 -