Skip to main content

EventService.GetEvent

Reference

Prorigo.Protrak.API.Contracts.Event GetEvent(Guid eventId)

Use GetEvent to get details of a event by it's id.

Parameters

  • eventId: The unique Guid for event. This id can be used to fetch all the details of one event.

Returns

Prorigo.Protrak.API.Contracts.Event:

  • Guid Id: The event id
  • Guid? InstanceTypeId : The type id for event.
  • string InstanceTypeName: The type name for the instance
  • Guid InstanceId: The instance id
  • string EventType: The event type.
  • string EventData: The event data in json string.
  • string StringData1: The event string data 1.
  • string StringData2: The event string data 2.
  • string StringData3: The event string data 3.
  • string StringData4: The event string data 4.
  • string StringData5: The event string data 5.
  • double? NumericData1: The event numeric data 1.
  • double? NumericData2: The event numeric data 2.
  • double? NumericData3: The event numeric data 3.
  • double? NumericData4: The event numeric data 4.
  • double? NumericData5: The event numeric data 5.
  • DateTime? DateData1: The event date data 1.
  • DateTime? DateData2: The event date data 2.
  • DateTime? DateData3: The event date data 3.
  • DateTime? DateData4: The event date data 4.
  • DateTime? DateData5: The event date data 5.
  • Boolean? BooleanData1: The event boolean data 1.
  • Boolean? BooleanData2: The event boolean data 2.
  • Boolean? BooleanData3: The event boolean data 3.
  • Boolean? BooleanData4: The event boolean data 4.
  • Boolean? BooleanData5: The event boolean data 5.
  • DateTime? Created: Event created date in server.
  • DateTime? Modified: Event modified date in server.
  • DateTime? EventCreated: Event actual created date.
  • UserValue Creator: Event creator details in UserValue.
  • UserValue Modifier: Event modifier details in UserValue.

Caveats

  • This API returns error if the event does not exist for the event Id passed. This should be used in code where it is guaranteed that event with the given id exists.

Usage

var eventId = new Guid("<EventId>")
var event = EventService.GetInstance(eventId);
var eventType = event.EventType;
var instanceid = event.InstanceId;

Troubleshooting