POST api/users/{userId}/calendar/events

This method will add a new calendar event to user's calendar

Request Information

URI Parameters

Name	Description	Type	Additional information
userId	Owner's user id	integer	Required

Body Parameters

Content of the new calendar event

CalendarEventBindingModel

Name	Type	Additional information
Title	string	None.
Location	string	None.
CountyId	integer	None.
TownshipId	integer	None.
AgencyId	integer	None.
EmployeeIds	Collection of integer	None.
StartDate	string	None.
EndDate	string	None.
StartTime	string	None.
EndTime	string	None.
isReoccuring	boolean	None.
Interval	string	None.
IsPrivate	boolean	None.
IsSystemWide	boolean	None.
CalendarEventTypeId	integer	None.
Notes	string	None.

Request Formats

application/json, text/json

Sample:

{
  "title": "sample string 1",
  "location": "sample string 2",
  "countyId": 1,
  "townshipId": 1,
  "agencyId": 1,
  "employeeIds": [
    1,
    2
  ],
  "startDate": "sample string 3",
  "endDate": "sample string 4",
  "startTime": "sample string 5",
  "endTime": "sample string 6",
  "isReoccuring": true,
  "interval": "sample string 8",
  "isPrivate": true,
  "isSystemWide": true,
  "calendarEventTypeId": 11,
  "notes": "sample string 12"
}

text/html

Sample:

{"title":"sample string 1","location":"sample string 2","countyId":1,"townshipId":1,"agencyId":1,"employeeIds":[1,2],"startDate":"sample string 3","endDate":"sample string 4","startTime":"sample string 5","endTime":"sample string 6","isReoccuring":true,"interval":"sample string 8","isPrivate":true,"isSystemWide":true,"calendarEventTypeId":11,"notes":"sample string 12"}

application/xml, text/xml

Sample:

<CalendarEventBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ptd.Model.WebModels.CalendarBinding">
  <AgencyId>1</AgencyId>
  <CalendarEventTypeId>11</CalendarEventTypeId>
  <CountyId>1</CountyId>
  <EmployeeIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </EmployeeIds>
  <EndDate>sample string 4</EndDate>
  <EndTime>sample string 6</EndTime>
  <Interval>sample string 8</Interval>
  <IsPrivate>true</IsPrivate>
  <IsSystemWide>true</IsSystemWide>
  <Location>sample string 2</Location>
  <Notes>sample string 12</Notes>
  <StartDate>sample string 3</StartDate>
  <StartTime>sample string 5</StartTime>
  <Title>sample string 1</Title>
  <TownshipId>1</TownshipId>
  <isReoccuring>true</isReoccuring>
</CalendarEventBindingModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'CalendarEventBindingModel'.

Response Information

Resource Description

Instance of

CalendarEventResponseModel

Name	Type	Additional information
Title	string	None.
StartDate	string	None.
EndDate	string	None.
StartTime	string	None.
EndTime	string	None.
CountyId	integer	None.
TownshipId	integer	None.
Notes	string	None.
IsPrivate	boolean	None.
IsSystemWide	boolean	None.
IsReoccuring	boolean	None.
EmployeeIds	Collection of integer	None.
AddedDate	date	None.
AgencyId	integer	None.
CalendarEventColor	string	None.
Interval	string	None.
Id	integer	None.
Location	string	None.
CountyName	string	None.
TownshipName	string	None.
AgencyName	string	None.
CalendarEventType	string	None.
UserId	integer	None.
CalendarEventTypeId	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "title": "sample string 1",
  "startDate": "sample string 2",
  "endDate": "sample string 3",
  "startTime": "sample string 4",
  "endTime": "sample string 5",
  "countyId": 1,
  "townshipId": 6,
  "notes": "sample string 7",
  "isPrivate": true,
  "isSystemWide": true,
  "isReoccuring": true,
  "employeeIds": [
    1,
    2
  ],
  "addedDate": "2025-05-20T14:33:55.7278125-05:00",
  "agencyId": 12,
  "calendarEventColor": "sample string 13",
  "interval": "sample string 14",
  "id": 15,
  "location": "sample string 16",
  "countyName": "sample string 17",
  "townshipName": "sample string 18",
  "agencyName": "sample string 19",
  "calendarEventType": "sample string 20",
  "userId": 21,
  "calendarEventTypeId": 22
}

text/html

Sample:

{"title":"sample string 1","startDate":"sample string 2","endDate":"sample string 3","startTime":"sample string 4","endTime":"sample string 5","countyId":1,"townshipId":6,"notes":"sample string 7","isPrivate":true,"isSystemWide":true,"isReoccuring":true,"employeeIds":[1,2],"addedDate":"2025-05-20T14:33:55.7278125-05:00","agencyId":12,"calendarEventColor":"sample string 13","interval":"sample string 14","id":15,"location":"sample string 16","countyName":"sample string 17","townshipName":"sample string 18","agencyName":"sample string 19","calendarEventType":"sample string 20","userId":21,"calendarEventTypeId":22}

application/xml, text/xml

Sample:

<CalendarEventResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ptd.Model.WebModels.CalendarBinding">
  <AddedDate>2025-05-20T14:33:55.7278125-05:00</AddedDate>
  <AgencyId>12</AgencyId>
  <AgencyName>sample string 19</AgencyName>
  <CalendarEventColor>sample string 13</CalendarEventColor>
  <CalendarEventType>sample string 20</CalendarEventType>
  <CalendarEventTypeId>22</CalendarEventTypeId>
  <CountyId>1</CountyId>
  <CountyName>sample string 17</CountyName>
  <EmployeeIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </EmployeeIds>
  <EndDate>sample string 3</EndDate>
  <EndTime>sample string 5</EndTime>
  <Id>15</Id>
  <Interval>sample string 14</Interval>
  <IsPrivate>true</IsPrivate>
  <IsReoccuring>true</IsReoccuring>
  <IsSystemWide>true</IsSystemWide>
  <Location>sample string 16</Location>
  <Notes>sample string 7</Notes>
  <StartDate>sample string 2</StartDate>
  <StartTime>sample string 4</StartTime>
  <Title>sample string 1</Title>
  <TownshipId>6</TownshipId>
  <TownshipName>sample string 18</TownshipName>
  <UserId>21</UserId>
</CalendarEventResponseModel>