GET api/Calendar/GetReadOnlyEvents?authId={authId}&includeArchivedEvents={includeArchivedEvents}

Request Information

URI Parameters

Name	Description	Type	Additional information
authId		globally unique identifier	Required
includeArchivedEvents		boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

ReadOnlyCalEventModel

Name	Type	Additional information
CalendarEvents	Collection of CalEventModel	None.
Status	boolean	None.
Message	string	None.

Response Formats

application/json, text/json

Sample:

{
  "CalendarEvents": [
    {
      "start": "sample string 1",
      "end": "sample string 2",
      "title": "sample string 3",
      "color": "sample string 4",
      "textColor": "sample string 5",
      "lessonPlanId": 6,
      "mapId": 7,
      "instrDay": true,
      "notes": "sample string 9",
      "standards": [
        "sample string 1",
        "sample string 2"
      ],
      "userEvent": true,
      "allDay": true,
      "eventId": 12,
      "editable": true,
      "publicEvent": true,
      "mapDataId": 1,
      "mapLessonStartDay": 1,
      "instructionalStartDay": 1,
      "bindToCalendar": true,
      "eventColorCode": "sample string 16",
      "IsReOccuring": true,
      "ReOccuranceType": 18,
      "ReOccuranceEndDate": "sample string 19",
      "ParentEventId": 20,
      "UpdateAll": true,
      "UserId": "1ef8ba77-7cd8-43e0-96b5-4e593bb43f7e",
      "isDeleted": true
    },
    {
      "start": "sample string 1",
      "end": "sample string 2",
      "title": "sample string 3",
      "color": "sample string 4",
      "textColor": "sample string 5",
      "lessonPlanId": 6,
      "mapId": 7,
      "instrDay": true,
      "notes": "sample string 9",
      "standards": [
        "sample string 1",
        "sample string 2"
      ],
      "userEvent": true,
      "allDay": true,
      "eventId": 12,
      "editable": true,
      "publicEvent": true,
      "mapDataId": 1,
      "mapLessonStartDay": 1,
      "instructionalStartDay": 1,
      "bindToCalendar": true,
      "eventColorCode": "sample string 16",
      "IsReOccuring": true,
      "ReOccuranceType": 18,
      "ReOccuranceEndDate": "sample string 19",
      "ParentEventId": 20,
      "UpdateAll": true,
      "UserId": "1ef8ba77-7cd8-43e0-96b5-4e593bb43f7e",
      "isDeleted": true
    }
  ],
  "Status": true,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:

<ReadOnlyCalEventModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CurriculumCrafter.Domain.Models">
  <CalendarEvents>
    <CalEventModel>
      <IsReOccuring>true</IsReOccuring>
      <ParentEventId>20</ParentEventId>
      <ReOccuranceEndDate>sample string 19</ReOccuranceEndDate>
      <ReOccuranceType>18</ReOccuranceType>
      <UpdateAll>true</UpdateAll>
      <UserId>1ef8ba77-7cd8-43e0-96b5-4e593bb43f7e</UserId>
      <allDay>true</allDay>
      <bindToCalendar>true</bindToCalendar>
      <color>sample string 4</color>
      <editable>true</editable>
      <end>sample string 2</end>
      <eventColorCode>sample string 16</eventColorCode>
      <eventId>12</eventId>
      <instrDay>true</instrDay>
      <instructionalStartDay>1</instructionalStartDay>
      <isDeleted>true</isDeleted>
      <lessonPlanId>6</lessonPlanId>
      <mapDataId>1</mapDataId>
      <mapId>7</mapId>
      <mapLessonStartDay>1</mapLessonStartDay>
      <notes>sample string 9</notes>
      <publicEvent>true</publicEvent>
      <standards xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </standards>
      <start>sample string 1</start>
      <textColor>sample string 5</textColor>
      <title>sample string 3</title>
      <userEvent>true</userEvent>
    </CalEventModel>
    <CalEventModel>
      <IsReOccuring>true</IsReOccuring>
      <ParentEventId>20</ParentEventId>
      <ReOccuranceEndDate>sample string 19</ReOccuranceEndDate>
      <ReOccuranceType>18</ReOccuranceType>
      <UpdateAll>true</UpdateAll>
      <UserId>1ef8ba77-7cd8-43e0-96b5-4e593bb43f7e</UserId>
      <allDay>true</allDay>
      <bindToCalendar>true</bindToCalendar>
      <color>sample string 4</color>
      <editable>true</editable>
      <end>sample string 2</end>
      <eventColorCode>sample string 16</eventColorCode>
      <eventId>12</eventId>
      <instrDay>true</instrDay>
      <instructionalStartDay>1</instructionalStartDay>
      <isDeleted>true</isDeleted>
      <lessonPlanId>6</lessonPlanId>
      <mapDataId>1</mapDataId>
      <mapId>7</mapId>
      <mapLessonStartDay>1</mapLessonStartDay>
      <notes>sample string 9</notes>
      <publicEvent>true</publicEvent>
      <standards xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </standards>
      <start>sample string 1</start>
      <textColor>sample string 5</textColor>
      <title>sample string 3</title>
      <userEvent>true</userEvent>
    </CalEventModel>
  </CalendarEvents>
  <Message>sample string 2</Message>
  <Status>true</Status>
</ReadOnlyCalEventModel>