Events API

Common objects - Event object

OVERVIEW

Parameter Type Description

eventtitle

String

For add event, the title is mandatory

 Title of the event

categoryid

Integer

For add event, the category is mandatory

 ID of the site in which the event is going to be added

startdate

String

For add event, the start date is mandatory

 Start date of the event from when it is taking place

starttime

 String

Start time of the event 

enddate

String

For add event, the end date is mandatory

End date of the event from when the event ends

endtime

 String

End time of the event 

contactname

 String

Contact details can be added. Able to enter either name or email

Users from the site which is used in the siteid object can be added.

showcomment

 Integer Whether to allow commenting on the event or not. 

eventcontent

 String A field used to send a description of an event

tagname

 String

Object for tags which consists of a list of tags.
location String To send location details for an event
status Integer To add the event as a draft or published

id

ID of collaborate document and/or external document

 Integer To upload an attachment in the event. The attachment can be internal and/or external.
contactid Integer Pass the ID of the site user

Note : dd MMM yyyy  date format will be allowed as shown in the request XML object below.

 

<event>
        <eventtitle>bbbb</eventTitle>

        <eventcontent></eventContent>
        <categories>
              <category>
                   <categoryid>11</categoryid>
              </category>
         </categories>
        <startate>27 Aug 2018</startDate>
        <starttime>00:00:00</startTime>
        <enddate>29 Aug 2018</endDate>
        <endtime>00:00:00</endTime>
        <showcomment>1</showComment>
        <eventcontent>Description</eventContent>
        <tags>
              <tag>
                    <tagname></tagname>
              </tag>
        </tags>

        <location></location>

        <attachments>

               <attachment>

                      <fileid>{pass id of collaborate file and/or external file}</fileid>

              </attachment>

               <attachment>

                      <fileid>{pass id of collaborate file and/or external file}</fileid>

              </attachment>

        </attachments>

       <contacts>

              <contact>

                     <contactname></contactname>

                     <contactid></contactid>

              <contact>

              <contact>

                     <contactname></contactname>

                     <contactid></contactid>

              <contact>

       </contacts>

       <status>{status of the event draft or publish}</status>

</event>

Comments


0 Comments

Last Updated: Jun 09,2023