API Reference

Completes a visit raised through Total Mobile.

patch
https://{tenant}.rubixx.app/api/v3/totalmobile/workorders/visits/complete

VisitExternalID is the identifier the caller supplied when the visit was created.

VisitResult must exactly match the description of one of the visit results configured for the tenant.
The permitted values are per-tenant configuration rather than a fixed list; obtain the set for a given client
from Rubixx.

VisitComments is optional and is appended to the notes on the visit.

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 complete a visit it previously raised.

string
required
length ≥ 1

The identifier supplied when the visit was created, published on the wire as VisitExternalID.

string | null

Optional comments to append to the notes on the visit.

string
required
length ≥ 1

The outcome of the visit. Must exactly match the description of one of the visit results configured for the
tenant. The permitted values are per-tenant configuration rather than a fixed list, so obtain the set for a
given client from Rubixx.

Responses

Updated about 2 hours ago

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

Updated about 2 hours ago

Did this page help you?