The most basic entity type in our domain. We require that there is a location open to enter violations, so that this information can be returned to the client.
| name | data type | constraints | description |
|---|---|---|---|
| id | number | ||
| clients | array of Client | ||
| office | OfficeInfo | ||
| tmc | Client | ||
| name | string | ||
| number | number | ||
| notes | map of object | ||
| guestInstructions | map of object | ||
| complexNotes | map of object | ||
| datatype | number | required int | |
| required | boolean | required boolean | |
| list | boolean | required boolean | |
| code | UdidReportCode | ||
| complex | boolean | required boolean | |
| inApproval | boolean | required boolean | |
| enabled | boolean | required boolean | |
| guest | boolean | required boolean | |
| profiled | boolean | required boolean | |
| traveler | boolean | required boolean | |
| trip | boolean | required boolean | |
| approver | boolean | required boolean | |
| travelerType | string | ||
| valueSource | string | ||
| policyRules | array of ClientTravelPolicyUdid | ||
| linkedUdids | array of LinkedUdid | ||
| ownerClient | Client | ||
| example | string | ||
| maximum | number | ||
| minimum | number | ||
| workingNotes | string | ||
| workingGuestInstructions | string | ||
| workingComplexNotes | string | ||
| reportField | number | ||
| linkageType | number | required int | |
| reportCode | UdidReportCode | ||
Properties inherited from BaseEntity |
|||
| violations | array of SimpleViolation | A list of constraint violations, if any, that this object has. | |
Example
{
"id" : 12345,
"clients" : [ {
"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" : "..."
} ]
}, {
"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" : "..."
} ]
} ],
"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" : "...",
"name" : "...",
"enabled" : 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" : "..."
} ]
},
"tmc" : {
"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" : "..."
} ]
},
"name" : "...",
"number" : 12345,
"notes" : {
"property1" : { },
"property2" : { }
},
"guestInstructions" : {
"property1" : { },
"property2" : { }
},
"complexNotes" : {
"property1" : { },
"property2" : { }
},
"datatype" : 12345,
"required" : true,
"list" : true,
"code" : {
"name" : "...",
"code" : "...",
"id" : 12345,
"version" : 12345,
"violations" : [ {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
}, {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
} ]
},
"complex" : true,
"inApproval" : true,
"enabled" : true,
"guest" : true,
"profiled" : true,
"traveler" : true,
"trip" : true,
"approver" : true,
"travelerType" : "...",
"valueSource" : "...",
"policyRules" : [ {
"value" : "...",
"moveToClient" : {
"status" : { },
"parentClient" : { },
"accountNumber" : "...",
"name" : "...",
"type" : { },
"id" : 12345,
"version" : 12345,
"violations" : [ { }, { } ]
},
"description" : "...",
"id" : 12345,
"version" : 12345,
"violations" : [ {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
}, {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
} ]
}, {
"value" : "...",
"moveToClient" : {
"status" : { },
"parentClient" : { },
"accountNumber" : "...",
"name" : "...",
"type" : { },
"id" : 12345,
"version" : 12345,
"violations" : [ { }, { } ]
},
"description" : "...",
"id" : 12345,
"version" : 12345,
"violations" : [ {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
}, {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
} ]
} ],
"linkedUdids" : [ {
"udidName" : "...",
"udidId" : 12345,
"compositeNumber" : 12345
}, {
"udidName" : "...",
"udidId" : 12345,
"compositeNumber" : 12345
} ],
"ownerClient" : {
"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" : "..."
} ]
},
"example" : "...",
"maximum" : 12345,
"minimum" : 12345,
"workingNotes" : "...",
"workingGuestInstructions" : "...",
"workingComplexNotes" : "...",
"reportField" : 12345,
"linkageType" : 12345,
"reportCode" : {
"name" : "...",
"code" : "...",
"id" : 12345,
"version" : 12345,
"violations" : [ {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
}, {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
} ]
},
"violations" : [ {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
}, {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
} ]
}