PDFreactor SOAP API Documentation

REST Documentation

convert http://soap.webservice.pdfreactor.realobjects.com

Converts the posted configuration or asset package into PDF or image and returns the generated PDF or image.

Parameter

Name Type Description
configuration Configuration The configuration to convert.
apiKey <Content> An API key which may be required by the service for authentication purposes.
http://webservice.pdfreactor.realobjects.com

Response

Name Type Description
result Result The resulting document, including other information like log files and page numbers.
Namespace: http://webservice.pdfreactor.realobjects.com

Faults

Type Reasons Fault Info
NoInputDocument No input document was specified in the configuration. Result
InvalidConfiguration The supplied configuration was not valid for some reason. See the error message for details. Result
InvalidClient The version of the client that was used is outdated and no longer supported. This is only available for the PDFreactor REST wrapper clients. Result
Unauthorized The client failed an authorization check, e.g. because a supplied API key was invalid. Result
UnprocessableConfiguration The supplied configuration was accepted by PDFreactor but could not be converted for some reason. See the error message for details. Result
NoConfiguration No configuration was supplied to the operation. Result
ConversionFailure The configuration could not be processed and should be re-checked. Result
ConversionAborted The supplied configuration is valid, however the conversion could not be completed for some reason. See the error message for details. Result
ServiceUnavailable The PDFreactor Web Service is running and reachable, but conversions are unavailable. Result
Namespace: http://webservice.pdfreactor.realobjects.com

convertAsync http://soap.webservice.pdfreactor.realobjects.com

Converts the posted configuration or asset package into PDF or image. This operation responds immediately and does not wait for the conversion to finish. This is especially useful for very large or complex documents where the conversion will take some time.

Parameter

Name Type Description
configuration Configuration The configuration to convert.
apiKey <Content> An API key which may be required by the service for authentication purposes.
http://webservice.pdfreactor.realobjects.com

Response

Name Type Description
documentId <Content> The ID of the conversion and resulting document.
Namespace: http://webservice.pdfreactor.realobjects.com

Faults

Type Reasons Fault Info
NoInputDocument No input document was specified in the configuration. Result
InvalidConfiguration The supplied configuration was not valid for some reason. See the error message for details. Result
InvalidClient The version of the client that was used is outdated and no longer supported. This is only available for the PDFreactor REST wrapper clients. Result
Unauthorized The client failed an authorization check, e.g. because a supplied API key was invalid. Result
UnprocessableConfiguration The supplied configuration was accepted by PDFreactor but could not be converted for some reason. See the error message for details. Result
NoConfiguration No configuration was supplied to the operation. Result
ConversionFailure The configuration could not be processed and should be re-checked. Result
ConversionAborted The supplied configuration is valid, however the conversion could not be completed for some reason. See the error message for details. Result
ServiceUnavailable The PDFreactor Web Service is running and reachable, but conversions are unavailable. Result
Namespace: http://webservice.pdfreactor.realobjects.com

getProgress http://soap.webservice.pdfreactor.realobjects.com

Retrieves progress information about the conversion with the given ID.

Parameter

Name Type Description
documentId <Content> The document ID.
apiKey <Content> An API key which may be required by the service for authentication purposes.
http://webservice.pdfreactor.realobjects.com

Response

Name Type Description
progress Progress The current estimated progress, including log output.
Namespace: http://webservice.pdfreactor.realobjects.com

Faults

Type Reasons Fault Info
Unauthorized The client failed an authorization check, e.g. because a supplied API key was invalid. Result
DocumentNotFound Conversion does not exist Result
Namespace: http://webservice.pdfreactor.realobjects.com

getDocument http://soap.webservice.pdfreactor.realobjects.com

Returns the document with the given ID.

Parameter

Name Type Description
documentId <Content> The document ID.
apiKey <Content> An API key which may be required by the service for authentication purposes.
http://webservice.pdfreactor.realobjects.com

Response

Name Type Description
result Result The resulting document, including other information like log files and page numbers.
Namespace: http://webservice.pdfreactor.realobjects.com

Faults

Type Reasons Fault Info
Unauthorized The client failed an authorization check, e.g. because a supplied API key was invalid. Result
DocumentNotFound Conversion does not exist Result
Namespace: http://webservice.pdfreactor.realobjects.com

getDocumentMetadata http://soap.webservice.pdfreactor.realobjects.com

Returns the metadata of the document with the given ID.

Parameter

Name Type Description
documentId <Content> The document ID.
apiKey <Content> An API key which may be required by the service for authentication purposes.
http://webservice.pdfreactor.realobjects.com

Response

Name Type Description
result Result The resulting document metadata, including other information like log files and page numbers.
Namespace: http://webservice.pdfreactor.realobjects.com

Faults

Type Reasons Fault Info
Unauthorized The client failed an authorization check, e.g. because a supplied API key was invalid. Result
DocumentNotFound Conversion does not exist Result
Namespace: http://webservice.pdfreactor.realobjects.com

deleteDocument http://soap.webservice.pdfreactor.realobjects.com

Deletes the document with the given ID.

Parameter

Name Type Description
documentId <Content> The document ID.
apiKey <Content> An API key which may be required by the service for authentication purposes.
http://webservice.pdfreactor.realobjects.com

Response

None.

Faults

Type Reasons Fault Info
Unauthorized The client failed an authorization check, e.g. because a supplied API key was invalid. Result
DocumentNotFound Conversion does not exist Result
Namespace: http://webservice.pdfreactor.realobjects.com

getVersion http://soap.webservice.pdfreactor.realobjects.com

Returns the version of the PDFreactor web service that is currently running.

Parameter

Name Type Description
apiKey <Content> An API key which may be required by the service for authentication purposes.
http://webservice.pdfreactor.realobjects.com

Response

Name Type Description
version Version The version.
Namespace: http://webservice.pdfreactor.realobjects.com

Faults

None.

getStatus http://soap.webservice.pdfreactor.realobjects.com

Checks if the PDFreactor Web Service is available and functional.

Parameter

Name Type Description
apiKey <Content> An API key which may be required by the service for authentication purposes.
http://webservice.pdfreactor.realobjects.com

Response

None.

Faults

Type Reasons Fault Info
Unauthorized The client failed an authorization check, e.g. because a supplied API key was invalid. Result
ServiceUnavailable The PDFreactor Web Service is running but not functional. Result
Namespace: http://webservice.pdfreactor.realobjects.com