Click or drag to resize

WoVisit Class

Represents a Visit - a unit of recurring maintenance activity (janitorial, snow removal, cleaning, etc.) within a single Work Order. Created via Check-In/Check-Out commands or manually. Supports standard IntegrationApi deletion; BO deletion cleanup removes related visit services and writes the VisitDeleted work order action log.
Inheritance Hierarchy

Namespace: CorrigoService.Entities
Assembly: ClientXMLDoc (in ClientXMLDoc.exe) Version: 1.0.0.0 (1.0.0.0)
Syntax
Copy
[SerializableAttribute]
public class WoVisit : CorrigoEntityWithOptimisticLock

The WoVisit type exposes the following members.

Constructors
 NameDescription
Public methodWoVisitInitializes a new instance of the WoVisit class
Top
Properties
 NameDescription
Public propertyDocuments Visit attachments
Public propertyDtCheckin Date/time value for Check-In event in TimeZone. NULL means Visit has no Check-In event.
Public propertyDtCheckout Date/time value for Check-Out event in TimeZone. NULL means Visit has no Check-Out event.
Public propertyDtWhen Date/time value indicating when the visit operation is performed. Derived from DtCheckin or DtCheckout if not explicitly set.
Public propertyEmployeeId Technician or Provider ID linked to the Visit. Inherited from WO's primary assignee when Visit is created.
Public propertyILatitude GPS latitude of technician/provider when Check-In was executed. Range: -90 to 90.
Public propertyILongitude GPS longitude of technician/provider when Check-In was executed. Range: -180 to 180.
Public propertyIPhone Phone number used for Check-In via IVR. Max 32 characters.
Public propertyIsBad Boolean flag computed by application. True means Visit status is automatically computed as "Bad" based on IsManual, IValidated and OValidated values.
Public propertyIsManual True means Visit record was created manually by dispatcher/manager rather than via Visit Check-In/Check-Out action.
Public propertyIValidated True means presence of technician/provider was validated for Check-In event.
Public propertyIWeather Weather conditions around Check-In event. Max 512 characters. Used only for WOs with user-defined type WOSubtype.PmWeather.
Public propertyOLatitude GPS latitude of technician/provider when Check-Out was executed. Range: -90 to 90.
Public propertyOLongitude GPS longitude of technician/provider when Check-Out was executed. Range: -180 to 180.
Public propertyOPhone Phone number used for Check-Out via IVR. Max 32 characters.
Public propertyOtherComments Free-text comments provided as part of visit execution (check-in/check-out) or when Visit is created manually. Max 1024 characters.
Public propertyOValidated True means presence of technician/provider was validated for Check-Out event.
Public propertyOWeather Weather conditions around Check-Out event. Max 512 characters. Used only for WOs with user-defined type WOSubtype.PmWeather.
Public propertyPmSequenceId PM Schedule identifier (int64). For local WOs stores PM Schedule ID; for WOs received from requestor stores requestor ID (higher 4 bytes) + PM Schedule ID (lower 4 bytes).
Public propertyServices Visit services collection - defines activities performed during this Visit.
Public propertyTimeZone Time zone inherited from parent work order when Visit is created.
Public propertyVerificationId Visit verification status assigned by user. None=0, Bad=1, Good=2. Value None means Visit wasn't verified manually.
Public propertyVerifyComments Free-text comments provided as part of verification. Max 1024 characters. Required when VerificationId = Bad.
Public propertyWorkOrder Parent work order ID.
Public propertyWorkOrderId Parent work order ID.
Top
See Also