WoVisit

Property NameProperty ValueProperty Description
WorkOrderIdIntegerParent work order ID.
WorkOrder{WorkOrder entity reference}Parent work order ID.
DtWhenDateTimeDate/time value indicating when the visit operation is performed. Derived from DtCheckin or DtCheckout if not explicitly set.
VerifyCommentsStringFree-text comments provided as part of verification. Max 1024 characters. Required when VerificationId = Bad.
OtherCommentsStringFree-text comments provided as part of visit execution (check-in/check-out) or when Visit is created manually. Max 1024 characters.
PmSequenceIdIntegerPM 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).
IsBadBooleanBoolean flag computed by application. True means Visit status is automatically computed as "Bad" based on IsManual, IValidated and OValidated values.
IsManualBooleanTrue means Visit record was created manually by dispatcher/manager rather than via Visit Check-In/Check-Out action.
VerificationIdVisitStatus enumeration memberVisit verification status assigned by user. None=0, Bad=1, Good=2. Value None means Visit wasn't verified manually.
EmployeeIdIntegerTechnician or Provider ID linked to the Visit. Inherited from WO's primary assignee when Visit is created.
TimeZoneIntegerTime zone inherited from parent work order when Visit is created.
DtCheckinDateTime or NULLDate/time value for Check-In event in TimeZone. NULL means Visit has no Check-In event.
IPhoneStringPhone number used for Check-In via IVR. Max 32 characters.
ILatitudeDecimalGPS latitude of technician/provider when Check-In was executed. Range: -90 to 90.
ILongitudeDecimalGPS longitude of technician/provider when Check-In was executed. Range: -180 to 180.
IValidatedBooleanTrue means presence of technician/provider was validated for Check-In event.
IWeatherStringWeather conditions around Check-In event. Max 512 characters. Used only for WOs with user-defined type WOSubtype.PmWeather.
DtCheckoutDateTime or NULLDate/time value for Check-Out event in TimeZone. NULL means Visit has no Check-Out event.
OPhoneStringPhone number used for Check-Out via IVR. Max 32 characters.
OLatitudeDecimalGPS latitude of technician/provider when Check-Out was executed. Range: -90 to 90.
OLongitudeDecimalGPS longitude of technician/provider when Check-Out was executed. Range: -180 to 180.
OValidatedBooleanTrue means presence of technician/provider was validated for Check-Out event.
OWeatherStringWeather conditions around Check-Out event. Max 512 characters. Used only for WOs with user-defined type WOSubtype.PmWeather.
Documents[{Document entity reference}, ...]Visit attachments
Services[{WoVisitSvc entity reference}, ...]Visit services collection - defines activities performed during this Visit.
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.
Properties[{PropertyTreeNode object reference}, ...]List of filled properties
LimitMultipleEntitiesNumberBehaviourBooleanReturn exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API