Events
An event is something that occurs in a certain place during a particular interval of time.
Authentication
This method requires Authentication
Resource Structure
This resource conforms to the following XSD
Methods
Members ::
- list [GET] https://CHURCHCODE.fellowshiponeapi.com/events/v1/events
- show [GET] https://CHURCHCODE.fellowshiponeapi.com/events/v1/events/{id}
- edit [GET] https://CHURCHCODE.fellowshiponeapi.com/events/v1/events/{id}/edit
- update [PUT] [POST(Low REST)] https://CHURCHCODE.fellowshiponeapi.com/events/v1/events/{id}
Method: list [GET]
The list
method will return a list of events 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/events.{format}
- [GET] https://CHURCHCODE.fellowshiponeapi.com/events/v1/events?format={format}
- [Header] Accept : {Content-type}
Sample Response ::
Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/events/v1/events
Response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://CHURCHCODE.fellowshiponeapi.com/events/v1/events
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"?>
<events>
<event id="8296" uri="https://CHURCHCODE.fellowshiponeapi.com/events/v1/events/8296">
<name>Jinjyi's Date Control - Awesome Event</name>
<description>Default event for group: Jinjyi's Date Control</description>
<createdDate>2010-11-22T15:13:46</createdDate>
<createdByPerson id="28912161" uri="{{CONSUMER_ROOT_DOMAIN}}/people/28912161" />
<lastUpdatedDate>2010-12-06T10:51:47</lastUpdatedDate>
<lastUpdatedByPerson id="1999191" uri="{{CONSUMER_ROOT_DOMAIN}}/people/1999191" />
</event>
<event id="8298" uri="https://CHURCHCODE.fellowshiponeapi.com/events/v1/events/8298">
<name>Yet Another Group - Default Event</name>
<description>Default event for group: Yet Another Group</description>
....
</event>
</events>
Sample Response ::
Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/events/v1/events.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/events.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
{
"events":{
"event":[
{
"@id":"8296",
"@uri":"https://CHURCHCODE.fellowshiponeapi.com/events/v1/events/8296",
"name":"Jinjyi's Date Control - Awesome Event",
"description":"Default event for group: Jinjyi's Date Control",
"createdDate":"2010-11-22T15:13:46",
"createdByPerson":{
"@id":"28912161",
"@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/28912161"
},
"lastUpdatedDate":"2010-12-06T10:51:47",
"lastUpdatedByPerson":{
"@id":"1999191",
"@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/1999191"
}
},
...
]
}
}
Method: show [GET]
The show
keyword will return a single event
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/events/{id}.{format}
- [GET] https://CHURCHCODE.fellowshiponeapi.com/events/v1/events/{id}?format={format}
- [Header] Accept : {Content-type}
- {id}
- [GET] https://CHURCHCODE.fellowshiponeapi.com/events/v1/events/{id}
Sample Response ::
Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/events/v1/events/8296
Response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://CHURCHCODE.fellowshiponeapi.com/events/v1/events/8296
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"?>
<event id="8296" uri="https://CHURCHCODE.fellowshiponeapi.com/events/v1/events/8296">
<name>Jinjyi's Date Control - Awesome Event</name>
<description>Default event for group: Jinjyi's Date Control</description>
<createdDate>2010-11-22T15:13:46</createdDate>
<createdByPerson id="28912161" uri="{{CONSUMER_ROOT_DOMAIN}}/people/28912161" />
<lastUpdatedDate>2010-12-06T10:51:47</lastUpdatedDate>
<lastUpdatedByPerson id="1999191" uri="{{CONSUMER_ROOT_DOMAIN}}/people/1999191" />
</event>
Sample Response ::
Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/events/v1/events/8296.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/events/8296.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
{
"event":{
"@id":"8296",
"@uri":"https://CHURCHCODE.fellowshiponeapi.com/events/v1/events/8296",
"name":"Jinjyi's Date Control - Awesome Event",
"description":"Default event for group: Jinjyi's Date Control",
"createdDate":"2010-11-22T15:13:46",
"createdByPerson":{
"@id":"28912161",
"@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/28912161"
},
"lastUpdatedDate":"2010-12-06T10:51:47",
"lastUpdatedByPerson":{
"@id":"1999191",
"@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/1999191"
}
}
}
Method: edit [GET]
The edit
method will return a single event
for a given id
. 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
- application/help
Format ::
- json
- xml
- help
Parameters ::
- {format}
- [GET] https://CHURCHCODE.fellowshiponeapi.com/events/v1/events/{id}/edit.{format}
- [GET] https://CHURCHCODE.fellowshiponeapi.com/events/v1/events/{id}/edit?format={format}
- [Header] Accept : {Content-type}
- {id}
- [GET] https://CHURCHCODE.fellowshiponeapi.com/events/v1/events/{id}/edit
Sample Response ::
Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/events/v1/events/8296/edit
Response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://CHURCHCODE.fellowshiponeapi.com/events/v1/events/8296/edit
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 17:32:47 GMT
Content-Length: 565
<?xml version="1.0" encoding="utf-8"?>
<event id="8296" uri="https://CHURCHCODE.fellowshiponeapi.com/events/v1/events/8296">
<name>Jinjyi's Date Control - Awesome Event</name>
<description>Default event for group: Jinjyi's Date Control</description>
<createdDate>2010-11-22T15:13:46</createdDate>
<createdByPerson id="28912161" uri="{{CONSUMER_ROOT_DOMAIN}}/people/28912161" />
<lastUpdatedDate>2010-12-06T10:51:47</lastUpdatedDate>
<lastUpdatedByPerson id="1999191" uri="{{CONSUMER_ROOT_DOMAIN}}/people/1999191" />
</event>
Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/events/v1events/8296/edit.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/events/8296/edit.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 17:33:24 GMT
Content-Length: 478
{
"event":{
"@id":"8296",
"@uri":"https://CHURCHCODE.fellowshiponeapi.com/events/v1/events/8296",
"name":"Jinjyi's Date Control - Awesome Event",
"description":"Default event for group: Jinjyi's Date Control",
"createdDate":"2010-11-22T15:13:46",
"createdByPerson":{
"@id":"28912161",
"@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/28912161"
},
"lastUpdatedDate":"2010-12-06T10:51:47",
"lastUpdatedByPerson":{
"@id":"1999191",
"@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/1999191"
}
}
}
Method: update [PUT] [POST (Low REST)]
The update
method will update a location.
Content-types ::
- application/json
- application/xml
Format ::
- json
- xml
Parameters ::
- {format}
- [PUT] https://CHURCHCODE.fellowshiponeapi.com/events/v1/events/{id}.{format}
- [PUT] https://CHURCHCODE.fellowshiponeapi.com/events/v1/events/{id}?format={format}
- [Header] Accept : {Content-type}
- {id}
- [PUT] https://CHURCHCODE.fellowshiponeapi.com/events/v1/events/{id}
Sample Response ::
Given: [PUT] https://CHURCHCODE.fellowshiponeapi.com/events/v1/events/8296
Request body:
<?xml version="1.0" encoding="utf-8"?>
<event>
<name>Jinjyi's Date Control - Awesome Event</name>
<description>Default event for group: Jinjyi's Date Control</description>
<createdDate>2010-11-22T15:13:46</createdDate>
<createdByPerson id="28912161" uri="{{CONSUMER_ROOT_DOMAIN}}/people/28912161" />
<lastUpdatedDate>2010-12-06T10:51:47</lastUpdatedDate>
<lastUpdatedByPerson id="1999191" uri="{{CONSUMER_ROOT_DOMAIN}}/people/1999191" />
</event>
Response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://CHURCHCODE.fellowshiponeapi.com/events/v1/events/8296
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 17:35:58 GMT
Content-Length: 525
<?xml version="1.0" encoding="utf-8"?>
<event id="8296" uri="https://CHURCHCODE.fellowshiponeapi.com/events/v1/events/8296">
<name>Jinjyi's Date Control - Awesome Event</name>
<description>Default event for group: Jinjyi's Date Control</description>
<createdDate></createdDate>
<createdByPerson id="1999191" uri="{{CONSUMER_ROOT_DOMAIN}}/people/1999191" />
<lastUpdatedDate></lastUpdatedDate>
<lastUpdatedByPerson id="1999191" uri="{{CONSUMER_ROOT_DOMAIN}}/people/1999191" />
</event>
Given: [PUT] https://CHURCHCODE.fellowshiponeapi.com/events/v1/events/8296.json
Request body:
{
"event":{
"@id":",
"@uri":",
"name":"Jinjyi's Date Control - Awesome Event",
"description":"Default event for group: Jinjyi's Date Control",
"createdDate":"2010-11-22T15:13:46",
"createdByPerson":{
"@id":"28912161",
"@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/28912161"
},
"lastUpdatedDate":"2010-12-07T11:35:58",
"lastUpdatedByPerson":{
"@id":"1999191",
"@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/1999191"
}
}
}
Response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Content-Location: https://CHURCHCODE.fellowshiponeapi.com/events/v1/events/8296.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 17:37:59 GMT
Content-Length: 442
{
"event":{
"@id":"8296",
"@uri":"https://CHURCHCODE.fellowshiponeapi.com/events/v1/events/8296",
"name":"Jinjyi's Date Control - Awesome Event",
"description":"Default event for group: Jinjyi's Date Control",
"createdDate":null,
"createdByPerson":{
"@id":"1999191",
"@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/1999191"
},
"lastUpdatedDate":null,
"lastUpdatedByPerson":{
"@id":"1999191",
"@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/1999191"
}
}
}