Email Job PDF - Revision history

Paularthur: /* Email Job PDF */

2018-12-10T09:04:16Z

‎Email Job PDF

Ian: /* Email Job PDF */

2016-11-25T11:23:24Z

‎Email Job PDF

Ian: /* Email Job PDF */

2016-11-14T12:36:11Z

‎Email Job PDF

Paul: /* Email Job PDF */

2016-08-24T11:56:53Z

‎Email Job PDF

Ryanmt at 18:42, 19 January 2016

2016-01-19T18:42:02Z

Ryanmt: /* Default : export_name="default_job" */

2015-07-09T13:42:31Z

‎Default : export_name="default_job"

Ryanmt: /* Gas Safe : export_name = "default_gassafe" */

2015-07-09T13:42:13Z

‎Gas Safe : export_name = "default_gassafe"

Ryanmt: /* Summary */

2015-07-09T13:41:59Z

‎Summary

Ryanmt: Created page with "=== Email 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 jo..."

2015-06-18T10:41:00Z

Created page with "=== Email 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 jo..."

New page

=== Email 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 email the same PDF's the portal generates using your api key as authentication rather than having to log into via the web.

'''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/

Its coding style is similar to API and returns the same set of error codes.

== Summary ==
{| border="1" class="wikitable"å

! Jobs
! colspan="2" |
|-
! URL
| colspan="2" | http://:base_url/api/email_job_export?api_key=YOUR_KEY&job_number=JOB_NUMBER&emails=xxx@xx.com&subject=Job Export&message=Please see attached file

|-
! Type
| colspan="2" | GET
|-
! Params:
| api_key || required
|-
!
| job_number || required
|-
!
| export_name || not required
|-
!
| emails (multiples are ; seperated) || required
|-
!
| message || not required
|-
!
| subject || not required
|-
! Response
| colspan="2" | JSON
|}

== Responses ==

In the event of a successful export generation the tool will return a 200 response and the json
<source lang="java">
{"success":true}
</source>

If an error occurs the tool will return either a 401 or 500 error code. The HTTP response code should be used to decide if the PDF was generated correctly. If a 401 or 500 response is returned the headers will be of type 'application/json' and the error code structure will match the rest of the API.
<source lang="java">
{"error_code":"JBE100","error_message":"Job cannot be found."}
</source>

== 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.

== Header / Footer ==

Custom headers and footers can be configured via the web portal. For more information please see here

[https://mymobileworkers.zendesk.com/entries/27349997-Custom-Signatures KB article on custom headers/footers]

''Warning: If a header or footer is configured with either broken HTML or broken IMG tags then PDF will fail to generate''

== Available export templates ==

MyMobileWorkers has different types of exports for a job, these all use the same engine to generate the export but have different designs and options.

You can toggle which export you want to generate by setting the <code>export_name</code> flag. The default is "default_job" which is called the "Default job export" on the portal. Each export has its own set of optional flags you can pass as GET params to alter what is displayed on the report.

=== Default : export_name="default_job" ===
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'''''
{| border="1" class="wikitable"å
|-
! GET Param
! Default value
! Description
|-
! show_notes
| true (1)
| Displays job notes
|-
! show_photos
| true (1)
| Displays job photos
|-
! show_times
| false (0)
| Display created at/updated at timestamps
|-
! show_elements
| false (0)
| Display items / parts / assets
|-
! show_pre_checks
| false (0)
| Displays pre job check results
|-
! show_post_checks
| false (0)
| Displays post job check results
|-
! show_advanced
| false (0)
| Show Repair information (Repair jobs only)
|-
! show_activities
| false (0)
| Displays job activities
|-
! show_vehicle_reg
| false (0)
| Displays vehicle used (only if vehicles feature is installed)
|-
|}

=== Gas Safe : export_name = "default_gassafe" ===

{| border="1" class="wikitable"å
|-
! GET Param
! Default value
! Description
|-
! show_checklist
| true
| Displays second page checklist
|-
|}

@@ Line 9: / Line 9: @@
 Its coding style is similar to API and returns the same set of error codes.
-Note that this method requires POST. If you attempt to pass a job number to this method using GET you will get error API101 reminding you.
+Note that this method accepts GET or POST. For example, you can pass a job number to this method using GET or POST.
 == Summary ==

@@ 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.'''
-     https://api.mymobileworkers.com/api/
+     https://live.mymobileworkers.com/api/
 Its coding style is similar to API and returns the same set of error codes.

@@ 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.'''
-     https://live.mymobileworkers.com/api/
+     https://api.mymobileworkers.com/api/
 Its coding style is similar to API and returns the same set of error codes.

← Older revision		Revision as of 11:56, 24 August 2016
Line 8:		Line 8:

	Its coding style is similar to API and returns the same set of error codes.		Its coding style is similar to API and returns the same set of error codes.
		+
		+	Note that this method requires POST. If you attempt to pass a job number to this method using GET you will get error API101 reminding you.

	== Summary ==		== Summary ==

@@ Line 76: / Line 76: @@
 === Default : export_name="default_job" ===
-Below is a list of optional extra GET parameters which are related specifically to this export type
+Below is a list of optional extra POST parameters which are related specifically to this export type
@@ Line 82: / Line 82: @@
 {| border="1" class="wikitable"å
 |-
-! GET Param
+! POST Param
 ! Default value
 ! Description

@@ Line 16: / Line 16: @@
 |-
 ! URL
-| colspan="2" | http://:base_url/api/email_job_export?api_key=YOUR_KEY&job_number=JOB_NUMBER&emails=xxx@xx.com&subject=Job Export&message=Please see attached file
+| colspan="2" | http://:base_url/api/email_job_export
 |-
 ! Type
-| colspan="2" | GET
+| colspan="2" | POST
 |-
 ! Params: