POST api/calendar?DocId={DocId}&SerialNumber={SerialNumber}&applicationID={applicationID}

CREATE event through expedient

Request Information

URI Parameters

Name	Type	Additional information
DocId	integer	Required
SerialNumber	string	Required
applicationID	integer	Required

Body Parameters

Event

Name	Description	Type	Additional information
HasAttachments	HasAttachments	boolean	None.
EventComunicationId	EventId	integer	None.
EventId	EventId	string	None.
Subject	Subject	string	None.
Body	Body	EventBody	None.
Location	Location	string	None.
CalendarId	CalendarId	string	None.
CalendarName	CalendarName	string	None.
StartDate	StartDate	string	None.
EndDate	EndDate	string	None.
EventType	EventType	string	None.
Attendees	Attendees	Collection of EventPerson	None.
IsMeeting	IsMeeting	boolean	None.
IsRecurring	IsRecurring	boolean	None.
IsAllDayEvent	IsAllDayEvent	boolean	None.
AppointmentState	AppointmentState	integer	None.
TimeZone	TimeZone	string	None.
Organizer	Organizer	EventPerson	None.
InstanceId	SerialNumber	string	None.
Category	Categories	string	None.
EventRecurrence	Event Recurrence	EventRecurrence	None.
Attachments		Collection of Attachment	None.
IsPrivate		boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "HasAttachments": true,
  "EventComunicationId": 2,
  "EventId": "sample string 3",
  "Subject": "sample string 4",
  "Body": {
    "BodyType": 1,
    "Text": "sample string 2"
  },
  "Location": "sample string 5",
  "CalendarId": "sample string 6",
  "CalendarName": "sample string 7",
  "StartDate": "sample string 8",
  "EndDate": "sample string 9",
  "EventType": "sample string 10",
  "Attendees": [
    {
      "Id": 1,
      "EmailAddress": "sample string 2",
      "Name": "sample string 3",
      "IsRequired": true,
      "UserType": "sample string 5",
      "IsPR": true,
      "Entity": "sample string 7",
      "Acknowledgment": true
    },
    {
      "Id": 1,
      "EmailAddress": "sample string 2",
      "Name": "sample string 3",
      "IsRequired": true,
      "UserType": "sample string 5",
      "IsPR": true,
      "Entity": "sample string 7",
      "Acknowledgment": true
    }
  ],
  "IsMeeting": true,
  "IsRecurring": true,
  "IsAllDayEvent": true,
  "AppointmentState": 14,
  "TimeZone": "sample string 15",
  "Organizer": {
    "Id": 1,
    "EmailAddress": "sample string 2",
    "Name": "sample string 3",
    "IsRequired": true,
    "UserType": "sample string 5",
    "IsPR": true,
    "Entity": "sample string 7",
    "Acknowledgment": true
  },
  "InstanceId": "sample string 16",
  "Category": "sample string 17",
  "EventRecurrence": {
    "Type": 0,
    "Day": 1,
    "DayOfWeek": 0,
    "Month": 1,
    "LastOccurrence": "2024-10-18T05:20:05.7825663+01:00"
  },
  "Attachments": [
    {
      "Id": 1,
      "ParentId": "sample string 2",
      "Source": 0,
      "SourceId": "sample string 3",
      "Description": "sample string 4",
      "SourceName": "sample string 5",
      "CreateDate": "sample string 6",
      "Stakeholders": "sample string 7",
      "Link": "sample string 8",
      "Data": {},
      "ApplicationId": 1,
      "FileSize": 10
    },
    {
      "Id": 1,
      "ParentId": "sample string 2",
      "Source": 0,
      "SourceId": "sample string 3",
      "Description": "sample string 4",
      "SourceName": "sample string 5",
      "CreateDate": "sample string 6",
      "Stakeholders": "sample string 7",
      "Link": "sample string 8",
      "Data": {},
      "ApplicationId": 1,
      "FileSize": 10
    }
  ],
  "IsPrivate": true
}

application/xml, text/xml

Sample:

<CalendarModel.Event xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GabineteDigital.Services.Models">
  <AppointmentState>14</AppointmentState>
  <Attachments>
    <AttachmentsModel.Attachment>
      <ApplicationId>1</ApplicationId>
      <CreateDate>sample string 6</CreateDate>
      <Data />
      <Description>sample string 4</Description>
      <FileSize>10</FileSize>
      <Id>1</Id>
      <Link>sample string 8</Link>
      <ParentId>sample string 2</ParentId>
      <Source>Undefined</Source>
      <SourceId>sample string 3</SourceId>
      <SourceName>sample string 5</SourceName>
      <Stakeholders>sample string 7</Stakeholders>
    </AttachmentsModel.Attachment>
    <AttachmentsModel.Attachment>
      <ApplicationId>1</ApplicationId>
      <CreateDate>sample string 6</CreateDate>
      <Data />
      <Description>sample string 4</Description>
      <FileSize>10</FileSize>
      <Id>1</Id>
      <Link>sample string 8</Link>
      <ParentId>sample string 2</ParentId>
      <Source>Undefined</Source>
      <SourceId>sample string 3</SourceId>
      <SourceName>sample string 5</SourceName>
      <Stakeholders>sample string 7</Stakeholders>
    </AttachmentsModel.Attachment>
  </Attachments>
  <Attendees>
    <CalendarModel.EventPerson>
      <Acknowledgment>true</Acknowledgment>
      <EmailAddress>sample string 2</EmailAddress>
      <Entity>sample string 7</Entity>
      <Id>1</Id>
      <IsPR>true</IsPR>
      <IsRequired>true</IsRequired>
      <Name>sample string 3</Name>
      <UserType>sample string 5</UserType>
    </CalendarModel.EventPerson>
    <CalendarModel.EventPerson>
      <Acknowledgment>true</Acknowledgment>
      <EmailAddress>sample string 2</EmailAddress>
      <Entity>sample string 7</Entity>
      <Id>1</Id>
      <IsPR>true</IsPR>
      <IsRequired>true</IsRequired>
      <Name>sample string 3</Name>
      <UserType>sample string 5</UserType>
    </CalendarModel.EventPerson>
  </Attendees>
  <Body>
    <BodyType>1</BodyType>
    <Text>sample string 2</Text>
  </Body>
  <CalendarId>sample string 6</CalendarId>
  <CalendarName>sample string 7</CalendarName>
  <Category>sample string 17</Category>
  <EndDate>sample string 9</EndDate>
  <EventComunicationId>2</EventComunicationId>
  <EventId>sample string 3</EventId>
  <EventRecurrence>
    <Day>1</Day>
    <DayOfWeek>Sunday</DayOfWeek>
    <LastOccurrence>2024-10-18T05:20:05.7825663+01:00</LastOccurrence>
    <Month>1</Month>
    <Type>Daily</Type>
  </EventRecurrence>
  <EventType>sample string 10</EventType>
  <HasAttachments>true</HasAttachments>
  <InstanceId>sample string 16</InstanceId>
  <IsAllDayEvent>true</IsAllDayEvent>
  <IsMeeting>true</IsMeeting>
  <IsPrivate>true</IsPrivate>
  <IsRecurring>true</IsRecurring>
  <Location>sample string 5</Location>
  <Organizer>
    <Acknowledgment>true</Acknowledgment>
    <EmailAddress>sample string 2</EmailAddress>
    <Entity>sample string 7</Entity>
    <Id>1</Id>
    <IsPR>true</IsPR>
    <IsRequired>true</IsRequired>
    <Name>sample string 3</Name>
    <UserType>sample string 5</UserType>
  </Organizer>
  <StartDate>sample string 8</StartDate>
  <Subject>sample string 4</Subject>
  <TimeZone>sample string 15</TimeZone>
</CalendarModel.Event>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

string

Response Formats

application/json, text/json

Sample:

"sample string 1"

application/xml, text/xml

Sample:

<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>