Returns group memberships for the given ID.
This web service calls underlying SQL stored procedure – SynergyOne.dbo.spxeCommunityGroups.
InputObject (XML)
Element |
SQL Data Type |
Mandatory |
Description |
VendorTokenGUID |
GUID |
Yes |
Specific GUID that Synergetic will give the third party app to validate them upon every web service request. |
VersionNumber |
Decimal(4,2) |
Yes |
To cater for extending the web service and return the version specific format. Default 2.5. |
ConfigFileName |
Varchar(max) |
No |
Optional - if missing or blank then the authentication details into DB are found in WebServiceSynergetic.XML in the website folder. |
ID |
Integer |
Yes |
Synergetic Community ID for the required person. |
GroupTypes |
xmlNode |
Yes |
Optional sub-node required to determine which groups to be returned in the list. |
GroupsTypes sub-node
This node demines which areas of the system are returned as a group membership for the given ID.
Element |
SQL Data Type |
Mandatory |
Description |
Constituencies |
Bit (1/0) |
Yes |
List all constituencies for a community member. |
StudentClasses |
Bit |
Yes |
List all student classes in the default file year and term. |
StudentYearLevels |
Bit |
Yes |
List year level membership. |
Sample Input
3FC2ABA9-8F37-4CC9-934C-6ABCCA9F44B7
2.5
9578
1
1
0
OutputObject (XML)
Element |
SQL Data Type |
Description |
ID |
Integer |
Person's community ID, same as passed in ID. |
GroupType |
Varchar(20) |
Group type matches the group type sub node for the input parameter. Eg. 'Constituency', 'StudentClass', 'StudentYearLevel' |
GroupCode |
Varchar(40) |
Returns the group code, eg for Constituencies you will get something like @SC or @PC. |
GroupDescription |
Varchar(40) |
Description for the group code. Eg. @PC = Current Parent. @SC = Current student. |
Sample Output
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article