EligTests
Name: Eligibility Tests
Type: Application
Modules: Booking, Scheduling
Description: Contains all eligibility tests and their specific criteria which define whether or not a trip can be provided. Checked when creating bookings.
| Field | Documentation |
|---|---|
| EligTestId | Numeric identifier of the eligibility test. |
| ClientId | Numeric identifier of the client (from the Clients table). |
| ConditionCode | AlphaNumeric identifier of the eligibility condition (from the EligCondition table). |
| StatusId | Hard-coded value for the test status (1 = Expired, 2 = In Progress, 3 = Reviewed). |
| EligTestAction | Hard-coded value for the action to be taken (1 = Required, 2 = Sufficient, 3 = Deny). |
| WeekTemplate | 7-digit character string representing the days of the week for the test (e.g., 0100100 = Monday and Thursday). |
| FromTime | Start time from which the test is in effect. Value is in seconds from midnight. |
| ToTime | End time to which the test is in effect. Value is in seconds from midnight. |
| FromDate | Start date from which the test is used. |
| ToDate | End date after which the test is no longer used. |
| SuspFromDate | Start date from which the test will be ignored or not performed. |
| SuspToDate | End date after which the test will no longer be ignored or performed. |
| SchedulePeriodId | Numeric identifier of the schedule period (from the SchedulePeriods table). |
| PurposeId | Numeric identifier of the booking purpose (from the BookingPurpose table). |
| AdvanceDaysMin | Minimum number of days in advance a trip must be booked to be considered for eligibility via testing. |
| AdvanceDaysMax | Maximum number of days in advance a trip must be booked to be considered for eligibility via testing. |
| OriginObjectType | Hard-coded value for the address type of the origin location. |
| OriginObjectId | Numeric identifier of the relevant table or field based on the OriginObjectType (e.g., if the OriginObjectType is for a location then the ObjectID is the LocID). |
| OriginSiteName | Address name or location name of the origin location address. |
| OriginStreetNo | Street number of the origin location address. |
| OriginOnStreet | Street name of the origin location address. |
| OriginAtStreet | Cross-street or intersection closest to the origin location address. |
| OriginCity | City of the origin location address. |
| OriginState | State of the origin location address. |
| OriginZipCode | Zip code or postal code of the origin location address. |
| DestinationObjectType | Hard-coded value for the destination's address type or location type (e.g., Client Home or Location). |
| DestinationObjectId | Numeric identifier of the relevant table or field based on the ObjectType (e.g., if the type is a location then the ID is the LocID from the Locations table). |
| DestinationSiteName | Name of the destination location address (e.g., name of the building). |
| DestinationStreetNo | Street number of the destination location address. |
| DestinationOnStreet | Street name of the destination location address. |
| DestinationAtStreet | Cross-street or intersection closest to the destination location address. |
| DestinationCity | City of the destination location address. |
| DestinationState | State of the destination location address. |
| DestinationZipCode | Zip code or postal code of the destination location address. |
| ApplyToReverse | Flag that indicates whether the test should also apply to the reverse trip (if applicable). If a client books a trip from A to B, then also apply the test to the B to A booking. |
| MinTripDist | Minimum distance in meters that a trip must travel before the test is invoked. |
| Comments | Comments about the record. |
| CreDate | Date the eligibility test was created. |
| CreTime | Time the eligibility test was created. Value is in seconds from midnight. |
| CreBy | Username that created the eligibility test. |
| ModDate | Date the eligibility test was last modified. |
| ModTime | Time the eligibility test was last modified. Value is in seconds from midnight. |
| ModBy | Username that last modified the eligibility test. |
| FixedRouteAvailable | Flag that indicates if a third party can be called for fixed route solutions. |
| EligBeforeDate | Date a client must be already eligible by to book a trip (i.e., a grandfathered provision). Value is in YYYMMDD format. |
| OriginLon | Longitude coordinate of the origin location address. |
| OriginLat | Latitude coordinate of the origin location address. |
| DestinationLon | Longitude coordinate of the destination location address. |
| DestinationLat | Latitude coordinate of the destination location address. |
| ADA | Flag that indicates the eligibility test is for ADA (Americans with Disabilities Act). |
| ADAPolyTypeId | Numeric identifier of the ADA polygon (from the Polygons table). |
| Custom | Flag that indicates that the eligibility test is a third-party, custom test. If so, then a third-party application is called using property sets for it. |
| SetName | Defined SetName associated with the eligibility test (from the TripPlanningSolutionSets table). |