Click or drag to resize
dyostem api documentation

ThirdPartySystemGetBlocks Method

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

Return the list of all active blocks with their block data for the connected customer. The list can be filtered on blocks, block data types and vintages

Namespace:  Dyostem.Services
Assembly:  Dyostem (in Dyostem.dll) Version: 5.3
Syntax
Copy
public BlocksListResult GetBlocks(
	string sessionId,
	List<Guid> listBlockId,
	List<Guid> listBlockDataTypeId,
	List<Guid> listVintageId
)

Parameters

sessionId
Type: SystemString
The SessionId returned by the OpenSession(String, String) command.
listBlockId
Type: System.Collections.GenericListGuid
A list of block unique identifiers (Set to null to retreive block data for all customer's active blocks.) A list of available unique identifiers could be retrieved using the GetBlocks(String, ListGuid, ListGuid, ListGuid) command.
listBlockDataTypeId
Type: System.Collections.GenericListGuid
A list of block data type unique identifiers (Set to null to retrieve all data for a block). Available block data types could be retrieved using the GetBlockDataTypes(String) commmand.
listVintageId
Type: System.Collections.GenericListGuid
A list of vintage unique identifiers (Set to null to retrieve block data for all vintages.) Available vintages could be retrieved using the GetVintages(String) command.

Return Value

Type: BlocksListResult
An instance of BlocksListResult object compound with a Message indicating that the command succeeded or not, and the requested list.
Examples
Request
Copy
1POST /Services/ThirdPartySystem.svc/GetBlocks HTTP/1.1
2Content-Type: application/json
3Host: www.dyostem.com
4Content-Length: 155
5Expect: 100-continue
6Connection: Keep-Alive
7
8{"sessionId":"d291a5c8-60ab-429a-a167-1a97d15c91b3","listVintageId":["88670414-3c1e-40c1-b597-2fe44ddef08d"],"listBlockId":null,"listBlockDataTypeId":null}
Response
Copy
 1HTTP/1.1 200 OK
 2Cache-Control: private
 3Transfer-Encoding: chunked
 4Content-Type: application/json; charset=utf-8
 5Server: Microsoft-IIS/7.5
 6Set-Cookie: ASP.NET_SessionId=jk15wpyms5k4y42gwxgfd1xs; path=/; HttpOnly
 7X-AspNet-Version: 4.0.30319
 8X-Powered-By: ASP.NET
 9Date: Mon, 23 May 2016 15:05:52 GMT
10
118000
12{"d":{"__type":"BlocksListResult:#Dyostem.Services.Data","Blocks":[{"__type":"Block:#Dyostem.S…
138000
14DataTypeId":"3f6369d9-40d0-4445-b000-277216486592","BlockDataTypeName":"Identifiant","RawValue…
158000
16rvices.Data","BlockDataTypeId":"21d926d8-fbfc-4d03-87f0-90e7c0462f6b","BlockDataTypeName":"Cép…
173b00
187-2fe44ddef08d","VintageLabel":"Millésime 2015"}],"BlockId":"eb1c6c78-80e8-485b-9048-fc91b46e1…
190
Formated Json Response
Copy
 1{
 2  "d" : {
 3    "__type" : "BlocksListResult:#Dyostem.Services.Data",
 4    "Blocks" : [{
 5        "__type" : "Block:#Dyostem.Services.Data",
 6        "BlockData" : [{
 7            "__type" : "BlockData:#Dyostem.Services.Data",
 8            "BlockDataTypeId" : "21d926d8-fbfc-4d03-87f0-90e7c0462f6b",
 9            "BlockDataTypeName" : "Cépage",
10            "RawValue" : "1796030c-a1a5-4a02-9304-c47ee3dfcf77",
11            "Value" : "Syrah",
12            "VintageId" : null,
13            "VintageLabel" : null
14          }, {
15            "__type" : "BlockData:#Dyostem.Services.Data",
16            "BlockDataTypeId" : "3f6369d9-40d0-4445-b000-277216486592",
17            "BlockDataTypeName" : "Code",
18            "RawValue" : "160038",
19            "Value" : "160038",
20            "VintageId" : "88670414-3c1e-40c1-b597-2fe44ddef08d",
21            "VintageLabel" : "Millésime 2015"
22          }
23        ],
24        "BlockId" : "b2bc675c-63c5-4119-88ca-1aa9bf299989",
25        "BlockName" : "01201"
26      }, {
27        "__type" : "Block:#Dyostem.Services.Data",
28        "BlockData" : [{
29            "__type" : "BlockData:#Dyostem.Services.Data",
30            "BlockDataTypeId" : "21d926d8-fbfc-4d03-87f0-90e7c0462f6b",
31            "BlockDataTypeName" : "Cépage",
32            "RawValue" : "1796030c-a1a5-4a02-9304-c47ee3dfcf77",
33            "Value" : "Syrah",
34            "VintageId" : null,
35            "VintageLabel" : null
36          }, {
37            "__type" : "BlockData:#Dyostem.Services.Data",
38            "BlockDataTypeId" : "3f6369d9-40d0-4445-b000-277216486592",
39            "BlockDataTypeName" : "Code",
40            "RawValue" : "160039",
41            "Value" : "160039",
42            "VintageId" : "88670414-3c1e-40c1-b597-2fe44ddef08d",
43            "VintageLabel" : "Millésime 2015"
44          }
45        ],
46        "BlockId" : "1a5ccef2-5661-4879-8ba0-76b0c26dfcc4",
47        "BlockName" : "01207"
48      }, ...
49      {
50        "__type" : "Block:#Dyostem.Services.Data",
51        "BlockData" : [{
52            "__type" : "BlockData:#Dyostem.Services.Data",
53            "BlockDataTypeId" : "21d926d8-fbfc-4d03-87f0-90e7c0462f6b",
54            "BlockDataTypeName" : "Cépage",
55            "RawValue" : "6961eb9d-f3fb-4086-830c-461d2491c97e",
56            "Value" : "Mourvèdre",
57            "VintageId" : null,
58            "VintageLabel" : null
59          }, {
60            "__type" : "BlockData:#Dyostem.Services.Data",
61            "BlockDataTypeId" : "3f6369d9-40d0-4445-b000-277216486592",
62            "BlockDataTypeName" : "Code",
63            "RawValue" : "160021",
64            "Value" : "160021",
65            "VintageId" : "88670414-3c1e-40c1-b597-2fe44ddef08d",
66            "VintageLabel" : "Millésime 2015"
67          }
68        ],
69        "BlockId" : "25581f0a-9717-435d-965d-f06cc825677e",
70        "BlockName" : "67112"
71      }
72    ],
73    "Message" : "OK"
74  }
75}
See Also