getActivityEvent: Get a specific ActivityEvent

In samterfa/SkywardSDK: Creates R Functions for Skyward Generic API Functions

Description

This function returns fields for an ActivityEvent.

Usage

getActivityEvent(
  ActivityEventID,
  EntityID = 1,
  returnActivityEventID = F,
  returnActivityID = F,
  returnCodeSummary = F,
  returnContactType = F,
  returnContactTypeCode = F,
  returnCost = F,
  returnCreatedTime = F,
  returnDate = F,
  returnDescription = F,
  returnDisplayOnDistrictCalendar = F,
  returnEndTime = F,
  returnEventTypeID = F,
  returnLocationID = F,
  returnModifiedTime = F,
  returnNameIDContact = F,
  returnStartTime = F,
  returnStatus = F,
  returnStatusCode = F,
  returnSummary = F,
  returnUserIDCreatedBy = F,
  returnUserIDModifiedBy = F,
  returnVisibleTo = F,
  returnVisibleToCode = F
)

Arguments

ActivityEventID	The id of the ActivityEvent. Run getAllActivityEvents for a list of ActivityEvents.
EntityID	The id of the entity. Run getAllEntities for a list of entities.
returnFieldName	A TRUE or FALSE value determining whether or not to return FieldName for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.

Value

Details for the ActivityEvent.

References

{yourApiUrl}/swagger

Skyward's Knowledge Hub

samterfa/SkywardSDK documentation built on Oct. 13, 2020, 6:53 a.m.