The Family Detail service will return information for a given family.
Service Name
family_detail
Required Parameters
| Name | Type |
|---|---|
| family_id | integer |
Optional Parameters
None
Example Curl
curl -u user:pass "https://yourchurch.ccbchurch.com/api.php?srv=family_detail&family_id=1"Example Response XML
<?xml version="1.0" encoding="UTF-8"?>
<ccb_api>
<request>
<parameters>
<argument value="family_detail" name="srv"/>
<argument value="1" name="family_id"/>
</parameters>
</request>
<items count="1">
<item>
<id>1</id>
<sync_id>0</sync_id>
<name>Tomato</name>
<picture></picture>
<picture_privacy_lvl>1</picture_privacy_lvl>
<email></email>
<email_listed>Yes</email_listed>
<area_id>3</area_id>
<area_name>SOUTH</area_name>
<address_street>228 Calle Street</address_street>
<address_city>Oceanside</address_city>
<address_state>CA</address_state>
<address_zip>54321</address_zip>
<address_country>Albania</address_country>
<address_carrier_route></address_carrier_route>
<address_listed>No</address_listed>
<address_privacy_lvl>4</address_privacy_lvl>
<phone>5554333518</phone>
<phone_listed>Yes</phone_listed>
<phone_privacy_lvl>1</phone_privacy_lvl>
<listed>Yes</listed>
<creator_id>0</creator_id>
<modifier_id>1</modifier_id>
<date_created>2002-06-15 00:00:00</date_created>
<date_modified>2014-01-16 11:29:18</date_modified>
</item>
</items>
</ccb_api>