POST {version}/Entity/GetEntityAffiliationList

Request Information

URI Parameters

Name	Description	Type	Additional information
version		string	None.

Body Parameters

EntityAffiliation

Name	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": "21274480-e2a7-4388-9598-a6978b5e0fd6",
  "ToEntityAffiliationName": "sample string 1",
  "FromEntityAffiliationId": "c07e4227-9727-4929-9312-969f4f1b4cdc",
  "FromEntityAffiliationName": "sample string 2",
  "IsLegislator": true,
  "EntityName": "sample string 3",
  "ToEntityLinkId": "e4651687-4602-4964-8cb1-ed2fb4564e65",
  "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": "64598101-ffdf-402d-9000-d9ba27450660",
  "FromEntityId": "15cbff1e-56f8-47eb-b422-e315e40e65a6",
  "PairId": "91a3d8e3-1f9e-4a0f-93c7-1074a49d2c9a",
  "DirectionName": "sample string 22",
  "ToEntityLink": "/Organization/Select?id=da0e7425-7f2a-46eb-8664-6353491c6056",
  "FromEntityLink": "/Organization/Select?id=15cbff1e-56f8-47eb-b422-e315e40e65a6",
  "IsComplianceType": true,
  "IsInternal": true,
  "ToEntityId": "da0e7425-7f2a-46eb-8664-6353491c6056",
  "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>c07e4227-9727-4929-9312-969f4f1b4cdc</FromEntityAffiliationId>
  <FromEntityAffiliationName>sample string 2</FromEntityAffiliationName>
  <FromEntityId>15cbff1e-56f8-47eb-b422-e315e40e65a6</FromEntityId>
  <FromEntityLinkId>64598101-ffdf-402d-9000-d9ba27450660</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>91a3d8e3-1f9e-4a0f-93c7-1074a49d2c9a</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>21274480-e2a7-4388-9598-a6978b5e0fd6</ToEntityAffiliationId>
  <ToEntityAffiliationName>sample string 1</ToEntityAffiliationName>
  <ToEntityId>da0e7425-7f2a-46eb-8664-6353491c6056</ToEntityId>
  <ToEntityLinkId>e4651687-4602-4964-8cb1-ed2fb4564e65</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	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": "402fd2c0-6f9d-4368-bc06-c7c17823c6d5",
      "ToEntityAffiliationName": "sample string 1",
      "FromEntityAffiliationId": "404caacb-3c47-470b-b1fc-cd911b26aabf",
      "FromEntityAffiliationName": "sample string 2",
      "IsLegislator": true,
      "EntityName": "sample string 3",
      "ToEntityLinkId": "10f5c8c6-7b7c-4e99-a9d4-2b5616da3ddf",
      "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": "457e0761-08a6-4758-99d0-0c86454285d2",
      "FromEntityId": "006ec72a-a5e2-4459-bb61-cbd807a22d4e",
      "PairId": "65591cb5-475a-4ff4-be81-3d996e7c6b84",
      "DirectionName": "sample string 22",
      "ToEntityLink": "/Organization/Select?id=6e98388f-044a-49c4-bd83-4f55eece7960",
      "FromEntityLink": "/Organization/Select?id=006ec72a-a5e2-4459-bb61-cbd807a22d4e",
      "IsComplianceType": true,
      "IsInternal": true,
      "ToEntityId": "6e98388f-044a-49c4-bd83-4f55eece7960",
      "ConfirmDelete": true,
      "SkipRelations": true
    },
    {
      "ToEntityAffiliationId": "402fd2c0-6f9d-4368-bc06-c7c17823c6d5",
      "ToEntityAffiliationName": "sample string 1",
      "FromEntityAffiliationId": "404caacb-3c47-470b-b1fc-cd911b26aabf",
      "FromEntityAffiliationName": "sample string 2",
      "IsLegislator": true,
      "EntityName": "sample string 3",
      "ToEntityLinkId": "10f5c8c6-7b7c-4e99-a9d4-2b5616da3ddf",
      "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": "457e0761-08a6-4758-99d0-0c86454285d2",
      "FromEntityId": "006ec72a-a5e2-4459-bb61-cbd807a22d4e",
      "PairId": "65591cb5-475a-4ff4-be81-3d996e7c6b84",
      "DirectionName": "sample string 22",
      "ToEntityLink": "/Organization/Select?id=6e98388f-044a-49c4-bd83-4f55eece7960",
      "FromEntityLink": "/Organization/Select?id=006ec72a-a5e2-4459-bb61-cbd807a22d4e",
      "IsComplianceType": true,
      "IsInternal": true,
      "ToEntityId": "6e98388f-044a-49c4-bd83-4f55eece7960",
      "ConfirmDelete": true,
      "SkipRelations": true
    }
  ],
  "TotalRecords": 1,
  "AvailableRelations": [
    {
      "ToEntityAffiliationId": "402fd2c0-6f9d-4368-bc06-c7c17823c6d5",
      "ToEntityAffiliationName": "sample string 1",
      "FromEntityAffiliationId": "404caacb-3c47-470b-b1fc-cd911b26aabf",
      "FromEntityAffiliationName": "sample string 2",
      "IsLegislator": true,
      "EntityName": "sample string 3",
      "ToEntityLinkId": "10f5c8c6-7b7c-4e99-a9d4-2b5616da3ddf",
      "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": "457e0761-08a6-4758-99d0-0c86454285d2",
      "FromEntityId": "006ec72a-a5e2-4459-bb61-cbd807a22d4e",
      "PairId": "65591cb5-475a-4ff4-be81-3d996e7c6b84",
      "DirectionName": "sample string 22",
      "ToEntityLink": "/Organization/Select?id=6e98388f-044a-49c4-bd83-4f55eece7960",
      "FromEntityLink": "/Organization/Select?id=006ec72a-a5e2-4459-bb61-cbd807a22d4e",
      "IsComplianceType": true,
      "IsInternal": true,
      "ToEntityId": "6e98388f-044a-49c4-bd83-4f55eece7960",
      "ConfirmDelete": true,
      "SkipRelations": true
    },
    {
      "ToEntityAffiliationId": "402fd2c0-6f9d-4368-bc06-c7c17823c6d5",
      "ToEntityAffiliationName": "sample string 1",
      "FromEntityAffiliationId": "404caacb-3c47-470b-b1fc-cd911b26aabf",
      "FromEntityAffiliationName": "sample string 2",
      "IsLegislator": true,
      "EntityName": "sample string 3",
      "ToEntityLinkId": "10f5c8c6-7b7c-4e99-a9d4-2b5616da3ddf",
      "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": "457e0761-08a6-4758-99d0-0c86454285d2",
      "FromEntityId": "006ec72a-a5e2-4459-bb61-cbd807a22d4e",
      "PairId": "65591cb5-475a-4ff4-be81-3d996e7c6b84",
      "DirectionName": "sample string 22",
      "ToEntityLink": "/Organization/Select?id=6e98388f-044a-49c4-bd83-4f55eece7960",
      "FromEntityLink": "/Organization/Select?id=006ec72a-a5e2-4459-bb61-cbd807a22d4e",
      "IsComplianceType": true,
      "IsInternal": true,
      "ToEntityId": "6e98388f-044a-49c4-bd83-4f55eece7960",
      "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>404caacb-3c47-470b-b1fc-cd911b26aabf</FromEntityAffiliationId>
      <FromEntityAffiliationName>sample string 2</FromEntityAffiliationName>
      <FromEntityId>006ec72a-a5e2-4459-bb61-cbd807a22d4e</FromEntityId>
      <FromEntityLinkId>457e0761-08a6-4758-99d0-0c86454285d2</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>65591cb5-475a-4ff4-be81-3d996e7c6b84</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>402fd2c0-6f9d-4368-bc06-c7c17823c6d5</ToEntityAffiliationId>
      <ToEntityAffiliationName>sample string 1</ToEntityAffiliationName>
      <ToEntityId>6e98388f-044a-49c4-bd83-4f55eece7960</ToEntityId>
      <ToEntityLinkId>10f5c8c6-7b7c-4e99-a9d4-2b5616da3ddf</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>404caacb-3c47-470b-b1fc-cd911b26aabf</FromEntityAffiliationId>
      <FromEntityAffiliationName>sample string 2</FromEntityAffiliationName>
      <FromEntityId>006ec72a-a5e2-4459-bb61-cbd807a22d4e</FromEntityId>
      <FromEntityLinkId>457e0761-08a6-4758-99d0-0c86454285d2</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>65591cb5-475a-4ff4-be81-3d996e7c6b84</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>402fd2c0-6f9d-4368-bc06-c7c17823c6d5</ToEntityAffiliationId>
      <ToEntityAffiliationName>sample string 1</ToEntityAffiliationName>
      <ToEntityId>6e98388f-044a-49c4-bd83-4f55eece7960</ToEntityId>
      <ToEntityLinkId>10f5c8c6-7b7c-4e99-a9d4-2b5616da3ddf</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>404caacb-3c47-470b-b1fc-cd911b26aabf</FromEntityAffiliationId>
      <FromEntityAffiliationName>sample string 2</FromEntityAffiliationName>
      <FromEntityId>006ec72a-a5e2-4459-bb61-cbd807a22d4e</FromEntityId>
      <FromEntityLinkId>457e0761-08a6-4758-99d0-0c86454285d2</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>65591cb5-475a-4ff4-be81-3d996e7c6b84</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>402fd2c0-6f9d-4368-bc06-c7c17823c6d5</ToEntityAffiliationId>
      <ToEntityAffiliationName>sample string 1</ToEntityAffiliationName>
      <ToEntityId>6e98388f-044a-49c4-bd83-4f55eece7960</ToEntityId>
      <ToEntityLinkId>10f5c8c6-7b7c-4e99-a9d4-2b5616da3ddf</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>404caacb-3c47-470b-b1fc-cd911b26aabf</FromEntityAffiliationId>
      <FromEntityAffiliationName>sample string 2</FromEntityAffiliationName>
      <FromEntityId>006ec72a-a5e2-4459-bb61-cbd807a22d4e</FromEntityId>
      <FromEntityLinkId>457e0761-08a6-4758-99d0-0c86454285d2</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>65591cb5-475a-4ff4-be81-3d996e7c6b84</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>402fd2c0-6f9d-4368-bc06-c7c17823c6d5</ToEntityAffiliationId>
      <ToEntityAffiliationName>sample string 1</ToEntityAffiliationName>
      <ToEntityId>6e98388f-044a-49c4-bd83-4f55eece7960</ToEntityId>
      <ToEntityLinkId>10f5c8c6-7b7c-4e99-a9d4-2b5616da3ddf</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>