An object that explains the relation a manager or planner has to a client or group of travelers.
| name | data type | constraints | description |
|---|---|---|---|
| role | Role | required | The title that the user has in relation to the client. |
| manager | User | required | The user that manages the client. |
| client | Client | required | The client that is being managed. |
| displayOrder | number | Determines order in which the agent is displayed throughout the front end. | |
| boolean | required boolean | ||
| agressoUpdateDate | number | ||
| bypassAgressoSync | boolean | required boolean | |
| enrollmentApprover | boolean | required boolean | |
| travelAlertManager | boolean | required boolean | |
| approver | boolean | required boolean | True / False if this manager is the travel approver for this client. |
| cardExpireNotify | boolean | required boolean | True / False if this manager should get notifications about expiring credit cards |
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
{
"role" : {
"name" : "...",
"code" : "...",
"id" : 12345,
"version" : 12345,
"violations" : [ {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
}, {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
} ]
},
"manager" : {
"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" : "..."
} ]
},
"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" : "..."
} ]
},
"displayOrder" : 12345,
"hidden" : true,
"agressoUpdateDate" : 12345,
"bypassAgressoSync" : true,
"enrollmentApprover" : true,
"travelAlertManager" : true,
"approver" : true,
"cardExpireNotify" : true,
"id" : 12345,
"version" : 12345,
"violations" : [ {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
}, {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
} ]
}