Fellowship One - Developer Community

Categories

A Group category allows users to easily find a group by specific criteria.

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/categories, 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

categories ::

list [GET] https://CHURCHCODE.fellowshiponeapi.com/groups/v1/categories
show [GET] https://CHURCHCODE.fellowshiponeapi.com/groups/v1/categories/{id}

Method: list [GET]

The list method will return a list of categories.

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/categories.{format}
- [GET] https://CHURCHCODE.fellowshiponeapi.com/groups/v1/categories?format={format}
- [Header] Accept : {Content-type}

Sample Response ::

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

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://CHURCHCODE.fellowshiponeapi.com/groups/v1/categories
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Wed, 14 Apr 2010 19:03:54 GMT
Content-Length: 1011

<?xml version="1.0" encoding="utf-8"?>
<categories>
    <category json:Array="true" id="1" uri="https://CHURCHCODE.fellowshiponeapi.com/groups/v1/categories/1">
        <name>All ages males and females in North Dallas who speak Spanish or English</name>
    </category>
    <category json:Array="true" id="39" uri="https://CHURCHCODE.fellowshiponeapi.com/groups/v1/categories/39">
        <name>Gender</name>
     </category>
</categories>

Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/groups/v1/categories.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/categories.json
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: 2013 Oct 9 15:15:33
Content-Length: 184

{
   "categories":{
      "category":[
         {
            "@id":"1",
            "@uri":"https://CHURCHCODE.fellowshiponeapi.com/groups/v1/categories/1",
            "name":"All ages males and females in North Dallas who speak Spanish or English"
         },
         {
            "@id":"39",
            "@uri":"https://CHURCHCODE.fellowshiponeapi.com/groups/v1/categories/39",
            "name":"Gender"
         }
      ]
   }
}

Method: show [GET]

The show method will return a single category 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/categories/{id}.{format}
- [GET] https://CHURCHCODE.fellowshiponeapi.com/groups/v1/categories/{id}?format={format}
- [Header] Accept : {Content-type}
{id}
- [GET] https://CHURCHCODE.fellowshiponeapi.com/groups/v1/categories/{id}

Sample Response ::

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

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://CHURCHCODE.fellowshiponeapi.com/groups/v1/categories/1
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Wed, 14 Apr 2010 19:09:54 GMT
Content-Length: 176

<category id="1" uri="https://CHURCHCODE.fellowshiponeapi.com/groups/v1/categories/1">
    <name>All ages males and females in North Dallas who speak Spanish or English</name>
</category>

Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/groups/v1/categories/1.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/categories/1.json
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Wed, 14 Apr 2010 19:10:42 GMT
Content-Length: 119

{
    "category":
    {
        "@id":"1",
        "@uri":"https://CHURCHCODE.fellowshiponeapi.com/groups/v1/categories/1",
        "name":"All ages males and females in North Dallas who speak Spanish or English"
    }
}