Campuses

Campus is an indiciator on a group that specifices what campus a group belongs to.

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

campuses ::

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

Method: list [GET]

The list method will return a list of campuses.

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

Sample Response ::

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

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://CHURCHCODE.fellowshiponeapi.com/groups/v1/campuses
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"?>
<campuses>
    <campus json:Array="true" id="0" uri="https://CHURCHCODE.fellowshiponeapi.com/groups/v1/campuses/1">
        <name>North</name>
    </campus>
    <campus json:Array="true" id="1" uri="https://CHURCHCODE.fellowshiponeapi.com/groups/v1/campuses/2">
        <name>South>/name>
     </campus>
    <campus json:Array="true" id="2" uri="https://CHURCHCODE.fellowshiponeapi.com/groups/v1/campuses/3">
        <name>East</name>
    </campus>
</campuses>

Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/groups/v1/campuses.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/campuses.json
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Tue, 02 Nov 2010 20:38:35 GMT
Content-Length: 5384

{
   "campuses":{
      "campus":[
         {
            "@array":"true",
            "@id":"0",
            "@uri":"https://CHURCHCODE.fellowshiponeapi.com/groups/v1/campuses/1",
            "name":"North"
         },
         {
            "@array":"true",
            "@id":"1",
            "@uri":"https://CHURCHCODE.fellowshiponeapi.com/groups/v1/campuses/2",
            "name":"South"
         },
         {
            "@array":"true",
            "@id":"2",
            "@uri":"https://CHURCHCODE.fellowshiponeapi.com/groups/v1/campuses/3",
            "name":"East"
         }
      ]
   }
}

Method: show [GET]

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

Sample Response ::

Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/groups/v1/campuses/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/campuses/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

<campus id="1" uri="https://CHURCHCODE.fellowshiponeapi.com/groups/v1/campuses/1">
    <name>North</name>
</campus>

Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/groups/v1/campuses/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/campuses/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

{
    "campus":
    {
        "@id":"1",
        "@uri":"https://CHURCHCODE.fellowshiponeapi.com/groups/v1/campuses/1",
        "name":"North"
    }
}