Newer Version Available

This content describes an older version of this product. View Latest

Visit

Represents a visit to inspect, assess compliance, or assess an applicant’s ability to get a license or permit or inspect. This object is available in API version 47.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Fields

Field Details
AccountID
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The account that is associated with a visit. This field is available in API versions 48.0 and later.
ActualVisitEndTime
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The date and time when the visit ended.
ActualVisitStartTime
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The date and time when the visit started.
ContextId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The purpose of a visit, such as business license application, or complaint. This field is available in API versions 48.0 and later.
InstructionDescription
Type
textarea
Properties
Create, Filter, Nillable, Sort, Update
Description
Special instructions provided by a compliance manager or an administrator.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The most recent date on which a user referenced this record.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The most recent date on which a user viewed this record.
Name
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
Unique identifier for the visit record.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
ID of the visit record owner.
PlaceId
Type
reference
Properties
Create, Filter, Group, Sort, Update
Description
ID of the place that inspector visits.
PlannedVisitEndTime
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The date and time when the visit is expected to end.
PlannedVisitStartTime
Type
dateTime
Properties
Create, Filter, Sort, Update
Description
The date and time when the visit is expected to start.
Status
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update
Description
The status of the visit.
Possible values are:
  • Abandoned
  • Completed
  • InProgress
  • Planned
StatusRemarks
Type
textarea
Properties
Create, Filter, Nillable, Sort, Update
Description
The reasons for abandoning or completing the visit as provided by the inspector.
VisitPriority
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The priority of the visit.
Possible values are:
  • High
  • Low
  • Medium
VisitorId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
ID of the inspector visiting the store.

Associated Objects

This object has the following associated objects. Unless noted, they are available in the same API version as this object.

VisitFeed
Feed tracking is available for the object.