Jump to: navigation, search

Event methods

createEvents(Event[] events, Org org)

Creates new events associated with the Org.

Input

  • events : externalId, description and requiredOptInLevel are required. At least one channel is required.
  • org: internalId or (externalId, parent, type)

Response

Event[] (D)

Availability

Insight 1.5

Errors returned

  • ARG_INVALID_TYPE – Argument is of invalid type '%s'
  • ARG_NULL – Argument supplied is null
  • ARG_TOO_LARGE – Invalid Data, argument '%s' exceeds allowed size
  • ATTRIBUTE_NULL – Attribute supplied is null
  • ATTRIBUTE_INVALID – Attribute is not valid
  • OBJECT_EXISTS – Object '%s' already exists1
  • OBJECT_NOT_EXISTS – Referenced object '%s' does not exist

Notes

  • The maximum number of items that may be supplied using this method is 100.
  • Org must be of type Account.

deleteEvents(Event[] events)

Deletes supplied Events.

Input

events : internalId (or externalId and owner) for Events to be deleted

Response

NONE

Availability

Insight 1.5

Errors returned

  • ARG_NULL – Argument supplied is null
  • ARG_TOO_LARGE – Invalid Data, argument '%s' exceeds allowed size
  • OBJECT_NOT_EXISTS – Referenced object '%s' does not exist

Notes

  • Deletion is always a soft delete.
  • The maximum number of items that may be supplied using this method is 100.
  • All events supplied must belong to the Account.

changeEvent(Event event)

Changes an existing Event.

Input

event: internalId (or externalId and owner) + any fields to be changed

Response

Event (D): updated Event

Availability

Insight 1.5

Errors returned

  • ARG_INVALID – Argument is invalid – reason '%s'
  • ARG_INVALID_TYPE – Argument is of invalid type '%s'
  • ARG_NULL – Invalid Data, argument '%s' must be non-null
  • ATTRIBUTE_NULL – Attribute supplied is null
  • ATTRIBUTE_INVALID – Attribute is not valid
  • OBJECT_NOT_EXISTS – Referenced object '%s' does not exist

Notes

externalId and owner cannot be changed.

showEvent(Event event)

Retrieves information about the supplied Event

Input

event : internalId (or externalId and owner)

Response

Event (D)

Availability

Insight 1.5

Errors returned

  • ARG_INVALID – Argument is invalid – reason '%s'
  • ARG_NULL – Invalid Data, argument '%s' must be non-null
  • ATTRIBUTE_NULL – Attribute supplied is null
  • OBJECT_NOT_EXISTS – Referenced object '%s' does not exist

Notes

externalId and owner cannot be changed.

listEvents(Org org, Event sample)

Lists all the Events in the supplied organization that match the sample Event.

Input

  • org: internalId or (externalId, parent, type)
  • sample: optional event object to narrow the returned set.


Response

Event[] (D)

Availability

Insight 1.5

Errors returned

  • ARG_INVALID – Argument is invalid – reason '%s'
  • ARG_INVALID_TYPE – Argument is of invalid type '%s'
  • ARG_NULL – Invalid Data, argument '%s' must be non-null
  • OBJECT_NOT_EXISTS – Referenced object '%s' does not exist
  • RESULT_TOO_LARGE – Result returned would be too large

Notes

  • If the sample is non-null, all attributes must match. If the sample is null all Events will match.
  • The maximum number of items returned using this method is 100.

createSubscriptions(Subscriptions[] subscriptions, Contact contact)

Create new subscriptions associated with the identified contact.

Input

  • subscriptions : event and notifyOnDevice are required. At least one Schedule Line is required.
  • contact : internalId

Response

Subscription[] (D)

Availability

Future

Errors returned

  • ARG_INVALID_TYPE – Argument is of invalid type '%s'
  • ARG_NULL – Argument supplied is null
  • ARG_TOO_LARGE – Invalid Data, argument '%s' exceeds allowed size
  • ATTRIBUTE_NULL – Attribute supplied is null
  • ATTRIBUTE_INVALID – Attribute is not valid
  • OBJECT_EXISTS – Object '%s' already exists1
  • OBJECT_NOT_EXISTS – Referenced object '%s' does not exist

deleteSubscriptions(Subscriptions[] subscriptions)

Deletes supplied Subscriptions

Input

Subscriptions : internalId for Subscriptions to be deleted

Response

NONE

Availability

Future

Errors returned

  • ARG_NULL – Argument supplied is null
  • ARG_TOO_LARGE – Invalid Data, argument '%s' exceeds allowed size
  • OBJECT_NOT_EXISTS – Referenced object '%s' does not exist

Notes

  • Deletion is always a soft delete.
  • The maximum number of items that may be supplied using this method is 100.

changeSubscription(Subscription subscription)

Changes an existing Subscription

Input

Subscription : internalId + any fields to be changed

Response

Subscription (D) : Updated Subscription

Availability

Future

Errors returned

  • ARG_INVALID_TYPE – Argument is of invalid type '%s'
  • ARG_NULL – Invalid Data, argument '%s' must be non-null
  • ATTRIBUTE_NULL – Attribute supplied is null
  • ATTRIBUTE_INVALID – Attribute is not valid
  • OBJECT_NOT_EXISTS – Referenced object '%s' does not exist

listSubscriptionsUsingEvent(Contact contact, Event sample)

Lists Subscriptions matching sample associated with the identified contact.

Input

  • contact: internalId
  • sample: optional event object to narrow the returned set.

Response

Subscriptions[] (D) : List of associated Subscriptions

Availability

Future

Errors returned

  • ARG_INVALID_TYPE – Argument is of invalid type '%s'
  • ARG_NULL – Invalid Data, argument '%s' must be non-null
  • OBJECT_NOT_EXISTS – Referenced object '%s' does not exist
  • RESULT_TOO_LARGE – Result returned would be too large

Notes

  • The maximum number of items returned using this method is 100.
  • Only the attributes on the core entity are matched if a sample is supplied.

Feedback

Comment on this article:

blog comments powered by Disqus
This page was last modified on 6 September 2016, at 11:25.