Exigo Web Services API v3.4.252

CreateCalendarItem

Creates a new calendar item.

Note: This request can participate in a transaction. Learn more about transactions.

Input Properties

CreateCalendarItemRequest
PropertyData TypeNotes
UserIDInt32
CalendarIDInt32
CalendarItemType CalendarItemType
CalendarItemStatusType CalendarItemStatusType
CalendarItemPriorityType CalendarItemPriorityType
SubjectStringOptional.
LocationStringOptional.
NotesStringOptional.
StartDateDateTime
EndDateDateTime
TimeZoneInt32
Address1StringOptional.
Address2StringOptional.
CityStringOptional.
State StringOptional.
Country StringOptional.
PostalCodeStringOptional.
ContactInfoStringOptional.
ContactPhoneStringOptional.
ContactPhoneType ContactPhoneType
ContactEmailStringOptional.
EventHostStringOptional.
SpecialGuestsStringOptional.
EventFlyerStringOptional.
EventCostInfoStringOptional.
EventConferenceCallOrWebinarStringOptional.
EventRegistrationInfoStringOptional.
EventTagsStringOptional.
IsSharedBoolean

Output Properties

CreateCalendarItemResponse
PropertyData TypeNotes
CalendarIDInt32
CalendarItemIDInt32

SOAP Request

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /3.0/ExigoApi.asmx HTTP/1.1
Host: api.exigo.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://api.exigo.com/CreateCalendarItem"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Header> <ApiAuthentication xmlns="http://api.exigo.com/"> <LoginName>string</LoginName> <Password>string</Password> <Company>string</Company> <Identity>string</Identity> <RequestTimeUtc>dateTime</RequestTimeUtc> <Signature>string</Signature> </ApiAuthentication> </soap:Header> <soap:Body> <CreateCalendarItemRequest xmlns="http://api.exigo.com/"> <UserID>int</UserID> <CalendarID>int</CalendarID> <CalendarItemType>Appointment or ToDo or Anniversary</CalendarItemType> <CalendarItemStatusType>Open or Closed</CalendarItemStatusType> <CalendarItemPriorityType>None or High or Medium or Low</CalendarItemPriorityType> <Subject>string</Subject> <Location>string</Location> <Notes>string</Notes> <StartDate>dateTime</StartDate> <EndDate>dateTime</EndDate> <TimeZone>int</TimeZone> <Address1>string</Address1> <Address2>string</Address2> <City>string</City> <State>string</State> <Country>string</Country> <PostalCode>string</PostalCode> <ContactInfo>string</ContactInfo> <ContactPhone>string</ContactPhone> <ContactPhoneType>Office or Mobile or Home</ContactPhoneType> <ContactEmail>string</ContactEmail> <EventHost>string</EventHost> <SpecialGuests>string</SpecialGuests> <EventFlyer>string</EventFlyer> <EventCostInfo>string</EventCostInfo> <EventConferenceCallOrWebinar>string</EventConferenceCallOrWebinar> <EventRegistrationInfo>string</EventRegistrationInfo> <EventTags>string</EventTags> <IsShared>boolean</IsShared> </CreateCalendarItemRequest> </soap:Body> </soap:Envelope>

SOAP Response

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <CreateCalendarItemResult xmlns="http://api.exigo.com/"> <CalendarID>int</CalendarID> <CalendarItemID>int</CalendarItemID> </CreateCalendarItemResult> </soap:Body> </soap:Envelope>

C#

try

{

    //Create Main API Context Object

    ExigoApi api = new ExigoApi();

 

    //Create Authentication Header

    ApiAuthentication auth = new ApiAuthentication();

    auth.LoginName = "yourLoginName";

    auth.Password = "yourPassword";

    auth.Company = "yourCompany";

    api.ApiAuthenticationValue = auth;

 

    //Create Request

    CreateCalendarItemRequest req = new CreateCalendarItemRequest();

 

    req.UserID = 1;

    req.CalendarID = 1;

    req.CalendarItemType = CalendarItemType.Appointment;

    req.CalendarItemStatusType = CalendarItemStatusType.Open;

    req.CalendarItemPriorityType = CalendarItemPriorityType.None;

    req.Subject = "1";

    req.Location = "1";

    req.Notes = "1";

    req.StartDate = DateTime.Today;

    req.EndDate = DateTime.Today;

    req.TimeZone = 1;

    req.Address1 = "1";

    req.Address2 = "1";

    req.City = "1";

    req.PostalCode = "1";

    req.ContactInfo = "1";

    req.ContactPhone = "1";

    req.ContactPhoneType = ContactPhoneType.Office;

    req.ContactEmail = "1";

    req.EventHost = "1";

    req.SpecialGuests = "1";

    req.EventFlyer = "1";

    req.EventCostInfo = "1";

    req.EventConferenceCallOrWebinar = "1";

    req.EventRegistrationInfo = "1";

    req.EventTags = "1";

    req.IsShared = true;

 

    //Send Request to Server and Get Response

    CreateCalendarItemResponse res = api.CreateCalendarItem(req);

 

    //Now examine the results:

    Console.WriteLine("CalendarID: {0}", res.CalendarID);

    Console.WriteLine("CalendarItemID: {0}", res.CalendarItemID);

}

catch (Exception ex)

{

    Console.WriteLine("Error: " + ex.Message);

}

VB.Net

Try

    'Create Main API Context Object

    Dim api as new ExigoApi()

 

    'Create Authentication Header

    Dim auth as new ApiAuthentication()

    auth.LoginName = "yourLoginName"

    auth.Password = "yourPassword"

    auth.Company = "yourCompany"

    api.ApiAuthenticationValue = auth

 

    'Create Request

    Dim req as new CreateCalendarItemRequest()

 

    req.UserID = 1

    req.CalendarID = 1

    req.CalendarItemType = CalendarItemType.Appointment

    req.CalendarItemStatusType = CalendarItemStatusType.Open

    req.CalendarItemPriorityType = CalendarItemPriorityType.None

    req.Subject = "1"

    req.Location = "1"

    req.Notes = "1"

    req.StartDate = DateTime.Today

    req.EndDate = DateTime.Today

    req.TimeZone = 1

    req.Address1 = "1"

    req.Address2 = "1"

    req.City = "1"

    req.PostalCode = "1"

    req.ContactInfo = "1"

    req.ContactPhone = "1"

    req.ContactPhoneType = ContactPhoneType.Office

    req.ContactEmail = "1"

    req.EventHost = "1"

    req.SpecialGuests = "1"

    req.EventFlyer = "1"

    req.EventCostInfo = "1"

    req.EventConferenceCallOrWebinar = "1"

    req.EventRegistrationInfo = "1"

    req.EventTags = "1"

    req.IsShared = true

 

    'Send Request to Server and Get Response

    Dim res As CreateCalendarItemResponse = api.CreateCalendarItem(req)

 

    'Now examine the results:

    Console.WriteLine("CalendarID: {0}", res.CalendarID)

    Console.WriteLine("CalendarItemID: {0}", res.CalendarItemID)

Catch ex As Exception

    Console.WriteLine("Error: " & ex.Message)

End Try

PHP

Note: PHP is not officially supported.

<?php

try

{

    //Setup the SoapClient and Authentication

    $api = new SoapClient("http://api.exigo.com/3.0/ExigoApi.asmx?WSDL");

    $ns = "http://api.exigo.com/";

    $auth = array()

    $auth["LoginName"] = new SoapVar("yourLoginName",XSD_STRING,null,null,null,$ns);

    $auth["Password"] = new SoapVar("yourPassword",XSD_STRING,null,null,null,$ns);

    $auth["Company"] = new SoapVar("yourCompany",XSD_STRING,null,null,null,$ns);

    $headerBody = new SoapVar($auth, SOAP_ENC_OBJECT);

    $header = new SoapHeader($ns, 'ApiAuthentication', $headerBody);

    $api->__setSoapHeaders(array($header));

 

    //Create Request

 

    $req->UserID = 1;

    $req->CalendarID = 1;

    $req->CalendarItemType = 1;

    $req->CalendarItemStatusType = 1;

    $req->CalendarItemPriorityType = 1;

    $req->Subject = "1";

    $req->Location = "1";

    $req->Notes = "1";

    $req->StartDate = 1;

    $req->EndDate = 1;

    $req->TimeZone = 1;

    $req->Address1 = "1";

    $req->Address2 = "1";

    $req->City = "1";

    $req->PostalCode = "1";

    $req->ContactInfo = "1";

    $req->ContactPhone = "1";

    $req->ContactPhoneType = 1;

    $req->ContactEmail = "1";

    $req->EventHost = "1";

    $req->SpecialGuests = "1";

    $req->EventFlyer = "1";

    $req->EventCostInfo = "1";

    $req->EventConferenceCallOrWebinar = "1";

    $req->EventRegistrationInfo = "1";

    $req->EventTags = "1";

    $req->IsShared = 1;

 

    //Send Request to Server and Get Response

    $res = $api.CreateCalendarItem($req);

 

    //Now examine the results:

}

catch (SoapFault $ex)

{

    echo "Error: ", $ex->getMessage();

}

?>

Java

Note: Java is not officially supported.

try

{

    //Create Main API Context Object

    ExigoApi api = new ExigoApi();

 

    //Create Authentication Header

    ApiAuthentication auth = new ApiAuthentication();

    auth.setLoginName("yourLoginName");

    auth.setPassword("yourPassword");

    auth.setCompany("yourCompany");

    api.setApiAuthenticationValue(auth);

 

    //Create Request

    CreateCalendarItemRequest req = new CreateCalendarItemRequest();

 

    req.setUserID(1);

    req.setCalendarID(1);

    req.setCalendarItemType(1);

    req.setCalendarItemStatusType(1);

    req.setCalendarItemPriorityType(1);

    req.setSubject("1");

    req.setLocation("1");

    req.setNotes("1");

    req.setStartDate(1);

    req.setEndDate(1);

    req.setTimeZone(1);

    req.setAddress1("1");

    req.setAddress2("1");

    req.setCity("1");

    req.setPostalCode("1");

    req.setContactInfo("1");

    req.setContactPhone("1");

    req.setContactPhoneType(1);

    req.setContactEmail("1");

    req.setEventHost("1");

    req.setSpecialGuests("1");

    req.setEventFlyer("1");

    req.setEventCostInfo("1");

    req.setEventConferenceCallOrWebinar("1");

    req.setEventRegistrationInfo("1");

    req.setEventTags("1");

    req.setIsShared(1);

 

    //Send Request to Server and Get Response

    CreateCalendarItemResponse res = api.getExigoApiSoap().createCalendarItem(req, auth);

 

    //Now examine the results:

}

catch (Exception ex)

{

    System.out.println("Error: " + ex.getMessage());

}

CSV

This method does not support csv output.