Fellowship One - Developer Community

Groups

A group is a category that can be used by administrators to keep track of various areas of ministry.

Notes ::

By passing in the content-type of application/help in the accept header or using the {format} parameter help from https://CHURCHCODE.fellowshiponeapi.com/groups/v1/groups, the API will return an html representation of the help documents for this resource (*authentication not required*)

Authentication

This method requires Authentication

Resource Structure

This resource conforms to the following XSD

Methods

Groups ::

search [GET] https://CHURCHCODE.fellowshiponeapi.com/groups/v1/groups/search?{parameters}
list [GET] https://CHURCHCODE.fellowshiponeapi.com/groups/v1/grouptypes/{id}/groups
show [GET] https://CHURCHCODE.fellowshiponeapi.com/groups/v1/groups/{id}
new [GET] https://CHURCHCODE.fellowshiponeapi.com/groups/v1/groups/New
edit [GET] https://CHURCHCODE.fellowshiponeapi.com/groups/v1/groups/{id}/Edit
create [POST] https://CHURCHCODE.fellowshiponeapi.com/groups/v1/groups
update [PUT] [POST(Low REST)] https://CHURCHCODE.fellowshiponeapi.com/groups/v1/groups/{id}

Method: search [GET]

The search method will return a collection of groups for the parameters provided.

Notes ::

Search by Group name: https://CHURCHCODE.fellowshiponeapi.com/groups/v1/groups/search?searchFor=My%20Group
- All values passed in via searchFor must be url encoded (ex. My Group needs to be My%20Group)
Search by IsSearchable: https://CHURCHCODE.fellowshiponeapi.com/groups/v1/groups/search?issearchable=true
- Will return all groups that are marked as searchable in Portal.
Search by IsActive: https://CHURCHCODE.fellowshiponeapi.com/groups/v1/groups/search?isactive=true
- Will return all groups that are marked as active in Portal.
Search by Gender: https://CHURCHCODE.fellowshiponeapi.com/groups/v1/groups/search?genderID=1
- Will return all groups that have gender set to Male.
Search by MaritalStatus: https://CHURCHCODE.fellowshiponeapi.com/groups/v1/groups/search?maritalStatusID=1
- Will return all groups that have Marital Status set to Married.
Search by Age Range: https://CHURCHCODE.fellowshiponeapi.com/groups/v1/groups/search?startAgeRange=18&endAgeRange=21
- Will return all groups that have Age range between 18 and 21 years
Search by Campus: https://CHURCHCODE.fellowshiponeapi.com/groups/v1/groups/search?churchCampusID=1
- Will return all groups that belong to the church campus
Search by Category: https://CHURCHCODE.fellowshiponeapi.com/groups/v1/groups/search?categoryID=1
- Will return all groups that have this category id
Search by Child care: https://CHURCHCODE.fellowshiponeapi.com/groups/v1/groups/search?hasChildcare=true
- Will return all groups that provide child care
Search by Latitude & Longitude: https://CHURCHCODE.fellowshiponeapi.com/groups/v1/groups/search?latitude=32.926032&longitude=-97.000136
- Will return all groups that are within a 20 mile radius of the latitude and longitude that was passed. *Optionally a Radius and RadiusUnit parameter can be passed with the Latitude and Longitude paramters: https://CHURCHCODE.fellowshiponeapi.com/groups/v1/groups/search?latitude=32.926032&longitude=-97.000136&radius=50&radiusunit=km
  - Radius is how far out (in miles or kilometers based on the RadiusUnit) you want to search for a group. If you do not pass a Radius parameter it will default to 20.
  - RadiusUnit is the unit of measure for the Radius and Distance. mi = Miles, km = Kilometers. If you do not pass a RadiusUnit parameter it will default to miles.
By passing in the content-type of application/xsd in the accept header or using the {format} parameter xsd the API will return an xsd for a single version of this resource (authentication not required)
If the recordsPerPage parameter is not used or its value is less than 1, the API will default the parameter to 20
If the recordsPerPage parameter's value is less than 10, the API will default the parameter to 10
If the page parameter is not used or its value is less than 1, the API will default the parameter to 1

Content-types ::

application/json
application/xml
application/xsd
application/help

Format ::

json
xml
xsd
help

Parameters ::

{format}
- [GET] https://CHURCHCODE.fellowshiponeapi.com/groups/v1/groups/search.{format}?{search parameters}
- [GET] https://CHURCHCODE.fellowshiponeapi.com/groups/v1/groups/search?format={format}&{search parameters}
- [Header] Accept : {Content-type}
{search parameters}
- searchFor = Name of the group you are searching for *ex. searchfor=test
- isSearchable = include groups that are marked as searchable. *ex. issearchable=true
- isActive = include groups that are marked as active. *ex. isActive=true
- genderID = gender type *ex. genderid=1
- maritalStatusID = marital status type *ex. matiralstatusid=1
- startAge = lower end age range *ex. startagerange=18
- endAge = upper end age range *ex. endagerange=21
- churchCampusID = church campus group is associated with *ex. churchcampusid=1
- categoryID = category group is associated with *ex. categoryid=1
- hasChildcare = designates if group has childcare *ex. haschildcare=true
- latitude = latitude of the center point of the radius to search *Note: must be used in conjunction with longitude. *ex: latitiude=32.926032
- longitude = longitude of the center point of the radius to search *Note: must be used in conjunction with latitude. *ex: latitiude=-97.000136
- radius = the distance of the radius to search for groups. *Note: can only be used when latitude and longitude params are used. Defaults to 20. *ex: radius=50
- radiusUnit = the unit of measure of the radius and distance. *Note: can only be used when latitude and longitude parameters are used. Valid values are mi for Miles and km for kilometers. Default to 1 (Miles). *ex. radiusUnit=km

Sample Response ::

Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/groups/v1/groups/search?searchfor=Test

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://CHURCHCODE.fellowshiponeapi.com/groups/v1/grouptypes/33/groups
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Tue, 07 Dec 2010 00:01:59 GMT
Content-Length: 7186

<?xml version="1.0" encoding="utf-8"?>
<groups>
    <group json:Array="true" id="29" uri="https://CHURCHCODE.fellowshiponeapi.com/groups/v1/groups/29">
        <name>Dacy Home Group</name>
        <description></description>
        <startDate>2007-11-07T00:00:00</startDate>
        <expirationDate></expirationDate>
        <isOpen>true</isOpen>
        <isPublic>false</isPublic>
        <hasChildcare>false</hasChildcare>
        <isSearchable>true</isSearchable>
        <isActive>true</isActive>
        <churchCampus id="">
            <name></name>
        </churchCampus>
        <groupType id="33" uri="https://CHURCHCODE.fellowshiponeapi.com/groups/v1/grouptypes/33">
            <name>Home Bible Groups</name>
        </groupType>
        <groupURL>dacy_home_group</groupURL>
        <timeZone id="115" uri="https://CHURCHCODE.fellowshiponeapi.com/groups/v1/timezones/115">
            <name>(GMT-06:00) Central Time (US &amp; Canada)</name>
        </timeZone>
        <gender id="0" uri="https://CHURCHCODE.fellowshiponeapi.com/groups/v1/genders/0">
            <name>Coed</name>
        </gender>
        <maritalStatus id="0" uri="https://CHURCHCODE.fellowshiponeapi.com/groups/v1/maritalstatuses/0">
            <name>Married or Single</name>
        </maritalStatus>
        <startAgeRange></startAgeRange>
        <endAgeRange></endAgeRange>
        <dateRangeType id="" uri="">
            <name></name>
        </dateRangeType>
        <leadersCount>2</leadersCount>
        <membersCount>2</membersCount>
        <openProspectsCount>0</openProspectsCount>
        <event id="8297" uri="{{CONSUMER_EVENTS_REALM}}/events/8297">
            <name>Dacy Home Group - Default Event</name>
        </event>
        <location id="" uri="">
            <name></name>
            <description></description>
            <isOnline>false</isOnline>
            <url></url>
            <address>
                <address1></address1>
                <address2></address2>
                <address3></address3>
                <city></city>
                <stProvince></stProvince>
                <postalCode></postalCode>
                <county></county>
                <country></country>
                <carrierRoute></carrierRoute>
                <deliveryPoint></deliveryPoint>
                <latitude></latitude>
                <longitude></longitude>
                <createdDate></createdDate>
                <createdByPerson id="" uri="" />
                <lastUpdatedDate></lastUpdatedDate>
                <lastUpdatedByPerson id="" uri="" />
            </address>
            <createdDate></createdDate>
            <createdByPerson id="" uri="" />
            <lastUpdatedDate></lastUpdatedDate>
            <lastUpdatedByPerson id="" uri="" />
        </location>
        <createdDate>2007-11-07T12:34:28</createdDate>
        <createdByPerson id="1999191" uri="{{CONSUMER_ROOT_DOMAIN}}/people/1999191" />
        <lastUpdatedDate>2010-09-08T12:35:26</lastUpdatedDate>
        <lastUpdatedByPerson id="" uri="" />
        <isLocationPrivate></isLocationPrivate>
    </group>
    <group json:Array="true" id="235881" uri="https://CHURCHCODE.fellowshiponeapi.com/groups/v1/groups/235881">
        <name>Jinjyi's Date Control</name>
        ...
    </group>
</groups>

Sample Response ::

Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/groups/v1/groups/search.json?searchfor=Test

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Content-Location: https://CHURCHCODE.fellowshiponeapi.com/groups/v1/grouptypes/33/groups.json
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Tue, 07 Dec 2010 00:07:03 GMT
Content-Length: 6237

{
   "groups":{
      "group":[
         {
            "@array":"true",
            "@id":"29",
            "@uri":"https://CHURCHCODE.fellowshiponeapi.com/groups/v1/groups/29",
            "name":"Dacy Home Group",
            "description":null,
            "startDate":"2007-11-07T00:00:00",
            "expirationDate":null,
            "isOpen":"true",
            "isPublic":"false",
            "hasChildcare":"false",
            "isSearchable":"true",
            "isActive": "true",
            "churchCampus":{
               "@id":"",
               "name":null
            },
            "groupType":{
               "@id":"33",
               "@uri":"https://CHURCHCODE.fellowshiponeapi.com/groups/v1/grouptypes/33",
               "name":"Home Bible Groups"
            },
            "groupURL":"dacy_home_group",
            "timeZone":{
               "@id":"115",
               "@uri":"https://CHURCHCODE.fellowshiponeapi.com/groups/v1/timezones/115",
               "name":"(GMT-06:00) Central Time (US & Canada)"
            },
            "gender":{
               "@id":"0",
               "@uri":"https://CHURCHCODE.fellowshiponeapi.com/groups/v1/genders/0",
               "name":"Coed"
            },
            "maritalStatus":{
               "@id":"0",
               "@uri":"https://CHURCHCODE.fellowshiponeapi.com/groups/v1/maritalstatuses/0",
               "name":"Married or Single"
            },
            "startAgeRange":null,
            "endAgeRange":null,
            "dateRangeType":{
               "@id":"",
               "@uri":"",
               "name":null
            },
            "leadersCount":"2",
            "membersCount":"2",
            "openProspectsCount":"0",
            "event":{
               "@id":"8297",
               "@uri":"{{CONSUMER_EVENTS_REALM}}/events/8297",
               "name":"Dacy Home Group - Default Event"
            },
            "location":{
               "@id":"",
               "@uri":"",
               "name":null,
               "description":null,
               "isOnline":"false",
               "url":null,
               "address":{
                  "address1":null,
                  "address2":null,
                  "address3":null,
                  "city":null,
                  "stProvince":null,
                  "postalCode":null,
                  "county":null,
                  "country":null,
                  "carrierRoute":null,
                  "deliveryPoint":null,
                  "latitude":null,
                  "longitude":null,
                  "createdDate":null,
                  "createdByPerson":{
                     "@id":"",
                     "@uri":""
                  },
                  "lastUpdatedDate":null,
                  "lastUpdatedByPerson":{
                     "@id":"",
                     "@uri":""
                  }
               },
               "createdDate":null,
               "createdByPerson":{
                  "@id":"",
                  "@uri":""
               },
               "lastUpdatedDate":null,
               "lastUpdatedByPerson":{
                  "@id":"",
                  "@uri":""
               }
            },
            "createdDate":"2007-11-07T12:34:28",
            "createdByPerson":{
               "@id":"1999191",
               "@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/1999191"
            },
            "lastUpdatedDate":"2010-09-08T12:35:26",
            "lastUpdatedByPerson":{
               "@id":"",
               "@uri":""
            },
            "isLocationPrivate":"false"
         },
         ...
      ]
   }
}

Method: list [GET]

The list method will return a list of groups.

Notes ::

By passing in the content-type of application/xsd in the accept header or using the {format} parameter xsd the API will return an xsd for a single version of this resource (authentication not required)

Content-types ::

application/json
application/xml
application/xsd
application/help

Format ::

json
xml
xsd
help

Parameters ::

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

Sample Response ::

Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/groups/v1/grouptypes/33/groups

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://CHURCHCODE.fellowshiponeapi.com/groups/v1/grouptypes/33/groups
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Mon, 06 Dec 2010 23:48:36 GMT
Content-Length: 7186

<?xml version="1.0" encoding="utf-8"?>
<groups>
    <group json:Array="true" id="29" uri="https://CHURCHCODE.fellowshiponeapi.com/groups/v1/groups/29">
        <name>Dacy Home Group</name>
        <description></description>
        <startDate>2007-11-07T00:00:00</startDate>
        <expirationDate></expirationDate>
        <isOpen>true</isOpen>
        <isPublic>false</isPublic>
        <hasChildcare>false</hasChildcare>
        <isSearchable>true</isSearchable>
        <isActive>true</isActive>
        <churchCampus id="">
            <name></name>
        </churchCampus>
        <groupType id="33" uri="https://CHURCHCODE.fellowshiponeapi.com/groups/v1/grouptypes/33">
            <name>Home Bible Groups</name>
        </groupType>
        <groupURL>dacy_home_group</groupURL>
        <timeZone id="115" uri="https://CHURCHCODE.fellowshiponeapi.com/groups/v1/timezones/115">
            <name>(GMT-06:00) Central Time (US &amp; Canada)</name>
        </timeZone>
        <gender id="0" uri="https://CHURCHCODE.fellowshiponeapi.com/groups/v1/genders/0">
            <name>Coed</name>
        </gender>
        <maritalStatus id="0" uri="https://CHURCHCODE.fellowshiponeapi.com/groups/v1/maritalstatuses/0">
            <name>Married or Single</name>
        </maritalStatus>
        <startAgeRange></startAgeRange>
        <endAgeRange></endAgeRange>
        <dateRangeType id="" uri="">
            <name></name>
        </dateRangeType>
        <leadersCount>2</leadersCount>
        <membersCount>2</membersCount>
        <openProspectsCount>0</openProspectsCount>
        <event id="8297" uri="{{CONSUMER_EVENTS_REALM}}/events/8297">
            <name>Dacy Home Group - Default Event</name>
        </event>
        <location id="" uri="">
            <name></name>
            <description></description>
            <isOnline>false</isOnline>
            <url></url>
            <address>
                <address1></address1>
                <address2></address2>
                <address3></address3>
                <city></city>
                <stProvince></stProvince>
                <postalCode></postalCode>
                <county></county>
                <country></country>
                <carrierRoute></carrierRoute>
                <deliveryPoint></deliveryPoint>
                <latitude></latitude>
                <longitude></longitude>
                <createdDate></createdDate>
                <createdByPerson id="" uri="" />
                <lastUpdatedDate></lastUpdatedDate>
                <lastUpdatedByPerson id="" uri="" />
            </address>
            <createdDate></createdDate>
            <createdByPerson id="" uri="" />
            <lastUpdatedDate></lastUpdatedDate>
            <lastUpdatedByPerson id="" uri="" />
        </location>
        <createdDate>2007-11-07T12:34:28</createdDate>
        <createdByPerson id="1999191" uri="{{CONSUMER_ROOT_DOMAIN}}/people/1999191" />
        <lastUpdatedDate>2010-09-08T12:35:26</lastUpdatedDate>
        <lastUpdatedByPerson id="" uri="" />
        <isLocationPrivate>false</isLocationPrivate>
    </group>
    <group json:Array="true" id="235881" uri="https://CHURCHCODE.fellowshiponeapi.com/groups/v1/groups/235881">
        <name>Jinjyi's Date Control</name>
        ...
    </group>
</groups>

Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/groups/v1/grouptypes/33/groups.json

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Content-Location: https://CHURCHCODE.fellowshiponeapi.com/groups/v1/grouptypes/33/groups.json
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Mon, 06 Dec 2010 23:54:11 GMT
Content-Length: 6237

{
   "groups":{
      "group":[
         {
            "@array":"true",
            "@id":"29",
            "@uri":"https://CHURCHCODE.fellowshiponeapi.com/groups/v1/groups/29",
            "name":"Dacy Home Group",
            "description":null,
            "startDate":"2007-11-07T00:00:00",
            "expirationDate":null,
            "isOpen":"true",
            "isPublic":"false",
            "hasChildcare":"false",
            "isSearchable":"true",
            "isActive": "true",
            "churchCampus":{
               "@id":"",
               "name":null
            },
            "groupType":{
               "@id":"33",
               "@uri":"https://CHURCHCODE.fellowshiponeapi.com/groups/v1/grouptypes/33",
               "name":"Home Bible Groups"
            },
            "groupURL":"dacy_home_group",
            "timeZone":{
               "@id":"115",
               "@uri":"https://CHURCHCODE.fellowshiponeapi.com/groups/v1/timezones/115",
               "name":"(GMT-06:00) Central Time (US & Canada)"
            },
            "gender":{
               "@id":"0",
               "@uri":"https://CHURCHCODE.fellowshiponeapi.com/groups/v1/genders/0",
               "name":"Coed"
            },
            "maritalStatus":{
               "@id":"0",
               "@uri":"https://CHURCHCODE.fellowshiponeapi.com/groups/v1/maritalstatuses/0",
               "name":"Married or Single"
            },
            "startAgeRange":null,
            "endAgeRange":null,
            "dateRangeType":{
               "@id":"",
               "@uri":"",
               "name":null
            },
            "leadersCount":"2",
            "membersCount":"2",
            "openProspectsCount":"0",
            "event":{
               "@id":"8297",
               "@uri":"{{CONSUMER_EVENTS_REALM}}/events/8297",
               "name":"Dacy Home Group - Default Event"
            },
            "location":{
               "@id":"",
               "@uri":"",
               "name":null,
               "description":null,
               "isOnline":"false",
               "url":null,
               "address":{
                  "address1":null,
                  "address2":null,
                  "address3":null,
                  "city":null,
                  "stProvince":null,
                  "postalCode":null,
                  "county":null,
                  "country":null,
                  "carrierRoute":null,
                  "deliveryPoint":null,
                  "latitude":null,
                  "longitude":null,
                  "createdDate":null,
                  "createdByPerson":{
                     "@id":"",
                     "@uri":""
                  },
                  "lastUpdatedDate":null,
                  "lastUpdatedByPerson":{
                     "@id":"",
                     "@uri":""
                  }
               },
               "createdDate":null,
               "createdByPerson":{
                  "@id":"",
                  "@uri":""
               },
               "lastUpdatedDate":null,
               "lastUpdatedByPerson":{
                  "@id":"",
                  "@uri":""
               }
            },
            "createdDate":"2007-11-07T12:34:28",
            "createdByPerson":{
               "@id":"1999191",
               "@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/1999191"
            },
            "lastUpdatedDate":"2010-09-08T12:35:26",
            "lastUpdatedByPerson":{
               "@id":"",
               "@uri":""
            },
            "isLocationPrivate":"false"
         },
         {
            ...
         }
      ]
   }
}

Method: show [GET]

The show method will return a single group for a given id.

Notes ::

By passing in the content-type of application/xsd in the accept header or using the {format} parameter xsd the API will return an xsd for a single version of this resource (authentication not required)

Content-types ::

application/json
application/xml
application/xsd
application/help

Format ::

json
xml
xsd
help

Parameters ::

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

Sample Response ::

Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/groups/v1/groups/235881

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://CHURCHCODE.fellowshiponeapi.com/groups/v1/groups/235881
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Mon, 06 Dec 2010 23:36:26 GMT
Content-Length: 3112

<?xml version="1.0" encoding="utf-8"?>
<group id="235881" uri="https://CHURCHCODE.fellowshiponeapi.com/groups/v1/groups/235881">
  <name>Jinjyi's Date Control</name>
  <description></description>
  <startDate>2010-11-22T00:00:00</startDate>
  <expirationDate></expirationDate>
  <isOpen>true</isOpen>
  <isPublic>false</isPublic>
  <hasChildcare>true</hasChildcare>
  <isSearchable>true</isSearchable>
  <isActive>true</isActive>
  <churchCampus id="">
    <name></name>
  </churchCampus>
  <groupType id="33" uri="https://CHURCHCODE.fellowshiponeapi.com/groups/v1/grouptypes/33">
    <name>Home Bible Groups</name>
  </groupType>
  <groupURL>jinjyis_date_control</groupURL>
  <timeZone id="115" uri="https://CHURCHCODE.fellowshiponeapi.com/groups/v1/timezones/115">
    <name>(GMT-06:00) Central Time (US &amp; Canada)</name>
  </timeZone>
  <gender id="0" uri="https://CHURCHCODE.fellowshiponeapi.com/groups/v1/genders/0">
    <name>Coed</name>
  </gender>
  <maritalStatus id="0" uri="https://CHURCHCODE.fellowshiponeapi.com/groups/v1/maritalstatuses/0">
    <name>Married or Single</name>
  </maritalStatus>
  <startAgeRange>1</startAgeRange>
  <endAgeRange>99</endAgeRange>
  <dateRangeType id="7" uri="https://CHURCHCODE.fellowshiponeapi.com/groups/v1/daterangetypes/7">
    <name>Years</name>
  </dateRangeType>
  <leadersCount>0</leadersCount>
  <membersCount>1</membersCount>
  <openProspectsCount>0</openProspectsCount>
  <event id="8296" uri="https://CHURCHCODE.fellowshiponeapi.com/groups/v1/events/8296">
    <name>Jinjyi's Date Control - Awesome Event</name>
  </event>
  <location id="2060" uri="{{CONSUMER_EVENTS_REALM}}/locations/2060">
    <name>Jingyi's House</name>
    <description>Small mansion in the hills.</description>
    <isOnline>false</isOnline>
    <url></url>
    <address>
      <address1>400 N. Aspen</address1>
      <address2></address2>
      <address3></address3>
      <city>Broken Arrow</city>
      <stProvince>OK</stProvince>
      <postalCode>74012</postalCode>
      <county></county>
      <country></country>
      <carrierRoute></carrierRoute>
      <deliveryPoint></deliveryPoint>
      <latitude>36.0561150</latitude>
      <longitude>-95.8175860</longitude>
      <createdDate>2010-12-03T10:49:11</createdDate>
      <createdByPerson id="1999191" uri="{{CONSUMER_ROOT_DOMAIN}}/people/1999191" />
      <lastUpdatedDate>2010-12-03T11:00:25</lastUpdatedDate>
      <lastUpdatedByPerson id="1999191" uri="{{CONSUMER_ROOT_DOMAIN}}/people/1999191" />
    </address>
    <createdDate>2010-12-03T10:49:11</createdDate>
    <createdByPerson id="1999191" uri="{{CONSUMER_ROOT_DOMAIN}}/people/1999191" />
    <lastUpdatedDate>2010-12-03T11:00:25</lastUpdatedDate>
    <lastUpdatedByPerson id="1999191" uri="{{CONSUMER_ROOT_DOMAIN}}/people/1999191" />
  </location>
  <createdDate>2010-11-22T15:13:45</createdDate>
  <createdByPerson id="28912161" uri="{{CONSUMER_ROOT_DOMAIN}}/people/28912161" />
  <lastUpdatedDate></lastUpdatedDate>
  <lastUpdatedByPerson id="" uri="" />
  <isLocationPrivate>false</isLocationPrivate>
</group>

Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/groups/v1/groups/235881.json

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Content-Location: https://CHURCHCODE.fellowshiponeapi.com/groups/v1/groups/235881.json
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Mon, 06 Dec 2010 23:40:27 GMT
Content-Length: 2388

{
   "group":{
      "@id":"235881",
      "@uri":"https://CHURCHCODE.fellowshiponeapi.com/groups/v1/groups/235881",
      "name":"Jinjyi's Date Control",
      "description":null,
      "startDate":"2010-11-22T00:00:00",
      "expirationDate":null,
      "isOpen":"true",
      "isPublic":"false",
      "hasChildcare":"true",
      "isSearchable":"true",
      "isActive": "true",
      "churchCampus":{
         "@id":"",
         "name":null
      },
      "groupType":{
         "@id":"33",
         "@uri":"https://CHURCHCODE.fellowshiponeapi.com/groups/v1/grouptypes/33",
         "name":"Home Bible Groups"
      },
      "groupURL":"jinjyis_date_control",
      "timeZone":{
         "@id":"115",
         "@uri":"https://CHURCHCODE.fellowshiponeapi.com/groups/v1/timezones/115",
         "name":"(GMT-06:00) Central Time (US & Canada)"
      },
      "gender":{
         "@id":"0",
         "@uri":"https://CHURCHCODE.fellowshiponeapi.com/groups/v1/genders/0",
         "name":"Coed"
      },
      "maritalStatus":{
         "@id":"0",
         "@uri":"https://CHURCHCODE.fellowshiponeapi.com/groups/v1/maritalstatuses/0",
         "name":"Married or Single"
      },
      "startAgeRange":"1",
      "endAgeRange":"99",
      "dateRangeType":{
         "@id":"7",
         "@uri":"https://CHURCHCODE.fellowshiponeapi.com/groups/v1/daterangetypes/7",
         "name":"Years"
      },
      "leadersCount":"0",
      "membersCount":"1",
      "openProspectsCount":"0",
      "event":{
         "@id":"8296",
         "@uri":"{{CONSUMER_EVENTS_REALM}}/events/8296",
         "name":"Jinjyi's Date Control - Awesome Event"
      },
      "location":{
         "@id":"2060",
         "@uri":"{{CONSUMER_EVENTS_REALM}}/locations/2060",
         "name":"Jingyi's House",
         "description":"Small mansion in the hills.",
         "isOnline":"false",
         "url":null,
         "address":{
            "address1":"400 N. Aspen",
            "address2":null,
            "address3":null,
            "city":"Broken Arrow",
            "stProvince":"OK",
            "postalCode":"74012",
            "county":null,
            "country":null,
            "carrierRoute":null,
            "deliveryPoint":null,
            "latitude":"36.0561150",
            "longitude":"-95.8175860",
            "createdDate":"2010-12-03T10:49:11",
            "createdByPerson":{
               "@id":"1999191",
               "@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/1999191"
            },
            "lastUpdatedDate":"2010-12-03T11:00:25",
            "lastUpdatedByPerson":{
               "@id":"1999191",
               "@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/1999191"
            }
         },
         "createdDate":"2010-12-03T10:49:11",
         "createdByPerson":{
            "@id":"1999191",
            "@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/1999191"
         },
         "lastUpdatedDate":"2010-12-03T11:00:25",
         "lastUpdatedByPerson":{
            "@id":"1999191",
            "@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/1999191"
         }
      },
      "createdDate":"2010-11-22T15:13:45",
      "createdByPerson":{
         "@id":"28912161",
         "@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/28912161"
      },
      "lastUpdatedDate":null,
      "lastUpdatedByPerson":{
         "@id":"",
         "@uri":""
      },
      "isLocationPrivate":"false"
   }
}

Method: new [GET]

The new keyword will return a single group. The purpose of the new method is to retrieve an empty resource with the proper structure.

Notes ::

By passing in the content-type of application/xsd in the accept header or using the {format} parameter xsd the API will return an xsd for a single version of this resource (authentication not required)

Content-types ::

application/json
application/xml
application/xsd
application/help

Format ::

json
xml
xsd
help

Parameters ::

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

Sample Response ::

Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/groups/v1/groups/new

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Thu, 12 Jul 2012 15:31:18 GMT
Content-Length: 1036

<?xml version="1.0" encoding="utf-8"?>
<group id="" uri="">
  <name></name>
  <description></description>
  <startDate></startDate>
  <expirationDate></expirationDate>
  <isOpen></isOpen>
  <isPublic></isPublic>
  <hasChildcare>false</hasChildcare>
  <isSearchable>false</isSearchable>
  <isActive>false</isActive>
  <churchCampus id="">
    <name></name>
  </churchCampus>
  <groupType id="" uri="">
    <name></name>
  </groupType>
  <groupURL></groupURL>
  <timeZone id="" uri="">
    <name></name>
  </timeZone>
  <gender id="" uri="">
    <name></name>
  </gender>
  <maritalStatus id="" uri="">
    <name></name>
  </maritalStatus>
  <startAgeRange></startAgeRange>
  <endAgeRange></endAgeRange>
  <dateRangeType id="" uri="">
    <name></name>
  </dateRangeType>
  <createdDate></createdDate>
  <createdByPerson id="1999191" uri="{{CONSUMER_ROOT_DOMAIN}}/people/1999191" />
  <lastUpdatedDate></lastUpdatedDate>
  <lastUpdatedByPerson id="1999191" uri="{{CONSUMER_ROOT_DOMAIN}}/people/1999191" />
  <isLocationPrivate>false</isLocationPrivate>
</group>

Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/groups/v1/attendances/new.json

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Thu, 12 Jul 2012 15:36:10 GMT
Content-Length: 733

{
    "group":{
        "@id":"",
        "@uri":"",
        "name":null,
        "description":null,
        "startDate":null,
        "expirationDate":null,
        "isOpen":null,
        "isPublic":null,
        "hasChildcare":"false",
        "isSearchable":"false",
        "isActive": "true",
        "churchCampus":{
            "@id":"",
            "name":null
        },
        "groupType":{
            "@id":"",
            "@uri":"",
            "name":null
        },
        "groupURL":null,
        "timeZone":{
            "@id":"",
            "@uri":"",
            "name":null
        },
        "gender":{
            "@id":"",
            "@uri":"",
            "name":null
        },
        "maritalStatus":{
            "@id":"",
            "@uri":"",
            "name":null
        },
        "startAgeRange":null,
        "endAgeRange":null,
        "dateRangeType":{
            "@id":"",
            "@uri":"",
            "name":null
        },
        "createdDate":null,
        "createdByPerson":{
            "@id":"1999191",
            "@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/1999191"
        },
        "lastUpdatedDate":null,
        "lastUpdatedByPerson":{
            "@id":"1999191",
            "@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/1999191"
        },
        "isLocationPrivate":"false"
    }
}

Method: edit [GET]

The edit method will return a single group. The purpose of the edit method is to retrieve a resource in its most recent condition with its latest values.

Content-types ::

application/json
application/xml

Format ::

json
xml

Parameters ::

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

Required Fields ::

name
startDate
isOpen
isPublic
hasChildcare
isSearchable
isActive
groupType
timeZone

Sample Response ::

Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/groups/v1/groups/238591/edit

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://CHURCHCODE.fellowshiponeapi.com/groups/v1/groups/238591/edit
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Wed, 11 Jul 2012 19:51:23 GMT
Content-Length: 1490

<?xml version="1.0" encoding="utf-8"?>
<group id="238591" uri="https://CHURCHCODE.fellowshiponeapi.com/groups/v1/groups/238591">
  <name>Test Api Group</name>
  <description>Test group created through api</description>
  <startDate>2012-07-06T00:00:00</startDate>
  <expirationDate></expirationDate>
  <isOpen>true</isOpen>
  <isPublic>true</isPublic>
  <hasChildcare>true</hasChildcare>
  <isSearchable>true</isSearchable>
  <isActive>true</isActive>
  <churchCampus id="1">
    <name></name>
  </churchCampus>
  <groupType id="7" uri="https://CHURCHCODE.fellowshiponeapi.com/groups/v1/grouptypes/7">
    <name>Home Team</name>
  </groupType>
  <groupURL></groupURL>
  <timeZone id="115" uri="https://CHURCHCODE.fellowshiponeapi.com/groups/v1/timezones/115">
    <name>(GMT-06:00) Central Time (US &amp; Canada)</name>
  </timeZone>
  <gender id="0" uri="https://CHURCHCODE.fellowshiponeapi.com/groups/v1/genders/0">
    <name>Coed</name>
  </gender>
  <maritalStatus id="0" uri="https://CHURCHCODE.fellowshiponeapi.com/groups/v1/maritalstatuses/0">
    <name>Married or Single</name>
  </maritalStatus>
  <startAgeRange>21</startAgeRange>
  <endAgeRange>30</endAgeRange>
  <dateRangeType id="7" uri="https://CHURCHCODE.fellowshiponeapi.com/groups/v1/daterangetypes/7">
    <name>Years</name>
  </dateRangeType>
  <createdDate>2012-07-10T14:57:39</createdDate>
  <createdByPerson id="1999191" uri="{{CONSUMER_ROOT_DOMAIN}}/people/1999191" />
  <lastUpdatedDate></lastUpdatedDate>
  <lastUpdatedByPerson id="" uri="" />
  <isLocationPrivate>false</isLocationPrivate>
</group>

Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/groups/v1/groups/238591/edit.json

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Content-Location: https://CHURCHCODE.fellowshiponeapi.com/groups/v1/groups/238591/edit.json
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Wed, 11 Jul 2012 20:08:42 GMT
Content-Length: 1157

{
    "group":{
        "@id":"238591",
        "@uri":"https://CHURCHCODE.fellowshiponeapi.com/groups/v1/groups/238591",
        "name":"Test Api Group",
        "description":"Test group created through api",
        "startDate":"2012-07-06T00:00:00",
        "expirationDate":null,
        "isOpen":"true",
        "isPublic":"true",
        "hasChildcare":"true",
        "isSearchable":"true",
        "isActive": "true",
        "churchCampus":{
            "@id":"1",
            "name":null
        },
        "groupType":{
            "@id":"7",
            "@uri":"https://CHURCHCODE.fellowshiponeapi.com/groups/v1/grouptypes/7",
            "name":"Home Team"
        },
        "groupURL":null,
        "timeZone":{
            "@id":"115",
            "@uri":"https://CHURCHCODE.fellowshiponeapi.com/groups/v1/timezones/115",
            "name":"(GMT-06:00) Central Time (US & Canada)"
        },
        "gender":{
            "@id":"0",
            "@uri":"https://CHURCHCODE.fellowshiponeapi.com/groups/v1/genders/0",
            "name":"Coed"
        },
        "maritalStatus":{
            "@id":"0",
            "@uri":"https://CHURCHCODE.fellowshiponeapi.com/groups/v1/maritalstatuses/0",
            "name":"Married or Single"
        },
        "startAgeRange":"21",
        "endAgeRange":"30",
        "dateRangeType":{
            "@id":"7",
            "@uri":"https://CHURCHCODE.fellowshiponeapi.com/groups/v1/daterangetypes/7",
            "name":"Years"
        },
        "createdDate":"2012-07-10T14:57:39",
        "createdByPerson":{
            "@id":"1999191",
            "@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/1999191"
        },
        "lastUpdatedDate":null,
        "lastUpdatedByPerson":{
            "@id":"",
            "@uri":""
        },
        "isLocationPrivate":"false"
    }
}

Method: create [POST]

The create method will create a group.

Notes ::

This method will return a 201 - Created if successfully created
This method creates a default event for the group. If you want to create a schedule or location for this event, you will need to do this through the events api.
Groups can not have the same name within a single group type. If you try to create a group with the same name of another group in the same group type the method will return 400

Content-types ::

application/json
application/xml

Format ::

json
xml

Parameters ::

{format}
- [POST] https://CHURCHCODE.fellowshiponeapi.com/groups/v1/groups.{format}
- [POST] https://CHURCHCODE.fellowshiponeapi.com/groups/v1/groups?format={format}
- [Header] Accept : {Content-type}

Required Fields ::

name
startDate
isOpen
isPublic
hasChildcare
isSearchable
isActive
groupType
timeZone

Sample Response ::

Given: [POST] https://CHURCHCODE.fellowshiponeapi.com/groups/v1/groups

Request body:

<group>
    <name>Test Api Group 5</name>
    <description>Test group created through api</description>
    <startDate>2012-07-06T00:00:00</startDate>
    <expirationDate></expirationDate>
    <isOpen>1</isOpen>
    <isPublic>1</isPublic>
    <hasChildcare>1</hasChildcare>
    <isSearchable>1</isSearchable>
    <isActive>1</isActive>
    <churchCampus id="1"></churchCampus>
    <groupType id="7"></groupType>
    <groupURL></groupURL>
    <timeZone id="115"></timeZone>
    <gender id="0"></gender>
    <maritalStatus id="0"></maritalStatus>
    <startAgeRange>21</startAgeRange>
    <endAgeRange>30</endAgeRange>
    <dateRangeType></dateRangeType>
    <createdDate />
    <createdByPerson />
    <lastUpdatedDate />
    <lastUpdatedByPerson />
    <isLocationPrivate />
</group>

Response:

HTTP/1.1 201 Created
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Location: https://CHURCHCODE.fellowshiponeapi.com/groups/v1/groups/238599
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Thu, 12 Jul 2012 20:02:01 GMT
Content-Length: 2513

<?xml version="1.0" encoding="utf-8"?>
<group id="238599" uri="https://CHURCHCODE.fellowshiponeapi.com/groups/v1/groups/238599">
  <name>Test Api Group 5</name>
  <description>Test group created through api</description>
  <startDate>2012-07-06T00:00:00</startDate>
  <expirationDate></expirationDate>
  <isOpen>true</isOpen>
  <isPublic>true</isPublic>
  <hasChildcare>true</hasChildcare>
  <isSearchable>true</isSearchable>
  <isActive>true</isActive>
  <churchCampus id="1">
    <name></name>
  </churchCampus>
  <groupType id="7" uri="https://CHURCHCODE.fellowshiponeapi.com/groups/v1/grouptypes/7">
    <name>Home Team</name>
  </groupType>
  <groupURL></groupURL>
  <timeZone id="115" uri="https://CHURCHCODE.fellowshiponeapi.com/groups/v1/timezones/115">
    <name>(GMT-06:00) Central Time (US &amp; Canada)</name>
  </timeZone>
  <gender id="0" uri="https://CHURCHCODE.fellowshiponeapi.com/groups/v1/genders/0">
    <name>Coed</name>
  </gender>
  <maritalStatus id="0" uri="https://CHURCHCODE.fellowshiponeapi.com/groups/v1/maritalstatuses/0">
    <name>Married or Single</name>
  </maritalStatus>
  <startAgeRange>21</startAgeRange>
  <endAgeRange>30</endAgeRange>
  <dateRangeType id="7" uri="https://CHURCHCODE.fellowshiponeapi.com/groups/v1/daterangetypes/7">
    <name>Years</name>
  </dateRangeType>
  <leadersCount>0</leadersCount>
  <membersCount>0</membersCount>
  <openProspectsCount>0</openProspectsCount>
  <event id="1" uri="">
    <name>Test Api Group 5 - Default Event</name>
  </event>
  <location id="" uri="">
    <name></name>
    <description></description>
    <isOnline>false</isOnline>
    <url></url>
    <address>
      <address1></address1>
      <address2></address2>
      <address3></address3>
      <city></city>
      <stProvince></stProvince>
      <postalCode></postalCode>
      <county></county>
      <country></country>
      <carrierRoute></carrierRoute>
      <deliveryPoint></deliveryPoint>
      <latitude></latitude>
      <longitude></longitude>
      <createdDate></createdDate>
      <createdByPerson id="" uri="" />
      <lastUpdatedDate></lastUpdatedDate>
      <lastUpdatedByPerson id="" uri="" />
    </address>
    <createdDate></createdDate>
    <createdByPerson id="" uri="" />
    <lastUpdatedDate></lastUpdatedDate>
    <lastUpdatedByPerson id="" uri="" />
  </location>
  <createdDate>2012-07-12T15:01:59</createdDate>
  <createdByPerson id="1999191" uri="{{CONSUMER_ROOT_DOMAIN}}/people/1999191" />
  <lastUpdatedDate></lastUpdatedDate>
  <lastUpdatedByPerson id="" uri="" />
  <isLocationPrivate>false<isLocationPrivate>
</group>

Given: [POST] https://CHURCHCODE.fellowshiponeapi.com/groups/v1/groups.json

Request body:

{
   "group":{
      "@id":"",
      "@uri":"",
      "name":"Test Api Group 6",
      "description":"Test group created through api",
      "startDate":"2012-07-06T00:00:00",
      "expirationDate":null,
      "isOpen":"1",
      "isPublic":"1",
      "hasChildcare":"1",
      "isSearchable":"1",
      "isActive": "1",
      "churchCampus":{
         "@id":"1"
      },
      "groupType":{
         "@id":"7",
         "@uri":""
      },
      "groupURL":null,
      "timeZone":{
         "@id":"115",
         "@uri":""
      },
      "gender":{
         "@id":"0",
         "@uri":""
      },
      "maritalStatus":{
         "@id":"0",
         "@uri":""
      },
      "startAgeRange":"21",
      "endAgeRange":"30",
      "dateRangeType":{
         "@id":"",
         "@uri":""
      },
      "createdDate":null,
      "createdByPerson":{
         "@id":"",
         "@uri":""
      },
      "lastUpdatedDate":null,
      "lastUpdatedByPerson":{
         "@id":"",
         "@uri":""
      },
      "isLocationPrivate":"false"
   }
}

Response:

HTTP/1.1 201 Created
Cache-Control: private
Content-Type: application/json; charset=utf-8
Location: https://CHURCHCODE.fellowshiponeapi.com/groups/v1/groups.json/238600
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Thu, 12 Jul 2012 20:34:44 GMT
Content-Length: 1815

{
   "group":{
      "@id":"238600",
      "@uri":"https://CHURCHCODE.fellowshiponeapi.com/groups/v1/groups/238600",
      "name":"Test Api Group 6",
      "description":"Test group created through api",
      "startDate":"2012-07-06T00:00:00",
      "expirationDate":null,
      "isOpen":"true",
      "isPublic":"true",
      "hasChildcare":"true",
      "isSearchable":"true",
      "isActive": "true",
      "churchCampus":{
         "@id":"1",
         "name":null
      },
      "groupType":{
         "@id":"7",
         "@uri":"https://CHURCHCODE.fellowshiponeapi.com/groups/v1/grouptypes/7",
         "name":"Home Team"
      },
      "groupURL":null,
      "timeZone":{
         "@id":"115",
         "@uri":"https://CHURCHCODE.fellowshiponeapi.com/groups/v1/timezones/115",
         "name":"(GMT-06:00) Central Time (US & Canada)"
      },
      "gender":{
         "@id":"0",
         "@uri":"https://CHURCHCODE.fellowshiponeapi.com/groups/v1/genders/0",
         "name":"Coed"
      },
      "maritalStatus":{
         "@id":"0",
         "@uri":"https://CHURCHCODE.fellowshiponeapi.com/groups/v1/maritalstatuses/0",
         "name":"Married or Single"
      },
      "startAgeRange":"21",
      "endAgeRange":"30",
      "dateRangeType":{
         "@id":"7",
         "@uri":"https://CHURCHCODE.fellowshiponeapi.com/groups/v1/daterangetypes/7",
         "name":"Years"
      },
      "leadersCount":"0",
      "membersCount":"0",
      "openProspectsCount":"0",
      "event":{
         "@id":"1",
         "@uri":"",
         "name":"Test Api Group 6 - Default Event"
      },
      "location":{
         "@id":"",
         "@uri":"",
         "name":null,
         "description":null,
         "isOnline":"false",
         "url":null,
         "address":{
            "address1":null,
            "address2":null,
            "address3":null,
            "city":null,
            "stProvince":null,
            "postalCode":null,
            "county":null,
            "country":null,
            "carrierRoute":null,
            "deliveryPoint":null,
            "latitude":null,
            "longitude":null,
            "createdDate":null,
            "createdByPerson":{
               "@id":"",
               "@uri":""
            },
            "lastUpdatedDate":null,
            "lastUpdatedByPerson":{
               "@id":"",
               "@uri":""
            }
         },
         "createdDate":null,
         "createdByPerson":{
            "@id":"",
            "@uri":""
         },
         "lastUpdatedDate":null,
         "lastUpdatedByPerson":{
            "@id":"",
            "@uri":""
         }
      },
      "createdDate":"2012-07-12T15:34:43",
      "createdByPerson":{
         "@id":"1999191",
         "@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/1999191"
      },
      "lastUpdatedDate":null,
      "lastUpdatedByPerson":{
         "@id":"",
         "@uri":""
      },
      "isLocationPrivate":"false"
   }
}

Method: update [PUT] [POST (Low REST)]

The update method will update a group.

Content-types ::

application/json
application/xml

Format ::

json
xml

Parameters ::

{format}
- [PUT] https://CHURCHCODE.fellowshiponeapi.com/groups/v1/groups/{id}.{format}
- [PUT] https://CHURCHCODE.fellowshiponeapi.com/groups/v1/groups/{id}?format={format}
- [Header] Accept : {Content-type}
{id}
- [PUT] https://CHURCHCODE.fellowshiponeapi.com/groups/v1/groups/{id}

Sample Response ::

Given: [PUT] https://CHURCHCODE.fellowshiponeapi.com/groups/v1/groups/238600

Request body:

<group>
    <name>Test Api Group 6</name>
    <description>Test group updated through api</description>
    <startDate>2012-07-06T00:00:00</startDate>
    <expirationDate></expirationDate>
    <isOpen>1</isOpen>
    <isPublic>1</isPublic>
    <hasChildcare>1</hasChildcare>
    <isSearchable>1</isSearchable>
    <isActive>1</isActive>
    <churchCampus id="1"></churchCampus>
    <groupType id="7"></groupType>
    <groupURL></groupURL>
    <timeZone id="115"></timeZone>
    <gender id="0"></gender>
    <maritalStatus id="0"></maritalStatus>
    <startAgeRange>21</startAgeRange>
    <endAgeRange>30</endAgeRange>
    <dateRangeType></dateRangeType>
    <createdDate />
    <createdByPerson />
    <lastUpdatedDate />
    <lastUpdatedByPerson />
    <isLocatonPrivate />
</group>

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://CHURCHCODE.fellowshiponeapi.com/groups/v1/groups/238600
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Thu, 12 Jul 2012 23:10:07 GMT
Content-Length: 2587

<?xml version="1.0" encoding="utf-8"?>
<group id="238600" uri="https://CHURCHCODE.fellowshiponeapi.com/groups/v1/groups/238600">
  <name>Test Api Group 6</name>
  <description>Test group updated through api</description>
  <startDate>2012-07-06T00:00:00</startDate>
  <expirationDate></expirationDate>
  <isOpen>true</isOpen>
  <isPublic>true</isPublic>
  <hasChildcare>true</hasChildcare>
  <isSearchable>true</isSearchable>
  <isActive>true</isActive>
  <churchCampus id="1">
    <name></name>
  </churchCampus>
  <groupType id="7" uri="https://CHURCHCODE.fellowshiponeapi.com/groups/v1/grouptypes/7">
    <name>Home Team</name>
  </groupType>
  <groupURL></groupURL>
  <timeZone id="115" uri="https://CHURCHCODE.fellowshiponeapi.com/groups/v1/timezones/115">
    <name>(GMT-06:00) Central Time (US &amp; Canada)</name>
  </timeZone>
  <gender id="0" uri="https://CHURCHCODE.fellowshiponeapi.com/groups/v1/genders/0">
    <name>Coed</name>
  </gender>
  <maritalStatus id="0" uri="https://CHURCHCODE.fellowshiponeapi.com/groups/v1/maritalstatuses/0">
    <name>Married or Single</name>
  </maritalStatus>
  <startAgeRange>21</startAgeRange>
  <endAgeRange>30</endAgeRange>
  <dateRangeType id="7" uri="https://CHURCHCODE.fellowshiponeapi.com/groups/v1/daterangetypes/7">
    <name>Years</name>
  </dateRangeType>
  <leadersCount>0</leadersCount>
  <membersCount>0</membersCount>
  <openProspectsCount>0</openProspectsCount>
  <event id="1" uri="">
    <name>Test Api Group 6 - Default Event</name>
  </event>
  <location id="" uri="">
    <name></name>
    <description></description>
    <isOnline>false</isOnline>
    <url></url>
    <address>
      <address1></address1>
      <address2></address2>
      <address3></address3>
      <city></city>
      <stProvince></stProvince>
      <postalCode></postalCode>
      <county></county>
      <country></country>
      <carrierRoute></carrierRoute>
      <deliveryPoint></deliveryPoint>
      <latitude></latitude>
      <longitude></longitude>
      <createdDate></createdDate>
      <createdByPerson id="" uri="" />
      <lastUpdatedDate></lastUpdatedDate>
      <lastUpdatedByPerson id="" uri="" />
    </address>
    <createdDate></createdDate>
    <createdByPerson id="" uri="" />
    <lastUpdatedDate></lastUpdatedDate>
    <lastUpdatedByPerson id="" uri="" />
  </location>
  <createdDate>2012-07-12T15:34:43</createdDate>
  <createdByPerson id="1999191" uri="{{CONSUMER_ROOT_DOMAIN}}/people/1999191" />
  <lastUpdatedDate>2012-07-12T18:10:07</lastUpdatedDate>
  <lastUpdatedByPerson id="1999191" uri="{{CONSUMER_ROOT_DOMAIN}}/people/1999191" />
  <isLocationPrivate>false</isLocationPrivate>
</group>

Given: [PUT] https://CHURCHCODE.fellowshiponeapi.com/groups/v1/groups/238600.json

Request body:

{
   "group":{
      "@id":"",
      "@uri":"",
      "name":"Test Api Group 6",
      "description":"Test group also updated through api",
      "startDate":"2012-07-06T00:00:00",
      "expirationDate":null,
      "isOpen":"1",
      "isPublic":"1",
      "hasChildcare":"1",
      "isSearchable":"1",
      "isActive": "1",
      "churchCampus":{
         "@id":"1"
      },
      "groupType":{
         "@id":"7",
         "@uri":""
      },
      "groupURL":null,
      "timeZone":{
         "@id":"115",
         "@uri":""
      },
      "gender":{
         "@id":"0",
         "@uri":""
      },
      "maritalStatus":{
         "@id":"0",
         "@uri":""
      },
      "startAgeRange":"21",
      "endAgeRange":"30",
      "dateRangeType":{
         "@id":"",
         "@uri":""
      },
      "createdDate":null,
      "createdByPerson":{
         "@id":"",
         "@uri":""
      },
      "lastUpdatedDate":null,
      "lastUpdatedByPerson":{
         "@id":"",
         "@uri":""
      },
      "isLocationPrivate":"false"
   }
}

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Content-Location: https://CHURCHCODE.fellowshiponeapi.com/groups/v1/groups/238600.json
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Thu, 12 Jul 2012 23:13:14 GMT
Content-Length: 1892

{
    "group":{
        "@id":"238600",
        "@uri":"https://CHURCHCODE.fellowshiponeapi.com/groups/v1/groups/238600",
        "name":"Test Api Group 6",
        "description":"Test group also updated through api",
        "startDate":"2012-07-06T00:00:00",
        "expirationDate":null,
        "isOpen":"true",
        "isPublic":"true",
        "hasChildcare":"true",
        "isSearchable":"true",
        "isActive": "true",
        "churchCampus":{
            "@id":"1",
            "name":null
        },
        "groupType":{
            "@id":"7",
            "@uri":"https://CHURCHCODE.fellowshiponeapi.com/groups/v1/grouptypes/7",
            "name":"Home Team"
        },
        "groupURL":null,
        "timeZone":{
            "@id":"115",
            "@uri":"https://CHURCHCODE.fellowshiponeapi.com/groups/v1/timezones/115",
            "name":"(GMT-06:00) Central Time (US & Canada)"
        },
        "gender":{
            "@id":"0",
            "@uri":"https://CHURCHCODE.fellowshiponeapi.com/groups/v1/genders/0",
            "name":"Coed"
        },
        "maritalStatus":{
            "@id":"0",
            "@uri":"https://CHURCHCODE.fellowshiponeapi.com/groups/v1/maritalstatuses/0",
            "name":"Married or Single"
        },
        "startAgeRange":"21",
        "endAgeRange":"30",
        "dateRangeType":{
            "@id":"7",
            "@uri":"https://CHURCHCODE.fellowshiponeapi.com/groups/v1/daterangetypes/7",
            "name":"Years"
        },
        "leadersCount":"0",
        "membersCount":"0",
        "openProspectsCount":"0",
        "event":{
            "@id":"1",
            "@uri":"",
            "name":"Test Api Group 6 - Default Event"
        },
        "location":{
            "@id":"",
            "@uri":"",
            "name":null,
            "description":null,
            "isOnline":"false",
            "url":null,
            "address":{
                "address1":null,
                "address2":null,
                "address3":null,
                "city":null,
                "stProvince":null,
                "postalCode":null,
                "county":null,
                "country":null,
                "carrierRoute":null,
                "deliveryPoint":null,
                "latitude":null,
                "longitude":null,
                "createdDate":null,
                "createdByPerson":{
                    "@id":"",
                    "@uri":""
                },
                "lastUpdatedDate":null,
                "lastUpdatedByPerson":{
                    "@id":"",
                    "@uri":""
                }
            },
            "createdDate":null,
            "createdByPerson":{
                "@id":"",
                "@uri":""
            },
            "lastUpdatedDate":null,
            "lastUpdatedByPerson":{
                "@id":"",
                "@uri":""
            }
        },
        "createdDate":"2012-07-12T15:34:43",
        "createdByPerson":{
            "@id":"1999191",
            "@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/1999191"
        },
        "lastUpdatedDate":"2012-07-12T18:13:14",
        "lastUpdatedByPerson":{
            "@id":"1999191",
            "@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/1999191"
        },
        "isLocationPrivate":"false"
    }
}