This is similar process to createProof() but allows you to create proof(s) from multiple sources. When calling the createProofs() method the system generates the first version of the proof. Subsequent versions are created using createProofVersion(), currently only web proofs are supported when creating subsequent verisons. Please note: If you are creating a web snapshot proof then the "Hash" parameter must contain the single string value "web" and the "SourceName" must contain the space delimited set of web sources. If you are creating a combined proof consisting of files then the "Hash" and "SourceName" parameters must have the same number of sources. If you are creating a non combined proof consisting of files then the "Hash", "Name" and "SourceName" parameters must have the same number of sources.Note: in order to make all functionality (such as text selection) available when creating a file proof its important to provide the file name along with it's extension. The "SourceName" parameter is used to determine the extension and file type
|
Parameter |
Example |
API version |
||
SessionID* |
The session Id obtained from doLogin() |
string |
7viklshodc6cnsh4s5vu75mqk0 |
|
OwnerID* |
Result code |
integer |
0 - current user ownerOID - see getOwners() |
|
Hash* |
Space delimited file identifier(s) |
string |
ffc50a5fdd43ff.046772a6b09987aa1 ff754hhyfs45633ggj545645434aa2 |
|
Name* |
Pipe "|" delimited proof name(s) |
string |
File1|File2 |
|
SourceName* |
Space delimited source file name(s) |
string |
Proofhq-api.pdf Proofhq-api2.pdf |
|
Subject |
File subject |
string |
Custom subject |
|
Message |
Message to reviewers. We accept the following formatting tags within the message: <a> href <i> italic <span> group inline-elements <div> defines a division or a section <p> paragraph <font> specifying a font <u> underline <br> new line |
string |
Email body text inserted here |
|
Deadline |
Deadline date of reviewing |
date |
2011-09-01 23:59 (YYYY-MM-DD hh:mm) |
|
Recipients |
List of recipient email addresses |
string |
email1@address.com email2@address.com
email1@address.com;email2@address.com
email1@address.com,email2@address.com |
|
WorkspaceId |
Workspace identifier |
integer | 245 - see getWorkspaces() |
|
BatchID |
Batch upload identifier (seeCreating proofs) |
integer | Identifier returned by createBatch() |
|
EnableSubscriptions |
Allows people who are not participants to subscribe themselves to the proof. See help for more information. Default taken from the user's personal settings -> proofing defaults | boolean |
true false |
|
EnableSubscriptionsValidation |
People subscribing can only access the proof using their personal URL sent in the email. See help for more information. | boolean |
true false |
|
DefaultEmailNotifications |
Email notification settings for reviewers. It will not override a user's personal setting or the proof-level setting set by a reviewer. See help for more information. 1: All new comments and replies 2: Replies to my comments 3: Daily summary 4: Hourly summary 5: Decisions only 9: Disabled |
string | 4 |
|
DefaultRole |
If EnableSubscriptionsValidation is turned on, there is a further setting that you can use, which sets the Role for subscribers. See help for more information on this setting and here for help on roles.1: Read only 3: Reviewer 4: Approver 5: Reviewer and approver 6: Author 7: Moderator |
string | 5 |
|
AuthorizedOnly |
This is the same as the Login Required function on the new proof page. If used, then EnableSubscriptions must be set to false .See help for more information. Default taken from the user's personal settings -> proofing defaults |
boolean | true false |
|
EnableAutoLock |
Locks the proof when all required decisions are made. See help for more information. Default taken from the user's personal settings -> proofing defaults | boolean | true false |
|
LockAfterFirstDecision |
Locks the proof after first decision is made. See help for more information. Default taken from the user's personal settings -> proofing defaults | boolean | true false |
|
EnableDownload |
Enables download of the source file. Default taken from the user's personal settings -> proofing defaults | boolean | true false |
|
EnableTeamURL |
Hides or shows the team URL. Default taken from the user's personal settings -> proofing defaults | boolean | true false |
|
EnableEmbedPlayer |
Shows or hides the embed viewer URL. |
boolean | true false (default) |
|
ShowDashboardLink |
Shows / hides the navigation link to the dashboard in the proof page. | boolean | true false (default) |
|
ShowWorkspaceLink |
Shows / hides the navigation link to the workspace in the proof page. | boolean | true false (default) |
|
ShowDetailsPageLink |
Shows / hides the navigation link to the proof details in the proof page. | boolean | true false (default) |
|
ShowVersionsLink |
Shows / hides the navigation link to the versions window will be displayed in the proof page. |
boolean | true false (default) |
|
ShowHelpLink |
Shows / hides the help link in the proof page. |
boolean | true false (default) |
|
ShowHelpQuickStartLink |
Shows / hides the Getting started link in the proof page. | boolean | true false (default) |
|
ShowHelpUserGuideLink |
Shows / hides the Knowledgebase link in the proof page. | boolean | true false (default) |
|
ShowHelpWelcomeScreenLink |
Displays or not Getting started popup | boolean | true false (default) |
|
ShowHelpForumLink |
Shows / hides the forum link. | boolean | true false (default) |
|
ShowHelpBlogLink |
Show / hides the blog link. | boolean | true false (default) |
|
CustomLinkUrl |
Allows you to specify a custom URL. | string | http://app.proofhq.com/ | |
CustomLinkLabel |
The label for the CustomLinkUrl |
string | ProofHQ Home | |
SuppressNewProofNotification |
If true the creator will not receive a notification email when the proof has been created. |
boolean | true false (default) |
|
SWF |
When creating an SWF proof, you can specify whether this is an application or animation type. See our help for more information. |
string | application or animation | |
ShowDashboardfunctions |
Setting this to false will hide all functions that will navigate the user to the ProofHQ application.This is applicable when proof management is done outside of ProofHQ |
boolean | true false (default) |
|
ShowCloseIcon |
Setting this to false will hide the close icon within the proof viewer |
boolean |
true (default) |
|
ShowPublishToTheWeb |
Setting this to false will hide the publish to web option within the proof viewer |
boolean |
true (default) |
|
ShowPrintComments |
Setting this to false will hide the print comments option within the proof viewer |
boolean |
true (default) |
|
ShowEmailAlertSettings |
Setting this to false will hide the email alert settings within the proof viewer |
boolean |
true (default) |
|
CombinedProof |
Determines if a single combined proof will be created from all the sources |
boolean |
true |
|
EnabledElectronicSignatures |
Setting this to true will enable electronic signatures on this proof. If electronic signatures have been enabled on the account then this parameter will be ignored |
boolean |
true |
13.5 |
ShowSendDecisionConfirmationCheckbox |
Toggle on / off the "Send me an email confirmation of my decision" option in the Proofing tool (ProofViewer) |
boolean |
true (default) |
13.6 |
ClassicProofViewer |
Determines if the proof uses the old or new ProofViewer |
boolean |
true (default) |
13.17 |
DisableSubscriptionEmail |
Determines if the subscription email should be send or not |
boolean |
true |
14.5 |
DisablePDFSummary |
Determines if the PDF print summary should be available on the print summary page |
boolean |
true |
14.17 |
DisableExcelSummary |
Determines if the Excel print summary should be available on the print summary page |
boolean |
true |
14.17 |
ShowProofWorkflow |
Setting this to false will hide the Workflow panel within the ProofHQ Viewer |
boolean |
true (default) |
15.1 |
ShowProofDetails |
Setting this to false will hide the Details panel within the ProofHQ Viewer |
boolean |
true (default) |
15.1 |
ReferenceID |
Reference id for a proof (it can be any string that could be used to identify a proof) |
string |
proof789 |
16.17 |
ResolutionID |
A comma seperated list of resolution ids used for web capture proofs:
1: WQHD 2560x1440 2: FHD 1920x1080 3: UXGA 1600x1200 4: HD 1366x768 5: WXGA 1280x720 6: XGA 1024x768 7: IPAD 2048x1536 9: STD 2560x1600 10: STD 1920x1280 11: STD 1280x800 12: IPHONE_640x1136 13: STD 1080x1920 14: IPHONE 375x667
|
string |
3 5 11 |
17.15 |
SOAPFileObjectArray:
array of
SOAPFileObject