API (SOAP) – Run Timing Event

Introduction

Within the print IQ application there is a SOAP web service called ProductionIntegration This service exposes an entry point to allow external applications to add timing to an operation on a section or job. The method in the web service is called RunTimingEvent. The web service is accessible using the print IQ site URL, for example:

http://gpo.printiq.com/WebService/ProductionIntegration.asmx?op=RunTimingEvent
<printIQ URL>/WebService/ProductionIntegration.asmx?op=RunTimingEvent

The API returns a code and message, a list of codes and corresponding messages are included below.

The AppKey and AppName must be configured manually by IQ.

Parameters

* = Required field

Name	Data Type	Description
AppKey *	String	A valid print IQ application key
AppName *	String	A valid print IQ application name
JobNo *	String	A valid print IQ job number
SectionKey	String	A valid section key on the job number specified above
OperationKey *	String	A valid operation key on the job number or section key specified above
OperatorUserName *	String	A valid print IQ user name
StartDate	String	A valid start date/time (e.g. 2016-08-08 09:00:00.000)
EndDate	String	A valid end date/time (e.g. 2016-08-11 09:00:00.000)
Duration	String	A valid fractional duration in hours (e.g. 1.5 hours)
TimeZoneId	String	A valid time zone ID, see the table below for valid time zones
ParameterKey	String	A valid parameter key associated with the operation
ParameterValue	String	A valid fractional value for the parameter key associated with the operation.
Finish *	Boolean	A valid boolean value (true or false). If true is specified the operation timing will be finished. If false is specified the operation timing will be paused.

Return Codes

Code	Message
FAIL_CRED	Invalid application credentials supplied
FAIL_TIME	Invalid time supplied
FAIL_OPERATOR	Invalid operator user name supplied
FAIL_JOBREF	Invalid job reference supplied
FAIL_JOBDRAFT	Unable to start timing on a draft job
FAIL_OPKEY	Invalid operation key supplied
FAIL_SECKEY	Invalid section key supplied
FAIL_SECKEYJOB	Invalid section key for the supplied job reference
FAIL_OPKEYSEC	Invalid operation key for the supplied section key
FAIL_PARAMETER_KEY	Invalid parameter key supplied
FAIL_PARAMETER_VAL	Invalid parameter value supplied
SUCCESS

Rules

There are several rules surrounding the time based parameters, StartDate, EndDate and Duration:

If a start date and duration have been specified but no end date, the duration is added to the start date to calculate the end date.
If an end date and duration have been specified, then the duration is subtracted from the end date to calculate the start date.
If only a start date is specified, then assume the operation is finishing using the current date as the end date.
If no start and end date are specified but the duration is specified, then the duration is subtracted from the current date to calculate the start and end date.
If no date's or duration are specified, then assume an immediate start then stop time entry using the current date as the start and end date.
The start and end date will be stored in the systems default time zone unless it is supplied.

Sample Request

POST /PrintIQ/WebService/ProductionIntegration.asmx HTTP/1.1

Host: gpo.printiq.com

Content-Type: application/soap+xml; charset=utf-8

Content-Length: length

<?xml version="1.0" encoding="utf-8"?>

<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">

<soap12:Body>

<AppName xmlns="">TestApp</AppName>

<OperatorUserName xmlns="">joe.bloggs</OperatorUserName>

</RunTimingEvent>

</soap12:Body>

</soap12:Envelope>

Sample Response

HTTP/1.1 200 OK

Content-Type: application/soap+xml; charset=utf-8

Content-Length: length

<?xml version="1.0" encoding="utf-8"?>

<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">

<soap12:Body>

<ReturnCode xmlns="http://iq.co.nz/">SUCCESS</ReturnCode>

</RunTimingEventResult>

</RunTimingEventResponse>

</soap12:Body>

</soap12:Envelope>

Time Zones

Time Zone Id	Base UTC Offset
Dateline Standard Time	-12:00:00
UTC-11	-11:00:00
Aleutian Standard Time	-10:00:00
Hawaiian Standard Time	-10:00:00
Marquesas Standard Time	-09:30:00
Alaskan Standard Time	-09:00:00
UTC-09	-09:00:00
Pacific Standard Time (Mexico)	-08:00:00
UTC-08	-08:00:00
Pacific Standard Time	-08:00:00
US Mountain Standard Time	-07:00:00
Mountain Standard Time (Mexico)	-07:00:00
Mountain Standard Time	-07:00:00
Central America Standard Time	-06:00:00
Central Standard Time	-06:00:00
Easter Island Standard Time	-06:00:00
Central Standard Time (Mexico)	-06:00:00
Canada Central Standard Time	-06:00:00
SA Pacific Standard Time	-05:00:00
Eastern Standard Time (Mexico)	-05:00:00
Eastern Standard Time	-05:00:00
Haiti Standard Time	-05:00:00
Cuba Standard Time	-05:00:00
US Eastern Standard Time	-05:00:00
Paraguay Standard Time	-04:00:00
Atlantic Standard Time	-04:00:00
Venezuela Standard Time	-04:00:00
Central Brazilian Standard Time	-04:00:00
SA Western Standard Time	-04:00:00
Pacific SA Standard Time	-04:00:00
Turks And Caicos Standard Time	-04:00:00
Newfoundland Standard Time	-03:30:00
Tocantins Standard Time	-03:00:00
E. South America Standard Time	-03:00:00
SA Eastern Standard Time	-03:00:00
Argentina Standard Time	-03:00:00
Greenland Standard Time	-03:00:00
Montevideo Standard Time	-03:00:00
Saint Pierre Standard Time	-03:00:00
Bahia Standard Time	-03:00:00
UTC-02	-02:00:00
Mid-Atlantic Standard Time	-02:00:00
Azores Standard Time	-01:00:00
Cape Verde Standard Time	-01:00:00
UTC	00:00:00
Morocco Standard Time	00:00:00
GMT Standard Time	00:00:00
Greenwich Standard Time	00:00:00
W. Europe Standard Time	01:00:00
Central Europe Standard Time	01:00:00
Romance Standard Time	01:00:00
Central European Standard Time	01:00:00
W. Central Africa Standard Time	01:00:00
Namibia Standard Time	01:00:00
Jordan Standard Time	02:00:00
GTB Standard Time	02:00:00
Middle East Standard Time	02:00:00
Egypt Standard Time	02:00:00
E. Europe Standard Time	02:00:00
Syria Standard Time	02:00:00
West Bank Standard Time	02:00:00
South Africa Standard Time	02:00:00
FLE Standard Time	02:00:00
Turkey Standard Time	02:00:00
Israel Standard Time	02:00:00
Kaliningrad Standard Time	02:00:00
Libya Standard Time	02:00:00
Arabic Standard Time	03:00:00
Arab Standard Time	03:00:00
Belarus Standard Time	03:00:00
Russian Standard Time	03:00:00
E. Africa Standard Time	03:00:00
Iran Standard Time	03:30:00
Arabian Standard Time	04:00:00
Astrakhan Standard Time	04:00:00
Azerbaijan Standard Time	04:00:00
Russia Time Zone 3	04:00:00
Mauritius Standard Time	04:00:00
Georgian Standard Time	04:00:00
Caucasus Standard Time	04:00:00
Afghanistan Standard Time	04:30:00
West Asia Standard Time	05:00:00
Ekaterinburg Standard Time	05:00:00
Pakistan Standard Time	05:00:00
India Standard Time	05:30:00
Sri Lanka Standard Time	05:30:00
Nepal Standard Time	05:45:00
Central Asia Standard Time	06:00:00
Bangladesh Standard Time	06:00:00
N. Central Asia Standard Time	06:00:00
Myanmar Standard Time	06:30:00
SE Asia Standard Time	07:00:00
Altai Standard Time	07:00:00
W. Mongolia Standard Time	07:00:00
North Asia Standard Time	07:00:00
Tomsk Standard Time	07:00:00
China Standard Time	08:00:00
North Asia East Standard Time	08:00:00
Singapore Standard Time	08:00:00
W. Australia Standard Time	08:00:00
Taipei Standard Time	08:00:00
Ulaanbaatar Standard Time	08:00:00
North Korea Standard Time	08:30:00
Aus Central W. Standard Time	08:45:00
Transbaikal Standard Time	09:00:00
Tokyo Standard Time	09:00:00
Korea Standard Time	09:00:00
Yakutsk Standard Time	09:00:00
Cen. Australia Standard Time	09:30:00
AUS Central Standard Time	09:30:00
E. Australia Standard Time	10:00:00
AUS Eastern Standard Time	10:00:00
West Pacific Standard Time	10:00:00
Tasmania Standard Time	10:00:00
Vladivostok Standard Time	10:00:00
Lord Howe Standard Time	10:30:00
Bougainville Standard Time	11:00:00
Russia Time Zone 10	11:00:00
Magadan Standard Time	11:00:00
Norfolk Standard Time	11:00:00
Sakhalin Standard Time	11:00:00
Central Pacific Standard Time	11:00:00
Russia Time Zone 11	12:00:00
New Zealand Standard Time	12:00:00
UTC+12	12:00:00
Fiji Standard Time	12:00:00
Kamchatka Standard Time	12:00:00
Chatham Islands Standard Time	12:45:00
Tonga Standard Time	13:00:00
Samoa Standard Time	13:00:00
Line Islands Standard Time	14:00:00

Related Articles
API (SOAP) – Event Types
Introduction When sending SOAP calls from a third party system to printIQ, you need to specify a System, an Event Type, and Job Number with corresponding File Reference. Production Integration supported Systems The following table lists the Systems ...
API (SOAP) – Update Job Orientation
Introduction You may use SOAP to call a production event that completes the edit job process, whereby allowing the job finish size to be altered. By incorporating this production event before or during a preflight check, you may avoid validation ...
API (SOAP) – Send Email
Introduction You may use SOAP calls to send emails from printIQ. Email templates are configured via Admin / Customise, then the link to Emails All of the email templates available on your system may be referenced by the following table of ID’s: ...
API (SOAP) – Status Update
Introduction By referencing the Production Status ID’s, you may use SOAP calls to update a Job’s Production Status. Production Statuses are located under Admin / Configure Factory / Terminology (under General). Production Status ID's The following ...
API (SOAP) – Add Note
Introduction You may use SOAP calls to add Notes to a Job Details screen. As with other Production Integration API calls, you must reference the following Parameters System EventType JobRef Production Integration supported Systems The following ...

API (SOAP) – Run Timing Event

API (SOAP) – Run Timing Event

Related Articles

API (SOAP) – Event Types

API (SOAP) – Update Job Orientation

API (SOAP) – Send Email

API (SOAP) – Status Update

API (SOAP) – Add Note