Additional Information about the PDD Public Web Service (PWS)

 

The Public Data Distribution (PDD) Public Web Service (PWS) allows a user to automatically retrieve public data contained in the Central Data Repository (CDR) either through the users’ own programs or the programs provided. The user must have an account before proceeding to access the PWS. When the user initially establishes an account, an email will be sent containing the user name, security token, and instructions for using the web service. After a year of inactivity, the account will be removed and the user will have to register again.

 

Currently, the PWS will allow a limited number of downloads (approximately 2500 per hour). If the download limit has been reached within one hour, the user will have to wait until the next hour to continue with the next download.

 

Depending on the request, the files are either in Portable Document Format (PDF), Semicolon Delimited Format (SDF), or eXtensible Business Reporting Language (XBRL) format. SDF text files can be viewed and modified using spreadsheet or database software (e.g., Excel, Access) or with a text editor (e.g., NotePad). XBRL files require an XBRL editor.  A taxonomy may have to be downloaded after the XBRL files have been downloaded for a better understanding of the file. The taxonomy may be accessed through the PDD web site.

 

Samples of software to use with the PWS are available by accessing the tab entitled “Software Downloads” under Manage My Web Service Account.

 

The PWS supports the Simple Object Access Protocol (SOAP) Version 1.1. Error conditions discovered by the PWS will be related back to the client as SOAP Faults. SOAP Faults represent a mechanism for encapsulating and transmitting error information using SOAP messages, and consist of fields that contain information about the error that occurred. Listed below are SOAP Faults that you might receive while using the PWS.

 

SOAP fault code

SOAP fault string (Description)

wsse:UnsupportedSecurityToken

An unsupported token was provided

wsse:InvalidSecurity

An error was discovered processing the <wsse:Security> header.

wsse:InvalidSecurityToken

An invalid security token was provided.

wsse:FailedAuthentication

The security token could not be authenticated or authorized.

wsse:SecurityTokenUnavailable

Referenced security token could not be retrieved.

Client.UserQuotaExceeded

Returned when the user has exceeded the maximum number of retrieval requests as specified in the Supplementary Specification.

Client.InvalidDataSeriesName

Returned when the client application has specified invalid data series name.

Client.InvalidReportingPeriodEndDate

Returned when the client application has specified invalid reporting period end date.

Client.InvalidFacsimileType

Returned when the client application has specified incorrect facsimile type.

Client.InvalidFIType

Returned when the client application has specified invalid FI type.

Client.InvalidFI

Returned when the client application has specified invalid FI ID.

Server.UnexpectedError

Returned when the service encounters a general error that prevents it from completing the request. Sources of such an error could include unavailable database or application error.

Server.FacsimileNotFoundOrUnavailable

Returned by a call to RetrieveFacsimile method when all input parameters are valid, however, the facsimile cannot be found in the system. There may be a perfectly valid reason why the facsimile is not found, e.g., the FI has not filed yet or the business rules do not allow the facsimile to be released to the public.