POST v2/apps/{appId}/calendarevent/{tenantId}
Create a new Event or Reminder for the Tenant
Request Information
URI Parameters
| Name | Type | Description | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| appId | integer |
Application Id
Additional Info :
Required |
|||||||||||
| tenantId | integer |
Tenant Id
Additional Info :
Required |
|||||||||||
Body Parameters
Calendar Event Request
CalendarEventRequest| Name | Type | Description | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| CalendarId | integer |
Calendar id that this event/reminder will be saved.
Additional Info :
Required |
|||||||||||
| PosterId | integer |
App that is trying to post this new record.
Additional Info :
Required |
|||||||||||
| PosterType | PosterTypeEnum |
Poster Id Type
Additional Info :
Required |
|||||||||||
| PostScope | PostScopeEnum |
Scope of the event/reminder
Additional Info :
Required |
|||||||||||
| Title | string |
Title
Additional Info :
Required |
|||||||||||
| Message | string |
Custom Message that will be displayed on the event (Optional) |
|||||||||||
| Url | string |
Url (Optional) |
|||||||||||
| StartDate | date |
Start Date of the Event UTC |
|||||||||||
| EndDate | date |
End Date of the Event UTC |
|||||||||||
| DueDate | date |
Due Date of the Reminder UTC |
|||||||||||
| Alarm | date |
Alarm of the Reminder UTC |
|||||||||||
Request Formats
{
"calendarId": 1,
"posterId": 2,
"posterType": 1,
"postScope": 1,
"title": "sample string 3",
"message": "sample string 4",
"url": "sample string 5",
"startDate": "2024-12-30T17:10:03.5056352Z",
"endDate": "2024-12-30T17:10:03.5056352Z",
"dueDate": "2024-12-30T17:10:03.5056352Z",
"alarm": "2024-12-30T17:10:03.5056352Z"
}
<CalendarEventRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AppNotch.Converter.Api.Server.Models"> <Alarm>2024-12-30T17:10:03.5056352+00:00</Alarm> <CalendarId>1</CalendarId> <DueDate>2024-12-30T17:10:03.5056352+00:00</DueDate> <EndDate>2024-12-30T17:10:03.5056352+00:00</EndDate> <Message>sample string 4</Message> <PostScope>Private</PostScope> <PosterId>2</PosterId> <PosterType>Owner</PosterType> <StartDate>2024-12-30T17:10:03.5056352+00:00</StartDate> <Title>sample string 3</Title> <Url>sample string 5</Url> </CalendarEventRequest>
Response Information
Resource Description
Newly created Calendar Event
Collection of CalendarEventResponse| Name | Type | Description | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Id | integer |
Calendar Event Id |
|||||||||||
| AppId | integer |
App Id |
|||||||||||
| AppType | integer |
AppType [Master or Tenant] |
|||||||||||
| PosterId | integer |
Id that posted the event/reminder |
|||||||||||
| PosterType | integer |
Type of Poster Id (1: Owner) (2:Member) |
|||||||||||
| PostScope | integer |
Post Visibility (1: Private) (2:Public) |
|||||||||||
| Type | integer |
Type [Event or Reminder] |
|||||||||||
| Title | string |
Title |
|||||||||||
| Message | string |
Custom Message that will be displayed on the event (Optional) |
|||||||||||
| Url | string |
Url (Optional) |
|||||||||||
| StartDate | date |
Start Date of the Event |
|||||||||||
| EndDate | date |
End Date of the Event |
|||||||||||
| Alarm | date |
Alarm of the Reminder |
|||||||||||
| DueDate | date |
Due Date of the Reminder |
|||||||||||
| CreateDate | date |
Create date of the record. |
|||||||||||
Response Formats
[
{
"id": 1,
"appId": 2,
"appType": 3,
"posterId": 4,
"posterType": 5,
"postScope": 6,
"type": 7,
"title": "sample string 8",
"message": "sample string 9",
"url": "sample string 10",
"startDate": "2024-12-30T17:10:03.6189058Z",
"endDate": "2024-12-30T17:10:03.6189058Z",
"alarm": "2024-12-30T17:10:03.6189058Z",
"dueDate": "2024-12-30T17:10:03.6189058Z",
"createDate": "2024-12-30T17:10:03.6189058Z"
},
{
"id": 1,
"appId": 2,
"appType": 3,
"posterId": 4,
"posterType": 5,
"postScope": 6,
"type": 7,
"title": "sample string 8",
"message": "sample string 9",
"url": "sample string 10",
"startDate": "2024-12-30T17:10:03.6189058Z",
"endDate": "2024-12-30T17:10:03.6189058Z",
"alarm": "2024-12-30T17:10:03.6189058Z",
"dueDate": "2024-12-30T17:10:03.6189058Z",
"createDate": "2024-12-30T17:10:03.6189058Z"
}
]
<ArrayOfCalendarEventResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AppNotch.Converter.Api.Server.Models">
<CalendarEventResponse>
<Alarm>2024-12-30T17:10:03.6189058+00:00</Alarm>
<AppId>2</AppId>
<AppType>3</AppType>
<CreateDate>2024-12-30T17:10:03.6189058+00:00</CreateDate>
<DueDate>2024-12-30T17:10:03.6189058+00:00</DueDate>
<EndDate>2024-12-30T17:10:03.6189058+00:00</EndDate>
<Message>sample string 9</Message>
<PostScope>6</PostScope>
<PosterId>4</PosterId>
<PosterType>5</PosterType>
<StartDate>2024-12-30T17:10:03.6189058+00:00</StartDate>
<Title>sample string 8</Title>
<Type>7</Type>
<Url>sample string 10</Url>
</CalendarEventResponse>
<CalendarEventResponse>
<Alarm>2024-12-30T17:10:03.6189058+00:00</Alarm>
<AppId>2</AppId>
<AppType>3</AppType>
<CreateDate>2024-12-30T17:10:03.6189058+00:00</CreateDate>
<DueDate>2024-12-30T17:10:03.6189058+00:00</DueDate>
<EndDate>2024-12-30T17:10:03.6189058+00:00</EndDate>
<Message>sample string 9</Message>
<PostScope>6</PostScope>
<PosterId>4</PosterId>
<PosterType>5</PosterType>
<StartDate>2024-12-30T17:10:03.6189058+00:00</StartDate>
<Title>sample string 8</Title>
<Type>7</Type>
<Url>sample string 10</Url>
</CalendarEventResponse>
</ArrayOfCalendarEventResponse>