GET api/entity/family/GetFamilyPersons

Gets a list of family information about the specified people.

Request Information

URI Parameters

Name	Type	Additional information
PersonIDs	Collection of integer	None.
Roles	Collection of FamilyPersonRole	None.
IncludeExtendedResults	boolean	None.
Since	date	None.

Body Parameters

None.

Response Information

Resource Description

WebMethodResultOfListOfFamilyPerson

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

Response Formats

application/json, text/json

Sample:

{
  "Result": [
    {
      "FamilyID": 1,
      "PersonID": 2,
      "RoleID": 1,
      "Role": 1,
      "TimeStamp": {
        "Created": {
          "PersonID": 1,
          "DateTime": "sample string 1"
        },
        "Modified": {
          "PersonID": 1,
          "DateTime": "sample string 1"
        },
        "Archived": {
          "PersonID": 1,
          "DateTime": "sample string 1"
        }
      }
    },
    {
      "FamilyID": 1,
      "PersonID": 2,
      "RoleID": 1,
      "Role": 1,
      "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,"PersonID":2,"RoleID":1,"Role":1,"TimeStamp":{"Created":{"PersonID":1,"DateTime":"sample string 1"},"Modified":{"PersonID":1,"DateTime":"sample string 1"},"Archived":{"PersonID":1,"DateTime":"sample string 1"}}},{"FamilyID":1,"PersonID":2,"RoleID":1,"Role":1,"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:

<WebMethodResultOfListOfFamilyPerson 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>
    <FamilyPerson>
      <FamilyID>1</FamilyID>
      <PersonID>2</PersonID>
      <RoleID>1</RoleID>
      <Role>Parent1</Role>
      <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>
    </FamilyPerson>
    <FamilyPerson>
      <FamilyID>1</FamilyID>
      <PersonID>2</PersonID>
      <RoleID>1</RoleID>
      <Role>Parent1</Role>
      <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>
    </FamilyPerson>
  </Result>
</WebMethodResultOfListOfFamilyPerson>