RecurrenceTypes
A recurrence type specifies the kind of recurrence for a schedule.
Authentication
This method requires Authentication
Resource Structure
This resource conforms to the following XSD
Methods
Members ::
- list [GET] https://CHURCHCODE.fellowshiponeapi.com/events/v1/recurrencetypes
- show [GET] https://CHURCHCODE.fellowshiponeapi.com/events/v1/recurrencetypes/{id}
Method: list [GET]
The list
method will return a list of recurrence types for the church.
Notes ::
- By passing in the
content-type
ofapplication/xsd
in theaccept
header or using the {format} parameterxsd
the API will return anxsd
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/events/v1/recurrencetypes.{format}
- [GET] https://CHURCHCODE.fellowshiponeapi.com/events/v1/recurrencetypes?format={format}
- [Header] Accept : {Content-type}
Sample Response ::
Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/events/v1/recurrencetypes
Response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://CHURCHCODE.fellowshiponeapi.com/events/v1/recurrencetypes
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 19:24:56 GMT
Content-Length: 4118
<?xml version="1.0" encoding="utf-8"?>
<recurrenceTypes>
<recurrenceType json:Array="true" id="0" uri="https://CHURCHCODE.fellowshiponeapi.com/events/v1/RecurrenceTypes/0">
<name>OneTime</name>
</recurrenceType>
<recurrenceType json:Array="true" id="1" uri="https://CHURCHCODE.fellowshiponeapi.com/events/v1/RecurrenceTypes/1">
<name>Daily</name>
</recurrenceType>
<recurrenceType json:Array="true" id="2" uri="https://CHURCHCODE.fellowshiponeapi.com/events/v1/RecurrenceTypes/2">
<name>Weekly</name>
</recurrenceType>
<recurrenceType json:Array="true" id="3" uri="https://CHURCHCODE.fellowshiponeapi.com/events/v1/RecurrenceTypes/3">
<name>Monthly</name>
</recurrenceType>
<recurrenceType json:Array="true" id="4" uri="https://CHURCHCODE.fellowshiponeapi.com/events/v1/RecurrenceTypes/4">
<name>Annually</name>
</recurrenceType>
</recurrenceTypes>
Sample Response ::
Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/events/v1/recurrencetypes.json
Response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Content-Location: https://CHURCHCODE.fellowshiponeapi.com/events/v1/recurrencetypes.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 19:27:12 GMT
Content-Length: 3429
{
"recurrencetypes":{
"recurrencetype":[
{
"@id":"0",
"@uri":"https://CHURCHCODE.fellowshiponeapi.com/events/v1/recurrencetypes/0",
"name":"OneTime"
},
...
]
}
}
Method: show [GET]
The show
keyword will return a single recurrencetype
with the given id
.
Notes ::
- By passing in the
content-type
ofapplication/xsd
in theaccept
header or using the {format} parameterxsd
the API will return anxsd
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/events/v1/recurrencetypes/{id}.{format}
- [GET] https://CHURCHCODE.fellowshiponeapi.com/events/v1/recurrencetypes/{id}?format={format}
- [Header] Accept : {Content-type}
- {id}
- [GET] https://CHURCHCODE.fellowshiponeapi.com/events/v1/recurrencetypes/{id}
Sample Response ::
Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/events/v1/recurrencetypes/0
Response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://CHURCHCODE.fellowshiponeapi.com/events/v1recurrencetypes/0
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 16:24:43 GMT
Content-Length: 565
<?xml version="1.0" encoding="utf-8"?>
<recurrenceType id="0" uri="https://CHURCHCODE.fellowshiponeapi.com/events/v1/RecurrenceTypes/0">
<name>OneTime</name>
</recurrenceType>
Sample Response ::
Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/events/v1/recurrencetypes/0.json
Response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Content-Location: https://CHURCHCODE.fellowshiponeapi.com/events/v1/recurrencetypes/0.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 16:25:24 GMT
Content-Length: 478
{
"recurrencetype":{
"@id":"0",
"@uri":"https://CHURCHCODE.fellowshiponeapi.com/events/v1/recurrencetypes/0",
"name":"OneTime"
}
}