GetCommunityRelationships
- James Overell
Returns a record for each relationship recorded for the given ID.
This web service calls underlying SQL stored procedure – SynergyOne.dbo.spxeCommunityRelationships.
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. |
Sample Input
<InputXML>
<VendorTokenGUID>3FC2ABA9-8F37-4CC9-934C-6ABCCA9F44B7</VendorTokenGUID>
<VersionNumber>2.5</VersionNumber>
<ConfigFileName></ConfigFileName>
<ID>9578</ID>
</InputXML>
OutputObject (XML)
Element |
SQL Data Type |
Description |
ID |
Integer |
Person's community ID, same as passed in ID. |
RelatedID |
Integer |
Community ID for the relation. |
RelationshipDescription |
Varchar(40) |
Description of the relationship. Eg. Mother or Father. |
Sample Output
<Community ID="444">
<Relationships RelatedID="442" RelationshipDescription="Father"/>
<Relationships RelatedID="445" RelationshipDescription="Grandmother"/>
<Relationships RelatedID="443" RelationshipDescription="Mother"/>
</Community>