Creates a visit against a work order raised through Total Mobile.

PrimaryOrderNumber is matched against the work order reference, which is the OrderNumber
supplied when the work order was created.

VisitExternalID is supplied by the caller rather than by Rubixx, and must be unique across every
visit. It is the key the complete and cancel endpoints use to find the visit, so the caller must retain it.

The visit type is taken from the Total Mobile visit type configured for the tenant, which has to be set in
the Marketplace before this endpoint can be used.

OperativeName is stored as the visit note. The visit itself is attributed to the Unknown user rather
than to the named operative, because Total Mobile operatives do not map onto Rubixx users.

Dates may be supplied either as ISO 8601 or as dd/MM/yyyy HH:mm, and are read as UTC. Dates on the response
are returned as ISO 8601.

Requires the Manage Visits permission.

Required Permission(s): Misc.ManageVisits

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

A request from Total Mobile to raise a visit against a work order it previously created.

string
required
length ≥ 1

The name of the Total Mobile operative attending. Stored as the visit note - the visit itself is attributed
to the Unknown user, because Total Mobile operatives do not map onto Rubixx users.

string
required
length ≥ 1

An identifier for the visit, supplied by the caller rather than by Rubixx and published on the wire as
VisitExternalID. Must be unique across every visit. It is the key the complete and cancel endpoints
use to find the visit, so the caller must retain it.

string
required
length ≥ 1

The reference of the work order the visit belongs to. This is the OrderNumber supplied when the work
order was created.

date-time
required

The date and time the visit is planned to start.

Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json