Difference between revisions of "Main Page"
From MyMobileWorkers API
(→Getting Started) |
|||
| (28 intermediate revisions by 6 users not shown) | |||
| Line 1: | Line 1: | ||
| − | [[File: | + | [[File:MMW_Logo_Stacked.png]] |
| + | 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 === | === Getting Started === | ||
| Line 14: | Line 12: | ||
*[[Versioning]] | *[[Versioning]] | ||
*[[Errors]] | *[[Errors]] | ||
| + | *[[Timezones]] | ||
*[[Datetime Formats]] | *[[Datetime Formats]] | ||
*[[List of Job Statuses]] | *[[List of Job Statuses]] | ||
| Line 25: | Line 24: | ||
*Jobs | *Jobs | ||
** [[Get Job By Job Number]] | ** [[Get Job By Job Number]] | ||
| − | ** [[Get Jobs By Status]] | + | ** [[Get Jobs By Activity Status]] |
| + | ** [[Get Jobs By Current Status]] | ||
** [[Get Job Updates Since]] | ** [[Get Job Updates Since]] | ||
** [[Get Job Updates Between]] | ** [[Get Job Updates Between]] | ||
** [[Get Photos Added Since]] | ** [[Get Photos Added Since]] | ||
| − | ** [[Get Job Signatures]] | + | ** [[Get Job Signatures]] (deprecated) |
** [[Create Jobs]] | ** [[Create Jobs]] | ||
** [[Delete Job]] | ** [[Delete Job]] | ||
** [[Delete Jobs]] | ** [[Delete Jobs]] | ||
** [[Create Job Items]] | ** [[Create Job Items]] | ||
| + | ** [[Delete Job Items]] | ||
** [[Create Job Parts]] | ** [[Create Job Parts]] | ||
** [[Get Job PDF]] | ** [[Get Job PDF]] | ||
** [[Email 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 | *Assets | ||
| Line 52: | Line 58: | ||
** [[Get Item By Name]] | ** [[Get Item By Name]] | ||
** [[Delete Item By Name]] | ** [[Delete Item By Name]] | ||
| + | ** [[Create Items by External Id]] | ||
** [[Get Item by External Id]] | ** [[Get Item by External Id]] | ||
** [[Delete Item By External Id]] | ** [[Delete Item By External Id]] | ||
| Line 63: | Line 70: | ||
*Catalogue | *Catalogue | ||
** [[Delete Entire 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 | *Mobile Users | ||
| + | ** [[Create Mobileuser]] | ||
** [[Get Mobile Users]] | ** [[Get Mobile Users]] | ||
** [[Get latest vehicle assignment by date and mobile user]] | ** [[Get latest vehicle assignment by date and mobile user]] | ||
** [[Get Mobile User Location]] | ** [[Get Mobile User Location]] | ||
| + | ** [[Get Mobile User Logs]] | ||
*Companies | *Companies | ||
** [[Get Company]] | ** [[Get Company]] | ||
| + | ** [[Create Company Attachment Folders]] | ||
*Customers | *Customers | ||
** [[Add Customer]] | ** [[Add Customer]] | ||
** [[Update Customer Name]] | ** [[Update Customer Name]] | ||
| − | ** [[Create Customer | + | ** [[Create Customer Sites]] |
*Routes | *Routes | ||
** [[Get jobs assigned to route]] | ** [[Get jobs assigned to route]] | ||
| Line 85: | Line 103: | ||
*Invoices | *Invoices | ||
**[[Get Invoices Updated Since]] | **[[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 | * ApiKey | ||
**[[Check Key]] | **[[Check Key]] | ||
Latest revision as of 16:22, 29 September 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.
[edit] Getting Started
- Connecting to the API
- API Authentication
- Versioning
- Errors
- Timezones
- Datetime Formats
- List of Job Statuses
- Job Process Information
- Examples
[edit] 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
- Items
- Catalogue
- Custom Lists
- Mobile Users
- Companies
- Customers
- Routes
- Attachments
- Invoices
- Forms
- Vehicle Checks
- ApiKey
