Filings search V2 response schema
Hello
Thank you in advance
Best Answer
-
Hello @nikita.vladarsky
Please see the information from the RKD team below.
The response note is in array format based on the schema.
Please find below schema level interpretation,
The parent node SubmissionStatusAndInfoType is an array type and can have multiple data as per response received.
<xs:complexType name="SubmissionStatusAndInfoType">
<xs:sequence>
<xs:element name="submissionInfo" type="SubmissionInfoType" minOccurs="1" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="commonID" type="xs:string"/>
</xs:complexType>The child node SubmissionInfoType is also an array type, can have multiple data. Further child nodes under this node may be an array or would be a single element as shown below.
<xs:complexType name="SubmissionInfoType">
<xs:sequence>
<xs:element name="companyInfo" type="CompanyInfoType" minOccurs="1" maxOccurs="unbounded"/>
<xs:element name="snippets" type="SnippetsType" minOccurs="0" maxOccurs="1"/>
<xs:element name="sectionTags" type="SectionTagsType" minOccurs="0" maxOccurs="1"/>
<xs:element name="DeltaValues" type="DeltaValuesType" minOccurs="0" maxOccurs="1"/>
<xs:element name="documentTitle" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="docType" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="automationInfo" type="AutomationInfoType" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="IsHTMLDocumentAvailable" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="IsPDFDocumentAvailable" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="IsRTFDocumentAvailable" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="IsXBRLZIPDocumentAvailable" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="IsTXTDocumentAvailable" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="IsEdgarDocumentAvailable" type="xs:string" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
<xs:attribute name="DCN" type="xs:string" use="optional"/>
<xs:attribute name="arriveDate" type="xs:dateTime" use="optional"/>
<xs:attribute name="categoryID" type="xs:int" use="optional"/>
<xs:attribute name="commonID" type="xs:string" use="optional"/>
<xs:attribute name="countryCode" type="xs:string" use="optional"/>
<xs:attribute name="feedID" type="xs:string" use="optional"/>
<xs:attribute name="fileType" type="xs:string" use="optional"/>
<xs:attribute name="formName" type="xs:string" use="optional"/>
<xs:attribute name="formType" type="xs:string" use="optional"/>
<xs:attribute name="isRestricted" type="xs:boolean" use="optional"/>
<xs:attribute name="languageCode" type="xs:string" use="optional"/>
<xs:attribute name="originalFileName" type="xs:string" use="optional"/>
<xs:attribute name="periodEndDate" type="xs:dateTime" use="optional"/>
<xs:attribute name="releaseDate" type="xs:dateTime" use="optional"/>
<xs:attribute name="size" type="xs:int" use="required"/>
<xs:attribute name="accessionNumber" type="xs:string" use="optional"/>
<xs:attribute name="nativePdfFlag" type="xs:boolean" use="optional"/>
</xs:complexType>- maxOccurs=”unbounded”: it is an array type and would have no limit in data display
- maxOccurs=”1”: it is not an array type and would accommodate upto one data to display
- minOccurs=”0”: data for the element either can be available or not
- minOccurs=”1”: it must have at least of one data to display.
- use=”optional”: attribute is not mandatory
- use=”required”: attribute is mandatory.
The RKD team confirms data is being sent from the back end and the RKD API just passes data to the client.
Hope this helps.
0
Answers
-
Hello @nikita.vladarsky,
RDP Filings search results are defined by filings search request. For instance, if you request:
https://{{RDP_HOST}}/data-store/{{RDP_VERSION_FILINGS}}/graphql
{ FinancialFiling(
filter: {
AND: [ {FilingDocument: {Identifiers: {OrganizationId: {EQ: "4297089638"}}}} {FilingDocument: {DocumentSummary: {FilingDate: {BETWN: {FROM: "2020-01-01T00:00:00Z", TO: "2020-12-31T00:00:00Z"}}}}}
]
} limit: 25)
{
FilingDocument { _metadata { totalCount } DocumentSummary { DocumentTitle FilingDate DocumentType FeedName } }
}
}The result will contain:
{
"data": {
"FinancialFiling": [
{
"FilingDocument": {
"_metadata": {
"totalCount": 199
},
"DocumentSummary": {
"DocumentTitle": "Tesla, Inc. 8-K",
"FilingDate": "2020-01-03T00:00:00.000Z",
"DocumentType": "8-K",
"FeedName": "Edgar"
}
}
},
{
"FilingDocument": {
"_metadata": {
"totalCount": 199
},
"DocumentSummary": {
"DocumentTitle": "Tesla, Inc. CT Order",
"FilingDate": "2020-01-03T00:00:00.000Z",
"DocumentType": "CT Order",
"FeedName": "Edgar"
}
}
},
...More information on the contents can be found in Filings Developer Guide , example Filings search requests are included with RDP Postman Starter Collection and Tutorial Samples , section Filings.
0 -
@zoya.farberov
Thanks for the answer. I am not using graphql. I am using rest api.
Endpoint:/api/FilingsSearch2/FilingsSearch2.svc/REST/FilingsSearch2_1/SearchSubmissions_1
I take it from RKD (Refinitiv knowledge direct).
Could you tell me what is the difference between RDP and RKD? And where can I get help for RKD (endpoint that we use)?0 -
Hello @nikita.vladarsky ,
Moving your question to Refinitiv Knowledge Direct forums, for better visibility with RDK experts.
RDP Filings and RKD are different products, so API access as well as capabilities differ.
Please refer to Refinitiv Knowledge Direct API (RKD API) area for materials related to RKD.
0
Categories
- All Categories
- 6 AHS
- 37 Alpha
- 161 App Studio
- 4 Block Chain
- 4 Bot Platform
- 16 Connected Risk APIs
- 47 Data Fusion
- 30 Data Model Discovery
- 608 Datastream
- 1.3K DSS
- 577 Eikon COM
- 4.9K Eikon Data APIs
- 7 Electronic Trading
- Generic FIX
- 7 Local Bank Node API
- Trading API
- 2.7K Elektron
- 1.3K EMA
- 236 ETA
- 519 WebSocket API
- 33 FX Venues
- 10 FX Market Data
- 1 FX Post Trade
- 1 FX Trading - Matching
- 12 FX Trading – RFQ Maker
- 5 Intelligent Tagging
- 2 Legal One
- 20 Messenger Bot
- 2 Messenger Side by Side
- 9 ONESOURCE
- 7 Indirect Tax
- 59 Open Calais
- 264 Open PermID
- 39 Entity Search
- 2 Org ID
- PAM
- PAM - Logging
- 8.4K Private Comments
- 6 Product Insight
- Project Tracking
- ProView
- ProView Internal
- 20 RDMS
- 1.4K Refinitiv Data Platform
- 367 Refinitiv Data Platform Libraries
- 3 Refinitiv Due Diligence
- LSEG Due Diligence Portal API
- 3 Refinitiv Due Dilligence Centre
- Rose's Space
- 1.1K Screening
- 18 Qual-ID API
- 13 Screening Deployed
- 23 Screening Online
- 10 World-Check Customer Risk Screener
- 990 World-Check One
- 44 World-Check One Zero Footprint
- 45 Side by Side Integration API
- Test Space
- 3 Thomson One Smart
- 1.2K TR Internal
- Global Hackathon 2015
- 2 Specialists Who Code
- 10 TR Knowledge Graph
- 150 Transactions
- 142 REDI API
- 1.7K TREP APIs
- 4 CAT
- 21 DACS Station
- 117 Open DACS
- 1.1K RFA
- 103 UPA
- 172 TREP Infrastructure
- 224 TRKD
- 886 TRTH
- 5 Velocity Analytics
- 5 Wealth Management Web Services
- 59 Workspace SDK
- 9 Element Framework
- 5 Grid
- 13 World-Check Data File
- Yield Book Analytics
- 46 中文论坛