NovatusEvent Object

  • The NovatusEvent object is a means by which Events can be created, updated, and queried.  
  • The “column” field can be null or “originalexpirationdate”. When the value is null, the event will only appear in the Events tab of the profile. If the value is “originalexpirationdate” on a Contract Event, it will be used as the renewal event that appears in the “Term and Renewal” section of the contract profile. Only one event per contract can be used as the renewal event.

Production WSDL: https://app1.novatuscontracts.com/Contracts/wsapi/v1/Event?Wsdl

Field Name

Type

Description

Queryable

Required

id

String

A unique identifier of this Contracts Event

Yes

-

column

String

The column to attach the event (see above)

Yes

-

date

XML Gregorian Calendar Date

Date of the event

Yes

Yes

description

String

Description of the Event

Yes

-

documentIds

String

IDs of the documents attached to the Event

Only

-

endDate

XML Gregorian Calendar Date

If a frequency is set, then the date that the event will end

Yes

Yes

frequency

Integer

If a frequency type is then the number of times the event will go out

Yes

Yes, if frequency type is set to monthly or yearly

frequencyType

String

Single, Monthly, or Yearly

Yes

Yes

name

String

Name of the Event

Yes

Yes

notificationMessage

String

Body of the notification message

Yes

-

notificationIds

String

Person IDs of the notification list

Only

-

objectId

String

ID of the contact the event is on

Yes

Yes

ownerId

String

Person ID of the Event Owner

Yes

Yes

reminder

Boolean

If reminder exists

Yes

-

reminderDays

Integer

Number of reminder days

Yes

-

reminderMessage

String

Body of the reminder message

Yes

-

status

String

Event Status

Yes

Yes

reminderIds

String

Person IDs of the reminder list

Only

-

warnDays

Integer

Number of Warn Days

Yes

-

NovatusEvent Object Methods

The methods listed below are the means by which changes can be made to the event(s) themselves; below is a quick example of how to use these methods:

String eventId = session.getEventPort().create(event);		
		EventQueryResult test = session.getEventPort().query("id = '" + eventId + "'", 10, 0);
		// EventQueryResult event = eventPort.query("name='Event 1'", 25, 0);
		return test.getEventList().get(0);
CODE


NovatusEvent NQL Statements

These are list of items that can be placed into an NQL statement to filter Event queries.  This is different from the above chart in that these are not methods that can return data but rather NQL statements that can allow you to filter query results.

EventQueryResult events = eventPort.query(“name = ‘Event 1’”,10,0);
CODE

Field Name

Description

id

A unique identifier of this Contracts Event

date

Date of the Event

description

Event Description

endDate

End Date of the Event if frequency is set to monthly or yearly

notificationids

Person IDs of the notification list

frequencyType

Single, Monthly, or Yearly

name

Name of the Event

notificationmessage

Body of the notification message

objectId

Contract ID that the Event belongs to

ownerId

Event owner person ID

reminder

Boolean value to determine if reminder exists

reminderdays

Number of reminder days

reminderids

Person ID’s of the reminder list

documentids

IDs of the documents attached to the Event

remindermessage

Body of the reminder message