Difference between revisions of "Setting the status of a job"
From MyMobileWorkers API
(→Valid status transitions) |
|||
| Line 26: | Line 26: | ||
The status of a job can be changed remotely by placing requests against the API. | The status of a job can be changed remotely by placing requests against the API. | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
== Valid status transitions == | == Valid status transitions == | ||
{| border="1" class="wikitable" | {| border="1" class="wikitable" | ||
Revision as of 09:53, 9 August 2016
Summary
| Update job status | ||
|---|---|---|
| URL | https://:base_url/:api_path/:version/jobs//job/status/update?api_key=YOUR_KEY&&job_number=JOB_NUMBER&status=JOB_STATUS | |
| Type | POST | |
| Params: | api_key | required |
| job_number | required | |
| status | required | |
| Response | JSON | |
The status of a job can be changed remotely by placing requests against the API.
Valid status transitions
| Current status | Possible status | |
|---|---|---|
| NEW | JOB_COMPLETED | |
| NEW | JOB_FAILED | |
| NEW | CUSTOM_COMPLETED_TYPE | |
| JOB_COMPLETED | JOB_FAILED | |
| JOB_FAILED | JOB_COMPLETED | |
| CUSTOM_COMPLETED_TYPE | CUSTOM_COMPLETED_TYPE | |
Example curl request
curl -X POST "https://live.mymobileworkers.com:8181/api/1/jobs/job/status/update?api_key=APIKEY&job_number=JOB_NUMBER&status=JOB_COMPLETED"
curl -X POST "https://live.mymobileworkers.com:8181/api/1/jobs/job/status/update?api_key=APIKEY&job_number=JOB_NUMBER&status=JOB_FAILED"
