Household Member Types

A household member type or collection of household member types are used for people to describe the position of a given person in a household.

Authentication

This method requires Authentication

Resource Structure

This resource conforms to the following XSD

Methods

Household Member Types ::

  • list [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/HouseholdMemberTypes
  • show [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/HouseholdMemberTypes/{id}

Method: list [GET]

The list method will return a list of household member types.

Notes ::

  • list and show are the only available methods for this resource; this resource cannot be updated via the API

Content-types ::

  • application/json
  • application/xml
  • application/help

Format ::

  • json
  • xml
  • help

Parameters ::

  • {format}
    • [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/HouseholdMemberTypes.{format}
    • [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/HouseholdMemberTypes?format={format}
    • [Header] Accept : {Content-type}

Sample Response ::

Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/HouseholdMemberTypes

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://CHURCHCODE.fellowshiponeapi.com/v1/People/HouseholdMemberTypes
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Tue, 28 Apr 2009 06:57:20 GMT
Content-Length: 936

<?xml version="1.0" encoding="utf-8"?>
<householdMemberTypes>
  <householdMemberType json:Array="true" id="1" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/householdMemberTypes/1">
    <name>Head</name>
  </householdMemberType>
  <householdMemberType json:Array="true" id="2" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/householdMemberTypes/2">
    <name>Spouse</name>
  </householdMemberType>
  <householdMemberType json:Array="true" id="3" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/householdMemberTypes/3">
    <name>Child</name>
  </householdMemberType>
  <householdMemberType json:Array="true" id="4" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/householdMemberTypes/4">
    <name>Other</name>
  </householdMemberType>
  <householdMemberType json:Array="true" id="101" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/householdMemberTypes/101">
    <name>Visitor</name>
  </householdMemberType>
</householdMemberTypes>

Sample Response ::

Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/HouseholdMemberTypes.json

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Content-Location: https://CHURCHCODE.fellowshiponeapi.com/v1/People/HouseholdMemberTypes.json
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Fri, 01 May 2009 18:33:26 GMT
Content-Length: 654

{
    "householdMemberTypes": {
        "householdMemberType": [
            {
                "@array": "true",
                "@id": "1",
                "@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/householdMemberTypes/1",
                "name": "Head"
            },
            {
                "@array": "true",
                "@id": "2",
                "@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/householdMemberTypes/2",
                "name": "Spouse"
            },
            {
                "@array": "true",
                "@id": "3",
                "@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/householdMemberTypes/3",
                "name": "Child"
            },
            {
                "@array": "true",
                "@id": "4",
                "@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/householdMemberTypes/4",
                "name": "Other"
            },
            {
                "@array": "true",
                "@id": "101",
                "@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/householdMemberTypes/101",
                "name": "Visitor"
            }
        ]
    }
}

Method: show [GET]

The show method will return a single household member type for a given id.

Notes ::

  • list and show are the only available methods on this resource; this resource cannot be updated via the API

Content-types ::

  • application/json
  • application/xml
  • application/xsd

Format ::

  • json
  • xml
  • xsd

Parameters ::

  • {format}
    • [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/HouseholdMemberTypes/{id}.{format}
    • [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/HouseholdMemberTypes/{id}?format={format}
    • [Header] Accept : {Content-type}
  • {id}
    • [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/HouseholdMemberTypes/{id}

Sample Response ::

Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/HouseholdMemberTypes/1

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://CHURCHCODE.fellowshiponeapi.com/v1/People/HouseholdMemberTypes/1
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Sat, 11 Apr 2009 03:49:30 GMT
Content-Length: 164

<?xml version="1.0" encoding="utf-8"?>
<householdMemberType id="1" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/householdMemberTypes/1">
    <name>Head</name>
</householdMemberType>

Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/HouseholdMemberTypes/1.json

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Content-Location: https://CHURCHCODE.fellowshiponeapi.com/v1/People/HouseholdMemberTypes/1.json
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Fri, 01 May 2009 18:39:09 GMT
Content-Length: 122

{
    "householdMemberType": {
        "@id": "1",
        "@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/householdMemberTypes/1",
        "name": "Head"
    }
}