An object describing this user as an employee.
name | data type | constraints | description |
---|---|---|---|
user | User | The user that this employee information belongs to. | |
agentCode | string | The agent code this employee uses to define themselves in their GDS. | |
office | OfficeInfo | Get the office that this person works at. | |
workEmail | string | The email that this employee will email from. | |
active | string | required | Whether or not this office is active. |
type | string | ||
emailList | string | ||
category | string | required | |
directLine | string | max size: 20, min size: 0 | The phone number to connect to the agent. |
hours | string | ||
onlineAgent | boolean | true / false whether this agent is an online booking engine | |
recheckEmails | boolean | ||
serviceFeesPct | number | ||
otherServiceFeesPct | number | ||
internationalAirCommissionPct | number | ||
miscCommissionPct | number | ||
airCommissionPct | number | ||
hotelCommissionPct | number | ||
carCommissionPct | number | ||
employeeType | EmployeeType | ||
ticketingAgent | boolean | true / false whether this agent is a ticketing support agent. Usually there is a small fee for this agent's service, which the company gathers. | |
supportAgent | boolean | Whether or not this agent is a support agent. Support agents get ignored when calculating fees. | |
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
{ "user" : { "answer" : "...", "emailed" : true, "newUser" : true, "question" : "...", "obeUserName" : "...", "obePassword" : "...", "obeSyncId" : "...", "created" : 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" : "...", "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, "id" : 12345, "version" : 12345, "violations" : [ { "propertyName" : "...", "failureMessage" : "...", "stackTrace" : "..." }, { "propertyName" : "...", "failureMessage" : "...", "stackTrace" : "..." } ] }, "agentCode" : "...", "office" : { "pcc" : "...", "name" : "...", "address1" : "...", "address2" : "...", "address3" : "...", "city" : "...", "state" : "...", "zip" : "...", "parentCompany" : { "name" : "...", "id" : 12345, "version" : 12345, "violations" : [ { }, { } ] }, "active" : "...", "branch" : "...", "clientPrefix" : "...", "profileSettings" : { "profileNameFormat" : "...", "id" : 12345, "version" : 12345, "violations" : [ { }, { } ] }, "afterHoursNumber" : "...", "collectVoidLogs" : true, "gds" : { "code" : "...", "oldCode" : "...", "name" : "...", "agressoCode" : "...", "enabled" : true, "profileSyncEnabled" : true, "id" : 12345, "version" : 12345, "violations" : [ { }, { } ] }, "arcNumber" : "...", "logo" : "...", "logoLink" : "...", "afterHoursInternationalNumber" : "...", "tollFreeNumber" : "...", "phoneNumber" : "...", "onlineOffice" : { "name" : "...", "hours" : "...", "phone" : "...", "tollFree" : "...", "email" : "...", "id" : 12345, "version" : 12345, "violations" : [ { }, { } ] }, "showTmcAppLinks" : true, "vipTollFree" : "...", "vipAfterHours" : "...", "cityCode" : { "code" : "...", "countryCode" : "...", "latitude" : 12345.0, "longitude" : 12345.0, "name" : "...", "stateOrCountry" : "...", "airportName" : "...", "region" : { }, "timeZone" : { }, "retentionOnly" : true, "position" : 12345, "unique" : true, "alias" : true, "id" : 12345, "version" : 12345, "violations" : [ { }, { } ] }, "tmcHeadQuarters" : true, "id" : 12345, "version" : 12345, "violations" : [ { "propertyName" : "...", "failureMessage" : "...", "stackTrace" : "..." }, { "propertyName" : "...", "failureMessage" : "...", "stackTrace" : "..." } ] }, "workEmail" : "...", "active" : "...", "type" : "...", "emailList" : "...", "category" : "...", "directLine" : "...", "hours" : "...", "onlineAgent" : true, "recheckEmails" : true, "serviceFeesPct" : 12345.0, "otherServiceFeesPct" : 12345.0, "internationalAirCommissionPct" : 12345.0, "miscCommissionPct" : 12345.0, "airCommissionPct" : 12345.0, "hotelCommissionPct" : 12345.0, "carCommissionPct" : 12345.0, "employeeType" : { "code" : "...", "name" : "...", "id" : 12345, "version" : 12345, "violations" : [ { "propertyName" : "...", "failureMessage" : "...", "stackTrace" : "..." }, { "propertyName" : "...", "failureMessage" : "...", "stackTrace" : "..." } ] }, "ticketingAgent" : true, "supportAgent" : true, "id" : 12345, "version" : 12345, "violations" : [ { "propertyName" : "...", "failureMessage" : "...", "stackTrace" : "..." }, { "propertyName" : "...", "failureMessage" : "...", "stackTrace" : "..." } ] }