Creates a work order from a Total Mobile job.

Several values are transformed before the work order is created, and some field names do not mean what they
appear to:

  • PropertyID is a UPRN. Where the tenant has configured a Total Mobile UPRN prefix, that prefix is
    stripped from the front of the value when present. Leading zeros are then trimmed. The remainder is matched
    against the property UPRN.
  • Contract, Supplier and Priority are each passed through the corresponding translation
    table for the tenant where one is configured, and used verbatim where one is not. Supplier is the
    contractor.
  • Description populates both the title and the description of the work order.
  • RaisedDateUTC sets both the date reported and the date logged.
  • TargetCompletionDate is optional. When it is omitted the target date is derived from the day count
    and working-day flag of the resolved priority.
  • Status is mapped: New, Planned and Work in Progress each become Open; Cancelled becomes Cancelled;
    Work Completed becomes Work Completed; On Hold becomes On Hold; Invoiced becomes Paid; and Financially
    Completed becomes Financially Complete. Any other value is passed through unchanged and then matched,
    ignoring case, against the Rubixx work order statuses; a value matching neither list fails validation.
    Omitting the field is valid.
  • OrderNumber becomes the work order reference. It is the key the other four endpoints use to find the
    work order, so the caller must retain it.
  • OrderContactName and OrderContactPhone are accepted but are not currently persisted.
  • The job value always defaults to 0.

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 Work Order Create permission.

Required Permission(s): WorkOrder.Create

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

A job pushed into Rubixx by Total Mobile, in Total Mobile's own field names and value set.

string
required
length ≥ 1

The UPRN of the property the work order is raised against. Where a Total Mobile UPRN prefix is configured for
the tenant, that prefix is stripped from the front of this value when present, and leading zeros are then
trimmed, before the property is matched.

string
required
length ≥ 1

The contract the work order is raised under. Passed through the contract translation table for the tenant
where one is configured, and used verbatim where one is not.

string
required
length ≥ 1

The contractor the work order is assigned to, published on the wire as Supplier. Passed through the
contractor translation table for the tenant where one is configured, and used verbatim where one is not.

string
required
length ≥ 1

The priority of the work order. Passed through the priority translation table for the tenant where one is
configured, and used verbatim where one is not. Also determines the target date when
RubixxHousing.API.Versions.V3.Dtos.WorkOrders.Actions.CreateWorkOrderTMFormatDto.TargetCompletionDate is omitted.

string | null

The description of the work required. Populates both the title and the description of the work order.

date-time | null

The date and time the job was raised in Total Mobile. Sets both the date reported and the date logged on the
work order.

date-time | null

The date and time the work order is due to be completed by. Optional - when it is omitted the target date is
derived from the day count and working-day flag of the resolved priority.

date-time | null

The date and time the work was completed, where the job has already been completed by the time it reaches
Rubixx.

string | null

The Total Mobile status of the job, mapped onto a Rubixx work order status: New, Planned and Work in Progress
each become Open; Cancelled becomes Cancelled; Work Completed becomes Work Completed; On Hold becomes On
Hold; Invoiced becomes Paid; and Financially Completed becomes Financially Complete. Any other value is
passed through unchanged and then matched, ignoring case, against the Rubixx work order statuses, so values
such as Approved or Awaiting Dispatch are accepted too; a value matching neither list fails validation.
Optional - omitting it leaves the status to be derived from whether a completion date was supplied.

string | null

The Total Mobile order number, which becomes the work order reference. It is the key the complete and visit
endpoints use to find the work order, so the caller must retain it.

string | null

The name of the contact for the job. Accepted but not currently persisted.

string | null

The telephone number of the contact for the job. Accepted but not currently persisted.

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