POST {version}/Entity/GetEntityAffiliationList
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
version | string |
None. |
Body Parameters
EntityAffiliationName | 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": "58e2f1c2-19ac-4777-bfce-290e4efdf4cb", "ToEntityAffiliationName": "sample string 1", "FromEntityAffiliationId": "2a8040a6-7701-4c7e-9371-9ad859b84e06", "FromEntityAffiliationName": "sample string 2", "IsLegislator": true, "EntityName": "sample string 3", "ToEntityLinkId": "d4648b40-2751-44cf-8810-2e3eff7f463c", "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": "a10fbbc9-12a3-4e97-84a8-4560cc123f3c", "FromEntityId": "1f2c7c0c-4e34-49f9-b6a7-721a4cc617b9", "PairId": "492f00c5-ebd3-41d1-a3ed-b71bf62b7429", "DirectionName": "sample string 22", "ToEntityLink": "/Organization/Select?id=d3e6572e-843f-456c-be4f-17133d8da78b", "FromEntityLink": "/Organization/Select?id=1f2c7c0c-4e34-49f9-b6a7-721a4cc617b9", "IsComplianceType": true, "IsInternal": true, "ToEntityId": "d3e6572e-843f-456c-be4f-17133d8da78b", "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>2a8040a6-7701-4c7e-9371-9ad859b84e06</FromEntityAffiliationId> <FromEntityAffiliationName>sample string 2</FromEntityAffiliationName> <FromEntityId>1f2c7c0c-4e34-49f9-b6a7-721a4cc617b9</FromEntityId> <FromEntityLinkId>a10fbbc9-12a3-4e97-84a8-4560cc123f3c</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>492f00c5-ebd3-41d1-a3ed-b71bf62b7429</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>58e2f1c2-19ac-4777-bfce-290e4efdf4cb</ToEntityAffiliationId> <ToEntityAffiliationName>sample string 1</ToEntityAffiliationName> <ToEntityId>d3e6572e-843f-456c-be4f-17133d8da78b</ToEntityId> <ToEntityLinkId>d4648b40-2751-44cf-8810-2e3eff7f463c</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
EntityAffiliationListName | 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": "7f769fdc-fe56-45e4-8b7a-5fdb95b7d7c8", "ToEntityAffiliationName": "sample string 1", "FromEntityAffiliationId": "52a6a90b-4931-47dd-b754-cb3e3678f8d7", "FromEntityAffiliationName": "sample string 2", "IsLegislator": true, "EntityName": "sample string 3", "ToEntityLinkId": "e2f6d448-dbc0-4171-b9c3-49594c0cbf30", "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": "ea024597-4151-4be0-b0b7-19099a56db97", "FromEntityId": "2a8d33ce-3bf5-4076-b2a9-ac69a89af7cb", "PairId": "14d2b7f1-a0d9-4191-a55f-142503ede001", "DirectionName": "sample string 22", "ToEntityLink": "/Organization/Select?id=37201309-51f0-4fb6-b8e8-3bcbaf3b9074", "FromEntityLink": "/Organization/Select?id=2a8d33ce-3bf5-4076-b2a9-ac69a89af7cb", "IsComplianceType": true, "IsInternal": true, "ToEntityId": "37201309-51f0-4fb6-b8e8-3bcbaf3b9074", "ConfirmDelete": true, "SkipRelations": true }, { "ToEntityAffiliationId": "7f769fdc-fe56-45e4-8b7a-5fdb95b7d7c8", "ToEntityAffiliationName": "sample string 1", "FromEntityAffiliationId": "52a6a90b-4931-47dd-b754-cb3e3678f8d7", "FromEntityAffiliationName": "sample string 2", "IsLegislator": true, "EntityName": "sample string 3", "ToEntityLinkId": "e2f6d448-dbc0-4171-b9c3-49594c0cbf30", "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": "ea024597-4151-4be0-b0b7-19099a56db97", "FromEntityId": "2a8d33ce-3bf5-4076-b2a9-ac69a89af7cb", "PairId": "14d2b7f1-a0d9-4191-a55f-142503ede001", "DirectionName": "sample string 22", "ToEntityLink": "/Organization/Select?id=37201309-51f0-4fb6-b8e8-3bcbaf3b9074", "FromEntityLink": "/Organization/Select?id=2a8d33ce-3bf5-4076-b2a9-ac69a89af7cb", "IsComplianceType": true, "IsInternal": true, "ToEntityId": "37201309-51f0-4fb6-b8e8-3bcbaf3b9074", "ConfirmDelete": true, "SkipRelations": true } ], "TotalRecords": 1, "AvailableRelations": [ { "ToEntityAffiliationId": "7f769fdc-fe56-45e4-8b7a-5fdb95b7d7c8", "ToEntityAffiliationName": "sample string 1", "FromEntityAffiliationId": "52a6a90b-4931-47dd-b754-cb3e3678f8d7", "FromEntityAffiliationName": "sample string 2", "IsLegislator": true, "EntityName": "sample string 3", "ToEntityLinkId": "e2f6d448-dbc0-4171-b9c3-49594c0cbf30", "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": "ea024597-4151-4be0-b0b7-19099a56db97", "FromEntityId": "2a8d33ce-3bf5-4076-b2a9-ac69a89af7cb", "PairId": "14d2b7f1-a0d9-4191-a55f-142503ede001", "DirectionName": "sample string 22", "ToEntityLink": "/Organization/Select?id=37201309-51f0-4fb6-b8e8-3bcbaf3b9074", "FromEntityLink": "/Organization/Select?id=2a8d33ce-3bf5-4076-b2a9-ac69a89af7cb", "IsComplianceType": true, "IsInternal": true, "ToEntityId": "37201309-51f0-4fb6-b8e8-3bcbaf3b9074", "ConfirmDelete": true, "SkipRelations": true }, { "ToEntityAffiliationId": "7f769fdc-fe56-45e4-8b7a-5fdb95b7d7c8", "ToEntityAffiliationName": "sample string 1", "FromEntityAffiliationId": "52a6a90b-4931-47dd-b754-cb3e3678f8d7", "FromEntityAffiliationName": "sample string 2", "IsLegislator": true, "EntityName": "sample string 3", "ToEntityLinkId": "e2f6d448-dbc0-4171-b9c3-49594c0cbf30", "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": "ea024597-4151-4be0-b0b7-19099a56db97", "FromEntityId": "2a8d33ce-3bf5-4076-b2a9-ac69a89af7cb", "PairId": "14d2b7f1-a0d9-4191-a55f-142503ede001", "DirectionName": "sample string 22", "ToEntityLink": "/Organization/Select?id=37201309-51f0-4fb6-b8e8-3bcbaf3b9074", "FromEntityLink": "/Organization/Select?id=2a8d33ce-3bf5-4076-b2a9-ac69a89af7cb", "IsComplianceType": true, "IsInternal": true, "ToEntityId": "37201309-51f0-4fb6-b8e8-3bcbaf3b9074", "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>52a6a90b-4931-47dd-b754-cb3e3678f8d7</FromEntityAffiliationId> <FromEntityAffiliationName>sample string 2</FromEntityAffiliationName> <FromEntityId>2a8d33ce-3bf5-4076-b2a9-ac69a89af7cb</FromEntityId> <FromEntityLinkId>ea024597-4151-4be0-b0b7-19099a56db97</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>14d2b7f1-a0d9-4191-a55f-142503ede001</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>7f769fdc-fe56-45e4-8b7a-5fdb95b7d7c8</ToEntityAffiliationId> <ToEntityAffiliationName>sample string 1</ToEntityAffiliationName> <ToEntityId>37201309-51f0-4fb6-b8e8-3bcbaf3b9074</ToEntityId> <ToEntityLinkId>e2f6d448-dbc0-4171-b9c3-49594c0cbf30</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>52a6a90b-4931-47dd-b754-cb3e3678f8d7</FromEntityAffiliationId> <FromEntityAffiliationName>sample string 2</FromEntityAffiliationName> <FromEntityId>2a8d33ce-3bf5-4076-b2a9-ac69a89af7cb</FromEntityId> <FromEntityLinkId>ea024597-4151-4be0-b0b7-19099a56db97</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>14d2b7f1-a0d9-4191-a55f-142503ede001</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>7f769fdc-fe56-45e4-8b7a-5fdb95b7d7c8</ToEntityAffiliationId> <ToEntityAffiliationName>sample string 1</ToEntityAffiliationName> <ToEntityId>37201309-51f0-4fb6-b8e8-3bcbaf3b9074</ToEntityId> <ToEntityLinkId>e2f6d448-dbc0-4171-b9c3-49594c0cbf30</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>52a6a90b-4931-47dd-b754-cb3e3678f8d7</FromEntityAffiliationId> <FromEntityAffiliationName>sample string 2</FromEntityAffiliationName> <FromEntityId>2a8d33ce-3bf5-4076-b2a9-ac69a89af7cb</FromEntityId> <FromEntityLinkId>ea024597-4151-4be0-b0b7-19099a56db97</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>14d2b7f1-a0d9-4191-a55f-142503ede001</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>7f769fdc-fe56-45e4-8b7a-5fdb95b7d7c8</ToEntityAffiliationId> <ToEntityAffiliationName>sample string 1</ToEntityAffiliationName> <ToEntityId>37201309-51f0-4fb6-b8e8-3bcbaf3b9074</ToEntityId> <ToEntityLinkId>e2f6d448-dbc0-4171-b9c3-49594c0cbf30</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>52a6a90b-4931-47dd-b754-cb3e3678f8d7</FromEntityAffiliationId> <FromEntityAffiliationName>sample string 2</FromEntityAffiliationName> <FromEntityId>2a8d33ce-3bf5-4076-b2a9-ac69a89af7cb</FromEntityId> <FromEntityLinkId>ea024597-4151-4be0-b0b7-19099a56db97</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>14d2b7f1-a0d9-4191-a55f-142503ede001</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>7f769fdc-fe56-45e4-8b7a-5fdb95b7d7c8</ToEntityAffiliationId> <ToEntityAffiliationName>sample string 1</ToEntityAffiliationName> <ToEntityId>37201309-51f0-4fb6-b8e8-3bcbaf3b9074</ToEntityId> <ToEntityLinkId>e2f6d448-dbc0-4171-b9c3-49594c0cbf30</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>