  |
GoFiler Legato Script Reference
Legato v 1.4j Application v 5.22b
|
| Table of Contents | < < Previous | Next >> |
Chapter Twenty-one — EDGARView Integration (continued)
EDGARResponseGetSeries Function
Overview
The EDGARResponseGetSeries function returns a table containing series and class information extracted from the response message, if present.
Syntax/Parameters
Syntax
string [][] = EDGARResponseGetSeries ( string data | handle hMessage, [boolean terse] );
Parameters
data
A string containing the response message. Or,
hMessage
A handle to a Response Message Object.
terse
An optional boolean value that when TRUE, will result in the table being created with the series ID and name only being added when a new series starts in the list.
Return Value
A string table containing the series and class information returned in the response message or an empty list on failure. Use the GetLastError function to retrieve a formatted error code.
Remarks
Only certain types of EDGAR response messages contain series and class information. The function expects the ‘SERIES AND CLASSES (CONTRACTS) SUMMARY’ heading in the incoming messages. If it is not present, the function will return an empty table with the error ERROR_EOD.
Data returned in the table is formatted by a row for each class and a column for each item data. The columns have the following key names:
| Key Name | Description | ||
| Type | Type response from the SEC/EDGAR System as: “NEW”, “EXISTING” or “MERGED”. | ||
| SeriesID | Series ID as existing or assigned by the SEC. In terse mode, only the first series name for a sequence of classes will have a value. | ||
| SeriesName | Series name. In terse mode, only the first series name for a sequence of classes will have a value. | ||
| ClassID | Class ID. | ||
| ClassName | Class name. | ||
| Ticker | Ticker name, if not assigned the SEC returns “NO_VALUE”. |
Related Functions
Platform Support
Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL
Legato IDE
| Table of Contents | < < Previous | Next >> |
© 2012-2024 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. GoFiler™ and Legato™ are trademarks of Novaworks, LLC. EDGAR® is a federally registered trademark of the U.S. Securities and Exchange Commission. Novaworks is not affiliated with or approved by the U.S. Securities and Exchange Commission. All other trademarks are property of their respective owners. Use of the features specified in this language are subject to terms, conditions and limitations of the Software License Agreement.