Web Services & API Documentation

  • Updated

The attached Web Services Documentation provides a comprehensive guide to interacting with the BigChange/JobWatch API, detailing various web services essential for managing jobs, contacts, contracts, tracking, stock, routes, assets, resources, and financial operations within the BigChange system.

Key Sections:

  1. Introduction:
    • Describes how to build API URLs.
    • Provides authentication details.
  2. Contact Services:
    • Adding, editing, deleting, and retrieving contact details.
    • Managing contact groups and their respective notes.
  3. Job Services:
    • Procedures for adding, editing, scheduling, and cancelling jobs.
    • Retrieving job details and handling job groups.
  4. Contract Services:
    • Methods for managing contracts, including creating, editing, and retrieving contract details and financial lines.
  5. Tracking Services:
    • Real-time tracking of resources and mobile assets.
    • Retrieving journey data and odometer readings.
  6. Stock Services:
    • Managing stock items, quantities, and associated job stock.
    • Adding and editing stock reorder levels and movements.
  7. Routes Services:
    • Listing and saving routes.
  8. Asset Services:
    • Procedures for adding, editing, and associating assets with resources.
    • Managing asset groups, types, and defects.
  9. Resource Services:
    • Adding and managing resource information and skills.
    • Handling resource absences and working hours.
  10. Financial Services:
    • Managing job financial lines, payments, and predefined invoicing items.
    • Handling financial documents like invoices, purchase orders, and credit notes.
  11. Cross Service Functions:
    • Listing and managing tags for jobs and contact notes.

The attached document serves as a technical reference for developers integrating with the BigChange system, ensuring efficient management of various operations through well-documented API endpoints.

Was this article helpful?

0 out of 0 found this helpful

Comments

0 comments

Article is closed for comments.