User Data Type

An element representing a user for AirPortal.

Properties
name data type constraints description
answer string   The answer to the security question specified by the user.
emailed boolean   A flag specifying whether this user has been e-mailed their password.
newUser boolean   A flag specifying if this user has ever logged in to Airportal.
question string   The security question defined by the user.
obeUserName string   The user name of this user's Online Booking Tool login.
obePassword string   The password for this user in their Online Booking Tool.
obeSyncId string  
created number   The creation date of this user object.
emailedWhen number   The date that the user was last emailed their password.
travelgpaLogin string   This user's username for their TravelGPA account.
groups array of Group   The groups that this user belongs to.
active boolean   Whether this user account is active.
prefix string   The user's name prefix
firstName string   The first name of this user.
lastName string   The last name of this user.
middleName string   The middle name of this user.
suffix string   The user's name suffix
email string   The email address of this user. This is the email address that we email to.
tripitAuthorized boolean   Whether the user has authorized Airportal to push itineraries to their tripit account.
supportTitle string   The Helpdesk support title belonging to this user
automatedNotifications boolean  
enableHotelAttachment boolean  
atHomeNotificationMethod NotificationMethod   The user's preferred notification method while they are at home.
inTravelNotificationMethod NotificationMethod   The user's preferred notification method while they are in travel.
cellPhoneNumber string   The cell phone number of the user. This is for text messaging.
oldClient number  
defaultClient Client  
defaultPlannerGroup Client  
showWelcomeDialog boolean  
siteTour boolean  
unusedTicketEmail boolean required
surveyEmail boolean required Flag to control sending survey emails
wt0EmailEnabled boolean   Flag to control sending work to zero emails
wt0EmailDaily boolean   Flag to control daily or weekly emails
wt0EmailDay number   The day of the week to send the email, where Sunday = 1
wt0EmailHour number   The hour of the day to send the email, where midnight = 0, noon = 12
marketingSubscribed boolean   Whether or not this user is subscribed to canned marketing emails.
responsive boolean required Flag to control the user's layout
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

{
  "answer" : "...",
  "emailed" : true,
  "newUser" : true,
  "question" : "...",
  "obeUserName" : "...",
  "obePassword" : "...",
  "obeSyncId" : "...",
  "created" : 12345,
  "emailedWhen" : 12345,
  "travelgpaLogin" : "...",
  "groups" : [ {
    "name" : "...",
    "permissions" : [ {
      "name" : "...",
      "description" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    }, {
      "name" : "...",
      "description" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    } ],
    "description" : "...",
    "role" : {
      "name" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "type" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "name" : "...",
    "permissions" : [ {
      "name" : "...",
      "description" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    }, {
      "name" : "...",
      "description" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    } ],
    "description" : "...",
    "role" : {
      "name" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "type" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "active" : true,
  "prefix" : "...",
  "firstName" : "...",
  "lastName" : "...",
  "middleName" : "...",
  "suffix" : "...",
  "email" : "...",
  "tripitAuthorized" : true,
  "supportTitle" : "...",
  "automatedNotifications" : true,
  "enableHotelAttachment" : true,
  "atHomeNotificationMethod" : {
    "name" : "...",
    "code" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "inTravelNotificationMethod" : {
    "name" : "...",
    "code" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "cellPhoneNumber" : "...",
  "defaultClient" : {
    "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" : "..."
    } ]
  },
  "defaultPlannerGroup" : {
    "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" : "..."
    } ]
  },
  "showWelcomeDialog" : true,
  "siteTour" : true,
  "unusedTicketEmail" : true,
  "surveyEmail" : true,
  "wt0EmailEnabled" : true,
  "wt0EmailDaily" : true,
  "wt0EmailDay" : 12345,
  "wt0EmailHour" : 12345,
  "marketingSubscribed" : true,
  "responsive" : true,
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
}