GET Household/{householdId}

Gets the specified household.

Request Information

Header Parameters

NameDescriptionTypeAdditional information
Authorization

The authorization token prefixed with 'Bearer'

string

Required

Sample:
Authorization: Bearer gBsdjflsdkj#wsjelKDSDdsdDTjeYYfvikg2cZQIu_ombqpyE7DZgEHClLO06EtHLFV65lelXVwx9JR33gib3nxzzJKLSDFJ-Xrt5ressxjArc3F6hy1J...        

URI Parameters

NameDescriptionTypeAdditional information
householdId

The household identifier.

integer

Required

Body Parameters

None.

Response Information

Resource Description

Returns household information in a HouseholdModel object.

Type: HouseholdModel
NameDescriptionTypeAdditional information
HouseholdId

Gets or sets the household identifier.

integer

None.

Name

Gets or sets the household name.

string

None.

CustomerName

Gets or sets the name of the customer.

string

None.

RepresentativeId

Gets or sets the representative identifier.

string

None.

Address

Gets or sets the address.

AddressModel

None.

Accounts

Gets or sets the accounts.

Collection of AccountModel

None.

ClientGroups

Gets or sets the client groups.

Collection of ClientGroupModel

None.

Response Formats

application/json, text/json

Sample:
{
  "HouseholdId": 1,
  "Name": "Sample Household Name 1",
  "CustomerName": "Sample Customer Name 1",
  "RepresentativeId": "REPID123",
  "Address": {
    "Line1": "321 Elm Street",
    "Line2": "Apt 200",
    "City": "New York City",
    "State": "NY",
    "Zipcode": "54321"
  },
  "Accounts": [],
  "ClientGroups": [
    {
      "ClientGroupId": "GROUP1",
      "Name": "Sample Client Group Name 1",
      "Accounts": []
    },
    {
      "ClientGroupId": "GROUP2",
      "Name": "Sample Client Group Name 2",
      "Accounts": []
    }
  ]
}

application/xml, text/xml

Sample:
<HouseholdModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PP.Contracts.WebApi.Client">
  <Accounts />
  <Address xmlns:d2p1="http://schemas.datacontract.org/2004/07/PP.Contracts.WebApi">
    <d2p1:City>New York City</d2p1:City>
    <d2p1:Line1>321 Elm Street</d2p1:Line1>
    <d2p1:Line2>Apt 200</d2p1:Line2>
    <d2p1:State>NY</d2p1:State>
    <d2p1:Zipcode>54321</d2p1:Zipcode>
  </Address>
  <ClientGroups>
    <ClientGroupModel>
      <Accounts />
      <ClientGroupId>GROUP1</ClientGroupId>
      <Name>Sample Client Group Name 1</Name>
    </ClientGroupModel>
    <ClientGroupModel>
      <Accounts />
      <ClientGroupId>GROUP2</ClientGroupId>
      <Name>Sample Client Group Name 2</Name>
    </ClientGroupModel>
  </ClientGroups>
  <CustomerName>Sample Customer Name 1</CustomerName>
  <HouseholdId>1</HouseholdId>
  <Name>Sample Household Name 1</Name>
  <RepresentativeId>REPID123</RepresentativeId>
</HouseholdModel>