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": "78f4c0b6-0a3e-4643-b163-988a7f90f228",
"ToEntityAffiliationName": "sample string 1",
"FromEntityAffiliationId": "a081b599-8554-4742-9f0f-db0f1a61feab",
"FromEntityAffiliationName": "sample string 2",
"IsLegislator": true,
"EntityName": "sample string 3",
"ToEntityLinkId": "ab438607-a343-4f4a-b05e-7939c06e17fa",
"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": "4199c949-9600-4510-973e-fbb917ce93c4",
"FromEntityId": "5b447dae-6fd8-4b27-9205-542e8531422f",
"PairId": "348b1ade-91b3-425c-82ec-fefbeb90ad48",
"DirectionName": "sample string 22",
"ToEntityLink": "/Organization/Select?id=e04cb721-7bd5-45cf-a6f3-b482aa700207",
"FromEntityLink": "/Organization/Select?id=5b447dae-6fd8-4b27-9205-542e8531422f",
"IsComplianceType": true,
"IsInternal": true,
"ToEntityId": "e04cb721-7bd5-45cf-a6f3-b482aa700207",
"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>a081b599-8554-4742-9f0f-db0f1a61feab</FromEntityAffiliationId> <FromEntityAffiliationName>sample string 2</FromEntityAffiliationName> <FromEntityId>5b447dae-6fd8-4b27-9205-542e8531422f</FromEntityId> <FromEntityLinkId>4199c949-9600-4510-973e-fbb917ce93c4</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>348b1ade-91b3-425c-82ec-fefbeb90ad48</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>78f4c0b6-0a3e-4643-b163-988a7f90f228</ToEntityAffiliationId> <ToEntityAffiliationName>sample string 1</ToEntityAffiliationName> <ToEntityId>e04cb721-7bd5-45cf-a6f3-b482aa700207</ToEntityId> <ToEntityLinkId>ab438607-a343-4f4a-b05e-7939c06e17fa</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": "9eab5887-385f-4911-bd11-60a1143df3b5",
"ToEntityAffiliationName": "sample string 1",
"FromEntityAffiliationId": "17244b9c-d5a8-4e15-a52e-42e5720b397b",
"FromEntityAffiliationName": "sample string 2",
"IsLegislator": true,
"EntityName": "sample string 3",
"ToEntityLinkId": "3c445f78-002c-4110-babf-24a964c14e3a",
"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": "394863dd-e12b-402c-a2df-122eb4009e59",
"FromEntityId": "2fc15045-5bb6-49be-a206-4cae5c08351b",
"PairId": "9c3497ba-89ad-4111-a87e-2a6c84b45755",
"DirectionName": "sample string 22",
"ToEntityLink": "/Organization/Select?id=dda193ba-67d0-44e4-ac77-411c561a7325",
"FromEntityLink": "/Organization/Select?id=2fc15045-5bb6-49be-a206-4cae5c08351b",
"IsComplianceType": true,
"IsInternal": true,
"ToEntityId": "dda193ba-67d0-44e4-ac77-411c561a7325",
"ConfirmDelete": true,
"SkipRelations": true
},
{
"ToEntityAffiliationId": "9eab5887-385f-4911-bd11-60a1143df3b5",
"ToEntityAffiliationName": "sample string 1",
"FromEntityAffiliationId": "17244b9c-d5a8-4e15-a52e-42e5720b397b",
"FromEntityAffiliationName": "sample string 2",
"IsLegislator": true,
"EntityName": "sample string 3",
"ToEntityLinkId": "3c445f78-002c-4110-babf-24a964c14e3a",
"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": "394863dd-e12b-402c-a2df-122eb4009e59",
"FromEntityId": "2fc15045-5bb6-49be-a206-4cae5c08351b",
"PairId": "9c3497ba-89ad-4111-a87e-2a6c84b45755",
"DirectionName": "sample string 22",
"ToEntityLink": "/Organization/Select?id=dda193ba-67d0-44e4-ac77-411c561a7325",
"FromEntityLink": "/Organization/Select?id=2fc15045-5bb6-49be-a206-4cae5c08351b",
"IsComplianceType": true,
"IsInternal": true,
"ToEntityId": "dda193ba-67d0-44e4-ac77-411c561a7325",
"ConfirmDelete": true,
"SkipRelations": true
}
],
"TotalRecords": 1,
"AvailableRelations": [
{
"ToEntityAffiliationId": "9eab5887-385f-4911-bd11-60a1143df3b5",
"ToEntityAffiliationName": "sample string 1",
"FromEntityAffiliationId": "17244b9c-d5a8-4e15-a52e-42e5720b397b",
"FromEntityAffiliationName": "sample string 2",
"IsLegislator": true,
"EntityName": "sample string 3",
"ToEntityLinkId": "3c445f78-002c-4110-babf-24a964c14e3a",
"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": "394863dd-e12b-402c-a2df-122eb4009e59",
"FromEntityId": "2fc15045-5bb6-49be-a206-4cae5c08351b",
"PairId": "9c3497ba-89ad-4111-a87e-2a6c84b45755",
"DirectionName": "sample string 22",
"ToEntityLink": "/Organization/Select?id=dda193ba-67d0-44e4-ac77-411c561a7325",
"FromEntityLink": "/Organization/Select?id=2fc15045-5bb6-49be-a206-4cae5c08351b",
"IsComplianceType": true,
"IsInternal": true,
"ToEntityId": "dda193ba-67d0-44e4-ac77-411c561a7325",
"ConfirmDelete": true,
"SkipRelations": true
},
{
"ToEntityAffiliationId": "9eab5887-385f-4911-bd11-60a1143df3b5",
"ToEntityAffiliationName": "sample string 1",
"FromEntityAffiliationId": "17244b9c-d5a8-4e15-a52e-42e5720b397b",
"FromEntityAffiliationName": "sample string 2",
"IsLegislator": true,
"EntityName": "sample string 3",
"ToEntityLinkId": "3c445f78-002c-4110-babf-24a964c14e3a",
"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": "394863dd-e12b-402c-a2df-122eb4009e59",
"FromEntityId": "2fc15045-5bb6-49be-a206-4cae5c08351b",
"PairId": "9c3497ba-89ad-4111-a87e-2a6c84b45755",
"DirectionName": "sample string 22",
"ToEntityLink": "/Organization/Select?id=dda193ba-67d0-44e4-ac77-411c561a7325",
"FromEntityLink": "/Organization/Select?id=2fc15045-5bb6-49be-a206-4cae5c08351b",
"IsComplianceType": true,
"IsInternal": true,
"ToEntityId": "dda193ba-67d0-44e4-ac77-411c561a7325",
"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>17244b9c-d5a8-4e15-a52e-42e5720b397b</FromEntityAffiliationId>
<FromEntityAffiliationName>sample string 2</FromEntityAffiliationName>
<FromEntityId>2fc15045-5bb6-49be-a206-4cae5c08351b</FromEntityId>
<FromEntityLinkId>394863dd-e12b-402c-a2df-122eb4009e59</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>9c3497ba-89ad-4111-a87e-2a6c84b45755</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>9eab5887-385f-4911-bd11-60a1143df3b5</ToEntityAffiliationId>
<ToEntityAffiliationName>sample string 1</ToEntityAffiliationName>
<ToEntityId>dda193ba-67d0-44e4-ac77-411c561a7325</ToEntityId>
<ToEntityLinkId>3c445f78-002c-4110-babf-24a964c14e3a</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>17244b9c-d5a8-4e15-a52e-42e5720b397b</FromEntityAffiliationId>
<FromEntityAffiliationName>sample string 2</FromEntityAffiliationName>
<FromEntityId>2fc15045-5bb6-49be-a206-4cae5c08351b</FromEntityId>
<FromEntityLinkId>394863dd-e12b-402c-a2df-122eb4009e59</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>9c3497ba-89ad-4111-a87e-2a6c84b45755</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>9eab5887-385f-4911-bd11-60a1143df3b5</ToEntityAffiliationId>
<ToEntityAffiliationName>sample string 1</ToEntityAffiliationName>
<ToEntityId>dda193ba-67d0-44e4-ac77-411c561a7325</ToEntityId>
<ToEntityLinkId>3c445f78-002c-4110-babf-24a964c14e3a</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>17244b9c-d5a8-4e15-a52e-42e5720b397b</FromEntityAffiliationId>
<FromEntityAffiliationName>sample string 2</FromEntityAffiliationName>
<FromEntityId>2fc15045-5bb6-49be-a206-4cae5c08351b</FromEntityId>
<FromEntityLinkId>394863dd-e12b-402c-a2df-122eb4009e59</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>9c3497ba-89ad-4111-a87e-2a6c84b45755</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>9eab5887-385f-4911-bd11-60a1143df3b5</ToEntityAffiliationId>
<ToEntityAffiliationName>sample string 1</ToEntityAffiliationName>
<ToEntityId>dda193ba-67d0-44e4-ac77-411c561a7325</ToEntityId>
<ToEntityLinkId>3c445f78-002c-4110-babf-24a964c14e3a</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>17244b9c-d5a8-4e15-a52e-42e5720b397b</FromEntityAffiliationId>
<FromEntityAffiliationName>sample string 2</FromEntityAffiliationName>
<FromEntityId>2fc15045-5bb6-49be-a206-4cae5c08351b</FromEntityId>
<FromEntityLinkId>394863dd-e12b-402c-a2df-122eb4009e59</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>9c3497ba-89ad-4111-a87e-2a6c84b45755</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>9eab5887-385f-4911-bd11-60a1143df3b5</ToEntityAffiliationId>
<ToEntityAffiliationName>sample string 1</ToEntityAffiliationName>
<ToEntityId>dda193ba-67d0-44e4-ac77-411c561a7325</ToEntityId>
<ToEntityLinkId>3c445f78-002c-4110-babf-24a964c14e3a</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>