GET api/FamilyMember

Get a list of family members for the logged in account

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

ApiResultOfListOfFamilyMember

Name	Description	Type	Additional information
Entity		Collection of FamilyMember	None.
HasErrors	True if there are any errors present	boolean	None.
Errors	The list of errors	Collection of ApiResultError	None.

Response Formats

application/json, text/json

Sample:

{
  "Entity": [
    {
      "SecureSystemId": 1,
      "Id": 1,
      "AccountId": 2,
      "FirstName": "sample string 3",
      "LastName": "sample string 4",
      "MiddleName": "sample string 5",
      "FamilyMemberTypeId": 6,
      "GenderId": 1
    },
    {
      "SecureSystemId": 1,
      "Id": 1,
      "AccountId": 2,
      "FirstName": "sample string 3",
      "LastName": "sample string 4",
      "MiddleName": "sample string 5",
      "FamilyMemberTypeId": 6,
      "GenderId": 1
    }
  ],
  "HasErrors": true,
  "Errors": [
    {
      "Code": 0,
      "ErrorType": "sample string 1",
      "Message": "sample string 2"
    },
    {
      "Code": 0,
      "ErrorType": "sample string 1",
      "Message": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:

<ApiResultOfArrayOfFamilyMemberZaee7PIL xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Caf.DonorSystem.Mobile.WebApi.Models">
  <Errors>
    <ApiResultError>
      <Code>InvalidParameterAddressMissing</Code>
      <ErrorType>sample string 1</ErrorType>
      <Message>sample string 2</Message>
    </ApiResultError>
    <ApiResultError>
      <Code>InvalidParameterAddressMissing</Code>
      <ErrorType>sample string 1</ErrorType>
      <Message>sample string 2</Message>
    </ApiResultError>
  </Errors>
  <Entity xmlns:d2p1="http://schemas.datacontract.org/2004/07/Caf.DonorCloud.Entities">
    <d2p1:FamilyMember>
      <d2p1:AccountId>2</d2p1:AccountId>
      <d2p1:FamilyMemberTypeId>6</d2p1:FamilyMemberTypeId>
      <d2p1:FirstName>sample string 3</d2p1:FirstName>
      <d2p1:GenderId>1</d2p1:GenderId>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:LastName>sample string 4</d2p1:LastName>
      <d2p1:MiddleName>sample string 5</d2p1:MiddleName>
      <d2p1:SecureSystemId>1</d2p1:SecureSystemId>
    </d2p1:FamilyMember>
    <d2p1:FamilyMember>
      <d2p1:AccountId>2</d2p1:AccountId>
      <d2p1:FamilyMemberTypeId>6</d2p1:FamilyMemberTypeId>
      <d2p1:FirstName>sample string 3</d2p1:FirstName>
      <d2p1:GenderId>1</d2p1:GenderId>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:LastName>sample string 4</d2p1:LastName>
      <d2p1:MiddleName>sample string 5</d2p1:MiddleName>
      <d2p1:SecureSystemId>1</d2p1:SecureSystemId>
    </d2p1:FamilyMember>
  </Entity>
</ApiResultOfArrayOfFamilyMemberZaee7PIL>