Setting the status of a job - Revision history

Paul: new url

2016-10-21T09:19:21Z

new url

Ian: /* Valid status transitions */

2016-08-09T10:03:09Z

‎Valid status transitions

Ryanmt: /* Valid status transitions */

2016-08-09T10:01:42Z

‎Valid status transitions

Ian at 09:58, 9 August 2016

2016-08-09T09:58:42Z

Ian at 09:58, 9 August 2016

2016-08-09T09:58:01Z

Ian at 09:57, 9 August 2016

2016-08-09T09:57:03Z

Ian at 09:55, 9 August 2016

2016-08-09T09:55:51Z

Ian at 09:54, 9 August 2016

2016-08-09T09:54:04Z

Ian at 09:53, 9 August 2016

2016-08-09T09:53:33Z

Ian: /* Valid status transitions */

2016-08-09T09:52:27Z

‎Valid status transitions

@@ Line 67: / Line 67: @@
 == Example curl request ==
-curl -X POST "<nowiki>https://live.mymobileworkers.com:8181/api/1/jobs/job/status/update?api_key=APIKEY&job_number=JOB_NUMBER&status=JOB_COMPLETED</nowiki>"
+curl -X POST "<nowiki>https://api.mymobileworkers.com:8181/api/1/jobs/job/status/update?api_key=APIKEY&job_number=JOB_NUMBER&status=JOB_COMPLETED</nowiki>"
-curl -X POST "<nowiki>https://live.mymobileworkers.com:8181/api/1/jobs/job/status/update?api_key=APIKEY&job_number=JOB_NUMBER&status=JOB_FAILED</nowiki>"
+curl -X POST "<nowiki>https://api.mymobileworkers.com:8181/api/1/jobs/job/status/update?api_key=APIKEY&job_number=JOB_NUMBER&status=JOB_FAILED</nowiki>"

@@ Line 42: / Line 42: @@
 ! NEW
 | colspan="2" | CUSTOM_COMPLETED_TYPE
 |-
 ! JOB_COMPLETED

@@ Line 53: / Line 53: @@
 |-
 |}
 == Example success response ==

@@ Line 58: / Line 58: @@
 == Example failure response ==
-<source lang="java"></source>
+<source lang="java">{"failed":[{"job_number":"123456","errors":[{"error_code":"STA001","error_message":"Invalid job status specified"}]}]}</source>
 == Example curl request ==

@@ Line 55: / Line 55: @@
 == Example success response ==
-<source lang="java"></source>
+<source lang="java">{"successful":[{"job_number":"123456"}]}</source>
 == Example failure response ==

@@ Line 1: / Line 1: @@
 == Summary ==
 {| border="1" class="wikitable"
@@ Line 25: / Line 27: @@
 == Valid status transitions ==

@@ Line 26: / Line 26: @@
 The status of a job can be changed remotely by placing requests against the API.
-Please refer to the [[List_of_Job_Statuses]] when placing an API call. In addition if your My Mobile Workers account defines any custom statuses then the API can also be used to update jobs with these.
-−
-In order to make a valid API request it must contain the following parameters
-−
-. A MyMobileWorkers web API key
-. The job number that you wish to update the status of
-. The status you with to update the job to
-−
-The curl tool can be used to place requests against the API in order to test connectivity to the API.
-Please substitute within the call <<YOUR_WEB_API_KEY>> and <<YOUR_JOB_NUMBER>> with values from your portal account
-−
-curl -X POST "<nowiki>https://live.mymobileworkers.com:8181/api/1/jobs/job/status/update?api_key=<<YOUR_WEB_API_KEY>>&job_number=<<YOUR_JOB_NUMBER>>&status=JOB_COMPLETED</nowiki>"
-−
-The above request will transition the status of a job to JOB_COMPLETED if the job presently has the status NEW.
-−
-Within the MyMobileWorkers system statuses have a status type. The type of a status dictates which status changes can be made through the API.
-−
-NEW -> JOB_COMPLETED type completed
-NEW -> JOB_FAILED type completed
-−
-JOB_COMPLETED -> JOB_FAILED
-JOB_FAILED -> JOB_COMPLETED
-−
-NEW -> custom completed type
-−
-custom completed type -> custom completed type
-−
 == Valid status transitions ==
 {| border="1" class="wikitable"

@@ Line 74: / Line 74: @@
 | colspan="2" | JOB_COMPLETED
 |-
-! CUSTOM_COMPLETED_TYPE | CUSTOM_COMPLETED_TYPE
+! CUSTOM_COMPLETED_TYPE
-| colspan="2" | JOB_COMPLETED
+| colspan="2" | CUSTOM_COMPLETED_TYPE
 |-
 |}