Introduction
A Clean Check Truck emission vehicle enrollment. One Device should only have one active enrollment with status Pending or Enrolled.
Security clearance requirements:
Creating EmissionVehicleEnrollment (Add requests) requires security clearances AccessCleanTruckCheckCompliance;
Updating EmissionVehicleEnrollment (Set requests) requires one of the following security clearances AccessCleanTruckCheckCompliance or AccessCleanTruckCheckComplianceEditor;
Note: AccessCleanTruckCheckComplianceEditor is not allowed for disenrolling an enrollment.
Retrieving EmissionVehicleEnrollment (Get requests) requires one of the following security clearances AccessCleanTruckCheckCompliance, AccessCleanTruckCheckComplianceEditor or AccessCleanTruckCheckComplianceViewer.
Properties

CreatedDateTime

The DateTime when the emission vehicle enrollment record was created.

Device

The Device.

DisenrolledDateTime

The disenrolled DateTime if the EmissionVehicleEnrollment is disenrolled. If null, the EmissionVehicleEnrollment is not disenrolled.
To disenroll a device, cancel its enrollment by:
  • Setting DisenrolledDateTime to a not-null timestamp;
  • Setting the EnrollmentStatus to NotEnrolled;
  • Setting the LoggingFrequency to 0 (Disabled).

DmvRegistrationDateTime

The DMV registration DateTime for the EmissionVehicleEnrollment.

DriverNotificationMode

The driver notification mode for the EmissionVehicleEnrollment. Determines whether driver/fleet-manager notifications for Invalid Test and Not Ready scan results are sent automatically or only when manually triggered. The default value is "Manual". Valid values are:
  • Manual
  • Auto

EnrollmentStatus

The enrollment status for the EmissionVehicleEnrollment. Valid values are:
  • NotEnrolled: When an enrollment's status is set to NotEnrolled or the DisenrolledDateTime is set, the enrollment is cancelled and the device is disenrolled.
  • Pending: Active enrollment status. A new enrollment should be created with Pending status.
  • Enrolled: Active enrollment status. Once a complete cycle has been received, a Pending enrollment will be marked as Enrolled.
  • Rejected: When an enrollment attempt fails, an enrollment record with Rejected status will be created for the device with the failure reason. If later enrollment succeeds, the enrollment will be updated with an active enrollment status.

FailureReason

The reason for enrollment failure. Valid values are:
  • None
  • DeviceIsNotProPlusOrGoPlan
  • NoCompleteCycleReceived
  • DeviceRatePlanNotFound
  • VehicleNotApplicableForObdTesting
  • VehicleNotApplicableForCleanTruckCheck
  • DeviceIsArchived
  • UncertifiedHarnessDetected
  • Unknown The default value is "None".

Id

The unique identifier for the specific Entity object in the Geotab system. See Id.

LastLoggingFrequencyUpdateDateTime

The DateTime when the logging frequency value was last updated.

LoggingFrequencyType

Sets the Value property of EmissionEnrollmentLoggingFrequencyType to the one of the following numeric values to configure the emission logging frequency type:
  • 0 (Disabled)
  • 1~250 (Every 1~125 Day)
  • 251 (Every Ignition)
  • 253 (On Demand)

PlanDowngradeDetectedDateTime

The DateTime when a device plan downgrade was detected for the enrolled Device.
If null, no plan downgrade has been detected for this enrollment.
A plan downgrade occurs when a device's rate plan changes from a supported plan (ProPlus or GO) to an unsupported plan
(e.g., Basic, Suspended, Terminated). When this happens, the system automatically records the timestamp when the downgrade was detected.
To clear this value, use the ClearPlanDowngradeDetectedDateTime method instead of setting this property to null directly.
This ensures the database is properly updated to remove the timestamp.

SelectedLoggingFrequencyType

Version

The version of the entity.

WorkOrderCreationMode

The work order creation mode for the EmissionVehicleEnrollment. Determines whether a work order for a Fail scan result is created automatically or only when manually triggered. The default value is "Manual". Valid values are:
  • Manual
  • Auto
Rate limits
MethodDescriptionLimitPeriodStatus
GetLimit of 500 Get requests per 1m.5001mNot specified
SetLimit of 500 Set requests per 1m.5001mNot specified
AddLimit of 500 Add requests per 1m.5001mNot specified
GetCountOfLimit of 500 GetCountOf requests per 1m.5001mNot specified
RemoveLimit of 500 Remove requests per 1m.5001mNot specified
GetFeedLimit of 250 GetFeed requests per 1m.2501mActive
Pagination

Results limit

10000

Supported sort

Id

Timeout Limit
MethodDescriptionLimitStatus
GetFeedTimeout of 180 seconds for GetFeed per request.180Active

Loading API Runner...