DocumentResponse Class

[This is preliminary documentation and is subject to change.]

A document returned by GetDocument(DocumentRequest)

Inheritance Hierarchy

SystemObject
Purolator.Webservice.ObjectsResponseBase
Purolator.Webservice.ObjectsDocumentResponse

Namespace: Purolator.Webservice.Objects
Assembly: OLS.Webservice.Objects (in OLS.Webservice.Objects.dll) Version: 9.3.0.21647 (9.3.0.21647)

Syntax

public class DocumentResponse : ResponseBase

Public Class DocumentResponse
	Inherits ResponseBase

public ref class DocumentResponse : public ResponseBase

The DocumentResponse type exposes the following members.

Constructors

	Name	Description
	DocumentResponse

Properties

	Name	Description
	Data	The document data. For DocumentLocation Data, Data will contain the Base 64 encoded data. For DocumentLocation Url, Data will contain the Url of the report.
	DocumentFormat	The format of the document (PDF, XPS).
	DocumentLocation	The location of the document to return (Data, Url).
	DocumentType	Indicates the document type.
	HybridResults	The json response to the HSS call. (Inherited from ResponseBase.)
	Messages	Error, Warning or Informational messages. (Inherited from ResponseBase.)
	Status	The status of the request (0 - Success, 1 - Success with warnings, 2 - Failure). (Inherited from ResponseBase.)

Methods

	Name	Description
	SetFromRequest