Get Job PDF - Revision history

Paul: /* Usage / Caching */

2016-12-06T15:54:23Z

‎Usage / Caching

2016-12-06T15:53:37Z

‎Summary

2016-12-06T15:52:31Z

Clarification

2016-12-06T15:49:26Z

more likley example

2016-12-06T15:35:11Z

Updated available flags

2016-11-24T16:13:14Z

‎Get Job PDF

2016-11-14T12:35:48Z

‎Get Job PDF

2016-01-19T18:41:30Z

2014-02-17T11:39:08Z

2014-01-14T16:29:36Z

‎Default : export_name="default_job"

@@ Line 50: / Line 50: @@
 == Usage / Caching ==
-Requesting PDFs via this tool can sometimes take an extended period to generate, its suggested that any PDFs generated are not streamed directly to your end users but saved on your server for downloading.
+Requesting PDFs via this tool can sometimes take an extended period to generate. It is suggested that any PDFs generated are not streamed directly to your end users but saved on your server for downloading.
 == Header / Footer ==

@@ Line 30: / Line 30: @@
+!
 | export_name || not required
 |-
 ! Response

@@ Line 1: / Line 1: @@
 === Get Job PDF ===
-The MyMobileWorkers web portal provides a tool for exporting PDFs from the job data, In some integration cases it may be easier to pull the completed job down in PDF format over importing the data into your database. This page provides a way to remotely download the same PDF's the portal generates using your api key as authentication rather than having to log into via the web.
+The MyMobileWorkers web portal provides a tool for exporting PDFs from the job data. In some integration cases it may be easier to pull the completed job down in PDF format than importing the data into your database. This call provides a way to remotely download the same PDFs the portal generates using your API key as authentication rather than having to log in via the web. Note however that options which may default to on on the portal likely default to off via the API.
-'''The tool provided to do this is part of the web portal and not the api, as such the URL is slightly different.'''
+'''The tool provided to do this is part of the web portal and not the api server, as such the URL is slightly different.'''
      https://live.mymobileworkers.com/api/
-Its coding style is similar to API and returns the same set of error codes.
+The coding style is similar to the main API and returns the same set of error codes.
 == Summary ==

@@ Line 68: / Line 68: @@
 Use a value of 1 for true (show the item) or 0 for false (do not show the item)
-'''''Note: when sending get parameters use the boolean value not the string, so send '0' for false and not the string 'false''''''
+'''''Note: when sending get parameters use the boolean value not the string, so send '1' for true and not the string 'true''''''
 {| border="1" class="wikitable"å
 |-

@@ Line 66: / Line 66: @@
 Below is a list of optional extra GET parameters which are related specifically to this export type
-'''''Note: when sending get params use the boolean value not the string, send '0' for false and not the string 'false'''''
+'''''Note: when sending get parameters use the boolean value not the string, so send '0' for false and not the string 'false''''''
 {| border="1" class="wikitable"å
 |-
@@ Line 75: / Line 76: @@
 |-
 ! show_notes
-| true (1)
+| 0 (false)
 | Displays job notes
 |-
 ! show_photos
-| true (1)
+| 0 (false)
 | Displays job photos
 |-
 ! show_times
-| false (0)
+| 0 (false)
 | Display created at/updated at timestamps
 |-
 ! show_elements
-| false (0)
+| 0 (false)
 | Display items / parts / assets
 |-
 ! show_pre_checks
-| false (0)
+| 0 (false)
 | Displays pre job check results
 |-
 ! show_post_checks
-| false (0)
+| 0 (false)
 | Displays post job check results
 |-
 ! show_advanced
-| false (0)
+| 0 (false)
-| Show Repair information (Repair jobs only)
+| Displays Repair information (Repair jobs only)
 |-
 ! show_activities
-| false (0)
+| 0 (false)
 | Displays job activities
 |-
 ! show_vehicle_reg
-| false (0)
+| 0 (false)
 | Displays vehicle used (only if vehicles feature is installed)
 |-
 |}

@@ Line 5: / Line 5: @@
 '''The tool provided to do this is part of the web portal and not the api, as such the URL is slightly different.'''
-     http://live.mymobileworkers.com/api/
+     https://live.mymobileworkers.com/api/
 Its coding style is similar to API and returns the same set of error codes.
@@ Line 16: / Line 16: @@
 |-
 ! URL
-| colspan="2" | http://:base_url/api/job_export?api_key=YOUR_KEY&job_number=JOB_NUMBER
+| colspan="2" | https://:base_url/api/job_export?api_key=YOUR_KEY&job_number=JOB_NUMBER
 |-