ThirdPartySystemGetAnalyses Method

[This is preliminary documentation and is subject to change.]

Return a list of analyses. This list can be filtered on blocks, measure types and timestamp.

Namespace: Dyostem.Services
Assembly: Dyostem (in Dyostem.dll) Version: 5.3

Syntax

JScript

JavaScript

Copy

public AnalysesResult GetAnalyses(
	string sessionId,
	List<Guid> blockIds,
	List<Guid> measureTypeIds,
	Nullable<DateTime> fromTimestamp,
	Nullable<DateTime> toTimestamp
)

Public Function GetAnalyses ( 
	sessionId As String,
	blockIds As List(Of Guid),
	measureTypeIds As List(Of Guid),
	fromTimestamp As Nullable(Of DateTime),
	toTimestamp As Nullable(Of DateTime)
) As AnalysesResult

Dim instance As ThirdPartySystem
Dim sessionId As String
Dim blockIds As List(Of Guid)
Dim measureTypeIds As List(Of Guid)
Dim fromTimestamp As Nullable(Of DateTime)
Dim toTimestamp As Nullable(Of DateTime)
Dim returnValue As AnalysesResult

returnValue = instance.GetAnalyses(sessionId, 
	blockIds, measureTypeIds, fromTimestamp, 
	toTimestamp)

public final function GetAnalyses(
	sessionId : String, 
	blockIds : List<Guid>, 
	measureTypeIds : List<Guid>, 
	fromTimestamp : Nullable<DateTime>, 
	toTimestamp : Nullable<DateTime>
) : AnalysesResult

function GetAnalyses(sessionId, blockIds, measureTypeIds, fromTimestamp, toTimestamp);

Parameters

sessionId: Type: SystemString
The SessionId returned by the OpenSession(String, String) command.
blockIds: Type: System.Collections.GenericListGuid
A list of block unique identifiers (Set to null to get analyses from all customer's active blocks.) A list of available unique identifiers could be retrieved using the GetBlocks(String, ListGuid, ListGuid, ListGuid) command.
measureTypeIds: Type: System.Collections.GenericListGuid
A list of measure type unique identifier (Set to null to retrieve analyses of every kind of measure.) A list of available unique identifiers could be retrieved using the GetMeasureTypes(String) command.
fromTimestamp: Type: SystemNullableDateTime
The minimum analysis timestamp to return (Set to null to get analyses from all vintages.)
toTimestamp: Type: SystemNullableDateTime
The maximum analysis timestamp to retun. (Set to null to get analysis to last one.)

Return Value

Type: AnalysesResult
An instance of AnalysesResult compound with a Message indicating that the command succeeded or not, and the requested list, grouped by block.

Examples

Request

Copy

1POST http://www.dyostem.com/Services/ThirdPartySystem.svc/GetAnalyses HTTP/1.1
2Content-Type: application/json
3Host: www.dyostem.com
4Content-Length: 150
5Expect: 100-continue
6
7{"sessionId":"8a6e5fe0-6e98-42c8-ac0b-7b07d2dfb56e","measureTypeIds":["dcaca71e-8d39-42af-bc81-bb5384f34758"],"fromTimestamp":"/Date(1441152000000)/"}

Response

Copy

 1HTTP/1.1 200 OK
 2Cache-Control: private
 3Content-Type: application/json; charset=utf-8
 4Server: Microsoft-IIS/7.5
 5Set-Cookie: ASP.NET_SessionId=ap1ao2chwaek2ubncknxdlgu; path=/; HttpOnly
 6X-AspNet-Version: 4.0.30319
 7X-Powered-By: ASP.NET
 8Date: Thu, 23 Jun 2016 12:10:43 GMT
 9Content-Length: 257863
10
11{"d":{"__type":"AnalysesResult:#Dyostem.Services.Data","Blocks":[{"__type":"BlockAnalyses:#Dyostem.Services.Data","Analyses":[{"__type":"Analysis:#Dyostem.Services.Data","AnalysisId":"1efd8f07-71e9-4f4e-b4c0-babc95d626d4","Comment":null,"Measures":[{"__type":"Measure:#Dyostem.Services.Data","MeasureTypeId":"dcaca71e-8d39-42af-bc81-bb5384f34758","MeasureTypeName":"Acidité totale","RawValue":"3.96","Unit":"g H2SO4\/l","Value":"4"}],"SampleCode":"1523209","Timestamp":"\/Date(1441196640000)\/"},
12…
13{"__type":"Analysis:#Dyostem.Services.Data","AnalysisId":"8671fcee-ac0a-4fed-b986-852dd1f9a889","Comment":null,"Measures":[{"__type":"Measure:#Dyostem.Services.Data","MeasureTypeId":"dcaca71e-8d39-42af-bc81-bb5384f34758","MeasureTypeName":"Acidité totale","RawValue":"3.54","Unit":"g H2SO4\/l","Value":"3,5"}],"SampleCode":"1526638","Timestamp":"\/Date(1442569140000)\/"}],"BlockId":"4d9b4cf3-3f23-40d3-9494-ddd0f64dd9c1","BlockName":"MA PARCELLE"},{"__type":"BlockAnalyses:#Dyostem.Services.Data","Analyses":[{"__type":"Analysis:#Dyostem.Services.Data","AnalysisId":"35cb6bd7-5e0a-4163-b41b-fc8d1427c086","Comment":null,"Measures":[{"__type":"Measure:#Dyostem.Services.Data","MeasureTypeId":"dcaca71e-8d39-42af-bc81-bb5384f34758","MeasureTypeName":"Acidité totale","RawValue":"4.82","Unit":"g H2SO4\/l","Value":"4,8"}],"SampleCode":"1523374","Timestamp":"\/Date(1441279560000)\/"}],"BlockId":"7b57cc6e-38aa-450b-99b8-af55ef3c295e","BlockName":"MON AUTRE PARCELLE"}],"Message":"OK"}}

Formated Json Response

Copy

 1{
 2  "d" : {
 3    "__type" : "AnalysesResult:#Dyostem.Services.Data",
 4    "Blocks" : [{
 5        "__type" : "BlockAnalyses:#Dyostem.Services.Data",
 6        "Analyses" : [{
 7            "__type" : "Analysis:#Dyostem.Services.Data",
 8            "AnalysisId" : "1efd8f07-71e9-4f4e-b4c0-babc95d626d4",
 9            "Comment" : null,
10            "Measures" : [{
11                "__type" : "Measure:#Dyostem.Services.Data",
12                "MeasureTypeId" : "dcaca71e-8d39-42af-bc81-bb5384f34758",
13                "MeasureTypeName" : "Acidité totale",
14                "RawValue" : "3.96",
15                "Unit" : "g H2SO4\/l",
16                "Value" : "4"
17              }
18            ],
19            "SampleCode" : "1523209",
20            "Timestamp" : "\/Date(1441196640000)\/"
21          }, 
22…
23          {
24            "__type" : "Analysis:#Dyostem.Services.Data",
25            "AnalysisId" : "8671fcee-ac0a-4fed-b986-852dd1f9a889",
26            "Comment" : null,
27            "Measures" : [{
28                "__type" : "Measure:#Dyostem.Services.Data",
29                "MeasureTypeId" : "dcaca71e-8d39-42af-bc81-bb5384f34758",
30                "MeasureTypeName" : "Acidité totale",
31                "RawValue" : "3.54",
32                "Unit" : "g H2SO4\/l",
33                "Value" : "3,5"
34              }
35            ],
36            "SampleCode" : "1526638",
37            "Timestamp" : "\/Date(1442569140000)\/"
38          }
39        ],
40        "BlockId" : "4d9b4cf3-3f23-40d3-9494-ddd0f64dd9c1",
41        "BlockName" : "MA PARCELLE"
42      }, {
43        "__type" : "BlockAnalyses:#Dyostem.Services.Data",
44        "Analyses" : [{
45            "__type" : "Analysis:#Dyostem.Services.Data",
46            "AnalysisId" : "35cb6bd7-5e0a-4163-b41b-fc8d1427c086",
47            "Comment" : null,
48            "Measures" : [{
49                "__type" : "Measure:#Dyostem.Services.Data",
50                "MeasureTypeId" : "dcaca71e-8d39-42af-bc81-bb5384f34758",
51                "MeasureTypeName" : "Acidité totale",
52                "RawValue" : "4.82",
53                "Unit" : "g H2SO4\/l",
54                "Value" : "4,8"
55              }
56            ],
57            "SampleCode" : "1523374",
58            "Timestamp" : "\/Date(1441279560000)\/"
59          }
60        ],
61        "BlockId" : "7b57cc6e-38aa-450b-99b8-af55ef3c295e",
62        "BlockName" : "MON AUTRE PARCELLE"
63      }
64    ],
65    "Message" : "OK"
66  }
67}

Reference

ThirdPartySystem Class

Dyostem.Services Namespace

ThirdPartySystemAddLanguageSpecificTextSet("LST5483508E_0?cpp=::|nu=.");GetAnalyses Method

Parameters

Return Value

Reference

ThirdPartySystemGetAnalyses Method