PRUVAN SUPPORT CENTER

Follow

Get Work Orders Reference

See also: Get Work Orders Service

Work Orders (Projects)

Type=DataType, Req=Required on Create, UI=User Interface may Update, Int=Integration may Update

Data Element

Type

Req

UI

Int

Default

Description

workOrderNumber

 

Y

N

Y

 

Work Order/Project Number; this will be displayed in Pruvan as “{client code}::workOrderNumber”.  Also known as Project Name.  Can be text, numeric, or alpha numeric.  Integration updates to a Project do not require all elements, however, to update a workOrderNumber/Project Name it must exist in the active Project table.

workOrderInfo

 

N

Y

Y

 

Work Order information that is displayed on the work order details screen on Pruvan Mobile.  Useful for lockbox codes etc.

address1

 

Y

N

Y

 

Address line 1, required on create

address2

 

N

N

Y

 

Address line 2

city

 

Y

N

Y

 

City, required on create

state

 

Y

N

Y

 

State, required on create

zip

 

Y

N

Y

 

Zip, required on create

country

 

N

N

Y

 

Country

assignedTo

 

N

Y

Y*

 

Pruvan subuser to assign to.  To assign to all subusers on an account set assignedTo: “~all~”.  *Internal integrations can directly update, external integrations can indirectly update if default assignTo is set- read more about Pruvan Integration Types. 

status

 

N

Y*

Y**

Un-assigned

Pruvan status.  *Internal integrations can directly update, external integrations can indirectly update - see Pruvan Integration Types below. **If Auto-Admin = OFF not updateable, integrations can always update clientStatus.

dueDate

 

N

Y*

Y**

Today

Field due date.  *Internal integrations can directly update, external integrations can indirectly update - see Pruvan Integration Types below.  See more info in the Date Fields section. **If Auto-Admin = OFF not updateable, integrations can always update clientDueDate.

instructions

 

N

Y*

Y**

 

Instructions for the field - viewable on device.  These are displayed as ‘webviews’.  This field can contain light HTML formatting to include:  headers, text styling (bold, etc), line breaks, href links, etc.  An example of what won’t work is embedded video.  *Internal integrations can directly update, external integrations can indirectly update - see Pruvan Integration Types below.  **If Auto-Admin = OFF not updateable, integrations can always update clientInstructions.

clientStatus

 

N

Y

Y

 

Client order status – see status mapping.  Should always be updated by integration to current order status. Updates will overwrite User edits.

clientDueDate

 

N

Y

Y

 

Client due date.  See more info in the Date Fields section. Should always be updated by integration to current order status. Updates will overwrite User edits.

clientInstructions

 

N

Y

Y

 

Client instructions. Should always be updated by integration to current order status.  Updates will overwrite User edits.

description

 

N

Y

Y**

 

Description; only viewable in Pruvan Online Project Management tab – **cannot be updated by integrations if Auto-Admin=OFF.

reference

 

N

Y*

Y

 

Reference; only viewable in Pruvan Online Project Management tab.  *Internal integrations can directly update, external integrations can indirectly update - see Pruvan Integration Types below.

attribute7-15

 

N

N

Y

 

Optional workorder/Project attributes for integration owner.  Returned with each item sent to Order Source.

gpsLatitude /
gpsLongitude

 

N

N

 

GPS Lat/Long are used to specify the property address.  If not provided Pruvan will geo-locate the address.  Both Lat/Long must be present and valid.

options

 

N

Y*

Y

 

A JSON string for Mobile Configuration Options set at the Work Order level.  See options section for details.  *Can only be changed by User if not an integrated order.

startDate

 

N

Y

Y

 

Setting a startDate will prevent the project from opening on Pruvan Mobile before the startDate.  Will appear on Pruvan Mobile as "Upcoming".  See Date Fields section for managing dates.

source_wo_id

 

N

N

 Y

 

The work order ID as determined by the source work order provider

source_wo_number

 

N

N

 Y

 

The work order number as determined by the source work order provider

source_wo_provider

 

N

N

 

The (ultimate) source work order provider (the Tier one provider)

services

 

Y

N*

 

An object containing the work order’s services; at least one service/task is required on create.  Services are not required for updates.  If services are included on an update ALL of the services must be included.  Missing services will be deleted.  *UI Users must delete a service/Task in UI to recreate a new service/Task.

 

Services (Tasks)

Type=DataType, Req=Required on Create, UI=User Interface may Update, Int=Integration may Update

Data Element

Type

Req

UI

Int

Default

Description

serviceName

 

Y

N*

Y

  Service/Task name, can not be duplicated on same Order/Project.  Must have a minimum of one serviceName/Task.  *UI User must delete Task in Pruvan UI and recreate a Task to change Task name.  

survey

 

N

N*

Y

 

Survey template ID, if just the templateID is given it will pull the latest published template from the local Pruvan account. If a version number is passed it will load that specific version of the template (must be published). To load a survey from a separate account use this format:“{master_username}::templateID”. *User must delete Task in Pruvan UI and recreate Task to change survey.  

surveyDynamic

 

N

N

Y

 

This allows for modifications to Survey template ID, or if Survey template ID is null, may contain the entire Survey in JSON format.  See related SurveyDynamic documentation.

 instructions

 

 N

 Y

 Y*

 

Task Instructions; visible on the device.  These are displayed as ‘webviews’, see instructions for the work order level. *Integration can only update if Auto-Admin=OFF

options

 

N

Y*

Y

EvidenceType is defaulted to before, during, after if not set

A JSON string for Mobile Configuration Options set at the Service level. See options section for details. *User can update options via UI if not an integrated order.

source_service   N N Y   The service as determined by the source work order provider
source_service_id   N N Y   The service ID as determined by the source work order provider
attribute1-15   N N Y   Optional service/task level attributes for integration owner. Returned with each item sent to Order Source.
price   N N Y   Price for Task serviceName
quantity   N N Y   Quantity for Task serviceName

 

Note:  Spelling of all elements is case sensitive and must match exactly to be recognized.

See also: Get Work Orders Service

 

 

 

 

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments