Contents

• Title and Copyright Information
• Preface

1 Introduction

• Document Purpose
• Scope of the Document
• Target Audience
• Accessing the APIs
• Glossary

2 Inbound API Overview

• Inbound Interface Overview
  • Incremental Upload
    • Activity-related Commands
    • Inventory-related Commands
  • Full Upload
    • Full Activity Upload
    • Full Inventory Upload

3 Implementation Guidelines

• Implementation Guidelines
  • Send Multiple Commands Per Incremental Upload

4 Inbound API Structures

• Inbound API Structures
  • Properties, Files, and Fields
    • Key Fields
      • Activity Key Fields
    • Inventory Key Fields
    • Duplicating Properties
    • Property Visibility
    • Property Type
    • ‘property’ Structure
    • ‘file’ Structure
  • Inventory
    • ‘inventory’ Structure
  • Activities
    • Activity Types
    • Activity Statuses
    • Ignored and Duplicating Activities
    • Activity Status and Incremental Upload
    • 'action_if_completed' Meanings
    • ‘appointment’ Structure
    • ‘links’ Structure
    • ‘preference’ Structure
    • ‘required_inventories’ Structure

5 Detailed Commands Description

• Command List
• Activity-related Command Actions
  • Finding an Existing Activity
  • Determining if the Activity is to be Moved or Rescheduled
  • Ordering Activities in the Route
  • Updating/Replacing Properties
    • Updating Fields Changed in Core Manage and Mobility
  • Updating Activity Inventory
    • Activity Inventory Validation
    • Updating Validated Inventory
  • Canceling/Deleting Activities
• Peculiarities of Activity Processing
  • Canceling a Non-scheduled Activity
  • Deleting a Non-scheduled Activity
  • Updating Activity Assigned to a Non-Working Resource
• Activity-related Command Details
  • 'start_activity' Command
  • 'complete_activity' Command
  • 'notdone_activity' Command
  • 'suspend_activity' Command
  • 'update_activity' Command
  • 'cancel_activity' Command
  • 'delete_activity' Command
• Inventory-related Commands
  • ‘set_inventory’ Command
  • 'update_inventory' Command
  • ‘delete_inventory’ Command

6 'inbound_interface_request' Method Description

• 'inbound_interface_request' Method Description
  • Method Workflow
    • Incremental Upload Workflow
    • Full Upload Workflow
  • 'inbound_interface_request' Request
    • User Authentication Structure
      • Authentication
    • ‘head’ Node
    • 'data' Node
      • Incremental Upload ‘data’ Node
      • Full Upload ‘data’ Node
  • 'inbound_interface_request' Response
  • 'inbound_interface_request' Response 'data' Node
    • ‘report’ Node

7 Previous Versions

• Previous Versions

8 Appendix A

• Appendix A – List of Error and Warning Messages