Schedules

A schedule contains date/time information for an event.

Authentication

This method requires Authentication

Resource Structure

This resource conforms to the following XSD

Methods

Members ::

  • list [GET] https://demo.fellowshiponeapi.com/events/v1/events/{id}/schedules
  • show [GET] https://demo.fellowshiponeapi.com/events/v1/events/{id}/schedules/{id}
  • new [GET] https://demo.fellowshiponeapi.com/events/v1/events/{id}/schedules/new
  • edit [GET] https://demo.fellowshiponeapi.com/events/v1/events/{id}/schedules/{id}/edit
  • create [POST] https://demo.fellowshiponeapi.com/events/v1/events/{id}/schedules
  • update [PUT] [POST(Low REST)] https://demo.fellowshiponeapi.com/events/v1/events/{id}/schedules/{id}
  • delete [DELETE] https://demo.fellowshiponeapi.com/events/v1/events/{id}/schedules/{id}
  • delete [GET(Low REST)] https://demo.fellowshiponeapi.com/events/v1/events/{id}/schedules/{id}/delete

Method: list [GET]

The list method will return a list of schedules in the context of an event.

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)
  • The recurrences node can contain one or many recurrence nodes.
    • Each recurrence node contains a recurrenceWeekly and recurrenceMonthly node. However, only the node that matches the recurrenceType can be used. For example, if the recurrenceType is 2 (Weekly) then only the recurrenceWeekly node is valid in the entity.
    • Multiple recurrenceMonthly entities can exist for a given schedule however only one recurrenceWeekly can exist for a given schedule.
    • Even though you can have multiple recurrenceMonthly entities each recurrence node contains one recurrenceWeekly and one recurrenceMonthly node. To get multiple recurrenceMonthly nodes you need to have multiple recurrence nodes with the recurrenceMonthly nodes set to there unique values. This allows for schedules like "1st & 3rd Sunday every month."
  • The monthly and weekly recurrence pattern follows the iCalendar RFC (RFC 5545) which can be found here: http://tools.ietf.org/html/rfc5545

Content-types ::

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

Format ::

  • json
  • xml
  • xsd
  • help

Parameters ::

  • {format}
    • [GET] https://demo.fellowshiponeapi.com/events/v1/events/{id}/schedules.{format}
    • [GET] https://demo.fellowshiponeapi.com/events/v1/events/{id}/schedules?format={format}
    • [Header] Accept : {Content-type}

Sample Response ::

Given: [GET] https://demo.fellowshiponeapi.com/events/v1/events/8296/schedules

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://demo.fellowshiponeapi.com/events/v1/events/8296/schedules
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Wed, 08 Dec 2010 15:50:35 GMT
Content-Length: 1466

<?xml version="1.0" encoding="utf-8"?>
<schedules>
  <schedule json:Array="true" id="2267" uri="https://demo.fellowshiponeapi.com/events/v1/schedules/2267">
    <name>Default Schedule 1</name>
    <description></description>
    <startTime>2010-12-07T03:00:00</startTime>
    <endTime></endTime>
    <numberRecurrences></numberRecurrences>
    <startDate>2010-11-22T00:00:00</startDate>
    <endDate>2010-12-07T00:00:00</endDate>
    <recurrenceType id="2" uri="https://demo.fellowshiponeapi.com/events/v1/RecurrenceType/2">
      <name>Weekly</name>
    </recurrenceType>
    <recurrences>
      <recurrence>
        <recurrenceWeekly>
          <recurrenceFrequency>2</recurrenceFrequency>
          <occurOnSunday>false</occurOnSunday>
          <occurOnMonday>true</occurOnMonday>
          <occurOnTuesday>false</occurOnTuesday>
          <occurOnWednesday>false</occurOnWednesday>
          <occurOnThursday>false</occurOnThursday>
          <occurOnFriday>false</occurOnFriday>
          <occurOnSaturday>false</occurOnSaturday>
        </recurrenceWeekly>
        <recurrenceMonthly>
          <recurrenceFrequency></recurrenceFrequency>
          <recurrenceOffset></recurrenceOffset>
          <monthDay></monthDay>
          <monthWeekDay></monthWeekDay>
        </recurrenceMonthly>
      </recurrence>
    </recurrences>
    <createdDate>2010-12-07T20:06:32</createdDate>
    <createdByPerson id="1999191" uri="{{CONSUMER_ROOT_DOMAIN}}/people/1999191" />
    <lastUpdatedDate></lastUpdatedDate>
    <lastUpdatedByPerson id=" uri=" />
  </schedule>
</schedules>

Sample Response ::

Given: [GET] https://demo.fellowshiponeapi.com/events/v1/events/8296/schedules.json

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Content-Location: https://demo.fellowshiponeapi.com/events/v1/events/8296/schedules.json
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Wed, 08 Dec 2010 15:51:31 GMT
Content-Length: 944

{
   "schedules":{
      "schedule":[
         {
            "@array":"true",
            "@id":"2267",
            "@uri":"https://demo.fellowshiponeapi.com/events/v1/schedules/2267",
            "name":"Default Schedule 1",
            "description":null,
            "startTime":"2010-12-07T03:00:00",
            "endTime":null,
            "numberRecurrences":null,
            "startDate":"2010-11-22T00:00:00",
            "endDate":"2010-12-07T00:00:00",
            "recurrenceType":{
               "@id":"2",
               "@uri":"https://demo.fellowshiponeapi.com/events/v1/RecurrenceType/2",
               "name":"Weekly"
            },
             "recurrences":{
                "recurrence":{
                    "recurrenceWeekly":{
                       "recurrenceFrequency":"2",
                       "occurOnSunday":"false",
                       "occurOnMonday":"true",
                       "occurOnTuesday":"false",
                       "occurOnWednesday":"false",
                       "occurOnThursday":"false",
                       "occurOnFriday":"false",
                       "occurOnSaturday":"false"
                    },
                    "recurrenceMonthly":{
                       "recurrenceFrequency":null,
                       "recurrenceOffset":null,
                       "monthDay":null,
                       "monthWeekDay":null
                    }
                }
            },
            "createdDate":"2010-12-07T20:06:32",
            "createdByPerson":{
               "@id":"1999191",
               "@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/1999191"
            },
            "lastUpdatedDate":null,
            "lastUpdatedByPerson":{
               "@id":",
               "@uri":"
            }
         }
      ]
   }
}

Method: show [GET]

The show keyword will return a single schedule with the 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://demo.fellowshiponeapi.com/events/v1/events/{id}/schedules/{id}.{format}
    • [GET] https://demo.fellowshiponeapi.com/events/v1/events/{id}/schedules/{id}?format={format}
    • [Header] Accept : {Content-type}
  • {id}
    • [GET] https://demo.fellowshiponeapi.com/events/v1/events/{id}/schedules/{id}

Sample Response ::

Given: [GET] https://demo.fellowshiponeapi.com/events/v1/events/8296/schedules/2267

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://demo.fellowshiponeapi.com/events/v1/events/8296/schedules/2267
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Wed, 08 Dec 2010 15:53:26 GMT
Content-Length: 1375

<?xml version="1.0" encoding="utf-8"?>
<schedule id="2267" uri="https://demo.fellowshiponeapi.com/events/v1/schedules/2267">
  <name>Default Schedule 1</name>
  <description></description>
  <startTime>2010-12-07T03:00:00</startTime>
  <endTime></endTime>
  <numberRecurrences></numberRecurrences>
  <startDate>2010-11-22T00:00:00</startDate>
  <endDate>2010-12-07T00:00:00</endDate>
  <recurrenceType id="2" uri="https://demo.fellowshiponeapi.com/events/v1/RecurrenceType/2">
    <name>Weekly</name>
  </recurrenceType>
  <recurrences>
      <recurrence>
          <recurrenceWeekly>
            <recurrenceFrequency>2</recurrenceFrequency>
            <occurOnSunday>false</occurOnSunday>
            <occurOnMonday>true</occurOnMonday>
            <occurOnTuesday>false</occurOnTuesday>
            <occurOnWednesday>false</occurOnWednesday>
            <occurOnThursday>false</occurOnThursday>
            <occurOnFriday>false</occurOnFriday>
            <occurOnSaturday>false</occurOnSaturday>
          </recurrenceWeekly>
          <recurrenceMonthly>
            <recurrenceFrequency></recurrenceFrequency>
            <recurrenceOffset></recurrenceOffset>
            <monthDay></monthDay>
            <monthWeekDay></monthWeekDay>
          </recurrenceMonthly>
      </recurrence>
  </recurrences>
  <createdDate>2010-12-07T20:06:32</createdDate>
  <createdByPerson id="1999191" uri="{{CONSUMER_ROOT_DOMAIN}}/people/1999191" />
  <lastUpdatedDate></lastUpdatedDate>
  <lastUpdatedByPerson id=" uri=" />
</schedule>

Sample Response ::

Given: [GET] https://demo.fellowshiponeapi.com/events/v1/events/8296/schedules/2267.json

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Content-Location: https://demo.fellowshiponeapi.com/events/v1/events/8296/schedules/2267.json
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Wed, 08 Dec 2010 15:53:53 GMT
Content-Length: 930

{
   "schedule":{
      "@id":"2267",
      "@uri":"https://demo.fellowshiponeapi.com/events/v1/schedules/2267",
      "name":"Default Schedule 1",
      "description":null,
      "startTime":"2010-12-07T03:00:00",
      "endTime":null,
      "numberRecurrences":null,
      "startDate":"2010-11-22T00:00:00",
      "endDate":"2010-12-07T00:00:00",
      "recurrenceType":{
         "@id":"2",
         "@uri":"https://demo.fellowshiponeapi.com/events/v1/RecurrenceType/2",
         "name":"Weekly"
      },
       "recurrences":{
           "recurrence":{
               "recurrenceWeekly":{
                  "recurrenceFrequency":"2",
                  "occurOnSunday":"false",
                  "occurOnMonday":"true",
                  "occurOnTuesday":"false",
                  "occurOnWednesday":"false",
                  "occurOnThursday":"false",
                  "occurOnFriday":"false",
                  "occurOnSaturday":"false"
               },
               "recurrenceMonthly":{
                  "recurrenceFrequency":null,
                  "recurrenceOffset":null,
                  "monthDay":null,
                  "monthWeekDay":null
            }
         }
      },
      "createdDate":"2010-12-07T20:06:32",
      "createdByPerson":{
         "@id":"1999191",
         "@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/1999191"
      },
      "lastUpdatedDate":null,
      "lastUpdatedByPerson":{
         "@id":",
         "@uri":"
      }
   }
}

Method: new [GET]

The new keyword will return a single schedule. 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://demo.fellowshiponeapi.com/events/v1/events/{id}/schedules/new.{format}
    • [GET] https://demo.fellowshiponeapi.com/events/v1/events/{id}/schedules/new?format={format}
    • [Header] Accept : {Content-type}

Sample Response ::

Given: [GET] https://demo.fellowshiponeapi.com/events/v1/events/8296/schedules/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: Wed, 08 Dec 2010 15:55:49 GMT
Content-Length: 1056

<?xml version="1.0" encoding="utf-8"?>
<schedule id=" uri=">
  <name></name>
  <description></description>
  <startTime></startTime>
  <endTime></endTime>
  <numberRecurrences></numberRecurrences>
  <startDate></startDate>
  <endDate></endDate>
  <recurrenceType id=" uri=">
    <name></name>
  </recurrenceType>
   <recurrences>
      <recurrence>
          <recurrenceWeekly>
            <recurrenceFrequency></recurrenceFrequency>
            <occurOnSunday></occurOnSunday>
            <occurOnMonday></occurOnMonday>
            <occurOnTuesday></occurOnTuesday>
            <occurOnWednesday></occurOnWednesday>
            <occurOnThursday></occurOnThursday>
            <occurOnFriday></occurOnFriday>
            <occurOnSaturday></occurOnSaturday>
          </recurrenceWeekly>
          <recurrenceMonthly>
            <recurrenceFrequency></recurrenceFrequency>
            <recurrenceOffset></recurrenceOffset>
            <monthDay></monthDay>
            <monthWeekDay></monthWeekDay>
          </recurrenceMonthly>
      </recurrence>
  </recurrences>
  <createdDate></createdDate>
  <createdByPerson id=" uri=" />
  <lastUpdatedDate></lastUpdatedDate>
  <lastUpdatedByPerson id=" uri=" />
</schedule>

Given: [GET] https://demo.fellowshiponeapi.com/events/v1/events/8296/schedules/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: Wed, 08 Dec 2010 15:56:37 GMT
Content-Length: 639

{
   "schedule":{
      "@id":",
      "@uri":",
      "name":null,
      "description":null,
      "startTime":null,
      "endTime":null,
      "numberRecurrences":null,
      "startDate":null,
      "endDate":null,
      "recurrenceType":{
         "@id":",
         "@uri":",
         "name":null
      },
       "recurrences":{
           "recurrence":{
              "recurrenceWeekly":{
                 "recurrenceFrequency":null,
                 "occurOnSunday":null,
                 "occurOnMonday":null,
                 "occurOnTuesday":null,
                 "occurOnWednesday":null,
                 "occurOnThursday":null,
                 "occurOnFriday":null,
                 "occurOnSaturday":null
              },
              "recurrenceMonthly":{
                 "recurrenceFrequency":null,
                 "recurrenceOffset":null,
                 "monthDay":null,
                 "monthWeekDay":null
              }
          }
      },
      "createdDate":null,
      "createdByPerson":{
         "@id":",
         "@uri":"
      },
      "lastUpdatedDate":null,
      "lastUpdatedByPerson":{
         "@id":",
         "@uri":"
      }
   }
}

Method: edit [GET]

The edit method will return a single schedule 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://demo.fellowshiponeapi.com/events/v1/events/{id}/schedules/{id}/edit.{format}
    • [GET] https://demo.fellowshiponeapi.com/events/v1/events/{id}/schedules/{id}/edit?format={format}
    • [Header] Accept : {Content-type}
  • {id}
    • [GET] https://demo.fellowshiponeapi.com/events/v1/events/{id}/schedules/{id}/edit

Sample Response ::

Given: [GET] https://demo.fellowshiponeapi.com/events/v1/events/8296/schedules/2267/edit

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://demo.fellowshiponeapi.com/events/v1/events/8296/schedules/2267/edit
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Wed, 08 Dec 2010 16:16:05 GMT
Content-Length: 1375

<?xml version="1.0" encoding="utf-8"?>
<schedule id="2267" uri="https://demo.fellowshiponeapi.com/events/v1/schedules/2267">
  <name>Default Schedule 1</name>
  <description></description>
  <startTime>2010-12-07T03:00:00</startTime>
  <endTime></endTime>
  <numberRecurrences></numberRecurrences>
  <startDate>2010-11-22T00:00:00</startDate>
  <endDate>2010-12-07T00:00:00</endDate>
  <recurrenceType id="2" uri="https://demo.fellowshiponeapi.com/events/v1/RecurrenceType/2">
    <name>Weekly</name>
  </recurrenceType>
   <recurrences>
      <recurrence>
        <recurrenceWeekly>
        <recurrenceFrequency>2</recurrenceFrequency>
        <occurOnSunday>false</occurOnSunday>
        <occurOnMonday>true</occurOnMonday>
        <occurOnTuesday>false</occurOnTuesday>
        <occurOnWednesday>false</occurOnWednesday>
        <occurOnThursday>false</occurOnThursday>
        <occurOnFriday>false</occurOnFriday>
        <occurOnSaturday>false</occurOnSaturday>
      </recurrenceWeekly>
      <recurrenceMonthly>
        <recurrenceFrequency></recurrenceFrequency>
        <recurrenceOffset></recurrenceOffset>
        <monthDay></monthDay>
        <monthWeekDay></monthWeekDay>
      </recurrenceMonthly>
    </recurrence>
  </recurrences>
  <createdDate>2010-12-07T20:06:32</createdDate>
  <createdByPerson id="1999191" uri="{{CONSUMER_ROOT_DOMAIN}}/people/1999191" />
  <lastUpdatedDate></lastUpdatedDate>
  <lastUpdatedByPerson id=" uri=" />
</schedule>

Given: [GET] https://demo.fellowshiponeapi.com/events/v1/schedules/8296/schedules/2267/edit.json

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Content-Location: https://demo.fellowshiponeapi.com/events/v1/events/8296/schedules/2267/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, 08 Dec 2010 16:16:49 GMT
Content-Length: 930

{
   "schedule":{
      "@id":"2267",
      "@uri":"https://demo.fellowshiponeapi.com/events/v1/schedules/2267",
      "name":"Default Schedule 1",
      "description":null,
      "startTime":"2010-12-07T03:00:00",
      "endTime":null,
      "numberRecurrences":null,
      "startDate":"2010-11-22T00:00:00",
      "endDate":"2010-12-07T00:00:00",
      "recurrenceType":{
         "@id":"2",
         "@uri":"https://demo.fellowshiponeapi.com/events/v1/RecurrenceType/2",
         "name":"Weekly"
      },
       "recurrences":{
           "recurrence":{
              "recurrenceWeekly":{
                 "recurrenceFrequency":"2",
                 "occurOnSunday":"false",
                 "occurOnMonday":"true",
                 "occurOnTuesday":"false",
                 "occurOnWednesday":"false",
                 "occurOnThursday":"false",
                 "occurOnFriday":"false",
                 "occurOnSaturday":"false"
              },
              "recurrenceMonthly":{
                 "recurrenceFrequency":null,
                 "recurrenceOffset":null,
                 "monthDay":null,
                 "monthWeekDay":null
              }
          }
      },
      "createdDate":"2010-12-07T20:06:32",
      "createdByPerson":{
         "@id":"1999191",
         "@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/1999191"
      },
      "lastUpdatedDate":null,
      "lastUpdatedByPerson":{
         "@id":",
         "@uri":"
      }
   }
}

Method: create [POST]

The create method will create a schedule in the context of an event.

Notes ::

  • This method will return a 201 - Created if successfully created

Content-types ::

  • application/json
  • application/xml

Format ::

  • json
  • xml

Parameters ::

  • {format}
    • [POST] https://demo.fellowshiponeapi.com/events/v1/events/{id}/schedules.{format}
    • [POST] https://demo.fellowshiponeapi.com/events/v1/events/{id}/schedules?format={format}
    • [Header] Accept : {Content-type}

Sample Response ::

Given: [POST] https://demo.fellowshiponeapi.com/events/v1/events/8296/schedules

Request body:

<?xml version="1.0" encoding="utf-8"?>
<schedule>
  <name>Default Schedule 1</name>
  <description></description>
  <startTime>2010-12-07T03:00:00</startTime>
  <endTime></endTime>
  <numberRecurrences></numberRecurrences>
  <startDate>2010-11-22T00:00:00</startDate>
  <endDate>2010-12-07T00:00:00</endDate>
  <recurrenceType id="2">
    <name></name>
  </recurrenceType>
  <recurrences>
     <recurrence>
       <recurrenceWeekly>
          <recurrenceFrequency>2</recurrenceFrequency>
          <occurOnSunday>false</occurOnSunday>
          <occurOnMonday>true</occurOnMonday>
          <occurOnTuesday>false</occurOnTuesday>
          <occurOnWednesday>false</occurOnWednesday>
          <occurOnThursday>false</occurOnThursday>
          <occurOnFriday>false</occurOnFriday>
          <occurOnSaturday>false</occurOnSaturday>
       </recurrenceWeekly>
       <recurrenceMonthly>
          <recurrenceFrequency></recurrenceFrequency>
          <recurrenceOffset></recurrenceOffset>
          <monthDay></monthDay>
          <monthWeekDay></monthWeekDay>
       </recurrenceMonthly>
     </recurrence>
  </recurrences>
  <createdDate></createdDate>
  <createdByPerson id=" uri=" />
  <lastUpdatedDate></lastUpdatedDate>
  <lastUpdatedByPerson id=" uri=" />
</schedule>

Response:

HTTP/1.1 201 Created
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Location: https://demo.fellowshiponeapi.com/events/v1/events/8296/schedules/2268
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Wed, 08 Dec 2010 16:24:10 GMT
Content-Length: 1375

<?xml version="1.0" encoding="utf-8"?>
<schedule id="2268" uri="https://demo.fellowshiponeapi.com/events/v1/schedules/2268">
  <name>Default Schedule 1</name>
  <description></description>
  <startTime>2010-12-07T03:00:00</startTime>
  <endTime></endTime>
  <numberRecurrences></numberRecurrences>
  <startDate>2010-11-22T00:00:00</startDate>
  <endDate>2010-12-07T00:00:00</endDate>
  <recurrenceType id="2" uri="https://demo.fellowshiponeapi.com/events/v1/RecurrenceType/2">
    <name>Weekly</name>
  </recurrenceType>
   <recurrences>
      <recurrence>
         <recurrenceWeekly>
           <recurrenceFrequency>2</recurrenceFrequency>
           <occurOnSunday>false</occurOnSunday>
           <occurOnMonday>true</occurOnMonday>
           <occurOnTuesday>false</occurOnTuesday>
           <occurOnWednesday>false</occurOnWednesday>
           <occurOnThursday>false</occurOnThursday>
           <occurOnFriday>false</occurOnFriday>
           <occurOnSaturday>false</occurOnSaturday>
         </recurrenceWeekly>
         <recurrenceMonthly>
           <recurrenceFrequency></recurrenceFrequency>
           <recurrenceOffset></recurrenceOffset>
           <monthDay></monthDay>
           <monthWeekDay></monthWeekDay>
         </recurrenceMonthly>
      </recurrence>
  </recurrences>
  <createdDate>2010-12-08T10:24:09</createdDate>
  <createdByPerson id="1999191" uri="{{CONSUMER_ROOT_DOMAIN}}/people/1999191" />
  <lastUpdatedDate></lastUpdatedDate>
  <lastUpdatedByPerson id=" uri=" />
</schedule>

Given: [POST] https://demo.fellowshiponeapi.com/events/v1/events/8296/schedules.json

Request body:

{
   "schedule":{
      "@id":",
      "@uri":",
      "name":"Default Schedule 1",
      "description":null,
      "startTime":"2010-12-07T03:00:00",
      "endTime":null,
      "numberRecurrences":null,
      "startDate":"2010-11-22T00:00:00",
      "endDate":"2010-12-07T00:00:00",
      "recurrenceType":{
         "@id":"2",
         "@uri":",
         "name":"Weekly"
      },
       "recurrences":{
           "recurrence":{
              "recurrenceWeekly":{
                 "recurrenceFrequency":"2",
                 "occurOnSunday":"false",
                 "occurOnMonday":"true",
                 "occurOnTuesday":"false",
                 "occurOnWednesday":"false",
                 "occurOnThursday":"false",
                 "occurOnFriday":"false",
                 "occurOnSaturday":"false"
              },
              "recurrenceMonthly":{
                 "recurrenceFrequency":null,
                 "recurrenceOffset":null,
                 "monthDay":null,
                 "monthWeekDay":null
              }
          }
      },
      "createdDate":",
      "createdByPerson":{
         "@id":",
         "@uri":"
      },
      "lastUpdatedDate":null,
      "lastUpdatedByPerson":{
         "@id":",
         "@uri":"
      }
   }
}

Response:

HTTP/1.1 201 Created
Cache-Control: private
Content-Type: application/json; charset=utf-8
Location: https://demo.fellowshiponeapi.com/events/v1/events/8296/schedules.json/2269
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Wed, 08 Dec 2010 16:27:44 GMT
Content-Length: 930

{
   "schedule":{
      "@id":"2269",
      "@uri":"https://demo.fellowshiponeapi.com/events/v1/schedules/2269",
      "name":"Default Schedule 1",
      "description":null,
      "startTime":"2010-12-07T03:00:00",
      "endTime":null,
      "numberRecurrences":null,
      "startDate":"2010-11-22T00:00:00",
      "endDate":"2010-12-07T00:00:00",
      "recurrenceType":{
         "@id":"2",
         "@uri":"https://demo.fellowshiponeapi.com/events/v1/RecurrenceType/2",
         "name":"Weekly"
      },
      "recurrences":{
          "recurrence":{
              "recurrenceWeekly":{
                 "recurrenceFrequency":"2",
                 "occurOnSunday":"false",
                 "occurOnMonday":"true",
                 "occurOnTuesday":"false",
                 "occurOnWednesday":"false",
                 "occurOnThursday":"false",
                 "occurOnFriday":"false",
                 "occurOnSaturday":"false"
              },
              "recurrenceMonthly":{
                 "recurrenceFrequency":null,
                 "recurrenceOffset":null,
                 "monthDay":null,
                 "monthWeekDay":null
              }
          }
      },
      "createdDate":"2010-12-08T10:27:44",
      "createdByPerson":{
         "@id":"1999191",
         "@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/1999191"
      },
      "lastUpdatedDate":null,
      "lastUpdatedByPerson":{
         "@id":",
         "@uri":"
      }
   }
}

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

The update method will update a schedule.

Content-types ::

  • application/json
  • application/xml

Format ::

  • json
  • xml

Parameters ::

  • {format}
    • [PUT] https://demo.fellowshiponeapi.com/events/v1/events/{id}/schedules/{id}.{format}
    • [PUT] https://demo.fellowshiponeapi.com/events/v1/events/{id}/schedules/{id}?format={format}
    • [Header] Accept : {Content-type}
  • {id}
    • [PUT] https://demo.fellowshiponeapi.com/events/v1/events/{id}/schedules/{id}

Sample Response ::

Given: [PUT] https://demo.fellowshiponeapi.com/events/v1/events/8296/schedules/2068

Request body:

<?xml version="1.0" encoding="utf-8"?>
<schedule>
  <name>Default Schedule 1</name>
  <description></description>
  <startTime>2010-12-07T03:00:00</startTime>
  <endTime></endTime>
  <numberRecurrences></numberRecurrences>
  <startDate>2010-11-22T00:00:00</startDate>
  <endDate>2010-12-07T00:00:00</endDate>
  <recurrenceType id="2" uri=">
    <name>Weekly</name>
  </recurrenceType>
  <recurrences>
     <recurrence>
       <recurrenceWeekly>
          <recurrenceFrequency>2</recurrenceFrequency>
          <occurOnSunday>false</occurOnSunday>
          <occurOnMonday>true</occurOnMonday>
          <occurOnTuesday>false</occurOnTuesday>
          <occurOnWednesday>false</occurOnWednesday>
          <occurOnThursday>false</occurOnThursday>
          <occurOnFriday>false</occurOnFriday>
          <occurOnSaturday>false</occurOnSaturday>
       </recurrenceWeekly>
       <recurrenceMonthly>
          <recurrenceFrequency></recurrenceFrequency>
          <recurrenceOffset></recurrenceOffset>
          <monthDay></monthDay>
          <monthWeekDay></monthWeekDay>
       </recurrenceMonthly>
     </recurrence>
  <recurrences>
  <createdDate></createdDate>
  <createdByPerson id=" uri=" />
  <lastUpdatedDate></lastUpdatedDate>
  <lastUpdatedByPerson id=" uri=" />
</schedule>

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://demo.fellowshiponeapi.com/events/v1/events/8296/schedules/2269
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Wed, 08 Dec 2010 16:30:24 GMT
Content-Length: 1453

<?xml version="1.0" encoding="utf-8"?>
<schedule id="2269" uri="https://demo.fellowshiponeapi.com/events/v1/schedules/2269">
  <name>Default Schedule 1</name>
  <description></description>
  <startTime>2010-12-07T03:00:00</startTime>
  <endTime></endTime>
  <numberRecurrences></numberRecurrences>
  <startDate>2010-11-22T00:00:00</startDate>
  <endDate>2010-12-07T00:00:00</endDate>
  <recurrenceType id="2" uri="https://demo.fellowshiponeapi.com/events/v1/RecurrenceType/2">
    <name>Weekly</name>
  </recurrenceType>
   <recurrences>
     <recurrence>
        <recurrenceWeekly>
          <recurrenceFrequency>2</recurrenceFrequency>
          <occurOnSunday>false</occurOnSunday>
          <occurOnMonday>true</occurOnMonday>
          <occurOnTuesday>false</occurOnTuesday>
          <occurOnWednesday>false</occurOnWednesday>
          <occurOnThursday>false</occurOnThursday>
          <occurOnFriday>false</occurOnFriday>
          <occurOnSaturday>false</occurOnSaturday>
       </recurrenceWeekly>
       <recurrenceMonthly>
          <recurrenceFrequency></recurrenceFrequency>
          <recurrenceOffset></recurrenceOffset>
          <monthDay></monthDay>
          <monthWeekDay></monthWeekDay>
       </recurrenceMonthly>
     </recurrence>
  </recurrences>
  <createdDate>2010-12-08T10:27:44</createdDate>
  <createdByPerson id="1999191" uri="{{CONSUMER_ROOT_DOMAIN}}/people/1999191" />
  <lastUpdatedDate>2010-12-08T10:30:24</lastUpdatedDate>
  <lastUpdatedByPerson id="1999191" uri="{{CONSUMER_ROOT_DOMAIN}}/people/1999191" />
</schedule>

Given: [PUT] https://demo.fellowshiponeapi.com/events/v1/events/8296/schedules/2060.json

Request body:

{
   "schedule":{
      "@id":",
      "@uri":",
      "name":"Default Schedule 1",
      "description":null,
      "startTime":"2010-12-07T03:00:00",
      "endTime":null,
      "numberRecurrences":null,
      "startDate":"2010-11-22T00:00:00",
      "endDate":"2010-12-07T00:00:00",
      "recurrenceType":{
         "@id":"2",
         "@uri":",
         "name":"Weekly"
      },
      "recurrences":{
           "recurrence":{
              "recurrenceWeekly":{
                 "recurrenceFrequency":"2",
                 "occurOnSunday":"false",
                 "occurOnMonday":"true",
                 "occurOnTuesday":"false",
                 "occurOnWednesday":"false",
                 "occurOnThursday":"false",
                 "occurOnFriday":"false",
                 "occurOnSaturday":"false"
              },
              "recurrenceMonthly":{
                 "recurrenceFrequency":null,
                 "recurrenceOffset":null,
                 "monthDay":null,
                 "monthWeekDay":null
              }
          }
      },
      "createdDate":"2010-12-08T10:27:44",
      "createdByPerson":{
         "@id":",
         "@uri":"
      },
      "lastUpdatedDate":"2010-12-08T10:30:24",
      "lastUpdatedByPerson":{
         "@id":",
         "@uri":"
      }
   }
}

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Content-Location: https://demo.fellowshiponeapi.com/events/v1/events/8296/schedules/2269.json
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Wed, 08 Dec 2010 16:32:52 GMT
Content-Length: 1006

{
   "schedule":{
      "@id":"2269",
      "@uri":"https://demo.fellowshiponeapi.com/events/v1/schedules/2269",
      "name":"Default Schedule 1",
      "description":null,
      "startTime":"2010-12-07T03:00:00",
      "endTime":null,
      "numberRecurrences":null,
      "startDate":"2010-11-22T00:00:00",
      "endDate":"2010-12-07T00:00:00",
      "recurrenceType":{
         "@id":"2",
         "@uri":"https://demo.fellowshiponeapi.com/events/v1/RecurrenceType/2",
         "name":"Weekly"
      },
      "recurrences":{
           "recurrence":{
              "recurrenceWeekly":{
                 "recurrenceFrequency":"2",
                 "occurOnSunday":"false",
                 "occurOnMonday":"true",
                 "occurOnTuesday":"false",
                 "occurOnWednesday":"false",
                 "occurOnThursday":"false",
                 "occurOnFriday":"false",
                 "occurOnSaturday":"false"
              },
              "recurrenceMonthly":{
                 "recurrenceFrequency":null,
                 "recurrenceOffset":null,
                 "monthDay":null,
                 "monthWeekDay":null
              }
          }
      },
      "createdDate":"2010-12-08T10:27:44",
      "createdByPerson":{
         "@id":"1999191",
         "@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/1999191"
      },
      "lastUpdatedDate":"2010-12-08T10:32:51",
      "lastUpdatedByPerson":{
         "@id":"1999191",
         "@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/1999191"
      }
   }
}

Method: delete [DELETE]

The delete method will delete a schedule from the event.

Notes ::

  • If delete is called the resource will no longer be available from the API and will return a 410 - Entity is GONE if the resource is ever requested again
  • This method will return a 204 - No Content if a successful deletion occurs
  • Content-type and Format are not used by this action

Parameters ::

  • {id}
    • [GET(Low REST)] https://demo.fellowshiponeapi.com/events/v1/events/{id}/schedules/{id}/Delete
    • [DELETE] https://demo.fellowshiponeapi.com/events/v1/events/{id}/schedules/{id}

Sample Response ::

Given: [DELETE] https://demo.fellowshiponeapi.com/events/v1/events/8296/schedules/2060

Response:

HTTP/1.1 204 The resource https://demo.fellowshiponeapi.com/events/v1/events/26649/schedules/2060 has been deleted.
Cache-Control: private
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Tue, 07 Apr 2009 16:06:52 GMT