GET api/entity/family/GetFamilyList

Gets a list of information about the specified families.

Request Information

URI Parameters

Name	Description	Type	Additional information
FamilyIDs		Collection of integer	None.
Since		date	None.

Body Parameters

None.

Response Information

Resource Description

WebMethodResultOfListOfFamily

Name	Type	Additional information
Result	Collection of Family	None.
Success	boolean	None.
ErrorText	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Result": [
    {
      "FamilyID": 1,
      "P1PersonID": 1,
      "P1Relation": "sample string 2",
      "P2PersonID": 1,
      "P2Relation": "sample string 3",
      "HomePhone": "sample string 4",
      "HomeFax": "sample string 5",
      "Greeting": "sample string 6",
      "MailingTitle": "sample string 7",
      "AltMailingTitle": "sample string 8",
      "BillingPhone": "sample string 9",
      "BillingEmail": "sample string 10",
      "BillingEmail2": "sample string 11",
      "SummerPhone": "sample string 12",
      "LeadSource": "sample string 13",
      "LeadSourceMemo": "sample string 14",
      "ReceivesMail": true,
      "ReceivesInvoices": true,
      "InvoiceDeliveryMethodID": 17,
      "DepositPaymentMethodID": 18,
      "TimeStamp": {
        "Created": {
          "PersonID": 1,
          "DateTime": "sample string 1"
        },
        "Modified": {
          "PersonID": 1,
          "DateTime": "sample string 1"
        },
        "Archived": {
          "PersonID": 1,
          "DateTime": "sample string 1"
        }
      }
    },
    {
      "FamilyID": 1,
      "P1PersonID": 1,
      "P1Relation": "sample string 2",
      "P2PersonID": 1,
      "P2Relation": "sample string 3",
      "HomePhone": "sample string 4",
      "HomeFax": "sample string 5",
      "Greeting": "sample string 6",
      "MailingTitle": "sample string 7",
      "AltMailingTitle": "sample string 8",
      "BillingPhone": "sample string 9",
      "BillingEmail": "sample string 10",
      "BillingEmail2": "sample string 11",
      "SummerPhone": "sample string 12",
      "LeadSource": "sample string 13",
      "LeadSourceMemo": "sample string 14",
      "ReceivesMail": true,
      "ReceivesInvoices": true,
      "InvoiceDeliveryMethodID": 17,
      "DepositPaymentMethodID": 18,
      "TimeStamp": {
        "Created": {
          "PersonID": 1,
          "DateTime": "sample string 1"
        },
        "Modified": {
          "PersonID": 1,
          "DateTime": "sample string 1"
        },
        "Archived": {
          "PersonID": 1,
          "DateTime": "sample string 1"
        }
      }
    }
  ],
  "Success": true,
  "ErrorText": "sample string 2"
}

application/javascript

Sample:

{"Result":[{"FamilyID":1,"P1PersonID":1,"P1Relation":"sample string 2","P2PersonID":1,"P2Relation":"sample string 3","HomePhone":"sample string 4","HomeFax":"sample string 5","Greeting":"sample string 6","MailingTitle":"sample string 7","AltMailingTitle":"sample string 8","BillingPhone":"sample string 9","BillingEmail":"sample string 10","BillingEmail2":"sample string 11","SummerPhone":"sample string 12","LeadSource":"sample string 13","LeadSourceMemo":"sample string 14","ReceivesMail":true,"ReceivesInvoices":true,"InvoiceDeliveryMethodID":17,"DepositPaymentMethodID":18,"TimeStamp":{"Created":{"PersonID":1,"DateTime":"sample string 1"},"Modified":{"PersonID":1,"DateTime":"sample string 1"},"Archived":{"PersonID":1,"DateTime":"sample string 1"}}},{"FamilyID":1,"P1PersonID":1,"P1Relation":"sample string 2","P2PersonID":1,"P2Relation":"sample string 3","HomePhone":"sample string 4","HomeFax":"sample string 5","Greeting":"sample string 6","MailingTitle":"sample string 7","AltMailingTitle":"sample string 8","BillingPhone":"sample string 9","BillingEmail":"sample string 10","BillingEmail2":"sample string 11","SummerPhone":"sample string 12","LeadSource":"sample string 13","LeadSourceMemo":"sample string 14","ReceivesMail":true,"ReceivesInvoices":true,"InvoiceDeliveryMethodID":17,"DepositPaymentMethodID":18,"TimeStamp":{"Created":{"PersonID":1,"DateTime":"sample string 1"},"Modified":{"PersonID":1,"DateTime":"sample string 1"},"Archived":{"PersonID":1,"DateTime":"sample string 1"}}}],"Success":true,"ErrorText":"sample string 2"}

application/xml, text/xml

Sample:

<WebMethodResultOfListOfFamily xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Success>true</Success>
  <ErrorText>sample string 2</ErrorText>
  <Result>
    <Family>
      <FamilyID>1</FamilyID>
      <P1PersonID>1</P1PersonID>
      <P1Relation>sample string 2</P1Relation>
      <P2PersonID>1</P2PersonID>
      <P2Relation>sample string 3</P2Relation>
      <HomePhone>sample string 4</HomePhone>
      <HomeFax>sample string 5</HomeFax>
      <Greeting>sample string 6</Greeting>
      <MailingTitle>sample string 7</MailingTitle>
      <AltMailingTitle>sample string 8</AltMailingTitle>
      <BillingPhone>sample string 9</BillingPhone>
      <BillingEmail>sample string 10</BillingEmail>
      <BillingEmail2>sample string 11</BillingEmail2>
      <SummerPhone>sample string 12</SummerPhone>
      <LeadSource>sample string 13</LeadSource>
      <LeadSourceMemo>sample string 14</LeadSourceMemo>
      <ReceivesMail>true</ReceivesMail>
      <ReceivesInvoices>true</ReceivesInvoices>
      <InvoiceDeliveryMethodID>17</InvoiceDeliveryMethodID>
      <DepositPaymentMethodID>18</DepositPaymentMethodID>
      <TimeStamp>
        <Created>
          <PersonID>1</PersonID>
          <DateTime>sample string 1</DateTime>
        </Created>
        <Modified>
          <PersonID>1</PersonID>
          <DateTime>sample string 1</DateTime>
        </Modified>
        <Archived>
          <PersonID>1</PersonID>
          <DateTime>sample string 1</DateTime>
        </Archived>
      </TimeStamp>
    </Family>
    <Family>
      <FamilyID>1</FamilyID>
      <P1PersonID>1</P1PersonID>
      <P1Relation>sample string 2</P1Relation>
      <P2PersonID>1</P2PersonID>
      <P2Relation>sample string 3</P2Relation>
      <HomePhone>sample string 4</HomePhone>
      <HomeFax>sample string 5</HomeFax>
      <Greeting>sample string 6</Greeting>
      <MailingTitle>sample string 7</MailingTitle>
      <AltMailingTitle>sample string 8</AltMailingTitle>
      <BillingPhone>sample string 9</BillingPhone>
      <BillingEmail>sample string 10</BillingEmail>
      <BillingEmail2>sample string 11</BillingEmail2>
      <SummerPhone>sample string 12</SummerPhone>
      <LeadSource>sample string 13</LeadSource>
      <LeadSourceMemo>sample string 14</LeadSourceMemo>
      <ReceivesMail>true</ReceivesMail>
      <ReceivesInvoices>true</ReceivesInvoices>
      <InvoiceDeliveryMethodID>17</InvoiceDeliveryMethodID>
      <DepositPaymentMethodID>18</DepositPaymentMethodID>
      <TimeStamp>
        <Created>
          <PersonID>1</PersonID>
          <DateTime>sample string 1</DateTime>
        </Created>
        <Modified>
          <PersonID>1</PersonID>
          <DateTime>sample string 1</DateTime>
        </Modified>
        <Archived>
          <PersonID>1</PersonID>
          <DateTime>sample string 1</DateTime>
        </Archived>
      </TimeStamp>
    </Family>
  </Result>
</WebMethodResultOfListOfFamily>