Work Management Web Services

Developer’s Guide

Welcome to the Work Management Web Services Developer’s Guide. This documentation is divided into two sections:

• The Overview section explains the key features and concepts that you need to understand before getting started with the Work Management Web Services. It includes an overview of each service, along with details of the specific programming concepts that are involved. It also contains example code that shows how to use the services.
• The Reference section contains detailed reference documentation for each service.

Document Information

Issue: 4.5

Date: April 2018

www.trimble.com/fsm

Copyright © 2018, Trimble Inc. All rights reserved. Trimble and the Globe & Triangle logo are trademarks of Trimble Inc. registered in the United States Patent and Trademark Office and other countries. TrimWeb and TrimView are trademarks of Trimble Inc. GeoManager is a service mark of Trimble Inc. All other trademarks are the property of their respective owners.

Trimble reserves the right to make changes at any time, in order to improve the reliability, function or design of its devices, products or services and to supply the best devices, products and services possible. Trimble devices, products and services are protected under one or more of the following U.S. Patents: 5,477,228; 5,694,594; 5,959,577; 5,990,827; 6,459,988; 6,529,159; 6,552,682; 6,594,576; 6,664,922; 6,578,005; 5,963,911; 6,862,524; 6,795,017; 6,882,313; 6,867,733; 6,832,140; 6,922,566 and numerous other patents and patents pending in jurisdictions worldwide. Trimble does not represent that the devices, products or services shown or described herein are free from patent infringement or from any other third party right. Trimble assumes no obligation to correct any errors contained herein or to advise any user of liability for the accuracy or correctness of any engineering software support or assistance provided to a user.

The Trimble devices, products and services are dependent on the coverage and calling areas of wireless networks owned and operated by third parties. Coverage and calling areas are approximate and may not cover significant portions of the United States. Actual coverage and operation of the devices, products and services depend on a variety of factors, including without limitation: system availability and capacity; system and equipment upgrades, repairs, maintenance, modifications and relocation; user equipment; terrain; signal strength; structural conditions; weather and atmospheric conditions; availability of power; governmental regulations; suspected fraudulent activities; acts of God and other conditions beyond the reasonable control of Trimble. Trimble will not be responsible for limits in coverage or performance degradation due to any such conditions. The user acknowledges that coverage and calling areas may be interrupted, halted or curtailed or the quality of the transmission may be diminished at any time.

The devices, products and services are dependent upon the availability of the Internet, which is owned and operated by and accessed through third parties. Trimble assumes no responsibility for improper storage of data or information, or delivery of messages. The user assumes the entire risk in downloading or otherwise accessing any data, information, files or other materials obtained from the Trimble web site, even if the user has paid for or otherwise been provided virus protection services from Trimble.

The Trimble devices, products and services and any modifications, alterations, additions or changes to the devices, products or services are not fault tolerant and are not designed, manufactured or intended for use in life support, emergency, mission-critical or other ultra-hazardous activities (“High Risk Activities”). Trimble specifically disclaims any express or implied warranty of fitness for such High Risk Activities. Use of a Trimble device, product or services in any application without the written consent of Trimble is prohibited.

All customer information is governed by the Trimble Privacy Policy located on the Trimble web site www.trimble.com/privacy.aspx

Notice of Rights. All rights reserved. No part of this manual may be reproduced or transmitted in any form by any means—electronically, mechanically, by photocopying, via recording or otherwise—without the prior written permission of Trimble Inc. For information on getting permission for reprints, contact Corporate Communications at Trimble Inc. Headquarters.

Notice of Liability. The information in this manual is distributed on an “As Is” basis, without warranty, and was current at the time of publication. While precautions have been taken in the preparation of the manual, Trimble will not have any liability to any person or entity with respect to any loss or damage caused or alleged to be caused directly or indirectly by the instructions contained in this manual or by the software or hardware products described in it.

Privacy and Use. This product is intended to monitor and make available information concerning the vehicle’s activities. It is the customer’s sole responsibility to ensure that its use complies with any applicable laws and regulations. It is the customer’s responsibility to develop and communicate policies concerning use of the application prior to implementing the product. Customers are urged to consult with their own legal counsel in connection with the particular use to which the customer puts the product and the potential implications from that use.

• Overview
• Introduction
  • About this documentation
    • Related documents
      • Work Management User Guide
      • Web Services 2.0 Developer’s Guide
      • Apache Axis2 User’s Guide
      • MSDN Library
    • About the Work Management Web Services
      • Job Management
      • Schedule Management
      • Customer Configuration
      • Employee Absence
• Installation
• Getting Started
  • Sample 1: Creating and updating a task
    • Objective:
    • Prerequisites:
    • The code:
    • Running the sample
  • Sample 2: Assigning and dispatching a task
    • Objective:
    • Prerequisites:
    • The code:
    • Running the sample
  • Sample 3: Retrieving task details
    • Objective:
    • Prerequisites:
    • The code:
    • Running the sample
  • Sample 4: Closing a task
    • Objective:
    • Prerequisites:
    • The code:
    • Running the sample
• Concepts
  • Security
  • JobManagement
    • Optimistic locking
    • Task location
      • Geofences
    • Access time restrictions
      • Examples
    • Time zones
    • Contact lists
    • Task commitments
      • commitmentDateTime
      • earliestStartDateTime
      • latestStartDateTime
    • Task completion times
    • Retrieving task details
      • Multi-day tasks
      • File attachments
    • Linking tasks
      • Follow-on tasks
      • Assistance tasks
      • Co-operation tasks
      • Dependent tasks
    • Parts
      • Parts catalogues
    • Special characters
  • ScheduleManagement
    • Assigning tasks
      • Schedule date
      • Unassigning tasks
    • Task dispatch
• Reference
  • Job Management
    • SOAP APIs
    • REST APIs
      • Parts API
        • Associating parts with a task
          • HTTP request header
          • Attributes
          • Planned parts for a task
          • Adding parts from the catalogue
          • Adding parts that have been bought
        • Retrieving the parts that are associated with specific tasks
          • HTTP request header
          • Retrieving the parts details for a single task
          • Retrieving the parts details for multiple tasks
        • Deleting the parts that are associated with a task
          • HTTP request header
          • Sample JSON response
      • Get Task Updates API
        • Retrieving a list of task updates
          • Support for crews
          • HTTP request header
          • HTTP request body
          • Sample JSON response
      • Close Incomplete API
        • HTTP request header
        • HTTP sample request body
        • Sample JSON response
      • Customer Configuration API
        • HTTP request header
        • Sample JSON response for reasons for incomplete closure
        • Sample JSON response for reasons for cancellation
        • Sample JSON response for reasons for rejection
      • Progression API
        • HTTP request header
        • HTTP sample request body
        • Sample JSON response
      • Work Order Timesheet Approval API
        • HTTP request header
        • HTTP sample request body using work order references
        • HTTP sample request body using employee identities
        • HTTP sample request body using approval times
        • Sample JSON response
      • Removing employee information from work order approvals
        • HTTP request header
        • HTTP sample request body
      • Retrieving tasks for a work order
        • HTTP request header
        • HTTP sample request body
        • Sample JSON response
  • Schedule Management
  • Field Employees
    • Field Employees API
      • Field Employees API methods
        • Attributes
      • Errors reported by the Field Employees API
      • Retrieving field employee information for two employees
        • HTTP request header
        • Sample JSON response
      • Updating the capabilities of an employee
        • HTTP request header
        • HTTP sample request body
        • Sample JSON response
      • Updating the capabilities of an employee without optimistic checking
        • HTTP request header
        • HTTP sample request body
        • Sample JSON response
      • Updating the work areas of an employee
        • HTTP request header
        • HTTP sample request body
        • Sample JSON response
      • Updating the work areas of an employee without optimistic checking
        • HTTP request header
        • HTTP sample request body
        • Sample JSON response
      • Removing all the work areas from an employee
        • HTTP request header
        • HTTP sample request body
        • Sample JSON response
      • Updating the “Work Management Settings” of an employee
        • HTTP request header
        • HTTP sample request body
        • Sample JSON response
      • Updating the ‘rollingTourSize’ of an employee
        • HTTP request header
        • HTTP sample request body
        • Sample JSON response
      • Updating ‘efficiencyFactor’ without optimistic checking
        • HTTP request header
        • HTTP sample request body
        • Sample JSON response
      • Updating ‘calloutEnabled’ for many employees without optimistic checking
        • HTTP request header
        • HTTP sample request body
        • Sample JSON response
      • Updating multiple aspects of an employee
        • HTTP request header
        • HTTP sample request body
        • Sample JSON response
      • Updating multiple aspects for multiple employees
        • HTTP request header
        • HTTP sample request body
        • Sample JSON response
      • Updating multiple work areas for multiple employees, with an error in one of the updates
        • HTTP request header
        • HTTP sample request body
        • Sample JSON response
      • Removing all work areas from an employee
        • HTTP request header
        • HTTP sample request body
        • Sample JSON response
      • Removing all work capabilities from an employee
        • HTTP request header
        • HTTP sample request body
        • Sample JSON response
  • Customer Configuration
    • Capabilities API
      • Capabilities API methods
        • Reading employee capabilities
          • HTTP request header
          • Sample XML response
          • Sample JSON response
  • Employee Absence
    • Absences API
      • Absences API methods
        • Retrieving employee absence details
          • HTTP request header
          • Request parameters
          • Retrieving the absence details for a single employee
          • Retrieving the absence details for all employees
        • Creating employee absences
          • HTTP request header
          • Attributes
          • HTTP request body
        • Deleting employee absence details
          • HTTP request header
          • Request parameters
  • Template
    • Terminology
    • Templates API methods
    • Template Data API methods
    • Request attributes
      • Template attributes
      • Rule attributes
      • Rule action attributes
      • Rule action parameter attributes
      • Node attributes
      • Field attributes
      • Field option attributes
      • Content block attributes
    • Creating a template
      • HTTP request header
      • HTTP sample request body
      • Examples of different input types
        • Creating a text box
        • Creating a drop-down list
        • Creating a date selector
        • Creating a task closure template
    • Posting template data
      • HTTP request header
      • HTTP sample request body