An element representing a user for AirPortal.
| name | data type | constraints | description |
|---|---|---|---|
| answer | string | The answer to the security question specified by the user. | |
| emailed | boolean | required boolean | A flag specifying whether this user has been e-mailed their password. |
| newUser | boolean | required boolean | A flag specifying if this user has ever logged in to Airportal. |
| temporaryPassword | string | This user's password. | |
| 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. | |
| modifiedDate | number | ||
| 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 | required 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 | |
| string | The email address of this user. This is the email address that we email to. | ||
| tripitAuthorized | boolean | required 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 | required boolean | |
| enableHotelAttachment | boolean | required 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. | |
| |
|
|
|
| userCurrentClient | UserCurrentClient | ||
| defaultClient | Client | ||
| defaultPlannerGroup | Client | ||
| showWelcomeDialog | boolean | ||
| siteTour | boolean | required boolean | |
| unusedTicketEmail | boolean | required boolean | |
| surveyEmail | boolean | required boolean | Flag to control sending survey emails |
| wt0EmailEnabled | boolean | required boolean | Flag to control sending work to zero emails |
| wt0EmailDaily | boolean | required boolean | Flag to control daily or weekly emails |
| wt0EmailDay | number | required int | The day of the week to send the email, where Sunday = 1 |
| wt0EmailHour | number | required int | The hour of the day to send the email, where midnight = 0, noon = 12 |
| marketingSubscribed | boolean | required boolean | Whether or not this user is subscribed to canned marketing emails. |
| responsive | boolean | required boolean | Flag to control the user's layout |
| businessPhoneNumber | string | The business/work number of the user. | |
| homePhoneNumber | string | The home phone number of the user. | |
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,
"temporaryPassword" : "...",
"question" : "...",
"obeUserName" : "...",
"obePassword" : "...",
"obeSyncId" : "...",
"created" : 12345,
"modifiedDate" : 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" : "...",
"userCurrentClient" : {
"id" : 12345,
"version" : 12345,
"violations" : [ {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
}, {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
} ]
},
"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,
"businessPhoneNumber" : "...",
"homePhoneNumber" : "...",
"id" : 12345,
"version" : 12345,
"violations" : [ {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
}, {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
} ]
}