NotificationStatus Data Type

An object defining the basic abilities we want all of our hibernate objects to have.

Properties
name data type constraints description
notification Notification required
sendTime number  
client Client  
toUser User   The user to receive the notification. The system will use this user to determine their notification method
toName string  
toAddress string   This is an alternative field if the user doesn't exist
fromUser User  
fromName string  
fromAddress string  
status AnalyticStatus required
sent number  
method NotificationMethod  
deliveredTo string   Not to be confused with toUser or toAddress. This field tracks the addresses that the notification was sent to at the time of delivery. It's likely that users will change their email and/or mobile number, so this field will track each instance of delivery address.
failureMessage string  
Properties inherited from BaseHibernateEntity
id number   The unique internal ID of the object.
version number   For internal use only. This is the serialization recorder for optimistic locking of several objects between sessions.
Properties inherited from BaseEntity
violations array of SimpleViolation   A list of constraint violations, if any, that this object has.

Example

{
  "notification" : {
    "dateCreated" : 12345,
    "createdBy" : {
      "answer" : "...",
      "emailed" : true,
      "newUser" : true,
      "temporaryPassword" : "...",
      "question" : "...",
      "obeUserName" : "...",
      "obePassword" : "...",
      "obeSyncId" : "...",
      "created" : 12345,
      "modifiedDate" : 12345,
      "emailedWhen" : 12345,
      "travelgpaLogin" : "...",
      "groups" : [ { }, { } ],
      "active" : true,
      "prefix" : "...",
      "firstName" : "...",
      "lastName" : "...",
      "middleName" : "...",
      "suffix" : "...",
      "email" : "...",
      "tripitAuthorized" : true,
      "supportTitle" : "...",
      "automatedNotifications" : true,
      "enableHotelAttachment" : true,
      "atHomeNotificationMethod" : { },
      "inTravelNotificationMethod" : { },
      "cellPhoneNumber" : "...",
      "userCurrentClient" : { },
      "defaultClient" : { },
      "defaultPlannerGroup" : { },
      "showWelcomeDialog" : true,
      "siteTour" : true,
      "unusedTicketEmail" : true,
      "surveyEmail" : true,
      "wt0EmailEnabled" : true,
      "wt0EmailDaily" : true,
      "wt0EmailDay" : 12345,
      "wt0EmailHour" : 12345,
      "marketingSubscribed" : true,
      "responsive" : true,
      "businessPhoneNumber" : "...",
      "homePhoneNumber" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "subject" : "...",
    "content" : "...",
    "travelAlert" : {
      "timestamp" : 12345,
      "destination" : { },
      "severity" : { },
      "start" : 12345,
      "end" : 12345,
      "description" : "...",
      "link" : "...",
      "datetime" : 12345,
      "latitude" : 12345.0,
      "longitude" : 12345.0,
      "type" : { },
      "stateCode" : "...",
      "metroCode" : "...",
      "cityName" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "safetyCheck" : true,
    "emailOnly" : true,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "sendTime" : 12345,
  "client" : {
    "status" : {
      "name" : "...",
      "active" : true,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "parentClient" : { },
    "accountNumber" : "...",
    "name" : "...",
    "type" : {
      "name" : "...",
      "hide" : true,
      "level" : 12345,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "toUser" : {
    "answer" : "...",
    "emailed" : true,
    "newUser" : true,
    "temporaryPassword" : "...",
    "question" : "...",
    "obeUserName" : "...",
    "obePassword" : "...",
    "obeSyncId" : "...",
    "created" : 12345,
    "modifiedDate" : 12345,
    "emailedWhen" : 12345,
    "travelgpaLogin" : "...",
    "groups" : [ {
      "name" : "...",
      "permissions" : [ { }, { } ],
      "description" : "...",
      "role" : { },
      "type" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    }, {
      "name" : "...",
      "permissions" : [ { }, { } ],
      "description" : "...",
      "role" : { },
      "type" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    } ],
    "active" : true,
    "prefix" : "...",
    "firstName" : "...",
    "lastName" : "...",
    "middleName" : "...",
    "suffix" : "...",
    "email" : "...",
    "tripitAuthorized" : true,
    "supportTitle" : "...",
    "automatedNotifications" : true,
    "enableHotelAttachment" : true,
    "atHomeNotificationMethod" : {
      "name" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "inTravelNotificationMethod" : {
      "name" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "cellPhoneNumber" : "...",
    "userCurrentClient" : {
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "defaultClient" : {
      "status" : { },
      "parentClient" : { },
      "accountNumber" : "...",
      "name" : "...",
      "type" : { },
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "defaultPlannerGroup" : {
      "status" : { },
      "parentClient" : { },
      "accountNumber" : "...",
      "name" : "...",
      "type" : { },
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "showWelcomeDialog" : true,
    "siteTour" : true,
    "unusedTicketEmail" : true,
    "surveyEmail" : true,
    "wt0EmailEnabled" : true,
    "wt0EmailDaily" : true,
    "wt0EmailDay" : 12345,
    "wt0EmailHour" : 12345,
    "marketingSubscribed" : true,
    "responsive" : true,
    "businessPhoneNumber" : "...",
    "homePhoneNumber" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "toName" : "...",
  "toAddress" : "...",
  "fromUser" : {
    "answer" : "...",
    "emailed" : true,
    "newUser" : true,
    "temporaryPassword" : "...",
    "question" : "...",
    "obeUserName" : "...",
    "obePassword" : "...",
    "obeSyncId" : "...",
    "created" : 12345,
    "modifiedDate" : 12345,
    "emailedWhen" : 12345,
    "travelgpaLogin" : "...",
    "groups" : [ {
      "name" : "...",
      "permissions" : [ { }, { } ],
      "description" : "...",
      "role" : { },
      "type" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    }, {
      "name" : "...",
      "permissions" : [ { }, { } ],
      "description" : "...",
      "role" : { },
      "type" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    } ],
    "active" : true,
    "prefix" : "...",
    "firstName" : "...",
    "lastName" : "...",
    "middleName" : "...",
    "suffix" : "...",
    "email" : "...",
    "tripitAuthorized" : true,
    "supportTitle" : "...",
    "automatedNotifications" : true,
    "enableHotelAttachment" : true,
    "atHomeNotificationMethod" : {
      "name" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "inTravelNotificationMethod" : {
      "name" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "cellPhoneNumber" : "...",
    "userCurrentClient" : {
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "defaultClient" : {
      "status" : { },
      "parentClient" : { },
      "accountNumber" : "...",
      "name" : "...",
      "type" : { },
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "defaultPlannerGroup" : {
      "status" : { },
      "parentClient" : { },
      "accountNumber" : "...",
      "name" : "...",
      "type" : { },
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "showWelcomeDialog" : true,
    "siteTour" : true,
    "unusedTicketEmail" : true,
    "surveyEmail" : true,
    "wt0EmailEnabled" : true,
    "wt0EmailDaily" : true,
    "wt0EmailDay" : 12345,
    "wt0EmailHour" : 12345,
    "marketingSubscribed" : true,
    "responsive" : true,
    "businessPhoneNumber" : "...",
    "homePhoneNumber" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "fromName" : "...",
  "fromAddress" : "...",
  "status" : {
    "name" : "...",
    "percentage" : 12345,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "sent" : 12345,
  "method" : {
    "name" : "...",
    "code" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "deliveredTo" : "...",
  "failureMessage" : "...",
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
}