POST {version}/Entity/GetEntityAffiliationList
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| version | string |
None. |
Body Parameters
EntityAffiliation| Name | Description | Type | Additional information |
|---|---|---|---|
| ToEntityAffiliationId | globally unique identifier |
None. |
|
| ToEntityAffiliationName | string |
None. |
|
| FromEntityAffiliationId | globally unique identifier |
None. |
|
| FromEntityAffiliationName | string |
None. |
|
| IsLegislator | boolean |
None. |
|
| EntityName | string |
None. |
|
| ToEntityLinkId | globally unique identifier |
None. |
|
| Line1 | string |
None. |
|
| City | string |
None. |
|
| State | string |
None. |
|
| Zip5 | string |
None. |
|
| Zip4 | string |
None. |
|
| isPrimary | boolean |
None. |
|
| PrimaryContactDisplayName | string |
None. |
|
| PrimaryContactEmail | string |
None. |
|
| PrimaryContactPhone | string |
None. |
|
| isCandidate | boolean |
None. |
|
| Line2 | string |
None. |
|
| Address | string |
None. |
|
| BalanceUsage | integer |
None. |
|
| GroupName | string |
None. |
|
| OrderBy | string |
None. |
|
| IsAscending | boolean |
None. |
|
| PageNum | integer |
None. |
|
| PageSize | integer |
None. |
|
| Filter | string |
None. |
|
| FromEntityType | string |
None. |
|
| ToEntityType | string |
None. |
|
| FromEntityLinkId | globally unique identifier |
None. |
|
| FromEntityId | globally unique identifier |
None. |
|
| PairId | globally unique identifier |
None. |
|
| DirectionName | string |
None. |
|
| ToEntityLink | string |
None. |
|
| FromEntityLink | string |
None. |
|
| IsComplianceType | boolean |
None. |
|
| IsInternal | boolean |
None. |
|
| ToEntityId | globally unique identifier |
None. |
|
| ConfirmDelete | boolean |
None. |
|
| SkipRelations | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"ToEntityAffiliationId": "e6c04a7d-8830-4c05-8219-ae110442a098",
"ToEntityAffiliationName": "sample string 1",
"FromEntityAffiliationId": "5229c49d-4e86-4650-89d5-939bc384d681",
"FromEntityAffiliationName": "sample string 2",
"IsLegislator": true,
"EntityName": "sample string 3",
"ToEntityLinkId": "b74e255e-b84e-4d60-b8a2-fb5c8b332f51",
"Line1": "sample string 4",
"City": "sample string 5",
"State": "sample string 6",
"Zip5": "sample string 7",
"Zip4": "sample string 8",
"isPrimary": true,
"PrimaryContactDisplayName": "sample string 9",
"PrimaryContactEmail": "sample string 10",
"PrimaryContactPhone": "sample string 11",
"isCandidate": true,
"Line2": "sample string 13",
"Address": "sample string 4\r\nsample string 13\r\nsample string 5\r\n\r\nsample string 6\r\n sample string 7-sample string 8",
"BalanceUsage": 1,
"GroupName": "sample string 14",
"OrderBy": "sample string 15",
"IsAscending": true,
"PageNum": 17,
"PageSize": 18,
"Filter": "sample string 19",
"FromEntityType": "sample string 20",
"ToEntityType": "sample string 21",
"FromEntityLinkId": "cb3b7f29-e8cb-4be7-9985-3b58b9e9902d",
"FromEntityId": "e69b611d-03e9-4e17-b01e-e5284b1c45c8",
"PairId": "27b828d0-85e9-41f6-8606-b412c0753282",
"DirectionName": "sample string 22",
"ToEntityLink": "/Organization/Select?id=4ade2244-3649-4224-9ecf-17b055dcb1e8",
"FromEntityLink": "/Organization/Select?id=e69b611d-03e9-4e17-b01e-e5284b1c45c8",
"IsComplianceType": true,
"IsInternal": true,
"ToEntityId": "4ade2244-3649-4224-9ecf-17b055dcb1e8",
"ConfirmDelete": true,
"SkipRelations": true
}
application/xml, text/xml
Sample:
<EntityAffiliation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aristotle.CM.Model"> <BalanceUsage>1</BalanceUsage> <City>sample string 5</City> <ConfirmDelete>true</ConfirmDelete> <DirectionName>sample string 22</DirectionName> <EntityName>sample string 3</EntityName> <Filter>sample string 19</Filter> <FromEntityAffiliationId>5229c49d-4e86-4650-89d5-939bc384d681</FromEntityAffiliationId> <FromEntityAffiliationName>sample string 2</FromEntityAffiliationName> <FromEntityId>e69b611d-03e9-4e17-b01e-e5284b1c45c8</FromEntityId> <FromEntityLinkId>cb3b7f29-e8cb-4be7-9985-3b58b9e9902d</FromEntityLinkId> <FromEntityType>sample string 20</FromEntityType> <GroupName>sample string 14</GroupName> <IsAscending>true</IsAscending> <IsComplianceType>true</IsComplianceType> <IsInternal>true</IsInternal> <IsLegislator>true</IsLegislator> <Line1>sample string 4</Line1> <Line2>sample string 13</Line2> <OrderBy>sample string 15</OrderBy> <PageNum>17</PageNum> <PageSize>18</PageSize> <PairId>27b828d0-85e9-41f6-8606-b412c0753282</PairId> <PrimaryContactDisplayName>sample string 9</PrimaryContactDisplayName> <PrimaryContactEmail>sample string 10</PrimaryContactEmail> <PrimaryContactPhone>sample string 11</PrimaryContactPhone> <SkipRelations>true</SkipRelations> <State>sample string 6</State> <ToEntityAffiliationId>e6c04a7d-8830-4c05-8219-ae110442a098</ToEntityAffiliationId> <ToEntityAffiliationName>sample string 1</ToEntityAffiliationName> <ToEntityId>4ade2244-3649-4224-9ecf-17b055dcb1e8</ToEntityId> <ToEntityLinkId>b74e255e-b84e-4d60-b8a2-fb5c8b332f51</ToEntityLinkId> <ToEntityType>sample string 21</ToEntityType> <Zip4>sample string 8</Zip4> <Zip5>sample string 7</Zip5> <isCandidate>true</isCandidate> <isPrimary>true</isPrimary> </EntityAffiliation>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
EntityAffiliationList| Name | Description | Type | Additional information |
|---|---|---|---|
| Results | Collection of EntityAffiliation |
None. |
|
| TotalRecords | integer |
None. |
|
| AvailableRelations | Collection of EntityAffiliation |
None. |
Response Formats
application/json, text/json
Sample:
{
"Results": [
{
"ToEntityAffiliationId": "75e94f72-d9c1-4bed-875b-96650981ac75",
"ToEntityAffiliationName": "sample string 1",
"FromEntityAffiliationId": "b6a9f919-536b-4930-a3df-535f946792b7",
"FromEntityAffiliationName": "sample string 2",
"IsLegislator": true,
"EntityName": "sample string 3",
"ToEntityLinkId": "7145baed-60c1-481f-a53c-3f31e7b8095e",
"Line1": "sample string 4",
"City": "sample string 5",
"State": "sample string 6",
"Zip5": "sample string 7",
"Zip4": "sample string 8",
"isPrimary": true,
"PrimaryContactDisplayName": "sample string 9",
"PrimaryContactEmail": "sample string 10",
"PrimaryContactPhone": "sample string 11",
"isCandidate": true,
"Line2": "sample string 13",
"Address": "sample string 4\r\nsample string 13\r\nsample string 5\r\n\r\nsample string 6\r\n sample string 7-sample string 8",
"BalanceUsage": 1,
"GroupName": "sample string 14",
"OrderBy": "sample string 15",
"IsAscending": true,
"PageNum": 17,
"PageSize": 18,
"Filter": "sample string 19",
"FromEntityType": "sample string 20",
"ToEntityType": "sample string 21",
"FromEntityLinkId": "0f0bfda1-e6a6-4854-8aa3-8b5a67f0bc24",
"FromEntityId": "dd839c5f-da68-4ac5-8cf9-e38294a30e87",
"PairId": "95bc4a64-cf46-44cb-acb2-511a9561f56c",
"DirectionName": "sample string 22",
"ToEntityLink": "/Organization/Select?id=53d7a0a2-d2bc-4a40-a5d1-ba6d6d597fc5",
"FromEntityLink": "/Organization/Select?id=dd839c5f-da68-4ac5-8cf9-e38294a30e87",
"IsComplianceType": true,
"IsInternal": true,
"ToEntityId": "53d7a0a2-d2bc-4a40-a5d1-ba6d6d597fc5",
"ConfirmDelete": true,
"SkipRelations": true
},
{
"ToEntityAffiliationId": "75e94f72-d9c1-4bed-875b-96650981ac75",
"ToEntityAffiliationName": "sample string 1",
"FromEntityAffiliationId": "b6a9f919-536b-4930-a3df-535f946792b7",
"FromEntityAffiliationName": "sample string 2",
"IsLegislator": true,
"EntityName": "sample string 3",
"ToEntityLinkId": "7145baed-60c1-481f-a53c-3f31e7b8095e",
"Line1": "sample string 4",
"City": "sample string 5",
"State": "sample string 6",
"Zip5": "sample string 7",
"Zip4": "sample string 8",
"isPrimary": true,
"PrimaryContactDisplayName": "sample string 9",
"PrimaryContactEmail": "sample string 10",
"PrimaryContactPhone": "sample string 11",
"isCandidate": true,
"Line2": "sample string 13",
"Address": "sample string 4\r\nsample string 13\r\nsample string 5\r\n\r\nsample string 6\r\n sample string 7-sample string 8",
"BalanceUsage": 1,
"GroupName": "sample string 14",
"OrderBy": "sample string 15",
"IsAscending": true,
"PageNum": 17,
"PageSize": 18,
"Filter": "sample string 19",
"FromEntityType": "sample string 20",
"ToEntityType": "sample string 21",
"FromEntityLinkId": "0f0bfda1-e6a6-4854-8aa3-8b5a67f0bc24",
"FromEntityId": "dd839c5f-da68-4ac5-8cf9-e38294a30e87",
"PairId": "95bc4a64-cf46-44cb-acb2-511a9561f56c",
"DirectionName": "sample string 22",
"ToEntityLink": "/Organization/Select?id=53d7a0a2-d2bc-4a40-a5d1-ba6d6d597fc5",
"FromEntityLink": "/Organization/Select?id=dd839c5f-da68-4ac5-8cf9-e38294a30e87",
"IsComplianceType": true,
"IsInternal": true,
"ToEntityId": "53d7a0a2-d2bc-4a40-a5d1-ba6d6d597fc5",
"ConfirmDelete": true,
"SkipRelations": true
}
],
"TotalRecords": 1,
"AvailableRelations": [
{
"ToEntityAffiliationId": "75e94f72-d9c1-4bed-875b-96650981ac75",
"ToEntityAffiliationName": "sample string 1",
"FromEntityAffiliationId": "b6a9f919-536b-4930-a3df-535f946792b7",
"FromEntityAffiliationName": "sample string 2",
"IsLegislator": true,
"EntityName": "sample string 3",
"ToEntityLinkId": "7145baed-60c1-481f-a53c-3f31e7b8095e",
"Line1": "sample string 4",
"City": "sample string 5",
"State": "sample string 6",
"Zip5": "sample string 7",
"Zip4": "sample string 8",
"isPrimary": true,
"PrimaryContactDisplayName": "sample string 9",
"PrimaryContactEmail": "sample string 10",
"PrimaryContactPhone": "sample string 11",
"isCandidate": true,
"Line2": "sample string 13",
"Address": "sample string 4\r\nsample string 13\r\nsample string 5\r\n\r\nsample string 6\r\n sample string 7-sample string 8",
"BalanceUsage": 1,
"GroupName": "sample string 14",
"OrderBy": "sample string 15",
"IsAscending": true,
"PageNum": 17,
"PageSize": 18,
"Filter": "sample string 19",
"FromEntityType": "sample string 20",
"ToEntityType": "sample string 21",
"FromEntityLinkId": "0f0bfda1-e6a6-4854-8aa3-8b5a67f0bc24",
"FromEntityId": "dd839c5f-da68-4ac5-8cf9-e38294a30e87",
"PairId": "95bc4a64-cf46-44cb-acb2-511a9561f56c",
"DirectionName": "sample string 22",
"ToEntityLink": "/Organization/Select?id=53d7a0a2-d2bc-4a40-a5d1-ba6d6d597fc5",
"FromEntityLink": "/Organization/Select?id=dd839c5f-da68-4ac5-8cf9-e38294a30e87",
"IsComplianceType": true,
"IsInternal": true,
"ToEntityId": "53d7a0a2-d2bc-4a40-a5d1-ba6d6d597fc5",
"ConfirmDelete": true,
"SkipRelations": true
},
{
"ToEntityAffiliationId": "75e94f72-d9c1-4bed-875b-96650981ac75",
"ToEntityAffiliationName": "sample string 1",
"FromEntityAffiliationId": "b6a9f919-536b-4930-a3df-535f946792b7",
"FromEntityAffiliationName": "sample string 2",
"IsLegislator": true,
"EntityName": "sample string 3",
"ToEntityLinkId": "7145baed-60c1-481f-a53c-3f31e7b8095e",
"Line1": "sample string 4",
"City": "sample string 5",
"State": "sample string 6",
"Zip5": "sample string 7",
"Zip4": "sample string 8",
"isPrimary": true,
"PrimaryContactDisplayName": "sample string 9",
"PrimaryContactEmail": "sample string 10",
"PrimaryContactPhone": "sample string 11",
"isCandidate": true,
"Line2": "sample string 13",
"Address": "sample string 4\r\nsample string 13\r\nsample string 5\r\n\r\nsample string 6\r\n sample string 7-sample string 8",
"BalanceUsage": 1,
"GroupName": "sample string 14",
"OrderBy": "sample string 15",
"IsAscending": true,
"PageNum": 17,
"PageSize": 18,
"Filter": "sample string 19",
"FromEntityType": "sample string 20",
"ToEntityType": "sample string 21",
"FromEntityLinkId": "0f0bfda1-e6a6-4854-8aa3-8b5a67f0bc24",
"FromEntityId": "dd839c5f-da68-4ac5-8cf9-e38294a30e87",
"PairId": "95bc4a64-cf46-44cb-acb2-511a9561f56c",
"DirectionName": "sample string 22",
"ToEntityLink": "/Organization/Select?id=53d7a0a2-d2bc-4a40-a5d1-ba6d6d597fc5",
"FromEntityLink": "/Organization/Select?id=dd839c5f-da68-4ac5-8cf9-e38294a30e87",
"IsComplianceType": true,
"IsInternal": true,
"ToEntityId": "53d7a0a2-d2bc-4a40-a5d1-ba6d6d597fc5",
"ConfirmDelete": true,
"SkipRelations": true
}
]
}
application/xml, text/xml
Sample:
<EntityAffiliationList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aristotle.CM.Model">
<AvailableRelations>
<EntityAffiliation>
<BalanceUsage>1</BalanceUsage>
<City>sample string 5</City>
<ConfirmDelete>true</ConfirmDelete>
<DirectionName>sample string 22</DirectionName>
<EntityName>sample string 3</EntityName>
<Filter>sample string 19</Filter>
<FromEntityAffiliationId>b6a9f919-536b-4930-a3df-535f946792b7</FromEntityAffiliationId>
<FromEntityAffiliationName>sample string 2</FromEntityAffiliationName>
<FromEntityId>dd839c5f-da68-4ac5-8cf9-e38294a30e87</FromEntityId>
<FromEntityLinkId>0f0bfda1-e6a6-4854-8aa3-8b5a67f0bc24</FromEntityLinkId>
<FromEntityType>sample string 20</FromEntityType>
<GroupName>sample string 14</GroupName>
<IsAscending>true</IsAscending>
<IsComplianceType>true</IsComplianceType>
<IsInternal>true</IsInternal>
<IsLegislator>true</IsLegislator>
<Line1>sample string 4</Line1>
<Line2>sample string 13</Line2>
<OrderBy>sample string 15</OrderBy>
<PageNum>17</PageNum>
<PageSize>18</PageSize>
<PairId>95bc4a64-cf46-44cb-acb2-511a9561f56c</PairId>
<PrimaryContactDisplayName>sample string 9</PrimaryContactDisplayName>
<PrimaryContactEmail>sample string 10</PrimaryContactEmail>
<PrimaryContactPhone>sample string 11</PrimaryContactPhone>
<SkipRelations>true</SkipRelations>
<State>sample string 6</State>
<ToEntityAffiliationId>75e94f72-d9c1-4bed-875b-96650981ac75</ToEntityAffiliationId>
<ToEntityAffiliationName>sample string 1</ToEntityAffiliationName>
<ToEntityId>53d7a0a2-d2bc-4a40-a5d1-ba6d6d597fc5</ToEntityId>
<ToEntityLinkId>7145baed-60c1-481f-a53c-3f31e7b8095e</ToEntityLinkId>
<ToEntityType>sample string 21</ToEntityType>
<Zip4>sample string 8</Zip4>
<Zip5>sample string 7</Zip5>
<isCandidate>true</isCandidate>
<isPrimary>true</isPrimary>
</EntityAffiliation>
<EntityAffiliation>
<BalanceUsage>1</BalanceUsage>
<City>sample string 5</City>
<ConfirmDelete>true</ConfirmDelete>
<DirectionName>sample string 22</DirectionName>
<EntityName>sample string 3</EntityName>
<Filter>sample string 19</Filter>
<FromEntityAffiliationId>b6a9f919-536b-4930-a3df-535f946792b7</FromEntityAffiliationId>
<FromEntityAffiliationName>sample string 2</FromEntityAffiliationName>
<FromEntityId>dd839c5f-da68-4ac5-8cf9-e38294a30e87</FromEntityId>
<FromEntityLinkId>0f0bfda1-e6a6-4854-8aa3-8b5a67f0bc24</FromEntityLinkId>
<FromEntityType>sample string 20</FromEntityType>
<GroupName>sample string 14</GroupName>
<IsAscending>true</IsAscending>
<IsComplianceType>true</IsComplianceType>
<IsInternal>true</IsInternal>
<IsLegislator>true</IsLegislator>
<Line1>sample string 4</Line1>
<Line2>sample string 13</Line2>
<OrderBy>sample string 15</OrderBy>
<PageNum>17</PageNum>
<PageSize>18</PageSize>
<PairId>95bc4a64-cf46-44cb-acb2-511a9561f56c</PairId>
<PrimaryContactDisplayName>sample string 9</PrimaryContactDisplayName>
<PrimaryContactEmail>sample string 10</PrimaryContactEmail>
<PrimaryContactPhone>sample string 11</PrimaryContactPhone>
<SkipRelations>true</SkipRelations>
<State>sample string 6</State>
<ToEntityAffiliationId>75e94f72-d9c1-4bed-875b-96650981ac75</ToEntityAffiliationId>
<ToEntityAffiliationName>sample string 1</ToEntityAffiliationName>
<ToEntityId>53d7a0a2-d2bc-4a40-a5d1-ba6d6d597fc5</ToEntityId>
<ToEntityLinkId>7145baed-60c1-481f-a53c-3f31e7b8095e</ToEntityLinkId>
<ToEntityType>sample string 21</ToEntityType>
<Zip4>sample string 8</Zip4>
<Zip5>sample string 7</Zip5>
<isCandidate>true</isCandidate>
<isPrimary>true</isPrimary>
</EntityAffiliation>
</AvailableRelations>
<Results>
<EntityAffiliation>
<BalanceUsage>1</BalanceUsage>
<City>sample string 5</City>
<ConfirmDelete>true</ConfirmDelete>
<DirectionName>sample string 22</DirectionName>
<EntityName>sample string 3</EntityName>
<Filter>sample string 19</Filter>
<FromEntityAffiliationId>b6a9f919-536b-4930-a3df-535f946792b7</FromEntityAffiliationId>
<FromEntityAffiliationName>sample string 2</FromEntityAffiliationName>
<FromEntityId>dd839c5f-da68-4ac5-8cf9-e38294a30e87</FromEntityId>
<FromEntityLinkId>0f0bfda1-e6a6-4854-8aa3-8b5a67f0bc24</FromEntityLinkId>
<FromEntityType>sample string 20</FromEntityType>
<GroupName>sample string 14</GroupName>
<IsAscending>true</IsAscending>
<IsComplianceType>true</IsComplianceType>
<IsInternal>true</IsInternal>
<IsLegislator>true</IsLegislator>
<Line1>sample string 4</Line1>
<Line2>sample string 13</Line2>
<OrderBy>sample string 15</OrderBy>
<PageNum>17</PageNum>
<PageSize>18</PageSize>
<PairId>95bc4a64-cf46-44cb-acb2-511a9561f56c</PairId>
<PrimaryContactDisplayName>sample string 9</PrimaryContactDisplayName>
<PrimaryContactEmail>sample string 10</PrimaryContactEmail>
<PrimaryContactPhone>sample string 11</PrimaryContactPhone>
<SkipRelations>true</SkipRelations>
<State>sample string 6</State>
<ToEntityAffiliationId>75e94f72-d9c1-4bed-875b-96650981ac75</ToEntityAffiliationId>
<ToEntityAffiliationName>sample string 1</ToEntityAffiliationName>
<ToEntityId>53d7a0a2-d2bc-4a40-a5d1-ba6d6d597fc5</ToEntityId>
<ToEntityLinkId>7145baed-60c1-481f-a53c-3f31e7b8095e</ToEntityLinkId>
<ToEntityType>sample string 21</ToEntityType>
<Zip4>sample string 8</Zip4>
<Zip5>sample string 7</Zip5>
<isCandidate>true</isCandidate>
<isPrimary>true</isPrimary>
</EntityAffiliation>
<EntityAffiliation>
<BalanceUsage>1</BalanceUsage>
<City>sample string 5</City>
<ConfirmDelete>true</ConfirmDelete>
<DirectionName>sample string 22</DirectionName>
<EntityName>sample string 3</EntityName>
<Filter>sample string 19</Filter>
<FromEntityAffiliationId>b6a9f919-536b-4930-a3df-535f946792b7</FromEntityAffiliationId>
<FromEntityAffiliationName>sample string 2</FromEntityAffiliationName>
<FromEntityId>dd839c5f-da68-4ac5-8cf9-e38294a30e87</FromEntityId>
<FromEntityLinkId>0f0bfda1-e6a6-4854-8aa3-8b5a67f0bc24</FromEntityLinkId>
<FromEntityType>sample string 20</FromEntityType>
<GroupName>sample string 14</GroupName>
<IsAscending>true</IsAscending>
<IsComplianceType>true</IsComplianceType>
<IsInternal>true</IsInternal>
<IsLegislator>true</IsLegislator>
<Line1>sample string 4</Line1>
<Line2>sample string 13</Line2>
<OrderBy>sample string 15</OrderBy>
<PageNum>17</PageNum>
<PageSize>18</PageSize>
<PairId>95bc4a64-cf46-44cb-acb2-511a9561f56c</PairId>
<PrimaryContactDisplayName>sample string 9</PrimaryContactDisplayName>
<PrimaryContactEmail>sample string 10</PrimaryContactEmail>
<PrimaryContactPhone>sample string 11</PrimaryContactPhone>
<SkipRelations>true</SkipRelations>
<State>sample string 6</State>
<ToEntityAffiliationId>75e94f72-d9c1-4bed-875b-96650981ac75</ToEntityAffiliationId>
<ToEntityAffiliationName>sample string 1</ToEntityAffiliationName>
<ToEntityId>53d7a0a2-d2bc-4a40-a5d1-ba6d6d597fc5</ToEntityId>
<ToEntityLinkId>7145baed-60c1-481f-a53c-3f31e7b8095e</ToEntityLinkId>
<ToEntityType>sample string 21</ToEntityType>
<Zip4>sample string 8</Zip4>
<Zip5>sample string 7</Zip5>
<isCandidate>true</isCandidate>
<isPrimary>true</isPrimary>
</EntityAffiliation>
</Results>
<TotalRecords>1</TotalRecords>
</EntityAffiliationList>