Difference between revisions of "Main Page"

Revision as of 11:05, 28 April 2020

Welcome to the MyMobileWorkers API documentation. This wiki is set up to guide developers through integrating with MyMobileWorkers.

The API uses JSON to transfer data. JSON is widely supported and most programming languages have built-in or comprehensive support with the use of a plugin.

You will need an API key, which can be obtained from the Settings section of the web portal.

Getting Started

• Connecting to the API
• API Authentication
• Versioning
• Errors
• Timezones
• Datetime Formats
• List of Job Statuses
• Job Process Information
• Examples
  • PHP
  • Java

API Calls

• Jobs
  • Get Job By Job Number
  • Get Jobs By Activity Status
  • Get Jobs By Current Status
  • Get Job Updates Since
  • Get Job Updates Between
  • Get Photos Added Since
  • Get Job Signatures (deprecated)
  • Create Jobs
  • Delete Job
  • Delete Jobs
  • Create Job Items
  • Delete Job Items
  • Create Job Parts
  • Get Job PDF
  • Email Job PDF
  • Setting the status of a job
  • Link jobs
  • Update PO Number & Invoice Number
  • Update PO Number & Invoice Number - status specific
  • Create Job Tracking Reference

• Assets
  • Create Assets
  • Get Asset By Serial Number
  • Get Assets Updated Since
  • Get Assets Assigned To Customer
  • Get Assets By Item Category
  • Get Asset History By Serial Number
  • Get Asset Statuses

• Items
  • Create Items
  • Get All Items
  • Get Item By Name
  • Delete Item By Name
  • Create Items by External Id
  • Get Item by External Id
  • Delete Item By External Id

• Categories
  • Create Category
  • Delete Category By Name
  • Delete Category By External Id
  • Get Categories

• Catalogue
  • Delete Entire Catalogue

• Custom Lists
  • Get All Custom Lists
  • Get Custom List By List Key
  • Update Custom List
  • Create Custom List Item
  • Delete Custom List Item By Name
  • Delete Custom List Item By External Id

• Mobile Users
  • Create Mobileuser
  • Get Mobile Users
  • Get latest vehicle assignment by date and mobile user
  • Get Mobile User Location
  • Get Mobile User Logs
• Companies
  • Get Company
  • Create Company Attachment Folders
• Customers
  • Add Customer
  • Update Customer Name
  • Create Customer Sites
• Routes
  • Get jobs assigned to route
  • Get total weight of route
  • Get route limit
  • Get all routes
• Attachments
  • Create Job Attachment
  • Delete Job Attachment
  • Create Company Attachment
• Invoices
  • Get Invoices Updated Since
  • Get Invoices Updated Between
  • Get Invoices Created Since
  • Get Invoices Created Between
• Forms
  • Get Form By Name and Username
  • Get Form By Name
• Vehicle Checks
  • Get Vehicle Checks By Registration
  • Get Vehicle Checks By Status

• ApiKey
  • Check Key