Click or drag to resize
dyostem api documentation

ThirdPartySystemGetGroups Method

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

Get the customer's groups definition.

Namespace:  Dyostem.Services
Assembly:  Dyostem (in Dyostem.dll) Version: 5.3
Syntax
Copy
public GroupsListResult GetGroups(
	string sessionId
)

Parameters

sessionId
Type: SystemString
The SessionId returned by the OpenSession(String, String) command.

Return Value

Type: GroupsListResult
An instance of GroupsListResult compound with Message indicating that the command succeeded or not, and a definition of Group items, when available.
Examples
Request
Copy
1POST /Services/ThirdPartySystem.svc/GetGroups HTTP/1.1
2Content-Type: application/json
3Host: www.dyostem.com
4Content-Length: 52
5Expect: 100-continue
6Connection: Keep-Alive
7
8{"sessionId":"d291a5c8-60ab-429a-a167-1a97d15c91b3"}
Response (no group defined)
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=rypn3r4x2qqngx0xqy1wvuol; path=/; HttpOnly
 7X-AspNet-Version: 4.0.30319
 8X-Powered-By: ASP.NET
 9Date: Mon, 23 May 2016 14:47:59 GMT
10
1157
12{"d":{"__type":"GroupsListResult:#Dyostem.Services.Data","Groups":null,"Message":"OK"}}
130
Response (2 groups defined)
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=tbtqm3ziawuuz2nsnfvoolat; path=/; HttpOnly
 7X-AspNet-Version: 4.0.30319
 8X-Powered-By: ASP.NET
 9Date: Mon, 23 May 2016 14:51:06 GMT
10
11171
12{"d":{"__type":"GroupsListResult:#Dyostem.Services.Data","Groups":{"__type":"Groups:#Dyostem.Services.Data","GroupInfoNiv1":{"__type":"Group:#Dyostem.Services.Data","Id":"f0cda574-ab7f-467c-8dc8-bd8c13a0dfe5","Name":"Propriétaire"},"GroupInfoNiv2":{"__type":"Group:#Dyostem.Services.Data","Id":"21d926d8-fbfc-4d03-87f0-90e7c0462f6b","Name":"Cépage"}},"Message":"OK"}}
130
Formated Json Response (2 groups defined)
Copy
 1{
 2  "d" : {
 3    "__type" : "GroupsListResult:#Dyostem.Services.Data",
 4    "Groups" : {
 5      "__type" : "Groups:#Dyostem.Services.Data",
 6      "GroupInfoNiv1" : {
 7        "__type" : "Group:#Dyostem.Services.Data",
 8        "Id" : "f0cda574-ab7f-467c-8dc8-bd8c13a0dfe5",
 9        "Name" : "Propriétaire"
10      },
11      "GroupInfoNiv2" : {
12        "__type" : "Group:#Dyostem.Services.Data",
13        "Id" : "21d926d8-fbfc-4d03-87f0-90e7c0462f6b",
14        "Name" : "Cépage"
15      }
16    },
17    "Message" : "OK"
18  }
19}
See Also