GET api/Calendar/GetEvents?userId={userId}&districtId={districtId}&mapId={mapId}&includeArchivedEvents={includeArchivedEvents}

Request Information

URI Parameters

Name	Type	Additional information
userId	globally unique identifier	Required
districtId	integer	Required
mapId	integer	Default value is 0
includeArchivedEvents	boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

Collection of CalEventModel

Name	Type	Additional information
start	string	None.
end	string	None.
title	string	None.
color	string	None.
textColor	string	None.
lessonPlanId	integer	None.
mapId	integer	None.
instrDay	boolean	None.
notes	string	None.
standards	Collection of string	None.
userEvent	boolean	None.
allDay	boolean	None.
eventId	integer	None.
editable	boolean	None.
publicEvent	boolean	None.
mapDataId	integer	None.
mapLessonStartDay	integer	None.
instructionalStartDay	integer	None.
bindToCalendar	boolean	None.
eventColorCode	string	None.
IsReOccuring	boolean	None.
ReOccuranceType	integer	None.
ReOccuranceEndDate	string	None.
ParentEventId	integer	None.
UpdateAll	boolean	None.
UserId	globally unique identifier	None.
isDeleted	boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "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": "1a703519-6aaa-438b-851e-9739428eea15",
    "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": "1a703519-6aaa-438b-851e-9739428eea15",
    "isDeleted": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfCalEventModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CurriculumCrafter.Domain.Models">
  <CalEventModel>
    <IsReOccuring>true</IsReOccuring>
    <ParentEventId>20</ParentEventId>
    <ReOccuranceEndDate>sample string 19</ReOccuranceEndDate>
    <ReOccuranceType>18</ReOccuranceType>
    <UpdateAll>true</UpdateAll>
    <UserId>1a703519-6aaa-438b-851e-9739428eea15</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:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1: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>1a703519-6aaa-438b-851e-9739428eea15</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:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </standards>
    <start>sample string 1</start>
    <textColor>sample string 5</textColor>
    <title>sample string 3</title>
    <userEvent>true</userEvent>
  </CalEventModel>
</ArrayOfCalEventModel>