lock
GET
apiportal/v1/community/{communityid}/Relationship
Gets all Relationships
EXPANDexpand_more
Request Information
Roles
- Vendor_APIClient
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| communityid | integer |
None. |
Body Parameters
None.
EXPANDexpand_more
Response Information
Resource Description
Collection of spsRelationships_Response| Name | Description | Type | Additional information |
|---|---|---|---|
| RelationshipSeq | integer |
None. |
|
| ID | integer |
None. |
|
| PersonalInfo | _PersonalInfo |
None. |
|
| RelatedID | integer |
None. |
|
| RelatedPersonalInfo | _PersonalInfo |
None. |
|
| Relationship | string |
None. |
|
| RelationshipDescription | string |
None. |
|
| NonCommunityRelation | string |
None. |
|
| UseEmail | string |
None. |
|
| UseEmailDescription | string |
None. |
|
| UseSMS | string |
None. |
|
| UseSMSDescription | string |
None. |
|
| PortalApproval | string |
None. |
Response Formats
[
{
"RelationshipSeq": 1,
"ID": 2,
"PersonalInfo": {
"Given1": "sample string 1",
"Given2": "sample string 2",
"Initials": "sample string 3",
"Suffix": "sample string 4",
"Surname": "sample string 5",
"NameInternal": "sample string 6",
"NameExternal": "sample string 7",
"LegalFullName": "sample string 8",
"PreferredFormal": "sample string 9",
"Title": "sample string 10",
"Preferred": "sample string 11",
"Gender": "sample string 12"
},
"RelatedID": 3,
"RelatedPersonalInfo": {
"Given1": "sample string 1",
"Given2": "sample string 2",
"Initials": "sample string 3",
"Suffix": "sample string 4",
"Surname": "sample string 5",
"NameInternal": "sample string 6",
"NameExternal": "sample string 7",
"LegalFullName": "sample string 8",
"PreferredFormal": "sample string 9",
"Title": "sample string 10",
"Preferred": "sample string 11",
"Gender": "sample string 12"
},
"Relationship": "sample string 4",
"RelationshipDescription": "sample string 5",
"NonCommunityRelation": "sample string 6",
"UseEmail": "sample string 7",
"UseEmailDescription": "sample string 8",
"UseSMS": "sample string 9",
"UseSMSDescription": "sample string 10",
"PortalApproval": "sample string 11"
},
{
"RelationshipSeq": 1,
"ID": 2,
"PersonalInfo": {
"Given1": "sample string 1",
"Given2": "sample string 2",
"Initials": "sample string 3",
"Suffix": "sample string 4",
"Surname": "sample string 5",
"NameInternal": "sample string 6",
"NameExternal": "sample string 7",
"LegalFullName": "sample string 8",
"PreferredFormal": "sample string 9",
"Title": "sample string 10",
"Preferred": "sample string 11",
"Gender": "sample string 12"
},
"RelatedID": 3,
"RelatedPersonalInfo": {
"Given1": "sample string 1",
"Given2": "sample string 2",
"Initials": "sample string 3",
"Suffix": "sample string 4",
"Surname": "sample string 5",
"NameInternal": "sample string 6",
"NameExternal": "sample string 7",
"LegalFullName": "sample string 8",
"PreferredFormal": "sample string 9",
"Title": "sample string 10",
"Preferred": "sample string 11",
"Gender": "sample string 12"
},
"Relationship": "sample string 4",
"RelationshipDescription": "sample string 5",
"NonCommunityRelation": "sample string 6",
"UseEmail": "sample string 7",
"UseEmailDescription": "sample string 8",
"UseSMS": "sample string 9",
"UseSMSDescription": "sample string 10",
"PortalApproval": "sample string 11"
}
]
<ArrayOfspsRelationships_Response xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Synergetic.Model.APIClient">
<spsRelationships_Response>
<ID>2</ID>
<NonCommunityRelation>sample string 6</NonCommunityRelation>
<PersonalInfo>
<Gender>sample string 12</Gender>
<Given1>sample string 1</Given1>
<Given2>sample string 2</Given2>
<Initials>sample string 3</Initials>
<LegalFullName>sample string 8</LegalFullName>
<NameExternal>sample string 7</NameExternal>
<NameInternal>sample string 6</NameInternal>
<Preferred>sample string 11</Preferred>
<PreferredFormal>sample string 9</PreferredFormal>
<Suffix>sample string 4</Suffix>
<Surname>sample string 5</Surname>
<Title>sample string 10</Title>
</PersonalInfo>
<PortalApproval>sample string 11</PortalApproval>
<RelatedID>3</RelatedID>
<RelatedPersonalInfo>
<Gender>sample string 12</Gender>
<Given1>sample string 1</Given1>
<Given2>sample string 2</Given2>
<Initials>sample string 3</Initials>
<LegalFullName>sample string 8</LegalFullName>
<NameExternal>sample string 7</NameExternal>
<NameInternal>sample string 6</NameInternal>
<Preferred>sample string 11</Preferred>
<PreferredFormal>sample string 9</PreferredFormal>
<Suffix>sample string 4</Suffix>
<Surname>sample string 5</Surname>
<Title>sample string 10</Title>
</RelatedPersonalInfo>
<Relationship>sample string 4</Relationship>
<RelationshipDescription>sample string 5</RelationshipDescription>
<RelationshipSeq>1</RelationshipSeq>
<UseEmail>sample string 7</UseEmail>
<UseEmailDescription>sample string 8</UseEmailDescription>
<UseSMS>sample string 9</UseSMS>
<UseSMSDescription>sample string 10</UseSMSDescription>
</spsRelationships_Response>
<spsRelationships_Response>
<ID>2</ID>
<NonCommunityRelation>sample string 6</NonCommunityRelation>
<PersonalInfo>
<Gender>sample string 12</Gender>
<Given1>sample string 1</Given1>
<Given2>sample string 2</Given2>
<Initials>sample string 3</Initials>
<LegalFullName>sample string 8</LegalFullName>
<NameExternal>sample string 7</NameExternal>
<NameInternal>sample string 6</NameInternal>
<Preferred>sample string 11</Preferred>
<PreferredFormal>sample string 9</PreferredFormal>
<Suffix>sample string 4</Suffix>
<Surname>sample string 5</Surname>
<Title>sample string 10</Title>
</PersonalInfo>
<PortalApproval>sample string 11</PortalApproval>
<RelatedID>3</RelatedID>
<RelatedPersonalInfo>
<Gender>sample string 12</Gender>
<Given1>sample string 1</Given1>
<Given2>sample string 2</Given2>
<Initials>sample string 3</Initials>
<LegalFullName>sample string 8</LegalFullName>
<NameExternal>sample string 7</NameExternal>
<NameInternal>sample string 6</NameInternal>
<Preferred>sample string 11</Preferred>
<PreferredFormal>sample string 9</PreferredFormal>
<Suffix>sample string 4</Suffix>
<Surname>sample string 5</Surname>
<Title>sample string 10</Title>
</RelatedPersonalInfo>
<Relationship>sample string 4</Relationship>
<RelationshipDescription>sample string 5</RelationshipDescription>
<RelationshipSeq>1</RelationshipSeq>
<UseEmail>sample string 7</UseEmail>
<UseEmailDescription>sample string 8</UseEmailDescription>
<UseSMS>sample string 9</UseSMS>
<UseSMSDescription>sample string 10</UseSMSDescription>
</spsRelationships_Response>
</ArrayOfspsRelationships_Response>