THOMSON REUTERS KNOWLEDGE DIRECT API

THOMSON REUTERS KNOWLEDGE DIRECT API DEVELOPER'S GUIDE

Product Version: 1.14 Guide Version: 1.6.1 1/21/2011

Thomson Reuters 2011. All Rights Reserved. Thomson Reuters, by publishing this document, does not guarantee that any information contained herein is and w ill remain accurate or that use of the information w ill ensure correct and faultless operation of the relevant service or equipment. Thomson Reuters, its agents and employees, shall not be held liable to or through any user for any loss or damage w hatsoever resulting from reliance on the information contained herein. This document contains information proprietary to Thomson Reuters and may not be reproduced, disclosed, or used in w hole or part w ithout the express w ritten permission of Thomson Reuters. Any Softw are, including but not limited to, the code, screen, structure, sequence, and organization thereof, and Documentation are protected by national copyright law s and international treaty provisions. This manual is subject to U.S. and other national export regulations.

CONTENTS

Table of Contents
Chapter I Chapter II Overview Preface 24 25

1 Intended ................................................................................................................................... Audience 25 2 Using................................................................................................................................... this Guide 25 3 Where ................................................................................................................................... to Get More Information 25

Chapter III

Getting Started

26

1 Before ................................................................................................................................... You Begin 26 2 Understanding ................................................................................................................................... Service Users, Impersonation (Effective Users) 26 3 Understanding ................................................................................................................................... Application Identification Strings (appids) 26 4 Understanding ................................................................................................................................... Authentication Tokens 26 5 An Example ................................................................................................................................... API Interaction 26 6 Web Services ................................................................................................................................... Standards 29 7 Date/Time ................................................................................................................................... Format 30

Chapter IV

Authentication and Authorization

31

1 Understanding ................................................................................................................................... Application Identification Strings (appids) 31 2 Understanding ................................................................................................................................... Service Users, Impersonation (Effective Users) 32 3 Understanding ................................................................................................................................... Authentication Tokens 32
Creating a Token .......................................................................................................................................................... 33 Creating Service .......................................................................................................................................................... and Im personation Token in One Request 35 Creating New .......................................................................................................................................................... Token Using Expired Token 36

4 WSDL ................................................................................................................................... 37 5 Validating ................................................................................................................................... Token 37 6 Resetting ................................................................................................................................... Password 38

Chapter V Chapter VI

Using MessageID Analytics

39 40

1 Authentication/Authorization, Service Endpoint, and Required Headers ................................................................................................................................... 40 2 WSDL ................................................................................................................................... 40 3 Getting ................................................................................................................................... Analytics (GetAnalytics_1) 40 4 Getting ................................................................................................................................... Analytic IDs (GetAnalyticIDs_1) 42

Chapter VII

Authors Reference

43

1 Authentication/Authorization, Service Endpoint, and Required Headers ................................................................................................................................... 43

TRKD API Developer's Guide

2 WSDL ................................................................................................................................... 43 3 Authors ................................................................................................................................... List (AuthorsList_1) 43 4 Persons ................................................................................................................................... List (PersonsList_1) 45 5 Get Related ................................................................................................................................... Accounts (GetRelatedAccounts_1) 46 6 Get Teams ................................................................................................................................... (GetTeams_1) 47 7 Listing ................................................................................................................................... All Authors (Analysts) from Contributor (Company) 48
Requesting Active .......................................................................................................................................................... Analysts 49

Chapter VIII

Charts

50

1 Authentication/Authorization, Service Endpoint, and Required Headers ................................................................................................................................... 50 2 WSDL ................................................................................................................................... 51 3 Understanding ................................................................................................................................... Reuters Charts Request 51
chartRequest .......................................................................................................................................................... 53 Tim eSeries .......................................................................................................................................................... 53 Analyses .......................................................................................................................................................... 54 StandardTem plate .......................................................................................................................................................... 55 Schem e .......................................................................................................................................................... 58 Retrieving 1Y .......................................................................................................................................................... Interday Stock Chart 60 Retrieving 1Y .......................................................................................................................................................... Interday Stock Chart w ith Index Com parison 66 Retrieving 1Y .......................................................................................................................................................... Interday Percent Change Stock Chart w ith Index Com parison 73 Retrieving 5 Day .......................................................................................................................................................... Intraday Dual Stock Chart w ith Sim ple Moving Average 79 Retrieving 1 Day .......................................................................................................................................................... Intraday Stock Chart 86

4 Understanding ................................................................................................................................... Reuters Charts Response 92 5 Analyses ................................................................................................................................... List 93 6 How to ................................................................................................................................... Build a Chart 94
Making Chart .......................................................................................................................................................... Request 94 Example 1 ......................................................................................................................................................... 97 Example 2......................................................................................................................................................... 103 Example 3......................................................................................................................................................... 110 ......................................................................................................................................................... 116 Creating Chart For The Past 10 Years Custom izing.......................................................................................................................................................... Chart Appearance 117 ......................................................................................................................................................... 117 Customizing Colour for Data Series Colour Picker ......................................................................................................................................... 124 RGB Mode ................................................................................................................................... 124 ARGB Mode ................................................................................................................................... 124 Named Mode ................................................................................................................................... 125 ......................................................................................................................................................... 126 Customizing Background Colour ......................................................................................................................................................... 132 Other Formatting Options Fill Format ......................................................................................................................................... 132 Text Format ......................................................................................................................................... 133 Font Format ......................................................................................................................................... 133 Line Format ......................................................................................................................................... 133 More Sam ple .......................................................................................................................................................... Requests 133 Case 1 ......................................................................................................................................................... 133 Case 2 ......................................................................................................................................................... 139

Chapter IX

Company Administration

147

CONTENTS

1 Authentication/Authorization, Service Endpoint, and Required Headers ................................................................................................................................... 147 2 WSDL ................................................................................................................................... 147 3 Company ................................................................................................................................... from Template (CompanyFromTemplate_1) 147 4 Get Channel Reference Information (GetChannelReferenceInfo_1) ................................................................................................................................... 149 5 Get Company ................................................................................................................................... Template (GetCompanyTemplate_1) 150 6 Update ................................................................................................................................... Company (UpdateCompany_1) 150 7 Country ................................................................................................................................... Codes 152 8 User................................................................................................................................... Job Roles 156

Chapter X

Document Retrieval

166

1 Authentication ................................................................................................................................... and Authorization 166 2 Identifying ................................................................................................................................... the User in Each Request 166
Generating the .......................................................................................................................................................... User Authorization Token 166 Setting the User .......................................................................................................................................................... Authorization Token 167 Required Dom .......................................................................................................................................................... ain Mapping 167

3 Retrieving ................................................................................................................................... Documents on Behalf of Another User 167 4 Retrieving ................................................................................................................................... Documents (DocumentRetrieval_1) 168
Retrieving Docum .......................................................................................................................................................... ent by Docum ent ID 168 Retrieving Docum .......................................................................................................................................................... ent by Contributor ID and Contributor Docum ent ID 169

5 Retrieving ................................................................................................................................... Document Thumbnails (GetThumbs_1) 170 6 Error ................................................................................................................................... Handling 171 7 Redirection ................................................................................................................................... for Expired or Invalid Authorization (Optional) 171

Chapter XI

Document Search

172

1 Authentication/Authorization, Service Endpoint, and Required Headers ................................................................................................................................... 172 2 WSDL ................................................................................................................................... 172 3 Performing ................................................................................................................................... a Simple Query 172
Using Other Date .......................................................................................................................................................... Ranges 173

4 Interpreting ................................................................................................................................... the Document Search Response 173

Understanding .......................................................................................................................................................... Docum ent Dates and Ordering 174

5 Samples ................................................................................................................................... of Document Search Requests 175

Docum ent IDs .......................................................................................................................................................... (DocIDs_1) 175 Docum ent Inform .......................................................................................................................................................... ation (DocInfo_1) 176 Docum ents Count .......................................................................................................................................................... (DocCount_1) 177 Docum ents Search .......................................................................................................................................................... (DocSearch_1) 178 Docum ents Sum .......................................................................................................................................................... m ary (DocSum m ary_1) 179 Fts Docum ent .......................................................................................................................................................... IDs (FtsDocIDs_1) 180 Fts Docum ents .......................................................................................................................................................... Count (FtsDocCount_1) 180 Fts Docum ents .......................................................................................................................................................... Search (FtsDocSearch_1) 181 Batch Request .......................................................................................................................................................... (Batch_1) 183 Search Keyw.......................................................................................................................................................... ord (DocSearchKeyw ord_1) 184 Table of Contents .......................................................................................................................................................... (DocTableOfContents_1) 186 DocSearch_1.......................................................................................................................................................... Request Param eters 187

TRKD API Developer's Guide

6 Searching ................................................................................................................................... for Documents from Particular Contributors 189 7 Searching ................................................................................................................................... for Documents about a Particular Company 191
A Word about .......................................................................................................................................................... Tickers 191 Searching by .......................................................................................................................................................... Tickers 192

8 Complex ................................................................................................................................... Keyword Searches 193 9 Searching ................................................................................................................................... by Analyst, Industry, Language, and other Criteria 193
Generating the .......................................................................................................................................................... Search Code 195 Using Reuters .......................................................................................................................................................... (Global) Codes 195 Using Contributor .......................................................................................................................................................... (Local) Codes 195

10 Searching ................................................................................................................................... by Additional Contributor Specific Data 196 11 Including ................................................................................................................................... the Undiscounted Document Price in the Metadata 196
Interpreting .......................................................................................................................................................... the Docum ent Price 197

12 Including ................................................................................................................................... the Document Synopsis in the Result Set 197 13 Query ................................................................................................................................... Optimization 197
The Query Pipeline .......................................................................................................................................................... 197 Caching the MXID .......................................................................................................................................................... 198

14 Paging ................................................................................................................................... the Response 199

Making a Request .......................................................................................................................................................... w ith Paging 199 Calculating Num .......................................................................................................................................................... ber of Seconds 200

15 Searching ................................................................................................................................... for Industry Reports 200 16 Some ................................................................................................................................... Words about Document Search Criteria 200

Chapter XII

Entitlements Administration

202

1 Authentication/Authorization, Service Endpoint, and Required Headers ................................................................................................................................... 202 2 WSDL ................................................................................................................................... 203 3 Create ................................................................................................................................... Entitlement (CreateEntitlement_1) 203 4 Get Entitlement ................................................................................................................................... (GetEntitlement_1) 204 5 Get User ................................................................................................................................... Group Template (GetUserGroupTemplate_1) 206 6 Remove ................................................................................................................................... Entitlement (RemoveEntitlement_1) 207 7 User................................................................................................................................... Group From Template (UserGroupFromTemplate_1) 208 8 Remove ................................................................................................................................... Entitlement (RemoveEntitlement_1) 209 9 Remove ................................................................................................................................... ROS Entitlement (RemoveROSEntitlements_1) 210 10 Set User ................................................................................................................................... Group Membership (SetUserGroupMembership_1) 211 11 Get User ................................................................................................................................... Group Membership (GetUserGroupMembership_1) 211 12 Remove User Group Membership (RemoveUserGroupMembership_1) ................................................................................................................................... 213 13 Get User ................................................................................................................................... Group (GetUserGroup_1) 214

Chapter XIII

Entitlement Requests

215

1 Authentication/Authorization, Service Endpoint, and Required Headers ................................................................................................................................... 215 2 WSDL ................................................................................................................................... 216

CONTENTS

3 Create ................................................................................................................................... Entitlement Request (CreateEntitlementRequest_1) 216 4 Get Contributor ................................................................................................................................... List (GetContributorList_1) 217 5 Get Entitlement ................................................................................................................................... Request List (GetEntitlementRequestList_1) 218 6 Get Last ................................................................................................................................... Client Contact (GetLastClientContact_1) 220 7 How................................................................................................................................... Does Get Contributor List Operation Work 221

Rules for Retrieving .......................................................................................................................................................... Contributors 221 Exam ple .......................................................................................................................................................... 222 Possible Policy .......................................................................................................................................................... Values 222 Why Users Cannot .......................................................................................................................................................... Get Docum ent from the Contributors They Are Entitled to 223 Why Users Cannot .......................................................................................................................................................... Access the Docum ent Their Colleagues Have Access to 223 Why Is Get Contributor .......................................................................................................................................................... List Operation Often Confused w ith Get Inform ation Operation from the Reference 223 Inform at Creation of Tem .......................................................................................................................................................... porary Entitlem ents Table 223

8 Handling ................................................................................................................................... Error Codes 224

Chapter XIV

Estimates

225

1 Authentication/Authorization, Service Endpoint, and Required Headers ................................................................................................................................... 225 2 WSDL ................................................................................................................................... 226 3 General ................................................................................................................................... Product Information 226
Date and Tim.......................................................................................................................................................... e Standards 226 Definition of .......................................................................................................................................................... a Com pany in Thom son Reuters Estim ates 226 Consensus Currency .......................................................................................................................................................... 226 Adjustm ents .......................................................................................................................................................... for Capital Changes 227 Unit Sizes .......................................................................................................................................................... 227 Periods .......................................................................................................................................................... 227 Consensus Methodology .......................................................................................................................................................... 227 Supplem ental .......................................................................................................................................................... Recom m endations 228 Expected Announcem .......................................................................................................................................................... ent Dates 228

4 Company ................................................................................................................................... Section Supplemental Information 229

Prim ary Consensus .......................................................................................................................................................... Type 229 Prim ary Estim .......................................................................................................................................................... ate Type 229 Prim ary Earnings .......................................................................................................................................................... Type 229 Prim ary Periodicity .......................................................................................................................................................... Type 229 The Current .......................................................................................................................................................... Fiscal Year 230

5 Thomson ................................................................................................................................... Reuters Estimates Requests 230

Understanding .......................................................................................................................................................... Reuters Estim ates Request 230 Get Reference .......................................................................................................................................................... Inform ation (GetReferenceInform ation_1) 233 Get Security .......................................................................................................................................................... Inform ation (GetSecurityInform ation_1) 234 Get Meta Inform .......................................................................................................................................................... ation (GetMetaInform ation_1) 235 Get Broker Coverage .......................................................................................................................................................... Inform ation (GetBrokerCoverageInform ation_1) 235 Get Consensus .......................................................................................................................................................... (GetConsensus_1) 236 Get Detailed .......................................................................................................................................................... (GetDetailed_1) 237

6 Understanding ................................................................................................................................... Thomson Reuters Estimates Responses 238

Reference Inform .......................................................................................................................................................... ation Section 243 244 Company ......................................................................................................................................................... Information ......................................................................................................................................................... 246 Issue Information Security Inform .......................................................................................................................................................... ation Section 247 META Inform.......................................................................................................................................................... ation Section 249 Broker Coverage .......................................................................................................................................................... Inform ation Section 251

TRKD API Developer's Guide

Consensus Inform .......................................................................................................................................................... ation Section 252 Detailed Inform .......................................................................................................................................................... ation Section 255

Chapter XV

File Content Retrieval

260

1 Authentication ................................................................................................................................... and Authorization 260 2 File ................................................................................................................................... Content Retrieval (RetrieveFileContent_1) 260 3 Error ................................................................................................................................... Handling 260

Chapter XVI

Fund Screener

262

1 Authentication/Authorization, Service Endpoint, and Required Headers ................................................................................................................................... 262 2 WSDL ................................................................................................................................... 263 3 How................................................................................................................................... to Get Screen Results? 263 4 Get Screening ................................................................................................................................... Meta Data (GetScreeningMetaData_1) 263 5 Get Screening ................................................................................................................................... Counts (GetScreeningCounts_1) 265 6 Get Screening ................................................................................................................................... Results Synch (GetScreeningResultsSynch_1) 267

Chapter XVII

Fundamentals

270

1 Authentication/Authorization, Service Endpoint, and Required Headers ................................................................................................................................... 270 2 WSDL ................................................................................................................................... 270 3 Interpreting ................................................................................................................................... Common Fundamental Elements 271
com panyIdType .......................................................................................................................................................... and com panyId - Request Attributes 271 CoIDs - Response .......................................................................................................................................................... Elem ent 271 Issues, Issue, .......................................................................................................................................................... and IssueID - Response Elem ents 271 ......................................................................................................................................................... 272 Issue Type and Order - Response Elements ......................................................................................................................................................... 272 Global Listings ......................................................................................................................................................... 272 Stock Splits CoGeneralInfo .......................................................................................................................................................... Elem ent 273 ......................................................................................................................................................... 273 CoStatus Element ......................................................................................................................................................... 273 CoType Element ......................................................................................................................................................... 273 Fiscal Period Information ......................................................................................................................................................... 274 Share Information

4 Get Business And Geographic Segments (GetBusinessAndGeographicSegments_1) ................................................................................................................................... 274

Making a Geographic .......................................................................................................................................................... Segm ent Request 275 Making a Business .......................................................................................................................................................... Segm ent Request 277

5 Financial ................................................................................................................................... Statements Concepts 279

Types of Statem .......................................................................................................................................................... ents 279 Unique Identifiers .......................................................................................................................................................... 279 Dual Listed Com .......................................................................................................................................................... panies 279 Prim ary Issue .......................................................................................................................................................... and Exchange 280 Periods and .......................................................................................................................................................... Filings 280 General Response .......................................................................................................................................................... Structure for All Financials 280 Period Lengths .......................................................................................................................................................... 281 Prelim inary Statem .......................................................................................................................................................... ents 281 Com plete Statem .......................................................................................................................................................... ents 281 Restatem ents/Reclassifications .......................................................................................................................................................... 282

CONTENTS

Chart of Account .......................................................................................................................................................... (COA) Codes 282 ......................................................................................................................................................... 282 Concept and Process ......................................................................................................................................................... 282 Uniqueness of COA Codes Mapping to STD .......................................................................................................................................................... 282 Currencies .......................................................................................................................................................... 283 Exchange Rates .......................................................................................................................................................... 283 Units .......................................................................................................................................................... 283 Footnote Item .......................................................................................................................................................... s 284 Num ber of Shares .......................................................................................................................................................... 284 Creating a Display .......................................................................................................................................................... 284

6 Getting ................................................................................................................................... Financial Statements 284

com panyIdType .......................................................................................................................................................... Attribute 286 com panyId Attribute .......................................................................................................................................................... 286 finStatem ent .......................................................................................................................................................... Attribute 286 Lim iting Num .......................................................................................................................................................... ber of Periods Returned 286 coaCodes Attribute .......................................................................................................................................................... 286 displayTypes .......................................................................................................................................................... Attribute 286 show * Attributes .......................................................................................................................................................... 287 updateType Attribute .......................................................................................................................................................... 287 com pleteStatem .......................................................................................................................................................... ent Attribute 287 finalFiling Attribute .......................................................................................................................................................... 287

7 Interpreting ................................................................................................................................... Financials Responses 287

Response Overview .......................................................................................................................................................... 287 Com panyInform .......................................................................................................................................................... ation Elem ent 288 Issues Elem ent .......................................................................................................................................................... 289 Statem entInfo .......................................................................................................................................................... Elem ent 290 Availability Elem .......................................................................................................................................................... ent 290 FinancialsLayout .......................................................................................................................................................... Elem ent 291 Period Elem ent .......................................................................................................................................................... 291 PeriodHeader .......................................................................................................................................................... Elem ent 291 PeriodFilings .......................................................................................................................................................... Elem ent 291 PeriodFilingHeader .......................................................................................................................................................... Elem ent 292 Statem ent Elem .......................................................................................................................................................... ent 292 Statem entHeader .......................................................................................................................................................... Elem ent 293 FinancialValues .......................................................................................................................................................... 294

8 Company ................................................................................................................................... Specific Financials Responses 294

MapItem Elem .......................................................................................................................................................... ent (Com pany-Specific) 294 FV Elem ent (Com .......................................................................................................................................................... pany-Specific) 295

9 Standardized ................................................................................................................................... Financials Responses 295

MapItem Elem .......................................................................................................................................................... ent (Standardized) 295 Obtaining a List .......................................................................................................................................................... of All COA Codes 296 FV Elem ent (Standardized) .......................................................................................................................................................... 296

10 Get Ratios ................................................................................................................................... And Statistics (GetRatiosAndStatistics_1) 296 11 Getting ................................................................................................................................... a Company's Officers and Directors 298
Get Officers .......................................................................................................................................................... And Directors (GetOfficersAndDirectors_1) 299 GetOfficersAndDirectors_Response_1 .......................................................................................................................................................... Elem ent 299 ......................................................................................................................................................... 300 OfficerInformation and Officer Elements ......................................................................................................................................................... 300 Person Information ......................................................................................................................................................... 301 Contact Information 302 Corporate......................................................................................................................................................... Affiliations ......................................................................................................................................................... 302 Position Information ......................................................................................................................................................... 303 Biographical Information

10

TRKD API Developer's Guide

......................................................................................................................................................... 303 Salary Information

12 Getting ................................................................................................................................... a Company's Competitors 304

Get Com petitors .......................................................................................................................................................... (GetCom petitors_1) 304 GetCom petitors_Response_1 .......................................................................................................................................................... Elem ent 304

13 Getting ................................................................................................................................... a List of Major Customers 306

Get Major Custom .......................................................................................................................................................... ers (GetMajorCustom ers_1) 306 GetMajorCustom .......................................................................................................................................................... ers_Response_1 Elem ent 306 FPHeader Elem .......................................................................................................................................................... ent 307 Custom erDetails .......................................................................................................................................................... Elem ent 307

14 Getting ................................................................................................................................... a Detailed Company Description 307

Get Long Com .......................................................................................................................................................... pany Description (GetLongCom panyDescription_1) 307 GetLongDescription_Response_1 .......................................................................................................................................................... Elem ent 308

15 Getting ................................................................................................................................... General Company Information 308

Get General Inform .......................................................................................................................................................... ation (GetGeneralInform ation_1) 308 GetGeneralInform .......................................................................................................................................................... ation_Response_1 elem ents 309 ......................................................................................................................................................... 311 GeneralInformation Element ......................................................................................................................................................... 312 Industry Classification 313 Company ......................................................................................................................................................... General Information ......................................................................................................................................................... 313 Issue Information ......................................................................................................................................................... 314 Contact Information ......................................................................................................................................................... 314 Web Links ......................................................................................................................................................... 315 Descriptive Sections Advisors ......................................................................................................................................................... 315 Officers ......................................................................................................................................................... 316

16 Get Industry ................................................................................................................................... Aggregate (GetIndustryAggregate_1) 317 17 Getting ................................................................................................................................... Company Reference Information 319
Get Fundam entals .......................................................................................................................................................... Reference Info (GetFundam entalsReferenceInfo_1) 319 ReferenceInform .......................................................................................................................................................... ation Elem ent 321 Com pany Xrefs .......................................................................................................................................................... 321 Com pany Status .......................................................................................................................................................... 321 Com pany Updates .......................................................................................................................................................... 322 Currencies .......................................................................................................................................................... 323 Industry Classification .......................................................................................................................................................... 323 Issue Inform.......................................................................................................................................................... ation 324 Issue Xref .......................................................................................................................................................... 324 Issue Status.......................................................................................................................................................... 325 Issue Specific .......................................................................................................................................................... 325

18 Getting ................................................................................................................................... a List of Industries, Sectors, and Indexes (Aggregates) 326

Get Fundam entals .......................................................................................................................................................... Reference Lists (GetFundam entalsReferenceLists_1) 327

19 Industry ................................................................................................................................... Classification Schema (ICS) 329

Overview .......................................................................................................................................................... 329 ......................................................................................................................................................... 329 Reuters Business Sector Schema (RBSS) ......................................................................................................................................................... 329 Standard Industry Classification (SIC) ......................................................................................................................................................... 329 North American Industry Classification System (NAICS) ......................................................................................................................................................... 329 Industry Tagging ICS Requests .......................................................................................................................................................... 329 ......................................................................................................................................................... 329 Find Industry Classification Schema (FindIndustryClassificationSchema_1) Get Industry Classification Schema Full Hierarchy ......................................................................................................................................................... 331 (GetIndustryClassificationSchemaFullHierarchy_1)

20 Fundamental ................................................................................................................................... Reports 333

Get Ratios Reports .......................................................................................................................................................... (GetRatiosReports_1) 333

CONTENTS

11

Get Financial.......................................................................................................................................................... Statem ents Reports (GetFinancialStatem entsReports_1) 337 Get Snapshot .......................................................................................................................................................... Reports (GetSnapshotReports_1) 339

Chapter XVIII

Lipper Asset Views

344

1 Authentication/Authorization, Service Endpoint, and Required Headers ................................................................................................................................... 344 2 WSDL ................................................................................................................................... 344 3 Get Asset ................................................................................................................................... Holdings (GetAssetHoldings_1) 344 4 Get Asset ................................................................................................................................... Overview (GetAssetOverview_1) 346 5 Get Asset ................................................................................................................................... Quantitative Analysis (GetAssetQuantitativeAnalysis_1) 351

Chapter XIX

Lipper Details

355

1 Lipper ................................................................................................................................... Holdings 355

Authentication/Authorization, .......................................................................................................................................................... Service Endpoint, and Required Headers 355 WSDL .......................................................................................................................................................... 355 Get Collected .......................................................................................................................................................... Allocations (GetCollectedAllocations_2) 356

2 Lipper ................................................................................................................................... Time Series 358

Authentication/Authorization, .......................................................................................................................................................... Service Endpoint, and Required Headers 358 WSDL .......................................................................................................................................................... 358 Get Price (GetPrice_1) .......................................................................................................................................................... 358 Get Prices (GetPrices_1) .......................................................................................................................................................... 360

3 Lipper ................................................................................................................................... Calculations 362

Authentication/Authorization, .......................................................................................................................................................... Service Endpoint, and Required Headers 362 WSDL .......................................................................................................................................................... 362 Get Best Worst .......................................................................................................................................................... Perform ance (GetBestWorstPerform ance_1) 363 Get Rolling Perform .......................................................................................................................................................... ance (GetRollingPerform ance_1) 364 Get Stored Perform .......................................................................................................................................................... ance By Calculations Filter (GetStoredPerform anceByCalculationsFilter_1) 366 Get Stored Perform .......................................................................................................................................................... ance Calculation (GetStoredPerform anceCalculation_1) 367 Get Stored Perform .......................................................................................................................................................... ance Calculations (GetStoredPerform anceCalculations_1) 369

4 Lipper ................................................................................................................................... Fundamentals 371

Authentication/Authorization, .......................................................................................................................................................... Service Endpoint, and Required Headers 371 WSDL .......................................................................................................................................................... 371 Get Asset Is .......................................................................................................................................................... Prim ary (GetAssetIsPrim ary_1) 372 Get Benchm ark .......................................................................................................................................................... (GetBenchm ark_1) 373 Get Benchm arks .......................................................................................................................................................... (GetBenchm arks_1) 374 Get Bottom Perform .......................................................................................................................................................... ers (GetBottom Perform ers_1) 375 Get Bottom Perform .......................................................................................................................................................... ers By Classification Schem e (GetBottom Perform ersByClassificationSchem e_1) 377 Get Bottom Perform .......................................................................................................................................................... ers By LG Classification Schem a (GetBottom Perform ersByLGClassificationSchem 379 a_1) Get Charges.......................................................................................................................................................... (GetCharges_1) 381 Get Classification .......................................................................................................................................................... (GetClassification_1) 383 Get Classifications .......................................................................................................................................................... (GetClassifications_1) 384 Get Cross Reference .......................................................................................................................................................... (GetCrossReference_1) 386 Get Cross Reference .......................................................................................................................................................... Bulk (GetCrossReferenceBulk_1) 388 Get Cross Reference .......................................................................................................................................................... By Identifier Type (GetCrossReferenceByIdentifierType_2) 389 Get Cross Reference .......................................................................................................................................................... To Lipper Id (GetCrossReferenceToLipperId_1) 391 Get Distribution .......................................................................................................................................................... (GetDistribution_1) 392 Get Dividend.......................................................................................................................................................... Details (GetDividendDetails_1) 393 Get Dividends .......................................................................................................................................................... Per Year (GetDividendsPerYear_1) 395 Get Dom iciles .......................................................................................................................................................... (GetDom iciles_1) 396 Get EU Tax Directive .......................................................................................................................................................... (GetEUTaxDirective_1) 397

12

TRKD API Developer's Guide

Get Get Get Get Get Get Get Get Get Get Get Get Get Get

Flags (GetFlags_1) .......................................................................................................................................................... 399 IPO Info (GetIPOInfo_1) .......................................................................................................................................................... 400 Legal Structure .......................................................................................................................................................... (GetLegalStructure_1) 402 Lipper Leader .......................................................................................................................................................... Scores (GetLipperLeaderScores_1) 403 Minim um .......................................................................................................................................................... Investm ent (GetMinim um Investm ent_1) 406 New ly Available .......................................................................................................................................................... Funds by RFS (GetNew lyAvailableFundsByRfs_1) 408 Registered .......................................................................................................................................................... Countries Of Sale (GetRegisteredCountriesOfSale_1) 409 Registered .......................................................................................................................................................... Country Of Sale (GetRegisteredCountryOfSale_1) 410 Support .......................................................................................................................................................... Com pany (GetSupportCom pany_1) 411 Top Perform .......................................................................................................................................................... ers (GetTopPerform ers_1) 413 Top Perform .......................................................................................................................................................... ers By Classification Schem e (GetTopPerform ersByClassificationSchem e_1) 415 Top Perform .......................................................................................................................................................... ers By LG Classification Schem a (GetTopPerform ersByLGClassificationSchem a_1) 417 Total Net.......................................................................................................................................................... Asset By Period Advanced (GetTotalNetAssetByPeriodAdvanced_1) 419 Total Net.......................................................................................................................................................... Asset By Period Basic (GetTotalNetAssetByPeriodBasic_1) 421

5 Lipper ................................................................................................................................... Data Enumerations 422

Allocation Enum .......................................................................................................................................................... eration 422 Countries Enum .......................................................................................................................................................... eration 423 Currency Code .......................................................................................................................................................... Enum eration 425 Universe Enum .......................................................................................................................................................... eration 429 Calculation TypeId .......................................................................................................................................................... Enum eration 430 Classification .......................................................................................................................................................... Schem e Enum eration 432 LG Classification .......................................................................................................................................................... Schem e Enum eration 434

Chapter XX

Lipper Overview

435

1 Authentication/Authorization, Service Endpoint, and Required Headers ................................................................................................................................... 435 2 WSDL ................................................................................................................................... 435 3 Get Asset ................................................................................................................................... Details Analysis SP (GetAssetDetailsAnalysisSP_1) 436 4 Get Asset ................................................................................................................................... Details Attributes (GetAssetDetailsAttributes_1) 438 5 Get Asset Details Financial Advanced (GetAssetDetailsFinancialAdvanced_1) ................................................................................................................................... 440 6 Get Asset Details Financial Basic (GetAssetDetailsFinancialBasic_1) ................................................................................................................................... 443 7 Get Asset Details Overview Basic (GetAssetDetailsOverviewBasic_1) ................................................................................................................................... 446 8 Get Asset ................................................................................................................................... Details Prices Basic (GetAssetDetailsPricesBasic_1) 450 9 Get Asset ................................................................................................................................... Details Ratings (GetAssetDetailsRatings_1) 451

Chapter XXI

Lipper Search

455

1 Authentication/Authorization, Service Endpoint, and Required Headers ................................................................................................................................... 455 2 WSDL ................................................................................................................................... 456 3 Get Class ................................................................................................................................... Scheme Search (GetClassSchemeSearch_1) 456 4 Get Class Scheme Search By RFS (GetClassSchemeSearchByRFS_1) ................................................................................................................................... 457 5 Get Cross ................................................................................................................................... Reference Search (GetCrossReferenceSearch_1) 459 6 Get Cross Reference Search By Universe (GetCrossReferenceSearchByUniverse_1) ................................................................................................................................... 461

CONTENTS

13

7 Get Fund Name Search Max Records (GetFundNameSearchMaxRecords_1) ................................................................................................................................... 463 8 Get Fund Name Search Max Records By Universe (GetFundNameSearchMaxRecordsByUniverse_1) ................................................................................................................................... 464 9 Get Fund ................................................................................................................................... Name Search Paging (GetFundNameSearchPaging_1) 466 10 Get Fund Name Search Pagination By RFS (GetFundNameSearchPaginationByRFS_1) ................................................................................................................................... 467 11 Get Legal ................................................................................................................................... Structure Search (GetLegalStructureSearch_1) 469 12 Get Lipper Leader Score Search (GetLipperLeaderScoreSearch_1) ................................................................................................................................... 471 13 Get Search Keyword By Asset Type (GetSearchKeywordByAssetType_1) ................................................................................................................................... 473

Chapter XXII

Lipper Utilities

476

1 Authentication/Authorization, Service Endpoint, and Required Headers ................................................................................................................................... 476 2 WSDL ................................................................................................................................... 477 3 Get Benchmarks ................................................................................................................................... (GetBenchmarks_1) 477 4 Get Class ................................................................................................................................... Schemes (GetClassSchemes_1) 478 5 Get Class ................................................................................................................................... Scheme Details (GetClassSchemeDetails_1) 480 6 Get Country ................................................................................................................................... List (GetCountryList_1) 481 7 Get Cross ................................................................................................................................... Reference Codes (GetCrossReferenceCodes_1) 482 8 Get Currency ................................................................................................................................... List (GetCurrencyList_1) 484 9 Get Domiciles ................................................................................................................................... (GetDomiciles_1) 485 10 Get EU ................................................................................................................................... Tax Directive (GetEUTaxDirective_1) 486 11 Get Flag ................................................................................................................................... Groups (GetFlagGroups_1) 488 12 Get Languages ................................................................................................................................... (GetLanguages_1) 489 13 Get Lipper ................................................................................................................................... Leader Score Dates (GetLipperLeaderScoreDates_1) 491 14 Get Price ................................................................................................................................... Estimation (GetPriceEstimation_1) 492 15 Get Risk ................................................................................................................................... Free Index (GetRiskFreeIndex_1) 493 16 Get Technical ................................................................................................................................... Indicators (GetTechnicalIndicators_1) 494 17 Get Universes ................................................................................................................................... (GetUniverses_1) 496

Chapter XXIII

News

498

1 Authentication/Authorization, Service Endpoint, and Required Headers ................................................................................................................................... 498 2 WSDL ................................................................................................................................... 498 3 Retrieve ................................................................................................................................... Headlines (RetrieveHeadlineML_Request_1) 498
Retrieve Headlines .......................................................................................................................................................... Request 499 Filters .......................................................................................................................................................... 499 Understanding .......................................................................................................................................................... Retrieve Headlines Response 500

4 Retrieve ................................................................................................................................... Story (RetrieveStoryML_Request_1) 503 5 Retrieve ................................................................................................................................... News (RetrieveNewsML_Request_1) 506

14

TRKD API Developer's Guide

6 Get News ................................................................................................................................... Topics (GetTopics_Request_1) 508 7 Classes ................................................................................................................................... for Metadata Search on News 509
How to See how .......................................................................................................................................................... a Specific New s Stories has been Categorized? 509 What Values .......................................................................................................................................................... Can I Use in Order to Filter on New s? 510 How Does the .......................................................................................................................................................... Com panies New s Metadata Constraint Work? 510 How Does the .......................................................................................................................................................... Topics New s Metadata Constraint Work? 510 How Does the .......................................................................................................................................................... Products New s Metadata Constraint Work? 510 How Does the .......................................................................................................................................................... Attribution New s Metadata Constraint Work? 511 What is a Nam .......................................................................................................................................................... ed Item ? 511

8 Special ................................................................................................................................... Characters in Thomson Reuters News 511

Chapter XXIV

Online Reports

512

1 Authentication/Authorization, Service Endpoint, and Required Headers ................................................................................................................................... 512 2 WSDL ................................................................................................................................... 512 3 Get Summary ................................................................................................................................... by Topic (GetSummaryByTopic_1) 512 4 Get Summaries ................................................................................................................................... by Stories (GetSummaryByStories_1) 515 5 Get Headlines ................................................................................................................................... (GetHeadlines_Request_1) 516 6 Get Topics ................................................................................................................................... (GetTopics_Request_2) 518 7 Retrieving ................................................................................................................................... Images Associated with Online Reports 519 8 Retrieving ................................................................................................................................... Stories without Duplicates 520

Chapter XXV

People Search

522

1 Authentication/Authorization, Service Endpoint, and Required Headers ................................................................................................................................... 522 2 WSDL ................................................................................................................................... 522 3 Get Detail ................................................................................................................................... (GetDetail_1) 523
Understanding .......................................................................................................................................................... GetDetail_1 Response 525 526 Corporate......................................................................................................................................................... Affiliations ......................................................................................................................................................... 526 Position Information ......................................................................................................................................................... 527 Biographical Information ......................................................................................................................................................... 528 Salary Information ......................................................................................................................................................... 528 Person Information

4 Get Person ................................................................................................................................... Relationships (GetPersonRelationships_1) 529 5 Get Relational ................................................................................................................................... Path (GetRelationalPath_1) 531 6 Get Search ................................................................................................................................... (GetSearch_1) 533

Chapter XXVI

Permissioning

536

1 Authentication/Authorization, Service Endpoint, and Required Headers ................................................................................................................................... 536 2 WSDL ................................................................................................................................... 536 3 Set Permissioning Groups Membership (SetPermGroupsMembership_1) ................................................................................................................................... 536

Chapter XXVII

Portfolio Tracker

538

CONTENTS

15

1 Conflation ................................................................................................................................... 538 2 Two................................................................................................................................... Methods of Working with Portfolios 538 3 Authentication/Authorization, Service Endpoint, and Required Headers ................................................................................................................................... 538 4 WSDL ................................................................................................................................... 539 5 Instrument ................................................................................................................................... Coverage 539 6 Cash ................................................................................................................................... holding 539 7 Portfolio ................................................................................................................................... fields and calculations 540 8 Working ................................................................................................................................... with a Portfolio 542
Creating a Portfolio .......................................................................................................................................................... (CreatePortfolio_Request_1) 542 Get User Portfolios .......................................................................................................................................................... (GetUserPortfolios_Request_1) 543 Editing a Portfolio .......................................................................................................................................................... (EditPortfolio_Request_1) 544 Deleting a Portfolio .......................................................................................................................................................... (DeletePortfolio_Request_1) 545

9 Working ................................................................................................................................... with Instruments 546

Add Instrum.......................................................................................................................................................... ents (AddInstrum ents_Request_1) 546 Buy Instrum ents .......................................................................................................................................................... (BuyInstrum ents_Request_1) 548 Sell Instrum ents .......................................................................................................................................................... (SellInstrum ents_Request_1) 549 Edit Instrum ents .......................................................................................................................................................... (EditInstrum ents_Request_1) 551 Rem ove Instrum .......................................................................................................................................................... ents (Rem oveInstrum ents_Request_1) 553

10 Retrieving ................................................................................................................................... Portfolio Views 554

Position View .......................................................................................................................................................... 554 PL View .......................................................................................................................................................... 556 Prices View .......................................................................................................................................................... 557 Sum m ary View .......................................................................................................................................................... 559 Valuation View .......................................................................................................................................................... 560

11 Client ................................................................................................................................... Portfolio View 562

Chapter XXVIII

Profiles

565

1 Authentication/Authorization, Service Endpoint, and Required Headers ................................................................................................................................... 565 2 WSDL ................................................................................................................................... 566 3 Create ................................................................................................................................... Profile (CreateProfile_1) 566 4 Delete ................................................................................................................................... Profile (DeleteProfile_1) 567 5 Get Profile ................................................................................................................................... (GetProfile_1) 568 6 Get Profile ................................................................................................................................... Email (GetProfileEmail_1) 569 7 Get Profile ................................................................................................................................... Schedule (GetProfileSchedule_1) 569 8 Get User ................................................................................................................................... Profiles (GetUserProfiles_1) 570 9 Get Use ................................................................................................................................... Template (GetUseTemplate_1) 571 10 Set Alert ................................................................................................................................... Type (SetAlertType_1) 572 11 Set Profile ................................................................................................................................... Email (SetProfileEmail_1) 573 12 Set Profile ................................................................................................................................... Schedule (SetProfileSchedule_1) 573 13 Set Use ................................................................................................................................... Template (SetUseTemplate_1) 574 14 Update ................................................................................................................................... Profile (UpdateProfile_1) 575 15 Mapping ................................................................................................................................... from Document Search Set Code to Profile Set Code 576

16

TRKD API Developer's Guide

16 Alerts Return ctSubjectsResp Different from ctsubjects in Created Profiles ................................................................................................................................... 576

Chapter XXIX

Purchase History

578

1 Authentication/Authorization, Service Endpoint, and Required Headers ................................................................................................................................... 578 2 WSDL ................................................................................................................................... 578 3 Get Purchase ................................................................................................................................... History (GetPurchaseHistory_1) 578 4 Get Purchase ................................................................................................................................... History Admin (GetPurchaseHistoryAdmin_1) 580

Chapter XXX

Quote Lists

582

1 Conflation ................................................................................................................................... 582 2 Quote ................................................................................................................................... data 582 3 Authentication/Authorization, Service Endpoint, and Required Headers ................................................................................................................................... 582 4 WSDL ................................................................................................................................... 583 5 Working ................................................................................................................................... with QuoteLists 583
Create QuoteList .......................................................................................................................................................... (CreateQuoteList_1) 583 Get QuoteList .......................................................................................................................................................... (GetQuoteList_Request_1) 586 Delete QuoteList .......................................................................................................................................................... (DeleteQuoteList_Request_1) 588 Get Listing (GetListing_Request_1) .......................................................................................................................................................... 589

6 Working ................................................................................................................................... with Instruments 590

Add RICs and .......................................................................................................................................................... FIDs (AddRICsFIDs_Request_1) 590 Rem ove RICs .......................................................................................................................................................... and FIDs (Rem oveRICsFIDs_Request_1) 592

7 Get Simple ................................................................................................................................... Data 594

Chapter XXXI

Quote

597

1 Quote ................................................................................................................................... Performance 597 2 Conflation ................................................................................................................................... 599 3 Quote ................................................................................................................................... Data 599 4 Quote ................................................................................................................................... Chain Data 599 5 Company ................................................................................................................................... Background Information 599 6 Authentication/Authorization, Service Endpoint, and Required Headers ................................................................................................................................... 600 7 WSDL ................................................................................................................................... 600 8 Retrieving ................................................................................................................................... Quotes (RetrieveItem_Request_3) 600 9 Retrieving ................................................................................................................................... Quote Chain 604

Chapter XXXII

Reference Information

607

1 Authentication/Authorization, Service Endpoint, and Required Headers ................................................................................................................................... 607 2 WSDL ................................................................................................................................... 607 3 Understanding ................................................................................................................................... Reference Information Request 608
Understanding .......................................................................................................................................................... Reuters Know ledge Direct API Codes 608

CONTENTS

17

......................................................................................................................................................... 608 Global Codes ......................................................................................................................................................... 608 Local Codes ......................................................................................................................................................... 609 Set Codes ......................................................................................................................................................... 609 UIDs Countries .......................................................................................................................................................... 609 Currencies .......................................................................................................................................................... 610 Industries .......................................................................................................................................................... 610 Regions .......................................................................................................................................................... 611 Categories .......................................................................................................................................................... 612 Contributors.......................................................................................................................................................... 612 Languages .......................................................................................................................................................... 613 Subjects .......................................................................................................................................................... 614 Type of Analysis .......................................................................................................................................................... (Disciplines) 614 Research Categories .......................................................................................................................................................... (Report Styles) 615 Research Subjects .......................................................................................................................................................... 615 Research Purpose .......................................................................................................................................................... (Reasons) 616

4 Get Information ................................................................................................................................... (GetInfo_1) 617 5 Get Information, ................................................................................................................................... Extended (GetInfoEx_1) 618 6 Get Information ................................................................................................................................... from UID (GetInfoFromUid_1) 619 7 Get Information ................................................................................................................................... from UID, Extended (GetInfoFromUidEx_1) 620 8 Get Intelligent ................................................................................................................................... Categorization Information (IcatGetInfo_1) 622

Chapter XXXIII

Research On Demand

624

1 Authentication/Authorization, Service Endpoint, and Required Headers ................................................................................................................................... 624 2 WSDL ................................................................................................................................... 624 3 Calculate ................................................................................................................................... Document Price (CalculateDocPrice_1) 625 4 Get Price ................................................................................................................................... per Page (GetPricePerPage_1) 626 5 Get Document ................................................................................................................................... Disclaimer (GetDocDisclaimer_1) 626 6 Check ................................................................................................................................... per Page Download (CheckPerPageDownload_1) 627

Chapter XXXIV

Thomson Reuters Search

629

1 Authentication ................................................................................................................................... and Authorization 629 2 Common ................................................................................................................................... Elements 629

Query Header .......................................................................................................................................................... 629 Query .......................................................................................................................................................... 630 Filter .......................................................................................................................................................... 632 Searchable Field .......................................................................................................................................................... Types 633 Difference betw .......................................................................................................................................................... een Query and Filter in Thom son Reuters Search 634

3 Thomson ................................................................................................................................... Reuters Search Requests 634

SearchAll Request .......................................................................................................................................................... (GetSearchall_Request_1) 634 ......................................................................................................................................................... 635 Service Endpoint and Required Headers ......................................................................................................................................................... 635 WSDL ......................................................................................................................................................... 635 Using Navigation ......................................................................................................................................................... 637 Search for Primary RIC using Company Name ......................................................................................................................................................... 638 Search by Asset Category 640 Retrieving......................................................................................................................................................... RIC List From an Exchange 642 Retrieving......................................................................................................................................................... RIC of an Exchange

18

TRKD API Developer's Guide

......................................................................................................................................................... 643 RIC Search in a Specified Exchange ......................................................................................................................................................... 644 Search for a RIC on the Nasdaq exchange using the ticker MSFT ......................................................................................................................................................... 646 Retrieving a Breakdow n of Search Results by Asset Class When to Use SearchAll and When More Specific Search Functions Like ......................................................................................................................................................... 646 Equity Quote? Organization.......................................................................................................................................................... (GetOrganisation_1) 646 ......................................................................................................................................................... 646 Service Endpoint and Required Headers ......................................................................................................................................................... 646 WSDL ......................................................................................................................................................... 647 Organization Search on Location ......................................................................................................................................................... 649 Organization Search by Ticker Com m odity Quote .......................................................................................................................................................... (GetCom m odityQuote_Request_1) 650 ......................................................................................................................................................... 650 Service Endpoint, and Required Headers ......................................................................................................................................................... 650 WSDL ......................................................................................................................................................... 651 Commodity Search on Coffee ......................................................................................................................................................... 652 Commodity Search w ith a Filter Derivative Instrum .......................................................................................................................................................... ents (GetDerivativeInst_1) 654 ......................................................................................................................................................... 654 Service Endpoint and Required Headers ......................................................................................................................................................... 655 WSDL 655 Retrieving......................................................................................................................................................... Warrants for an Underlying Issuer Derivative Quote .......................................................................................................................................................... (GetDerivativeQuote_1) 656 ......................................................................................................................................................... 657 Service Endpoint and Required Headers ......................................................................................................................................................... 657 WSDL ......................................................................................................................................................... 657 Search for Index Membership Equity Quote.......................................................................................................................................................... (GetEquityQuote_1) 659 ......................................................................................................................................................... 659 Service Endpoint and Required Headers ......................................................................................................................................................... 659 WSDL ......................................................................................................................................................... 659 Retrieve All RICs for a Particular Index ......................................................................................................................................................... 660 Search for all Equity RICs from the London Stock Exchange Search for IBM trading on a number of Named Exchanges (New York, ......................................................................................................................................................... 662 Hamburg and Euro TLX) ......................................................................................................................................................... 664 Search for Quote Detail by Issuer Ticker ......................................................................................................................................................... 665 Search for Quote Detail by Issuer MXID ......................................................................................................................................................... 666 Search for Quote Detail by Estimate ID 669 Retrieving......................................................................................................................................................... MXID by Company Name 670 Retrieving......................................................................................................................................................... MXID by Company Symbol 672 Retrieving......................................................................................................................................................... Estimate ID by Company Name 673 Retrieving......................................................................................................................................................... Estimate IDs by Company Symbols Fund Quote (GetFundQuote_1) .......................................................................................................................................................... 674 ......................................................................................................................................................... 674 Service Endpoint and Required Headers ......................................................................................................................................................... 674 WSDL ......................................................................................................................................................... 674 Fund Search w ith Currency and Exchange Information Governm ent.......................................................................................................................................................... and Corporate Bond Instrum ents (GetGovCorpInst_1) 676 ......................................................................................................................................................... 676 Service Endpoint and Required Headers ......................................................................................................................................................... 676 WSDL ......................................................................................................................................................... 676 Search on Government and Corporate Bond Instruments Index Instrum .......................................................................................................................................................... ents 678 ......................................................................................................................................................... 678 Service Endpoint and Required Headers ......................................................................................................................................................... 678 WSDL Index Quote .......................................................................................................................................................... 678 ......................................................................................................................................................... 679 Service Endpoint and Required Headers ......................................................................................................................................................... 679 WSDL 679 Retrieving......................................................................................................................................................... Index by PI

4 Understanding ................................................................................................................................... the Thomson Reuters Search Response 680

Result Header .......................................................................................................................................................... 680

CONTENTS

19

Navigator List .......................................................................................................................................................... 681 Result .......................................................................................................................................................... 681

Chapter XXXV

Screener

683

1 Authentication/Authorization, Service Endpoint, and Required Headers ................................................................................................................................... 683 2 WSDL ................................................................................................................................... 683 3 Data................................................................................................................................... Organization 684 4 Variables ................................................................................................................................... 684
Getting Actual .......................................................................................................................................................... Codes for Variables 684

5 Lists................................................................................................................................... 685
Com pany Lists .......................................................................................................................................................... 685

6 Screening ................................................................................................................................... 685 7 Format ................................................................................................................................... 686 8 Calculation ................................................................................................................................... Request 686
Using Position .......................................................................................................................................................... for Searching 686 Sort Order .......................................................................................................................................................... 687 Statistics .......................................................................................................................................................... 687

9 Supported ................................................................................................................................... Operations 687 10 Supported ................................................................................................................................... Functions 688

Num eric Infinity .......................................................................................................................................................... and Not-a-Num ber 689 Extended String .......................................................................................................................................................... and Array Com parison Functions 689

11 Example ................................................................................................................................... Requests 689

Calculation Requests .......................................................................................................................................................... 690 Getting Variables .......................................................................................................................................................... (GetVar_1) 690 Checking for .......................................................................................................................................................... Validity 691 Screening Com .......................................................................................................................................................... pany Lists 692 ......................................................................................................................................................... 693 Using Criteria for an Exact List ......................................................................................................................................................... 693 Including/Excluding Companies from the List Working w ith .......................................................................................................................................................... Form s 694 Positioning, Paging, .......................................................................................................................................................... and Search 694 ......................................................................................................................................................... 695 Implementing Paging Searching......................................................................................................................................................... 695 Grouping .......................................................................................................................................................... 697 ......................................................................................................................................................... 698 Position Grouping Single Value .......................................................................................................................................................... Colum ns 698 Custom Colum .......................................................................................................................................................... ns 700 Defining Scope .......................................................................................................................................................... of Request 701

12 Application ................................................................................................................................... Logic 702

Chapter XXXVI

Significant Developments

705

1 Authentication/Authorization, Service Endpoint, and Required Headers ................................................................................................................................... 705 2 WSDL ................................................................................................................................... 705 3 Significant ................................................................................................................................... Developments Requests 706
XSD .......................................................................................................................................................... 708 Com pany Requests .......................................................................................................................................................... 708 Multiple Com .......................................................................................................................................................... pany Request 708

20

TRKD API Developer's Guide

Period Specific .......................................................................................................................................................... Requests 709 Significance .......................................................................................................................................................... Level Requests 709 Specifying the .......................................................................................................................................................... Num ber of Developm ents 710 Topic Code Requests .......................................................................................................................................................... 710 Front Page Requests .......................................................................................................................................................... 711 Developm ent .......................................................................................................................................................... ID Requests 711

4 Understanding ................................................................................................................................... the Significant Development Response 712 5 Handling ................................................................................................................................... Dual-listed Companies 714 6 Topics ................................................................................................................................... and Descriptions 714

Chapter XXXVII

Street Events

717

1 Authentication/Authorization, Service Endpoint, and Required Headers ................................................................................................................................... 717 2 WSDL ................................................................................................................................... 717 3 Get Economic ................................................................................................................................... Headlines (GetEconomicHeadlines_1) 718 4 Get Event ................................................................................................................................... (GetEvent_1) 720 5 Get Event ................................................................................................................................... Headlines (GetEventHeadlines_1) 722 6 Get Event ................................................................................................................................... Headlines Overview (GetEventHeadlinesOverview_1) 725 7 Get Webcast ................................................................................................................................... Url (GetWebcastUrl_1) 726 8 StreetEvents ................................................................................................................................... Data Type Reference 727
Request Data .......................................................................................................................................................... Types 727 ......................................................................................................................................................... 727 EventType Pagination......................................................................................................................................................... 727 ......................................................................................................................................................... 728 PaginationResult ......................................................................................................................................................... 728 SortCriterion ......................................................................................................................................................... 728 SymbolCriterion Response Data .......................................................................................................................................................... Types 728 ......................................................................................................................................................... 728 Event ......................................................................................................................................................... 730 EventOverview Headline ......................................................................................................................................................... 731 ......................................................................................................................................................... 732 EconomicHeadlines ......................................................................................................................................................... 733 IdcPaymentTypeCode1 ......................................................................................................................................................... 733 IdcPaymentTypeCode2

Chapter XXXVIII

Time Series

735

1 Authentication/Authorization, Service Endpoint, and Required Headers ................................................................................................................................... 735 2 WSDL ................................................................................................................................... 735 3 InterDay ................................................................................................................................... 735
Retrieving Daily .......................................................................................................................................................... InterDay Data 736

4 IntraDay ................................................................................................................................... 737

Retrieving Hourly .......................................................................................................................................................... Intraday Data 738

Chapter XXXIX

User Information Update

740

1 Authentication/Authorization, Service Endpoint, and Required Headers ................................................................................................................................... 740 2 WSDL ................................................................................................................................... 740

CONTENTS

21

3 Create ................................................................................................................................... User (Create_1) 740 4 Get Accounts ................................................................................................................................... by Company ID (GetAccountsByCompanyId_1) 742 5 Modify ................................................................................................................................... User (Modify_1) 743 6 Get User ................................................................................................................................... Information (GetUserInfo_1) 744

Chapter XL

Web Views

746

1 Identifying ................................................................................................................................... the User 746

Authorizing Service .......................................................................................................................................................... Users 746 Authorizing Effective .......................................................................................................................................................... Users 747 Working w ithout .......................................................................................................................................................... Cookies 748

2 Preference ................................................................................................................................... Configuration 748 3 Client ................................................................................................................................... File Management Configuration 749 4 Library ................................................................................................................................... of TRKD API Web Views 750
Index Web View .......................................................................................................................................................... 752 Header Banner .......................................................................................................................................................... Web View 752 Thin Disclaim .......................................................................................................................................................... er Web View 753 Disclaim er Web .......................................................................................................................................................... View 754 Quotes Web .......................................................................................................................................................... View 755 Quote Chain .......................................................................................................................................................... Web View 756 QuoteList Web .......................................................................................................................................................... View 758 New s Web View .......................................................................................................................................................... 760 New s Story Web .......................................................................................................................................................... View 763 Charts Web View .......................................................................................................................................................... 763 Search Web View .......................................................................................................................................................... 769 Significant Developm .......................................................................................................................................................... ents Web View 775 Fundam entals .......................................................................................................................................................... Web View 777 Estim ates Web .......................................................................................................................................................... View 779 Online Reports .......................................................................................................................................................... 781 Lipper .......................................................................................................................................................... 785 ......................................................................................................................................................... 786 Lipper Asset Allocation ......................................................................................................................................................... 787 Lipper Asset Attributes ......................................................................................................................................................... 787 Lipper Asset Summary ......................................................................................................................................................... 789 Lipper Benchmark ......................................................................................................................................................... 790 Lipper Charges ......................................................................................................................................................... 791 Lipper Countries Registered For Sale ......................................................................................................................................................... 792 Lipper Cross References ......................................................................................................................................................... 793 Lipper Leader Score Card ......................................................................................................................................................... 794 Lipper Leader Score Card 2 ......................................................................................................................................................... 796 Lipper Minimum Investment ......................................................................................................................................................... 797 Lipper Objective ......................................................................................................................................................... 798 Lipper Support Companies ......................................................................................................................................................... 799 Lipper Technical Analysis ......................................................................................................................................................... 800 Lipper TotalNetAsset History ......................................................................................................................................................... 801 Lipper Top10 Holdings ......................................................................................................................................................... 803 Lipper Classifications ......................................................................................................................................................... 804 Lipper Performance Header ......................................................................................................................................................... 805 Lipper European Union Tax Directive ......................................................................................................................................................... 806 Lipper Search ......................................................................................................................................................... 807 Lipper Overview ......................................................................................................................................................... 808 Lipper Top Performing Funds (All) ......................................................................................................................................................... 809 Lipper Bottom Performing Funds (All)

22

TRKD API Developer's Guide

Lipper Lipper Lipper Lipper Lipper

......................................................................................................................................................... 810 Top Performing Funds (by LGC) ......................................................................................................................................................... 811 Bottom Performing Funds (by LGC) ......................................................................................................................................................... 812 Comparative Performance ......................................................................................................................................................... 813 New ly Available Funds ......................................................................................................................................................... 815 Calendar Year Performance

5 Error ................................................................................................................................... Messaging 816 6 Support ................................................................................................................................... 816 7 Standard ................................................................................................................................... Time Zones 816 8 Chart ................................................................................................................................... Skins 818

Chapter XLI

Troubleshooting and Debugging Your Application

829

1 Interpreting ................................................................................................................................... SOAP Faults 829 2 The ................................................................................................................................... ClientErrorReference 830 3 Using ................................................................................................................................... MessageID 831 4 Using Request Examples from Developer's Guide in the API Console ................................................................................................................................... 831 5 Contacting ................................................................................................................................... Support 832

Chapter XLII

Coding Examples

833

1 Prerequisites ................................................................................................................................... 833 2 Working ................................................................................................................................... with the Client Code Samples 833
Installing a Code .......................................................................................................................................................... Sam ple 834 Building a Code .......................................................................................................................................................... Sam ple 834 Running a Code .......................................................................................................................................................... Sam ple 834

3 Creating ................................................................................................................................... Your Own Client Application 835

Using Generated .......................................................................................................................................................... Proxy Classes 835 ......................................................................................................................................................... 835 Dow nloading XSDs and WSDLs Generating Proxy .......................................................................................................................................................... Classes 836 Creating a Service .......................................................................................................................................................... Token 836 Caching Tokens .......................................................................................................................................................... and Handling Token Expiration 836 Using MessageID .......................................................................................................................................................... 837 Handling Errors .......................................................................................................................................................... (Faults) 837 Overriding Server .......................................................................................................................................................... Certificate Validation 838 Supporting Responses .......................................................................................................................................................... Larger than 65,536 Bytes 838 Connecting to .......................................................................................................................................................... TRKD API Servers Being behind a Proxy 838

4 Debugging ................................................................................................................................... Request/Response Problems 838

Chapter XLIII

Building Java TRKD Client

840

1 TRKD ................................................................................................................................... Metadata 840

Nam ing Rules .......................................................................................................................................................... 840 Supported Bindings .......................................................................................................................................................... 840 Metada Files.......................................................................................................................................................... Location 840

2 Prerequisites ................................................................................................................................... 841

Sun JDK .......................................................................................................................................................... 841 Fram ew ork .......................................................................................................................................................... 841 Apache Ant .......................................................................................................................................................... 841

CONTENTS

23

Eclipse

.......................................................................................................................................................... 841

3 Generating ................................................................................................................................... Java Proxy Code 841

Using Wsim port .......................................................................................................................................................... Utility Tool Ant Task from Sun Metro Fram ew ork 841 ......................................................................................................................................................... 841 TRKD Java Classes for TRKD Services ......................................................................................................................................................... 842 Generating Proper Java Package Names ......................................................................................................................................................... 843 Running Ant Script

4 Creating Eclipse Project Based on Java Files Generated by Wsimport ................................................................................................................................... Ant Task Using Sun Metro Framework 844 5 Creating Java Client Application for Webservice Access in Eclipse ................................................................................................................................... Project 858 6 Client ................................................................................................................................... Code Sample 860
Sun Metro .......................................................................................................................................................... 860 Running Code .......................................................................................................................................................... Sam ple 864

7 Code ................................................................................................................................... Style Recommendations 865 8 Typical ................................................................................................................................... Problems 865

Errors w hen.......................................................................................................................................................... Trying to Im port WSDL via Java IDEs 866 MustUnderstand .......................................................................................................................................................... Exception 866

24

TRKD API Developer's Guide

chapter 1

Overview

Thomson Reuters Knowledge Direct API (TRKD API) offers a wide range of Thomson Reuters information and services delivered in a request-response scenario via web services. Services available via TRKD include quotes, news and charts, as well as value-add data such as Fundamentals, Estimates and Significant Developments. Connectivity can be via HTTP and HTTPS, over the Internet or BT-Radianz/RXN, using todays industry standard protocols (SOAP and XML). Thomson Reuters Knowledge Direct API is robust and scalable enough to handle traffic from even the most demanding sites while providing highly extensible support abilities to front and back-end infrastructures. The framework of layered architecture components allows for ease of integration and rapid deployment. Furthermore, the disintegration of the traditional user-interface (UI) layer provides for large-scale flexibility to the end-consumers or agents and a full-range of configurable data/information delivery scenarios. This is largely supported through the exposure of standards-based XML/ Web infrastructures for platform-independent data exchanges. The platform employs clusters of micro and macro components that granularly provide its building block definitions. These building blocks are key to the realization of the plug and play functionality model exposed to market participants through services integration or subscription based delivery services. TRKD API clearly introduces the benefits of maximizing one's best assets to clients (whether information or application-based services), as the platform enables unbounded electronic and information commerce abilities. The TRKD platform provides professional, quality investment information and data access from a singular information source. The platform services model caters to a full breadth and range of decision critical investment information (news, quotes, earnings, for example), as well as an infrastructure that allows for ease of discovery, personalization, navigation and subsequent delivery of information services to a firm.

Preface

25

chapter 2

Preface

This document is intended as a developers guide for the Thomson Reuters Knowledge Direct API (TRKD API). The guide contains a general introduction, tasks and examples, and coding samples.

2.1

Intended Audience
This document is intended for developers building application using the Thomson Reuters Knowledge Direct API. This document assumes you are familiar with Web Services and related technologies, including XML and HTTP. Thomson Reuters Knowledge Direct does not require you to code using any particular technology platform. However, this document does include coding examples as a suggested approach.

2.2

Using this Guide

Begin with the Overview and Getting Started. Then spend a good deal of time with Authentication and Authorization. After you are comfortable with these concepts, you can proceed directly to chapters detailing the specific services you purchased. Although Thomson Reuters Knowledge Direct does not require you to code using any particular technology platform, this document includes a chapter of coding examples as a suggested approach. You should review these examples before you start coding.

2.3

Where to Get More Information

For more information about Thomson Reuters Knowledge Direct, visit the Customer Zone, http://www.reuters.com/customer. Log in and navigate to the Thomson Reuters Knowledge Direct product page. The Thomson Reuters Knowledge Direct product page includes links to coding samples, FAQs, development support tools, etc. The developer support tools include our Request Builder harness, where you can easily construct API requests and examine responses. Thomson Reuters Knowledge Direct product page also links to Contact Us, where you can request help from our support staff.

26

TRKD API Developer's Guide

chapter 3

Getting Started

This section provides an introduction to the TRKD API including description of fundamental concepts.

3.1

Before You Begin

Before you can begin accessing Thomson Reuters Knowledge Direct API, you must contact Thomson Reuters (https:// customers.reuters.com/crmcontactus/support.asp) and receive a properly entitled service user credential. Thomson Reuters also gives you an application identification string (appid). This appid is a short descriptive string that uniquely identifies your application.

3.2

Understanding Service Users, Impersonation (Effective Users)

You can use a single credential (service user) for all users of your application or support individual user credentials (impersonation through effective users). The user credential provides the appropriate entitlements (rights) to data from various services. For example, a credential may be limited to estimates from particular regions. A single service user is all you need for applications where all users have the same entitlements. However, the most common scenario is an application that supports individual user credentials (impersonation through effective users). To accomplish this, your application first creates a service token using your service user credential (CreateServiceToken_Request). Next, with the service token you created, your application makes a second request passing the particular effective user credential (CreateImpersonationToken_Request). The application then passes this impersonation token with each data request.

3.3

Understanding Application Identification Strings (appids)

An application identification string (appid) is a short descriptive string that uniquely identifies your application for tracking and entitlement purposes. Thomson Reuters assigns an appid to you during setup. Your application submits this appid with each API request.

3.4

Understanding Authentication Tokens

An authentication token is an encrypted, expiring string that securely identifies the service user (or effective user). Your application must pass an authentication token in each web service request. To create a token representing the service user (service token), use CreateServiceToken_Request. To create a token representing a particular effective user credential (impersonation token), use CreateImpersonationToken_Request. For additional information, see section Authentication and Authorization.

3.5

An Example API Interaction

The following demonstrates API requests and responses for an application that displays significant developments. Step 1: Create a service token Service endpoint:
https://api.rkd.reuters.com/api/2006/05/01/TokenM anagement_1.sv c/A nony mous

HTTP headers:

Getting Started

27

P O S T /2006/05/01/TokenM anagement_1.sv c H TTP /1.1 C ontent-Ty pe: application/soap+xml H ost: api.rkd.reuters.com

XML Sample Request - Creating a Service Token

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2006/05/01/TokenM anagement_1.sv c/A nony mous</ To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/TokenM anagement_1/ C reateS erv iceToken_1</A ction> </H eader> <Body > <C reateS erv iceToken_Request_1 xmlns:global="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1" xmlns="http://w w w . reuters.com/ns/2006/05/01/w ebserv ices/rkd/TokenM anagement_1"> <global:A pplicationID>[A ppID]</global:A pplicationID> <U sername>[serv ice user]</U sername> <P assw ord>[passw ord]</P assw ord> </C reateS erv iceToken_Request_1> </Body > </E nv elope>

XML Sample Response - Creating a Service Token

<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader> <a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" s:mustU nderstand="1" >http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/ rkd/TokenM anagement_1/C reateS erv iceToken_1_Reply </a:A ction> <a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <C reateS erv iceToken_Response_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/TokenM anagement_1"> <E xpiration>[token expiration YYYY-M M -DDTH H :M M :S S ]</E xpiration> <Token xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1">[serv ice token]</Token> </C reateS erv iceToken_Response_1> </Body > </E nv elope>

Retrieve the token from the response XML. You should cache the token and reuse it until it expires (90 minutes, by default). Step 2: Create an impersonation token Service endpoint:
http://api.rkd.reuters.com/api/2006/05/01/TokenM anagement_1.sv c

HTTP headers:
P O S T /2006/05/01/TokenM anagement_1.sv c H TTP /1.1 C ontent-Ty pe: application/soap+xml H ost: api.rkd.reuters.com

XML Sample Request - Creating an Impersonation Token (Reuters effective user)

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://ny csdev rkd1/api/2006/05/01/TokenM anagement_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/TokenM anagement_1/ C reateImpersonationToken_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body >

28

TRKD API Developer's Guide

<C reateImpersonationToken_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/TokenM anagement_1"> <E ffectiv eU sername>[effectiv e user]</E ffectiv eU sername> </C reateImpersonationToken_Request_1> </Body > </E nv elope>

XML Sample Response - Creating an Impersonation Token (Reuters effective user)

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" s:mustU nderstand="1" >http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/ rkd/TokenM anagement_1/C reateImpersonationToken_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]<RelatesTo> <H eader> <Body > <C reateImpersonationToken_Response_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/TokenM anagement_1"> <E xpiration>[token expiration YYYY-M M -DDTH H :M M :S S ]</E xpiration> <Token xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1">[impersonation token]</Token> </C reateImpersonationToken_Response_1> </Body > </E nv elope>

Retrieve the token from the response XML. You should cache the token and reuse it until it expires (90 minutes, by default). Note: You can handle both Step 1 (Creating a Service Token) and Step 2 (Creating Impersonation Token) in one step by calling CreateImpersonationToken_Request_2 operation. See section Creating Service and Impersonation Token in One Request for more information. Step 3: Request the significant developments Service endpoint:
http://api.rkd.reuters.com/api/2006/05/01/S ignificantDev elopments_1.sv c

HTTP headers:
P O S T /2006/05/01/S ignificantDev elopments_1.sv c H TTP /1.1 C ontent-Ty pe: application/soap+xml H ost: api.rkd.reuters.com

XML Sample Request - Significant Development

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/rkd/2006/05/01/S ignificantDev elopments_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/rkd/ns/2006/05/01/w ebserv ices/rkd/ S ignificantDev elopments_1/G etS ignificantDev elopments_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etS ignificantDev elopments_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S ignificantDev elopments_1"> <F indRequest S ignificance="1 2 3" M axN umberO fItems="100"> <C ompany Identifiers> <RIC V alue="rtr.l" /> </C ompany Identifiers> </F indRequest> </G etS ignificantDev elopments_Request_1> </Body > </E nv elope>

XML Sample Response - Significant Development

<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing">

Getting Started

29

<s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S ignificantDev elopments_1/ G etS ignificantDev elopments_1Response</a:A ction> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etS ignificantDev elopments_Response_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S ignificantDev elopments_1"> <F indResponse> <Dev elopment> <Xrefs> <RepN o>A 488E </RepN o> <Dev elopmentId>801980</Dev elopmentId> </Xrefs> <Dates> <S ource>2006-08-14T23:00:00.0000000-04:00</S ource> <Initiation>2006-08-16T06:50:42.5200000-04:00</Initiation> <LastU pdate>2006-08-22T13:38:12.0100000-04:00</LastU pdate> </Dates> <F lags> <F rontP age>false</F rontP age> <S ignificance>3</S ignificance> </F lags> <Topics> <Topic1 C ode="204">Business Deals</Topic1> </Topics> <H eadline>Reuters G roup P LC C loses Deal w ith Lukoil, Russia's O il C ompany </H eadline> <Description>Reuters G roup P LC announced that its M oscow office has closed a deal w ith Lukoil, Russia's oil company , for 11 Reuters 3000 Xtra and 21 Reuters Trader for C ommodities key stations, w ith the Russian new s serv ice and specialist data.</ Description> </Dev elopment> </F indResponse> </G etS ignificantDev elopments_Response_1> </s:Body > </s:E nv elope>

3.6

Web Services Standards

TRKD API applies the following Web and Web services standards: HyperText Transfer Protocol (HTTP) - used as the primary transport for TRKD API. Note: Starting with TRKD API 1.14 Release users can use HyperText Transfer Protocol Secure (HTTPS) for data requests like estimates, news, etc. Secure Sockets Layer (SSL) - used for HTTP session encryption for token creation request messages, where user credentials would otherwise be an unencrypted plain-text part of the SOAP payload. XML Schema (http://www.w3.org/2001/XMLSchema) - All TRKD API services use XML Schema to describe the structure of the data being exchanged with the client. In addition to being used by clients to understand the nature of the data exchange, XSD schemas are also used for validating SOAP requests. SOAP 1.2 (http://www.w3.org/2003/05/soap-envelope) - defines a standard for generic XML data exchange in a way that supports describing metadata along with the service payload data. Note: Starting with TRKD API 1.14 Release SOAP 1.1 is supported. See example below. WSDL 1.1 (http://schemas.xmlsoap.org/wsdl/) - provides a standard way to describe the service interfaces, access methods, and specific service endpoint locations. WSDL Binding Extension for SOAP 1.2 (http://schemas.xmlsoap.org/wsdl/soap12/) WS-Policy (http://schemas.xmlsoap.org/ws/2004/09/policy) - provides a basic framework for how web services describe their policies. The related WS-PolicyAttachments provides mechanisms for describing how WS-Policy based information is described in WSDL documents. WS-Addressing 1.0 (http://www.w3.org/2005/08/addressing) - Web Services Addressing provides transportneutral mechanisms to address Web services and messages WS-Addressing 1.0 WSDL Binding (http://www.w3.org/2006/05/addressing/wsdl) - provides standard XML grammar for how WS-Addressing 1.0 properties are described in WSDL documents.

30

TRKD API Developer's Guide

XML Sample - SOAP 1.1 (Token Rejection Error)

<?xml v ersion="1.0" encoding="utf-8"?> <soap:E nv elope xmlns:soap="http://schemas.xmlsoap.org/soap/env elope/"> <soap:Body > <soap:F ault> <faultcode xmlns:a="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/F aults_1">a:Request_RejectedE xception</faultcode> <faultstring xml:lang="en-U S ">C redentials can't be passed v ia http to serv ice</faultstring> </soap:F ault> </soap:Body > </soap:E nv elope>

3.7

Date/Time Format
Thomson Reuters Knowledge Direct API services return date/time in UTC format: News: 2007-08-24T12:42:12-04:00 TimeSeries: 2007-08-24T12:42:12-05:00 Token Management Service: 2007-09-06T11:40:00.1782887Z Significant Developments: 2006-08-24T04:17:25.3730000-04:00 Quotes Service: 2007-03-01T05:00:00 Other services: 2007-03-01T05:00:00

Authentication and Authorization

31

chapter 4

Authentication and Authorization

Thomson Reuters Knowledge Direct API (TRKD API) uses an encrypted, expiring token to authenticate each request. To create this token, your application submits credentials to the Token Management service. The Token Management service authenticates the credentials and returns the token. Note that, unlike all other TRKD API transactions, you must make authentication and authorization requests (that is, requests to the TokenManagement_1 service) using HTTPS.

4.1

Understanding Application Identification Strings (appids)

An application identification string (appid) is a short descriptive string that uniquely identifies your application for tracking and entitlement purposes. Thomson Reuters assigns an appid to you during setup. Your application submits this appid with each API request. For a ServiceToken request (CreateServiceToken_Request_1), you must include the appid in the SOAP body: XML Sample Request - Creating a Service Token
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> ... <Body > <C reateS erv iceToken_Request_1 xmlns:global="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1" xmlns="http://w w w . reuters.com/ns/2006/05/01/w ebserv ices/rkd/TokenM anagement_1"> <A pplicationID xmlns="http://www.r euter s.com/ns/2 0 0 6 /0 5 /0 1 /webser vices/r kd/C ommon_1 ">[ A ppID] </ A pplicationID> <U sername>[serv ice user]</U sername> <P assw ord>[passw ord]</P assw ord> </C reateS erv iceToken_Request_1> </Body > </E nv elope>

For all other requests, you must include the appid in the SOAP header: XML Sample

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader > <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/rkd/2006/05/01/S ignificantDev elopments_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/rkd/ns/2006/05/01/w ebserv ices/rkd/ S ignificantDev elopments_1/G etS ignificantDev elopments_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[ A ppID] </A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader > ...

32

TRKD API Developer's Guide

4.2

Understanding Service Users, Impersonation (Effective Users)

You can use a single credential (service user) for all users of your application or support individual user credentials (impersonation through effective users). The user credential provides the appropriate entitlements (rights) to data from various services. For example, a credential may be limited to estimates from particular regions. A single service user is all you need for applications where all users have the same entitlements. However, the most common scenario is an application that supports individual user credentials (impersonation through effective users) to personalize each users experience. TRKD supports two types of effective users, depending on the particular service you are using: Reuters - This type of effective user represents an identity created (through manual administration during setup of your application) and maintained in the Thomson Reuters user data store. Reuters type is the default effective user type. Unmanaged - This type of effective user represents an identity with no entry in the Thomson Reuters user data store. Your application is responsible for maintaining this user identity. Please refer to the documentation about the particular service you are using for information about the effective user type that service supports.

4.3

Understanding Authentication Tokens

An authentication token is an encrypted, expiring string that securely identifies the service user (or effective user). Your application must pass an authentication token in each web service request. To create a token representing the service user (service token), use CreateServiceToken_Request. To create a token representing a particular effective user credential (impersonation token), your application makes a second request passing the particular effective user credential (CreateImpersonationToken_Request). The application then passes this impersonation token with each data request. Token Expiration Service tokens and impersonation tokens expire after a configurable time period. The default expiration is 90 minutes. You should code your application to reuse the token until the token expires. Note: You should not request a new token every time you make a request. It takes less time to get actual data than to get a new token. When TRKD API receives an expired token, the API returns a SOAP fault: XML Sample Response - Expired Token
<Description M ain="Token expired." /> <TornadoE rror> <s:F ault xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope"> <s:C ode> <s:V alue>s:Receiv er</s:V alue> <s:S ubcode> <s:V alue xmlns:a="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/F aults_1">a:G eneral_U nhandledE xception</s: V alue> </s:S ubcode> </s:C ode> <s:Reason> <s:Text xml:lang="en-U S ">Token expired.</s:Text> </s:Reason> <s:Detail> <C lientE rrorReference xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/F aults_1" xmlns:i="http://w w w .w 3. org/2001/XM LS chema-instance"> <Timestamp>2007-03-01T18:55:24.6070243Z</Timestamp> <E rrorReference>17e277ed6a0e4ba79ca97eb12403c5e0</E rrorReference> <S erv erReference>3F 81D8F 1444DB4083A 79F 37543B4B26BA F 3240F B7E 575C 85</S erv erReference> </C lientE rrorReference> </s:Detail> </s:F ault> </TornadoE rror>

Authentication and Authorization

33

Use this fault as a signal to create and cache a new token. For coding suggestions, see chapter Coding Examples. Note: Responses from the Token Management include the token expiration time. See section Creating a Token.

4.3.1

Creating a Token
Use the Token Management service to create tokens. Note that, unlike all other TRKD API transactions, you must make authentication and authorization requests (that is, requests to the TokenManagement_1 service) using HTTPS. Service Endpoint Token Management Endpoint
https://api.rkd.reuters.com/api/2006/05/01/TokenM anagement_1.sv c/A nony mous

Required Header Each post to the Token Management service must include the following HTTP headers: Required HTTP Headers
P O S T /2006/05/01/TokenM anagement_1.sv c/A nony mous H TTP /1.1 C ontent-Ty pe: application/soap+xml H ost: api.rkd.reuters.com C ontent-Length: [length]

You can use a single credential (service user) to create a service token that represents all users of your application or support individual user credentials (effective users) by creating an impersonation token representing each user. Creating a Service Token To create a token representing the service user (service user token), post a CreateServiceToken request to the Token Management service.

XML Sample Request - Creating a Service Token

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2006/05/01/TokenM anagement_1.sv c/A nony mous</ To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/TokenM anagement_1/ C reateS erv iceToken_1</A ction> </H eader> <Body > <C reateS erv iceToken_Request_1 xmlns:global="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1" xmlns="http://w w w . reuters.com/ns/2006/05/01/w ebserv ices/rkd/TokenM anagement_1"> <A pplicationID xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1">[A ppID]</A pplicationID> <U sername>[serv ice user]</U sername> <P assw ord>[passw ord]</P assw ord> </C reateS erv iceToken_Request_1> </Body > </E nv elope>

XML Sample Response - Creating a Service Token

<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader> <a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" s:mustU nderstand="1" >http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/ rkd/TokenM anagement_1/C reateS erv iceToken_1_Reply </a:A ction> <a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</a:RelatesTo> </s:H eader> <s:Body >

34

TRKD API Developer's Guide

<C reateS erv iceToken_Response_1 xmlns="https://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/TokenM anagement_1"> <E xpiration>[token expiration YYYY-M M -DDTH H :M M :S S ]</E xpiration> <Token xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1">[serv ice token]</Token> </C reateS erv iceToken_Response_1> </Body > </E nv elope>

Parse the response to retrieve the service token. If your application uses a single credential to represent all users, submit this service token with each data request. If your application supports individual user credentials, use this service token to create an impersonation token. Creating an Impersonation Token To create a token representing an individual user, post a Create Impersonation Token request to the Token Management service. You can create either a Reuters effective user or an Unmanaged effective user token. XML Sample Request - Creating an Impersonation Token (Reuters effective user)
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2006/05/01/TokenM anagement_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/TokenM anagement_1/ C reateImpersonationToken_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <C reateImpersonationToken_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/TokenM anagement_1"> <E ffectiv eU sername>[effectiv e user]</E ffectiv eU sername> </C reateImpersonationToken_Request_1> </Body > </E nv elope>

XML Sample Response - Creating an Impersonation Token (Reuters effective user)

<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader> <a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" s:mustU nderstand="1" >http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/ rkd/TokenM anagement_1/C reateS erv iceToken_1_Reply </a:A ction> <a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <C reateImpersonationToken_Response_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/TokenM anagement_1"> <E xpiration>[token expiration YYYY-M M -DDTH H :M M :S S ]</E xpiration> <Token xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1">[Impersonation Token]</Token> </C reateImpersonationToken_Response_1> </Body > </E nv elope>

XML Sample Request - Creating an Impersonation Token (Unmanaged effective user)

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2006/05/01/TokenM anagement_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/TokenM anagement_1/ C reateImpersonationToken_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader>

Authentication and Authorization

35

<Body > <C reateImpersonationToken_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/TokenM anagement_1"> <E ffectiv eU sername userTy pe="U nmanaged">[unmanaged user]</E ffectiv eU sername> </C reateImpersonationToken_Request_1> </Body > </E nv elope>

XML Sample Response - Creating an Impersonation Token (Unmanaged effective user)

<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader> <a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" s:mustU nderstand="1" >http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/ rkd/TokenM anagement_1/C reateS erv iceToken_1_Reply </a:A ction> <a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <C reateImpersonationToken_Response_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/TokenM anagement_1"> <E xpiration>[token expiration YYYY-M M -DDTH H :M M :S S ]</E xpiration> <Token xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1">[Impersonation Token]</Token> </C reateImpersonationToken_Response_1> </Body > </E nv elope>

Note that the Create Impersonation Token request includes the service token in the SOAP header. Parse the response to retrieve the impersonation token. Submit this impersonation token with each data request.

4.3.2

Creating Service and Impersonation Token in One Request

You can create both Service and Impersonation Token (Reuters or Unmanaged) in one request by using a CreateImpersonationToken_Request_2 operation and passing the service user credentials and the effective user id at once. XML Sample Request - Creating Service and Impersonation Tokens (Reuters effective user)
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2006/05/01/TokenM anagement_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/TokenM anagement_1/ C reateImpersonationToken_2</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <C reateImpersonationToken_Request_2 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/TokenM anagement_1"> <A pplicationID xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1">[A ppID]</A pplicationID> <U sername>[serv ice user]</U sername> <P assw ord>[passw ord]</P assw ord> <E ffectiv eU sername>[effectiv e user]</E ffectiv eU sername> </C reateImpersonationToken_Request_2> </Body > </E nv elope>

XML Sample Response - Creating Service and Impersonation Tokens (Reuters effective user)
<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader> <a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" s:mustU nderstand="1" >http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/ rkd/TokenM anagement_1/C reateImpersonationToken_2_Reply </a:A ction> <a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</a:RelatesTo> </s:H eader>

36

TRKD API Developer's Guide

<s:Body > <C reateImpersonationToken_Response_2 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/TokenM anagement_1"> <E xpiration>[token expiration YYYY-M M -DDTH H :M M :S S ]</E xpiration> <global:Token xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1">[Impersonation Token]</global:Token> </C reateImpersonationToken_Response_2> </Body > </E nv elope>

4.3.3

Creating New Token Using Expired Token

If your token has expired you can create a new valid token using the CreateImpersonationToken_Request_3 request. Keep in mind that Service User and ApplicationID for the new token will be extracted from the request header and not from the token in the request body. CreateImpersonation_Request_3 request requires an ApplicationID and a Token. This token is decoded to retrieve effective user, and a new token is generated for this effective user. See section Understanding Authentication Tokens for more details about token and effective user. Note that, unlike all other TRKD API transactions, you must make authentication and authorization requests (that is, requests to the TokenManagement_1 service) using HTTPS. XML Sample Request - Creating a New Token for the Same Effective User
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2006/05/01/TokenM anagement_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/TokenM anagement_1/ C reateImpersonationToken_3</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <C reateImpersonationToken_Request_3 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/TokenM anagement_1" xmlns: global="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <global:A pplicationID>[A ppID]</global:A pplicationID> <global:Token>[serv ice token]</global:Token> </C reateImpersonationToken_Request_3> </Body > </E nv elope>

XML Sample Response - Creating a New Token for the Same Effective User
<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader> <a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" s:mustU nderstand="1" >http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/ rkd/TokenM anagement_1/C reateImpersonationToken_3_Reply </a:A ction> <a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <C reateImpersonationToken_Response_3 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/TokenM anagement_1" xmlns: global="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <E xpiration>[token expiration YYYY-M M -DDTH H :M M :S S ]</E xpiration> <global:Token>[impersonation token]</global:Token> </C reateImpersonationToken_Response_3> </Body > </E nv elope>

Authentication and Authorization

37

4.4

WSDL
WSDL for CreateServiceToken_1 and CreateImpersonationToken_2 operations (they require passwords to be transferred): Token Management WSDL
http://api.rkd.reuters.com/schemas/w sdl/TokenM anagement_1_H ttpsA ndA nony mous.w sdl

For other operations, Token Management WSDL will be the following: Token Management WSDL
http://api.rkd.reuters.com/schemas/w sdl/TokenM anagement_1_H ttpA ndRKDToken.w sdl

4.5

Validating Token
This operation allows you to check whether your token has expired or not. ValidateToken_Request_1 request contains current ApplicationID and requires token as input data. Note that, unlike all other TRKD API transactions, you must make authentication and authorization requests (that is, requests to the TokenManagement_1 service) using HTTPS. XML Sample Request - Validating a Token
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2006/05/01/TokenM anagement_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/TokenM anagement_1/ V alidateToken_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <V alidateToken_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/TokenM anagement_1" xmlns:global="http:// w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <global:A pplicationID>[A ppID]</global:A pplicationID> <global:Token>[serv ice token]</global:Token> </V alidateToken_Request_1> </Body > </E nv elope>

XML Sample Response - Validating a Token

<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader> <a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" s:mustU nderstand="1" >http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/ rkd/TokenM anagement_1/V alidateToken_1_Reply </a:A ction> <a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <V alidateToken_Response_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/TokenM anagement_1"> <E xpiration>[token expiration YYYY-M M -DDTH H :M M :S S ]</E xpiration> <V alid>true</V alid> </V alidateToken_Response_1> </Body > </E nv elope>

38

TRKD API Developer's Guide

4.6

Resetting Password
Using this operation you change/reset password for the current service user. Note that, unlike all other TRKD API transactions, you must make authentication and authorization requests (that is, requests to the TokenManagement_1 service) using HTTPS. XML Sample Request - Resetting Password
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2006/05/01/TokenM anagement_1.sv c/A nony mous</ To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/TokenM anagement_1/ S etP assw ord_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <S etP assw ord_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/TokenM anagement_1"> <global:A pplicationID>[A ppID]</global:A pplicationID> <U sername>[y our_username]</U sername> <O ldP assw ord>[old_passw ord]</O ldP assw ord> <N ew P assw ord>[new _passw ord]</N ew P assw ord> </S etP assw ord_Request_1> </Body > </E nv elope>

XML Sample Response - Resetting Password

<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader> <a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/ rkd/TokenM anagement_1/S etP assw ord_1_Reply </a:A ction> <a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <S etP assw ord_Response_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/TokenM anagement_1"/> </Body > </E nv elope>

Using MessageID

39

chapter 5

Using MessageID

To help debug any problems that occur, your application should include a unique message identifier in the SOAP header of each request to TRKD API. For example: XML Sample Request - Using MessageID
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/S ignificantDev elopments_1.sv c</To> <M essageID xmlns="http://www.w3 .or g/2 0 0 5 /0 8 /addr essing">[ Unique M essage ID] </M essageID> ...

TRKD logs each message ID. The TRKD API also returns the message ID in the SOAP header of the response. For example: XML Sample Response - MessageID in the SOAP Header
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S ignificantDev elopments_1/ G etS ignificantDev elopments_1Response</a:A ction> <a:RelatesT o>[ Unique M essage ID] </a:RelatesT o> ...

Your application should log the message ID. When you contact Thomson Reuters for support, include the message ID in your problem description. For coding suggestions, see chapter Coding Examples.

40

TRKD API Developer's Guide

chapter 6

Analytics

The Thomson Reuters Analytics service allows the users to retrieve analytics values and related currencies and dates. Analytics are available for equity instruments on company-level (e.g. Debt to Assets), issue-level (e.g. Dividend Cover) and market-level (e.g. 1 Year Price % Change), and for indices (at issue-level; e.g. Index Volume). The following operations are available in the Analytics service: 1. Get Analytics (GetAnalytics_1) - provides the analytic values and associated information for a given entity. 2. Get Analytic IDs (GetAnalyticIDs_1) - provides the list of permissible analytics, in the form of Analytics IDs.

6.1

Authentication/Authorization, Service Endpoint, and Required Headers

Authorization All requests to the Thomson Reuters Analytics service require an authorization token. For details, see section Understanding Authentication Tokens. Authentication Thomson Reuters Analytics service uses Reuters impersonation tokens for each effective user. In this case, Thomson Reuters must create each user before your application authenticates them. Unmanaged effective users are not supported in Thomson Reuters Analytics service. For additional information, see section Creating a Token . Service Endpoint Thomson Reuters Analytics Endpoint
http://api.rkd.reuters.com/api/2010/03/17/A naly tics_1.sv c

Required Header Required HTTP Headers

P O S T /2010/03/17/A naly tics_1.sv c H TTP /1.1 C ontent-Ty pe: application/soap+xml H ost: api.rkd.reuters.com C ontent-Length: [length]

6.2

WSDL
Analytics WSDL
http://api.rkd.reuters.com/schemas/w sdl/A naly tics_1_H ttpA ndRKDToken.w sdl

6.3

Getting Analytics (GetAnalytics_1)

The users can use the GetAnalytics_1 request to retrieve analytic values and associated information for a given entity. The example below requests analytic values for 'IBM.N' (RIC as identifier) and 'ALPHA' analytic ID. XML Sample Request - Getting Analytics

Analytics

41

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2010/03/17/A naly tics_1.sv c/A nony mous</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2010/03/17/w ebserv ices/rkd/A naly tics_1/ G etA naly tics_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etA naly tics_Request_1 xmlns=http://w w w .reuters.com/ns/2010/03/17/w ebserv ices/rkd/A naly tics_1 xmlns:pf="http://w w w .reuters.com/ ns/2010/03/17/w ebserv ices/rkd/A naly tics_1_P ublicF orm"> <Identify ingBlock> <pf:Identifier identifierTy pe="RIC ">IBM .N </pf:Identifier> </Identify ingBlock> <C onfigurationBlock> <A naly ticID>A LP H A </A naly ticID> </C onfigurationBlock> </G etA naly tics_Request_1> </Body > </E nv elope>

Attribute Identifier AnalyticID PickListCSV

Description RIC (Reuters Instrument Code). Defines specific analytic type. It's possible to specify multiple Analytic IDs. If you want to restrict the data items returned by the response, enter a comma-separated list of the items you want to be retrieved.

The response returns the following information: XML Sample Response - Getting Analytics
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/ rkd/A naly tics_1/G etA naly tics_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <G etA naly tics_Response_1 timeS tamp="2010-04-09T10:57:06.609375+00:00" xmlns="http://w w w .reuters.com/ns/2010/03/17/ w ebserv ices/rkd/A naly tics_1"> <ResponseItem> <C ontent> <RIC >IBM .N </RIC > <S napshotDate>2010-03-17</S napshotDate> <A naly tic> <A naly ticID>A LP H A </A naly ticID> <V alue>0.006529686063557</V alue> </A naly tic> </C ontent> </ResponseItem> </G etA naly tics_Response_1> </Body > </E nv elope>

Note: If the user specifies an incorrect "PickListCSV" parameter in the request is wrong, the application returns "blank" response: XML Sample Response - Blank Response
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/

42

TRKD API Developer's Guide

rkd/A naly tics_1/G etA naly tics_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <G etA naly tics_Response_1 timeS tamp="2010-05-14T11:08:01.796875+00:00" xmlns="http://w w w .reuters.com/ns/2010/03/17/ w ebserv ices/rkd/A naly tics_1"> </G etA naly tics_Response_1> </Body > </E nv elope>

6.4

Getting Analytic IDs (GetAnalyticIDs_1)

Use the GetAnalyticIDs_1 request to get the list of the permissible analytics, in the form of Analytic IDs. XML Sample Request - Getting Analytic IDs
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2010/03/17/A naly tics_1.sv c/A nony mous</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2010/03/17/w ebserv ices/rkd/A naly tics_1/ G etA naly ticIDs_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etA naly ticIDs_Request_1 xmlns="http://w w w .reuters.com/ns/2010/03/17/w ebserv ices/rkd/A naly tics_1"> </G etA naly tics_Request_1> </Body > </E nv elope>

The users do not need to specify any request parameters and the response will return all available analytic IDs. The response returns the following information: XML Sample Response - Getting Analytics IDs
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/ rkd/A naly tics_1/G etA naly tics_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <G etA naly ticIDs_Response_1 timeS tamp="2010-04-09T10:55:47.203125+00:00" xmlns="http://w w w .reuters.com/ns/2010/03/17/ w ebserv ices/rkd/A naly tics_1"> <ResponseItem> <A naly ticID>A DXR_14D</A naly ticID> ... <A naly ticID>BE TA </A naly ticID> <A naly ticID>BV P S </A naly ticID> <A naly ticID>C A P ITA L_RA TIO _TIE R1</A naly ticID> ... <A naly ticID>TO TA L_A S S E TS </A naly ticID> ... <A naly ticID>V O LA TILITY_90D</A naly ticID> </ResponseItem> </G etA naly ticIDs_Response_1> </Body > </E nv elope>

Authors Reference

43

chapter 7

Authors Reference

The Authors Reference service is used to search for individual or multiple analysts, based on various user-defined attributes and criteria. The following operations are available through the Authors Reference service: Authors List (AuthorsList_1): Retrieves a list of analysts from the Analyst database. PersonsList (PersonsList_1): Retrieves a list of people from the Analyst database. Get Related Accounts (GetRelatedAccounts_1): Retrieves accounts related to an analyst. Get Teams (GetTeams_1): Retrieves the following information about teams of analysts.

7.1

Authentication/Authorization, Service Endpoint, and Required Headers

Authorization All requests to the Authors Reference web service require an authorization token. For details, see section Understanding Authentication Tokens. Authentication Authors Reference uses Reuters impersonation tokens for each effective user. In this case, Thomson Reuters must create each user before your application authenticates them. Unmanaged effective users are not supported in Authors Reference. For additional information on creating a Service Token, see section Creating a Token.

Service Endpoint Authors Reference Endpoint

http://api.rkd.reuters.com/api/2008/01/12/A uthorsref_1.sv c

Required Header Required HTTP Headers

P O S T api/2008/01/12/A uthorsref_1.sv c H TTP /1.1 C ontent-Ty pe: application/soap+xml H ost: api.rkd.reuters.com C ontent-Length: [length]

7.2

WSDL
WSDL:
http://api.rkd.reuters.com/schemas/w sdl/A uthorsref_1_H ttpA ndRKDToken.w sdl

7.3

Authors List (AuthorsList_1)

The AuthorsList_1 request retrieves a list of analysts from the Analyst database, according to the parameters provided. You can use the following criteria options can narrow down your search: Required Info: This criteria indicates what information should exist in the returned author record. The options are: o Basic o ctb

44

TRKD API Developer's Guide

o Education o Categorization o Contrib Strings o Event o Team Info Basic Search: You can use this search criteria to filter on basic information concerning the author. You can specify the following information: o nameSuffix o middleName o firstName o lastName o personID o uid o authorCode o Specialty ctb Search: This criteria lets you search for a specific contributor ID. Contributor String Search: This criteria allows you to search a contributors information for specified text. The following example shows how to retrieve the first ten authors with information written in English. XML Sample Request - Get Authors List
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2008/01/12/A uthorsref_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/A uthorsref_1/ A uthorsList_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <A uthorsList_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/A uthorsref_1" r owcount="10" dstLangID ="en" useM aster DB ="true"> <authorS earchC riterion /> </A uthorsList_Request_1> </Body > </E nv elope>

Attribute rowcount startrow dstLangID

Description Defines number of records to be retrieved. Defines the starting row which records are to be retrieved. Defines default language.

useMasterDB Defines whether to retrieve records from the Master DB. XML Sample Response - Get Authors List (Basic Search) The response returns the Author Code and User Id of the requested analysts.
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/ rkd/A uthorsref_1/A uthorsList_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <A uthorsList_Response_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/A uthorsref_1"> <A uthorsListResponse> <author authorC ode="3ZLM " uid="30167697" /> <author authorC ode="3IS 4" uid="30145973" /> <author authorC ode="35T6" uid="30129218" />

Authors Reference

45

<author authorC ode="35TU " uid="30129242" /> <author authorC ode="3C DH " uid="30137681" /> <author authorC ode="3C DI" uid="30137682" /> <author authorC ode="3C DJ" uid="30137683" /> <author authorC ode="3C K8" uid="30137922" /> <author authorC ode="3E C X" uid="30140247" /> <author authorC ode="3E C Z" uid="30140249" /> </A uthorsListResponse> </A uthorsList_Response_1> </Body > </E nv elope>

7.4

Persons List (PersonsList_1)

The PersonsList_1 request retrieves a list of people from the Analyst database. You can use the following criteria options can narrow down your search: Required Info: This criteria indicated what information should exist in the returned author record. The options are: o Basic o ctb o Education o Categorization o Contrib Strings o Event o Team Info Basic Search: You can use this search criteria to filter on basic information concerning the author. You can specify the following information: o nameSuffix o middleName o firstName o lastName o personID o uid o authorCode o Specialty ctb Search: This criteria lets you search for a specific contributor ID. Contributor String Search: This criteria allows you to search contributors information for specified text. The following example shows how to retrieve person list. XML Sample Request - Get Persons List
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2008/01/12/A uthorsref_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/A uthorsref_1/ P ersonsList_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <P ersonsList_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/A uthorsref_1" r owcount="5" ="en" useM aster DB ="true"> <authorS earchC riterion /> </P ersonsList_Request_1> </Body > </E nv elope> dstLangID

Attribute

Description

46

TRKD API Developer's Guide

rowcount startrow dstLangID useMasterDB

Defines number of records to be retrieved. Defines the starting row which records are to be retrieved. Defines default language. Defines whether to retrieve records from the Master DB.

XML Sample Response - Get Persons List The response returns the Person Id of the requested people.
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/ rkd/A uthorsref_1/P ersonsList_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <P ersonsList_Response_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/A uthorsref_1"> <A uthorsListResponse> <person personID="3RH Y" /> <person personID="3RRA " /> <person personID="3ZLM " /> <person personID="3IS 4" /> <person personID="3C DH " /> </A uthorsListResponse> </A uthorsList_Response_1> </Body > </E nv elope>

Note: In the Analyst Database, an analyst is associated with a company, whereas a person is not identified with any specific company. This makes it possible to keep track of people even when they leave one company and join another.

7.5

Get Related Accounts (GetRelatedAccounts_1)

The GetRelatedAccounts_1 request retrieves accounts related to an analyst from the Analyst database. The following example shows how to retrieve related accounts. XML Sample Request - Get Related Accounts
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2008/01/12/A uthorsref_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/A uthorsref_1/ G etRelatedA ccounts_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etRelatedA ccounts_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/A uthorsref_1"> < company ctbID=" 2 5 2 0 2 " /> </G etRelatedA ccounts_Request_1> </Body > </E nv elope>

This request takes the Contribution ID as input and returns related accounts. See the example below of a sample response. XML Sample Response - Get Related Accounts

Authors Reference

47

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/ rkd/A uthorsref_1/G etRelatedA ccounts_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <G etRelatedA ccounts_Response_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/A uthorsref_1"> <relatedA ccounts> <company company N ame="A BN A mro A sset M anagement" ctbID="25202" isP arent="true" /> </relatedA ccounts> </G etRelatedA ccounts_Response_1> </Body > </E nv elope>

7.6

Get Teams (GetTeams_1)

The GetTeams_1 request retrieves the following information about teams of analysts from the Analyst database: Team ID Team Name Contributor ID Team description Team start date Team end date It is possible to search for a team using the following criteria: Team ID Contributor ID Team Name This request takes the Team ID as input and returns information for the team. XML Sample Request - Get Teams
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2008/01/12/A uthorsref_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/A uthorsref_1/ G etTeams_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etTeams_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/A uthorsref_1" teamID="1 3 1 " /> </Body > </E nv elope>

XML Sample Response - Get Teams

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/ rkd/A uthorsref_1/G etTeams_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <G etTeams_Response_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/A uthorsref_1"> <G etTeamsResponse> <team ctbID="234" descr iption="A new team, made to order." endDate ="2007-11-30" star tDate ="2007-11-01" teamID ="131" teamName ="Team XYZ" />

48

TRKD API Developer's Guide

</G etTeamsResponse> </G etRelatedA ccounts_Response_1> </Body > </E nv elope>

Attribute ctbID Description endDate startDate teamID teamName

Description Defines the Contributor Id of the company to which the analyst belongs. Shows the description of the team. Shows the effective end date for the team. Shows the effective start date for the team. Shows the Team ID. Shows the name of the team.

7.7

Listing All Authors (Analysts) from Contributor (Company)

To efficiently support administration of the many analysts in the Thomson Reuters database, the Authors Reference service uses a parent-child relationship. Therefore, to list all analysts from a contributor, first you have to use the GetRelatedAccounts_1 request to find the parent. For example: XML Sample Request - Retrieving the Parent
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2008/01/12/A uthorsref_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/A uthorsref_1/ G etRelatedA ccounts_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etRelatedA ccounts_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/A uthorsref_1"> <company ctbID="1 8 1 8 5 " /> </G etRelatedA ccounts_Request_1> </Body > </E nv elope>

XML Sample Response - Retrieving the Parent

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/ rkd/A uthorsref_1/G etRelatedA ccounts_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <G etRelatedA ccounts_Response_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/A uthorsref_1"> <relatedA ccounts> <company ctbID="2 " companyName="M er r ill Lynch" isP ar ent="tr ue" /> <company ctbID="5" company N ame="M errill Ly nch - Test for M L_002 feed" isP arent="false" /> <company ctbID="44" company N ame="M errill Ly nch TE S T" isP arent="false" /> <company ctbID="15431" company N ame="M errill Ly nch - C lara" isP arent="false" /> <company ctbID="18185" company N ame="M errill Ly nch International P riv ate C lient G roup" isP arent="false" /> <company ctbID="29477" company N ame="M errill Ly nch C F C R C ontributions" isP arent="false" /> <company ctbID="40845" company N ame="M errill Ly nch RIXM L Test C ompany " isP arent="false" /> </relatedA ccounts> </G etRelatedA ccounts_Response_1> </Body > </E nv elope>

Authors Reference

49

Then use the parent contributor ID to retrieve the full list of analysts. For example: XML Sample Request - Retrieving the Full List of Analysts
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2008/01/12/A uthorsref_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/A uthorsref_1/ A uthorsList_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <A uthorsList_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/A uthorsref_1"> <authorS earchRequiredInfo authorInfoTy pe="basic" /> <authorS earchC riterion> <basicS earch /> <ctbS earch v isibleA sDisabled="false" isC urrent="true" ctbID="2 " /> </authorS earchC riterion> </A uthorsList_Request_1> </Body > </E nv elope>

7.7.1

Requesting Active Analysts

By default, the Authors Reference service returns disabled analysts for historical purposes. To request only analysts that are not disabled, set the <visibleAsDisabled> attribute to 'false'. For example: XML Sample Request - Requesting Active Analysts
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2008/01/12/A uthorsref_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/A uthorsref_1/ A uthorsList_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <A uthorsList_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/A uthorsref_1"> <authorS earchC riterion> <ctbS earch visibleA sDisabled="false" ctbID="2" /> </authorS earchC riterion> </A uthorsList_Request_1> </Body > </E nv elope>

50

TRKD API Developer's Guide

chapter 8

Charts

You can use the Thomson Reuters Charts service to retrieve a wide range of technical charts and tabular displays generated live by the Thomson Reuters Data Center analytics engine. This service provides many customizable features giving you the control of how the data will be displayed. Charting is available on an Intraday and Interday basis: INTERDAY lets you retrieve historical time series prices on an instrument, summarized in daily, weekly or monthly periods. INTRADAY lets you retrieve a time series of Intraday market prices on an instrument, summarized in periods from 1 minute to 1 hour (configurable). The supported time intervals (periods) for Intraday charts are: 1, 5, 15, 30, 60 minutes. Charts Availability for Low Volume Instruments TRKD API Charts may not render images for certain instruments because they lack trading volume which would be needed to render data points for a chart. These are extremely rare cases and this issue only appears when instruments do not trade for weeks at a time, and the lack of data makes it hard to render charts. However, you will still be able to get price & volume information for these instruments.

8.1

Authentication/Authorization, Service Endpoint, and Required Headers

Authorization All requests to Thomson Reuters Charts web service require an authorization token. For details, see section Understanding Authentication Tokens. Authentication Thomson Reuters Charts uses Reuters impersonation tokens for each effective user. In this case, Thomson Reuters must create each user before your application authenticates them. Unmanaged effective users are not supported in Thomson Reuters Charts. For additional information on creating a Service Token, see section Creating a Token.

Service Endpoint Reuters Charts Endpoint

http://api.rkd.reuters.com/api/2006/05/01/C harts_1.sv c

Required Header Required HTTP Headers

P O S T /api/2006/05/01/C harts_1.sv c H TTP /1.1 C ontent-Ty pe: application/soap+xml H ost: api.rkd.reuters.com C ontent-Length: [length]

Charts

51

8.2

WSDL
WSDL:
http://api.rkd.reuters.com/schemas/w sdl/C harts_1_H ttpA ndRKDToken.w sdl

8.3

Understanding Reuters Charts Request

The charts request call is broken up into the following sections: chartRequest: Basic chart description to indicate width, height and image type. TimeSeries: Defines the financial data being used in the chart. Analyses: Section that specifies the analysis formula used in the Chart. StandardTemplate: Defines how the data is being shown in the chart. Scheme: A set of display properties (color, line styles etc) used within a chart to render different types of data. Note: Thomson Reuters recommends to use the GetChart_Request_2 request. It is the same as the GetChart_Request_1 only without the CorporateEvents element. Note: The current data point limitation is 1000. XML Sample Request - Get Charts
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/C harts_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C harts_1/ G etC hart_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etC hart_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C harts_1"> < char tRequest ImageTy pe="BM P " Width="500" H eight="400" C ulture="en-U S "> <T imeSer ies> <TimeS eriesRequest xmlns="http://metastock.com/imageserv er/financial"> <S y mbol>IBM .N </S y mbol> <Reference>d1</Reference> </TimeS eriesRequest> </TimeS eries> <A nalyses> <A naly sis xmlns="http://metastock.com/imageserv er/analy sis"> <Reference>a1</Reference> <O H LC > <Instrument1> <Reference>d1</Reference> </Instrument1> </O H LC > </A naly sis> <A naly sis xmlns="http://metastock.com/imageserv er/analy sis"> <Reference>a2</Reference> <V ol> <Instrument1> <Reference>d1</Reference> </Instrument1> </V ol> </A naly sis> </A naly ses> < Standar dT emplate xmlns="http://metastock.com/imageserv er/financial"> <Title> <C aption> <V isible>true</V isible> <C ustomized>false</C ustomized>

52

TRKD API Developer's Guide

</C aption> <Range> <V isible>true</V isible> </Range> </Title> <Legend> <V isible>true</V isible> <Information>Long</Information> <Lay out>M ultiLine</Lay out> <P osition>O v erlaid</P osition> </Legend> <Instrument>S y mbol</Instrument> <Delimiter>% </Delimiter> <G ridLines>N one</G ridLines> <YA xisM arkers>N one</YA xisM arkers> <YA xisTitles>A ll</YA xisTitles> <Brand>N one</Brand> <Interv al> <C ommonTy pe xmlns="http://metastock.com/applications/data">Day s</C ommonTy pe> <M ultiplier xmlns="http://metastock.com/applications/data">1</M ultiplier> </Interv al> <S how N onTradedP eriods>false</S how N onTradedP eriods> <S how H oliday s>false</S how H oliday s> <S how G aps>true</S how G aps> <XA xis> <V isible>true</V isible> <P osition>Bottom</P osition> <Range> <F ixed> <F irst>2007-04-17T00:00:00</F irst> <Last>2007-05-24T00:00:00</Last> </F ixed> </Range> </XA xis> <S ubchart> <Weight>5</Weight> <YA xis> <V isible>true</V isible> <P osition>Right</P osition> <Inv ert>false</Inv ert> <Logarithmic>false</Logarithmic> <Display > <M ode>A utomatic</M ode> </Display > <Range> <A utomatic /> </Range> <A naly sis> <Reference>a1</Reference> </A naly sis> </YA xis> </S ubchart> ... </S tandardTemplate> < Scheme xmlns="http://metastock.com/imageserv er/financial"> <Background> ... </Background> <Border> ... </Border> <G ridLines> ... </G ridLines> <Title> ... </Title> <Legend> ... </Legend> <XA xis> ... </XA xis> <YA xis> ... </YA xis> <S eries>

Charts

53

... </S eries> ... <Lev elLine> <C olor> <RG B>120;120;120</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>1</Width> </Lev elLine> </S cheme> </chartRequest> </G etC hart_Request_1> </Body > </E nv elope>

8.3.1

chartRequest
The chartRequest section contains the basic chart description indicating the charts width, height, image type and Title.

XML Sample Request - Get Charts

<G etC hart_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C harts_1"> < char tRequest ImageT ype="BM P " Width="5 0 0 " H eight="4 0 0 " T itle="C har t T itle" C ultur e="en-US" DacsUser =""> ... </chartRequest> </G etC hart_Request_1>

Attribute ImageType

Description Selects the type of image to return. The following image types are supported: BMP PNG JPEG GIF EMF The width of the image in pixels. The height of the image in pixels. Shows culture-specific information, such as language, sublanguage, calendar, etc. Title for the chart.

Width Height Culture Title

Note: The culture parameter allows the client to specify what locale and language they would like the chart to adopt. That encompasses such settings like the language used for text labels, the formatting of the date (mm-dd-yyyy instead of dd-mmyyyy for 'en-US' culture), decimal separators (25.63 instead of 25,63 for 'en-US' culture), etc. The culture strings ("en-US", "pt-BR", etc) are standard across Microsoft products and platforms. The whole graph is affected by the culture parameter, the y-axis and x-axis values are displayed differently based on the culture, labels are different - "Date" for English vs. "Data" for Spanish, etc. The clients don't need to specify anything other than "en-US" unless they want localized formatting and/or strings. Keep in mind that if you specify your 'culture' parameter, the chart may not display properly because chart data may not be translated for the specified culture.

8.3.2

TimeSeries
TimeSeries section is used to indicate the data used in the chart. You can create multiple data sets that can be used in later sections simply by entering their reference id that is set for each data set in this section.

XML Sample Request - Get Charts

54

TRKD API Developer's Guide

<TimeS eries> < T imeSer iesRequest xmlns="http://metastock.com/imageserv er/financial"> < Symbol >IBM .N </S y mbol> < Refer ence >d1</Reference> </TimeS eriesRequest> < T imeSer iesRequest xmlns="http://metastock.com/imageserv er/financial"> <Symbol>V O D.L</S y mbol> <Refer ence>d2</Reference> </TimeS eriesRequest> </TimeS eries>

Attribute DataProvider

Description This field indicates which data provider to request data from. Leaving this blank will default to the default data provider. Note: Currently only one data provider is supported (TSI). Since TSI is the default value you can leave this field out.

FeedID Field Symbol Reference

This field indicates which feed of the data provider to request data from. Leaving this blank will default to the default feed. This is the field of data that we should retrieve for the symbol (RIC). Leaving this blank will use the default field of the symbol. The symbol (RIC) to request data for. This is the name (or id) that the analyses will reference to indicate what data they are using. This needs to be a unique value.

8.3.3

Analyses
This section of the Charts Request gives the ability to analyze information provided in TimeSeries section and indicate how it should be graphed. You are able to analyze and graph multiple data sets. For a full list of supported Analyses see section Analyses List. XML Sample Request - Get Charts
<A naly ses> < A nalysis xmlns="http://metastock.com/imageserv er/analy sis"> < Refer ence >a1</Reference> < Line > <Instrument1> < Refer ence >d1</Reference> </Instrument1> </Line> </A naly sis> < A nalysis xmlns="http://metastock.com/imageserv er/analy sis"> < Refer ence >a2</Reference> < Line > <Instrument1> < Refer ence >d2</Reference> </Instrument1> </Line> </A naly sis> < A nalysis xmlns="http://metastock.com/imageserv er/analy sis"> < Refer ence >a1m</Reference> < M A C D> <Instrument1> < Refer ence >d1</Reference> </Instrument1> </M A C D> </A naly sis> < A nalysis xmlns="http://metastock.com/imageserv er/analy sis"> < Refer ence >a2m</Reference> < M A C D> <Instrument1>

Charts

55

< Refer ence >d2</Reference> </Instrument1> </M A C D> </A naly sis> </A naly ses>

Attribute Analysis Reference Analysis Type Section <[Analysis Code]>

Description Contains analysis information. This is the name (or ID) that the Template will reference to indicate where this analysis should be drawn on the chart. This must be a unique value. This section indicates the type of the analysis you are running. For a full list of Analyses see section Analyses List. This element contains the following information: Instrument1: Defines what data is used in the current instance of the analysis through the following children elements. Action: Selects which column of data to use for the analysis: Valid values are (empty), Open, High, Low, Close and Volume. Leaving it blank indicates to use the default column of data (Close). Reference: This defines the data to use. This needs to match one of the data requests or custom data Reference properties as defined in TimeSeries section. Series1: This is the number of series that the analysis will draw on the chart. Some analyses will produce more than one series to draw (Bollinger Bands produce three lines to be drawn). This allows you to change the type of drawing of the series. However, not all analysis will allow all drawing styles. (BarOHLC will only allow OHLC drawing, Candle will only allow Candle). Series consists of the following child elements: Name: This is the name of the series to draw. Valid names are OHLC, HLC, HL, Candle, Line, Dot, FilledLine, Spline, FilledSpline, Stepped, FilledStepped, Forest, and LinkedForest. Note: Not all names are valid for all analyses. Symbol: This is the symbol to draw at each data point. This will be ignored for OHLC, HLC, HL, and Candle. The Possible values are (empty), None, Square, Diamond, UpArrow, DownArrow, and Circle.

8.3.4

StandardTemplate
In the StandardTemplate section you will setup the structure and options of the chart. This is where the options, number of sub-charts, y-axes and placement of analyses are determined. You can enter one or more sub-charts each based on their own analysis and settings. XML Sample Request - Get Charts
< Standar dT emplate xmlns="http://metastock.com/imageserv er/financial"> < T itle > <C aption> <V isible>true</V isible> <C ustomized>false</C ustomized> </C aption> <Range> <V isible>true</V isible> </Range> </Title> < Legend > <V isible>true</V isible> <Information>Long</Information> <Lay out>M ultiLine</Lay out> <P osition>O v erlaid</P osition> </Legend> < Instr ument>S y mbol</Instrument> < Delimiter >% </Delimiter> < Gr idLines >N one</G ridLines> < Y A xisM ar ker s >N one</YA xisM arkers> < Y A xisT itles >A ll</YA xisTitles> < Br and >N one</Brand>

56

TRKD API Developer's Guide

< Inter val > <C ommonTy pe xmlns="http://metastock.com/applications/data">Day s</C ommonTy pe> <M ultiplier xmlns="http://metastock.com/applications/data">1</M ultiplier> </Interv al> < ShowNonT r adedP er iods >false</S how N onTradedP eriods> < ShowH olidays >false</S how H oliday s> < ShowGaps >true</S how G aps> < XA xis > <V isible>true</V isible> <P osition>Bottom</P osition> <Range> <F ixed> <F irst>2007-04-17T00:00:00</F irst> <Last>2007-05-24T00:00:00</Last> </F ixed> </Range> </XA xis> < Subchar t> <Weight>5</Weight> <YA xis> <V isible>true</V isible> <P osition>Right</P osition> <Inv ert>false</Inv ert> <Logarithmic>false</Logarithmic> <Display > <M ode>A utomatic</M ode> </Display > <Range> <A utomatic /> </Range> <A naly sis> <Reference>a1</Reference> <Lev elLine>Decimal</Lev elLine> <C orporateE v entsReference>[v alue]></C orporateE v entsReference> <C orporateE v entsV isible>C apitalC hange</C orporateE v entsV isible> </A naly sis> </YA xis> </S ubchart> ... </S tandardTemplate>

Attribute Title

Description The chart has an area at the top of its window reserved for the display of a textual title. This area is divided into two parts: the title caption and the date range display. The title caption shows the current interval of the X-Axis and the analyses that are in the chart. The date range shows the first and last date of the data that is currently displayed in the chart, and the time zone of the X-Axis. The following child elements give you further control of the Title: Caption: caption contains the following elements: Visible - You can hide or show the caption by setting it to true or false. Customize - Rather than show the default information you can put in your own text. Range : Contains the following element to show or hide the Range part of the Title. Visible - You can hide or show the Range part of the title by setting this element to true or false. Legend contains information from all sub-charts and is shown transparently inside or outside the chart. Contains the following elements: Visible: You can show or hide the legend by setting this to true or false. Information: You can choose to display the legend in one of the following three ways: Long: ex ample v iew: C ndl; YHO O . O ; Last Trade 2005-03-18; 404. 75; 405. 87; 401; 403. 5 SMA ; YHO O ; 14 Short: ex ample v iew: C ndl; YHO O . O ; 2005-03-18; 404. 75; 405. 87; 401; 403. 5 Minimum: ex ample v iew: C ndl; 403. 5 Layout: Style of display that can be set to one of the following three choices: MultiLine: This stacks all legend entries on top of each other. This is the default setting. SingleLine: All legend entries for all analyses are on a single row. Only one row can be used, even

Legend

Charts

57

Instrument

Delimiter GridLines

YAxisMarkers

YAxisTitles

Brand Interval

if it does not fit horizontally on the chart. It makes sense to use Short or Minimum format when using this option. WrappedLine: Like single row, except wraps the text when it hits the right edge of the screen and start a new row. Position: This indicates where the legend should appear. The three options are: Above Below Overlaid Defines if the instrument is based on: Symbol FeedSymbol Name Defines the feed delimiter. Defines how to show the grid lines on the Chart. The choices are: None Vertical Horizontal Both Defines the Y-Axis marker style. The possible choices are: None Diamond Label Defines the Y-Axis title style. The possible choices are: None Type Currency Unit DisplayUnit All Option to display a brand to show that it is a MetaStock or a Reuters chart. The brand is displayed in the lower-right hand corner of the chart, below the x-axis. Specifies the data intervals.

Contains the following elements: CommonType: Specifies the type of the interval. The choices are: Unknown Undefined Ticks Seconds Minutes Hours Days Weeks Months Quarters Years Multiplier: The interval of the unit defined in Common type. ShowNonTraded You can hide or show Non Traded Periods by setting this element to true or false. Periods ShowHolidays You can hide or show Holidays by setting this element to true or false. ShowGaps You can hide or show Gaps by setting this element to true or false. XAxis Defines X-Axis style. Contains the following elements: Visible: You can show or hide the X-Axis by setting this to true or false. Position: This indicates where the X-Axis must appear. The two possible options are: Bottom Top Range: Defines the range of the data displayed in the chart. The possible options are: Default: This parameter displays the amount of data that best fits in a chart. All: This parameter displays all data. Fixed: This parameter displays the data for the entered period of time.

58

TRKD API Developer's Guide

SubChart

Last: This parameter displays the data for the last specified period of time. Points: This parameter displays the fixed number of data points. Note: The Charts service is limited to return only 1000 data point. To request a longer data range, see section Creating Chart for the Past 10 Years. Option to display a Subchart and define its style. Contains the following elements: Weight: Indicates the relative size of a sub-chart in the Chart. YAxis: Defines Y-Axis style. Visible: You can show or hide Y-Axis by setting this element to true or false. Position: This indicates where Y-Axis must appear. Two possible options are: Left Right Invert: You can choose to invert Y-Axis by setting this element to true or false. Logarithmic: You can choose to display Y-Axis in a logarithmic scale by setting this element to true or false. Display: This defines how Y-Axis display units are displayed: The possible options are: Automatic: Automatic adjustment of units. Decimal: Decimal display units. Fraction: Fractional display units. Financial: Financial display units. Range: This determines minimum and maximum values to be displayed on the Y-Axis. The possible options are: Automatic: Y-Axis automatically chooses a minimum and maximum values. Fixed: You can specify fixed values for minimum and maximal values. Relative: You can define a range of data for the Y-Axis to display around the last data point shown in the chart. Analysis Reference: This is the name (or ID) of the data set you specified in Time Series. LevelLine: This element allows to specify the placement of level lines defined by the integrator. CorporateEventsReference: This is the ID of corporate events that the Template will reference to indicate which events must be drawn on the chart. CorporateEventsVisible: This element allows to display corresponding corporate events. None Capital Change Dividend Earnings All

Note: CorporateEvents are not supported in the Get_Charts_2 request.

8.3.5

Scheme
The Scheme section defines display properties (color, line styles etc) used within a chart to render different types of data. You are able to set the display properties for the following items: Background Border GridLines Title Legend XAxis YAxis TimeSeries information

XML Sample Request - Get Charts

<S cheme xmlns="http://metastock.com/imageserv er/financial"> <Backgr ound> <BackgroundM ode>S olid</BackgroundM ode> <S tartC olor> <N amed>White</N amed>

Charts

59

</S tartC olor> <E ndC olor> <N amed>White</N amed> </E ndC olor> <H atchS ty le>LargeG rid</H atchS ty le> <G radientM ode>F orw ardDiagonal</G radientM ode> <ImageM ode>C entered</ImageM ode> </Background> <Bor der > <C olor> <RG B>139;139;155</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>1</Width> </Border> <Gr idLines> <C olor> <RG B>139;139;155</RG B> </C olor> <DashS ty le>Dot</DashS ty le> <Width>1</Width> </G ridLines> <T itle> <C aption> <C olor> <N amed>Black</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Bold</S ty le> <S ize>12</S ize> </C aption> <Range> <C olor> <N amed>Black</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Regular</S ty le> <S ize>8.25</S ize> </Range> </Title> <Legend> <C olor> <N amed>Black</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Regular</S ty le> <S ize>8.25</S ize> </Legend> <XA xis> <M ajor> <C olor> <N amed>Black</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Bold</S ty le> <S ize>9.75</S ize> </M ajor> <M inor> <C olor> <N amed>Black</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Regular</S ty le> <S ize>8.25</S ize> </M inor> </XA xis> <Y A xis> <M ajor> <C olor> <N amed>Black</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Bold</S ty le> <S ize>9.75</S ize> </M ajor> <M inor> <C olor>

60

TRKD API Developer's Guide

<N amed>Black</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Regular</S ty le> <S ize>8.25</S ize> </M inor> <Title> <C olor> <N amed>Black</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Regular</S ty le> <S ize>8.25</S ize> </Title> </YA xis> <Ser ies> <C olor> <N amed>Black</N amed> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <N amed>Black</N amed> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> ...

Attribute Background Border GridLines Title Legend XAxis YAxis Series

Description Specifies the style of chart's background. Specifies the style of chart's borders. Specifies the display settings for the gridlines. Specifies the display settings of the text shown in the title caption. Specifies the style of chart's legend. Specifies the display settings for chart's X-Axis. Specifies the display settings for chart's Y-Axis. Specifies the display settings for chart's time series.

8.3.6

Retrieving 1Y Interday Stock Chart

The following request demonstrates how to retrieve the 1Y Interday Stock Chart. XML Sample Request - Retrieve 1Y Interday Stock Chart
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/C harts_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C harts_1/ G etC hart_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etC hart_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C harts_1"> <chartRequest ImageTy pe="P N G " Width="500" H eight="400" C ulture="en-U S "> <TimeS eries> <TimeS eriesRequest xmlns="http://metastock.com/imageserv er/financial"> <S y mbol> IBM .N</S y mbol> <Reference> d1 </Reference> </TimeS eriesRequest> </TimeS eries>

Charts

61

<A naly ses> <A naly sis xmlns="http://metastock.com/imageserv er/analy sis"> <Reference> a1 </Reference> <Line> <Instrument1> <Reference> d1 </Reference> </Instrument1> </Line> </A naly sis> <A naly sis xmlns="http://metastock.com/imageserv er/analy sis"> <Reference> a2 </Reference> <V ol> <Instrument1> <Reference> d1 </Reference> </Instrument1> </V ol> </A naly sis> </A naly ses> <S tandardTemplate xmlns="http://metastock.com/imageserv er/financial"> <Title> <C aption> <V isible>true</V isible> <C ustomized>false</C ustomized> </C aption> <Range> <V isible>true</V isible> </Range> </Title> <Legend> <V isible>true</V isible> <Information>Long</Information> <Lay out>M ultiLine</Lay out> <P osition>O v erlaid</P osition> </Legend> <Instrument>S y mbol</Instrument> <Delimiter>% </Delimiter> <G ridLines>N one</G ridLines> <YA xisM arkers>N one</YA xisM arkers> <YA xisTitles>Ty pe</YA xisTitles> <Brand>N one</Brand> <Interv al> <C ommonTy pe xmlns="http://metastock.com/applications/data"> Days </C ommonTy pe> <M ultiplier xmlns="http://metastock.com/applications/data">1</M ultiplier> </Interv al> <S how N onTradedP eriods>false</S how N onTradedP eriods> <S how H oliday s>false</S how H oliday s> <S how G aps>true</S how G aps> <XA xis> <V isible>true</V isible> <P osition>Bottom</P osition> <Range> <F ixed> <F irst> 2 0 0 6 -0 8 -0 1 T 0 0 :0 0 :0 0 </F irst> <Last> 2 0 0 7 -0 8 -0 1 T 0 0 :0 0 :0 0 </Last> </F ixed> </Range> </XA xis> <S ubchart> <Weight>5</Weight> <YA xis> <V isible>true</V isible> <P osition>Right</P osition> <Inv ert>false</Inv ert> <Logarithmic>false</Logarithmic> <Display > <M ode>A utomatic</M ode> </Display > <Range> <A utomatic /> </Range> <A naly sis> <Reference>a1</Reference> </A naly sis> </YA xis> </S ubchart> <S ubchart> <Weight>2</Weight>

62

TRKD API Developer's Guide

<YA xis> <V isible>true</V isible> <P osition>Right</P osition> <Inv ert>false</Inv ert> <Logarithmic>false</Logarithmic> <Display > <M ode>A utomatic</M ode> </Display > <Range> <A utomatic /> </Range> <A naly sis> <Reference>a2</Reference> </A naly sis> </YA xis> </S ubchart> </S tandardTemplate> <S cheme xmlns="http://metastock.com/imageserv er/financial"> <Background> <BackgroundM ode>G radient</BackgroundM ode> <S tartC olor> <N amed>White</N amed> </S tartC olor> <E ndC olor> <RG B>51;0;153</RG B> </E ndC olor> <H atchS ty le>LargeG rid</H atchS ty le> <G radientM ode>V ertical</G radientM ode> <ImageM ode>C entered</ImageM ode> </Background> <Border> <C olor> <RG B>139;139;155</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>1</Width> </Border> <G ridLines> <C olor> <RG B>139;139;155</RG B> </C olor> <DashS ty le>Dot</DashS ty le> <Width>1</Width> </G ridLines> <Title> <C aption> <C olor> <N amed>Black</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Bold</S ty le> <S ize>12</S ize> </C aption> <Range> <C olor> <N amed>Black</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Regular</S ty le> <S ize>8.25</S ize> </Range> </Title> <Legend> <C olor> <N amed>Black</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Regular</S ty le> <S ize>8.25</S ize> </Legend> <XA xis> <M ajor> <C olor> <N amed>White</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Bold</S ty le>

Charts

63

<S ize>9.75</S ize> </M ajor> <M inor> <C olor> <N amed>White</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Regular</S ty le> <S ize>8.25</S ize> </M inor> </XA xis> <YA xis> <M ajor> <C olor> <N amed>Black</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Bold</S ty le> <S ize>9.75</S ize> </M ajor> <M inor> <C olor> <N amed>Black</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Regular</S ty le> <S ize>8.25</S ize> </M inor> <Title> <C olor> <N amed>Black</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Regular</S ty le> <S ize>8.25</S ize> </Title> </YA xis> <S eries> <C olor> <RG B>255;0;0</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>2</Width> <F illC olor> <N amed>Black</N amed> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <N amed>White</N amed> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <N amed>Red</N amed> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>62;169;0</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>62;169;0</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>156;38;115</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor>

64

TRKD API Developer's Guide

<RG B>156;38;115</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>255;120;0</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>255;120;0</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>25;108;229</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>25;108;229</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>60;117;28</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>60;117;28</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>230;176;18</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>230;176;18</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>0;186;193</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>0;186;193</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>255;178;127</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>255;178;127</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>100;79;190</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor>

Charts

65

<RG B>100;79;190</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>209;36;33</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>209;36;33</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>38;87;135</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>38;87;135</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>94;176;176</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>94;176;176</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <Lev elLine> <C olor> <RG B>0;0;153</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>1</Width> </Lev elLine> <Lev elLine> <C olor> <RG B>120;120;120</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>1</Width> </Lev elLine> </S cheme> </chartRequest> </G etC hart_Request_1> </Body > </E nv elope>

XML Sample Response - Retrieve 1Y Interday Stock Chart

<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader> <a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/ rkd/C harts_1/G etC hart_1_Reply </a:A ction> <a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </s:H eader> <s:Body > <G etC hart_Response_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C harts_1"> <C hartImageResult S erv er="api.rkd.reuters.com" Tag="5294F 1E 4824573D245D091494A E 60346" U rl="http://api.rkd.reuters. com/api/charts/3139392E 3234392E 33332E 3135/7-S ep-2007_01-33-29P M /5294F 1E 4824573D245D091494A E 60346.ashx" /> </G etC hart_Response_1> </Body > </E nv elope>

66

TRKD API Developer's Guide

Note: After the chart is generated it will be available for 15 minutes at the specified URL. The following is an example of a successfully built chart:

8.3.7

Retrieving 1Y Interday Stock Chart with Index Comparison

The following request demonstrates how to retrieve the 1Y Interday Stock Chart with Index Comparison. XML Sample Request - Retrieve 1Y Interday Stock Chart with Index Comparison
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/C harts_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C harts_1/ G etC hart_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etC hart_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C harts_1"> <chartRequest ImageTy pe="P N G " Width="500" H eight="400" C ulture="en-U S "> <TimeS eries> <TimeS eriesRequest xmlns="http://metastock.com/imageserv er/financial"> <S y mbol> IBM .N</S y mbol> <Reference> d1 </Reference> </TimeS eriesRequest> <TimeS eriesRequest xmlns="http://metastock.com/imageserv er/financial"> <S y mbol> .DJI </S y mbol>

Charts

67

<Reference> d2 </Reference> </TimeS eriesRequest> </TimeS eries> <A naly ses> <A naly sis xmlns="http://metastock.com/imageserv er/analy sis"> <Reference> a1 </Reference> <Line> <Instrument1> <Reference> d1 </Reference> </Instrument1> </Line> </A naly sis> <A naly sis xmlns="http://metastock.com/imageserv er/analy sis"> <Reference> a2 </Reference> <V ol> <Instrument1> <Reference> d1 </Reference> </Instrument1> </V ol> </A naly sis> <A naly sis xmlns="http://metastock.com/imageserv er/analy sis"> <Reference> a3 </Reference> <Line> <Instrument1> <Reference> d2 </Reference> </Instrument1> </Line> </A naly sis> </A naly ses> <S tandardTemplate xmlns="http://metastock.com/imageserv er/financial"> <Title> <C aption> <V isible>true</V isible> <C ustomized>false</C ustomized> </C aption> <Range> <V isible>true</V isible> </Range> </Title> <Legend> <V isible>true</V isible> <Information>Long</Information> <Lay out>M ultiLine</Lay out> <P osition>O v erlaid</P osition> </Legend> <Instrument>S y mbol</Instrument> <Delimiter>% </Delimiter> <G ridLines>Both</G ridLines> <YA xisM arkers>N one</YA xisM arkers> <YA xisTitles>Ty pe</YA xisTitles> <Brand>N one</Brand> <Interv al> <C ommonTy pe xmlns="http://metastock.com/applications/data">Day s</C ommonTy pe> <M ultiplier xmlns="http://metastock.com/applications/data">1</M ultiplier> </Interv al> <S how N onTradedP eriods>false</S how N onTradedP eriods> <S how H oliday s>false</S how H oliday s> <S how G aps>true</S how G aps> <XA xis> <V isible>true</V isible> <P osition>Bottom</P osition> <Range> <F ixed> <F irst> 2 0 0 6 -0 8 -0 1 T 0 0 :0 0 :0 0 </F irst> <Last> 2 0 0 7 -0 8 -0 1 T 0 0 :0 0 :0 0 </Last> </F ixed> </Range> </XA xis> <S ubchart> <Weight>5</Weight> <YA xis> <V isible>true</V isible> <P osition>Right</P osition> <Inv ert>false</Inv ert> <Logarithmic>false</Logarithmic> <Display > <M ode>A utomatic</M ode>

68

TRKD API Developer's Guide

</Display > <Range> <A utomatic /> </Range> <A naly sis> <Reference>a1</Reference> </A naly sis> </YA xis> </S ubchart> <S ubchart> <Weight>2</Weight> <YA xis> <V isible>true</V isible> <P osition>Right</P osition> <Inv ert>false</Inv ert> <Logarithmic>false</Logarithmic> <Display > <M ode>A utomatic</M ode> </Display > <Range> <A utomatic /> </Range> <A naly sis> <Reference>a2</Reference> </A naly sis> </YA xis> <YA xis> <V isible>true</V isible> <P osition>Left</P osition> <Inv ert>false</Inv ert> <Logarithmic>false</Logarithmic> <Display > <M ode>A utomatic</M ode> </Display > <Range> <A utomatic /> </Range> <A naly sis> <Reference>a3</Reference> </A naly sis> </YA xis> </S ubchart> <S ubchart> <Weight>2</Weight> <YA xis> <V isible>true</V isible> <P osition>Right</P osition> <Inv ert>false</Inv ert> <Logarithmic>false</Logarithmic> <Display > <M ode>A utomatic</M ode> </Display > <Range> <A utomatic /> </Range> <A naly sis> <Reference>a2</Reference> </A naly sis> </YA xis> </S ubchart> </S tandardTemplate> <S cheme xmlns="http://metastock.com/imageserv er/financial"> <Background> <BackgroundM ode>H atch</BackgroundM ode> <S tartC olor> <N amed>White</N amed> </S tartC olor> <E ndC olor> <N amed>White</N amed> </E ndC olor> <H atchS ty le>H orizontal</H atchS ty le> <G radientM ode>H orizontal</G radientM ode> <ImageM ode>C entered</ImageM ode> </Background> <Border> <C olor> <RG B>139;139;155</RG B>

Charts

69

</C olor> <DashS ty le>S olid</DashS ty le> <Width>1</Width> </Border> <G ridLines> <C olor> <RG B>139;139;155</RG B> </C olor> <DashS ty le>Dot</DashS ty le> <Width>1</Width> </G ridLines> <Title> <C aption> <C olor> <N amed>Black</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Bold</S ty le> <S ize>12</S ize> </C aption> <Range> <C olor> <N amed>Black</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Regular</S ty le> <S ize>8.25</S ize> </Range> </Title> <Legend> <C olor> <N amed>Black</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Regular</S ty le> <S ize>8.25</S ize> </Legend> <XA xis> <M ajor> <C olor> <N amed>Black</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Bold</S ty le> <S ize>9.75</S ize> </M ajor> <M inor> <C olor> <N amed>Black</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Regular</S ty le> <S ize>8.25</S ize> </M inor> </XA xis> <YA xis> <M ajor> <C olor> <N amed>Black</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Bold</S ty le> <S ize>9.75</S ize> </M ajor> <M inor> <C olor> <N amed>Black</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Regular</S ty le> <S ize>8.25</S ize> </M inor> <Title> <C olor> <N amed>Black</N amed> </C olor> <F amily >A rial</F amily >

70

TRKD API Developer's Guide

<S ty le>Regular</S ty le> <S ize>8.25</S ize> </Title> </YA xis> <S eries> <C olor> <RG B>255;0;0</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>2</Width> <F illC olor> <N amed>Black</N amed> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>51;0;153</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>2</Width> <F illC olor> <N amed>Red</N amed> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>153;0;0</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>62;169;0</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>156;38;115</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>156;38;115</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>255;120;0</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>255;120;0</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>25;108;229</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>25;108;229</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>60;117;28</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor>

Charts

71

<RG B>60;117;28</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>230;176;18</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>230;176;18</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>0;186;193</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>0;186;193</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>255;178;127</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>255;178;127</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>100;79;190</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>100;79;190</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>209;36;33</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>209;36;33</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>38;87;135</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>38;87;135</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>94;176;176</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor>

72

TRKD API Developer's Guide

<RG B>94;176;176</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <Lev elLine> <C olor> <RG B>0;0;153</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>1</Width> </Lev elLine> <Lev elLine> <C olor> <RG B>120;120;120</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>1</Width> </Lev elLine> </S cheme> </chartRequest> </G etC hart_Request_1> </Body > </E nv elope>

XML Sample Response - Retrieve 1Y Interday Stock Chart with Index Comparison
<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader> <a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/ rkd/C harts_1/G etC hart_1_Reply </a:A ction> <a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </s:H eader> <s:Body > <G etC hart_Response_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C harts_1"> <C hartImageResult S erv er="api.rkd.reuters.com" Tag="9B922A 44A 2DB3405C D20BF 63F 0E BD75F " U rl="http://api.rkd.reuters.com/ api/charts/3139392E 3234392E 33332E 3135/7-S ep-2007_04-29-29P M /9B922A 44A 2DB3405C D20BF 63F 0E BD75F .ashx" /> </G etC hart_Response_1> </Body > </E nv elope>

Note: After the chart is generated it will be available for 15 minutes at the specified URL. The following is an example of a successfully built chart:

Charts

73

8.3.8

Retrieving 1Y Interday Percent Change Stock Chart with Index Comparison

The following request demonstrates how to retrieve the 1Y Interday Percent Change Stock Chart with Index Comparison. XML Sample Request - Retrieve 1Y Interday Percent Change Stock Chart with Index Comparison
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/C harts_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C harts_1/ G etC hart_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etC hart_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C harts_1"> <chartRequest ImageTy pe="P N G " Width="500" H eight="400" C ulture="en-U S "> <TimeS eries> <TimeS eriesRequest xmlns="http://metastock.com/imageserv er/financial"> <S y mbol> IBM .N</S y mbol> <Reference> d1 </Reference> </TimeS eriesRequest> <TimeS eriesRequest xmlns="http://metastock.com/imageserv er/financial"> <S y mbol> .DJI </S y mbol> <Reference> d2 </Reference> </TimesS eriesRequest> </TimeS eries> <A naly ses> <A naly sis xmlns="http://metastock.com/imageserv er/analy sis"> <Reference> a1 </Reference>

74

TRKD API Developer's Guide

<P ctC ng> <Instrument1> <Reference> d1 </Reference> </Instrument1> <P ercentC hangeS elector>S pecifiedDate</P ercentC hangeS elector> <S pecifiedDate> 2 0 0 6 -0 8 -0 1 T 0 0 :0 0 :0 0 </S pecifiedDate> </P ctC ng> </A naly sis> <A naly sis xmlns="http://metastock.com/imageserv er/analy sis"> <Reference> a2 </Reference> <V ol> <Instrument1> <Reference> d1 </Reference> </Instrument1> </V ol> </A naly sis> <A naly sis xmlns="http://metastock.com/imageserv er/analy sis"> <Reference> a3 </Reference> <P ctC ng> <Instrument1> <Reference> d2 </Reference> </Instrument1> <P ercentC hangeS elector>S pecifiedDate</P ercentC hangeS elector> <S pecifiedDate> 2 0 0 6 -0 8 -0 1 T 0 0 :0 0 :0 0 </S pecifiedDate> </P ctC ng> </A naly sis> </A naly ses> <S tandardTemplate xmlns="http://metastock.com/imageserv er/financial"> <Title> <C aption> <V isible>true</V isible> <C ustomized>false</C ustomized> </C aption> <Range> <V isible>true</V isible> </Range> </Title> <Legend> <V isible>true</V isible> <Information>Long</Information> <Lay out>M ultiLine</Lay out> <P osition>O v erlaid</P osition> </Legend> <Instrument>S y mbol</Instrument> <Delimiter>% </Delimiter> <G ridLines>Both</G ridLines> <YA xisM arkers>N one</YA xisM arkers> <YA xisTitles>N one</YA xisTitles> <Brand>N one</Brand> <Interv al> <C ommonTy pe xmlns="http://metastock.com/applications/data">Day s</C ommonTy pe> <M ultiplier xmlns="http://metastock.com/applications/data">1</M ultiplier> </Interv al> <S how N onTradedP eriods>false</S how N onTradedP eriods> <S how H oliday s>false</S how H oliday s> <S how G aps>true</S how G aps> <XA xis> <V isible>true</V isible> <P osition>Bottom</P osition> <Range> <F ixed> <F irst> 2 0 0 6 -0 8 -0 1 T 0 0 :0 0 :0 0 </F irst> <Last> 2 0 0 7 -0 8 -0 1 T 0 0 :0 0 :0 0 </Last> </F ixed> </Range> </XA xis> <S ubchart> <Weight>6</Weight> <YA xis> <V isible>true</V isible> <P osition>Right</P osition> <Inv ert>false</Inv ert> <Logarithmic>false</Logarithmic> <Display > <M ode>A utomatic</M ode> </Display > <Range>

Charts

75

<A utomatic /> </Range> <A naly sis> <Reference>a1</Reference> </A naly sis> </YA xis> </S ubchart> <S ubchart> <Weight>2</Weight> <YA xis> <V isible>true</V isible> <P osition>Right</P osition> <Inv ert>false</Inv ert> <Logarithmic>false</Logarithmic> <Display > <M ode>A utomatic</M ode> </Display > <Range> <A utomatic /> </Range> <A naly sis> <Reference>a2</Reference> </A naly sis> </YA xis> </S ubchart> </S tandardTemplate> <S cheme xmlns="http://metastock.com/imageserv er/financial"> <Background> <BackgroundM ode>H atch</BackgroundM ode> <S tartC olor> <N amed>White</N amed> </S tartC olor> <E ndC olor> <N amed>White</N amed> </E ndC olor> <H atchS ty le>H orizontal</H atchS ty le> <G radientM ode>H orizontal</G radientM ode> <ImageM ode>C entered</ImageM ode> </Background> <Border> <C olor> <RG B>139;139;155</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>1</Width> </Border> <G ridLines> <C olor> <RG B>139;139;155</RG B> </C olor> <DashS ty le>Dot</DashS ty le> <Width>1</Width> </G ridLines> <Title> <C aption> <C olor> <N amed>Black</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Bold</S ty le> <S ize>12</S ize> </C aption> <Range> <C olor> <N amed>Black</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Regular</S ty le> <S ize>8.25</S ize> </Range> </Title> <Legend> <C olor> <N amed>Black</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Regular</S ty le>

76

TRKD API Developer's Guide

<S ize>8.25</S ize> </Legend> <XA xis> <M ajor> <C olor> <RG B>0;51;0</RG B> </C olor> <F amily >A rial</F amily > <S ty le>Bold</S ty le> <S ize>9.75</S ize> </M ajor> <M inor> <C olor> <RG B>0;51;0</RG B> </C olor> <F amily >A rial</F amily > <S ty le>Regular</S ty le> <S ize>8.25</S ize> </M inor> </XA xis> <YA xis> <M ajor> <C olor> <RG B>0;51;0</RG B> </C olor> <F amily >A rial</F amily > <S ty le>Bold</S ty le> <S ize>9.75</S ize> </M ajor> <M inor> <C olor> <RG B>0;51;0</RG B> </C olor> <F amily >A rial</F amily > <S ty le>Regular</S ty le> <S ize>8.25</S ize> </M inor> <Title> <C olor> <RG B>0;51;0</RG B> </C olor> <F amily >A rial</F amily > <S ty le>Regular</S ty le> <S ize>8.25</S ize> </Title> </YA xis> <S eries> <C olor> <RG B>0;102;0</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>1</Width> <F illC olor> <N amed>Black</N amed> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>255;51;0</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>1</Width> <F illC olor> <N amed>Red</N amed> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>51;153;51</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>62;169;0</RG B> </F illC olor>

Charts

77

<F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>156;38;115</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>156;38;115</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>255;120;0</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>255;120;0</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>25;108;229</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>25;108;229</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>60;117;28</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>60;117;28</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>230;176;18</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>230;176;18</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>0;186;193</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>0;186;193</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>255;178;127</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>255;178;127</RG B> </F illC olor>

78

TRKD API Developer's Guide

<F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>100;79;190</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>100;79;190</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>209;36;33</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>209;36;33</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>38;87;135</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>38;87;135</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>94;176;176</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>94;176;176</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <Lev elLine> <C olor> <RG B>120;120;120</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>1</Width> </Lev elLine> </S cheme> </chartRequest> </G etC hart_Request_1> </Body > </E nv elope>

XML Sample Response - Retrieve 1Y Interday Percent Change Stock Chart with Index Comparison
<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader> <a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/ rkd/C harts_1/G etC hart_1_Reply </a:A ction> <a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </s:H eader> <s:Body > <G etC hart_Response_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C harts_1"> <C hartImageResult S erv er="api.rkd.reuters.com" Tag="7089F 648B00DF 2D96764F 5D0BB54F 445" U rl="http://api.rkd.reuters.com/api/ charts/3139392E 3234392E 33332E 3135/10-S ep-2007__11-43-46A M /7089F 648B00DF 2D96764F 5D0BB54F 445.ashx" /> </G etC hart_Response_1> </Body >

Charts

79

</E nv elope>

Note: After the chart is generated it will be available for 15 minutes at the specified URL. The following is an example of a successfully built chart:

8.3.9

Retrieving 5 Day Intraday Dual Stock Chart with Simple Moving Average
The following request demonstrates how to retrieve the 5 Day Intraday Dual Stock Chart with Simple Moving Average. XML Sample Request - Retrieve 5 Day Intraday Dual Stock Chart with Simple Moving Average
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/C harts_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C harts_1/ G etC hart_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etC hart_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C harts_1"> <chartRequest ImageTy pe="P N G " Width="500" H eight="400" C ulture="en-U S "> <TimeS eries> <TimeS eriesRequest xmlns="http://metastock.com/imageserv er/financial"> <S y mbol> IBM .N</S y mbol> <Reference> d1 </Reference> </TimeS eriesRequest>

80

TRKD API Developer's Guide

<TimeS eriesRequest xmlns="http://metastock.com/imageserv er/financial"> <S y mbol> M SFT .O </S y mbol> <Reference> d2 </Reference> </TimeS eriesRequest> </TimeS eries> <A naly ses> <A naly sis xmlns="http://metastock.com/imageserv er/analy sis"> <Reference> a1 </Reference> <O H LC > <Instrument1> <Reference> d1 </Reference> </Instrument1> </O H LC > </A naly sis> <A naly sis xmlns="http://metastock.com/imageserv er/analy sis"> <Reference> a2 </Reference> <V ol> <Instrument1> <Reference> d1 </Reference> </Instrument1> </V ol> </A naly sis> <A naly sis xmlns="http://metastock.com/imageserv er/analy sis"> <Reference> a3 </Reference> <Line> <Instrument1> <Reference> d2 </Reference> </Instrument1> </Line> </A naly sis> <A naly sis xmlns="http://metastock.com/imageserv er/analy sis"> <Reference> sma </Reference> <S M A > <Instrument1> <Reference>d1</Reference> </Instrument1> </S M A > </A naly sis> </A naly ses> <S tandardTemplate xmlns="http://metastock.com/imageserv er/financial"> <Title> <C aption> <V isible>true</V isible> <C ustomized>false</C ustomized> </C aption> <Range> <V isible>true</V isible> </Range> </Title> <Legend> <V isible>true</V isible> <Information>S hort</Information> <Lay out>WrappedLine</Lay out> <P osition>Below </P osition> </Legend> <Instrument>S y mbol</Instrument> <Delimiter>% </Delimiter> <G ridLines>N one</G ridLines> <YA xisM arkers>N one</YA xisM arkers> <YA xisTitles>Ty pe</YA xisTitles> <Brand>N one</Brand> <Interv al> <C ommonTy pe xmlns="http://metastock.com/applications/data"> H our s </C ommonTy pe> <M ultiplier xmlns="http://metastock.com/applications/data">1</M ultiplier> </Interv al> <S how N onTradedP eriods>false</S how N onTradedP eriods> <S how H oliday s>false</S how H oliday s> <S how G aps>true</S how G aps> <XA xis> <V isible>true</V isible> <P osition>Bottom</P osition> <Range> <F ixed> <F irst> 2 0 0 7 -0 7 -2 3 T 0 0 :0 0 :0 0 </F irst> <Last> 2 0 0 7 -0 8 -0 1 T 0 0 :0 0 :0 0 </Last> </F ixed> </Range>

Charts

81

</XA xis> <S ubchart> <Weight>5</Weight> <YA xis> <V isible>true</V isible> <P osition>Right</P osition> <Inv ert>false</Inv ert> <Logarithmic>false</Logarithmic> <Display > <M ode>A utomatic</M ode> </Display > <Range> <A utomatic /> </Range> <A naly sis> <Reference>a1</Reference> </A naly sis> </YA xis> <YA xis> <V isible>true</V isible> <P osition>Left</P osition> <Inv ert>false</Inv ert> <Logarithmic>false</Logarithmic> <Display > <M ode>A utomatic</M ode> </Display > <Range> <A utomatic /> </Range> <A naly sis> <Reference>a3</Reference> </A naly sis> </YA xis> <YA xis> <V isible>false</V isible> <P osition>Right</P osition> <Inv ert>false</Inv ert> <Logarithmic>false</Logarithmic> <Display > <M ode>A utomatic</M ode> </Display > <Range> <A utomatic /> </Range> <A naly sis> <Reference>sma</Reference> </A naly sis> </YA xis> </S ubchart> <S ubchart> <Weight>2</Weight> <YA xis> <V isible>true</V isible> <P osition>Right</P osition> <Inv ert>false</Inv ert> <Logarithmic>false</Logarithmic> <Display > <M ode>A utomatic</M ode> </Display > <Range> <A utomatic /> </Range> <A naly sis> <Reference>a2</Reference> </A naly sis> </YA xis> </S ubchart> </S tandardTemplate> <S cheme xmlns="http://metastock.com/imageserv er/financial"> <Background> <BackgroundM ode>S olid</BackgroundM ode> <S tartC olor> <N amed>Black</N amed> </S tartC olor> <E ndC olor> <N amed>Black</N amed> </E ndC olor>

82

TRKD API Developer's Guide

<H atchS ty le>H orizontal</H atchS ty le> <G radientM ode>H orizontal</G radientM ode> <ImageM ode>C entered</ImageM ode> </Background> <Border> <C olor> <RG B>139;139;155</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>1</Width> </Border> <G ridLines> <C olor> <RG B>139;139;155</RG B> </C olor> <DashS ty le>Dot</DashS ty le> <Width>1</Width> </G ridLines> <Title> <C aption> <C olor> <RG B>255;255;0</RG B> </C olor> <F amily >A rial</F amily > <S ty le>Bold</S ty le> <S ize>12</S ize> </C aption> <Range> <C olor> <N amed>LightG ray </N amed> </C olor> <F amily >A rial</F amily > <S ty le>Regular</S ty le> <S ize>8.25</S ize> </Range> </Title> <Legend> <C olor> <N amed>LightG ray </N amed> </C olor> <F amily >A rial</F amily > <S ty le>Regular</S ty le> <S ize>8.25</S ize> </Legend> <XA xis> <M ajor> <C olor> <N amed>LightG ray </N amed> </C olor> <F amily >A rial</F amily > <S ty le>Bold</S ty le> <S ize>9.75</S ize> </M ajor> <M inor> <C olor> <N amed>LightG ray </N amed> </C olor> <F amily >A rial</F amily > <S ty le>Regular</S ty le> <S ize>8.25</S ize> </M inor> </XA xis> <YA xis> <M ajor> <C olor> <N amed>LightG ray </N amed> </C olor> <F amily >A rial</F amily > <S ty le>Bold</S ty le> <S ize>9.75</S ize> </M ajor> <M inor> <C olor> <N amed>LightG ray </N amed> </C olor> <F amily >A rial</F amily > <S ty le>Regular</S ty le>

Charts

83

<S ize>8.25</S ize> </M inor> <Title> <C olor> <N amed>LightG ray </N amed> </C olor> <F amily >A rial</F amily > <S ty le>Regular</S ty le> <S ize>8.25</S ize> </Title> </YA xis> <S eries> <C olor> <RG B>51;255;255</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <N amed>Black</N amed> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>255;51;0</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>2</Width> <F illC olor> <N amed>Red</N amed> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>255;255;0</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>62;169;0</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>0;204;0</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>156;38;115</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>255;120;0</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>255;120;0</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>25;108;229</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>25;108;229</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries>

84

TRKD API Developer's Guide

<S eries> <C olor> <RG B>60;117;28</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>60;117;28</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>230;176;18</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>230;176;18</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>0;186;193</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>0;186;193</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>255;178;127</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>255;178;127</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>100;79;190</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>100;79;190</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>209;36;33</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>209;36;33</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>38;87;135</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>38;87;135</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries>

Charts

85

<S eries> <C olor> <RG B>94;176;176</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>94;176;176</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <Lev elLine> <C olor> <RG B>0;0;153</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>1</Width> </Lev elLine> <Lev elLine> <C olor> <RG B>120;120;120</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>1</Width> </Lev elLine> </S cheme> </chartRequest> </G etC hart_Request_1> </Body > </E nv elope>

XML Sample Response - Retrieve 5 Day Intraday Dual Stock Chart with Simple Moving Average
<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader> <a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/ rkd/C harts_1/G etC hart_1_Reply </a:A ction> <a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </s:H eader> <s:Body > <G etC hart_Response_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C harts_1"> <C hartImageResult S erv er="api.rkd.reuters.com" Tag="54058F A B0E 171A E 4277E 62119F 356278" U rl="http://api.rkd.reuters.com/api/ charts/3136372E 37362E 3132332E 313037/10-S ep-2007_01-19-19P M /54058F A B0E 171A E 4277E 62119F 356278.ashx" /> </G etC hart_Response_1> </Body > </E nv elope>

Note: After the chart is generated it will be available for 15 minutes at the specified URL. The following is an example of a successfully built chart:

86

TRKD API Developer's Guide

8.3.10 Retrieving 1 Day Intraday Stock Chart

The following request demonstrates how to retrieve the 1 Day Intraday Stock Chart. XML Sample Request - Retrieve 1 Day Intraday Stock Chart
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/C harts_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C harts_1/ G etC hart_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etC hart_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C harts_1"> <chartRequest ImageTy pe="P N G " Width="500" H eight="400" C ulture="en-U S "> <TimeS eries> <TimeS eriesRequest xmlns="http://metastock.com/imageserv er/financial"> <S y mbol> IBM .N</S y mbol> <Reference> d1 </Reference> </TimeS eriesRequest> </TimeS eries> <A naly ses> <A naly sis xmlns="http://metastock.com/imageserv er/analy sis"> <Reference> a1 </Reference> <Line> <Instrument1> <Reference> d1 </Reference> </Instrument1>

Charts

87

<S eries1> <N ame> FilledLine </N ame> </S eries1> </Line> </A naly sis> </A naly ses> <S tandardTemplate xmlns="http://metastock.com/imageserv er/financial"> <Title> <C aption> <V isible>true</V isible> <C ustomized>false</C ustomized> </C aption> <Range> <V isible>true</V isible> </Range> </Title> <Legend> <V isible>true</V isible> <Information>Long</Information> <Lay out>M ultiLine</Lay out> <P osition>O v erlaid</P osition> </Legend> <Instrument>S y mbol</Instrument> <Delimiter>% </Delimiter> <G ridLines>Both</G ridLines> <YA xisM arkers>N one</YA xisM arkers> <YA xisTitles>Ty pe C urrency </YA xisTitles> <Brand>N one</Brand> <Interv al> <C ommonTy pe xmlns="http://metastock.com/applications/data"> M inutes </C ommonTy pe> <M ultiplier xmlns="http://metastock.com/applications/data">1</M ultiplier> </Interv al> <S how N onTradedP eriods>false</S how N onTradedP eriods> <S how H oliday s>false</S how H oliday s> <S how G aps>true</S how G aps> <XA xis> <V isible>true</V isible> <P osition>Bottom</P osition> <Range> <F ixed> <F irst> 2 0 0 7 -0 8 -0 1 T 0 0 :0 0 :0 0 </F irst> <Last> 2 0 0 7 -0 8 -0 2 T 0 0 :0 0 :0 0 </Last> </F ixed> </Range> </XA xis> <S ubchart> <Weight>1</Weight> <YA xis> <V isible>true</V isible> <P osition>Right</P osition> <Inv ert>false</Inv ert> <Logarithmic>false</Logarithmic> <Display > <M ode>A utomatic</M ode> </Display > <Range> <A utomatic /> </Range> <A naly sis> <Reference>a1</Reference> </A naly sis> </YA xis> </S ubchart> </S tandardTemplate> <S cheme xmlns="http://metastock.com/imageserv er/financial"> <Background> <BackgroundM ode>S olid</BackgroundM ode> <S tartC olor> <N amed>White</N amed> </S tartC olor> <E ndC olor> <N amed>White</N amed> </E ndC olor> <H atchS ty le>LargeG rid</H atchS ty le> <G radientM ode>F orw ardDiagonal</G radientM ode> <ImageM ode>C entered</ImageM ode> </Background>

88

TRKD API Developer's Guide

<Border> <C olor> <RG B>139;139;155</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>1</Width> </Border> <G ridLines> <C olor> <RG B>139;139;155</RG B> </C olor> <DashS ty le>Dot</DashS ty le> <Width>1</Width> </G ridLines> <Title> <C aption> <C olor> <RG B>51;0;102</RG B> </C olor> <F amily >A rial</F amily > <S ty le>Bold</S ty le> <S ize>12</S ize> </C aption> <Range> <C olor> <RG B>51;0;102</RG B> </C olor> <F amily >A rial</F amily > <S ty le>Regular</S ty le> <S ize>8.25</S ize> </Range> </Title> <Legend> <C olor> <RG B>51;0;102</RG B> </C olor> <F amily >A rial</F amily > <S ty le>Regular</S ty le> <S ize>8.25</S ize> </Legend> <XA xis> <M ajor> <C olor> <RG B>51;0;102</RG B> </C olor> <F amily >A rial</F amily > <S ty le>Bold</S ty le> <S ize>9.75</S ize> </M ajor> <M inor> <C olor> <RG B>51;0;102</RG B> </C olor> <F amily >A rial</F amily > <S ty le>Regular</S ty le> <S ize>8.25</S ize> </M inor> </XA xis> <YA xis> <M ajor> <C olor> <RG B>51;0;102</RG B> </C olor> <F amily >A rial</F amily > <S ty le>Bold</S ty le> <S ize>9.75</S ize> </M ajor> <M inor> <C olor> <RG B>51;0;102</RG B> </C olor> <F amily >A rial</F amily > <S ty le>Regular</S ty le> <S ize>8.25</S ize> </M inor> <Title> <C olor>

Charts

89

<RG B>51;0;102</RG B> </C olor> <F amily >A rial</F amily > <S ty le>Regular</S ty le> <S ize>8.25</S ize> </Title> </YA xis> <S eries> <C olor> <RG B>51;0;102</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>1</Width> <F illC olor> <RG B>51;0;153</RG B> </F illC olor> <F illS ty le>P ercent90</F illS ty le> </S eries> <S eries> <C olor> <N amed>Red</N amed> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <N amed>Red</N amed> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>62;169;0</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>62;169;0</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>156;38;115</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>156;38;115</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>255;120;0</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>255;120;0</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>25;108;229</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>25;108;229</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>60;117;28</RG B> </C olor>

90

TRKD API Developer's Guide

<DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>60;117;28</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>230;176;18</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>230;176;18</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>0;186;193</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>0;186;193</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>255;178;127</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>255;178;127</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>100;79;190</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>100;79;190</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>209;36;33</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>209;36;33</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>38;87;135</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>38;87;135</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>94;176;176</RG B> </C olor>

Charts

91

<DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>94;176;176</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <Lev elLine> <C olor> <RG B>0;0;153</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>1</Width> </Lev elLine> <Lev elLine> <C olor> <RG B>120;120;120</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>1</Width> </Lev elLine> </S cheme> </chartRequest> </G etC hart_Request_1> </Body > </E nv elope>

XML Sample Response - Retrieve 1 Day Intraday Stock Chart

<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader> <a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/ rkd/C harts_1/G etC hart_1_Reply </a:A ction> <a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </s:H eader> <s:Body > <G etC hart_Response_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C harts_1"> <C hartImageResult S erv er="api.rkd.reuters.com" Tag="442B938C 49A 9B8A 80F A 14E F 2E A C A 7F 76" U rl="http://api.rkd.reuters.com/ api/charts/3136372E 37362E 3132332E 313037/10-S ep-2007_01-59-59P M /442B938C 49A 9B8A 80F A 14E F 2E A C A 7F 76.ashx" /> </G etC hart_Response_1> </Body > </E nv elope>

Note: After the chart is generated it will be available for 15 minutes at the specified URL. The following is an example of a successfully built chart:

92

TRKD API Developer's Guide

8.4

Understanding Reuters Charts Response

When a valid chart request is sent the chart is created with a unique Tag by which it can be retrieved. Note: After the chart is generated it will be available for 15 minutes at the specified URL. XML Sample Response - Get Reuters Charts
<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader> <a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" s:mustU nderstand="1"> ttp://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/ http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/ </a:A ction> <a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etC hart_Response_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C harts_1"> < C har tImageResult Ser ver ="[serv er]" T ag ="A 8A 510A D1879D3DA 8C DB7F F 4D02B0BF A " Ur l ="http://[serv er]/api/ charts/31302E 39302E 312E 3837/19-Jun-2007_10-03-44P M /A 8A 510A D1879D3DA 8C DB7F F 4D02B0BF A .ashx" /> </G etC hart_Response_1> </Body > </E nv elope>

Attribute Server Tag Url

Description Server where the image is located. Image ID. Url location of the image.

Charts

93

Note: If you receive "Error Currency Conversion not supported" error, try putting different currencies on different axes in the same chart. For example, if you plot TRIL.L and .DJI on the same axis then the second item isn't plotted and the image contains the error message above. The following is an example of a successfully built chart:

8.5

Analyses List
The following is the list of Analysis you are able to perform in Reuters Charts. Code AbsCng HL HLC OHLC BBand Candle ChkMF CCI Envlp Invrs Line MACD MACDF MdnP Mom Analysis Name Absolute Change Bar High/Low Bar High/Low/Close Bar Open/High/Low/Close Bollinger Bands Candle Chaikin Money Flow Commodity Channel Index Envelopes Percentage Inverse Line MACD MACD Forest/Histogram Median Price Momentum

94

TRKD API Developer's Guide

EMA SMA WMA OBV OBVW Osc PctCng PctR ROC Ratio IPP RelPrf RSI Spread StochF StochS VltyCC Vol WClose Yield Yield Spread

Moving Average Exponential Moving Average Simple Moving Average Weighted On Balance Volume On Balance Volume Weighted Oscillator Percent Change Percent R Rate of Change Ratio Indexed Price Performance/Rebasing Relative Performance Relative Strength Index Spread (Views) Stochastics Fast Stochastics Slow Volatility Close-to-Close Volume Weighted Close Yield Yield Spread

8.6

How to Build a Chart

This chapter provides instructions and request examples that will help you build your own charts.

8.6.1

Making Chart Request

In order to build a chart, first you need to fetch data. To do so, use the Time Series section of the form in the Request Builder:

The Reference value can be any string you like (in the example above it is "d1"). You will need to use this reference when you

Charts

95

specify the analysis, so that the charting engine knows, which time series you want to apply to each analysis. After you have fetched data, you can apply different analyses to it. The analysis data is then used to plot the series on the chart.

Each analysis most commonly has one series to plot, but some may have up to three series (e.g. Bollinger Bands). This is important because you assign colors and styles to series based on their number in the whole sequence of all series of the chart. You can specify the reference for this Analysis as any string of your choice (in the example above it is "a1"). You will need to use this reference when you specify which subchart and axis you want to plot it on. You need to ensure that the Reference you specify for the Instrument matches the reference you specified for the appropriate Time Series. In this case it is "d1". Now when you have data to plot, you should arrange the different series on subcharts. Each subchart is an individual set of Y-Axis (up to two independent) and can have several series plotted on it. All subcharts share the same global X-Axis (time). To create a subchart use corresponding link on the form - "Add Subchart ". Any subchart has the Weight property, which defines how much space it will take on the global chart, as compared to other subcharts. To add Y-Axis use the corresponding link - "Add Y-Axis ". One Y-Axis can contain several analyses, you just need to make sure the resulting series have the same units and close ranges of values. You can specify the location of the axis: left or right, the range of values, and some other properties. To add analysis to the Y-Axis use the corresponding link:

96

TRKD API Developer's Guide

Use the ID you specified when creating analysis to reference it (in the example the reference to the analysis is "a1"):

After you have arranged all needed analyses into the corresponding subcharts and Y-Axis, you should check the resulting series sequence in order to determine the exact number of each individual line to configure the line styles respectively.

Charts

97

8.6.1.1

Example 1
For example we have two data fetches "d1" and "d2" (e.g. MSFT.O and .DJI). The first one has 2 analyses applied to it "a1" and "a2" (PctCng and Vol). The second one has only one analysis "a3" (PctCng). You want to plot PctCng for both RICs on the same subchart, and since they have the same value units (%) and most likely the same range (from -100% to +100% as maximum) you can plot both on the same Y-Axis. And the Vol is usually plotted on a separate subchart below the main one. On the form you will have something like this: Time Series Reference: d1 Symbol: MSFT.O Reference: d2 Symbol: .DJI Analyses Reference: a1 Type: PctCng Instrument: d1 Reference: a2 Type: Vol Instrument: d1 Reference: a3 Type: PctCng Instrument: d2 Chart X-Axis Subchart, Weight: 5 Y-Axis Analysis a1 Analysis a3 Subchart, Weight: 2 Y-Axis Analysis a2 Scheme Series, Color: Red (for TRIL.L pctcng) Series, Color: Blue (for .FTSE pctcng) Series, Color: Red (for TRIL.L vol) This gives the final series sequence 'a1', 'a3', 'a2'. You should use the Series Line/Fill controls in the same order to apply the right colors to the right lines. As a result, you will get the chart that looks like this:

98

TRKD API Developer's Guide

In XML it will look like this: XML Sample Request - Example 1 Making Chart with MSFT.O and .DJI
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/C harts_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C harts_1/ G etC hart_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etC hart_Request_1 xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema" xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C harts_1"> <chartRequest ImageTy pe="P N G " Width="500" H eight="400" C ulture="en-U S "> <TimeS eries> <TimeS eriesRequest xmlns="http://metastock.com/imageserv er/financial"> <S y mbol>M S F T.O </S y mbol> <Reference>d1</Reference> </TimeS eriesRequest> <TimeS eriesRequest xmlns="http://metastock.com/imageserv er/financial"> <S y mbol>.DJI</S y mbol> <Reference>d2</Reference> </TimeS eriesRequest> </TimeS eries> <A naly ses> <A naly sis xmlns="http://metastock.com/imageserv er/analy sis"> <Reference>a1</Reference> <P ctC ng> <Instrument1> <Reference>d1</Reference> </Instrument1> </P ctC ng>

Charts

99

</A naly sis> <A naly sis xmlns="http://metastock.com/imageserv er/analy sis"> <Reference>a2</Reference> <V ol> <Instrument1> <Reference>d1</Reference> </Instrument1> </V ol> </A naly sis> <A naly sis xmlns="http://metastock.com/imageserv er/analy sis"> <Reference>a3</Reference> <P ctC ng> <Instrument1> <Reference>d2</Reference> </Instrument1> </P ctC ng> </A naly sis> </A naly ses> <S tandardTemplate xmlns="http://metastock.com/imageserv er/financial"> <Title> <C aption> <V isible>true</V isible> <C ustomized>false</C ustomized> </C aption> <Range> <V isible>true</V isible> </Range> </Title> <Legend> <V isible>true</V isible> <Information>Long</Information> <Lay out>M ultiLine</Lay out> <P osition>O v erlaid</P osition> </Legend> <Instrument>S y mbol</Instrument> <Delimiter>% </Delimiter> <G ridLines>N one</G ridLines> <YA xisM arkers>N one</YA xisM arkers> <YA xisTitles>N one</YA xisTitles> <Brand>N one</Brand> <Interv al> <C ommonTy pe xmlns="http://metastock.com/applications/data">Day s</C ommonTy pe> <M ultiplier xmlns="http://metastock.com/applications/data">1</M ultiplier> </Interv al> <S how N onTradedP eriods>false</S how N onTradedP eriods> <S how H oliday s>false</S how H oliday s> <S how G aps>true</S how G aps> <XA xis> <V isible>true</V isible> <P osition>Bottom</P osition> <Range> <F ixed> <F irst>2009-04-17T00:00:00</F irst> <Last>2009-05-24T00:00:00</Last> </F ixed> </Range> </XA xis> <S ubchart> <Weight>5</Weight> <YA xis> <V isible>true</V isible> <P osition>Right</P osition> <Inv ert>false</Inv ert> <Logarithmic>false</Logarithmic> <Display > <M ode>A utomatic</M ode> </Display > <Range> <A utomatic /> </Range> <A naly sis> <Reference>a1</Reference> </A naly sis> <A naly sis> <Reference>a3</Reference> </A naly sis> </YA xis>

100

TRKD API Developer's Guide

</S ubchart> <S ubchart> <Weight>2</Weight> <YA xis> <V isible>true</V isible> <P osition>Right</P osition> <Inv ert>false</Inv ert> <Logarithmic>false</Logarithmic> <Display > <M ode>A utomatic</M ode> </Display > <Range> <A utomatic /> </Range> <A naly sis> <Reference>a2</Reference> </A naly sis> </YA xis> </S ubchart> </S tandardTemplate> <S cheme xmlns="http://metastock.com/imageserv er/financial"> <Background> <BackgroundM ode>S olid</BackgroundM ode> <S tartC olor> <N amed>White</N amed> </S tartC olor> <E ndC olor> <N amed>White</N amed> </E ndC olor> <H atchS ty le>LargeG rid</H atchS ty le> <G radientM ode>F orw ardDiagonal</G radientM ode> <ImageM ode>C entered</ImageM ode> </Background> <Border> <C olor> <RG B>139;139;155</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>1</Width> </Border> <G ridLines> <C olor> <RG B>139;139;155</RG B> </C olor> <DashS ty le>Dot</DashS ty le> <Width>1</Width> </G ridLines> <Title> <C aption> <C olor> <N amed>Black</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Bold</S ty le> <S ize>12</S ize> </C aption> <Range> <C olor> <N amed>Black</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Regular</S ty le> <S ize>8.25</S ize> </Range> </Title> <Legend> <C olor> <N amed>Black</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Regular</S ty le> <S ize>8.25</S ize> </Legend> <XA xis> <M ajor> <C olor> <N amed>Black</N amed>

Charts

101

</C olor> <F amily >A rial</F amily > <S ty le>Bold</S ty le> <S ize>9.75</S ize> </M ajor> <M inor> <C olor> <N amed>Black</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Regular</S ty le> <S ize>8.25</S ize> </M inor> </XA xis> <YA xis> <M ajor> <C olor> <N amed>Black</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Bold</S ty le> <S ize>9.75</S ize> </M ajor> <M inor> <C olor> <N amed>Black</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Regular</S ty le> <S ize>8.25</S ize> </M inor> <Title> <C olor> <N amed>Black</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Regular</S ty le> <S ize>8.25</S ize> </Title> </YA xis> <S eries> <C olor> <N amed>Red</N amed> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <N amed>Black</N amed> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <N amed>G reen</N amed> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <N amed>Red</N amed> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <N amed>Blue</N amed> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>62;169;0</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <N amed>Blue</N amed> </C olor>

102

TRKD API Developer's Guide

<DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>156;38;115</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <N amed>Red</N amed> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>255;120;0</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>25;108;229</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>25;108;229</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>60;117;28</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>60;117;28</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>230;176;18</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>230;176;18</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>0;186;193</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>0;186;193</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>255;178;127</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>255;178;127</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>100;79;190</RG B> </C olor>

Charts

103

<DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>100;79;190</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>209;36;33</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>209;36;33</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>38;87;135</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>38;87;135</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>94;176;176</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>94;176;176</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <Lev elLine> <C olor> <RG B>0;0;153</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>1</Width> </Lev elLine> <Lev elLine> <C olor> <RG B>120;120;120</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>1</Width> </Lev elLine> </S cheme> </chartRequest> </G etC hart_Request_1> </Body > </E nv elope>

8.6.1.2

Example 2
If you want to plot the actual prices instead of percentage change, then you will have to create two separate Y-Axis on the first subchart, since the prices of instruments can differ very much. Time Series Reference: d1 Symbol: MSFT.O Reference: d2 Symbol: .DJI Analyses

104

TRKD API Developer's Guide

Reference: a1 Type: Line Instrument: d1 Reference: a2 Type: Vol Instrument: d1 Reference: a3 Type: Line Instrument: d2 Chart X-Axis Subchart, Weight: 5 Y-Axis, Position: Right Analysis a1 Y-Axis, Position: Left Analysis a3 Subchart, Weight: 2 Y-Axis Analysis a2 Scheme Series, Color: Red (for TRIL.L price) Series, Color: Green (for .FTSE price) Series, Color: Blue (for TRIL.L vol) But as you can see the series sequence remains the same 'a1', 'a3', 'a2'. As a result, you will get the following chart:

The same request will look like this in XML: XML Sample Request - Example 2 Making Chart with MSFT.O and .DJI

Charts

105

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/C harts_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C harts_1/ G etC hart_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etC hart_Request_1 xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema" xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C harts_1"> <chartRequest ImageTy pe="P N G " Width="500" H eight="400" C ulture="en-U S "> <TimeS eries> <TimeS eriesRequest xmlns="http://metastock.com/imageserv er/financial"> <S y mbol>M S F T.O </S y mbol> <Reference>d1</Reference> </TimeS eriesRequest> <TimeS eriesRequest xmlns="http://metastock.com/imageserv er/financial"> <S y mbol>.DJI</S y mbol> <Reference>d2</Reference> </TimeS eriesRequest> </TimeS eries> <A naly ses> <A naly sis xmlns="http://metastock.com/imageserv er/analy sis"> <Reference>a1</Reference> <Line> <Instrument1> <Reference>d1</Reference> </Instrument1> </Line> </A naly sis> <A naly sis xmlns="http://metastock.com/imageserv er/analy sis"> <Reference>a2</Reference> <V ol> <Instrument1> <Reference>d1</Reference> </Instrument1> </V ol> </A naly sis> <A naly sis xmlns="http://metastock.com/imageserv er/analy sis"> <Reference>a3</Reference> <Line> <Instrument1> <Reference>d2</Reference> </Instrument1> </Line> </A naly sis> </A naly ses> <S tandardTemplate xmlns="http://metastock.com/imageserv er/financial"> <Title> <C aption> <V isible>true</V isible> <C ustomized>false</C ustomized> </C aption> <Range> <V isible>true</V isible> </Range> </Title> <Legend> <V isible>true</V isible> <Information>Long</Information> <Lay out>M ultiLine</Lay out> <P osition>O v erlaid</P osition> </Legend> <Instrument>S y mbol</Instrument> <Delimiter>% </Delimiter> <G ridLines>N one</G ridLines> <YA xisM arkers>N one</YA xisM arkers> <YA xisTitles>N one</YA xisTitles> <Brand>N one</Brand> <Interv al> <C ommonTy pe xmlns="http://metastock.com/applications/data">Day s</C ommonTy pe> <M ultiplier xmlns="http://metastock.com/applications/data">1</M ultiplier>

106

TRKD API Developer's Guide

</Interv al> <S how N onTradedP eriods>false</S how N onTradedP eriods> <S how H oliday s>false</S how H oliday s> <S how G aps>true</S how G aps> <XA xis> <V isible>true</V isible> <P osition>Bottom</P osition> <Range> <F ixed> <F irst>2009-04-17T00:00:00</F irst> <Last>2009-05-24T00:00:00</Last> </F ixed> </Range> </XA xis> <S ubchart> <Weight>5</Weight> <YA xis> <V isible>true</V isible> <P osition>Right</P osition> <Inv ert>false</Inv ert> <Logarithmic>false</Logarithmic> <Display > <M ode>A utomatic</M ode> </Display > <Range> <A utomatic /> </Range> <A naly sis> <Reference>a1</Reference> </A naly sis> </YA xis> <YA xis> <V isible>true</V isible> <P osition>Left</P osition> <Inv ert>false</Inv ert> <Logarithmic>false</Logarithmic> <Display > <M ode>A utomatic</M ode> </Display > <Range> <A utomatic /> </Range> <A naly sis> <Reference>a3</Reference> </A naly sis> </YA xis> </S ubchart> <S ubchart> <Weight>2</Weight> <YA xis> <V isible>true</V isible> <P osition>Right</P osition> <Inv ert>false</Inv ert> <Logarithmic>false</Logarithmic> <Display > <M ode>A utomatic</M ode> </Display > <Range> <A utomatic /> </Range> <A naly sis> <Reference>a2</Reference> </A naly sis> </YA xis> </S ubchart> </S tandardTemplate> <S cheme xmlns="http://metastock.com/imageserv er/financial"> <Background> <BackgroundM ode>S olid</BackgroundM ode> <S tartC olor> <N amed>White</N amed> </S tartC olor> <E ndC olor> <N amed>White</N amed> </E ndC olor> <H atchS ty le>LargeG rid</H atchS ty le> <G radientM ode>F orw ardDiagonal</G radientM ode>

Charts

107

<ImageM ode>C entered</ImageM ode> </Background> <Border> <C olor> <RG B>139;139;155</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>1</Width> </Border> <G ridLines> <C olor> <RG B>139;139;155</RG B> </C olor> <DashS ty le>Dot</DashS ty le> <Width>1</Width> </G ridLines> <Title> <C aption> <C olor> <N amed>Black</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Bold</S ty le> <S ize>12</S ize> </C aption> <Range> <C olor> <N amed>Black</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Regular</S ty le> <S ize>8.25</S ize> </Range> </Title> <Legend> <C olor> <N amed>Black</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Regular</S ty le> <S ize>8.25</S ize> </Legend> <XA xis> <M ajor> <C olor> <N amed>Black</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Bold</S ty le> <S ize>9.75</S ize> </M ajor> <M inor> <C olor> <N amed>Black</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Regular</S ty le> <S ize>8.25</S ize> </M inor> </XA xis> <YA xis> <M ajor> <C olor> <N amed>Black</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Bold</S ty le> <S ize>9.75</S ize> </M ajor> <M inor> <C olor> <N amed>Black</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Regular</S ty le> <S ize>8.25</S ize> </M inor>

108

TRKD API Developer's Guide

<Title> <C olor> <N amed>Black</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Regular</S ty le> <S ize>8.25</S ize> </Title> </YA xis> <S eries> <C olor> <N amed>Red</N amed> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <N amed>Black</N amed> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <N amed>G reen</N amed> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <N amed>Red</N amed> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <N amed>Blue</N amed> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>62;169;0</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <N amed>Blue</N amed> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>156;38;115</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <N amed>Red</N amed> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>255;120;0</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>25;108;229</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>25;108;229</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor>

Charts

109

<RG B>60;117;28</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>60;117;28</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>230;176;18</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>230;176;18</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>0;186;193</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>0;186;193</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>255;178;127</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>255;178;127</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>100;79;190</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>100;79;190</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>209;36;33</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>209;36;33</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>38;87;135</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>38;87;135</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor>

110

TRKD API Developer's Guide

<RG B>94;176;176</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>94;176;176</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <Lev elLine> <C olor> <RG B>0;0;153</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>1</Width> </Lev elLine> <Lev elLine> <C olor> <RG B>120;120;120</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>1</Width> </Lev elLine> </S cheme> </chartRequest> </G etC hart_Request_1> </Body > </E nv elope>

8.6.1.3

Example 3
Lets take Bollinger Bands analysis as another more complex example. To plot it along with instrument's OHLC and volume we need one data fetch and three analyses: Time Series Reference: d1 Symbol: MSFT.O Analyses Reference: a1 Type: OHLC Instrument: d1 Reference: a2 Type: Vol Instrument: d1 Reference: a3 Type: BBand Instrument: d1 Chart X-Axis Subchart, Weight: 5 Y-Axis Analysis a1 Analysis a3 Subchart, Weight: 2 Y-Axis Analysis a2 Scheme Series, Series, Series, Series, Series, Color: Red (for price) Color: Green (for BBand upper line) Color: Blue (for BBand centre line) Color: Orange (for BBand lower line) Color: Black (for vol)

Charts

111

Since the BBand analysis consists of three series, the resulting sequence will be: 'a1', 'a3'/1, 'a3'/2, 'a3'/3, 'a2. That means you will have to configure 5 styles of series styles in the corresponding order. The result of the request we created in this example will look like this:

The same request will look like this in XML: XML Sample Request - Example 3 Making Chart with MSFT.O and .DJI
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/C harts_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C harts_1/ G etC hart_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etC hart_Request_1 xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema" xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C harts_1"> <chartRequest ImageTy pe="P N G " Width="500" H eight="400" C ulture="en-U S "> <TimeS eries> <TimeS eriesRequest xmlns="http://metastock.com/imageserv er/financial"> <S y mbol>M S F T.O </S y mbol> <Reference>d1</Reference> </TimeS eriesRequest> </TimeS eries> <A naly ses> <A naly sis xmlns="http://metastock.com/imageserv er/analy sis"> <Reference>a1</Reference> <O H LC >

112

TRKD API Developer's Guide

<Instrument1> <Reference>d1</Reference> </Instrument1> </O H LC > </A naly sis> <A naly sis xmlns="http://metastock.com/imageserv er/analy sis"> <Reference>a2</Reference> <V ol> <Instrument1> <Reference>d1</Reference> </Instrument1> </V ol> </A naly sis> <A naly sis xmlns="http://metastock.com/imageserv er/analy sis"> <Reference>a3</Reference> <BBand> <Instrument1> <Reference>d1</Reference> </Instrument1> </BBand> </A naly sis> </A naly ses> <S tandardTemplate xmlns="http://metastock.com/imageserv er/financial"> <Title> <C aption> <V isible>true</V isible> <C ustomized>false</C ustomized> </C aption> <Range> <V isible>true</V isible> </Range> </Title> <Legend> <V isible>true</V isible> <Information>Long</Information> <Lay out>M ultiLine</Lay out> <P osition>O v erlaid</P osition> </Legend> <Instrument>S y mbol</Instrument> <Delimiter>% </Delimiter> <G ridLines>N one</G ridLines> <YA xisM arkers>N one</YA xisM arkers> <YA xisTitles>N one</YA xisTitles> <Brand>N one</Brand> <Interv al> <C ommonTy pe xmlns="http://metastock.com/applications/data">Day s</C ommonTy pe> <M ultiplier xmlns="http://metastock.com/applications/data">1</M ultiplier> </Interv al> <S how N onTradedP eriods>false</S how N onTradedP eriods> <S how H oliday s>false</S how H oliday s> <S how G aps>true</S how G aps> <XA xis> <V isible>true</V isible> <P osition>Bottom</P osition> <Range> <F ixed> <F irst>2009-04-17T00:00:00</F irst> <Last>2009-05-24T00:00:00</Last> </F ixed> </Range> </XA xis> <S ubchart> <Weight>5</Weight> <YA xis> <V isible>true</V isible> <P osition>Right</P osition> <Inv ert>false</Inv ert> <Logarithmic>false</Logarithmic> <Display > <M ode>A utomatic</M ode> </Display > <Range> <A utomatic /> </Range> <A naly sis> <Reference>a1</Reference> </A naly sis>

Charts

113

<A naly sis> <Reference>a3</Reference> </A naly sis> </YA xis> </S ubchart> <S ubchart> <Weight>2</Weight> <YA xis> <V isible>true</V isible> <P osition>Right</P osition> <Inv ert>false</Inv ert> <Logarithmic>false</Logarithmic> <Display > <M ode>A utomatic</M ode> </Display > <Range> <A utomatic /> </Range> <A naly sis> <Reference>a2</Reference> </A naly sis> </YA xis> </S ubchart> </S tandardTemplate> <S cheme xmlns="http://metastock.com/imageserv er/financial"> <Background> <BackgroundM ode>S olid</BackgroundM ode> <S tartC olor> <N amed>White</N amed> </S tartC olor> <E ndC olor> <N amed>White</N amed> </E ndC olor> <H atchS ty le>LargeG rid</H atchS ty le> <G radientM ode>F orw ardDiagonal</G radientM ode> <ImageM ode>C entered</ImageM ode> </Background> <Border> <C olor> <RG B>139;139;155</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>1</Width> </Border> <G ridLines> <C olor> <RG B>139;139;155</RG B> </C olor> <DashS ty le>Dot</DashS ty le> <Width>1</Width> </G ridLines> <Title> <C aption> <C olor> <N amed>Black</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Bold</S ty le> <S ize>12</S ize> </C aption> <Range> <C olor> <N amed>Black</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Regular</S ty le> <S ize>8.25</S ize> </Range> </Title> <Legend> <C olor> <N amed>Black</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Regular</S ty le> <S ize>8.25</S ize> </Legend>

114

TRKD API Developer's Guide

<XA xis> <M ajor> <C olor> <N amed>Black</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Bold</S ty le> <S ize>9.75</S ize> </M ajor> <M inor> <C olor> <N amed>Black</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Regular</S ty le> <S ize>8.25</S ize> </M inor> </XA xis> <YA xis> <M ajor> <C olor> <N amed>Black</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Bold</S ty le> <S ize>9.75</S ize> </M ajor> <M inor> <C olor> <N amed>Black</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Regular</S ty le> <S ize>8.25</S ize> </M inor> <Title> <C olor> <N amed>Black</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Regular</S ty le> <S ize>8.25</S ize> </Title> </YA xis> <S eries> <C olor> <N amed>Red</N amed> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <N amed>Black</N amed> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <N amed>G reen</N amed> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <N amed>Red</N amed> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <N amed>Blue</N amed> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>62;169;0</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries>

Charts

115

<S eries> <C olor> <N amed>O range</N amed> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>156;38;115</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <N amed>Black</N amed> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>255;120;0</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>25;108;229</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>25;108;229</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>60;117;28</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>60;117;28</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>230;176;18</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>230;176;18</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>0;186;193</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>0;186;193</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>255;178;127</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>255;178;127</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries>

116

TRKD API Developer's Guide

<S eries> <C olor> <RG B>100;79;190</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>100;79;190</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>209;36;33</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>209;36;33</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>38;87;135</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>38;87;135</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>94;176;176</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>94;176;176</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <Lev elLine> <C olor> <RG B>0;0;153</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>1</Width> </Lev elLine> <Lev elLine> <C olor> <RG B>120;120;120</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>1</Width> </Lev elLine> </S cheme> </chartRequest> </G etC hart_Request_1> </Body > </E nv elope>

8.6.1.4

Creating Chart For The Past 10 Years

The Charts web service is configured to return only 1000 data points. If you need to create a chart for the past 10 years you will need to specify an exact data range: XML Sample Request

Charts

117

<TimeS eries> < T imeSer iesRequest xmlns="http://metastock.com/imageserv er/financial"> < Symbol >9501.T</S y mbol> < Refer ence >d1</Reference> <RequestRange> < Star tDate xmlns="http://metastock.com/applications/data">2000-09-16T00:00:00</S tartDate> < EndDate xmlns="http://metastock.com/applications/data">2010-09-16T00:00:00</E ndDate> </RequestRange> </TimeS eriesRequest> < T imeSer iesRequest xmlns="http://metastock.com/imageserv er/financial"> <Symbol>V O D.L</S y mbol> <Refer ence>d2</Reference> </TimeS eriesRequest> </TimeS eries>

rather than: XML Sample Request

<XA xis> <V isible>true</V isible> <P osition>Bottom</P osition> <Range> <Last> <Ty pe> Y ear </Ty pe> <C ount> 1 0 </C ount> <Display >A ll</Display > </Last> </Range> </XA xis>

8.6.2

Customizing Chart Appearance

There are two main ways to ensure that charts match your companys corporate brand identity, which will be described one by one later in this section: 1. Using the colour that data points are plotted in to match a colour used in your brand identity, as illustrated in case 1 below. 2. Using a background gradient to match a colour used in your brand identity, as illustrated in case 2 below You can also choose the font used for text on charts.

8.6.2.1

Customizing Colour for Data Series

118

TRKD API Developer's Guide

This can be implemented by configuring the colour for the appropriate data series as described below. To understand how data series are related to the lines on the chart please go to section Making Chart Request earlier in this chapter. Note: The chart above shows daily statistics for IBEX 35 INDEX. The same request will look like this in XML: XML Sample Request Customizing Colour for Data Series
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/C harts_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C harts_1/ G etC hart_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etC hart_Request_1 xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema" xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C harts_1"> <chartRequest ImageTy pe="P N G " Width="600" H eight="350" Title="IBE X 35" C ulture="es-E S "> <TimeS eries> <TimeS eriesRequest xmlns="http://metastock.com/imageserv er/financial"> <S y mbol>.IBE X</S y mbol> <Reference>d1</Reference> </TimeS eriesRequest> </TimeS eries> <A naly ses> <A naly sis xmlns="http://metastock.com/imageserv er/analy sis"> <Reference>a1</Reference> <Line> <Instrument1> <Reference>d1</Reference> </Instrument1> </Line> </A naly sis> <A naly sis xmlns="http://metastock.com/imageserv er/analy sis"> <Reference>a2</Reference>

Charts

119

<V ol> <Instrument1> <Reference>d1</Reference> </Instrument1> </V ol> </A naly sis> </A naly ses> <S tandardTemplate xmlns="http://metastock.com/imageserv er/financial"> <Title> <C aption> <V isible>false</V isible> <C ustomized>false</C ustomized> </C aption> <Range> <V isible>false</V isible> </Range> </Title> <Legend> <V isible>false</V isible> <Information>Long</Information> <Lay out>M ultiLine</Lay out> <P osition>O v erlaid</P osition> </Legend> <Instrument>S y mbol</Instrument> <Delimiter>% </Delimiter> <G ridLines>Both</G ridLines> <YA xisM arkers>N one</YA xisM arkers> <YA xisTitles>U nit</YA xisTitles> <Brand>N one</Brand> <Interv al> <C ommonTy pe xmlns="http://metastock.com/applications/data">Day s</C ommonTy pe> <M ultiplier xmlns="http://metastock.com/applications/data">1</M ultiplier> </Interv al> <S how N onTradedP eriods>false</S how N onTradedP eriods> <S how H oliday s>false</S how H oliday s> <S how G aps>true</S how G aps> <XA xis> <V isible>true</V isible> <P osition>Bottom</P osition> <Range> <F ixed> <F irst>2008-07-27T00:00:00</F irst> <Last>2009-07-27T00:00:00</Last> </F ixed> </Range> </XA xis> <S ubchart> <Weight>5</Weight> <YA xis> <V isible>true</V isible> <P osition>Right</P osition> <Inv ert>false</Inv ert> <Logarithmic>false</Logarithmic> <Display > <M ode>A utomatic</M ode> </Display > <Range> <F ixed> <F irst>6500</F irst> <Last>12500</Last> </F ixed> </Range> <A naly sis> <Reference>a1</Reference> </A naly sis> </YA xis> <YA xis> <V isible>true</V isible> <P osition>Left</P osition> <Inv ert>false</Inv ert> <Logarithmic>false</Logarithmic> <Display > <M ode>A utomatic</M ode> </Display > <Range> <F ixed> <F irst>6500</F irst>

120

TRKD API Developer's Guide

<Last>12500</Last> </F ixed> </Range> </YA xis> </S ubchart> <S ubchart> <Weight>2</Weight> <YA xis> <V isible>true</V isible> <P osition>Right</P osition> <Inv ert>false</Inv ert> <Logarithmic>false</Logarithmic> <Display > <M ode>A utomatic</M ode> </Display > <Range> <F ixed> <F irst>0</F irst> <Last>800000</Last> </F ixed> </Range> <A naly sis> <Reference>a2</Reference> </A naly sis> </YA xis> <YA xis> <V isible>true</V isible> <P osition>Left</P osition> <Inv ert>false</Inv ert> <Logarithmic>false</Logarithmic> <Display > <M ode>A utomatic</M ode> </Display > <Range> <F ixed> <F irst>0</F irst> <Last>800000</Last> </F ixed> </Range> </YA xis> </S ubchart> </S tandardTemplate> <S cheme xmlns="http://metastock.com/imageserv er/financial"> <Background> <BackgroundM ode>S olid</BackgroundM ode> <S tartC olor> <N amed>White</N amed> </S tartC olor> <E ndC olor> <N amed>White</N amed> </E ndC olor> <H atchS ty le>LargeG rid</H atchS ty le> <G radientM ode>F orw ardDiagonal</G radientM ode> <ImageM ode>C entered</ImageM ode> </Background> <Border> <C olor> <N amed>Black</N amed> </C olor> <DashS ty le>S olid</DashS ty le> <Width>1</Width> </Border> <G ridLines> <C olor> <RG B>204;204;204</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>1</Width> </G ridLines> <Title> <C aption> <C olor> <N amed>Black</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Bold</S ty le> <S ize>12</S ize>

Charts

121

</C aption> <Range> <C olor> <N amed>Black</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Regular</S ty le> <S ize>8.25</S ize> </Range> </Title> <Legend> <C olor> <N amed>Black</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Regular</S ty le> <S ize>8.25</S ize> </Legend> <XA xis> <M ajor> <C olor> <N amed>Black</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Regular</S ty le> <S ize>8.25</S ize> </M ajor> <M inor> <C olor> <N amed>Black</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Regular</S ty le> <S ize>8.25</S ize> </M inor> </XA xis> <YA xis> <M ajor> <C olor> <RG B>68;66;67</RG B> </C olor> <F amily >A rial</F amily > <S ty le>Regular</S ty le> <S ize>8.25</S ize> </M ajor> <M inor> <C olor> <RG B>68;66;67</RG B> </C olor> <F amily >A rial</F amily > <S ty le>Regular</S ty le> <S ize>8.25</S ize> </M inor> <Title> <C olor> <RG B>68;66;67</RG B> </C olor> <F amily >A rial</F amily > <S ty le>Regular</S ty le> <S ize>8.25</S ize> </Title> </YA xis> <S eries> <C olor> <RG B>153;0;0</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>2</Width> <F illC olor> <N amed>Black</N amed> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>153;0;0</RG B> </C olor>

122

TRKD API Developer's Guide

<DashS ty le>S olid</DashS ty le> <Width>2</Width> <F illC olor> <N amed>Red</N amed> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <N amed>Black</N amed> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>62;169;0</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <N amed>Black</N amed> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>156;38;115</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>255;120;0</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>255;120;0</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>25;108;229</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>25;108;229</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>60;117;28</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>60;117;28</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>230;176;18</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>230;176;18</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>0;186;193</RG B> </C olor>

Charts

123

<DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>0;186;193</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>255;178;127</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>255;178;127</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>100;79;190</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>100;79;190</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>209;36;33</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>209;36;33</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>38;87;135</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>38;87;135</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>94;176;176</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>94;176;176</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <Lev elLine> <C olor> <RG B>0;0;153</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>1</Width> </Lev elLine> <Lev elLine> <C olor> <RG B>120;120;120</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>1</Width> </Lev elLine> </S cheme>

124

TRKD API Developer's Guide

</chartRequest> </G etC hart_Request_1> </Body > </E nv elope>

8.6.2.1.1 Colour Picker This section describes the colour picker tool available in Request builder. It can be used for changing colours used for drawing charts. 8.6.2.1.1.1 RGB Mode You can either choose a colour from the palette or enter Red, Green, Blue component values manually to get the exact color you need:

8.6.2.1.1.2 ARGB Mode You can either choose a color from the palette or enter Red, Green, Blue values manually to get the exact colour you need. Additionally, you can set the value for Alpha level transparency:

Charts

125

8.6.2.1.1.3 Named Mode Use this mode to select commonly used named colors - for example, Red, Cyan, Blue, etc.

126

TRKD API Developer's Guide

8.6.2.2

Customizing Background Colour

Note: The chart above shows daily statistics for IBEX 35 INDEX. This can be implemented by configuring the background as described below: 1. 2. 3. 4. Set Set Set Set Background mode to Gradient 2 Gradient Mode to Forward Diagonal Start Color to White End Color to RGB 153;0;0

You should get the following form:

Other gradient modes available: Horizontal Vertical Forward Diagonal Backward Diagonal Horizontal Cycle Vertical Cycle Forward Diagonal Cycle Backward Diagonal Cycle The request for the chart shown above will be the following in XML:

Charts

127

XML Sample Request - Customizing Background Colour

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/C harts_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C harts_1/ G etC hart_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <<G etC hart_Request_1 xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema" xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C harts_1"> <chartRequest ImageTy pe="P N G " Width="600" H eight="350" Title="IBE X 35" C ulture="es-E S "> <TimeS eries> <TimeS eriesRequest xmlns="http://metastock.com/imageserv er/financial"> <S y mbol>.IBE X</S y mbol> <Reference>d1</Reference> </TimeS eriesRequest> </TimeS eries> <A naly ses> <A naly sis xmlns="http://metastock.com/imageserv er/analy sis"> <Reference>a1</Reference> <Line> <Instrument1> <Reference>d1</Reference> </Instrument1> </Line> </A naly sis> <A naly sis xmlns="http://metastock.com/imageserv er/analy sis"> <Reference>a2</Reference> <V ol> <Instrument1> <Reference>d1</Reference> </Instrument1> </V ol> </A naly sis> </A naly ses> <S tandardTemplate xmlns="http://metastock.com/imageserv er/financial"> <Title> <C aption> <V isible>false</V isible> <C ustomized>false</C ustomized> </C aption> <Range> <V isible>false</V isible> </Range> </Title> <Legend> <V isible>false</V isible> <Information>Long</Information> <Lay out>M ultiLine</Lay out> <P osition>O v erlaid</P osition> </Legend> <Instrument>S y mbol</Instrument> <Delimiter>% </Delimiter> <G ridLines>Both</G ridLines> <YA xisM arkers>N one</YA xisM arkers> <YA xisTitles>U nit</YA xisTitles> <Brand>N one</Brand> <Interv al> <C ommonTy pe xmlns="http://metastock.com/applications/data">Day s</C ommonTy pe> <M ultiplier xmlns="http://metastock.com/applications/data">1</M ultiplier> </Interv al> <S how N onTradedP eriods>false</S how N onTradedP eriods> <S how H oliday s>false</S how H oliday s> <S how G aps>true</S how G aps> <XA xis> <V isible>true</V isible> <P osition>Bottom</P osition> <Range>

128

TRKD API Developer's Guide

<F ixed> <F irst>2008-07-27T00:00:00</F irst> <Last>2009-07-27T00:00:00</Last> </F ixed> </Range> </XA xis> <S ubchart> <Weight>5</Weight> <YA xis> <V isible>true</V isible> <P osition>Right</P osition> <Inv ert>false</Inv ert> <Logarithmic>false</Logarithmic> <Display > <M ode>A utomatic</M ode> </Display > <Range> <F ixed> <F irst>6500</F irst> <Last>12500</Last> </F ixed> </Range> <A naly sis> <Reference>a1</Reference> </A naly sis> </YA xis> <YA xis> <V isible>true</V isible> <P osition>Left</P osition> <Inv ert>false</Inv ert> <Logarithmic>false</Logarithmic> <Display > <M ode>A utomatic</M ode> </Display > <Range> <F ixed> <F irst>6500</F irst> <Last>12500</Last> </F ixed> </Range> </YA xis> </S ubchart> <S ubchart> <Weight>2</Weight> <YA xis> <V isible>true</V isible> <P osition>Right</P osition> <Inv ert>false</Inv ert> <Logarithmic>false</Logarithmic> <Display > <M ode>A utomatic</M ode> </Display > <Range> <F ixed> <F irst>0</F irst> <Last>800000</Last> </F ixed> </Range> <A naly sis> <Reference>a2</Reference> </A naly sis> </YA xis> <YA xis> <V isible>true</V isible> <P osition>Left</P osition> <Inv ert>false</Inv ert> <Logarithmic>false</Logarithmic> <Display > <M ode>A utomatic</M ode> </Display > <Range> <F ixed> <F irst>0</F irst> <Last>800000</Last> </F ixed> </Range> </YA xis>

Charts

129

</S ubchart> </S tandardTemplate> <S cheme xmlns="http://metastock.com/imageserv er/financial"> <Background> <BackgroundM ode>G radient</BackgroundM ode> <S tartC olor> <N amed>White</N amed> </S tartC olor> <E ndC olor> <RG B>153;0;0</RG B> </E ndC olor> <H atchS ty le>LargeG rid</H atchS ty le> <G radientM ode>F orw ardDiagonal</G radientM ode> <ImageM ode>C entered</ImageM ode> </Background> <Border> <C olor> <N amed>Black</N amed> </C olor> <DashS ty le>S olid</DashS ty le> <Width>1</Width> </Border> <G ridLines> <C olor> <N amed>Black</N amed> </C olor> <DashS ty le>S olid</DashS ty le> <Width>1</Width> </G ridLines> <Title> <C aption> <C olor> <N amed>Black</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Bold</S ty le> <S ize>12</S ize> </C aption> <Range> <C olor> <N amed>Black</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Regular</S ty le> <S ize>8.25</S ize> </Range> </Title> <Legend> <C olor> <N amed>Black</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Regular</S ty le> <S ize>8.25</S ize> </Legend> <XA xis> <M ajor> <C olor> <N amed>Black</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Regular</S ty le> <S ize>8.25</S ize> </M ajor> <M inor> <C olor> <N amed>Black</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Regular</S ty le> <S ize>8.25</S ize> </M inor> </XA xis> <YA xis> <M ajor> <C olor> <N amed>Black</N amed>

130

TRKD API Developer's Guide

</C olor> <F amily >A rial</F amily > <S ty le>Regular</S ty le> <S ize>8.25</S ize> </M ajor> <M inor> <C olor> <N amed>Black</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Regular</S ty le> <S ize>8.25</S ize> </M inor> <Title> <C olor> <N amed>Black</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Regular</S ty le> <S ize>8.25</S ize> </Title> </YA xis> <S eries> <C olor> <N amed>Black</N amed> </C olor> <DashS ty le>S olid</DashS ty le> <Width>2</Width> <F illC olor> <N amed>Black</N amed> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <N amed>Black</N amed> </C olor> <DashS ty le>S olid</DashS ty le> <Width>2</Width> <F illC olor> <N amed>Red</N amed> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <N amed>Black</N amed> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>62;169;0</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <N amed>Black</N amed> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>156;38;115</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>255;120;0</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>255;120;0</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries>

Charts

131

<S eries> <C olor> <RG B>25;108;229</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>25;108;229</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>60;117;28</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>60;117;28</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>230;176;18</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>230;176;18</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>0;186;193</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>0;186;193</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>255;178;127</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>255;178;127</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>100;79;190</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>100;79;190</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>209;36;33</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>209;36;33</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries>

132

TRKD API Developer's Guide

<S eries> <C olor> <RG B>38;87;135</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>38;87;135</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>94;176;176</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>94;176;176</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <Lev elLine> <C olor> <RG B>0;0;153</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>1</Width> </Lev elLine> <Lev elLine> <C olor> <RG B>120;120;120</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>1</Width> </Lev elLine> </S cheme> </chartRequest> </G etC hart_Request_1> </Body > </E nv elope>

8.6.2.3

Other Formatting Options

This section provides information about other formatting options available in Request Builder for changing the colour of lines, font, text and fill.

8.6.2.3.1 Fill Format This control configures the fill pattern and color.

Other fill pattern examples: 5 percent

Charts

133

50 percent 90 percent Vertical Large Grid Forward Diagonal Sphere Wave Large Checker Board 8.6.2.3.2 Text Format Using this control you can set the text color and configure font (see section Font Format later):

8.6.2.3.3 Font Format This control allows specifying font family, size and applying additional formatting, such as Bold, Italic, Underline or Strikeout:

8.6.2.3.4 Line Format Use this control to select line color, style (Solid, Dash, Dash Dot, Dash Dot Dot, Dot) and thickness (in pixels):

8.6.3

More Sample Requests

This section provides two more samples of chart requests.

8.6.3.1

Case 1
The chart below shows Hourly statistics for FTSE 100 INDEX.

134

TRKD API Developer's Guide

To get this chart, you need to pass the following request: XML Sample Request - Making Request for Hourly FTSE 100 Index Chart
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/C harts_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C harts_1/ G etC hart_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etC hart_Request_1 xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema" xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C harts_1"> <chartRequest ImageTy pe="P N G " Width="700" H eight="400" C ulture="en-G B"> <TimeS eries> <TimeS eriesRequest xmlns="http://metastock.com/imageserv er/financial"> <S y mbol>.F TS E </S y mbol> <Reference>d1</Reference> </TimeS eriesRequest> </TimeS eries> <A naly ses> <A naly sis xmlns="http://metastock.com/imageserv er/analy sis"> <Reference>a1</Reference> <Line> <Instrument1> <Reference>d1</Reference> </Instrument1> <S eries1> <N ame>F illedLine</N ame> </S eries1> </Line> </A naly sis> <A naly sis xmlns="http://metastock.com/imageserv er/analy sis"> <Reference>a2</Reference> <V ol> <Instrument1> <Reference>d1</Reference> </Instrument1> </V ol> </A naly sis> </A naly ses> <S tandardTemplate xmlns="http://metastock.com/imageserv er/financial"> <Title> <C aption> <V isible>true</V isible> <C ustomized>false</C ustomized> </C aption> <Range> <V isible>false</V isible> </Range> </Title> <Legend> <V isible>true</V isible> <Information>Long</Information> <Lay out>M ultiLine</Lay out>

Charts

135

<P osition>O v erlaid</P osition> </Legend> <Instrument>N ame</Instrument> <Delimiter>% </Delimiter> <G ridLines>H orizontal</G ridLines> <YA xisM arkers>N one</YA xisM arkers> <YA xisTitles>A ll</YA xisTitles> <Brand>N one</Brand> <Interv al> <C ommonTy pe xmlns="http://metastock.com/applications/data">H ours</C ommonTy pe> <M ultiplier xmlns="http://metastock.com/applications/data">1</M ultiplier> </Interv al> <S how N onTradedP eriods>false</S how N onTradedP eriods> <S how H oliday s>false</S how H oliday s> <S how G aps>true</S how G aps> <XA xis> <V isible>true</V isible> <P osition>Bottom</P osition> <Range> <F ixed> <F irst>2009-05-05T00:00:00</F irst> <Last>2009-05-12T00:00:00</Last> </F ixed> </Range> </XA xis> <S ubchart> <Weight>5</Weight> <YA xis> <V isible>true</V isible> <P osition>Right</P osition> <Inv ert>false</Inv ert> <Logarithmic>false</Logarithmic> <Display > <M ode>A utomatic</M ode> </Display > <Range> <A utomatic /> </Range> <A naly sis> <Reference>a1</Reference> <Lev elLine>4462</Lev elLine> </A naly sis> </YA xis> </S ubchart> <S ubchart> <Weight>2</Weight> <YA xis> <V isible>true</V isible> <P osition>Right</P osition> <Inv ert>false</Inv ert> <Logarithmic>false</Logarithmic> <Display > <M ode>A utomatic</M ode> </Display > <Range> <F ixed> <F irst>0</F irst> <Last>1000000000000</Last> </F ixed> </Range> <A naly sis> <Reference>a2</Reference> <Lev elLine>2000000000000</Lev elLine> <Lev elLine>125000000000</Lev elLine> <Lev elLine>250000000000</Lev elLine> <Lev elLine>375000000000</Lev elLine> </A naly sis> </YA xis> </S ubchart> </S tandardTemplate> <S cheme xmlns="http://metastock.com/imageserv er/financial"> <Background> <BackgroundM ode>G radient</BackgroundM ode> <S tartC olor> <RG B>0;0;100</RG B> </S tartC olor> <E ndC olor>

136

TRKD API Developer's Guide

<RG B>0;0;50</RG B> </E ndC olor> <H atchS ty le>LargeG rid</H atchS ty le> <G radientM ode>F orw ardDiagonal</G radientM ode> <ImageM ode>C entered</ImageM ode> </Background> <Border> <C olor> <RG B>139;139;155</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>1</Width> </Border> <G ridLines> <C olor> <RG B>139;139;155</RG B> </C olor> <DashS ty le>Dot</DashS ty le> <Width>1</Width> </G ridLines> <Title> <C aption> <C olor> <N amed>O range</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Bold</S ty le> <S ize>12</S ize> </C aption> <Range> <C olor> <N amed>WhiteS moke</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Regular</S ty le> <S ize>8.25</S ize> </Range> </Title> <Legend> <C olor> <N amed>WhiteS moke</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Regular</S ty le> <S ize>8.25</S ize> </Legend> <XA xis> <M ajor> <C olor> <N amed>WhiteS moke</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Bold</S ty le> <S ize>9.75</S ize> </M ajor> <M inor> <C olor> <N amed>WhiteS moke</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Regular</S ty le> <S ize>8.25</S ize> </M inor> </XA xis> <YA xis> <M ajor> <C olor> <N amed>WhiteS moke</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Bold</S ty le> <S ize>9.75</S ize> </M ajor> <M inor> <C olor> <N amed>WhiteS moke</N amed> </C olor>

Charts

137

<F amily >A rial</F amily > <S ty le>Regular</S ty le> <S ize>8.25</S ize> </M inor> <Title> <C olor> <N amed>WhiteS moke</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Regular</S ty le> <S ize>8.25</S ize> </Title> </YA xis> <S eries> <C olor> <RG B>255;153;0</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>2</Width> <F illC olor> <RG B>255;153;0</RG B> </F illC olor> <F illS ty le>P ercent90</F illS ty le> </S eries> <S eries> <C olor> <N amed>O range</N amed> </C olor> <DashS ty le>S olid</DashS ty le> <Width>5</Width> <F illC olor> <N amed>Red</N amed> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>62;169;0</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>62;169;0</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>156;38;115</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>156;38;115</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>255;120;0</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>255;120;0</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>25;108;229</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>25;108;229</RG B> </F illC olor>

138

TRKD API Developer's Guide

<F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>60;117;28</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>60;117;28</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>230;176;18</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>230;176;18</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>0;186;193</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>0;186;193</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>255;178;127</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>255;178;127</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>100;79;190</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>100;79;190</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>209;36;33</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>209;36;33</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>38;87;135</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>38;87;135</RG B> </F illC olor>

Charts

139

<F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>94;176;176</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>94;176;176</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <Lev elLine> <C olor> <RG B>255;102;0</RG B> </C olor> <DashS ty le>Dash</DashS ty le> <Width>2</Width> </Lev elLine> <Lev elLine> <C olor> <N amed>G ray </N amed> </C olor> <DashS ty le>Dash</DashS ty le> <Width>1</Width> </Lev elLine> <Lev elLine> <C olor> <N amed>G ray </N amed> </C olor> <DashS ty le>Dash</DashS ty le> <Width>1</Width> </Lev elLine> <Lev elLine> <C olor> <N amed>G ray </N amed> </C olor> <DashS ty le>Dash</DashS ty le> <Width>1</Width> </Lev elLine> <Lev elLine> <C olor> <N amed>G ray </N amed> </C olor> <DashS ty le>Dash</DashS ty le> <Width>1</Width> </Lev elLine> </S cheme> </chartRequest> </G etC hart_Request_1> </Body > </E nv elope>

8.6.3.2

Case 2
The chart below shows daily fluctuations (in %) of HSBC HOLDINGS with HANG SENG INDEX against their respective values at the beginning of the requested period.

140

TRKD API Developer's Guide

To request such a chart, you must make the following request: XML Sample Request - Making Request for Daily 0005.HK
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/C harts_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C harts_1/ G etC hart_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etC hart_Request_1 xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema" xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C harts_1"> <chartRequest ImageTy pe="P N G " Width="700" H eight="400" C ulture="en-G B"> <TimeS eries> <TimeS eriesRequest xmlns="http://metastock.com/imageserv er/financial"> <S y mbol>.F TS E </S y mbol> <Reference>d1</Reference> </TimeS eriesRequest> </TimeS eries> <A naly ses> <A naly sis xmlns="http://metastock.com/imageserv er/analy sis"> <Reference>a1</Reference> <Line> <Instrument1> <Reference>d1</Reference> </Instrument1> <S eries1> <N ame>F illedLine</N ame> </S eries1> </Line> </A naly sis>

Charts

141

<A naly sis xmlns="http://metastock.com/imageserv er/analy sis"> <Reference>a2</Reference> <V ol> <Instrument1> <Reference>d1</Reference> </Instrument1> </V ol> </A naly sis> </A naly ses> <S tandardTemplate xmlns="http://metastock.com/imageserv er/financial"> <Title> <C aption> <V isible>true</V isible> <C ustomized>false</C ustomized> </C aption> <Range> <V isible>false</V isible> </Range> </Title> <Legend> <V isible>true</V isible> <Information>Long</Information> <Lay out>M ultiLine</Lay out> <P osition>O v erlaid</P osition> </Legend> <Instrument>N ame</Instrument> <Delimiter>% </Delimiter> <G ridLines>H orizontal</G ridLines> <YA xisM arkers>N one</YA xisM arkers> <YA xisTitles>A ll</YA xisTitles> <Brand>N one</Brand> <Interv al> <C ommonTy pe xmlns="http://metastock.com/applications/data">H ours</C ommonTy pe> <M ultiplier xmlns="http://metastock.com/applications/data">1</M ultiplier> </Interv al> <S how N onTradedP eriods>false</S how N onTradedP eriods> <S how H oliday s>false</S how H oliday s> <S how G aps>true</S how G aps> <XA xis> <V isible>true</V isible> <P osition>Bottom</P osition> <Range> <F ixed> <F irst>2009-05-05T00:00:00</F irst> <Last>2009-05-12T00:00:00</Last> </F ixed> </Range> </XA xis> <S ubchart> <Weight>5</Weight> <YA xis> <V isible>true</V isible> <P osition>Right</P osition> <Inv ert>false</Inv ert> <Logarithmic>false</Logarithmic> <Display > <M ode>A utomatic</M ode> </Display > <Range> <A utomatic /> </Range> <A naly sis> <Reference>a1</Reference> <Lev elLine>4462</Lev elLine> </A naly sis> </YA xis> </S ubchart> <S ubchart> <Weight>2</Weight> <YA xis> <V isible>true</V isible> <P osition>Right</P osition> <Inv ert>false</Inv ert> <Logarithmic>false</Logarithmic> <Display > <M ode>A utomatic</M ode> </Display >

142

TRKD API Developer's Guide

<Range> <F ixed> <F irst>0</F irst> <Last>1000000000000</Last> </F ixed> </Range> <A naly sis> <Reference>a2</Reference> <Lev elLine>2000000000000</Lev elLine> <Lev elLine>125000000000</Lev elLine> <Lev elLine>250000000000</Lev elLine> <Lev elLine>375000000000</Lev elLine> </A naly sis> </YA xis> </S ubchart> </S tandardTemplate> <S cheme xmlns="http://metastock.com/imageserv er/financial"> <Background> <BackgroundM ode>G radient</BackgroundM ode> <S tartC olor> <RG B>0;0;100</RG B> </S tartC olor> <E ndC olor> <RG B>0;0;50</RG B> </E ndC olor> <H atchS ty le>LargeG rid</H atchS ty le> <G radientM ode>F orw ardDiagonal</G radientM ode> <ImageM ode>C entered</ImageM ode> </Background> <Border> <C olor> <RG B>139;139;155</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>1</Width> </Border> <G ridLines> <C olor> <RG B>139;139;155</RG B> </C olor> <DashS ty le>Dot</DashS ty le> <Width>1</Width> </G ridLines> <Title> <C aption> <C olor> <N amed>O range</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Bold</S ty le> <S ize>12</S ize> </C aption> <Range> <C olor> <N amed>WhiteS moke</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Regular</S ty le> <S ize>8.25</S ize> </Range> </Title> <Legend> <C olor> <N amed>WhiteS moke</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Regular</S ty le> <S ize>8.25</S ize> </Legend> <XA xis> <M ajor> <C olor> <N amed>WhiteS moke</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Bold</S ty le> <S ize>9.75</S ize>

Charts

143

</M ajor> <M inor> <C olor> <N amed>WhiteS moke</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Regular</S ty le> <S ize>8.25</S ize> </M inor> </XA xis> <YA xis> <M ajor> <C olor> <N amed>WhiteS moke</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Bold</S ty le> <S ize>9.75</S ize> </M ajor> <M inor> <C olor> <N amed>WhiteS moke</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Regular</S ty le> <S ize>8.25</S ize> </M inor> <Title> <C olor> <N amed>WhiteS moke</N amed> </C olor> <F amily >A rial</F amily > <S ty le>Regular</S ty le> <S ize>8.25</S ize> </Title> </YA xis> <S eries> <C olor> <RG B>255;153;0</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>2</Width> <F illC olor> <RG B>255;153;0</RG B> </F illC olor> <F illS ty le>P ercent90</F illS ty le> </S eries> <S eries> <C olor> <N amed>O range</N amed> </C olor> <DashS ty le>S olid</DashS ty le> <Width>5</Width> <F illC olor> <N amed>Red</N amed> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>62;169;0</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>62;169;0</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>156;38;115</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>156;38;115</RG B>

144

TRKD API Developer's Guide

</F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>255;120;0</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>255;120;0</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>25;108;229</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>25;108;229</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>60;117;28</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>60;117;28</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>230;176;18</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>230;176;18</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>0;186;193</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>0;186;193</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>255;178;127</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>255;178;127</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>100;79;190</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>100;79;190</RG B>

Charts

145

</F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>209;36;33</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>209;36;33</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>38;87;135</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>38;87;135</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <S eries> <C olor> <RG B>94;176;176</RG B> </C olor> <DashS ty le>S olid</DashS ty le> <Width>0</Width> <F illC olor> <RG B>94;176;176</RG B> </F illC olor> <F illS ty le>P ercent20</F illS ty le> </S eries> <Lev elLine> <C olor> <RG B>255;102;0</RG B> </C olor> <DashS ty le>Dash</DashS ty le> <Width>2</Width> </Lev elLine> <Lev elLine> <C olor> <N amed>G ray </N amed> </C olor> <DashS ty le>Dash</DashS ty le> <Width>1</Width> </Lev elLine> <Lev elLine> <C olor> <N amed>G ray </N amed> </C olor> <DashS ty le>Dash</DashS ty le> <Width>1</Width> </Lev elLine> <Lev elLine> <C olor> <N amed>G ray </N amed> </C olor> <DashS ty le>Dash</DashS ty le> <Width>1</Width> </Lev elLine> <Lev elLine> <C olor> <N amed>G ray </N amed> </C olor> <DashS ty le>Dash</DashS ty le> <Width>1</Width> </Lev elLine> </S cheme> </chartRequest> </G etC hart_Request_1> </Body > </E nv elope>

146

TRKD API Developer's Guide

Company Administration

147

chapter 9

Company Administration

The Company Administration service can be used to retrieve and update company and channel information from the MxPDB database. It is one of the APIs used by the Multex Permissioning Database Front-End System (MDBS) to manage company information. The following operations are available through Company Administration: Company from Template (CompanyFromTemplate_1) - creates a company from a template. Get Channel Reference Information (GetChannelReferenceInfo_1) - retrieves reference information of all the available channels. Get Company Template (GetCompanyTemplate_1) - retrieves the list of country codes. Update Company (UpdateCompany_1) - updates the properties of a particular company.

9.1

Authentication/Authorization, Service Endpoint, and Required Headers

Authorization All requests to the Company Administration service require an authorization token. For details, see section Understanding Authentication Tokens. Authentication The Company Administration service uses Reuters impersonation tokens for each effective user. In this case, Thomson Reuters must create each user before your application authenticates them. Unmanaged effective users are not supported in Company Administration. For additional information on creating a Service Token, see section Creating a Token.

Service Endpoint Company Administration Endpoint

http://api.rkd.reuters.com/api/2008/08/08/C ompany A dmin_1.sv c

Required Header Required HTTP Headers

P O S T api/2008/08/08/C ompany A dmin_1.sv c H TTP /1.1 C ontent-Ty pe: application/soap+xml H ost: api.rkd.reuters.com C ontent-Length: [length]

9.2

WSDL
WSDL:
http://api.rkd.reuters.com/schemas/w sdl/C ompany A dmin_1_H ttpA ndRKDToken.w sdl

9.3

Company from Template (CompanyFromTemplate_1)

The CompanyFromTemplate_1 request creates a company from a template. Templates are used to describe the database object patterns to instantiate a new company within the database.

148

TRKD API Developer's Guide

The following example creates a company with company name 'New_Company' and Template ID '30530'. It also requires the mailing address, city, state, postal code, and country. Note: When specifying country name, make sure you use the proper country code. See section Country Codes for mapping. XML Sample Request - Creating Company from Template
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2008/08/08/C ompany A dmin_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/ C ompany A dmin_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <C ompany F romTemplate_Request_1 xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/C ompany A dmin_1"> <input> <company N ame>N ew _C ompany </company N ame> <description>C ompany A dmin_serv ice test company </description> <templateid>30530</templateid> <company M ailingA ddress> <A ddressLine1>M ailing A ddress_Line1</A ddressLine1> <C ity >C ity _N ame</C ity > <S tateP rov ince>S tate_N ame</S tateP rov ince> <C ountry >C ountry _N ame</C ountry > </company M ailingA ddress> </input> </C ompany F romTemplate_Request_1> </Body > </E nv elope>

Attribute

Description

companyNam Name for the company to be created. Note: The value for this attribute is limited to 64 characters max. e description templateid Provides company description. Note: The value for this attribute is limited to 255 characters max. Defines template id used by the company (mandatory input parameter).

companyMaili Defines company's mailing address. ngAddress The response returns ID of the created company. Note: Keep in mind that to update the company, this id is required on the input. XML Sample Response - Creating Company from Template
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/ rkd/C ompany A dmin_1/C ompany F romTemplate_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <C ompany F romTemplate_Response_1 xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/C ompany A dmin_1"> <company Id>184</company Id> </C ompany F romTemplateResponse_1> </Body > </E nv elope>

Company Administration

149

9.4

Get Channel Reference Information (GetChannelReferenceInfo_1)

The GetChannelReferenceInfo_1 request can be used to retrieve a list of the country codes for use when creating a new entitlement entity. See section Country Codes for mapping. The following request is an example of the GetChannelReferenceInfo_1 request: XML Sample Request - Retrieving Channel Reference Information
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2008/08/08/C ompany A dmin_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/ C ompany A dmin_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etC hannelReferenceInfo_Request_1 xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/C ompany A dmin_1"> <channelReferenceInfoO utputF ilter countr y ="true" user JobFunction="false"/> </G etC hannelReferenceInfo_Request_1> </Body > </E nv elope>

Attribute country

Description Defines whether to include country code in the response.

userJobFuncti Defines whether to include user's job function code in the response. See section User Job Roles for on mapping. The response returns the following information: XML Sample Response - Retrieving Channel Reference Information
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/ rkd/C ompany A dmin_1/C ompany F romTemplate_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <G etC hannelReferenceInfo_Response_1 xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/C ompany A dmin_1"> <channelRef> <countr y> <id>U S </id> <name>U nited S tates of A merica</name> </country > <country > <id>U K</id> <name>U nited Kingdom</name> </country > </channelRef> </G etC hannelReferenceInfoResponse_1> </Body > </E nv elope>

Attribute country id country name userJobFunctio

Description Shows the country code. Shows country name. Shows code of user's job function.

150

TRKD API Developer's Guide

n ID name

Shows name of user's job function.

9.5

Get Company Template (GetCompanyTemplate_1)

The GetCompanyTemplate_1 request retrieves the list of all company template IDs. The following example shows how to retrieve company templates: XML Sample Request - Retrieving Company Template
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2008/08/08/C ompany A dmin_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/ C ompany A dmin_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etC ompany Template_Request_1 xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/C ompany A dmin_1"/> </Body > </E nv elope>

The response returns the following information: XML Sample Response - Retrieving Company Template
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/ rkd/C ompany A dmin_1/C ompany F romTemplate_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <G etC ompany Template_Response_1 xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/C ompany A dmin_1"> <company Template> <id>184</id> <name>M ultex</name> </company Template> </G etC hannelReferenceInfoResponse_1> </Body > </E nv elope>

Attribute company template id company template name

Description Defines the company template. Shows the name of company template.

9.6

Update Company (UpdateCompany_1)

The UpdateCompany_1 request updates the properties of a particular company. The following example updates the properties of the company with Company ID '184'. You receive Company ID in the response when creating a company (see section CompanyFromTemplate_1 for more details). You can change company name, 'disabled' flag, cancel date and reason, description and address.

Company Administration

151

XML Sample Request - Updating Company

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2008/08/08/C ompany A dmin_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/ C ompany A dmin_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <U pdateC ompany _Request_1 xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/C ompany A dmin_1"> <company > <company Id>184</company Id> <company N ame>N ew _C ompany </company N ame> <disabled>false</disabled> <cancelDate>2008-09-10T00:00:00</cancelDate> <cancelReason>C ancel_Reason</cancelReason> <description>description of company </description> <mailingA ddress> <A ddressLine1>M ailing_A ddress_Line1</A ddressLine1> <C ity >C ity </C ity > <S tateP rov ince>S tate</S tateP rov ince> <P ostalC ode>P O _C ode</P ostalC ode> <C ountry >C ountry </C ountry > </mailingA ddress> </company > </U pdateC ompany _Request_1> </Body > </E nv elope>

Attribute companyId

Description Identifies company (mandatory input parameter).

companyNam Name for the company to be created. e disabled cancelDate description Shows whether the company is disabled. Defines when the company will be disabled. Provides company description.

cancelReason Shows the reason why the company is disabled. mailingAddres Defines company's mailing address. s The response returns the following information: XML Sample Response - Updating Company
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/ rkd/C ompany A dmin_1/C ompany F romTemplate_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <U pdateC ompany _Response_1 xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/C ompany A dmin_1"> </U pdateC ompany Response_1> </Body > </E nv elope>

152

TRKD API Developer's Guide

9.7

Country Codes
Country Code Country Name AF Afghanistan AL Albania DZA Algeria ASM American Samoa AD Andorra AND Angola AIA Anguilla AQ Antarctica AG Antigua and Barbuda ARG Argentina AM Armenia ABW Aruba AUS Australia AUT Austria AZ Azerbaijan BHS Bahamas BHR Bahrain BD Bangladesh BB Barbados BY Belarus BEL Belgium BLZ Belize BJ Benin BMU Bermuda BT Bhutan BOL Bolivia BA Bosnia and Herzegovina BWA Botswana BV Bouvet Island BRA Brazil IO British Indian Ocean Territory BN Brunei Darussalam BUL Bulgaria BF Burkina Faso BI Burundi KH Cambodia CM Cameroon CAN Canada CV Cape Verde CYM Cayman Islands CF Central African Republic TD Chad CHL Chile CHN China CX Christmas Island CC Cocos (Keeling) Islands COL Colombia KM Comoros CG Congo

Company Administration

153

ZAR CK CRI IVC HR CUB CYP CZE DNK DJ DM DO TP ECU EGY SLV GQ ER EE ET FK FO FJ FIN FRA GF PF TF GAB GM GE DEU GHA GI GRC GL GD GP GU GT GN GW GY HT HM HN HKG HUN ISL IND IDN IRN

Congo, The Democratic Republic of Cook Islands Costa Rica Cote d'Ivoire Croatia Cuba Cyprus Czech Republic Denmark Djibouti Dominica Dominican Republic East Timor Ecuador Egypt El Salvador Equatorial Guinea Eritrea Estonia Ethiopia Falkland Islands Faroe Islands Fiji Finland France French Guiana French Polynesia French Southern Territories Gabon Gambia Georgia Germany Ghana Gibraltar Greece Greenland Grenada Guadeloupe Guam Guatemala Guinea Guinea-Bissau Guyana Haiti Heard Island and McDonald Islands Honduras Hong Kong Hungary Iceland India Indonesia Iran, Islamic Republic of

154

TRKD API Developer's Guide

IQ IRL ISR ITA JAM JPN JOR KZ KEN KI PRK KOR KWT KYR LA LV LBN LS LBR LY LIE LT LUX MO MK MDG MWI MYS MV ML MLT MH MQ MR MUS YT MEX FM MD MC MN ME MS MAR MZ MM NA NR NP NLD ANT NC

Iraq Ireland Israel Italy Jamaica Japan Jordan Kazakhstan Kenya Kiribati Korea, Democratic People's Republic of Korea, Republic of Kuwait Kyrgyzstan Lao People's Democratic Republic Latvia Lebanon Lesotho Liberia Libyan Arab Jamahiriya Liechtenstein Lithuania Luxembourg Macau Macedonia, The Former Yugoslav Republic of Madagascar Malawi Malaysia Maldives Mali Malta Marshall Islands Martinique Mauritania Mauritius Mayotte Mexico Micronesia, Federated States of Moldova, Republic of Monaco Mongolia Montenegro Montserrat Morocco Mozambique Myanmar Namibia Nauru Nepal Netherlands Netherlands Antilles New Caledonia

Company Administration

155

NZL NI NE NGA NU NF MP NOR OM PAK PW PS PAN PNG PY PER PHL PN POL PRT PRI QAT RE ROM RUS RW SH KN LC PM VC WS SM ST SAU SN RS YUG SC SL SGP SVK SI SB SO ZAF GS ESP LKA SDN SUR SJ

New Zealand Nicaragua Niger Nigeria Niue Norfolk Island Northern Mariana Islands Norway Oman Pakistan Palau Palestine Panama Papua New Guinea Paraguay Peru Philippines Pitcairn Poland Portugal Puerto Rico Qatar Reunion Romania Russian Federation Rwanda Saint Helena Saint Kitts and Nevis Saint Lucia Saint Pierre and Miquelon Saint Vincent and the Grenadines Samoa San Marino Sao Tome and Principe Saudi Arabia Senegal Serbia Serbia & Montenegro - Discontinue with effect from December 11, 2006 Seychelles Sierra Leone Singapore Slovakia Slovenia Soloman Islands Somalia South Africa South Georgia and the South Sandwich Islands Spain Sri Lanka Sudan Suriname Svalbard and Jan Mayen

156

TRKD API Developer's Guide

SZ SWE CHE SY TWN TJ TZA THA TG TK TO TTO TUN TUR TM TC TV UGA UA ARE GBR USA UM URY UZ VUT VA VEN VNM VGB VI WF EH YE ZMB ZWE

Swaziland Sweden Switzerland Syrian Arab Republic Taiwan Tajikistan Tanzania, United Republic of Thailand Togo Tokelau Tonga Trinidad and Tobago Tunisia Turkey Turkmenistan Turks and Caicos Islands Tuvalu Uganda Ukraine United Arab Emirates United Kingdom United States United States Minor Outlying Islands Uruguay Uzbekistan Vanuatu Vatican City State Venezuela Vietnam Virgin Islands, British Virgin Islands, U.S. Wallis and Futuna Western Sahara Yemen Zambia Zimbabwe

9.8

User Job Roles

ID 269 270 271 Job Role FX & Interest Rate Portfolio Manager FX & Interest Rate Research Analyst FX & Interest Rate Sales Job Role Description You are typically involved in investing in FX and interest rate instruments. You are typically involved in analysis of market trends in the FX and interest rate markets. You are typically involved in managing relationships with existing customers, promoting the firm's research and primary business to generate trade in FX and interest rate products. You act as a broker between professional counter-parties in the FX markets. You are typically involved in FX Forward and Arbitrage Trading. You are responsible for the trading of, or sales activities related to, FX options. You are typically involved in FX Spot and Spot Arbitrage Trading.

272 273 274 275

FX Broker FX Forward Trader FX Options Sales & Trader FX Trader

Company Administration

157

276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295

Interest Rate Broker

296 297 298 299 300 301

302 303 304 305 306

You are mainly concerned with acting as a broker between professional counterparties in the interest rate markets. Interest Rate Futures Trader You are responsible for trading interest rate futures. Interest Rate Swaps Trader You are an IRS Trader or Specialist IRS Sales Trader who generally trades products with tenor of over 2 years. Interest Rate Trader You are responsible for trading interest rate instruments. Short Term Interest Rate You are typically responsible for FX Forwards, OIS, Money Market, FRA and other Trader short term instruments and generally trade products with a tenor of under 2 years. Fixed Income Job Roles Central Bank and You are responsible for trading or sales activities as part of a central bank or Supranational Sales & Trader supranational organization. Commercial Paper Sales & You are responsible for the trading of, or sales activities related to, Commercial Trader Paper. Convertible Bond Sales & You are responsible for the trading of, or sales activities related to, Convertible Trader Bonds. Corporate Bond Sales & You are responsible for the trading of, or sales activities related to, Corporate Bonds. Trader Credit Derivatives Sales & You are responsible for the trading of, or sales activities related to, credit Trader derivatives. Fixed Income Bond Futures You are responsible for the trading of fixed income bond futures. Can be an assistant Trader role too. Fixed Income Broker You act as a broker between professional counter-parties in the fixed income markets. Fixed Income Emerging You are responsible for the trading of, or sales activities related to, emerging market Markets Sales & Trader credit instruments. Fixed Income Portfolio You are typically involved in investing in fixed income instruments. Manager Fixed Income Research You are typically involved in analysis of market trends in the fixed income markets. Analyst Fixed Income Sales & Trader You are responsible for the trading of, or sales activities related to, fixed income instruments. Government / Agency Sales & You are responsible for the trading of, or sales activities related to, government or Trader agency bonds. High Yield Sales & Trader You are responsible for the trading of, or sales activities related to, high yield bonds. Market Strategist You typically provide clients, prospects and consultants with ongoing updates about the investment philosophy, process and performance of specific products, and act as the primary contact for clients within the Investment team. MBS / ABS / CDO Sales & You are responsible for the trading of, or sales activities related to, mortgage backed Trader securities, asset backed securities or collateralized debt obligations. Municipal Sales & Trader You are responsible for the trading of, or sales activities related to, municipal bonds. Repo Sales & Trader You are responsible for the trading of, or sales activities related to, repurchase agreements. Structured Products Trader / You are responsible for the creation, trading or analysis of structured products. Analyst Equity Job Roles Equity Derivatives Sales You are typically involved in managing relationships with existing customers, promoting the firm's research and primary business and getting customers to trade equity derivative products. Equity Derivatives Trader You are typically involved in trading equity futures, options and other equity derivatives. Equity Portfolio Manager You are typically involved in investing in equity cash and derivative instruments. Equity Portfolio Manager Who You are responsible for the execution of transactions for the portfolios you manage. Trades Equity Research Analyst You are typically involved in analysis of market trends in the equity markets. Equity Sales You are typically involved in managing relationships with existing customers, promoting the firm's research and primary business to generate trade in equity products.

158

TRKD API Developer's Guide

307

Equity Sales Trader

308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343

Equity Trader Structured Products Trader / Analyst Commodities & Energy Job Roles Agriculture Analyst Agriculture Broker Agriculture Purchasing / Supply Manager Agriculture Sales & Trader Energy Analyst Energy Broker Energy Purchasing / Supply Manager Energy Sales & Trader Metals Analyst Metals Broker Metals Purchasing / Supply Manager Metals Sales & Trader Shipping Agent Shipping Analyst Shipping Broker Shipping Owner / Operator Environmental Markets Job Roles Carbon Market Analyst Carbon Market Broker Carbon Trader CDM / JI Professional

You are typically involved in managing relationships with existing customers, promoting the firm's research and primary business and executing trades in equity products. You are responsible for trading equity cash instruments. You are responsible for the creation, trading or analysis of structured products.

You are typically involved in analysis of trends in the agriculture markets. You are typically involved in broking agriculture futures, options and cash instruments. You are typically involved in the physical supply chain for agriculture products. You are responsible for the trading of, or sales activities related to, agriculture futures, options and cash instruments. You are typically involved in analysis of market trends in the energy markets. You are typically involved in broking energy futures, options and cash instruments. You are typically involved in the physical supply chain for energy products. You are responsible for the trading of, or sales activities related to, energy products. You are typically involved in analysis of market trends in the metals markets. You are typically involved in broking metals futures, options and cash instruments. You are typically involved in the physical supply chain for metals products. You are responsible for the trading of, or sales activities related to, metals. You typically represent ship owner / operators or charterers for physical shipments. You are responsible for analysis of market trends in the shipping markets. You typically fix ships or arrange forward freight agreements for owner / operators and / or charterers. You own or operate a shipping company.

Environmental Markets Analyst Environmental Markets Broker You are typically involved in broking emissions, renewable energy certificates or weather derivatives. Environmental Markets Sales You are typically involved in trading emissions, renewable energy certificates or & Trader weather derivatives. Media Job Roles Agency Account Executive / You are responsible for the overall client relationship. Account Director Content Manager You are responsible for purchasing content sources but not part of an editorial team. Creative Director You typically oversee the design of branding and advertising for a client. Editor in Chief / Editor / Head You head an editorial team in a news organization. of News Editorial Content Buyer You are part of the editorial team in a news organization and responsible for purchasing content sources. Exec. Producer / Producer You work as a producer or executive producer in a media organization. Journalist / Correspondent You contribute reports to a newspaper, or radio or television news. Media Buyer You are responsible for purchasing advertising space within a range of media.

You are typically involved in the analysis of the market trends in the carbon market. You are typically involved in broking carbon market contracts and / or CDM & JI deals. You are typically involved in trading carbon market contracts. You are typically involved in transactions associated with the Kyoto protocol mechanisms (Clean Development Mechanism and Joint Implementation). You are typically involved in analysis of market trends in the environmental markets.

Company Administration

159

344 345 346 347 348

Media Planner Pictures / Graphics Editor Cross Market Job Roles Algorithmic / Quantitative Trading Capital Markets / Syndication / Origination

You typically plan the advertising strategy, and determine the timing of adverts and the most effective media to use. You are responsible for still image selection.

349

350 351 352 353 354 355 356 357 358

359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374

You are typically involved in developing algorithmic and / or quantitative trading strategies and the execution of trades. You are typically involved in capital markets process: in the origination of transactions, targeting investors, syndication, marketing activities, pricing and allocation as well as the aftermarket activities. Corporate Treasurer You are typically involved in liquidity management, trade finance and managing the company's working capital. You may also manage company pension fund, investments and overall risk management. Cross Asset Portfolio Manager You are typically involved in longer term investment across different asset classes, you could also be a relationship manager. Cross Asset Proprietary You are typically involved in trading any asset class for your institution and not for Trader clients. Cross Asset Research Analyst You are typically involved in research across multiple asset classes on buy-side. (Buy-side) Cross Asset Research Analyst You are typically involved in research across multiple asset classes on sell-side. (Sell-side) Cross Asset Trader You are a trader and you trade several different asset types. Economist You are typically involved in analysis of economic fundamentals, usually in support of the trading, sales and investment functions. Hedge Fund Portfolio Manager You are responsible for investing in multiple asset classes as part of a hedge fund. Hedge Fund Trader You are typically involved in looking for profitable trading opportunities in cash and derivative securities as part of a hedge fund. Investment Banker You are typically assisting corporations to raise funds in the capital markets (both equity and debt), as well as in providing strategic advisory services for mergers, acquisitions and other types of financial transactions and financial organization. Investor Relations You are typically involved in investor communications and act as a liaison between Professional your organization, analysts and investors. Private Equity / Venture You are typically involved in financing of new or developing businesses. Capitalist Securities Pricing Manager You are responsible for sourcing and managing pricing feeds from various vendors for portfolio valuation purposes. Technical Analyst You are responsible for use of technical analysis to analyze market trends to support trading, sales and investment functions. Risk Management and Control Job Roles Chief Risk Officer You are typically in charge of assessing and planning for risk across the enterprise. Credit Risk Officer / Manager You are typically involved in credit pre-screening, fraud, bankruptcy, compliance and debt recovery. Market Risk Manager You are responsible for monitoring and assessing market risks in order to ensure appropriate controls and for mitigating or transferring risk where necessary. Operational Risk Manager You are responsible for monitoring and assessing operational risks in order to ensure appropriate controls and for mitigating or transferring risk where necessary. Real Estate Job Roles Property Derivatives Sales & You are responsible for the trading of, or sales activities related to, property Trader derivatives. Real Estate Advisor / Agent You are involved in Real Estate transactions, typically of direct property, on behalf of your clients, or your own firm. Real Estate Banker You are involved in advisory, underwriting, M&A focusing on the real estate sector. Real Estate Fund Manager / You invest the assets of a real estate fund, REIT, implement investment strategy and REIT Manager manage the day-to-day portfolio transactions. Real Estate Research Analyst You are typically involved in analysis of market trends in the real estate markets. Wealth Management Roles

160

TRKD API Developer's Guide

375 376 377 378 379 380 381

Financial Advisor Personal Investor Private Banker Retail Broker Wealth Manager Other Job Roles Accountant / Lawyer

You are typically involved in providing advice or consulting services to individuals on financial planning and investing. You are a customer of a bank, broker or wealth management company. You provide investment advisory services and other banking services to individual investors with sizable accounts, typically in excess of $1million. You are a transaction oriented, commission based, stock broker advising and executing investments on behalf of clients. You are typically responsible for managing client relationships in a financial institution.

382 383 384 385 386

387 388

389 390 391

392

393 394 395 396

397 398 399 400 401

You are typically responsible for ensuring the effective operation of accounting and financial activities within the enterprise or ensuring the legality of commercial transactions. Back Office / Settlement You are typically involved in settlement instruction processing, fail monitoring of trades and exception cleaning. Business Analyst - IT / Market You are typically responsible for translating IT requirements into business solutions Data through interfaces with stakeholders and the IT department. Chief Information Officer / You are responsible for defining vision, strategy, direction and oversight for Chief Technology Officer Information Technology in an organization. Chief Investment Officer You are responsible for the management of your organization's portfolio, by developing a long-term investment policy and asset allocation strategy. Compliance Officer You are responsible for dealing with any compliance issues that arise during financial transactions, trading, or the handling of client accounts and ensuring that your organization and all employees understand and abide by internal and regulatory procedure. Consultant You provide consulting services either internally to your own organization or to external clients. Corporate Librarian / You are typically involved in collecting, organizing and presenting information. Information Research Professional Database Administrator You are typically responsible for planning, maintenance and development of databases. Developer / Programmer You are typically responsible for designing, developing, testing and implementing software to improve business efficiency and productivity. e-Commerce Manager You plan and execute product groups or asset classes overall e-Commerce development, risk management and distribution strategy. You also provide leadership for the company's web site development and coordination between the company's internal departments. Fund Administrator You are typically involved in the management and control of day-to-day fund accounting activities and liaising with auditors, regulators and clients regarding all accounting issues. IT Manager / Analyst You typically plan, coordinate, direct, and design IT-related activities of your organization. Market Data Manager You are involved in overseeing and managing the Market Data delivery, operations and support. Marketing Officer / Manager You are responsible in various marketing-related activities within your organization. Middle Office You are responsible for trade processing: you handle trade confirmations and cash settlements as well as profitability reporting, risk position analysis and resolution of cash and position differences. Operations Manager You are responsible for ensuring that business operations are efficient and effective. Performance Measurement You are responsible for producing performance reports on in-house (proprietary) and Officer / Analyst peer group investment funds. Product and IT Support - 1st You are the first point of contact for users experiencing product-related technical Line issues. Product and IT Support You are the immediate escalation route for technical issues not resolved by first line 2nd / 3rd Line support. Quantitative Analyst You are a specialist in the mathematical techniques of finance and carry out quantitative research to develop and enhance models for risk management, asset

Company Administration

161

402 403 404 405 406 407 408 409

410 411 412 413 414 415 416 417 418

419 420 421 422 423 424 425 426 427 428

429 430 431

allocation and investment strategies. You are typically responsible for sourcing and managing reference data feeds from various vendors. Sales Person / Account You are responsible for sales and / or account management in a non-financial Manager (non-financial) institution. Senior Executive You are in a board-level or top-tier management role. Strategic Planning / Business You are responsible for defining corporate strategy, competitors analysis and Development Professional identifying M&A opportunities. Systems Engineer You are responsible for enabling the realization and deployment of successful systems. University Professor / Student You are a student or a professor in a university or other educational institution. All Job Roles Accountant / Lawyer You are typically responsible for ensuring the effective operation of accounting and financial activities within the enterprise or ensuring the legality of commercial transactions. Agency Account Executive / You are responsible for the overall client relationship. Account Director Agriculture Analyst You are typically involved in analysis of trends in the agriculture markets. Agriculture Broker You are typically involved in broking agriculture futures, options and cash instruments. Agriculture Purchasing / You are typically involved in the physical supply chain for agriculture products. Supply Manager Agriculture Sales & Trader You are responsible for the trading of, or sales activities related to, agriculture futures, options and cash instruments. Algorithmic / Quantitative You are typically involved in developing algorithmic and / or quantitative trading Trading strategies and the execution of trades. Back Office / Settlement You are typically involved in settlement instruction processing, fail monitoring of trades and exception cleaning. Business Analyst - IT / Market You are typically responsible for translating IT requirements into business solutions Data through interfaces with stakeholders and the IT department. Capital Markets / Syndication / You are typically involved in capital markets process: in the origination of Origination transactions, targeting investors, syndication, marketing activities, pricing and allocation as well as the aftermarket activities. Carbon Market Analyst You are typically involved in the analysis of the market trends in the carbon market. Carbon Market Broker You are typically involved in broking carbon market contracts and / or CDM & JI deals. Carbon Trader You are typically involved in trading carbon market contracts. CDM / JI Professional You are typically involved in transactions associated with the Kyoto protocol mechanisms (Clean Development Mechanism and Joint Implementation). Central Bank and You are responsible for trading or sales activities as part of a central bank or Supranational Sales & Trader supranational organization. Chief Information Officer / You are responsible for defining vision, strategy, direction and oversight for Chief Technology Officer Information Technology in an organization. Chief Investment Officer You are responsible for the management of your organization's portfolio, by developing a long-term investment policy and asset allocation strategy. Chief Risk Officer You are typically in charge of assessing and planning for risk across the enterprise. Commercial Paper Sales & You are responsible for the trading of, or sales activities related to, Commercial Trader Paper. Compliance Officer You are responsible for dealing with any compliance issues that arise during financial transactions, trading, or the handling of client accounts and ensuring that your organization and all employees understand and abide by internal and regulatory procedures. Consultant You provide consulting services either internally to your own organization or to external clients. Content Manager You are responsible for purchasing content sources but not part of an editorial team. Convertible Bond Sales & You are responsible for the trading of, or sales activities related to, Convertible Trader Bonds. Reference Data Manager

162

TRKD API Developer's Guide

432 433

434

Corporate Bond Sales & Trader Corporate Librarian / Information Research Professional Corporate Treasurer

You are responsible for the trading of, or sales activities related to, Corporate Bonds. You are typically involved in collecting, organizing and presenting information.

435 436 437 438 439 440 441 442 443 444 445

446 447 448 449 450 451 452 453 454 455 456

457 458 459 460 461

You are typically involved in liquidity management, trade finance and managing the company's working capital. You may also manage company pension fund, investments and overall risk management. Creative Director You typically oversee the design of branding and advertising for a client. Credit Derivatives Sales & You are responsible for the trading of, or sales activities related to, credit Trader derivatives. Credit Risk Officer / Manager You are typically involved in credit pre-screening, fraud, bankruptcy, compliance and debt recovery. Cross Asset Portfolio Manager You are typically involved in longer term investment across different asset classes, you could also be a relationship manager. Cross Asset Proprietary You are typically involved in trading any asset class for your institution and not for Trader clients. Cross Asset Research Analyst You are typically involved in research across multiple asset classes on buy-side. (Buy-side) Cross Asset Research Analyst You are typically involved in research across multiple asset classes on sell-side. (Sell-side) Cross Asset Trader You are a trader and you trade several different asset types. Database Administrator You are typically responsible for planning, maintenance and development of databases. Developer / Programmer You are typically responsible for designing, developing, testing and implementing software to improve business efficiency and productivity. e-Commerce Manager You plan and execute product groups or asset classes overall e-Commerce development, risk management and distribution strategy. You also provide leadership for the company's web site development and coordination between the company's internal departments. Economist You are typically involved in analysis of economic fundamentals, usually in support of the trading, sales and investment functions. Editor in Chief / Editor / Head You head an editorial team in a news organization. of News Editorial Content Buyer You are part of the editorial team in a news organization and responsible for purchasing content sources. Energy Analyst You are typically involved in analysis of market trends in the energy markets. Energy Broker You are typically involved in broking energy futures, options and cash instruments. Energy Purchasing / Supply You are typically involved in the physical supply chain for energy products. Manager Energy Sales & Trader You are responsible for the trading of, or sales activities related to, energy products. Environmental Markets You are typically involved in analysis of market trends in the environmental markets. Analyst Environmental Markets Broker You are typically involved in broking emissions, renewable energy certificates or weather derivatives. Environmental Markets Sales You are typically involved in trading emissions, renewable energy certificates or & Trader weather derivatives. Equity Derivatives Sales You are typically involved in managing relationships with existing customers, promoting the firm's research and primary business and getting customers to trade equity derivative products. Equity Derivatives Trader You are typically involved in trading equity futures, options and other equity derivatives. Equity Portfolio Manager You are typically involved in investing in equity cash and derivative instruments. Equity Portfolio Manager Who You are responsible for the execution of transactions for the portfolios you manage. Trades Equity Research Analyst You are typically involved in analysis of market trends in the equity markets. Equity Sales You are typically involved in managing relationships with existing customers,

Company Administration

163

462

Equity Sales Trader

463 464 465 466 467 468 469 470 471 472

Equity Trader Exec. Producer / Producer Financial Advisor Fixed Income Bond Futures Trader Fixed Income Broker Fixed Income Emerging Markets Sales & Trader Fixed Income Portfolio Manager Fixed Income Research Analyst Fixed Income Sales & Trader Fund Administrator

promoting the firm's research and primary business to generate trade in equity products. You are typically involved in managing relationships with existing customers, promoting the firm's research and primary business and executing trades in equity products. You are responsible for trading equity cash instruments. You work as a producer or executive producer in a media organization. You are typically involved in providing advice or consulting services to individuals on financial planning and investing. You are responsible for the trading of fixed income bond futures. Can be an assistant role too. You act as a broker between professional counter-parties in the fixed income markets. You are responsible for the trading of, or sales activities related to, emerging market credit instruments. You are typically involved in investing in fixed income instruments. You are typically involved in analysis of market trends in the fixed income markets. You are responsible for the trading of, or sales activities related to, fixed income instruments. You are typically involved in the management and control of day-to-day fund accounting activities and liaising with auditors, regulators and clients regarding all accounting issues. You are typically involved in investing in FX and interest rate instruments.

473 474 475

FX & Interest Rate Portfolio Manager FX & Interest Rate Research Analyst FX & Interest Rate Sales

476 477 478 479 480 481 482 483 484 485 486 487 488

489 490 491 492

You are typically involved in analysis of market trends in the FX and interest rate markets. You are typically involved in managing relationships with existing customers, promoting the firm's research and primary business to generate trade in FX and interest rate products. FX Broker You act as a broker between professional counter-parties in the FX markets. FX Forward Trader You are typically involved in FX Forward and Arbitrage Trading. FX Options Sales & Trader You are responsible for the trading of, or sales activities related to, FX options. FX Trader You are typically involved in FX Spot and Spot Arbitrage Trading. Government / Agency Sales & You are responsible for the trading of, or sales activities related to, government or Trader agency bonds. Hedge Fund Portfolio Manager You are responsible for investing in multiple asset classes as part of a hedge fund. Hedge Fund Trader You are typically involved in looking for profitable trading opportunities in cash and derivative securities as part of a hedge fund. High Yield Sales & Trader You are responsible for the trading of, or sales activities related to, high yield bonds. Interest Rate Broker You are mainly concerned with acting as a broker between professional counterparties in the interest rate markets. Interest Rate Futures Trader You are responsible for trading interest rate futures. Interest Rate Swaps Trader You are an IRS Trader or Specialist IRS Sales Trader who generally trades products with tenor of over 2 years. Interest Rate Trader You are responsible for trading interest rate instruments. Investment Banker You are typically assisting corporations to raise funds in the capital markets (both equity and debt), as well as in providing strategic advisory services for mergers, acquisitions and other types of financial transactions and financial organization. Investor Relations You are typically involved in investor communications and act as a liaison between Professional your organization, analysts and investors. IT Manager / Analyst You typically plan, coordinate, direct, and design IT-related activities of your organization. Journalist / Correspondent You contribute reports to a newspaper, or radio or television news. Market Data Manager You are involved in overseeing and managing the Market Data delivery, operations

164

TRKD API Developer's Guide

493 494

Market Risk Manager Market Strategist

495 496 497 498 499 500 501 502 503

Marketing Officer / Manager MBS / ABS / CDO Sales & Trader Media Buyer Media Planner Metals Analyst Metals Broker Metals Purchasing / Supply Manager Metals Sales & Trader Middle Office

and support. You are responsible for monitoring and assessing market risks in order to ensure appropriate controls and for mitigating or transferring risk where necessary. You typically provide clients, prospects and consultants with ongoing updates about the investment philosophy, process and performance of specific products, and act as the primary contact for clients within the Investment team. You are responsible in various marketing-related activities within your organization. You are responsible for the trading of, or sales activities related to, mortgage backed securities, asset backed securities or collateralized debt obligations. You are responsible for purchasing advertising space within a range of media. You typically plan the advertising strategy, and determine the timing of adverts and the most effective media to use. You are typically involved in analysis of market trends in the metals markets. You are typically involved in broking metals futures, options and cash instruments. You are typically involved in the physical supply chain for metals products. You are responsible for the trading of, or sales activities related to, metals. You are responsible for trade processing: you handle trade confirmations and cash settlements as well as profitability reporting, risk position analysis and resolution of cash and position differences. You are responsible for the trading of, or sales activities related to, municipal bonds. You are responsible for monitoring and assessing operational risks in order to ensure appropriate controls and for mitigating or transferring risk where necessary. You are responsible for ensuring that business operations are efficient and effective. You are responsible for producing performance reports on in-house (proprietary) and peer group investment funds. You are a customer of a bank, broker or wealth management company. You are responsible for still image selection. You provide investment advisory services and other banking services to individual investors with sizable accounts, typically in excess of $1million. You are typically involved in financing of new or developing businesses.

504 505 506 507 508 509 510 511 512 513 514 515

Municipal Sales & Trader Operational Risk Manager Operations Manager Performance Measurement Officer / Analyst Personal Investor Pictures / Graphics Editor Private Banker Private Equity / Venture Capitalist Product and IT Support - 1st Line Product and IT Support 2nd / 3rd Line Property Derivatives Sales & Trader Quantitative Analyst

516 517 518 519 520 521 522 523 524

You are the first point of contact for users experiencing product-related technical issues. You are the immediate escalation route for technical issues not resolved by first line support. You are responsible for the trading of, or sales activities related to, property derivatives. You are a specialist in the mathematical techniques of finance and carry out quantitative research to develop and enhance models for risk management, asset allocation and investment strategies. Real Estate Advisor / Agent You are involved in Real Estate transactions, typically of direct property, on behalf of your clients, or your own firm. Real Estate Banker You are involved in advisory, underwriting, M&A focusing on the real estate sector. Real Estate Fund Manager / You invest the assets of a real estate fund, REIT, implement investment strategy and REIT Manager manage the day-to-day portfolio transactions. Real Estate Research Analyst You are typically involved in analysis of market trends in the real estate markets. Reference Data Manager You are typically responsible for sourcing and managing reference data feeds from various vendors. Repo Sales & Trader You are responsible for the trading of, or sales activities related to, repurchase agreements. Retail Broker You are a transaction oriented, commission based, stock broker advising and executing investments on behalf of clients. Sales Person / Account You are responsible for sales and / or account management in a non-financial Manager (non-financial) institution. Securities Pricing Manager You are responsible for sourcing and managing pricing feeds from various vendors for

Company Administration

165

525 526 527 528 529 530 531 532 533 534 535 536

Senior Executive Shipping Agent Shipping Analyst Shipping Broker Shipping Owner / Operator Short Term Interest Rate Trader Strategic Planning / Business Development Professional Structured Products Trader / Analyst Systems Engineer

portfolio valuation purposes. You are in a board-level or top-tier management role. You typically represent ship owner / operators or charterers for physical shipments. You are responsible for analysis of market trends in the shipping markets. You typically fix ships or arrange forward freight agreements for owner / operators and / or charterers. You own or operate a shipping company. You are typically responsible for FX Forwards, OIS, Money Market, FRA and other short term instruments and generally trade products with a tenor of under 2 years. You are responsible for defining corporate strategy, competitors analysis and identifying M&A opportunities. You are responsible for the creation, trading or analysis of structured products.

You are responsible for enabling the realization and deployment of successful systems. Technical Analyst You are responsible for use of technical analysis to analyse market trends to support trading, sales and investment functions. University Professor / Student You are a student or a professor in a university or other educational institution. Wealth Manager You are typically responsible for managing client relationships in a financial institution.

166

TRKD API Developer's Guide

chapter 10

Document Retrieval

The Document Retrieval service is used to retrieve documents by Document ID or Contributor ID and Contributor Document ID. The service checks the authenticated user's credentials and delivers documents the user is entitled to. The service supports all file types in the document repository including multimedia files. The service also allows you to retrieve document thumbnails to determine a document's contents: whether it is a text or a chart. You can search for Document IDs and Contributor Document IDs using the Document Search service. See section Document Search for more information.

10.1

Authentication and Authorization

Authorization All requests to the TRKD API require an authorization token. For details, see section Understanding Authentication Tokens. Authentication TRKD API uses Reuters impersonation tokens for each effective user. In this case, Thomson Reuters must create each user before your application authenticates them. Unmanaged effective users are not supported in TRKD API. See section Creating a Token for more information.

10.2

Identifying the User in Each Request

This section describes generating the user authorization token before retrieving documents.

10.2.1 Generating the User Authorization Token

Your application must generate a user authorization token before making any document retrieval requests by submitting an authentication request (XML including the user login and password). To generate the token, submit the following XML: XML Sample Request - Creating a Service Token
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2006/05/01/TokenM anagement_1.sv c/A nony mous</ To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/TokenM anagement_1/ C reateS erv iceToken_1</A ction> </H eader> <Body > <C reateS erv iceToken_Request_1 xmlns:global="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1" xmlns="http://w w w . reuters.com/ns/2006/05/01/w ebserv ices/rkd/TokenM anagement_1"> <A pplicationID xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1">[A ppID]</A pplicationID> <U sername>[serv ice user]</U sername> <P assw ord>[passw ord]</P assw ord> </C reateS erv iceToken_Request_1> </Body > </E nv elope>

Document Retrieval

167

The Thomson Reuters Research API returns the following XML: XML Sample Response - Creating a Service Token
<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader> <a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" s:mustU nderstand="1" >http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/ rkd/TokenM anagement_1/C reateS erv iceToken_1_Reply </a:A ction> <a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <C reateS erv iceToken_Response_1 xmlns="https://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/TokenM anagement_1"> <E xpiration>[token expiration YYYY-M M -DDTH H :M M :S S ]</E xpiration> <Token xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1">[serv ice token]</Token> </C reateS erv iceToken_Response_1> </Body > </E nv elope>

Note: The user authorization token expires in a configurable time period. The default expiration is 90 minutes. If you make a Document Retrieval request with an expired or invalid authorization token, the service returns HTTP 403 Forbidden status response with the error description included in the response HTTP headers (see Error Handling). You can also enable redirection for an invalid or expired authorization - see Redirection for Expired or Invalid Authorization (Optional).

10.2.2 Setting the User Authorization Token

The value for the token and Application ID must be presented as a cookie (HTTP header). Cookie: RkdToken RkdAppId

10.2.3 Required Domain Mapping

Since each request must read a cookie written by your application, the request and your application must be in the same domain. To accomplish this, use your DNS create a CNAME to map the TRKD API host name to a name in your domain, as shown in the following example: [rkd api name] > d.mydomain.com Using the above example, your application sets the authorization cookie in "mydomain.com" and accesses the Document Retrieval service by: http://d.mydomain.com/api/2008/01/12/DocumentRetrieval_1.svc

10.3

Retrieving Documents on Behalf of Another User

After registering your application with Thomson Reuters, you will be provided a user name and password which you can use to submit requests. This account is generally referred to as the "service account". For implementations that only require one user context, use this service account to generate the "Authorization" header for each request. This service account can also be configured as a "super user", with the ability to submit request on behalf of another user the "effective user". This means the Document Retrieval service executes the query based on the entitlements of the effective user - not the service account. To do this, generate an Impersonation Token that authenticates an effective user: Generate a token for the effective user by making a CreateImpersonationToken_Request_1 request, specifying the effective user in the <EffectiveUsername> element as shown in the following example: XML Sample Request - Creating an Impersonation Token

168

TRKD API Developer's Guide

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2006/05/01/TokenM anagement_1.sv c/A nony mous</ To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/TokenM anagement_1/ C reateImpersonationToken_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <C reateImpersonationToken_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/TokenM anagement_1"> <E ffectiv eU sername>[effective user ]</E ffectiv eU sername> </C reateImpersonationToken_Request_1> </Body > </E nv elope>

Note: The "password" attribute is not required for this request. You can create both Service and Impersonation Token in one request - by using a CreateImpersonationToken_Request_2 operation and passing the service user credentials and the effective user id at once. XML Sample Request - Creating Service and Impersonation Tokens
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2006/05/01/TokenM anagement_1.sv c/A nony mous</ To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/TokenM anagement_1/ C reateImpersonationToken_2</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <C reateImpersonationToken_Request_2 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/TokenM anagement_1"> <A pplicationID xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon">[A ppID]</A pplicationID> <U sername>[serv ice user]</U sername> <P assw ord>[passw ord]</P assw ord> <E ffectiv eU sername>[effectiv e user]</E ffectiv eU sername> </C reateImpersonationToken_Request_2> </Body > </E nv elope>

10.4

Retrieving Documents (DocumentRetrieval_1)

The user can retrieve documents either by document ID (docID) or - by Contributor ID (CtbID) and Contributor Document ID (CtbDocID).

10.4.1 Retrieving Document by Document ID

To retrieve a document using document ID, make the following DocumentRetrieval_1 request: Http Sample Request
http://docs.rkd.reuters.com/api/2008/01/12/DocumentRetriev al_1.sv c/docs/[docID]/DocumentTy pe?pages=[page]&refN o=[reference_number] C ookie: RkdA ppId= [A ppID]; RkdToken=[RkdToken]

Document Retrieval

169

Attribute DocumentType

Description Defines the document type to be retrieved by the request. Please, provide DocumentType with the value of "fileType" attribute contained in the DocSearch response. For example, use "DocumentType = syn" to retrieve document synopsis. The possible values are: activeDoc - use this value to retrieve documents of the following types: doc, xsl, etc; pdf - use this value to get documents in pdf format; syn - apply this value to retrieve document synopsis; url - use this value to redirect to the specified url; web - use this value to get html documents with links to other html pages, images, stylesheets, etc; other - specify other document type you want to retrieve (txt, etc).

pages

Defines either page numbers or page ranges: f.e. pages=2; f.e. pages=1-5;7,9 Note: Document pages start from 0. (Optional) Specifies reference information to the purchase record.

refNo

Note: If fileType=web the URL must contain the forward slash "/" at the end:
http://docs.rkd.reuters.com/api/2008/01/12/DocumentRetriev al_1.sv c/docs/40465480/w eb/

The following example retrieves synopsis of the document with the 41958041 docID: Http Sample Request - Retrieving Document Synopsis
http://docs.rkd.reuters.com/api/2008/01/12/DocumentRetriev al_1.sv c/docs/4 1 9 5 8 0 4 1 /syn C ookie: RkdA ppId= [A ppID]; RkdToken=[RkdToken]

Http Sample Response - Retrieving Document Synopsis

H TTP /1.1 200 O K C ontent-Length: 0 C ache-C ontrol: priv ate Date: M on, 14 A pr 2008 12:29:51 G M T E xpires: M on, 14 A pr 2008 07:29:51 G M T S erv er: M icrosoft-IIS /6.0 X-A spN et-V ersion: 2.0.50727 X-P ow ered-By : A S P .N E T

If the user authorization token is invalid or expired, the service returns HTTP 403 Forbidden status response with the error description included in the response HTTP headers (see Error Handling). The Document Retrieval service supports also redirection for expired or invalid authorization (see Redirection for Expired or Invalid Authorization (Optional)).

10.4.2 Retrieving Document by Contributor ID and Contributor Document ID

To retrieve a document using Contributor ID and Contributor Document ID, make the following DocumentRetrieval_1 request: Http Sample Request
http://docs.rkd.reuters.com/api/2008/01/12/DocumentRetriev al_1.sv c/docs/C tbID/[C tbDocID]/DocumentTy pe?pages=[page_number]&refN o= [reference_number] C ookie: RkdA ppId= [A ppID]; RkdToken=[RkdToken]

Attribute

Description

170

TRKD API Developer's Guide

DocumentType

Defines the document type to be retrieved by the request. Please, provide DocumentType with the value of "fileType" attribute contained in the DocSearch response. For example, use "DocumentType = syn" to retrieve document synopsis. The possible values are: activeDoc - use this value to retrieve documents of the following types: doc, xsl, etc; pdf - use this value to get documents in pdf format; syn - apply this value to retrieve document synopsis; url - use this value to redirect to the specified url; web - use this value to get html documents with links to other html pages, images, stylesheets, etc; other - specify other document type you want to retrieve (txt, etc). Defines either page numbers or page ranges: f.e. pages=2; f.e. pages=1-5;7,9 Note: Document pages start from 0. (Optional) Specifies a reference information to the purchase record.

pages

refNo

Note: If fileType="web" the URL must contain the forward slash "/" at the end:
http://docs.rkd.reuters.com/api/2008/01/12/DocumentRetriev al_1.sv c/docs/17459/3853_L/w eb/

The following example retrieves pdf document with the 14505 CtbID and 2263 CtbDocID: Http Sample Request - Retrieving Document
http://docs.rkd.reuters.com/api/2008/01/12/DocumentRetriev al_1.sv c/docs/1 4 5 0 5 /2 2 6 3 /pdf C ookie: RkdA ppId= [A ppID]; RkdToken=[RkdToken]

Note: Both parameters (CtbID and CtbDocID) are required in the request: If a user enters null (nothing) for ctbid (contributor id) and a valid ctbdocid (contributor document id) then the documentretrieval service will return an error. If a user enters any value for ctbid, for example 1, and a valid value for ctbdocid then the documentretrieval service will return the document. The back-end service is flexible to allow searching for documents based on the value of ctbdocid. If a user enters a valid ctbid and a valid ctbdocid, then the documentretrieval service will also return the document. Http Sample Response - Retrieving Document
H TTP /1.1 200 O K C ontent-Length: 0 C ache-C ontrol: priv ate Date: M on, 14 A pr 2008 12:29:51 G M T E xpires: M on, 14 A pr 2008 07:29:51 G M T S erv er: M icrosoft-IIS /6.0 X-A spN et-V ersion: 2.0.50727 X-P ow ered-By : A S P .N E T

If the user authorization token is invalid or expired, the service returns HTTP 403 Forbidden status response with the error description included in the response HTTP headers (see Error Handling). The Document Retrieval service supports also redirection for expired or invalid authorization (see Redirection for Expired or Invalid Authorization (Optional)).

10.5

Retrieving Document Thumbnails (GetThumbs_1)

To retrieve document thumbnails use the GetThumbs_1 request: Http Sample Request
http://docs.rkd.reuters.com/api/2008/01/12/DocumentRetriev al_1.sv c/thumbs/[DocID]/[page number]

Document Retrieval

171

C ookie: RkdA ppId=[A ppID]; RkdToken=[RkdToken]

Note: Document pages start from the number 0. Only pages of PDF documents can be presented as thumbnails.

10.6

Error Handling
The service logs the errors in the following HTTP headers: - RkdFaultCode : the EventID full name - RkdFaultReason: exception message - ClientErrorReference : unique error reference number Please check HTTP headers to find the cause of errors. Note: If you get the "Error occurred while processing the request, please try again. If problem persists, contact product support." error while trying to download a document, you must follow the recommendations from the error message and try to download the document again.

10.7

Redirection for Expired or Invalid Authorization (Optional)

To enable redirection for expired or invalid authorization, you must provide the TRKD API team the URL address for your "invalid/expired authorization" page. Once this configuration is complete, the Document Retrieval service redirects to your "invalid/expired authorization" page URL (often called your "redirectURL"). To help your "invalid authorization" page and/or "expired authorization" page to process, the service passes the original URL address. This value is URL-encoded and associated with the parameter "u". In addition, the service passes the reason for the redirection associated with the parameter "r". Values for "r" can be "et" (expired token), "it" (invalid token). In this case the response has a 302 HTTP status code and a redirect URL in the Location HTTP header. With this information you can, for example, "recharge" an expired authorization token and deliver the requested document without alerting the user. In most cases, your expired token logic will be: 1. Post a CreateServiceToken_1 request to the TokenManagement_1 service for the service account and receive authorization token. 2. Post a CreateImpersonationToken_1 request to the TokenManagement_1 service for the effective user account and receive authorization token. 3. Redirect to the original (DocumentRetrieval_1.svc) URL and deliver the document to the user.

172

TRKD API Developer's Guide

chapter 11

Document Search

The Document Search service gives you the possibility to search for documents and retrieve document information from the electronic library contributed by research analysts of different companies. Each and every document containing financial or analytical data has a set of attributes assigned to them by the documents author. The Document Search service uses those attributes to find the documents satisfying the search criteria. To retrieve actual documents, use the Document Retrieval service. See section Document Retrieval for more information.

11.1

Authentication/Authorization, Service Endpoint, and Required Headers

Authorization All requests to the Document Search web service require an authorization token. For details, see section Understanding Authentication Tokens. Authentication Document Search uses Reuters impersonation tokens for each effective user. In this case, Thomson Reuters must create each user before your application authenticates them. Unmanaged effective users are not supported in Document Search. For additional information on creating a Service Token, see section Creating a Token. Service Endpoint Document Search Endpoint
http://api.rkd.reuters.com/api/2008/01/12/DocS earch_1.sv c

Required Header Required HTTP Headers

P O S T api/2008/01/12/DocS earch_1.sv c H TTP /1.1 C ontent-Ty pe: application/soap+xml H ost: api.rkd.reuters.com C ontent-Length: [length]

11.2

WSDL
WSDL:
http://api.rkd.reuters.com/schemas/w sdl/DocS earch_1_H ttpA ndRKDToken.w sdl

11.3

Performing a Simple Query

Many applications provide users with a bulletin board of the most recent research document contributions. You can easily generate this data by making a new submissions query. Note: "newSubmissions" is the default date range and is, by default, 1 day back. You can use the <bbDaysBack> element to change this range. For example <bbDaysBack>2</bbDaysBack> defines "newSubmissions" as 2 days back. The following XML example shows a request of metadata for 10 recently submitted documents:

Document Search

173

XML Sample Request - Performing a Request for 10 Recently Submitted Documents

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2008/01/12/DocS earch_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/DocS earch_1/ DocS earch_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <DocS earch_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/DocS earch_1" dateRange ="new S ubmissions" maxRows ="10"> </DocS earch_Request_1> </Body > </E nv elope>

Attribute dateRange

Description The date range of the document headlines to be returned. For a "newSubmissions" search, the API selects documents based on the date that the documents arrived at Thomson Reuters ("arriveDate"). For other searches, the API uses the release date contributed by the client ("releaseDate"). The maximum number of document headlines to returned - in this example the request is for a maximum of 10. Note: Max value for maxRows is 10000.

maxRows

Note: If the <maxRowsToAbort> attribute is set bigger than 2000, then system will reset it to 2000 (max value handled by system). If the number of records to be returned is greater than <maxRowsToAbort>, system will respond with 'DocSearch_TooGeneric' RKD fault. For example, if you have specified the following criteria XML Sample
<maxRow sToA bort=500 and maxRow s=50

keep in mind that the <maxRows> attribute is only for paging, which means that if 400 records satisfy the specified criteria then system will send back only 50 records. But if 600 records satisfy the specified criteria, you will receive a "too much data" exception.

11.3.1 Using Other Date Ranges

You can use the <dateRange> attribute to specify today, thisWeek, for example. You can also use <dateRange>=customDate along with <dateFrom>YYYY-MM-DD</dateFrom> and <dateTo>YYYY-MM-DD</dateTo> to specify a custom range. Note: A newSubmissions search uses the arriveDate date stamp. All other searches use releaseDate. See section Understanding Document Dates and Ordering for more details.

11.4

Interpreting the Document Search Response

The following is a typical document search response: XML Sample Response - Interpreting the Document Search Response
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader>

174

TRKD API Developer's Guide

<To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2008/01/12/DocS earch_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2007/01/12/w ebserv ices/rkd/DocS earch_1/ DocS earch_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <DocS earch_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/DocS earch_1" < diDef docID="28673918" ctbID="20780" companyName ="M ultex Research Desk" fileT ype ="url" fileName ="http://w w w . multexusa.com/mrd_daily .asp" fileS ize="0" price="0" pages="0" hasS y n="0" ndO v w ="0" tocS tart="-1" tocE nd="-1" docC lass="M R" r eleaseDate ="2003-03- 07T01:00:00" submitDate ="2003-03-07T15:10:00" ar r iveDate ="2003-0307T15:10:05" localC ode ="9120020712190622"> <headline>M ultex A t A G lance - C ompanies Reporting - M arch 10, 2003</headline> <tkr pr tID="100034300">A LXN =U S </tkr> <tkr prtID="100070420">C WG =U S </tkr> < r eg c="N A M ">N orth A merica</reg> <regG c="N A M ">N orth A merica</regG > <docTy p c="1100">E Q U ITY</docTy p> <docTy pG c="1100">E Q U ITY</docTy pG > <cntry c="C A N ">C anada</cntry > <cntry c="U S A ">U nited S tates</cntry > <crncy c="U S D">U .S . Dollar</crncy > <grp uid="70005269">1</grp> <grp uid="70005418">4</grp> <langDesc lang="en" rfc1766="en">E nglish</langDesc> <ctS ubjectsResp c="">M XC O </ctS ubjectsResp> <disciplinesResp c="">DIS _F U N D</disciplinesResp> <rptS ty lesResp c="">RP T_C O </rptS ty lesResp> < Restr iction underRestriction="0" underRev iew ="0" underE xtendedRev iew ="0"/> </diDef> <diDef ... </diDef> </DocS earch_Request_1> </Body > </E nv elope>

Attribute diDef releaseDate submitDate arriveDate prtID reg Restriction

Description Each <diDef/> element contains all the metadata for a document matching the search criteria. Each document metadata includes <releaseDate>, <submitDate>, and <arriveDate>. For more information, see section Understanding Document Dates and Ordering. Documents about a particular company are tagged by ticker and Thomson Reuters identifier or parent ID (MXID). For additional information, see section Searching for Documents about a Particular Company. Additional contributed metadata includes region, and language, for example. The TRKD API can be configured to return restriction information about documents.

11.4.1 Understanding Document Dates and Ordering

Each document metadata includes <releaseDate>,< submitDate>, and <arriveDate>. releaseDate The date the contributor specifies upon contribution. releaseDate is the only date the contributor can actually declare. The date is simply the declared, unadjusted publication date of the document and should agree with the publication date in the document. This is the date used by all searches except "newSubmissions" search. You should assume this date is in GMT format, however, contributors can use another date/time format if they choose. submitDate The date and time, in GMT format, Thomson Reuters actually received the document. arriveDate Also known as "update date". The date and time, in GMT format, when insertion occurs into the master SQL database - that is, contribution is complete and the document is available. This is the date used by a "newSubmissions" search. Note that newSubmissions is, by default, 1 day back. You can use the bbDaysBack element to change this range. For example, <bbDaysBack>2</bbDaysBack> defines newSubmissions as 2 days back.

Document Search

175

11.5

Samples of Document Search Requests

This section contains samples of requests available in the TRKD API for searching for documents. These requests are: Document IDs (DocIDs_1): Retrieves document IDs. Document Information (DocInfo_1): Retrieves information about a specific document. Document Search (DocSearch_1): Searches for a document using various criteria. Documents Count (DocCount_1): Shows the number of documents that match search criteria. Document Summary (DocSummary_1): Retrieves the document summary. Fts Document IDs (FtsDocIDs_1): Retrieves Document IDs using full text search. Fts Documents Count (FtsDocCount_1): Shows the number of documents that match full text search criteria. Fts Documents Search (FtsDocSearch_1): Performs a full text search for a document using various criteria. Batch Request (Batch_1): Can perform a request that can include several document search requests seen above in one call. Search Keyword (DocSearchKeyword_1): Retrieves the context in which a search term appears (i.e. the 20 words either side of the search term). Table of Contents (DocTableOfContents_1): Retrieves a table of contents for the research report. Currently, Document Search requests are divided into two groups: Structured searches that apply DocID parameters but do not apply matchStr parameter; Full Text Searches (with the prefix FTS) that apply matchStr parameter but do not apply DocID parameters.

11.5.1 Document IDs (DocIDs_1)

The DocIDs_1 request is used to retrieve document IDs. The example below shows how to retrieve document IDs for new submissions. XML Sample Request - Retrieving Document IDs
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2008/01/12/DocS earch_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/DocS earch_1/ DocIDs_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <DocIDs_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/DocS earch_1" dateRange=" newSubmissions " /> </Body > </E nv elope>

XML Sample Response - Retrieving Document IDs

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/ rkd/DocS earch_1/DocIDs_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <DocIDs_Response_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/DocS earch_1"> <id>41958041</id> <id>41958038</id> <id>41958017</id> <id>41958003</id> ... <id>41957041</id>

176

TRKD API Developer's Guide

<id>41957036</id> <id>41957030</id> </DocIDs_Response_1> </Body > </E nv elope>

11.5.2 Document Information (DocInfo_1)

The DocInfo_1 request is used to retrieve information about a specific document. The example below shows how to retrieve document information of a document with the docID "41737698". XML Sample Request - Retrieving Document Information
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2008/01/12/DocS earch_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/DocS earch_1/ DocInfo_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <DocInfo_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/DocS earch_1" acceptLanguage ="en" calcP r ice ="true" synC har sRequir ed ="350" r eq_id ="345"> <docID>43032783</docID> </DocInfo_Request_1> </Body > </E nv elope>

Attribute calcPrice

Description This indicates whether the response must show document price or not. The possible values are: true false

acceptLanguage This element allows you to retrieve the document in the language you specify.

synCharsRequir This value indicates the synopsis length (in characters) you want to receive in the response. ed req_id docID This value shows ID of the request. This value is the unique Document ID.

XML Sample Response - Retrieving Document Information

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/ rkd/DocS earch_1/DocInfo_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <DocInfo_Response_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/DocS earch_1" req_id="345"> <diDef arriv eDate="2008-07-31T07:03:33" company N ame="A lfa Bank" ctbID="20486" docC lass="M N " docID="43032783" fileE xt="pdf" fileN ame="43032783.pdf" fileS ize="235777" fileTy pe="pdf" hasE arns="false" hasS y n="true" indO v w ="false" pages="16" price="0" releaseDate="2008-07-31T11:02:00" submitDate="2008-07-31T07:03:00" tocE nd="-1" tocS tart="-1" transpRpt="false"> <headline>A LF A BA N K M orning Brief: M acroeconomics, DisC os, Bank F orum, Zaporizhstal</headline> <reg c="E U R">E urope</reg> <regG c="E U R">E urope</regG > <subj c="M RN C ">M O RN IN G C O M M E N TS </subj> <subjG c="M RN C ">M O RN IN G C O M M E N TS </subjG >

Document Search

177

<docTy p c="1120">E Q U ITY- M A RKE T</docTy p> <docTy pG c="1120">E Q U ITY- M A RKE T</docTy pG > <ind c="660">U tilities</ind> <ind c="480">M etals & M inerals</ind> <ind c="170">Banks</ind> <indG c="660">U tilities</indG > <indG c="480">M etals & M inerals</indG > <indG c="170">Banks</indG > <cntry c="U A ">U kraine</cntry > <cntry c="RU S ">Russian F ederation</cntry > <grp uid="70008251">3</grp> <grp uid="70005113">1</grp> <langDesc lang="en" rfc1766="en">E nglish</langDesc> <ctS ubjectsResp uid="120000014">M XC O </ctS ubjectsResp> <disciplinesResp uid="130000002">DIS _F U N D</disciplinesResp> <reasonsResp uid="140000001">RE A _C O M M </reasonsResp> <rptS ty lesResp uid="150000002">RP T_C O </rptS ty lesResp> <sy nopsis>Russian M arket M arket C omment, Looking to build on the bounce The rebound in oil and resilient U S markets suggest a continuation of y esterday s bounce on the local market. The preliminary reading of second-quarter U S G DP and initial jobless claims w ill then set the tone of trade in the late afternoon. Top S tories M acroeconomics: C P I likely to re</sy nopsis> </diDef> </DocInfo_Response_1> </Body > </E nv elope>

11.5.3 Documents Count (DocCount_1)

The DocCount_1 request shows the number of documents that match the specified search criteria. The example below retrieves the document count for documents marked with country name (USA) in new submissions. XML Sample Request - Retrieving Documents Count
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2008/01/12/DocS earch_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/DocS earch_1/ DocC ount_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <DocC ount_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/DocS earch_1" dateRange=" newSubmissions "> <countr y>USA </countr y> </DocC ount_Request_1> </Body > </E nv elope>

XML Sample Response - Retrieving Documents Count

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/ rkd/DocS earch_1/DocC ount_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <DocC ount_Response_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/DocS earch_1"> <count>247</count> </DocC ount_Response_1> </Body > </E nv elope>

178

TRKD API Developer's Guide

11.5.4 Documents Search (DocSearch_1)

The DocSearch_1 request is used to search for a document using various criteria. The following example shows how to search for a document with the docID 41737709. XML Sample Request - Performing Document Search
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2008/01/12/DocS earch_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/DocS earch_1/ DocS earch_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <DocS earch_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/DocS earch_1"> <docID> 4 1 7 3 7 7 0 9 </docID> </DocS earch_Request_1> </Body > </E nv elope>

Note: Please note that the <excludeRixmlDocs> attribute found in Request Modifiers is not currently used. It is reserved for future development. The complete list of all available parameters that can be used in a DocSearch_1 request can be found in the DocSearch_1 Request Parameters section at the end of this chapter. Note: The parameter acceptLanguage="en" does not perform search by documents in English, but returns response with the elements values in English (if there are any). To search for the document in English use the <langID> parameter. XML Sample Response - Performing Document Search
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/ rkd/DocS earch_1/DocS earch_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <DocS earch_Response_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/DocS earch_1"> <diDef arriv eDate="2008-02-27T11:01:22" company N ame="Ibersecurities" ctbID="8707" docC lass="M R" docID="41737709" fileE xt="pdf" fileN ame="41737709.pdf" fileS ize="173169" fileTy pe="pdf" hasE arns="false" hasS y n="true" indO v w ="false" localC ode="3052" pages="14" price="0" releaseDate="2008-02-27T06:00:00" submitDate="2008-02-27T11:01:00" tocE nd="-1" tocS tart="-1" transpRpt="false"> <headline>IBE RIA N DA ILY 27 F E BRU A RY (IBE RS E C U RITIE S S V )</headline> <pTkr prtID="100005771">A C X=E S </pTkr> <tkr prtID="100005771">A C X=E S </tkr> <author c="16C L">N icolas F ernandez</author> <author c="3P U 8">A gustin A lberti</author> <author c="41E 8">Jean Baptiste Bruny </author> <author c="421K">Laura Benito</author> <author c="3X7G ">M ara C ebollero</author> <author c="1S D7">G len S . C hapman</author> <author c="3O Q 6">Jesus Dominguez</author> <author c="3X7F ">C lara E spino</author> <author c="3X7D">Jav ier E steban</author> <author c="421L">M anuel G allego</author> <author c="3O P T">Jorge G onzalez</author> <author c="41E 4">Leon Izuzquiza</author> <author c="3F S 8">M ario Lodos</author>

Document Search

179

<author c="3X7C ">F rancisco Rodrguez</author> <author c="3X7E ">Ignacio Romero</author> <author c="421M ">Beatrix Tejero</author> <reg c="E U R">E urope</reg> <reg c="E RL">E uroland</reg> <regG c="E U R">E urope</regG > <regG c="E RL">E uroland</regG > <subj c="C O M ">C O M P A N Y U P DA TE </subj> <subjG c="C O M ">C O M P A N Y U P DA TE </subjG > <docTy p c="1100">E Q U ITY</docTy p> <docTy pG c="1100">E Q U ITY</docTy pG > <cntry c="E S P ">S pain</cntry > <grp uid="70001276">2</grp> <grp uid="70001187">1</grp> <langDesc lang="en" rfc1766="en">E nglish</langDesc> <ctS ubjectsResp uid="120000020">M XC O F N </ctS ubjectsResp> <ctS ubjectsResp uid="120000014">M XC O </ctS ubjectsResp> <disciplinesResp uid="130000002">DIS _F U N D</disciplinesResp> <reasonsResp uid="140000010">RE A _P E R</reasonsResp> <rptS ty lesResp uid="150000002">RP T_C O </rptS ty lesResp> </diDef> </DocS earch_Response_1> </Body > </E nv elope>

11.5.5 Documents Summary (DocSummary_1)

The DocSummary_1 request is used to retrieve document summary. The following example shows how to retrieve document summary for the specified docID. XML Sample Request - Retrieving Document Summary
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2008/01/12/DocS earch_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/DocS earch_1/ DocS ummary _1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <DocS ummary _Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/DocS earch_1"> <docID> 4 1 7 3 7 7 0 9 </docID> </DocS ummary _Request_1> </Body > </E nv elope>

XML Sample Response - Retrieving Document Summary

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/ rkd/DocS earch_1/DocS ummary _1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <DocS ummary _Response_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/DocS earch_1"> <ctbS um company ID=" 8 7 0 7 " company N ame="Ibersecurities" mnC nt="0" mrC nt="1" /> </DocS ummary _Response_1> </Body > </E nv elope>

180

TRKD API Developer's Guide

11.5.6 Fts Document IDs (FtsDocIDs_1)

The FtsDocIDs_1 request is used to retrieve document IDs using full text search. The following example shows how to perform a full text search for document IDs in new submissions for the last two days where text contains 'microsoft'. XML Sample Request - Retrieving Fts Document IDs
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2008/01/12/DocS earch_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/DocS earch_1/ F tsDocIDs_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <F tsDocIDs_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/DocS earch_1" dateRange=" newSubmissions "> <bbDay sBack> 2 </bbDay sBack> <matchS tr relev ance="1" strS rc="text"> micr osoft</matchS tr> </F tsDocIDs_Request_1> </Body > </E nv elope>

XML Sample Response - Retrieving Fts Document IDs

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/ rkd/DocS earch_1/F tsDocIDs_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <F tsDocIDs_Response_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/DocS earch_1"> <id>41949954</id> <id>41949963</id> ... <id>41956623</id> <id>41956648</id> </F tsDocIDs_Response_1> </Body > </E nv elope>

Note: Full Text Search supports only Roman characters . Other characters like Cyrillic, Arabic, hieroglyphs are ignored in Document Search service.

11.5.7 Fts Documents Count (FtsDocCount_1)

The following example shows how to perform a full text search for documents containing the specified data. XML Sample Request - Retrieving Fts Documents Count
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2008/01/12/DocS earch_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID>

Document Search

181

<A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/DocS earch_1/ F tsDocC ount_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <F tsDocC ount_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/DocS earch_1" dateRange=" newSubmissions "> <matchS tr relev ance="1"> Y ahoo </matchS tr> </F tsDocC ount_Request_1> </Body > </E nv elope>

XML Sample Response - Retrieving Fts Documents Count

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/ rkd/DocS earch_1/F tsDocC ount_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <F tsDocC ount_Response_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/DocS earch_1"> <count>2</count> </F tsDocC ount_Response_1> </Body > </E nv elope>

Note: Full Text Search supports only Roman characters . Other characters like Cyrillic, Arabic, hieroglyphs are ignored in Document Search service.

11.5.8 Fts Documents Search (FtsDocSearch_1)

FtsDocSearch_1 request is used to perform a full text search for a document using various criteria. Note: Full Text Search supports only Roman characters . Other characters like Cyrillic, Arabic, hieroglyphs are ignored in Document Search service. The following example shows how to perform a full text search for a document containing the "Egypt Market Review" phrase. XML Sample Request - Performing Fts Document Search
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2008/01/12/DocS earch_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/DocS earch_1/ F tsDocS earch_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <F tsDocS earch_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/DocS earch_1"> <matchS tr strS rc="text"> "Egypt M ar ket Review"</matchS tr> </F tsDocS earch_Request_1> </Body > </E nv elope>

The request returns the following information:

182

TRKD API Developer's Guide

XML Sample Response - Performing Fts Documents Search

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/ rkd/DocS earch_1/F tsDocS earch_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <F tsDocS earch_Response_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/DocS earch_1"> <diDef arriv eDate="2008-03-24T14:28:05" company N ame="H C Brokerage" ctbID="29328" docC lass="M R" docID="41958309" fileN ame="41958309.pdf" fileS ize="182850" fileTy pe="pdf" hasE arns="false" indO v w ="false" price="0" releaseDate="2008-0324T10:27:00" submitDate="2008-03-24T14:28:00" tocE nd="-1" tocS tart="-1" transpRpt="false" fileE xt="pdf" hasS y n="true" localC ode="2512" pages="4" relev ance="293"> <headline>H C Brokerage: E gy pt M arket Rev iew M arch 24 2008</headline> <tkr prtID="100103804">WC DF =E G </tkr> ... <tkr prtID="100211386">O RTE =E G </tkr> <tkr>O RH D=E G </tkr> ... <tkr>=U S </tkr> <author c="3M 4Y">N emat A llah C houcri</author> <author c="40KQ ">H atem A laa</author> <reg c="M S T ">M iddle E ast</reg> <regG c="M S T ">M iddle E ast</regG > <subj c="RA T ">RA TIN G S C H A N G E S </subj> <subj c="P RC ">P RIC E </subj> <subj c="O P R ">O P E RA TIN G RE S U LTS </subj> <subj c="E P S ">E S TIM A TE C H A N G E S </subj> <subjG c="RA T ">RA TIN G S C H A N G E S </subjG > <subjG c="P RC ">P RIC E </subjG > <subjG c="O P R ">O P E RA TIN G RE S U LTS </subjG > <subjG c="E P S ">E S TIM A TE C H A N G E S </subjG > <docTy p c="1010">E C O N O M IC S </docTy p> <docTy pG c="1010">E C O N O M IC S </docTy pG > <ind c="660">U tilities</ind> ... <indG c="235">C onsumer</indG > <cntry c="E G Y ">E gy pt</cntry > <grp uid="70007531">1</grp> <langDesc rfc1766="en" lang="en">E nglish</langDesc> <ctS ubjectsResp uid="120000034">M XE C </ctS ubjectsResp> <ctS ubjectsResp uid="120000013">M XC N </ctS ubjectsResp> <disciplinesResp uid="130000002">DIS _F U N D</disciplinesResp> <reasonsResp uid="140000001">RE A _C O M M </reasonsResp> <rptS ty lesResp uid="150000006">RP T_E C O N </rptS ty lesResp> </diDef> </F tsDocS earch_Response_1> </Body > </E nv elope>

Note: If the <maxRowsToAbort> attribute is set bigger than 2000, then system will reset it to 2000 (max value handled by system). If the number of records to be returned is greater than <maxRowsToAbort>, system will respond with 'DocSearch_TooGeneric' RKD fault. For example, if you have specified the following criteria XML Sample
<maxRow sToA bort=500 and maxRow s=50

keep in mind that the <maxRows> attribute is only for paging, which means that if 400 records satisfy the specified criteria then system will send back only 50 records. But if 600 records satisfy the specified criteria, you will receive a "too much data" exception. Some tips on Fts Document Search: To search headline only use the following:

Document Search

183

XML Sample
<matchS tr strS rc="hdln">qw erty </matchS tr>

To search both text and headline use the following: XML Sample
<matchS tr strS rc="text">qw erty </matchS tr> <matchS tr strS rc="hdln">qw erty </matchS tr>

To search in the text use the following: XML Sample

<matchS tr strS rc="hdln">qw erty </matchS tr>

All searches go against Fulcrum, even headlines searches. When search goes against Fulcrum it retrieves a vector of document ids that satisfy the given criteria. All document attributes (including cat codes) are taken from SQL Server using the vector of docids retrieved from the Fulcrum.

11.5.9 Batch Request (Batch_1)

The Batch_1 request is used to perform a request that can include several document search requests in one call. This sample query batches three requests for retrieving information for the documents with the following docIDs: 41737698, 41737704 and 41736916. XML Sample Request - Batch Request
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2008/01/12/DocS earch_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/DocS earch_1/ Batch_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <Batch_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/DocS earch_1"> <DocInfo_Request_1 calcP rice="false" sy nC harsRequired="1"> <docID> 4 1 7 3 7 6 9 8 </docID> </DocInfo_Request_1> <DocInfo_Request_1> <docID> 4 1 7 3 7 7 0 4 </docID> </DocInfo_Request_1> <DocInfo_Request_1 acceptLanguage="en" calcP rice="true" sy nC harsRequired="0"> <docID> 4 1 7 3 6 9 1 6 </docID> </DocInfo_Request_1> </Batch_Request_1> </Body > </E nv elope>

The following query batches two requests for retrieving document summary and document count. XML Sample Request - Batch Request
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2008/01/12/DocS earch_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/DocS earch_1/ Batch_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/C ommon_1">

184

TRKD API Developer's Guide

<A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <Batch_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/DocS earch_1"> <DocS ummary _Request_1 dateRange="today " req_id="1" /> <DocC ount_Request_1 dateRange="today " req_id="2" /> </Batch_Request_1> </Body > </E nv elope>

XML Sample Response - Batch Request

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/ rkd/DocS earch_1/Batch_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <Batch_Response_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/DocS earch_1"> <DocS ummary _Response_1 req_id="1"> <ctbS um company ID="39612" company N ame="A bu Dhabi Inv estment C ompany (A DIC )" mnC nt="0" mrC nt="1"></ctbS um> <ctbS um company ID="29444" company N ame="A ffin S ecurities S dn. Bhd." mnC nt="0" mrC nt="4"></ctbS um> <ctbS um company ID="19717" company N ame="A izaw a S ecurities C o., Ltd" mnC nt="0" mrC nt="1"></ctbS um> <ctbS um company ID="34730" company N ame="A L H abib C apital M arkets (P riv ate) Limited" mnC nt="1" mrC nt="0"></ctbS um> <ctbS um company ID="20486" company N ame="A lfa Bank" mnC nt="1" mrC nt="0"></ctbS um> <ctbS um company ID="37792" company N ame="A lpha F inance Romania S .A " mnC nt="1" mrC nt="0"></ctbS um> <ctbS um company ID="22229" company N ame="A qeel Karim Dhedhi S ecurities (P v t) Ltd" mnC nt="0" mrC nt="1"></ctbS um> <ctbS um company ID="8358" company N ame="A rab M alay sia S ecurities S dn Bhd" mnC nt="0" mrC nt="7"></ctbS um> <ctbS um company ID="19080" company N ame="A TR-Kim E ng S ecurities Inc." mnC nt="0" mrC nt="1"></ctbS um> ... <ctbS um company ID="31769" company N ame="TA IB S ecurities W.L.L" mnC nt="0" mrC nt="1"></ctbS um> <ctbS um company ID="5706" company N ame="Theodoor G ilissen S ecurities" mnC nt="0" mrC nt="2"></ctbS um> <ctbS um company ID="20981" company N ame="Thomson S treetE v ents" mnC nt="0" mrC nt="17"></ctbS um> <ctbS um company ID="30254" company N ame="Tong Yang S ecurities" mnC nt="2" mrC nt="9"></ctbS um> <ctbS um company ID="35007" company N ame="U O B Kay H ian S ecurities (Thailand) P ublic C ompany Limited" mnC nt="0" mrC nt="4"></ctbS um> <ctbS um company ID="41335" company N ame="V iet C apital S ecurities Joint S tock C ompany (V C S C )" mnC nt="1" mrC nt="0"></ ctbS um> <ctbS um company ID="4394" company N ame="Wilson H TM Ltd., A ustralia" mnC nt="0" mrC nt="7"></ctbS um> <ctbS um company ID="19919" company N ame="Wolfgang S teubing A G " mnC nt="0" mrC nt="1"></ctbS um> <ctbS um company ID="14236" company N ame="Wood &amp; C ompany " mnC nt="0" mrC nt="1"></ctbS um> <ctbS um company ID="17150" company N ame="Woori Inv estment &amp; S ecurities" mnC nt="0" mrC nt="2"></ctbS um> <ctbS um company ID="22482" company N ame="Yuanta Inv estment C onsulting" mnC nt="0" mrC nt="1"></ctbS um> </DocS ummary _Response_1> <DocC ount_Response_1 req_id="2"> <count>359</count> </DocC ount_Response_1> </Batch_Response_1> </Body > </E nv elope>

11.5.10 Search Keyword (DocSearchKeyword_1)

A keyword search returns headlines and other metadata for documents containing the specific text. In addition, to allow your users to see how the search text appears in the document, you can use the DocSearchKeyword_1 request to return page numbers and context snippets associated with the search text. First, use the FtsDocSearch_1 request to find documents containing the search text. For example: XML Sample Request - Searching for Documents
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope">

Document Search

185

<H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2008/01/12/DocS earch_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/DocS earch_1/ F tsDocS earch_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <F tsDocS earch_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/DocS earch_1" maxRow s="1" dateRange="new S ubmissions"> <matchS tr>Eur ope </matchS tr> </F tsDocS earch_Request_1> </Body > </E nv elope>

For these documents, use the docID and the same search text for the DocSearchKeyword_1 request: XML Sample Request - Document Keyword Search
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2008/01/12/DocS earch_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/DocS earch_1/ DocS earchKey w ord_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <DocS earchKey w ord_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/DocS earch_1" searchM ethod="any Key w ord"> <docId> 4 6 9 9 3 9 1 6 </docId> <searchText> Eur ope </searchText> </DocS earchKey w ord_Request_1> </Body > </E nv elope>

The following searchMethods are available: All keywords, Any keyword and Entire phrase. TRKD API returns page numbers and context snippets. For example: XML Sample Response - Document Keyword Search
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/ rkd/DocS earch_1/DocS earchKey w ord_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <DocS earchKey w ord_Response_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/DocS earch_1"> <Key w ordS earchResult> <P age no="21"> <Text>10036- 8293 U nited S tates Tel: + 1 ( 1) 212 761 4000 E urope 20 Bank S treet, C anary Wharf London E 14 4A D</Text> </P age> </Key w ordS earchResult> </DocS earchKey w ord_Response_1> </Body > </E nv elope>

186

TRKD API Developer's Guide

11.5.11 Table of Contents (DocTableOfContents_1)

Another feature offered by TRKD API is the ability to retrieve a document's TOC (Table of Contents). A Document ID of the document being searched for is required to retrieve the TOC. You can use this request to retrieve a table of contents for the research report before downloading it. Note: TOC page numbering starts from 0. The following example shows how to search for a document with the docID 46993916. XML Sample Request - Retrieving Table of Contents
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2008/01/12/DocS earch_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/DocS earch_1/ DocTableO fC ontents_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <DocTableO fC ontents_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/DocS earch_1"> <docID> 4 6 9 9 3 9 1 6 </docID> </DocTableO fC ontents_Request_1> </Body > </E nv elope>

The response returns the following information: XML Sample Response - Retrieving Table of Contents
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/ rkd/DocS earch_1/DocS earch_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <DocTableO fC ontents_Response_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/DocS earch_1"> <TableO fC ontents docID="46993916" ctbID="2975" pages="22"> <headline>Japan E conomics: Japan Briefing (N ov 2-13): E ntering S oft P atch A mid M ixed Data</headline> <titem page="3"> <tl>Bank Lending &amp; M oney S tock (O ctober) N ov ember 10, 2009</tl> </titem> <titem page="6"> <tl>E conomy Watchers S urv ey (O ctober) N ov ember 10, 2009</tl> </titem> <titem page="9"> <tl>M achinery O rders (S eptember Results, O ct-Dec O utlook) N ov ember 11, 2009</tl> </titem> <titem page="16"> <tl>E conomic Data C alendar: N ov 16-20: G DP , TIA I, A IA I</tl> <titem page="16"> <tl>M ain E conomic Indicator C alendar</tl> </titem> <titem page="16"> <tl>M ain E conomic E v ents</tl> </titem> <titem page="17"> <tl>Key E conomic Data F orecast</tl> </titem> <titem page="19"> <tl>M ain E conomic Indicators</tl> </titem> </titem>

Document Search

187

<titem page="20"> <tl>F orecast S ummary S eptember 11, 2009</tl> </titem> </TableO fC ontents> </DocTableO fC ontents_Response_1> </Body > </E nv elope>

Attribute headline titem tl

Description Contains the headline of the document. Contains the attribute "page" that indicates the page of the TOC item in the document. It also contains the element <tl>. The heading of the item in the table of contents.

11.5.12 DocSearch_1 Request Parameters

The table below lists all available request parameters for the DocSearch_1 request. Parameter docID ctbDocIDs langID bbDaysBack Description Contains unique Documents ID. Contains Contributor Document ID. Language identifier. To search for the document in a specific language use the <langID> parameter. Shows the count of days that dataRange should run back. Note that newSubmissions is, by default, 1 day back. You can use the bbDaysBack element to change this range. For example, <bbDaysBack>2</bbDaysBack> defines newSubmissions as 2 days back. Auxiliary data. In some cases, contributors need to tag contributed documents with data that does not fit in the standard set (ticker, industry, analyst, and others); for example, there may be documents referring to a particular event. Thomson Reuters includes this contributor specific data as auxiliary data. To search for documents tagged with particular auxiliary data, use the <auxData/> element. For example, to search for Multex Research Desk (contributor 20780) documents tagged with auxiliary code 555. Specifies the identifier of document type. Available IDs: 1(PDF), 2(TEXT), 3(EXCEL), 4(WEBSITE), 5 (URL) and other. pagingHint: By specifying the hintStr and docID of the last record on the previous page you are able to retrieve the next page. hintStr should contain values defined by the following rules: If you sort by date and the query is newSubmissions, then hintStr= arriveDate of the last doc in the previous query, formatted time_t (# of seconds since 01/01/1970). For any other query sorted by date, hintStr = releaseDate of the last doc in the previous query, formatted time_t (# of seconds since 01/01/1970). If you sort by primaryTicker, then hintStr = pTck of the last doc in the previous query. If you sort by pages, then hintStr = pages of the last doc in the previous query. You can also use <dateRange>=customDate along with <dateFrom>YYYY-MM-DD</dateFrom> and <dateTo>YYYY-MM-DD</dateTo> to specify a custom range. You can also use <dateRange>=customDate along with <dateFrom>YYYY-MM-DD</dateFrom> and <dateTo>YYYY-MM-DD</dateTo> to specify a custom range. The sort element allows you to control how the document headlines are sorted. The <s_c> attribute allows you to sort by date, score, pages, and the primary ticker. The <s_d> attribute allows you to control whether the document headlines are sorted in ascending or descending order. True/False (include/exclude contributors). Use the <excludeCtbs/> and <ctbs/> elements to include or exclude contributors. The <excludeCtbs>1</excludeCtbs> elements cause the query to exclude the contributors in <ctbs/>. To designate multiple contributors, use a comma separated list inside <ctbs/>. This value determines the category of contributors. The possible values are: brokers independents allCtbs The possible actions are: include

auxData

finalCtbType pagingHint

dateFrom dateTo sort

excludeCtbs ctbs

ctbsm

188

TRKD API Developer's Guide

ticker docType

analystSet

analyst

industrySet industry subjectSet subject bSubjects

regionSet region country currencies categorySet category ctSubjects

disciplines

reasons

rptStyles

dateRange

exclude3rdParty maxRows ppv tkrEncoding

tkrPrimary

exclude For example: <ctbsm category="allCtbs" action="exclude">20780</ctbsm>. This shows company's ticker. The SEDOLs, CUSIPs, and symbols that are to be used by the symbology server to obtain the MXIDs. Type of document. Available values: R Market research and MN morning note. Response contains attribute docClass that return: - MR if docType = R - MN if docType = MN Many contributors have their own designations for analysts, industries, subjects, regions, and categories. You can use these local codes by first specifying the code set. To specify an analyst code set, use the alpha numeric set code. For example, to use local contributor analyst codes from the fictitious Acme Inc. (AI#001), use <analystSet>AI#001</analystSet> <analysts>ABC</analysts>. Many contributors have their own designations for analysts, industries, subjects, regions, and categories. You can use these local codes by first specifying the code set. To specify an analyst code set, use the alpha numeric set code. For example, to use local contributor analyst codes from the fictitious Acme Inc. (AI#001), use <analystSet>AI#001</analystSet> <analysts>ABC</analysts>. This value indicates the industry code. Specifies an industry. This value specifies the subject code by which the search must be made. This specifies the document subject to be searched for. bSubjects values allow applications to use AND with subject codes. That is, to OR subject codes, use. For example: <subject>code1</subject> <bSubject>code2</bSubject> Applications should never send <bSubject/> without at least one <subject/>. This value specifies the region code. Specifies a region. This determines the country code. This determines currency codes to be used during the search. This specifies the category code. Specifies a category. During the contribution process Thomson Reuters automatically categorizes documents based on CtSubjects Criteria. You can use the Reference Information service to generate a list of the discipline categories. During the contribution process Thomson Reuters automatically categorizes documents based on types of analysis (disciplines). You can use the Reference Information service to generate a list of the discipline categories. During the contribution process Thomson Reuters automatically categorizes documents based on the research purpose (reasons). You can use the Reference Information service to generate a list of the research purposes. Search for industry reports. During the contribution process Thomson Reuters automatically categorizes documents based on Report Style. You can use the Reference Information service to generate a list of the industry reports. The date range of the document headlines to be returned. For a newSubmissions search, the TRKD API selects documents based on the date that the documents arrived at Thomson Reuters (arriveDate). For other searches, the TRKD API uses the release date contributed by the client (releaseDate). True/False. The maximum number of document headlines to returned. Thomson Reuters categorizes documents based on pay per view type. The available types are free, ppv, premium, free_ppv, free_premium, ppv_premium, all. The <ticker> element is used in combination with the "tkrEncoding" attribute. The following algorithm is used in the TRKD API: If tkrEncoding = tkr then <ticker> is symbol (IBM=US for example); If tkrEncoding = prtID then <ticker> is parent ID (or issuer ID (MXID) in other words, 100085757 for example). True/False. Documents have numerous tickers associated with them. One of the tickers may be

Document Search

189

useCtbSetCodes exludeRixmlDocs acceptLanguage calcPrice synCharsRequired req_id bShowPrims timeFrom timeTo NumPagesFrom NumPagesTo FileSizeFrom FileSizeTo

designated the primary ticker. When this attribute is set to "1", the TRKD API will only match against the primary ticker. Otherwise, it will match against any ticker associated with the document. Use the useCtbSetCodes attribute to specify the contributor set codes to use for all criteria. True/False. True/False. This element allows you to retrieve the document in the language you specify. True/False. This indicates whether the response must show document price or not. This value indicates the synopsis length (in characters) you want to receive in the response. This value shows ID of the request. True/False. This attribute allows users to specify whether all primary symbols should be returned in the response. This element <timeFrom>hh:mm:ss</timeFrom> allow a user to search by time interval in case of custom date range. This element <timeTo>hh:mm:ss</timeTo> allow a user to search by time interval in case of custom date range. This attribute allow a user to search by number of pages in the document. This attribute allow a user to search by number of pages in the document. This attribute allow a user to search by file size of the document. This attribute allow a user to search by file size of the document.

11.6

Searching for Documents from Particular Contributors

The following categories are available in TRKD API to use when searching for contributors: brokers , independents and allCtbs and you may use either "include " or "exclude " action with them. The Document Search service puts restrictions on "ctbsm " elements allowing only one element for any category. Each element puts some restriction on the contributors. The final result set is an intersection of all result sets for each element available for the current user entitlements. When the element has an exact category it means that there is a restriction on the contributors within the same category only, so the result includes all other contributors. The element string values can contain comma-separated contributor IDs or be empty. The empty value means all contributors within the same category will be included/excluded according to the action attribute. When the contributors category is specified (brokers or independents), then it is checked (whether it is it a broker or independent) and if it doesn't match the specified criteria the application returns an error. You can limit your document search to research from a particular contributor or several contributors. You can also exclude one or more contributors from your search. You will need the numeric contributor ID to include or exclude contributors. See chapter Reference Information for more information about generating data about the contributors you are entitled to. Use necessary contributors category and "include" or "exclude" actions to include or exclude contributors. For example, the following query excludes Multex Research Desk (contributor 20780): XML Sample Request - Excluding Contributors
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2008/01/12/DocS earch_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/DocS earch_1/ DocS earch_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <DocS earch_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/DocS earch_1" dateRange="new S ubmissions" maxRow s="20"> <ctbsm categor y="allC tbs " action="exclude">2 0 7 8 0 </ctbsm> </DocS earch_Request_1> </Body >

190

TRKD API Developer's Guide

</E nv elope>

To include only documents from a particular contributor, use the <action="include"> element in the query. The following query shows how to search for documents from a single contributor: XML Sample Request - Searching for Documents from a Single Contributor
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/DocS earch_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/DocS earch_1/ DocS earch_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <DocS earch_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/DocS earch_1" dateRange="new S ubmissions" maxRow s="20"> <ctbsm category =" allC tbs " action="include"> 2 0 7 8 0 </ctbsm> </DocS earch_Request_1> </Body > </E nv elope>

To designate multiple contributors, use a comma separated list inside <ctbsm/>. For example, the following query excludes both Multex Research Desk (contributor 20780) and Multex Estimates (contributor 17459): XML Sample Request - Excluding Multiple Contributors
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2008/01/12/DocS earch_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/DocS earch_1/ DocS earch_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <DocS earch_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/DocS earch_1" dateRange="new S ubmissions" maxRow s="20"> <ctbsm category =" allC tbs " action=" exclude "> 2 0 7 8 0 ,1 7 4 5 9 </ctbsm> </DocS earch_Request_1> </Body > </E nv elope>

Most manipulations can be done in different ways. For example, each of the following three elements
<ctbsm category =brokers action=include/> <ctbsm category =independents action=include /> <ctbsm category =allC tbs action=include />

means the same and there is no restriction on contributors at all. The element <ctbsm category=brokers action=exclude>2345</ctbsm> means all brokers except selected and all independents, but it is different from <ctbsm category=allCtbs action=exclude>2345</ctbsm>. The application checks whether the contributor with the specified id is a broker and returns an error, if not - the result set will be the same. The element <ctbsm category=brokers action=include>2345</ctbsm> means that just one broker and all independent will be selected. Note: The overall result depends on current user entitlements, so no document would be included in the response result if

Document Search

191

the document group does not include current user entitlements. Note: Another way to put restriction on contributor search is by using elements <ctbs>, <exclude3rdParty> and <excludeCtbs> in the Document Search service. However, Thomson Reuters DOES NOT recommend using them when searching for documents. You may not combine these elements with the elements described above, doing so will result in a response containing an error: Incorrect Request
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2008/01/12/DocS earch_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/DocS earch_1/ DocInfo_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <F tsDocIDs_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/DocS earch_1" dateRange="allDates" exclude3rdP arty ="true" maxRow s="3"> <excludeC tbs>true</excludeC tbs> <ctbs>10642</ctbs> <ctbsm category ="brokers" action="exclude">10642</ctbsm> <ctbsm category ="independents" action="exclude" /> <matchS tr>food</matchS tr> </F tsDocIDs_Request_1> </Body > </E nv elope>

XML Response
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/ rkd/DocS earch_1/F tsDocIDs_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <F tsDocIDs_Response_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/DocS earch_1"> <F ault> <faultcode>soap:S erv er</faultcode> <faultstring>S earch failed</faultstring> <detail> <DefaultTornadoF ault_1 xmlns="http://schemas.reuters.com/ns/2005/08/infrastructure/faults"> <Description>searches_1_doer::search failed: inv alid contributors manipulation</Description> </F tsDocIDs_Response_1> </Body > </E nv elope>

11.7

Searching for Documents about a Particular Company

You can limit your document search to research about a particular companies by specifying that company in the request. You can specify the company by specific ticker, Thomson Reuters identifier, or by using the Search symbology service to resolve tickers to Thomson Reuters identifiers.

11.7.1 A Word about Tickers

When documents are delivered to Thomson Reuters by contributors they are associated with a set of tickers. That is,

192

TRKD API Developer's Guide

contributors tag documents with relevant tickers. A ticker is represented by a text field and can contain keywords that are only relevant to the contributor - there is no common standard enforced by Thomson Reuters about what contributors should place in the ticker field. The best way to accurately search for a document is to use the Search service. The <ticker> element is used in combination with the "tkrEncoding" attribute. The following algorithm is used in the TRKD API: If tkrEncoding = tkr then <ticker> is symbol (IBM=US for example); If tkrEncoding = prtID then <ticker> is parent ID (or issuer ID (MXID) in other words, 100085757 for example). All documents are associated with a set of Thomson Reuters identifiers, referred to as MXIDs. Unlike tickers, which can be ambiguous, each MXID uniquely identifies a company. You can use the Search service to obtain the MXID by providing a variety of information such as company names, symbols, SEDOLs, CUSIPs, for example.

11.7.2 Searching by Tickers

Note: It is recommended to use MXID when searching for documents. When you perform document search by a ticker (for example, IBM), Thomson Reuters Search looks for exact match. So, if a contributor tagged the document with "IBM.N" ticker, your search will return no results. See chapter Reuters Search to know how to resolve company symbols/tickers to MXID. The following code example shows a simple query to search by a set of tickers, in this case AMZN and IBM. This query obtains a list of document headlines whose arrival date is classified as a new submission, and whose primary ticker is either AMZN or IBM. This list is sorted by date in descending order and has no more than ten entries. XML Sample Request - Searching by Tickers
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2008/01/12/DocS earch_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/DocS earch_1/ DocS earch_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <DocS earch_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/DocS earch_1" dateRange ="new S ubmissions" maxRows ="10" tkr P r imar y ="1"> < sor t s_c="date" s_d="desc"/> < ticker >A M ZN </ticker> <ticker>IBM </ticker> </DocS earch_Request_1> </Body > </E nv elope>

Attribute dateRange

Description The date range of the document headlines to be returned. For a newSubmissions search, the TRKD API selects documents based on the date that the documents arrived at Thomson Reuters (arriveDate). For other searches, the TRKD API uses the release date contributed by the client (releaseDate). The maximum number of document headlines to returned - in this example a request is for a maximum of 10. Note: Max value for maxRows is 10000. Documents have numerous tickers associated with them. One of the tickers may be designated the primary ticker. When this attribute is set to "1", the TRKD API will only match against the primary ticker. Otherwise, it will match against any ticker associated with the document. The sort element allows you to control how the document headlines are sorted. The <s_c> attribute allows you to sort by date, score, pages, and the primary ticker. The <s_d> attribute allows you to control whether the document headlines are sorted in ascending or descending order. The list of tickers to search on. For additional information about tickers, see section A Word About Tickers.

maxRows tkrPrimary

sort

ticker

Document Search

193

11.8

Complex Keyword Searches

The following table represents available keyword functionality. Typing in the text... DEC DEC & IBM or DEC and IBM DEC IBM DEC & IBM | GE DEC & ( IBM | GE ) "annual report" annual report software & "annual reports" software & ^ spreadsheet Java &^ (coffee | Indonesia) Coca-Cola near/5 PepsiCo Will retrieve documents containing... ...DEC, dec, Dec, etc. ...both DEC and IBM.

DEC | IBM or DEC or IBM ...either DEC or IBM. ...either DEC or IBM. ...either both DEC and IBM, or GE. ...both DEC and either IBM or GE. ...the phrase "annual report". ...either "annual" or "report". ...both the word software and the phrase annual reports. ...software but not spreadsheet. ...java but not coffee or Indonesia. ...Coca-Cola no more than 5 characters away from PepsiCo.

Coca-Cola near PepsiCo. ...Coca-Cola near PepsiCo. (Note: without a number of characters it will default to 64 characters). mer* m?cro Jane's "news of the day" "news & day" ...mer, Merrill, merry, etc. The "*" stands for any number of letters at the end of the word. ...micro, macro, m3cro, etc. The "?" stands for any one letter or digit. ...Jane's. The apostrophe is not treated like a single quote. ...the phrases "news of the day", "news of day", "news day". Words like "of", "the", "and", "in" are excluded from the search. ...the phrases "news & day", "news @ day", "news day". Special characters (not letters or numbers) are regarded as interchangeable.

Note: If the <maxRowsToAbort> attribute is set bigger than 2000, then system will reset it to 2000 (max value handled by system). If the number of records to be returned is greater than <maxRowsToAbort>, system will respond with 'DocSearch_TooGeneric' RKD fault. For example, if you have specified the following criteria XML Sample
<maxRow sToA bort=500 and maxRow s=50

keep in mind that the <maxRows> attribute is only for paging, which means that if 400 records satisfy the specified criteria then system will send back only 50 records. But if 600 records satisfy the specified criteria, you will receive a "too much data" exception.

11.9

Searching by Analyst, Industry, Language, and other Criteria

The <DocSearch_Request_1> elements allow you search to by analyst, industry, language, and many other criteria. For example, to limit the query to documents relevant to the Advertising industry (Reuters industry code 100):

194

TRKD API Developer's Guide

XML Sample Request - Searching by Industry

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2008/01/12/DocS earch_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/DocS earch_1/ DocS earch_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <DocS earch_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/DocS earch_1> <industr ySet>1 0 0 </industr ySet> </DocS earch_Request_1> </Body > </E nv elope>

The example below has more search criteria specified: XML Sample Request - Searching by Analyst, Industry, Language, and other Criteria
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2008/01/12/DocS earch_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/DocS earch_1/ DocS earch_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <DocS earch_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/DocS earch_1> < ctbsm categor y ="brokers" action="include">651651</ctbsm> <ticker>41651</ticker> <analy stS et>gregg</analy stS et> <industry S et>100</industry S et> <subjectS et>reuters</subjectS et> <subject>merger</subject> <bS ubjects>appearance</bS ubjects> <regionS et>europe</regionS et> <country >U K </country > <currencies>U S D </currencies> <category S et>651</category S et> </DocS earch_Request_1> </Body > </E nv elope>

Attribute ctbsm category

ticker industrySet subjectSet subject

Description This value determines the category of contributors. The possible values are: brokers independents allCtbs The possible actions are: include exclude This shows company's ticker. This value indicates the industry code. This value specifies the subject code by which the search must be made. This specifies the document subject to be searched for.

Document Search

195

bSubjects regionSet country currencies categorySet

This value specifies the region code. This determines the country code. This determines currency codes to be used during the search. This specifies the category code.

Note: The parameter acceptLanguage="language_ID" does not make the service search for documents in the specified language, but returns response with the elements values in English (if there are any). To search for the document in a specific language use the <langID> parameter. XML Sample Request - Searching for Documents in English
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2008/01/12/DocS earch_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/DocS earch_1/ DocS earch_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <DocS earch_Request_1 xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema" dateRange="customDate" maxRow s="30" xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/DocS earch_1"> <dateF rom>2009-09-22</dateF rom> <dateTo>2009-09-23</dateTo> <langID>en</langID> </DocS earch_Request_1> </Body > </E nv elope>

11.9.1 Generating the Search Code

Use <GetReferenceInfoRequest/> to generate the codes for analysts, industries, etc. For more information, see chapter Reference Information. For analysts, industries, subjects, regions, and categories, you can construct your queries using either Thomson Reuters (global) codes or contributor (local) codes.

11.9.2 Using Reuters (Global) Codes

By default, the TRKD API document search expects Thomson Reuters (global) codes in the request. For example: <analysts>32F8</analysts> limits the query to a (fictitious) analysts whose global code is 32F8.

11.9.3 Using Contributor (Local) Codes

Many contributors have their own designations for analysts, industries, subjects, regions, and categories. You can use these local codes by first specifying the code set. to specify an analyst code set, use the alpha numeric set code. For example, to use local contributor analyst codes from the fictitious Acme Inc. (AI#001), use <analystSet>AI#001</analystSet> <analysts>ABC</analysts>. to specify an industry, subject, region, or category code set, use the numeric contributor ID. For example, to use the local industry codes from the fictitious Acme Inc. (1), use <industrySet>1</industrySet> <industries>XYZ</industries> Note: Use a <GetContributorInfoRequest> to determine the contributor code set designation. For information about <GetContributorInfoRequest>, see chapter Reference Information.

196

TRKD API Developer's Guide

Note: As an alternate syntax, use the useCtbSetCodes attribute to specify the contributor set codes to use for all criteria.

11.10 Searching by Additional Contributor Specific Data

In some cases, contributors need to tag contributed documents with data that does not fit in the standard set (ticker, industry, analyst, and others); for example, there may be documents referring to a particular event. Thomson Reuters includes this contributor specific data as auxiliary data. To search for documents tagged with particular auxiliary data, use the <auxData/> element. For example, to search for Multex Research Desk (contributor 20780) documents tagged with auxiliary code 555: XML Sample Request - Searching by Additional Contributor Specific Data
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2008/01/12/DocS earch_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/DocS earch_1/ DocS earch_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <DocS earch_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/DocS earch_1" dateRange="new S ubmissions" maxRow s="2"> <ctbs>2 0 7 8 0 </ctbs> <auxData>5 5 5 </auxData> </DocS earch_Request_1> </Body > </E nv elope>

11.11 Including the Undiscounted Document Price in the Metadata

The cost for a user to purchase a document is based on the users entitlements. By default, the document result set (<diDef/ > element) includes a price attribute indicating whether or not the document has a price. price=1 indicates that the user must purchase a document, while price=0 indicates the document is free. To return the actual undiscounted price of the document, rather than this boolean indicator, specify calcPrice=1 in the request. Note: Including the document price in the result set is an expensive and therefore relatively slow operation. You should only request the document price for individual documents, not a range. Use the boolean price indicator to designate pay per view documents for your user. Only calculate the price if the user selects a particular document. Note: The document price returned by this request does not reflect discounts generally given through resellers. This price also does not reflect the standard 24 hour discount implemented by On Demand sites. With the 24 hour discount clients can retrieve a document multiple times in 24 hours and Reuters only charges for the first download. The following query returns the document metadata, including the undiscounted price, for document 27384598: XML Sample Request - Including the Undiscounted Document Price in the Metadata
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2008/01/12/DocS earch_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/DocS earch_1/ DocS earch_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token>

Document Search

197

</A uthorization> </H eader> <Body > <DocS earch_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/DocS earch_1" dateRange="allDates" maxRow s="1" calcP r ice ="1"> <docID>2 7 3 8 4 5 9 8 </docID> </DocS earch_Request_1> </Body > </E nv elope>

11.11.1 Interpreting the Document Price

The document price returned in the response metadata is in cents. You must code you application to display a meaningful amount to your users. For example, if the response indicates 4950, your application should display $49.50. Note: The document price returned by this request does not reflect discounts generally given through resellers. This price also does not reflect the standard 24 hour discount implemented by On-Demand sites. With the 24 hour discount clients can retrieve a document multiple times in 24 hours and Thomson Reuters only charges for the first download.

11.12 Including the Document Synopsis in the Result Set

By default, the document response metadata includes the hasSyn attribute to indicate whether or not a document includes a synopsis - hasSyn=1 indicates a document with a synopsis. To include the synopsis in the document response metadata, use synCharsRequired to indicate the synopsis length (in characters) you want to receive in the response. For example, the following query requests 50 characters from the synopsis: XML Sample Request - Including the Document Synopsis in the Result Set
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2008/01/12/DocS earch_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/DocS earch_1/ DocS earch_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <DocS earch_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/DocS earch_1" dateRange="new S ubmissions" maxRow s="10" synC har sRequir ed=5 0 > </DocS earch_Request_1> </Body > </E nv elope>

11.13 Query Optimization

This section describes the various ways that the document search query can be optimized. To understand all the aspects of optimization, it is important to understand the steps that are performed in executing a query as described in section The Query Pipeline. Using this information, we show additional ways of optimizing a query by caching information.

11.13.1 The Query Pipeline

To simplify development, the TRKD API performs a number of functions simultaneously. As shown in figure below, up to three sets of backend calls can be made on behalf of a single document search request. The resolution of the symbols and user logins can be cached resulting in a significant speedup of the document search request.

198

TRKD API Developer's Guide

Other than the last layer, the document query layer, symbol resolution is probably the most expensive. If the MXIDs of the companies can be cached, this would result in the most significant speedup of the document search request. For more information on caching, see section Caching the MXID.

11.13.2 Caching the MXID

Caching the Reuters ID, MXID, provides you the most efficient document search. This is because resolving symbols down to MXIDs can be a time consuming process. Use the Reuters Search service to find MXIDs for particular companies. The following example shows a simple query to search by a set of documents using MXIDs. XML Sample Request - Caching the MXID
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2008/01/12/DocS earch_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/DocS earch_1/ DocS earch_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <DocS earch_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/DocS earch_1" dateRange="new S ubmissions" maxRow s="10" tkr Encoding="pr tID">

Document Search

199

<ticker >1 0 0 0 6 5 0 1 9 </ticker > <ticker>100081948</ticker> <ticker>100085757</ticker> <sort s_c="date" s_d="desc"/> <excludeC tbs>1</excludeC tbs> <ctbs>17459</ctbs> </DocS earch_Request_1> </Body > </E nv elope>

Attribute <ticker> prtID

Description The parent (issuer) ID for the query. The ticker encoding informing the request that the codes are MXIDs.

11.14 Paging the Response

There is a built-in paging feature you can use to break up the amount of records you get back into multiple groups. By doing so instead of loading a huge amount of data in a single pass you can choose how many records each page should hold and control the amount of records and time it takes to return the information. You can specify paging information by using the following elements: maxRows: Indicates how many records should be returned in a response. If there are more records then specified in maxRow the next page can be retrieved by specifying pagingHint and retrieving the next batch. Note: Max value for maxRows is 10000. pagingHint: By specifying the hintStr and docID of the last record on the previous page you are able to retrieve the next page. hintStr should contain values defined by the following rules: If you sort by date and the query is newSubmissions , then hintStr= arriveDate of the last doc in the previous query, formatted time_t (# of seconds since 01/01/1970). For any other query sorted by date , hintStr = releaseDate of the last doc in the previous query, formatted time_t (# of seconds since 01/01/1970). If you sort by primaryTicker, then hintStr = pTck of the last doc in the previous query. If you sort by pages , then hintStr = pages of the last doc in the previous query.

11.14.1 Making a Request with Paging

After setting maxRows to the desired amount (in this case 5) and retrieving the first batch of results you can do the following to retrieve the next page: XML Sample Request - Making a Request with Paging
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2008/01/12/DocS earch_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/DocS earch_1/ DocS earch_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <DocS earch_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/DocS earch_1" exclude3rdP arty ="0" acceptLanguage="en" ppv ="both" calcP rice="0" tkrE ncoding="tkr" maxRow sToA bort="2000" maxRows="5 " infoLev el="default" dateRange="newSubmissions" query Ty pe="normal"> <sor t s_d="desc" s_c="date" /> <pagingH int hintStr ="1 1 7 9 2 1 8 6 4 2 " docID="3 9 5 9 7 4 9 1 " />

200

TRKD API Developer's Guide

</DocS earch_Request_1> </Body > </E nv elope>

11.14.2 Calculating Number of Seconds

Below is a simple VBScript that calculates desired date to number of seconds since 01/01/1970. Just copy the information below into a text file, and save it with .VBS extension. Date2 = DateSerial(2008, 4, 25) '(year, month, day) In the first brackets you need to specify the date, for which you want to calculate number of seconds since 1970. The second brackets define the date format.

11.15 Searching for Industry Reports

To search for industry reports use the <rptStyles> element: XML Sample Request - Searching for Industry Reports
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2008/01/12/DocS earch_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/DocS earch_1/ DocS earch_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <DocS earch_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/DocS earch_1" exclude3rdP arty ="0" acceptLanguage="en" ppv ="both" calcP rice="0" tkrE ncoding="tkr" maxRow sToA bort="2000" maxRow s="100" infoLev el="default" dateRange="new S ubmissions" query Ty pe="normal"> <sort s_d="desc" s_c="date" /> <r ptStyles>1 5 0 0 0 0 0 0 9 </r ptStyles> </DocS earch_Request_1> </Body > </E nv elope>

11.16 Some Words about Document Search Criteria

Document Search criteria of the same type are logical ORs while Document Search criteria of different types are ANDs. For example, a Document Search with XML Sample
<ctbs>1</ctbs> <ctbs>2</ctbs>

says "return docs with either ctbs=1 OR ctbs=2". But a Document Search with XML Sample
<ctbs>1</ctbs> <lang>en</lang>

Document Search

201

says "return docs with ctbs=1 AND lang=en". Note: The Document Search service may return a non-empty response without errors if you specify an invalid value for "ctbs" in the request. We implemented <bSubject> to allow applications to use AND with subject codes. That is, to OR subject codes, use XML Sample
<subject>code1</subject> <subject>code2</subject>

To AND the codes use XML Sample

<subject>code1</subject> <bS ubject>code2</bS ubject>

Applications should never send <bSubject/> without at least one <subject/>. Note: When a request contains the <bSubjects> element without a "subject", the following error is returned "searches_1_doer::search failed: bSubject should go together with Subject. Only bSubject is not acceptable!" Note: Keep in mind that symbol "$" is converted to '*' sign that serves as a wild card character in fulcrum. Also, symbol '#' is a special symbol for fulcrum search engine and should not be used in search query.

202

TRKD API Developer's Guide

chapter 12

Entitlements Administration

The Entitlement Administration 2 service allows the user to manage entitlement information by retrieving and updating entitlement, user or user group and document group information from the database. The following operations are available: Create Entitlement (CreateEntitlement_1) - creates an entitlement/entitlements. Get Entitlement (GetEntitlement_1) - retrieves a set of entitlements according to the given user or user group or viewer company and document group contributor company data. Get User Group Template (GetUserGroupTemplate_1) - retrieves all existing user group templates with IDs and names. Remove Entitlement (RemoveEntitlement_1) - removes an entitlement or a set of entitlements. User Group From Template (UserGroupFromTemplate_1) - creates a new user group using existing template. Remove ROS Entitlement (RemoveROSEntitlements_1) - resets the entitlements and removes the user from the ROS user group. Set User Group Membership (SetUserGroupMembership_1) - adds a user to the specified user group. Get User Group Membership (GetUserGroupMembership_1) - lists all users in the user group. Remove User Group Membership (RemoveUserGroupMembership_1) - removes all entitlements associated with the specified user group. Get User Group (GetUserGroup_1) - retrieves the companys user groups.

12.1

Authentication/Authorization, Service Endpoint, and Required Headers

Authorization All requests to the Entitlement Administration 2 web service require an authorization token. For details, see section Understanding Authentication Tokens. Authentication Thomson Reuters Entitlement Administration 2 uses Reuters impersonation tokens for each effective user. In this case, Thomson Reuters must create each user before your application authenticates them. Unmanaged effective users are not supported in Entitlement Administration 2. For additional information, see section Creating a Token . Service Endpoint Entitlement Administration 2 Endpoint
http://api.rkd.reuters.com/api/2008/08/08/E ntitleA dmin_2.sv c

Required Header Required HTTP Headers

P O S T /api/2008/08/08/E ntitleA dmin_2.sv c H TTP /1.1 C ontent-Ty pe: application/soap+xml H ost: api.rkd.reuters.com C ontent-Length: [length]

Entitlements Administration

203

12.2

WSDL
WSDL:
http://api.rkd.reuters.com/schemas/w sdl/E ntitleA dmin_2_H ttpA ndRKDToken.w sdl

12.3

Create Entitlement (CreateEntitlement_1)

The CreateEntitlement_1 request is used to create an entitlement/entitlements. The following example creates a set of entitlements for document groups for user identity and user group identity. XML Sample Request - Creating Entitlement
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2008/08/08/E ntitleA dmin_2.sv c/A nony mous</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleA dmin_2/ C reateE ntitlement_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <C reateE ntitlement_Request_1 xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleA dmin_2" xmlns:C ompany ="http:// w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleA dmin_2_C ompany "> <entitlement> <entitlementIdentity > <userIdentity > <C ompany :alias >tr_admin@reuters.com</C ompany :alias> </userIdentity > <docG roup> <company Id>27</company Id> <id>4</id> </docG roup> </entitlementIdentity > <description>user entitlement one</description> </entitlement> <entitlement> <entitlementIdentity > <user Gr oupIdentity> <C ompany :companyI D>40171</C ompany :company ID> <C ompany :ID>133</C ompany :ID> </userG roupIdentity > <docGr oup> <company Id>17964</company Id> <id>2</id> </docG roup> </entitlementIdentity > <description>user group entitlement one</description> </entitlement> <entitlement> <entitlementIdentity > <userIdentity > <C ompany :cid_uid> <C ompany :company ID>40171</C ompany :company ID> <C ompany :ID>32556999</C ompany :ID> </C ompany :cid_uid> </userIdentity > <docG roup> <company Id>17964</company Id> <id>3</id> </docG roup> </entitlementIdentity > <description>user entitlement tw o</description> </entitlement> </C reateE ntitlement_Request_1>

204

TRKD API Developer's Guide

</Body > </E nv elope>

Element User Identity User Group Identity Doc Group Identity Description

Value Alias Company ID + User ID User Group ID Company ID Doc Group ID Company ID The entitlement description.

The response returns an empty line if the creation of entitlement is successful: XML Sample Response - Creating Entitlement
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/ E ntitleA dmin_2/C reateE ntitlement_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <C reateE ntitlement_Response_1 xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleA dmin_2"/> </Body > </E nv elope>

12.4

Get Entitlement (GetEntitlement_1)

The GetEntitlement_1 request retrieves a set of entitlements according to the given user or user group or viewer company and document group or contributor company data. The following example retrieves the set of entitlements for Viewer Company ID 47319 and 40171 with the specified Document Groups of companies with IDs 27 and 17964 with all output filter criteria set to true. XML Sample Request - Retrieving Entitlement
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2008/08/08/E ntitleA dmin_2.sv c/A nony mous</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleA dmin_2/ G etE ntitlement_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etE ntitlement_Request_1 xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleA dmin_2"> <inputF ilter> < vwr C ompanyId >47319</v w rC ompany Id> < vwr C ompanyId >40171</v w rC ompany Id> < docGr oupIdentity > <company Id>27</company Id> <id>4</id> </docG roupIdentity > <docG roupIdentity > <company Id>17964</company Id> <id>2</id> </docG roupIdentity >

Entitlements Administration

205

<docG roupIdentity > <company Id>17964</company Id> <id>3</id> </docG roupIdentity > </inputF ilter> <outputF ilter ctbC ompany N ame="true" docG roupN ame="true" v w rC ompany N ame="true"/> </G etE ntitlement_Request_1> </Body > </E nv elope>

Element inputFilter

Description User-Vwr Identity - User-viewer identity (mandatory). Can have the following values: User Identity : Alias Company ID + User ID Integrated Entitlement (optional) User Group Identity : User Group ID Company ID Vwr Company ID: Viewer Company ID Doc-Ctb Identity - Doc-Contributor identity (mandatory). Can have the following values: Doc Group Identity : Doc Group ID Company ID Ctb Company ID: Contributor Company ID

outputFilter

Allows you to add the following information to the response: VwrCompanyName - Viewer company name CtbCompanyName - Contributor company name DocGroupname - Document group name

The response retrieves the following information: XML Sample Response - Retrieving Entitlement
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/ E ntitleA dmin_2/G etE ntitlement_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <G etE ntitlement_Response_1 xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleA dmin_2"> <entitlement> <entitlementIdentity > < user Gr oupIdentity > <company ID xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleA dmin_2_C ompany ">47319</ company ID> <ID xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleA dmin_2_C ompany ">10</ID> </userG roupIdentity > <docGr oup> <company Id>27</company Id> <id>4</id> </docG roup> </entitlementIdentity > < vwr C ompanyName >Test sellside BE E </v w rC ompany N ame> < ctbC ompanyName >Banc of A merica S ecurities</ctbC ompany N ame> < docGr oupName >TE S T</docG roupN ame> </entitlement> <entitlement> <entitlementIdentity > <userIdentity > <cid_uid xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleA dmin_2_C ompany "> <company ID>40171</company ID> <ID>32556999</ID> </cid_uid> <alias xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleA dmin_2_C ompany ">tr_admin@reuters.com</

206

TRKD API Developer's Guide

alias> </userIdentity > <docG roup> <company Id>27</company Id> <id>4</id> </docG roup> </entitlementIdentity > <v w rC ompany N ame>TM C - Test A P I C ompany 1 (IM - U S )</v w rC ompany N ame> <ctbC ompany N ame>Banc of A merica S ecurities</ctbC ompany N ame> <docG roupN ame>TE S T</docG roupN ame> </entitlement> </G etE ntitlement_Response_1> </Body > </E nv elope>

Attribute Description entitlementIdent Consists of two parts viewer (user identity or user group identity) and document group identity. ity vwrCompanyNa Name of the viewer company. me ctbCompanyNam Name of the contributor company. e docGroupName Name of the document group.

12.5

Get User Group Template (GetUserGroupTemplate_1)

You can use the GetUserGroupTemplate_1 request to retrieve all existing user group templates with IDs and names. The following request is an example of GetUserGroupTemplate_1, which retrieves user group templates. XML Sample Request - Retrieving User Group Template
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2008/08/08/E ntitleA dmin_2.sv c/A nony mous</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleA dmin_2/ G etU serG roupTemplate_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etU serG roupTemplate_Request_1 xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleA dmin_2"/> </Body > </E nv elope>

The response returns the list of existing user group templates with their IDs and names: XML Sample Response - Retrieving User Group Template
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/ E ntitleA dmin_2/G etU serG roupTemplate_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <G etU serG roupTemplate_Response_1 xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleA dmin_2"> <userG roupTemplate> <id>5</id> <name>C orporates/TM C RO S (C anada)</name>

Entitlements Administration

207

</userG roupTemplate> <userG roupTemplate> <id>6</id> <name>C orporates/TM C RO S (Japan)</name> </userG roupTemplate> <userG roupTemplate> <id>7</id> <name>C orporates/TM C RO S (RO W)</name> ... <userG roupTemplate> <id>10</id> <name>U LE (Japan)</name> </userG roupTemplate> <userG roupTemplate> <id>11</id> <name>U LE (RO W)</name> </userG roupTemplate> <userG roupTemplate> <id>12</id> <name>U LE (U S )</name> </userG roupTemplate> </G etU serG roupTemplate_Response_1> </Body > </E nv elope>

12.6

Remove Entitlement (RemoveEntitlement_1)

The RemoveEntitlement_1 request removes an entitlement. The following example removes the entitlement for the specified document group for user identity and user group identity. XML Sample Request - Removing Entitlement
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2008/01/12/E ntitleA dmin_2.sv c/A nony mous</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleA dmin_2/ Remov eE ntitlement_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <Remov eE ntitlement_Request_1 xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleA dmin_2"> < entitlementIdentity > < user Gr oupIdentity > <C ompany :company ID>40171</C ompany :company ID> <C ompany :ID>133</C ompany :ID> </userG roupIdentity > < docGr oup > <company Id>17964</company Id> <id>1</id> </docG roup> </entitlementIdentity > </Remov eE ntitlement_Request_1> </Body > </E nv elope>

An entitlement can be removed by the following identities: Identity Description Company Specifies company ID. entitlementId Specifies entitlement data. Can have the following values:

208

TRKD API Developer's Guide

entity

User Group

User

User Identity User Group Identity Doc Group Identity For more information see section Create Entitlement (CreateEntitlement_1). Specifies the following: User Group ID Company ID Specifies user identity. Can have the following values: Alias Company ID + User ID

The response returns an empty line if entitlements have been removed successfully: XML Sample Response - Removing Entitlement
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/ E ntitleA dmin_2/Remov eE ntitlement_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <Remov eE ntitlement_Response_1 xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleA dmin_2"/> </Body > </E nv elope>

Note: When you try to remove a non-existent entitlement or non-existent set of entitlements, you will not receive any error.

12.7

User Group From Template (UserGroupFromTemplate_1)

The UserGroupFromTemplate_1 can be used to create a new user group using existing template. The following example creates a new user group with the specified description for the company with companyId '47319'. New user group will be created using the template with templateId '4'. XML Sample Request - Retrieving User Group Template
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2008/08/08/E ntitleA dmin_2.sv c/A nony mous</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleA dmin_2/ U serG roupF romTemplate_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <U serG roupF romTemplate_Request_1 xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleA dmin_2"> <input> <description>usergroup_description</description> <company Id>47319</company Id> <templateid>4</templateid> </input> </U serG roupF romTemplate_Request_1> </Body > </E nv elope>

The response returns the ID of the created user group: XML Sample Response - Retrieving User Group Template

Entitlements Administration

209

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/ E ntitleA dmin_2/U serG roupF romTemplate_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <U serG roupF romTemplate_Response_1 xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleA dmin_2"> <userG roupIdentity > <company ID xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleA dmin_2_C ompany ">47319</company ID> <ID xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleA dmin_2_C ompany ">8</ID> </userG roupIdentity > </U serG roupF romTemplate_Response_1> </Body > </E nv elope>

12.8

Remove Entitlement (RemoveEntitlement_1)

The RemoveEntitlement_1 request removes an entitlement. The following example removes the entitlement for the specified document group for user identity and user group identity. XML Sample Request - Removing Entitlement
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2008/01/12/E ntitleA dmin_2.sv c/A nony mous</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleA dmin_2/ Remov eE ntitlement_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <Remov eE ntitlement_Request_1 xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleA dmin_2"> < entitlementIdentity > < user Gr oupIdentity > <C ompany :company ID>40171</C ompany :company ID> <C ompany :ID>133</C ompany :ID> </userG roupIdentity > < docGr oup > <company Id>17964</company Id> <id>1</id> </docG roup> </entitlementIdentity > </Remov eE ntitlement_Request_1> </Body > </E nv elope>

An entitlement can be removed by the following identities: Identity Description Company Specifies company ID. entitlementId Specifies entitlement data. Can have the following values: entity User Identity User Group Identity Doc Group Identity For more information see section Create Entitlement (CreateEntitlement_1). User Group Specifies the following: User Group ID

210

TRKD API Developer's Guide

User

Company ID Specifies user identity. Can have the following values: Alias Company ID + User ID

The response returns an empty line if entitlements have been removed successfully: XML Sample Response - Removing Entitlement
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/ E ntitleA dmin_2/Remov eE ntitlement_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <Remov eE ntitlement_Response_1 xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleA dmin_2"/> </Body > </E nv elope>

Note: When you try to remove a non-existent entitlement or non-existent set of entitlements, you will not receive any error.

12.9

Remove ROS Entitlement (RemoveROSEntitlements_1)

You can use the RemoveROSEntitlements_1 request to reset the entitlements and remove the user from the ROS user group. XML Sample Request - Removing ROS Entitlement
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2008/08/08/E ntitleA dmin_2.sv c/A nony mous</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleA dmin_2/ Remov eRO S E ntitlements_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <Remov eRO S E ntitlements_Request_1 xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleA dmin_2"> <userG roupIdentity > < companyID xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleA dmin_2_C ompany "> 4 7 3 1 9 </ company ID> < ID xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleA dmin_2_C ompany "> 6 </ID> </userG roupIdentity > </Remov eRO S E ntitlements_Request_1> </Body > </E nv elope>

The response is empty if request was successful: XML Sample Response - Removing ROS Entitlement
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/ E ntitleA dmin_2/Remov eRO S E ntitlements_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <Remov eRO S E ntitlements_Response_1 xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleA dmin_2"> </Remov eRO S E ntitlements_Response_1>

Entitlements Administration

211

</Body > </E nv elope>

12.10 Set User Group Membership (SetUserGroupMembership_1)

You can use the SetUserGroupMembership_1 request to add a user to the specified user group like shown in the example below: XML Sample Request - Setting User Group Membership
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2008/08/08/E ntitleA dmin_2.sv c/A nony mous</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleA dmin_2/ S etU serG roupM embership_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <S etU serG roupM embership_Request_1 xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleA dmin_2"> <userG roupM embership> <userG roupM embershipIdentity > <userG roupIdentity > <company ID xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleA dmin_2_C ompany ">40171</ company ID> <ID xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleA dmin_2_C ompany ">133</ID> </userG roupIdentity > <userIdentity > <cid_uid xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleA dmin_2_C ompany "> <company ID>40171</company ID> <ID>32556999</ID> </cid_uid> </userIdentity > </userG roupM embershipIdentity > </userG roupM embership> </S etU serG roupM embership_Request_1> </Body > </E nv elope>

The response is empty if request was successful: XML Sample Response - Setting User Group Membership
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/ E ntitleA dmin_2/S etU serG roupM embership_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <S etU serG roupM embership_Response_1 xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleA dmin_2"> </S etU serG roupM embership_Response_1> </Body > </E nv elope>

12.11 Get User Group Membership (GetUserGroupMembership_1)

You can use the GetUserGroupMembership_1 request to list all users in the user group.

212

TRKD API Developer's Guide

XML Sample Request - Retrieving User Group Membership

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2008/08/08/E ntitleA dmin_2.sv c/A nony mous</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleA dmin_2/ G etU serG roupM embership_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etU serG roupM embership_Request_1 xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleA dmin_2"> <inputF ilter> <membershipF ilter> <userIdentity > <cid_uid xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleA dmin_2_C ompany "> <company ID>40171</company ID> <ID>32556999</ID> </cid_uid> </userIdentity > </membershipF ilter> </inputF ilter> </G etU serG roupM embership_Request_1> </Body > </E nv elope>

The request returns the following information: XML Sample Response - Retrieving User Group Membership
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/ E ntitleA dmin_2/G etU serG roupM embership_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <G etU serG roupM embership_Response_1 xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleA dmin_2"> <U serG roupM embership> <userG roup> <company ID xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleA dmin_2_C ompany ">40171</company ID> <ID xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleA dmin_2_C ompany ">117</ID> </userG roup> <user> <cid_uid xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleA dmin_2_C ompany "> <company ID>40171</company ID> <ID>32556999</ID> </cid_uid> </user> <status>1</status> </U serG roupM embership> <U serG roupM embership> <userG roup> <company ID xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleA dmin_2_C ompany ">40171</company ID> <ID xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleA dmin_2_C ompany ">119</ID> </userG roup> <user> <cid_uid xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleA dmin_2_C ompany "> <company ID>40171</company ID> <ID>32556999</ID> </cid_uid> </user> <status>1</status> </U serG roupM embership> <U serG roupM embership> <userG roup> <company ID xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleA dmin_2_C ompany ">40171</company ID>

Entitlements Administration

213

<ID xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleA dmin_2_C ompany ">133</ID> </userG roup> <user> <cid_uid xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleA dmin_2_C ompany "> <company ID>40171</company ID> <ID>32556999</ID> </cid_uid> <status>1</status> </user> </U serG roupM embership> </G etU serG roupM embership_Response_1> </Body > </E nv elope>

12.12 Remove User Group Membership (RemoveUserGroupMembership_1)

You can use the RemoveUserGroupMembership_1 request to remove all entitlements associated with the specified user group. XML Sample Request - Removing User Group Membership
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2008/08/08/E ntitleA dmin_2.sv c/A nony mous</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleA dmin_2/ Remov eU serG roupM embership_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <Remov eU serG roupM embership_Request_1 xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleA dmin_2"> <userG roupM embership> <userG roupIdentity > <company ID xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleA dmin_2_C ompany ">40171</company ID> <ID xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleA dmin_2_C ompany ">133</ID> </userG roupIdentity > <userIdentity > <cid_uid xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleA dmin_2_C ompany "> <company ID>40171</company ID> <ID>32556999</ID> </cid_uid> </userIdentity > </userG roupM embership> </Remov eU serG roupM embership_Request_1> </Body > </E nv elope>

The response is empty if request was successful: XML Sample Response - Removing User Group Membership
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/ E ntitleA dmin_2/Remov eU serG roupM embership_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <Remov eU serG roupM embership_Response_1 xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleA dmin_2"> </Remov eU serG roupM embership_Response_1>

214

TRKD API Developer's Guide

</Body > </E nv elope>

12.13 Get User Group (GetUserGroup_1)

You can use the GetUserGroup_1 request to retrieve the company's user groups. XML Sample Request - Retrieving User Group
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2008/08/08/E ntitleA dmin_2.sv c/A nony mous</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleA dmin_2/ G etU serG roup_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etU serG roup_Request_1 xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleA dmin_2"> <inputF ilter> <userG roupIdentity > <company ID xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleA dmin_2_C ompany ">47319</company ID> <ID xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleA dmin_2_C ompany ">6</ID> </userG roupIdentity > </inputF ilter> </G etU serG roup_Request_1> </Body > </E nv elope>

The following information is returned in the response: XML Sample Response - Retrieving User Group
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/ E ntitleA dmin_2/G etU serG roup_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <G etU serG roup_Response_1 xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleA dmin_2"> <userG roup> <userG roupIdentity > <company ID xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleA dmin_2_C ompany ">47319</company ID> <ID xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleA dmin_2_C ompany ">6</ID> </userG roupIdentity > <userG roupN ame>A Test user group 12345</userG roupN ame> <description>this is a test user group 2</description> </userG roup> </G etU serG roup_Response_1> </Body > </E nv elope>

Entitlement Requests

215

chapter 13

Entitlement Requests

The Entitlements 2 service allows the user to request permission to view documents of other companies. The request sent by the client (buy side) can be either approved or declined by the broker (sell side). The Entitlements 2 service exposes a complete set of operations necessary to manage entitlement request lifetime and gather comprehensive statistics. The Entitlements 2 service differs from the Entitlements service in having two optional attributes - <userId> and <companyId> to add administrative functions to the service. Requests and other attributes are the same as in the Entitlements service. The following operations are available: Create Entitlement Request (CreateEntitlementRequest_1) - facilitates the creation of a new entitlement request. Get Contributor List (GetContributorList_1) - retrieves a list of contributors. Get Entitlement Request List (GetEntitlementRequestList_1) - retrieves the list of entitlement requests according to the specified filtering criteria. Get Last Client Contact (GetLastClientContact_1) - retrieves the last contact information submitted by the client.

13.1

Authentication/Authorization, Service Endpoint, and Required Headers

Authorization All requests to the Entitlement Requests 2 web service require an authorization token. For details, see section Understanding Authentication Tokens. Authentication Entitlements Requests 2 uses Reuters impersonation tokens for each effective user. In this case, Thomson Reuters must create each user before your application authenticates them. Unmanaged effective users are not supported in Entitlements Requests 2. For additional information, see section Creating a Token .

Service Endpoint Entitlements Requests 2 Endpoint

http://api.rkd.reuters.com/api/2008/08/08/E ntitleReq_2.sv c

Required Header Required HTTP Headers

P O S T /api/2008/08/08/E ntitleReq_2.sv c H TTP /1.1 C ontent-Ty pe: application/soap+xml H ost: api.rkd.reuters.com C ontent-Length: [length]

216

TRKD API Developer's Guide

13.2

WSDL
WSDL:
http://api.rkd.reuters.com/schemas/w sdl/E ntitleReq_2_H ttpA ndRKDToken.w sdl

13.3

Create Entitlement Request (CreateEntitlementRequest_1)

The CreateEntitlementRequest_1 request is used to create a new entitlement request. The following example shows how to create new entitlement requests with "235236" and "235237" IDs. XML Sample Request - Creating Entitlement Request
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2008/08/08/E ntitleReq_2.sv c/A nony mous</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleReq_2/ C reateE ntitlementRequest_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <C reateE ntitlementRequest_Request_1 xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleReq_2"> <C ontact userId="34" company Id="354" userN ame="<user's name>" jobF unction="<user's job function>" div ision="<div ision_name>" address="62 E lm str" city S tate="N ew York" country ="U S A " telephone="phone_number" email="bill. name@reuters.com"/> <C ontributorRequest id="235236" contactN ame="john.w er" contactP hone="34532545" contactE mail="john.w er@reuters.com"> <C omment>any _comments</C omment> </C ontributorRequest> <C ontributorRequest id="235237" contactN ame="ctb_contactN ame" /> </C reateE ntitlementRequest_Request_1> </Body > </E nv elope>

The user can specify the following contact details in the request: User Name - Is limited to 64 characters max. User ID - user's ID. Company ID - company's ID. Job Function - See section User Job Roles for more information. The value is limited to 32 characters max. Division - Is limited to 32 characters max. Address - Is limited to 256 characters max. City State - Is limited to 50 characters max. Country - See section Country for country codes. The value is limited to 50 characters max. Telephone - Is limited to 32 characters max. E-mail - Is limited to 64 characters max. Except Contributor ID (mandatory), you can provide the following information: Contact Name - contributor's contact name (limited to 64 characters). Contact Phone - contributor's phone number (limited to 24 characters). Contact E-mail - contributor's e-mail address (limited to 256 characters). Comment - comments for the specified contact. Note: If you do not specify User ID and Company ID (leave fields blank), system will automatically add to the request Company ID and User ID of the current user. If you specify only User ID or only Company ID system will respond with an error. The response returns Request IDs, which identify the IDs of the newly created entitlement requests:

Entitlement Requests

217

XML Sample Response - Creating Entitlement Request

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/ rkd/E ntitleReq_2/C reateE ntitlementRequest_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <C reateE ntitlementRequest_Response_1 xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleReq_2"> <Ids> <Id v alue="235236"/> <Id v alue="235237"/> </Ids> </C reateE ntitlementRequest_Response_1> </Body > </E nv elope>

13.4

Get Contributor List (GetContributorList_1)

The GetContributorList_1 request retrieves a list of contributors. The user can request entitlements from the contributors from this list and this list also has contributors for whom the user is currently entitled. The following example retrieves the list of contributors for userId "32558051" and companyId "40171": XML Sample Request - Retrieving Contributor List
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2008/08/08/E ntitleReq_2.sv c/A nony mous</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleReq_2/ G etC ontributorList_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etC ontributorList_Request_1 xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleReq_1" listTy pe="DefaultList" company Id="40171" userId="32558051"/> </Body > </E nv elope>

Attribute listType userId companyId CtbIds

Description Specifies the amount of detail required in the response. Can contain the following values: DefaultList name, entitlement status, and the most recent update date only. Defines User ID. Defines Company ID. Contains Contributor IDs which the response should be limited to.

Note: If you do not specify User ID and Company ID (leave fields blank), system will automatically add to the request Company ID and User ID of the current user. If you specify only User ID or only Company ID system will respond with an error. The request retrieves the following contributor list: XML Sample Response - Retrieving Contributor List
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope">

218

TRKD API Developer's Guide

<H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/ rkd/E ntitleReq_2/C reateE ntitlementRequest_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <G etC ontributorList_Response_1 xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleReq_2"> <C ontributor entitlementS tatus="E ntitled" id="20247" name="A &amp;A A ctienbank"/> <C ontributor date="2008-05-13T18:11:00" entitlementS tatus="RequestDeclinedBy Reuters" id="1013" name="A BG S undal C ollier"/ > <C ontributor entitlementS tatus="E ntitled" id="14576" name="A BN A M RO - F ixed Income (H istorical)"/> <C ontributor entitlementS tatus="E ntitled" id="6618" name="A BN A M RO A sia Limited (H istorical)"/> <C ontributor entitlementS tatus="E ntitled" id="5060" name="A BN A M RO A ustralia (H istorical)"/> <C ontributor entitlementS tatus="E ntitled" id="2852" name="A BN A M RO E urope (H istorical)"/> <C ontributor date="2008-09-10T09:28:12" entitlementS tatus="RequestReceiv ed" id="109" name="A BN A M RO G lobal Research"/> <C ontributor entitlementS tatus="E ntitled" id="4205" name="A BN A M RO Ireland (H istorical)"/> <C ontributor entitlementS tatus="E ntitled" id="12865" name="A BN A M RO Latin A merica (H istorical)"/> <C ontributor date="2008-05-13T18:17:00" entitlementS tatus="RequestDeclinedBy Broker" id="7530" name="A BN A M RO M organ Ltd"/> <C ontributor entitlementS tatus="E ntitled" id="6471" name="A BN A M RO S ecurities Japan Limited (H istorical)"/> <C ontributor entitlementS tatus="E ntitled" id="39612" name="A bu Dhabi Inv estment C ompany (A DIC )"/> ..... <C ontributor entitlementS tatus="N one" id="11136" name="WR H ambrecht + C o."/> <C ontributor entitlementS tatus="E ntitled" id="11395" name="Wunderlich Research P artners"/> <C ontributor entitlementS tatus="E ntitled" id="22482" name="Yuanta Inv estment C onsulting"/> <C ontributor entitlementS tatus="E ntitled" id="26989" name="Zacks Inv estment Research Inc."/> <C ontributor entitlementS tatus="E ntitled" id="37943" name="Zero2IP O F inancial M anagement C onsultancy (Beijing)Ltd."/> <C ontributor entitlementS tatus="E ntitled" id="41609" name="Zero2IP O G roup"/> <C ontributor entitlementS tatus="E ntitled" id="36351" name="Zheshang S ecurities C o.,LTD"/> </G etC ontributorList_Response_1> </Body > </E nv elope>

13.5

Get Entitlement Request List (GetEntitlementRequestList_1)

The GetEntitlementRequestList_1 request retrieves the list of Entitlement requests according to the supplied filtering criteria. The following example retrieves all entitlements requests for the company with Company ID '40171': XML Sample Request - Retrieving Entitlement Request List
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2008/08/08/E ntitleReq_2.sv c/A nony mous</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleReq_2/ G etE ntitlementRequestList_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etE ntitlementRrequestList_Request_1 xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleReq_2" detailLev el="DefaultLev el"> <F ilter> <C lientC riteria> <C ompany U ser company Id="40171"/> </C lientC riteria> </F ilter> </G etE ntitlementRequestList_Request_1> </Body > </E nv elope>

Attribute

Description

Entitlement Requests

219

detailLevel

maxRecords RecordCriteria

ClientCriteria

CtbCriteria

Specifies how much data must be returned in the response: DefaultLevel - returns all data except StatusChange trail. AllLevel - returns Default + StatusChange trail. Defines maximal number of records to be returned. Specifies filter criteria based on specific request traits such as request id/status. Id - request ID. Status - specifies request status. Can have the following values: None Entitled Request closed Request declined by Thomson Reuters Request declined by broker Request forwarded to broker Request received DateRange - specifies the date range of requests to be returned. Specifies filter criteria based on specific client data. Client Type - specifies type of client. Can have the following values: Company user - denotes user who belongs to a company. Company level based user - denotes user accounted for contributors supporting Company Level Entitlements. userId - Defines User ID. companyId - Defines Company ID. Corporate Flag. Can have the following values: Corporate Non corporate Both Client Name - defines client name. Specifies filter criteria based on specific Contributor data. CtbId - specifies contributor's ID. CtbName - specifies contributor's name.

Note: In this request you can either specify just Company ID to retrieve list of entitlement requests for a particular company OR Company ID with User ID to retrieve list of entitlement requests for a certain user of a particular company. If you do not specify anything (leave fields blank), system will automatically add to the request Company ID and User ID of the current user. The response returns all entitlements requests for the company with Company ID '40171': XML Sample Response - Retrieving Entitlement Request List
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/ rkd/E ntitleReq_2/C reateE ntitlementRequest_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <G etE ntitlementRequestList_Response_1 xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleReq_2"> <E ntitlementRequest createdDate="2007-12-03T10:31:51" id="15649" status="RequestC losed" statusC hangedDate="2007-1220T07:58:00"> <C ontactE x address="" city S tate="" company Id="40171" country ="" div ision="" email="JohnDoe@E ntitlementsTest.com" jobF unction="" telephone="81-3-5405-0422" userId="32475125" userN ame="Doe, John" company N ame="TM C - Test A P I C ompany 1 (IM - U S )" loginN ame="JohnDoe7"/> <C tbC ontact contact="test7" email="test7" id="765" name="C athay F inancial Inc." phone="test7"/> </E ntitlementRequest> <E ntitlementRequest createdDate="2007-12-03T10:31:52" id="15650" status="RequestC losed" statusC hangedDate="2007-1220T07:46:00"> <C ontactE x address="" city S tate="" company Id="40171" country ="" div ision="" email="JohnDoe@E ntitlementsTest.com" jobF unction="" telephone="81-3-5405-0422" userId="32475125" userN ame="Doe, John" company N ame="TM C - Test A P I C ompany 1 (IM - U S )" loginN ame="JohnDoe7"/> <C tbC ontact contact="test8" email="test8" id="10009" name="C ollins S tew art LLC " phone="test8"/> </E ntitlementRequest> <E ntitlementRequest createdDate="2008-07-16T12:35:00" id="15651" status="RequestDeclinedBy Reuters" statusC hangedDate="2008-07-16T12:35:00"> <C ontactE x address="" city S tate="" company Id="40171" country ="" div ision="" email="JohnDoe@E ntitlementsTest.com" jobF unction="" telephone="81-3-5405-0422" userId="32475125" userN ame="Doe, John" company N ame="TM C - Test A P I C ompany 1 (IM - U S )" loginN ame="JohnDoe7"/>

220

TRKD API Developer's Guide

<C tbC ontact contact="test9" email="test9" id="21613" name="C raig H allum" phone="test9"/> </E ntitlementRequest> .... <E ntitlementRequest createdDate="2008-10-10T10:18:02" id="25917" status="RequestReceiv ed" statusC hangedDate="2008-1010T10:18:02"> <C ontactE x address="contact address" city S tate="contact state" company Id="40171" country ="contact country " div ision="contact div ision" email="contact@email.com" jobF unction="contact job func" telephone="contact phone 2222222" userId="32556999" userN ame="contact userN ame" company N ame="TM C - Test A P I C ompany 1 (IM - U S )" loginN ame="tmc_qaadminserv ice"/> <C tbC ontact contact="ctb contactN ame" email="ctb_contactE mail@email.com" id="128" name="A uerbach G ray son &amp; C o., Inc." phone="ctb contactP hone 3333333"/> </E ntitlementRequest> <E ntitlementRequest createdDate="2008-10-15T11:00:38" id="25918" status="RequestReceiv ed" statusC hangedDate="2008-1015T11:00:38"> <C ontactE x address="contact address" city S tate="contact state" company Id="40171" country ="contact country " div ision="contact div ision" email="contact@email.com" jobF unction="contact job func" telephone="2222222" userId="32558052" userN ame="contact userN ame" company N ame="TM C - Test A P I C ompany 1 (IM - U S )" loginN ame="tmc_dev adminserv ice"/> <C tbC ontact contact="ctb contactN ame" email="ctb_contactE mail@email.com" id="7426" name="Dav enport &amp; C ompany , LLC " phone="3333333"/> </E ntitlementRequest> </G etE ntitlementRequestList_Response_1> </Body > </E nv elope>

13.6

Get Last Client Contact (GetLastClientContact_1)

The GetLastClientContact_1 request retrieves the last contact information submitted by the client. The following example retrieves last contact information submitted by user with User ID '32558052' and Company ID '40171': XML Sample Request - Retrieving Last Client Contact
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2008/08/08/E ntitleReq_2.sv c/A nony mous</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleReq_2/ G etLastC lientC ontact_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etLastC lientC ontact_Request_1 xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleReq_2" company Id="40171" userId="32558052"/> </Body > </E nv elope>

Attribute userId companyId

Description Defines User ID. Defines Company ID.

The request retrieves the last contact information submitted by the client. Note: If you do not specify User ID and Company ID (leave fields blank), system will automatically add to the request Company ID and User ID of the current user. If you specify only User ID or only Company ID system will respond with an error. Note: The field will be empty if there are no records. XML Sample Response - Retrieving Last Client Contact

Entitlement Requests

221

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/ rkd/E ntitleReq_2/C reateE ntitlementRequest_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <G etLastC lientC ontact_Response_1 xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/E ntitleReq_2"> <C ontact address="contact address" city S tate="contact state" company Id="40171" country ="contact country " div ision="contact div ision" email="contact@email.com" jobF unction="contact job func" telephone="2222222" userId="32558052" userN ame="contact userN ame"/> </G etLastC lientC ontact__Response_1> </Body > </E nv elope>

13.7

How Does Get Contributor List Operation Work

This section gives details on how the GetContributorList_1 operation works. The operation takes the following parameters as input data : Company ID UserID ContributorID (BrokerID) ChannelID MemberFirm After you have specified necessary input values and submitted the request, TRKD API will perform the following: 1. 2. 3. 4. 5. 6. Get the list of Broker IDs that are restricted for the user. Get Company Entitlement Category. Get Geography Policy for the current user. Create temporary Entitlements table with all entitled and potential contributors taking into consideration contributor ID (if provided into input parameters). Apply all policies to the table (refer to section Rules of retrieving contributors). Update status in temporary Entitlements table (possible values: "Entitled", "Request Closed", "Request Declined - By Broker", "Request Declined - By Reuters", "Request Forwarded to Broker", "Request Received") with the values from Entitlement Request table. In temporary Entitlements table set status to "none" for records with "entitled" status without the corresponding row in DocAccess table (records with undefined company ID, user group ID, document group id in DocAccess table). Get Brokers from temporary Entitlements table verifying that the broker it is not disabled and belongs to the defined channel ID.

7. 8.

As a result, you get the following values in the response: BrokerID BrokerName EntitlementStatus RequestStatusID Date

13.7.1 Rules for Retrieving Contributors

There are different policies are applied by TRKD API to users, contributors, documents, etc. Geography policy: each user belongs to different user groups (even users from one company can belong to different user groups!), geography policy takes into consideration the company the user belongs to and the user group the user belongs to. Approval Policy: there are number of document groups assigned to a company and each document group has its own approval policy the document group must have "preapproval" (distribution to general groups with pre-approval only) or "postapproval" (default distribution to all buyside with possible later restrictions) document group's policy.

222

TRKD API Developer's Guide

Pricing Policy: each document group has its own pricing policy - the pricing policy should be "Subscription". Receipt Policy: the user group must have "Public" receipt policy (full access).

13.7.2 Example
Let us have a look at the example how all this works in TRKD API: Use the following user login: rkapiadministrator1@ reuters. com Open GetContributorList_1 request and specify the following input parameters : CompanyID=30373 UserID=32188604 ContributorID=NULL ChannelID=0 MemberFirm=NULL As it was described earlier, TRKD API will do the following: 1. 2. 3. 4. Get Document Group Company ID (Broker ID) restrictions for the user: none . Get Company Entitlement Category: Buyside . Apply Geography Policy for the current user: U.S., All, US/Japan/Canada . Create temporary Entitlements table by applying all the policies (see the diagram in Creation of Temporary Entitlements Table). 5. Set status to "none" for the records with temporary "entitled" status without the corresponding row in DocAccess table. 6. Get Brokers from the temporary Entitlements table verifying the company it is not disabled. As a result, you will get the following output data: Bro ker ID 261 64 202 47 364 12 101 3 145 76 ... BrokerName EntitlementStatus RequestStatu Date s_ID -1 1 1 3 1 NULL NULL NULL 2008-12-17 06:55:00.000 NULL

0000 Adam test company A&A Actienbank Abaxbank - Banca d'Investimento ABG Sundal Collier

None Entitled Entitled

Request Declined - By Reuters ABN AMRO - Fixed Income Entitled (Historical)

13.7.3 Possible Policy Values

Company Entitlement Category: Buyside (this is for Document Group Entitlement Category - multiple Research Categories map to one Entitlement Category. Buyside=2, 100, 101, 23, 27, 17, 26, 37) Corporates (Res. Cat. #13) Press (Res. Cat. #11) Sellside/Univ (Sellside/Universities Res. Cat - 1,4,5,6,8,18,19,24,25,33,34,35,39. Univ - #22) Geography policy: All Canada Excl. US Excl. US/Japan/Canada

Entitlement Requests

223

U.S US/Japan/Canada Approval policy: Private (internal distribution or distribution only to certain groups) Preapproval (distribution to general groups with only) Postapproval (default distribution to all buyside with possible later restrictions) Pricing policy: PPV Broker PPV-Broker-Promotional PPV-Third Party PPV-Third Party-Promotional Premium-Broker Premium-Third Party Subscription Receipt policy: Private Public User-Level

13.7.4 Why Users Cannot Get Document from the Contributors They Are Entitled to
If the user is not a member of Public user group which is entitled to particular contributor, the user will see this contributor as entitled, even though the user doesn't have access to this contributor. This was done to prevent repeated requests for entitlements from clients who are already entitled through their public group.

13.7.5 Why Users Cannot Access the Document Their Colleagues Have Access to
All users belong to certain users groups, even users from the same company can belong to different users group, which means their contributors may differ. As a result they will have access to different documents.

13.7.6 Why Is Get Contributor List Operation Often Confused with Get Information Operation from the Reference Information service
Like GetContributorsList_1 operation the GetInfo_1 operation from the Reference Information service with specified "contributor" criteria returns the list of contributors and applies all the policies mentioned for Get Contributors List. But depending on the "Criterion" parameter the GetInfo_1 operation provides information about all contributors (full list), company contributors and users contributors. The GetContributorList_Request_1 is only supposed to be used to show ROS-enabled users what contributors they're entitled to and what contributors they can request approval to (it will show all of these as entitled, whether they actually are or not). For the user who doesn't appear to be ROS-enabled, you must use the "GetInfo_1" request (under the "References Information" API) to find out what contributors they are actually entitled to.

13.7.7 Creation of Temporary Entitlements Table

The diagram below shows the process of creating temporary Entitlements table:

224

TRKD API Developer's Guide

13.8

Handling Error Codes

The following subcodes representing 3 logical groups of possible errors have been implemented for the Entitlement Requests 2 service: Failed indicates various errors returned by the service. ServiceCustomConfigError indicates errors caused by incorrect service custom configuration nodes. BusinessRuleViolation indicates errors caused by requests which break service business rules. Note: An error message with the "BusinessRuleViolation" subcode has been added: "Attributes 'companyId' and 'userId' are interdependent. Either both or none of them should be specified". This error appears when a service user tries to send a request with only one user credential ('userId' or 'companyId') instead of specifying both of them or none of them. However, in the following case a request with single credential will not cause this error: the "GetEntitlementRequestList_Request_1/ Filter/ClientCriteria/CompanyUser/@companyId" attribute can be specified without the accompanying 'userId' (but not vice versa!).

Estimates

225

chapter 14

Estimates

The Reuters Estimates database consists of global estimates for over 15,000 active and 10,000 inactive companies. It contains all estimates types and periods that Thomson Reuters collects and is designed to allow Thomson Reuters to expand their offering seamlessly. This service allows clients to access and manipulate the following sets of data collected by Thomson Reuters: Consensus estimates and ratings Actuals Broker and Analyst Information Consensus Analysis (looking back up to 18 months) Basic Company Information Not all items are available for all companies. Thomson Reuters aims to provide the key investment variables for all markets. However, in certain markets some data types are simply not available in significant quantities due to the standards and practices inherent in that region. You can use the following operations to retrieve Estimates information: Get Get Get Get Get Get Reference Information: (GetReferenceInformation_1) Security Information: (GetSecurityInformation_1) Meta Information: (GetMetaInformation_1) Broker Coverage Information: (GetBrokerCoverageInformation_1) Consensus: (GetConsensus_1) Detailed: (GetDetailed_1)

14.1

Authentication/Authorization, Service Endpoint, and Required Headers

Authorization All requests to the Thomson Reuters Estimates web service require an authorization token. For details, see section Understanding Authentication Tokens. Authentication Thomson Reuters Estimates uses Reuters impersonation tokens for each effective user. In this case, Thomson Reuters must create each user before your application authenticates them. Unmanaged effective users are not supported in Reuters Estimates. For additional information, see section Creating a Token .

Service Endpoint Reuters Estimates Endpoint

http://api.rkd.reuters.com/api/2006/05/01/E stimates_1.sv c

Required Header Required HTTP Headers

P O S T /api/2006/05/01/E stimates_1.sv c H TTP /1.1 C ontent-Ty pe: application/soap+xml H ost: api.rkd.reuters.com C ontent-Length: [length]

226

TRKD API Developer's Guide

14.2

WSDL
WSDL:
http://api.rkd.reuters.com/schemas/w sdl/E stimates_1_H ttpA ndRKDToken.w sdl

14.3

General Product Information

This chapter provides explanation on the following general information a product can contain - date and time standards, data coverage, company definition, consensus currency, adjustments for capital changes, unit sizes, periods, consensus methodology, supplemental recommendations and expected announcement dates.

14.3.1 Date and Time Standards

Where possible, Thomson Reuters utilizes XML standards for providing dates and times. The following date and time masks are used: Type Date and time Year only Mask yyyy-mm-ddThh:mm:ss yyyy

Year and month yyyymm Year, month and yyyy-mm-dd day Note: All times in all files will be provided in GMT. This time will not be adjusted for daylights saving times.

14.3.2 Definition of a Company in Thomson Reuters Estimates

The purpose of Thomson Reuters Estimates in general is to fully represent estimates in the most appropriate fashion as intended by contributing brokers. In the Thomson Reuters Estimates service each company, in the eyes of the broker, has its record. However, users of the data should be aware that for various reasons one company in the real world may have two separate records in this service. An example of such an occurrence is HSBC where there are major listings on both the London Stock Exchange and the Hong Kong Stock Exchange. Currently both listings will have separate sets of Estimates. The reason for this is that each listing will produce separate accounts based on different accounting standards and as such brokers treat them as two separate companies. This representation of the equities world differs from the world of equities portrayed by equity identifiers and vendors of equities related data. As a result, clients need to pay extra attention when integrating the Estimates API since there is a one to many relationship between a company in the clients eyes and Estimates Records. Thomson Reuters recommends that if at all possible this relationship is maintained and both records are shown.

14.3.3 Consensus Currency

Thomson Reuters often receives data for a given company in a variety of different currencies, either at a given point in time, or over time. Examples would include companies in the Euro zone, companies which switch domiciles or companies that have changed their reporting currency to come in line with an industry or sector norm. The Thomson Reuters database allows the addition of data in multiple currencies but will supply all estimates to clients in only one currency, known as the consensus currency. When data is received in any currency other than the consensus currency it is translated into the consensus currency using the exchange rate applicable from the date the estimate was made by the broker. This ensures that Thomson Reuters Estimates are comparable and allows an accurate consensus calculation without having problems with exchange rate fluctuations and consensus recalculations due to changes in exchange rates. The current consensus currency will, generally, be the currency of the country of primary listing; however, there will be exceptions. The decision as to what currency should be used depends on the company in question. Some examples of situations where a currency may be different to the country of primary listing are as follows:

Estimates

227

ADRs will be provided in the currency of the listing location (USD) rather than in the companys local currency. Often to conform to an industry norm companies may also report in different currencies, for example Oil, Gas and Mining companies will often report in US Dollars or the currency may relate to the main market in which the company trades. The US dollar may be used as a forecasting currency in emerging markets where the currencies are weak or unstable.

14.3.4 Adjustments for Capital Changes

All data is adjusted to reflect the current share capital of a company. When a capital change is applied to the Thomson Reuters database, this will automatically be applied to all data sets. Clients should note that capital changes are updated on the X-date and as such, the corporate event will not be reflected until that night, unless the client is using the service in real time. Thomson Reuters will refresh the data to reflect the new share capital in the daily file following the capital change effective date. The company information section contains the most recent capital change and effective date. Users wishing to track these can do so by monitoring this section over time. Care must be taken when using real time pricing alongside the Estimates service. Note: The terms capital change and share split are used interchangeably by Thomson Reuters in relation to estimates.

14.3.5 Unit Sizes

Each monetary data value will be supplemented by a unit size. For any given currency, the data will always be provided in the same unit size for all aggregate (per company) numbers and also for all per share numbers. The default size for aggregate data is millions and the default size for per share data is units. Unit Code U T M B P MC Description Units Thousands Millions Billions Percentage Minor Currency (0.01 of a Unit)

14.3.6 Periods
The service is designed to handle periods of all lengths. As well as the period end date, periods will be identified by the use of separate period identifiers. Where there are multiple periods per fiscal period, these will also carry a numeric value, whereby 1 will be the first in the fiscal period, 2 the second and so on: Period Annual Semi-Annual Quarterly Trimester* Monthly* Identifier A S Q T M Maximum Period Number 1 2 4 3 12

* Currently reserved for future use

14.3.7 Consensus Methodology

Thomson Reuters provides two different consensus types for monetary values. In general, Thomson Reuters recommends that clients use a Mean consensus for North America and Median calculation for other markets. Below is a summary of how

228

TRKD API Developer's Guide

Thomson Reuters calculates consensus. Method Mean Median Description of methodology A straight mathematical mean, after excluding any numbers which Thomson Reuters knows to be out of date or made on a different basis. Thomson Reuters manually excludes these numbers. A mathematical median. In addition as with the Mean calculation Thomson Reuters may exclude any forecasts it knows to have been made on a different basis, or which have been overtaken by events.

Our Consensus Recommendation methodology assigns a numerical value from one to five to each broker-specific recommendation. Where possible Thomson Reuters will capture the substance of the recommendation rather than its ascribed name. We work with our contributors to ensure that we map our numerical rating to their preferred value. As such some broker-specific Buy recommendations may map to a value of 1, whereas others may map to a value of 2. Recommend Value ation Buy Outperform Hold Sell No opinion 1 2 3 5 6

Underperform 4

Thomson Reuters also provides a consensus recommendation score for each company. This is a straight arithmetic mean rating based upon the standard values above, excluding the No Opinion recommendations. This is then given a textual label as follows: Mean Rating Range Less than or equal to 1.5 but greater than zero Less than or equal to 2.5 but more than 1.5 Less than or equal to 3.5 but more than 2.5 Less than or equal to 4.5 but more than 3.5 More than 4.5 but less than or equal to 5 Zero Consensus Recommendation Buy Outperform Hold Underperform Sell No opinions

14.3.8 Supplemental Recommendations

In addition to Short-Term Recommendations, Thomson Reuters provides Supplemental Recommendations, which follow the Short-Term Recommendations schema for detailed data. However, please note that due to the nature of Supplemental Recommendations, a consensus will not be provided.

14.3.9 Expected Announcement Dates

Thomson Reuters provides Expected Announcement Dates as an additional attribute under the <CompanyPeriods> element in the Estimates service. There are three key attributes for Expected Announcement Dates, which are noted in the following: expectDate: Date and time that company is expected to announce earnings. dateStatus: Describes whether or not an event is "C" confirmed or "T" tentative. marketPhase: Describes what part of the day a company is expected to report earnings, Before Market Opens = "1", During Market Opens = "2" or After Market Closes = "3".

Estimates

229

14.4

Company Section Supplemental Information

In the company section Thomson Reuters Estimates provides four flags to assist clients with particular issues they might come up against. Clients are under no obligation to use these flags; however, they can be useful when making decisions on how to display/use Thomson Reuters Estimates data.

14.4.1 Primary Consensus Type

The Primary Consensus Type shows which consensus Thomson Reuters recommends be used for each company. Reuters Estimates recommends the Mean for North American estimates and Median for Non North American estimates.

14.4.2 Primary Estimate Type

For North American Real Estate Investment Trust companies (REITs) the primary estimate type is Funds from Operations rather than EPS. Description Earnings Per Share Funds From Operation Code EPS FFO

14.4.3 Primary Earnings Type

Thomson Reuters provides estimates on up to three different bases of EPS and Profit for companies where this information is available and valuable. Many users will only wish to display one type of EPS and profit in views on the data. In order to pick the correct bases on a company per company basis it is necessary to refer to this field in the company file. The primary measure is calculated by constantly reviewing current data. The algorithm looks at the depth of data available on each basis for Fiscal Year 1 annual EPS and bases the results on this. Thomson Reuters recommends that clients use the same basis for EPS and Profit. Description Earnings Per Share Pre Exceptional Earnings Per Share GAAP Earnings Per Share Pre Exceptional and Per Goodwill Code EPS EPSREP EBG

14.4.4 Primary Periodicity Type

In addition to annual data, Thomson Reuters provides interim estimates where available (currently, Quarterly and Semiannual; Trimester and Monthly estimates may be provided in the future). Based on how estimates are supplied to us by contributing brokers, both semi-annual and quarterly data may be provided at the same time for some companies. Thomson Reuters provides a Primary Periodicity Type flag to assist clients in identifying the primary interim reporting cycle (quarterly or semi-annual) as defined by Thomson Reuters for each company. Description Annual Interim (Semi-Annual) Quarterly Trimester* Monthly* Code A S Q T M

* Currently reserved for future use.

230

TRKD API Developer's Guide

14.4.5 The Current Fiscal Year

To help with modeling Thomson Reuters provides the current fiscal year in the element <curFiscalPeriod>. The current period element can have three values: Q for Quarter, S for Semi Annual or A for Annual. The rules are as follows: If If If If a company a company a company a company reports only annually, it is A. reports annually and semiannually, it is S. reports annually and quarterly, it is Q. reports annually, quarterly and semiannually, it is Q.

14.5

Thomson Reuters Estimates Requests

This chapter provides information on requests found in Thomson Reuters Estimates and it has general examples for each request. The available requests are: Get Get Get Get Get Get Reference Information (GetReferenceInformation_1): Retrieves Estimates reference information. Security Information (GetSecurityInformation_1): Retrieves Estimates security information. Meta Information (GetMetaInformation_1): Retrieves Estimates meta information. Broker Coverage (GetBrokerCoverageInformation_1): Retrieves Estimates broker coverage information. Consensus (GetConsensus_1): Retrieves Estimates consensus information. Detailed (GetDetailed_1): Retrieves Estimates detailed information.

14.5.1 Understanding Reuters Estimates Request

The following example shows the existing attributes in Thomson Reuters Estimates requests: XSD
XSD: http://api.rkd.reuters.com/schemas/E stimates_1.xsd

XML Sample Reuters Estimates Request

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/E stimates_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/E stimates_1/ G etE arningsE stimates_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etC onsensus_Request_1 xmlns=xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/E stimates_1" companyIdT ype ="<Ty pe of company id>" companyId ="<C ompany id v alue>" lang="<Language code> (optional)" FiscalP er iods="<F iscal periods v alue> (optional)" FiscalP er iodH intsO nly="<F iscal P eriod H int v alue> (optional)" EstimateT ype="<E stimate ty pe v alue> (optional)" C onsensusT ype="<C onsensus ty pe v alue> (optional)" UseP r imar yEar ningsT ypeO nly="<U se only P rimary E arnings ty pe> (optional)" UseP r imar yC onsensusT ypeO nly="<U se only P rimary C onsensus ty pe> (optional)" UseP r imar yEstimateT ypeO nly="<U se only P rimary E stimate ty pe> (optional)" UseP r imar yP er iodicityT ypeO nly="<U se only P rimary P eriodicity ty pe> (optional)" DateT ype="<Date ty pe v alue> (optional)" H istor icalT r endO nly="<H istorical Trend v alue> (optional)" RealT ime="<U se Real time> (optional)" P er iodicity="<P eriodicity v alue> (optional)" ShowRefer enceInfor mation="<S how Reference information> (optional)" ShowSecur ityInfor mation="<S how S ecurity information> (optional)" ShowM etaInfor mation="<S how M eta information> (optional)" ShowBr oker C over ageInfor mation="<S how Broker C ov erage information> (optional)" ShowA ctualInfor mation="<S how A ctual information> (optional)"

Estimates

231

ShowSur pr iseInfor mation="<S how S urprise Information> (optional)" H ideP er iodic="<H ide periodic> (optional)" H ideNonP er iodic="<H ide non-periodic> (optional)" H ideRecommendation="<H ide recommendation> (optional)" C ategor y="<C ategoty v alue> (optional)" T r ansactionID="Transaction ID v alue"/> </Body > </E nv elope>

Attribute Description companyIdT This indicates what symbol or identifier that is being used to resolve the company. This can be RIC or ype Estimate ID. You can use Reuters Search to resolve company identifiers to Estimate ID. Note: Estimate ID allows you to easily select estimates from different accounting standards. See Definition of a Company in Reuters Estimates Snapshots section about company accounting standards. companyId This is the actual symbol value that is required to be resolved. lang This is the language code for the company which is being resolved. This should be used where possible to assist with the unique resolution of companies especially when trying to resolve tickers. Example: "en-US". FiscalPeriods This optional attribute determines the fiscal period(s) to be returned. The attribute accepts years (2010,2011) and does not accept hints (CURR,NEXT). If you want to use hints, you must use the FiscalPeriodHintsOnly attribute. FiscalPeriodH This optional attribute determines hints for the fiscal periods to be returned. The values can be combined in intsOnly a comma-separated string to allow for multiple periods and are applied to the Actuals, Detailed Estimates and Consensus Estimate sections. The possible values are: CURR: Forecast Year 1 (FY1), current fiscal year NEXT: Forecast Year 2 (FY2) NEXT2: Forecast Year 3 (FY3) NEXT3: Forecast Year 4 (FY4) NEXT4: Forecast Year 5 (FY5) PRVS: Current Actualized Year (FY0) PRVS2: Previous Actualized Year (FY-1) PRVS3: Previous Actualized Year (FY-2) * PRVS4: Previous Actualized Year (FY-3) * PRVS5: Previous Actualized Year (FY-4) * PRVS6: Previous Actualized Year (FY-5) * not specified: response will contain fiscal year estimates for all fiscal periods * Consensus estimates data will be provided for these periods. Detailed estimates data will not be provided. EstimateTyp (Estimate types) This optional attribute determines the data type(s) to be returned. The values can be e combined in a comma separated string to allow for multiple estimate types to be returned and are applied to the Actuals, Detailed Estimates and Consensus Estimate sections. The possible values are: EPS: Earnings Per Share (Pre Exceptional) EPSEBG: Earnings Per Share (Pre Exceptional and Pre Goodwill) EPSREP: Earnings Per Share (As Reported) FFO: Funds From Operations Per Share CPS: Cash Flow Per Share REVENUE: Revenue DPS: Dividends Per Share NAV: Net Asset Value NPROFIT: Net Profit (Pre Exceptional) NPROFITEBG: Net Profit (Pre Exceptional and Pre Goodwill) NPROFITREP: Net Profit (As Reported) PPROFIT: Pre-Tax Profit (Pre Exceptional) PPROFITEBG: Pre-Tax Profit (Pre Exceptional and Pre Goodwill) PPROFITREP: Pre-Tax Profit (As Reported) OPROFIT: Operating Profit RPROFIT: Recurring Profit EBITDA: EBITDA EBIT: EBIT STOPINION: Short Term Broker Rating LTGROWTH: Long Term Growth

232

TRKD API Developer's Guide

TARGETPRICE: Target Price SUPOPINION: Supplemental Opinion NDEBT: Net Debit ROA: Return On Assets ROE: Return On Equity CAPEX: Capital Expenditure BVPS: Book Value Per Share SLREVENUE: Software License Revenue B2BR: Book to Bill Ratio ARPU: Average Revenue Per Unit USALES: Unit Sales T1R: Tier 1 Ratio SUBSCRS: Subscribers OUTOILGAS: Output Oil and Gas $PRIMARY: Primary estimate (see Glossary for more information) not specified: response will contain all types of estimates ConsensusTy This optional attribute determines whether to use Consensus Type. pe UsePrimaryE This optional attribute determines whether to use only Primary Earnings Type when generating the arningsType response. Only The possible values are: true false UsePrimaryC This optional attribute determines whether to use only Primary Consensus Type when generating the onsensusTyp response. eOnly The possible values are: true false UsePrimaryE This optional attribute determines whether to use only Primary Estimate Type when generating the stimateType response. Only The possible values are: true false UsePrimaryP This optional attribute determines whether to use only Primary Periodicity Type when generating the eriodicityTyp response. eOnly The possible values are: true false DateType This optional value determines the date type to be used in the response. The possible values are: yyyy-mm-ddThh:mm:ss - date and time yyyy - year only yyyymm - year and month yyyy-mm-dd - year, month and day HistoricalTre The possible values are: ndOnly 3MonthTrend - 3 Month Trend 12MonthTrend - 12 Month Trend 18MonthTrend - 18 Month Trend 0To3691218Trend - 0 to 3691218 trend RealTime The possible values are: true false Periodicity This optional value determines for which period data must be collected. The possible values are: Annual Interim SemiAnnual Trimester Monthly Weekly PeriodicAll ShowReferen This optional attribute determines whether to show Reference Information when generating the response. ceInformatio The possible values are:

Estimates

233

n ShowSecurit yInformation

ShowMetaInf ormation

ShowBrokerC overageInfor mation

ShowActualI nformation

ShowSurpris eInformation

HidePeriodic

HideNonPerio dic

HideRecomm endation

Category

TransactionI D

true false This optional attribute determines whether to show Security Information when generating the response. The possible values are: true false This optional attribute determines whether to show Meta Information when generating the response. The possible values are: true false This optional attribute determines whether to show Broker Coverage Information when generating the response. The possible values are: true false This optional attribute determines whether to show Actual Information when generating the response. The possible values are: true false This optional attribute determines whether to show Surprise Information when generating the response. The possible values are: true false This optional attribute determines whether to hide Periodic in the response. The possible values are: true false This optional attribute determines whether to hide Non Periodic in the response. The possible values are: true false This optional attribute determines whether to hide Recommendation in the response. The possible values are: true false This indicates The possible values are: Default Analysis AndDetailed This optional attribute is empty by default.

14.5.2 Get Reference Information (GetReferenceInformation_1)

The following example shows how to retrieve reference information. XML Sample Request - Retrieving Reference Information
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/E stimates_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/E stimates_1/ G etReferenceInformation_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader>

234

TRKD API Developer's Guide

<Body > <G etReferenceInformation_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/E stimates_1" company Id=" IBM .N" company IdTy pe=" RIC " lang=" en-US " U seP rimary E arningsTy peO nly =" false " U seP rimary C onsensusTy peO nly =" false " U seP rimary E stimateTy peO nly =" false " U seP rimary P eriodicity Ty peO nly =" false " H istoricalTrendO nly =" 3 M onthT r end " RealTime=" false " P eriodicity =" P er iodicA ll " S how ReferenceInformation=" false " S how S ecurity Information=" false " S how M etaInformation=" false " S how BrokerC ov erageInformation=" false " S how A ctualInformation=" false " S how S urpriseInformation=" false " H ideP eriodic=" false " H ideN onP eriodic=" false " H ideRecommendation=" false " C ategory =" Default" TransactionID="" /> </Body > </E nv elope>

For more details on elements the request contains see section Understanding Reuters Estimates Request.

14.5.3 Get Security Information (GetSecurityInformation_1)

The following example shows how to retrieve security information for Microsoft. XML Sample Request - Retrieving Security Information
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/E stimates_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/E stimates_1/ G etS ecurity Information_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etS ecurity Information_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/E stimates_1" company Id=" M SFT .O " company IdTy pe=" RIC " lang=" en-US " U seP rimary E arningsTy peO nly =" false " U seP rimary C onsensusTy peO nly =" false " U seP rimary E stimateTy peO nly =" false " U seP rimary P eriodicity Ty peO nly =" false " H istoricalTrendO nly =" 3 M onthT r end " RealTime=" false " P eriodicity =" P er iodicA ll " S how ReferenceInformation=" false " S how S ecurity Information=" false " S how M etaInformation=" false " S how BrokerC ov erageInformation=" false " S how A ctualInformation=" false " S how S urpriseInformation=" false " H ideP eriodic=" false " H ideN onP eriodic=" false " H ideRecommendation=" false " C ategory =" Default" TransactionID="" /> </Body > </E nv elope>

Estimates

235

For more details on elements the request contains see section Understanding Reuters Estimates Request.

14.5.4 Get Meta Information (GetMetaInformation_1)

The following example shows how to retrieve Estimates Meta Information for CISCO. XML Sample Request - Retrieving Estimates Meta Information
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/E stimates_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/E stimates_1/ G etM etaInformation_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etM etaInformation_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/E stimates_1" company Id=" C SC O .O " company IdTy pe=" RIC " lang=" en-US " U seP rimary E arningsTy peO nly =" false " U seP rimary C onsensusTy peO nly =" false " U seP rimary E stimateTy peO nly =" false " U seP rimary P eriodicity Ty peO nly =" false " H istoricalTrendO nly =" 3 M onthT r end " RealTime=" false " P eriodicity =" P er iodicA ll " S how ReferenceInformation=" false " S how S ecurity Information=" false " S how M etaInformation=" false " S how BrokerC ov erageInformation=" false " S how A ctualInformation=" false " S how S urpriseInformation=" false " H ideP eriodic=" false " H ideN onP eriodic=" false " H ideRecommendation=" false " C ategory =" Default" TransactionID="" /> </Body > </E nv elope>

For more details on elements the request contains see section Understanding Reuters Estimates Request.

14.5.5 Get Broker Coverage Information (GetBrokerCoverageInformation_1)

The following example shows how to retrieve Estimates Broker Coverage Information for Vodafone. XML Sample Request - Retrieving Estimates Broker Coverage Information
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/E stimates_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/E stimates_1/ G etBrokerC ov erageInformation_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body >

236

TRKD API Developer's Guide

<G etBrokerC ov erageInformation_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/E stimates_1" company Id=" V O D.L " company IdTy pe=" RIC " lang=" en-US " U seP rimary E arningsTy peO nly =" false " U seP rimary C onsensusTy peO nly =" false " U seP rimary E stimateTy peO nly =" false " U seP rimary P eriodicity Ty peO nly =" false " H istoricalTrendO nly =" 3 M onthT r end " RealTime=" false " P eriodicity =" P er iodicA ll " S how ReferenceInformation=" false " S how S ecurity Information=" false " S how M etaInformation=" false " S how BrokerC ov erageInformation=" false " S how A ctualInformation=" false " S how S urpriseInformation=" false " H ideP eriodic=" false " H ideN onP eriodic=" false " H ideRecommendation=" false " C ategory =" Default" TransactionID="" /> </Body > </E nv elope>

For more details on elements the request contains see section Understanding Reuters Estimates Request.

14.5.6 Get Consensus (GetConsensus_1)

The following is a sample request for Vodafone Consensus information. XML Sample Request - Retrieving Consensus Information
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/E stimates_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/E stimates_1/ G etC onsensus_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etC onsensus_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/E stimates_1" company Id=" V O D.L " company IdTy pe="RIC " lang="en-U S " U seP rimary E arningsTy peO nly ="false" U seP rimary C onsensusTy peO nly ="false" U seP rimary E stimateTy peO nly ="false" U seP rimary P eriodicity Ty peO nly ="false" H istoricalTrendO nly ="3M onthTrend" RealTime="false" P eriodicity ="P eriodicA ll" S how ReferenceInformation="false" S how S ecurity Information="false" S how M etaInformation="false" S how BrokerC ov erageInformation="false" S how A ctualInformation="false" S how S urpriseInformation="false" H ideP eriodic="false" H ideN onP eriodic="false" H ideRecommendation="false" C ategory ="A ndDetailed" TransactionID="" /> </Body > </E nv elope>

Estimates

237

For more details on elements the request contains see section Understanding Reuters Estimates Request. The following sample request is for AOL Time Warner Target Price, EPS and Revenue estimates for the current and next fiscal year including historical consensus for the last 3 months: XML Sample Request - Get Earnings Estimate for All Aggregate levels and Multiple Estimate Types
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/E stimates_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/E stimates_1/ G etE arningsE stimates_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etC onsensus_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/E stimates_1" companyId="A O L.N" companyIdT ype="RIC " FiscalP er iods="C URR,NEXT " EstimateT ype="T A RGET P RIC E,EP S,REV ENUE" H istor icalT r endO nly="3 M onthT r end" C ategor y="Default"/> </Body > </E nv elope>

The following sample request is for Boots Company, Revenue for all years including historical consensus for the last 12 months: XML Sample Request - Get Earnings Estimate for All Aggregate levels and Multiple Estimate Types
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http:/api.rkd.reuters.com/api/2006/05/01/E stimates_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/E stimates_1/ G etE arningsE stimates_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etC onsensus_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/E stimates_1" companyId="BO O T .L" companyIdT ype="RIC " EstimateT ype="REV ENUE" H istor icalT r endO nly="1 2 M onthT r end" C ategor y="Default"/> </Body > </E nv elope>

14.5.7 Get Detailed (GetDetailed_1)

The following example shows how to retrieve Estimates Detailed Information for Microsoft. XML Sample Request - Retrieving Estimates Broker Coverage Information
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope">

238

TRKD API Developer's Guide

<H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/E stimates_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/E stimates_1/ G etDetailed_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etDetailed_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/E stimates_1" company Id=" M SFT .O " company IdTy pe=" RIC " lang=" en-US " U seP rimary E arningsTy peO nly =" false " U seP rimary C onsensusTy peO nly =" false " U seP rimary E stimateTy peO nly =" false " U seP rimary P eriodicity Ty peO nly =" false " H istoricalTrendO nly =" 3 M onthT r end " RealTime=" false " P eriodicity =" P er iodicA ll " S how ReferenceInformation=" false " S how S ecurity Information=" false " S how M etaInformation=" false " S how BrokerC ov erageInformation=" false " S how A ctualInformation=" false " S how S urpriseInformation=" false " H ideP eriodic=" false " H ideN onP eriodic=" false " H ideRecommendation=" false " C ategory =" Default" TransactionID="" /> </Body > </E nv elope>

For more details on elements the request contains see section Understanding Reuters Estimates Request.

14.6

Understanding Thomson Reuters Estimates Responses

The following is an example of Thomson Reuters Estimates Response: XML Sample Response - Reuters Estimates Response Overview
<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader> ... </s:H eader> <s:Body > <G etC onsensus_Response_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/E stimates_1"> <Refer enceInfor mation xmlns="http://schemas.r euter s.com/ns/2 0 0 8 /0 1 /1 2 /webser vices/r kd/C EDRefinfo_1 " M ajor ="1 " M inor ="0 " Revision="0 "> <RepN o>4741N </RepN o> <P roduction Date="2008-01-26T21:59:55" /> <C ompany Information> <C ompany Xrefs> <C ompany Xref Ty pe="IRS N o">130871985</C ompany Xref> <C ompany Xref Ty pe="C IKN o">0000051143</C ompany Xref> <C ompany Xref Ty pe="F P roXRef">100002523</C ompany Xref> <C ompany Xref Ty pe="O rgID">18228</C ompany Xref> <C ompany N ame Ty pe="P rimary ">International Business M achines C orp.</C ompany N ame> </C ompany Xrefs> <C ompany S tatus> <S tatus Ty pe="A ctiv eS tatus">true</S tatus> <S tatus Ty pe="C urrentE stimates">true</S tatus> <C ompany Ty pe="E Q U " /> <A v ailableInfo Ty pe="BusinessIntelligence">true</A v ailableInfo> <A v ailableInfo Ty pe="F inancials">true</A v ailableInfo> <A v ailableInfo Ty pe="E stimates">true</A v ailableInfo> <A v ailableInfo Ty pe="S ignificantDev elopment">true</A v ailableInfo>

Estimates

239

<A v ailableInfo Ty pe="O fficers">true</A v ailableInfo> <F ilingS tatus C urrentS tatus="F iling" ReasonC ode="0" /> <H asP ublicDebt>false</H asP ublicDebt> </C ompany S tatus> <C ompany U pdates> <LastM odified Ty pe="F inancials">2008-01-24T18:44:27</LastM odified> <LastM odified Ty pe="O ther">2008-01-25T10:22:02</LastM odified> <LatestInformation Ty pe="A nnualF inancials">2007-12-31</LatestInformation> <LatestInformation Ty pe="InterimF inancials">2007-12-31</LatestInformation> </C ompany U pdates> <C urrencies> <C urrency Ty pe="F inancialS tatements">U S D</C urrency > <C urrency Ty pe="E stimates">U S D</C urrency > <C urrency Ty pe="P rimary IssueP rice">U S D</C urrency > </C urrencies> <Industry C lassification> <Taxonomy Ty pe="RBS S 2004"> <Detail O rder="1" C ode="57211" Description="IT S erv ices & C onsulting" /> </Taxonomy > <Taxonomy Ty pe="N A IC S 1997"> <Detail O rder="1" C ode="541611" Description="A dministrativ e M anagement and G eneral M anagement C onsulting S erv ices" /> </Taxonomy > ... <Taxonomy Ty pe="M G IN DU S TRY"> <Detail O rder="1" C ode="0909" M nemonic="S V S BU S " Description="Business S erv ices" /> </Taxonomy > </Industry C lassification> </C ompany Information> <IssueInformation> <Issue ID="1" Ty pe="C " O rder="1"> <IssueXrefs> <IssueXref Ty pe="N ame">C ommon S tock</IssueXref> <IssueXref Ty pe="Ticker">IBM </IssueXref> <IssueXref Ty pe="RIC ">IBM </IssueXref> <IssueXref Ty pe="Display RIC ">IBM .N </IssueXref> </IssueXrefs> <IssueS tatus> <IssueTy pe>C ommon S tock</IssueTy pe> <S tatus Ty pe="A ctiv eS tatus">true</S tatus> <S tatus Ty pe="P ublicS tatus">true</S tatus> <S tatus Ty pe="E xpectedIP O ">false</S tatus> </IssueS tatus> <IssueS pecifics> <E xchange C ode="N YS E " C ountry ="U S A " Region="N A ">N ew York S tock E xchange</E xchange> <ListingTy pe>O S R</ListingTy pe> <M ostRecentS plit Date="1999-05-27">2.0</M ostRecentS plit> <S plitH istory > <S plit Date="1999-05-27">2.0</S plit> <S plit Date="1997-05-28">2.0</S plit> </S plitH istory > </IssueS pecifics> </Issue> <Issue ID="2" Ty pe="P " O rder="1"> <IssueXrefs> <IssueXref Ty pe="N ame">P referred S tock- 7.5% </IssueXref> </IssueXrefs> <IssueS tatus> <IssueTy pe>P referred S tock</IssueTy pe> <S tatus Ty pe="A ctiv eS tatus">true</S tatus> <S tatus Ty pe="P ublicS tatus">false</S tatus> <S tatus Ty pe="E xpectedIP O ">false</S tatus> </IssueS tatus> <IssueS pecifics> <E xchange C ode="N YS E " C ountry ="U S A " Region="N A ">N ew York S tock E xchange</E xchange> </IssueS pecifics> </Issue> </IssueInformation> </ReferenceInformation> <EstimatesSecur ityInfor mation xmlns="http://schemas.r euter s.com/ns/2 0 0 8 /0 1 /1 2 /webser vices/r kd/ EstimatesSecur ityA P I_1 " M ajor ="1 " M inor ="0 " Revision="0 "> <RepN o>4741N </RepN o> <C ompany N ame Ty pe="P rimary ">International Business M achines C orp.</C ompany N ame> <P roduction Date="2007-06-06T13:30:49" /> <S ecurity Info> <S ecurity code="1"> <E xchange code="N YS E ">N ew York S tock E xchange</E xchange>

240

TRKD API Developer's Guide

<C ountry code="U S A " set="M X">U nited S tates</C ountry > <S ecIds><S ecId set="LO C A L" ty pe="RIC ">IBM </S ecId> <S ecId set="LO C A L" ty pe="Display RIC ">IBM .N </S ecId> <S ecId set="LO C A L" ty pe="TIC KE R">IBM </S ecId> </S ecIds> <M arketData> <M arketDataItem updated="2005-10-10T00:00:00" currC ode="U S D" unit="U " ty pe="C LP RIC E ">81.250000</ M arketDataItem> <M arketDataItem currC ode="U S D" unit="U " ty pe="S H A RE S O U T">1484827275</M arketDataItem> <M arketDataItem currC ode="U S D" unit="M " ty pe="M A RKE TC A P ">120642.2161</M arketDataItem> <M arketDataItem updated="2005-01-03T00:00:00" currC ode="U S D" unit="U " ty pe="52WKH IG H ">99.1000</ M arketDataItem> <M arketDataItem updated="2005-04-20T00:00:00" currC ode="U S D" unit="U " ty pe="52WKLO W">71.8500</ M arketDataItem> <M arketDataItem currC ode="U S D" unit="N " ty pe="E V _C ur">171595.10000</M arketDataItem> <M arketDataItem currC ode="U S D" unit="N " ty pe="BE TA ">1.62492</M arketDataItem> <M arketDataItem currC ode="U S D" unit="N " ty pe="V O L3M A V G ">162.83565</M arketDataItem> </M arketData> <LastS plit splitDate="1999-05-27T00:00:00">2.0000</LastS plit> </S ecurity > </S ecurity Info> </E stimatesS ecurity Information> <EstimatesM etaInfor mation xmlns="http://schemas.r euter s.com/ns/2 0 0 8 /0 1 /1 2 /webser vices/r kd/ EstimatesM etaA P I_1 " M ajor ="1 " M inor ="0 " Revision="0 "> <RepN o>4741N </RepN o> <C ompany N ame Ty pe="P rimary ">International Business M achines C orp.</C ompany N ame> <P roduction Date="2007-06-06T13:30:49" /> <C ompany Info> <P rimary ty pe="E arnings">P RX</P rimary > <P rimary ty pe="C onsensus">M ean</P rimary > <P rimary ty pe="E stimate">E P S </P rimary > <P rimary ty pe="P eriodicity ">Q </P rimary > <P rimary ty pe="G eneral N ote">A C C O U N TIN G : C onsensus includes stock-based compensation.</P rimary > <C urrency code="U S D" ty pe="C O N S E N S U S " set="IS O ">U .S . Dollars</C urrency > <C urF iscalP eriod periodN um="2" periodTy pe="Q " fy em="12" fYear="2007" /> <C ompany P eriods> <A nnual fy N um="-5" fYear="2001" sYear="P RV S 6" endM onth="12" periodU nit="M N S " periodLength="12"> <Interim ty pe="Q " periodN um="1" endM onth="3" endC alYear="2001" periodU nit="M N S " periodLength="3" /> <Interim ty pe="Q " periodN um="2" endM onth="6" endC alYear="2001" periodU nit="M N S " periodLength="3" /> <Interim ty pe="Q " periodN um="3" endM onth="9" endC alYear="2001" periodU nit="M N S " periodLength="3" /> <Interim ty pe="Q " periodN um="4" endM onth="12" endC alYear="2001" periodU nit="M N S " periodLength="3" /> </A nnual> ... </C ompany P eriods> </C ompany Info> <M etaC ategory catname="A ctTy pes"> <M etaItem> <M etaV alue mv alue="F Y" mname="periodty pe" /> <M etaV alue mv alue="BV P S " mname="ty pe" /> <M etaV alue mv alue="2006" mname="fy ear" /> </M etaItem> ... <M etaItem> <M etaV alue mv alue="N P " mname="periodty pe" /> <M etaV alue mv alue="S U P O P IN IO N " mname="ty pe" /> </M etaItem> </M etaC ategory > </E stimatesM etaInformation> <EstimatesBr oker C over ageInfor mation xmlns="http://schemas.r euter s.com/ns/2 0 0 8 /0 1 /1 2 /webser vices/ r kd/EstimatesBr oker C over ageA P I_1 " M ajor ="1 " M inor ="0 " Revision="0 "> <RepN o>4741N </RepN o> <C ompany N ame Ty pe="P rimary ">International Business M achines C orp.</C ompany N ame> <P roduction Date="2007-06-06T13:30:49" /> <C ov erage> <Broker brokerN ame="M errill Ly nch" brokerId="U S _2"> <Teams> <Team teamId="U S _303859"> <A naly st analy stId="3G RP ">Richard F armer</A naly st> </Team> </Teams> </Broker> ... </C ov erage> </E stimatesBrokerC ov erageInformation> <EstimatesC onsensusInfor mation xmlns="http://schemas.r euter s.com/ns/2 0 0 8 /0 1 /1 2 /webser vices/r kd/ EstimatesC onsensusA P I_1 " M ajor ="1 " M inor ="0 " Revision="0 "> <RepN o>4741N </RepN o>

Estimates

241

<C ompany N ame Ty pe="P rimary ">International Business M achines C orp.</C ompany N ame> <P roduction Date="2007-06-06T13:30:49" /> <C onsE stimates> <F YE stimates> <F YE stimate unit="U " ty pe="BV P S "> <F YP eriod endM onth="12" endC alYear="2005" periodTy pe="A " fYear="2005"> <C onsE stimate ty pe="H igh"> <C onsV alue dateTy pe="C U RR">20.7500</C onsV alue> </C onsE stimate> <C onsE stimate ty pe="Low "> <C onsV alue dateTy pe="C U RR">19.0000</C onsV alue> </C onsE stimate> <C onsE stimate ty pe="M ean"> <C onsV alue dateTy pe="C U RR">19.9667</C onsV alue> </C onsE stimate> <C onsE stimate ty pe="S tdDev "> <C onsV alue dateTy pe="C U RR">0.7261</C onsV alue> </C onsE stimate> <C onsE stimate ty pe="N umO fE st"> <C onsV alue dateTy pe="C U RR">3</C onsV alue> </C onsE stimate> <C onsE stimate ty pe="M edian"> <C onsV alue dateTy pe="C U RR">20.1500</C onsV alue> </C onsE stimate> </F YP eriod> ... </F YE stimate> </F YE stimates> <N P E stimates> <N P E stimate unit="P " ty pe="LTG RO WTH "> <C onsE stimate ty pe="H igh"> <C onsV alue dateTy pe="C U RR">15.0000</C onsV alue> </C onsE stimate> <C onsE stimate ty pe="Low "> <C onsV alue dateTy pe="C U RR">8.0000</C onsV alue> </C onsE stimate> <C onsE stimate ty pe="M ean"> <C onsV alue dateTy pe="C U RR">10.5100</C onsV alue> </C onsE stimate> <C onsE stimate ty pe="S tdDev "> <C onsV alue dateTy pe="C U RR">1.6617</C onsV alue> </C onsE stimate> <C onsE stimate ty pe="N umO fE st"> <C onsV alue dateTy pe="C U RR">12</C onsV alue> </C onsE stimate> <C onsE stimate ty pe="M edian"> <C onsV alue dateTy pe="C U RR">10.0000</C onsV alue> </C onsE stimate> </N P E stimate> ... </N P E stimates> <Recommendations> <S TO pinion> <C onsO pinion desc="BU Y" code="1" set="S TD"> <C onsO pV alue unit="N " ty pe="N umO fE st"> <C onsV alue dateTy pe="C U RR">8</C onsV alue> </C onsO pV alue> </C onsO pinion> <C onsO pinion desc="O U TP E RF O RM " code="2" set="S TD"> <C onsO pV alue unit="N " ty pe="N umO fE st"> <C onsV alue dateTy pe="C U RR">8</C onsV alue> </C onsO pV alue> </C onsO pinion> <C onsO pinion desc="H O LD" code="3" set="S TD"> <C onsO pV alue unit="N " ty pe="N umO fE st"> <C onsV alue dateTy pe="C U RR">6</C onsV alue> ... </S TO pinion> </Recommendations> </C onsE stimates> </E stimatesC onsensusInformation> <EstimatesDetailedInfor mation xmlns="http://schemas.r euter s.com/ns/2 0 0 8 /0 1 /1 2 /webser vices/r kd/ EstimatesDetailedA P I_1 " M ajor ="1 " M inor ="0 " Revision="0 "> <RepN o>4741N </RepN o> <C ompany N ame Ty pe="P rimary ">International Business M achines C orp.</C ompany N ame> <P roduction Date="2007-06-06T13:30:49" /> <DetE stimates>

242

TRKD API Developer's Guide

<F YE stimates> <F YE stimate unit="U " ty pe="BV P S "> <F YP eriod endM onth="12" endC alYear="2005" periodTy pe="A " fYear="2005"> <DetE stimate teamId="U S _" brokerId="U S _67"> <E stV alue suppr="false" expir="2006-09-19T09:28:00" confirm="2006-01-13T14:45:27" orig="2006-0113T14:45:27" dateTy pe="C U RR">20.1500</E stV alue> </DetE stimate> <DetE stimate teamId="U S _384539" brokerId="U S _4589"> <E stV alue suppr="false" confirm="2005-10-28T14:30:00" orig="2005-10-28T14:30:00" dateTy pe="C U RR">20.7500</E stV alue> </DetE stimate> <DetE stimate teamId="U S _201373" brokerId="U S _11581"> <E stV alue suppr="false" confirm="2005-10-18T15:30:00" orig="2005-10-18T15:30:00" dateTy pe="C U RR">19.0000</E stV alue> </DetE stimate> </F YP eriod> <F YP eriod endM onth="12" endC alYear="2006" periodTy pe="A " fYear="2006"> <DetE stimate teamId="U S _384539" brokerId="U S _4589"> <E stV alue suppr="false" confirm="2006-11-06T18:14:03" orig="2006-11-06T18:14:03" dateTy pe="C U RR">23.1200</E stV alue> </DetE stimate> <DetE stimate teamId="U S _194815" brokerId="U S _9211"> <E stV alue suppr="false" confirm="2006-10-18T11:28:59" orig="2006-10-18T11:28:59" dateTy pe="C U RR">22.5400</E stV alue> </DetE stimate> ... </F YP eriod> </F YE stimate> </F YE stimates> <N P E stimates> <N P E stimate unit="P " ty pe="LTG RO WTH "> <DetE stimate teamId="U S _303859" brokerId="U S _2"> <E stV alue suppr="false" confirm="2007-05-11T22:26:04" orig="2002-01-28T21:01:00" dateTy pe="C U RR">10.0000</E stV alue> </DetE stimate> <DetE stimate teamId="U S _155877" brokerId="U S _27"> <E stV alue suppr="false" confirm="2007-02-07T11:22:18" orig="2003-11-18T23:43:00" dateTy pe="C U RR">11.0000</E stV alue> </DetE stimate> <DetE stimate teamId="U S _397588" brokerId="U S _85"> <E stV alue suppr="false" confirm="2007-04-18T13:55:21" orig="2006-11-06T19:08:03" dateTy pe="C U RR">9.0000</ E stV alue> </DetE stimate> ... </N P E stimate> ... </N P E stimates> <Recommendations> <S TO pinion> <DetO pinion teamId="U S _303859" brokerId="U S _2"> <O pinionV alue suppr="false" confirm="2007-05-11T22:26:04" orig="2006-10-18T05:00:34" dateTy pe="C U RR"> <O pC ode code="3" set="S TD">H O LD</O pC ode> <O pC ode code="2" set="BKR">N E U TRA L</O pC ode> </O pinionV alue> </DetO pinion> <DetO pinion teamId="U S _155877" brokerId="U S _27"> <O pinionV alue suppr="false" confirm="2007-02-07T11:22:18" orig="2005-04-29T14:22:40" dateTy pe="C U RR"> <O pC ode code="1" set="S TD">BU Y</O pC ode> <O pC ode code="B " set="BKR">BU Y</O pC ode> </O pinionV alue> </DetO pinion> ... </S TO pinion> <S upO pinion> <DetO pinion teamId="U S _303859" brokerId="U S _2"> <O pinionV alue confirm="2007-04-24T14:30:00" orig="2004-09-15T19:12:35" dateTy pe="C U RR"> <O pC ode code="B " set="BKR">M edium</O pC ode> </O pinionV alue> </DetO pinion> ... </S upO pinion> </Recommendations> </DetE stimates> </E stimatesDetailedInformation> </G etC onsensus_Response_1> </Body > </E nv elope>

Estimates

243

The response elements for Reuters Estimates requests contain the following sections: 1. 2. 3. 4. 5. 6. Reference Information Security Information Meta Information Broker Coverage Information Consensus Information Detailed Information

Below you can find elements that are common for all sections: Attribute RepNo CompanyName Description Report No. Primary Company Name.

Production Date Date and time for when the information was last generated.

14.6.1 Reference Information Section

The following format is an example of specifying the Reference Information section in analysis data for a company: XML Sample Response - Reference Information Section

<Refer enceInfor mation xmlns="http://schemas.r euter s.com/ns/2 0 0 8 /0 1 /1 2 /webser vices/r kd/C EDRefinfo_1 " M ajor ="1 " M inor ="0 " Revision="0 "> <RepN o>4741N </RepN o> <P roduction Date="2008-01-26T21:59:55" /> <C ompanyInfor mation> <C ompany Xrefs> <C ompany Xref Ty pe="IRS N o">130871985</C ompany Xref> <C ompany Xref Ty pe="C IKN o">0000051143</C ompany Xref> <C ompany Xref Ty pe="F P roXRef">100002523</C ompany Xref> <C ompany Xref Ty pe="O rgID">18228</C ompany Xref> <C ompany N ame Ty pe="P rimary ">International Business M achines C orp.</C ompany N ame> </C ompany Xrefs> <C ompany S tatus> <S tatus Ty pe="A ctiv eS tatus">true</S tatus> <S tatus Ty pe="C urrentE stimates">true</S tatus> <C ompany Ty pe="E Q U " /> <A v ailableInfo Ty pe="BusinessIntelligence">true</A v ailableInfo> <A v ailableInfo Ty pe="F inancials">true</A v ailableInfo> <A v ailableInfo Ty pe="E stimates">true</A v ailableInfo> <A v ailableInfo Ty pe="S ignificantDev elopment">true</A v ailableInfo> <A v ailableInfo Ty pe="O fficers">true</A v ailableInfo> <F ilingS tatus C urrentS tatus="F iling" ReasonC ode="0" /> <H asP ublicDebt>false</H asP ublicDebt> </C ompany S tatus> <C ompany U pdates> <LastM odified Ty pe="F inancials">2008-01-24T18:44:27</LastM odified> <LastM odified Ty pe="O ther">2008-01-25T10:22:02</LastM odified> <LatestInformation Ty pe="A nnualF inancials">2007-12-31</LatestInformation> <LatestInformation Ty pe="InterimF inancials">2007-12-31</LatestInformation> </C ompany U pdates> <C urrencies> <C urrency Ty pe="F inancialS tatements">U S D</C urrency > <C urrency Ty pe="E stimates">U S D</C urrency > <C urrency Ty pe="P rimary IssueP rice">U S D</C urrency > </C urrencies> <Industry C lassification> <Taxonomy Ty pe="RBS S 2004"> <Detail O rder="1" C ode="57211" Description="IT S erv ices & C onsulting" /> </Taxonomy > <Taxonomy Ty pe="N A IC S 1997"> <Detail O rder="1" C ode="541611" Description="A dministrativ e M anagement and G eneral M anagement C onsulting

244

TRKD API Developer's Guide

S erv ices" /> </Taxonomy > ... <Taxonomy Ty pe="M G IN DU S TRY"> <Detail O rder="1" C ode="0909" M nemonic="S V S BU S " Description="Business S erv ices" /> </Taxonomy > </Industry C lassification> </C ompany Information> <IssueInfor mation> <Issue ID="1" Ty pe="C " O rder="1"> <IssueXrefs> <IssueXref Ty pe="N ame">C ommon S tock</IssueXref> <IssueXref Ty pe="Ticker">IBM </IssueXref> <IssueXref Ty pe="RIC ">IBM </IssueXref> <IssueXref Ty pe="Display RIC ">IBM .N </IssueXref> </IssueXrefs> <IssueS tatus> <IssueTy pe>C ommon S tock</IssueTy pe> <S tatus Ty pe="A ctiv eS tatus">true</S tatus> <S tatus Ty pe="P ublicS tatus">true</S tatus> <S tatus Ty pe="E xpectedIP O ">false</S tatus> </IssueS tatus> <IssueS pecifics> <E xchange C ode="N YS E " C ountry ="U S A " Region="N A ">N ew York S tock E xchange</E xchange> <ListingTy pe>O S R</ListingTy pe> <M ostRecentS plit Date="1999-05-27">2.0</M ostRecentS plit> <S plitH istory > <S plit Date="1999-05-27">2.0</S plit> <S plit Date="1997-05-28">2.0</S plit> </S plitH istory > </IssueS pecifics> </Issue> <Issue ID="2" Ty pe="P " O rder="1"> <IssueXrefs> <IssueXref Ty pe="N ame">P referred S tock- 7.5% </IssueXref> </IssueXrefs> <IssueS tatus> <IssueTy pe>P referred S tock</IssueTy pe> <S tatus Ty pe="A ctiv eS tatus">true</S tatus> <S tatus Ty pe="P ublicS tatus">false</S tatus> <S tatus Ty pe="E xpectedIP O ">false</S tatus> </IssueS tatus> <IssueS pecifics> <E xchange C ode="N YS E " C ountry ="U S A " Region="N A ">N ew York S tock E xchange</E xchange> </IssueS pecifics> </Issue> </IssueInformation> </ReferenceInformation>

For more information on CompanyInformation see section Company Information. For more information on IssueInformation see section Issue Information.

14.6.1.1 Company Information

The following format is an example of company information contained in the Reference Information section in analysis data for a company: XML Sample Response - Company Information

<C ompanyInfor mation> <C ompany Xrefs> <C ompany Xref Ty pe="IRS N o">130871985</C ompany Xref> <C ompany Xref Ty pe="C IKN o">0000051143</C ompany Xref> <C ompany Xref Ty pe="F P roXRef">100002523</C ompany Xref> <C ompany Xref Ty pe="O rgID">18228</C ompany Xref> <C ompany N ame Ty pe="P rimary ">International Business M achines C orp.</C ompany N ame> </C ompany Xrefs> <C ompany S tatus> <S tatus Ty pe="A ctiv eS tatus">true</S tatus>

Estimates

245

<S tatus Ty pe="C urrentE stimates">true</S tatus> <C ompany Ty pe="E Q U " /> <A v ailableInfo Ty pe="BusinessIntelligence">true</A v ailableInfo> <A v ailableInfo Ty pe="F inancials">true</A v ailableInfo> <A v ailableInfo Ty pe="E stimates">true</A v ailableInfo> <A v ailableInfo Ty pe="S ignificantDev elopment">true</A v ailableInfo> <A v ailableInfo Ty pe="O fficers">true</A v ailableInfo> <F ilingS tatus C urrentS tatus="F iling" ReasonC ode="0" /> <H asP ublicDebt>false</H asP ublicDebt> </C ompany S tatus> <C ompany U pdates> <LastM odified Ty pe="F inancials">2008-01-24T18:44:27</LastM odified> <LastM odified Ty pe="O ther">2008-01-25T10:22:02</LastM odified> <LatestInformation Ty pe="A nnualF inancials">2007-12-31</LatestInformation> <LatestInformation Ty pe="InterimF inancials">2007-12-31</LatestInformation> </C ompany U pdates> <C urrencies> <C urrency Ty pe="F inancialS tatements">U S D</C urrency > <C urrency Ty pe="E stimates">U S D</C urrency > <C urrency Ty pe="P rimary IssueP rice">U S D</C urrency > </C urrencies> <Industry C lassification> <Taxonomy Ty pe="RBS S 2004"> <Detail O rder="1" C ode="57211" Description="IT S erv ices & C onsulting" /> </Taxonomy > <Taxonomy Ty pe="N A IC S 1997"> <Detail O rder="1" C ode="541611" Description="A dministrativ e M anagement and G eneral M anagement C onsulting S erv ices" /> </Taxonomy > ... <Taxonomy Ty pe="M G IN DU S TRY"> <Detail O rder="1" C ode="0909" M nemonic="S V S BU S " Description="Business S erv ices" /> </Taxonomy > </Industry C lassification> </C ompany Information>

Attribute CompanyXrefs CompanyXref Type

Description Company Reference Information. Type of reference. Contains the following attribute(s): FProXRef orgID - organization ID Type of company Name.

CompanyName Type

Contains the following attribute(s): Primary - primary company name Company Status Company Status. Status Type Lists all company statuses. Contains the following attribute(s): Active Status Current Estimates Company type. Types of available information. Contains the following attribute(s): BusinessIntellligence: can contain the following values:1. Financials: can contain the following values: 1. Estimates: can contain the following values: 1. SignificantDevelopment: can contain the following values:1. Officers: can contain the following values: 1. Filing status. Contains the following attribute(s): CurrentStatus: can contain the following value(s): Filing

Company Type AvailableInfo Type

FilingStatus

246

TRKD API Developer's Guide

HasPublicDebt

Has Public Debt. The possible values are: 0Information on last company updates.

Company Updates LastModifiedTyp Type of information modified last time. e Contains the following attribute(s): Financials - date when financials were modified last time. Other - date when other information was modified last time. LatestInformatio Type of information received latest nType Contains the following attribute(s): AnnualFinancials - date when annual financials were modified last time. InterimFinancials - date when interim financials were modified last time. Currencies Currency description. Currency Type Type of currency used. Contains the following attribute(s): FinancialStatements - currency used for Financial Statements. Estimates - currency used for Estimates. PrimaryIssuePrice - currency used for primary Issue price. RelatedCompani Related Companies. es Contains the following attribute(s): CompanyType: Primary Measure (where applicable) RepNo: Report Number Primary: Relationship IndustryClassific Industry Classification. ation TaxonomyType Taxonomy Type. Contains the following attribute(s): Detail Order: Code: Description: Mnemonic:

14.6.1.2 Issue Information

The following format is an example of issue information contained in the Reference Information section in analysis data for a company: XML Sample Response - Issue Information

<IssueInfor mation> <Issue ID="1" Ty pe="C " O rder="1"> <IssueXrefs> <IssueXref Ty pe="N ame">C ommon S tock</IssueXref> <IssueXref Ty pe="Ticker">IBM </IssueXref> <IssueXref Ty pe="RIC ">IBM </IssueXref> <IssueXref Ty pe="Display RIC ">IBM .N </IssueXref> </IssueXrefs> <IssueS tatus> <IssueTy pe>C ommon S tock</IssueTy pe> <S tatus Ty pe="A ctiv eS tatus">true</S tatus> <S tatus Ty pe="P ublicS tatus">true</S tatus> <S tatus Ty pe="E xpectedIP O ">false</S tatus> </IssueS tatus>

Estimates

247

<IssueS pecifics> <E xchange C ode="N YS E " C ountry ="U S A " Region="N A ">N ew York S tock E xchange</E xchange> <ListingTy pe>O S R</ListingTy pe> <M ostRecentS plit Date="1999-05-27">2.0</M ostRecentS plit> <S plitH istory > <S plit Date="1999-05-27">2.0</S plit> <S plit Date="1997-05-28">2.0</S plit> </S plitH istory > </IssueS pecifics> </Issue> <Issue ID="2" Ty pe="P " O rder="1"> <IssueXrefs> <IssueXref Ty pe="N ame">P referred S tock- 7.5% </IssueXref> </IssueXrefs> <IssueS tatus> <IssueTy pe>P referred S tock</IssueTy pe> <S tatus Ty pe="A ctiv eS tatus">true</S tatus> <S tatus Ty pe="P ublicS tatus">false</S tatus> <S tatus Ty pe="E xpectedIP O ">false</S tatus> </IssueS tatus> <IssueS pecifics> <E xchange C ode="N YS E " C ountry ="U S A " Region="N A ">N ew York S tock E xchange</E xchange> </IssueS pecifics> </Issue> </IssueInformation>

Attribute Issue ID Type Order IssueXrefs

Description Issue ID. Type of Issue. Order. Issue reference information. Contains the following attribute(s): Type: type of information, can contain the following values: Name Ticker RIC DisplayRIC

IssueStatus

Issue status. Contains the following attribute(s): Issue Type: type of Issue Status Type: can contain the following values: ActiveStatus PublicStatus ExperctedIPO

IssueSpecifics Exchange Code Country Region ListingType MostRecentSplit Date SplitHistory

Issue specifics. Exchange Code (example: "NYSE"). Country name (example: "USA"). Region name (example: "NA"). Listing Type (example: "OSR"). Most recent date when split occurred. Shows history of all splits.

14.6.2 Security Information Section

The following is an example of Security Information Section in the Thomson Reuters Estimates Response: XML Sample Response - Estimates Security Information Section

248

TRKD API Developer's Guide

<G etS ecurity Information_Response_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/E stimates_1"> <EstimatesSecur ityInfor mation xmlns="http://schemas.r euter s.com/ns/2 0 0 8 /0 1 /1 2 /webser vices/r kd/ EstimatesSecur ityA P I_1 " M ajor ="1 " M inor ="0 " Revision="0 "> <RepN o>4741N </RepN o> <C ompany N ame Ty pe="P rimary ">International Business M achines C orp.</C ompany N ame> <P roduction Date="2007-06-06T13:30:49" /> <Secur ityInfo> <S ecurity code="1"> <E xchange code="N YS E ">N ew York S tock E xchange</E xchange> <C ountry code="U S A " set="M X">U nited S tates</C ountry > <S ecIds> <S ecId set="LO C A L" ty pe="RIC ">IBM </S ecId> <S ecId set="LO C A L" ty pe="Display RIC ">IBM .N </S ecId> <S ecId set="LO C A L" ty pe="TIC KE R">IBM </S ecId> </S ecIds> <M arketData> <M arketDataItem updated="2005-10-10T00:00:00" currC ode="U S D" unit="U " ty pe="C LP RIC E ">81.250000</ M arketDataItem> <M arketDataItem currC ode="U S D " unit="U " ty pe="S H A RE S O U T">1484827275</M arketDataItem> <M arketDataItem currC ode="U S D " unit="M " ty pe="M A RKE TC A P ">120642.2161</M arketDataItem> <M arketDataItem updated="2005-01-03T00:00:00" currC ode="U S D" unit="U " ty pe="52WKH IG H ">99.1000</ M arketDataItem> <M arketDataItem updated="2005-04-20T00:00:00" currC ode="U S D" unit="U " ty pe="52WKLO W">71.8500</ M arketDataItem> <M arketDataItem currC ode="U S D" unit="N " ty pe="E V _C ur">171595.10000</M arketDataItem> <M arketDataItem currC ode="U S D" unit="N " ty pe="BE TA ">1.62492</M arketDataItem> <M arketDataItem currC ode="U S D " unit="N " ty pe="V O L3M A V G ">162.83565</M arketDataItem> </M arketData> <LastS plit splitDate="1999-05-27T00:00:00">2.0000</LastS plit> </S ecurity > </S ecurity Info> </E stimatesS ecurity Information> </G etS ecurity Information_Response_1> </Body > </E nv elope>

Attribute Security Code Exchange Code Country

Description Security Code (1 = primary issue). Exchange (example: "NYSE"). Country name (example: Great Britain).

Contains the following attribute(s): Set: can contain the following values: MX - Multex Country Set (for North American companies). GE - Global Estimates Country Set (for non-NorthAm countries). Code: Country Code (example: USA). SecIds Contains one or multiple SecurityID. MarketData Markert Data Section may contain multiple MarketDataItems. MarketDataItem Market Data Item. Contains the following attribute(s): type: can contain values : CLPRICE - Closing Price. SHARESOUT - Number of Shares Outstanding. This will always be expressed as units (U). MARKETCAP - Market Cap always expressed in Millions (M) and calculated as CLPRICE (converted to U where unit = MC) * SHARESOUT. 52WKHIGH - 52 week High. 52WKLOW - 52 Week Low. unit: can contain the following values: U - Major Currency Units (x1.00). T - Major Currency Units (x1.00). M - Millions ... (x1000000.00). B - Billions ...(x1000000000.00). MC - Minor Currency Units (x0.01). currcode: Currency Code ( Not applicable where type = SHARESOUT). (example:USD). Updated: Date of the close price. Only provided where type = CLPRICE (example: "2001-0516T00:00:00").

Estimates

249

LastSplit

The last split factor. Contains the following attribute(s): splitDate: Date & Time when the split occurred.

14.6.3 META Information Section

The following format is an example of specifying the Meta Information section in analysis data for a company: XML Sample Response - Estimates Meta Information Section

<G etM etaInformation_Response_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/E stimates_1"> <EstimatesM etaInfor mation xmlns="http://schemas.r euter s.com/ns/2 0 0 8 /0 1 /1 2 /webser vices/r kd/ EstimatesM etaA P I_1 " M ajor ="1 " M inor ="0 " Revision="0 "> <RepN o>4741N </RepN o> <C ompany N ame Ty pe="P rimary ">International Business M achines C orp.</C ompany N ame> <P roduction Date="2007-06-06T13:30:49" /> <C ompanyInfo> <P rimary ty pe="E arnings">P RX</P rimary > <P rimary ty pe="C onsensus">M ean</P rimary > <P rimary ty pe="E stimate">E P S </P rimary > <P rimary ty pe="P eriodicity ">Q </P rimary > <P rimary ty pe="G eneral N ote">A C C O U N TIN G : C onsensus includes stock-based compensation.</P rimary > <C urrency code="U S D " ty pe="C O N S E N S U S " set="IS O ">U .S . Dollars</C urrency > <C urF iscalP eriod periodN um="2" periodTy pe="Q " fy em="12" fYear="2007" /> <C ompany P eriods> <A nnual fy N um="-5" fYear="2001" sYear="P RV S 6" endM onth="12" periodU nit="M N S " periodLength="12"> <Interim ty pe="Q " periodN um="1" endM onth="3" endC alYear="2001" periodU nit="M N S " periodLength="3" /> <Interim ty pe="Q " periodN um="2" endM onth="6" endC alYear="2001" periodU nit="M N S " periodLength="3" /> <Interim ty pe="Q " periodN um="3" endM onth="9" endC alYear="2001" periodU nit="M N S " periodLength="3" /> <Interim ty pe="Q " periodN um="4" endM onth="12" endC alYear="2001" periodU nit="M N S " periodLength="3" /> </A nnual> ... </C ompany P eriods> </C ompany Info> < M etaC ategor y catname="A ctTy pes"> <M etaItem> <M etaV alue mv alue="F Y " mname="periodty pe" /> <M etaV alue mv alue="BV P S " mname="ty pe" /> <M etaV alue mv alue="2006" mname="fy ear" /> </M etaItem> ... <M etaItem> <M etaV alue mv alue="N P " mname="periodty pe" /> <M etaV alue mv alue="S U P O P IN IO N " mname="ty pe" /> </M etaItem> </M etaC ategory > </E stimatesM etaInformation> </G etM etaInformation_Response_1>

Attribute CompanyInfo Primary Currency

Description Company Info. Primary Measure (where applicable). Currency description (example: U.S. Dollars). Contains the following attribute(s): Set: Currency Set Type: Currency Type Code: Currency Code Current Fiscal Period. Contains the following attribute(s): fyear: Current Fiscal Year.

CurFiscalPeriod

250

TRKD API Developer's Guide

Company Periods Annual

fyem: Current Fiscal Years End Month. periodType: Current Fiscal Periods Type. A - Annual Q - Quarterly S - Semi-annual T - Trimester (R eserv ed for future use) M - Monthly (R eserv ed for future use) periodNum: Current Fiscal Periods Number (not provided for Annual period). Can contain values (1,2,3,4,5-12). Company Periods. Annual Period. Contains the following attribute(s): periodNum: Annual Period Number. Possible values are: -5,-4,-3,-2,-1, 0,1,2,3,4,5. fYear: Current Fiscal Year. endMonth: Period End Month. periodUnit: Determines what the period is made up of. Can have the following values: M - Month W - Week periodLength: Number of units in the period. expectDate: Date & Time of excepted announcement date. (example: "2005-08-29T00:00:00"). dateStatus: Confirmed (C) or Tentative (T). marketPhase: can have the following values: 1 (Before Market Opens), 2 (During Market Open) or 3 (After Market Close). Interim. Contains the following attribute(s): type: Interim type. Can have the following values: Q - Quarter S - Semi-annual T - Trimester (R eserv ed for future use) M - Monthly (R eserv ed for future use) periodNum: Fiscal Periods Number. endMonth: Period End Month. endCalyear: The Calendar for the current period. periodUnit: Determines what the period is made up of. Can have the following values: MNS - Months WKS - Weeks periodLength: Number of units in the period. ExpectedDate: Date & Time of excepted announcement date. (example: "2005-0829T00:00:00"). dateStatus: Confirmed (C) or Tentative (T). marketPhase: can have the following values: 1 (Before Market Opens), 2 (During Market Open) or 3 (After Market Close). Meta Information Category. Contains the following Attribute(s): Type EstTypes - Estimate Type Category. ActTypes - Actual Type Category. Meta Information Item. Meta Information Value. Contains the following Attribute(s): mname: Meta Value Name type - Estimate/Actual Type periodtype - Period Type (for periodic estimates/actuals) fyear - Fiscal Year (for the FY estimates) mvalue: Meta Value. If mname="type" then mvalue can have the following values: EPS - EPS based on earnings pre exceptional and post goodwill.

Interim

MetaCategory

MetaItem MetaValue

Estimates

251

FFO - North American companies only. REVENUE - Revenue DPS - Dividends Per Share based on earnings pre exceptional and post goodwill. NAV - NAV NPROFIT - Net Profit based on earnings pre exceptional and post goodwill. OPROFIT - Operating Profit PPROFIT - Pre-tax Profit based on earnings pre exceptional and post goodwill. RPROFIT - Recurring Profit CPS - Cash Flow Per Share EBITDA - EBITDA EBIT - EBITA EPSREP - EPS reported or GAAP basis. EPSEBG - EPS based on earnings pre goodwill and pre exceptional NPROFITREP - Net Profit reported or GAAP basis NPROFITEBG - Net Profit based on earnings pre goodwill and pre exceptional PPROFITREP - Pre Tax Profit reported or GAAP basis PPROFITEBG - Pre Tax Profit based on earnings pre goodwill and pre exceptional BVPS - Book Value Per Share NDEBT - Net Debt CAPEX - Capital Expenditure SLREVENUE - Software License Revenue ARPU - Average Revenue Per Unit USALES - Unit Sales T1R - Tier 1 Ratio B2BR- Book to Bill Ratio SUBSCRS - Subscribers OUTOILGAS - Output, Oil and Gas ROA - Return on Assets ROE - Return on Equity LTGROWTH- Long Term Growth TARGETPRICE - Target Price STOPINION - Short Term Opinion If mname="periodtype" then mvalue can have the following values: FY - Fiscal Year Estimate NP - Non-periodic Estimate If mtype="fyear" then mvalue should have the Fiscal Year value.

14.6.4 Broker Coverage Information Section

The following format is an example of specifying the Estimates Broker Coverage Information section in analysis data for a company: XML Sample Response -Broker Coverage Information Section

<G etBrokerC ov erageInformation_Response_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/E stimates_1"> <EstimatesBr oker C over ageInfor mation xmlns="http://schemas.r euter s.com/ns/2 0 0 8 /0 1 /1 2 /webser vices/r kd/ EstimatesBr oker C over ageA P I_1 " M ajor ="1 " M inor ="0 " Revision="0 "> <RepN o>4741N </RepN o> <C ompany N ame Ty pe="P rimary ">International Business M achines C orp.</C ompany N ame> <P roduction Date="2007-06-06T13:30:49" /> <C over age> <Broker brokerN ame="M errill Ly nch" brokerId="U S _2"> <Teams> <Team teamId="U S _303859"> <A naly st analy stId="3G RP ">Richard F armer</A naly st> </Team> </Teams> </Broker> ... </C ov erage> </E stimatesBrokerC ov erageInformation> </G etBrokerC ov erageInformation_Response_1>

252

TRKD API Developer's Guide

Attribute Coverage Broker

Description Coverage information. Broker Information. Contains the following Attribute(s): brokerId: Broker ID (example: GL_31). brokerName: Broker Name (example: JP Morgan).

Teams Team

Teams Section. Team Info. Contains the following Attribute(s): teamid

Analyst

Analyst. Contains the following Attribute(s): analystid

14.6.5 Consensus Information Section

The following format is an example of specifying the Estimates Consensus Information section in analysis data for a company: XML Sample Response - Estimates Consensus Information Section

<G etC onsensus_Response_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/E stimates_1"> <EstimatesC onsensusInfor mation xmlns="http://schemas.r euter s.com/ns/2 0 0 8 /0 1 /1 2 /webser vices/r kd/ EstimatesC onsensusA P I_1 " M ajor ="1 " M inor ="0 " Revision="0 "> <RepN o>4741N </RepN o> <C ompany N ame Ty pe="P rimary ">International Business M achines C orp.</C ompany N ame> <P roduction Date="2007-06-06T13:30:49" /> <C onsE stimates> <F YE stimates> <F YE stimate unit="U " ty pe="BV P S "> <F YP eriod endM onth="12" endC alYear="2005" periodTy pe="A " fYear="2005"> <C onsE stimate ty pe="H igh"> <C onsV alue dateTy pe="C U RR">20.7500</C onsV alue> </C onsE stimate> <C onsE stimate ty pe="Low "> <C onsV alue dateTy pe="C U RR ">19.0000</C onsV alue> </C onsE stimate> <C onsE stimate ty pe="M ean"> <C onsV alue dateTy pe="C U RR ">19.9667</C onsV alue> </C onsE stimate> <C onsE stimate ty pe="S tdDev "> <C onsV alue dateTy pe="C U RR">0.7261</C onsV alue> </C onsE stimate> <C onsE stimate ty pe="N umO fE st"> <C onsV alue dateTy pe="C U RR ">3</C onsV alue> </C onsE stimate> <C onsE stimate ty pe="M edian"> <C onsV alue dateTy pe="C U RR ">20.1500</C onsV alue> </C onsE stimate> </F YP eriod> ... </F YE stimate> </F YE stimates> <N P E stimates> <N P E stimate unit="P " ty pe="LTG RO WTH "> <C onsE stimate ty pe="H igh"> <C onsV alue dateTy pe="C U RR ">15.0000</C onsV alue> </C onsE stimate> <C onsE stimate ty pe="Low "> <C onsV alue dateTy pe="C U RR ">8.0000</C onsV alue>

Estimates

253

</C onsE stimate> <C onsE stimate ty pe="M ean"> <C onsV alue dateTy pe="C U RR ">10.5100</C onsV alue> </C onsE stimate> <C onsE stimate ty pe="S tdDev "> <C onsV alue dateTy pe="C U RR ">1.6617</C onsV alue> </C onsE stimate> <C onsE stimate ty pe="N umO fE st"> <C onsV alue dateTy pe="C U RR ">12</C onsV alue> </C onsE stimate> <C onsE stimate ty pe="M edian"> <C onsV alue dateTy pe="C U RR ">10.0000</C onsV alue> </C onsE stimate> </N P E stimate> ... </N P E stimates> <Recommendations> <S TO pinion> <C onsO pinion desc="BU Y " code="1" set="S TD"> <C onsO pV alue unit="N " ty pe="N umO fE st"> <C onsV alue dateTy pe="C U RR ">8</C onsV alue> </C onsO pV alue> </C onsO pinion> ... </S TO pinion> </Recommendations> </C onsE stimates> </E stimatesC onsensusInformation> </G etC onsensus_Response_1>

Attribute ConsEstimates FYEstimates FYEstimate

Description Consensus Estimates Section. Fiscal Year Estimates contains multiple FYEstimate items. Fiscal Year Estimate. Contains the following attribute(s): Type: Estimate Type EPS - EPS based on earnings pre exceptional and post goodwill. FFO - North American companies only. REVENUE - Revenue. DPS - Dividends Per Share based on earnings pre exceptional and post goodwill. NAV - NAV. NPROFIT - Net Profit based on earnings pre exceptional and post goodwill. OPROFIT - Operating Profit. PPROFIT - Pre-tax Profit based on earnings pre exceptional and post goodwill. RPROFIT - Recurring Profit. CPS - Cash Flow Per Share. EBITDA - EBITDA. EBIT - EBITA. EPSREP - EPS reported or GAAP basis. EPSEBG - EPS based on earnings pre goodwill and pre exceptional. NPROFITREP - Net Profit reported or GAAP basis. NPROFITEBG - Net Profit based on earnings pre goodwill and pre exceptional. PPROFITREP - Pre Tax Profit reported or GAAP basis. PPROFITEBG - Pre Tax Profit based on earnings pre goodwill and pre exceptional. BVPS - Book Value Per Share. NDEBT - Net Debt. CAPEX - Capital Expenditure. SLREVENUE - Software License Revenue. ARPU - Average Revenue Per Unit. USALES - Unit Sales. T1R - Tier 1 Ratio. B2BR- Book to Bill Ratio. SUBSCRS - Subscribers. OUTOILGAS - Output, Oil and Gas. ROA - Return on Assets.

254

TRKD API Developer's Guide

FYPeriod

ROE - Return on Equity. Units: Estimate units U - Major Currency Units (x1.00). T - Thousands of Major CU (x1000.00). M - Millions ... (x1000000.00). B - Billions ... (x1000000000.00). MC - Minor Currency Units (x0.01). P - Percent (%). Fiscal Year Period. Contains the following attribute(s): fyear: Fiscal Year periodType: Fiscal Periods Type. Can have the following values: A - Annual Q - Quarterly S - Semi-annual T - Trimester (R eserv ed for future use) M - Monthly (R eserv ed for future use) periodNum: Fiscal Periods Number (not provided for Annual period). Can contain values (1,2,3,4,5-12). endCalYear: Period End Calendar Year. endMonth: Period End Month. Consensus Estimate. Contains the following attribute(s): type: Consensus Estimate Type. Can have the following values: High - High Estimate. Low - Low Estimate. Mean - Mean Estimate (primary consensus measure for North American companies). Median - Median Estimate (primary consensus measure for non-NorthAm companies). StdDev - Standard Deviation. NumOfEst - Number of Estimates. Upgradings - Number of Estimates upgraded. (Consensus Analysis Only) Dngradings - Number of Estimates downgraded. (Consensus Analysis Only) consvalue Contains the following attribute(s): dateType: Date Type. Can have the following values: CURR - Current Estimate ( note applicable for Upgradings or Dngradings). 1WA - Median / Mean value as of last week. Number of upgrades / downgrades between last week and current estimates (Consensus Analysis Only). 1MA - Median / Mean value as of last month. Number of upgrades / downgrades between last month and current estimates (Consensus Analysis Only). 2MA - Median / Mean value as of 2 months ago. Number of upgrades /downgrades between 2 months ago and current estimates (Consensus Analysis Only). 3MA- Median / Mean value as of 3 months ago. Number of upgrades / downgrades between 3 months ago and current estimates (Consensus Analysis Only). 4MA - Median / Mean value as of 4months ago (Consensus Analysis Only). 5MA - Median / Mean value as of 5 months ago (Consensus Analysis Only). 6MA - Median / Mean value as of 6 months ago (Consensus Analysis Only). 7MA - Median / Mean value as of 7 months ago (Consensus Analysis Only). 8MA - Median / Mean value as of 8 months ago (Consensus Analysis Only). 9MA - Median / Mean value as of 9 months ago (Consensus Analysis Only). 10MA - Median / Mean value as of 10 months ago (Consensus Analysis Only). 11MA - Median / Mean value as of 11 months ago (Consensus Analysis Only). 12MA - Median / Mean value as of 12 months ago (Consensus Analysis Only). 13MA - Median / Mean value as of 13 months ago (Consensus Analysis Only). 14MA - Median / Mean value as of 14 months ago (Consensus Analysis Only). 15MA - Median / Mean value as of 15 months ago (Consensus Analysis Only). 16MA - Median / Mean value as of 16 months ago (Consensus Analysis Only). 17MA - Median / Mean value as of 17 months ago (Consensus Analysis Only). 18MA - Median / Mean value as of 18 months ago (Consensus Analysis Only). Non-Periodic Estimates section. Non-Periodic Estimate.

ConsEstimate

ConsValue

NPEstimates NPEstimate

Estimates

255

ConsEstimate

Contains the following attribute(s): type: Estimate Type. Can have the following values: TARGETPRICE - Target Price LTGROWTH Long - Term Growth Rate unit: Estimate units. Can have the following values: U - Major Currency Units (x1.00) T - Thousands of Major CU (x1000.00) M - Millions ... (x1000000.00) B - Billions ... (x1000000000.00) MC - Minor Currency Units (x0.01) P - Percent (%) Consensus Estimate.

Contains the following attribute(s): type: Consensus Estimate Type. Can have the following values: High - High Estimate Low - Low Estimate Mean - Mean Estimate (primary consensus measure for North American companies) Median - Median Estimate (primary consensus measure for non-NorthAm companies) StdDev - Standard Deviation NumOfEst - Number of Estimates Upgradings - Number of Estimates upgraded. (Consensus Analysis Only) Dngradings - Number of Estimates downgraded. (Consensus Analysis Only) Recommendatio Recommendations. ns STOpinion Opinions. ConsOpinion Consensus Opinion. Contains the following attribute(s): set: Opinion Set. Can have the following values: STD - Standard code: Opinion Code. Can have the following values: 1 - Buy 2 - Outperfrom 3 - Hold 4 - Underperform 5 - Sell 6 - No Opinion desc:. Opinion Description. Can have the following values: BUY - Buy OUTPERFROM - Outperfrom HOLD - Hold UNDERPERFORM - Underperform SELL - Sell NA - No Opinion

14.6.6 Detailed Information Section

The following format is an example of specifying the Estimates Detailed Information section in analysis data for a company: XML Sample Response - Estimates Detailed Information Section

<G etDetailed_Response_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/E stimates_1"> <EstimatesDetailedInfor mation xmlns="http://schemas.r euter s.com/ns/2 0 0 8 /0 1 /1 2 /webser vices/r kd/ EstimatesDetailedA P I_1 " M ajor ="1 " M inor ="0 " Revision="0 "> <RepN o>4741N </RepN o> <C ompany N ame Ty pe="P rimary ">International Business M achines C orp.</C ompany N ame> <P roduction Date="2007-06-06T13:30:49" /> <DetE stimates> <F YE stimates> <F YE stimate unit="U " ty pe="BV P S ">

256

TRKD API Developer's Guide

<F YP eriod endM onth="12" endC alYear="2005" periodTy pe="A " fYear="2005"> <DetE stimate teamId="U S _" brokerId="U S _67"> <E stV alue suppr="false" expir="2006-01-13T14:45:27" confirm="2005-12-21T15:30:00" orig="2005-12-21T15:30:00" dateTy pe="P RV 1">20.1600</E stV alue> <E stV alue suppr="false" expir="2006-09-19T09:28:00" confirm="2006-01-13T14:45:27" orig="2006-01-13T14:45:27" dateTy pe="C U RR">20.1500</E stV alue> </DetE stimate> <DetE stimate teamId="U S _384539" brokerId="U S _4589"> <E stV alue suppr="false" confirm="2005-10-28T14:30:00" orig="2005-10-28T14:30:00" dateTy pe="C U RR">20.7500</E stV alue> </DetE stimate> <DetE stimate teamId="U S _201373" brokerId="U S _11581"> <E stV alue suppr="false" confirm="2005-10-18T15:30:00" orig="2005-10-18T15:30:00" dateTy pe="C U RR">19.0000</E stV alue> </DetE stimate> </F YP eriod> ... </F YE stimate> </F YE stimates> <N P E stimates> <N P E stimate unit="P " ty pe="LTG RO WTH "> <DetE stimate teamId="U S _303859" brokerId="U S _2"> <E stV alue suppr="false" confirm="2007-05-11T22:26:04" orig="2002-01-28T21:01:00" dateTy pe="C U RR">10.0000</ E stV alue> </DetE stimate> <DetE stimate teamId="U S _155877" brokerId="U S _27"> <E stV alue suppr="false" confirm="2007-02-07T11:22:18" orig="2003-11-18T23:43:00" dateTy pe="C U RR">11.0000</ E stV alue> </DetE stimate> <DetE stimate teamId="U S _397588" brokerId="U S _85"> <E stV alue suppr="false" confirm="2007-04-18T13:55:21" orig="2006-11-06T19:08:03" dateTy pe="C U RR">9.0000</ E stV alue> </DetE stimate> <DetE stimate teamId="U S _155188" brokerId="U S _3202"> <E stV alue suppr="false" confirm="2007-04-25T17:30:04" orig="2005-01-19T19:14:28" dateTy pe="C U RR">8.0000</ E stV alue> </DetE stimate> <DetE stimate teamId="U S _406131" brokerId="U S _3414"> <E stV alue suppr="false" confirm="2007-04-24T21:04:20" orig="2007-04-24T21:04:20" dateTy pe="C U RR">10.0000</ E stV alue> <E stV alue suppr="false" expir="2007-04-24T21:04:20" confirm="2007-04-17T13:46:19" orig="2007-04-17T13:46:19" dateTy pe="P RV 1">12.0000</E stV alue> </DetE stimate> <DetE stimate teamId="U S _393203" brokerId="U S _5451"> <E stV alue suppr="false" confirm="2007-04-24T19:26:16" orig="2007-04-24T19:26:16" dateTy pe="C U RR">11.1200</ E stV alue> <E stV alue suppr="false" expir="2007-04-24T19:26:16" confirm="2007-04-17T14:41:12" orig="2006-09-07T20:56:27" dateTy pe="P RV 1">11.0000</E stV alue> </DetE stimate> <DetE stimate teamId="U S _159597" brokerId="U S _8504"> <E stV alue suppr="false" confirm="2007-04-24T15:14:41" orig="2001-12-12T05:00:00" dateTy pe="C U RR">12.0000</ E stV alue> </DetE stimate> <DetE stimate teamId="U S _194815" brokerId="U S _9211"> <E stV alue suppr="false" confirm="2007-05-09T13:30:00" orig="2006-07-18T05:00:00" dateTy pe="C U RR">10.0000</ E stV alue> </DetE stimate> <DetE stimate teamId="U S _161789" brokerId="U S _9584"> <E stV alue suppr="false" confirm="2007-04-25T00:00:00" orig="2006-04-20T00:00:00" dateTy pe="C U RR">10.0000</ E stV alue> <E stV alue suppr="false" expir="2006-04-20T00:00:00" confirm="2006-03-30T00:00:00" orig="2006-01-06T00:00:00" dateTy pe="P RV 1">12.0000</E stV alue> </DetE stimate> <DetE stimate teamId="U S _157330" brokerId="U S _10333"> <E stV alue suppr="false" confirm="2007-04-23T11:15:04" orig="2005-04-18T20:01:06" dateTy pe="C U RR">10.0000</ E stV alue> <E stV alue suppr="false" expir="2005-04-18T20:01:06" confirm="2005-04-15T20:01:16" orig="2005-04-15T20:01:16" dateTy pe="P RV 1">15.0000</E stV alue> </DetE stimate> <DetE stimate teamId="U S _201373" brokerId="U S _11581"> <E stV alue suppr="false" confirm="2007-04-18T11:54:54" orig="2005-05-05T18:19:00" dateTy pe="C U RR">10.0000</ E stV alue> <E stV alue suppr="false" expir="2005-05-05T18:19:00" confirm="2005-04-18T20:52:19" orig="2005-04-18T20:52:19" dateTy pe="P RV 1">11.3000</E stV alue> </DetE stimate> <DetE stimate teamId="U S _372336" brokerId="U S _20481"> <E stV alue suppr="false" confirm="2007-04-18T17:14:41" orig="2006-07-17T15:25:48" dateTy pe="C U RR">15.0000</

Estimates

257

E stV alue> </DetE stimate> </N P E stimate> ... </N P E stimates> <Recommendations> <S TO pinion> <DetO pinion teamId="U S _303859" brokerId="U S _2"> <O pinionV alue suppr="false" confirm="2007-05-11T22:26:04" orig="2006-10-18T05:00:34" dateTy pe="C U RR"> <O pC ode code="3" set="S TD">H O LD</O pC ode> <O pC ode code="2" set="BKR">N E U TRA L</O pC ode> </O pinionV alue> <O pinionV alue suppr="false" expir="2006-10-18T05:00:34" confirm="2006-10-18T03:39:30" orig="2002-1017T06:30:00" dateTy pe="P RV 1"> <O pC ode code="1" set="S TD">BU Y</O pC ode> <O pC ode code="1" set="BKR">BU Y</O pC ode> </O pinionV alue> </DetO pinion> ... </S TO pinion> <S upO pinion> <DetO pinion teamId="U S _303859" brokerId="U S _2"> <O pinionV alue confirm="2007-04-24T14:30:00" orig="2004-09-15T19:12:35" dateTy pe="C U RR"> <O pC ode code="B " set="BKR">M edium</O pC ode> </O pinionV alue> </DetO pinion> ... </S upO pinion> </Recommendations> </DetE stimates> </E stimatesDetailedInformation> </G etDetailed_Response_1>

Attribute DetEstimates FYEstimates FYEstimate

Description Detailed Estimates Section. Fiscal Year Estimates contains multiple FYEstimate items. Fiscal Year Estimate. Contains the following attribute(s): Type: Estimate Type EPS - EPS based on earnings pre exceptional and post goodwill. FFO - North American companies only. REVENUE - Revenue. DPS - Dividends Per Share based on earnings pre exceptional and post goodwill. NAV - NAV. NPROFIT - Net Profit based on earnings pre exceptional and post goodwill. OPROFIT - Operating Profit. PPROFIT - Pre-tax Profit based on earnings pre exceptional and post goodwill. RPROFIT - Recurring Profit. CPS - Cash Flow Per Share. EBITDA - EBITDA. EBIT - EBITA. EPSREP - EPS reported or GAAP basis. EPSEBG - EPS based on earnings pre goodwill and pre exceptional. NPROFITREP - Net Profit reported or GAAP basis. NPROFITEBG - Net Profit based on earnings pre goodwill and pre exceptional. PPROFITREP - Pre Tax Profit reported or GAAP basis. PPROFITEBG - Pre Tax Profit based on earnings pre goodwill and pre exceptional. BVPS - Book Value Per Share. NDEBT - Net Debt. CAPEX - Capital Expenditure. SLREVENUE - Software License Revenue. ARPU - Average Revenue Per Unit. USALES - Unit Sales. T1R - Tier 1 Ratio. B2BR- Book to Bill Ratio. SUBSCRS - Subscribers. OUTOILGAS - Output, Oil and Gas.

258

TRKD API Developer's Guide

FYPeriod

ROA - Return on Assets. ROE - Return on Equity. Units: Estimate units U - Major Currency Units (x1.00). T - Thousands of Major CU (x1000.00). M - Millions ... (x1000000.00). B - Billions ... (x1000000000.00). MC - Minor Currency Units (x0.01). P - Percent (%). Fiscal Year Period. Contains the following attribute(s): fyear: Fiscal Year periodType: Fiscal Periods Type. Can have the following values: A - Annual Q - Quarterly S - Semi-annual T - Trimester (R eserv ed for future use) M - Monthly (R eserv ed for future use) periodNum: Fiscal Periods Number (not provided for Annual period). Can contain values (1,2,3,4,5-12). endCalYear: Period End Calendar Year. endMonth: Period End Month. Detailed Estimate. Contains the following attribute(s): teamID brokerID Estimate value. Contains the following attribute(s): dateType: Date Type. Can have the following values: CURR - Current Estimate ( note applicable for Upgradings or Dngradings). 1WA - Median / Mean value as of last week. Number of upgrades / downgrades between last week and current estimates (Consensus Analysis Only). 1MA - Median / Mean value as of last month. Number of upgrades / downgrades between last month and current estimates (Consensus Analysis Only). 2MA - Median / Mean value as of 2 months ago. Number of upgrades /downgrades between 2 months ago and current estimates (Consensus Analysis Only). 3MA- Median / Mean value as of 3 months ago. Number of upgrades / downgrades between 3 months ago and current estimates (Consensus Analysis Only). 4MA - Median / Mean value as of 4months ago (Consensus Analysis Only). 5MA - Median / Mean value as of 5 months ago (Consensus Analysis Only). 6MA - Median / Mean value as of 6 months ago (Consensus Analysis Only). 7MA - Median / Mean value as of 7 months ago (Consensus Analysis Only). 8MA - Median / Mean value as of 8 months ago (Consensus Analysis Only). 9MA - Median / Mean value as of 9 months ago (Consensus Analysis Only). 10MA - Median / Mean value as of 10 months ago (Consensus Analysis Only). 11MA - Median / Mean value as of 11 months ago (Consensus Analysis Only). 12MA - Median / Mean value as of 12 months ago (Consensus Analysis Only). 13MA - Median / Mean value as of 13 months ago (Consensus Analysis Only). 14MA - Median / Mean value as of 14 months ago (Consensus Analysis Only). 15MA - Median / Mean value as of 15 months ago (Consensus Analysis Only). 16MA - Median / Mean value as of 16 months ago (Consensus Analysis Only). 17MA - Median / Mean value as of 17 months ago (Consensus Analysis Only). 18MA - Median / Mean value as of 18 months ago (Consensus Analysis Only). Non-Periodic Estimates section. Non-Periodic Estimate. Contains the following attribute(s): type: Estimate Type. Can have the following values: TARGETPRICE - Target Price LTGROWTH Long - Term Growth Rate unit: Estimate units. Can have the following values:

DetEstimate

EstValue

NPEstimates NPEstimate

Estimates

259

U - Major Currency Units (x1.00) T - Thousands of Major CU (x1000.00) M - Millions ... (x1000000.00) B - Billions ... (x1000000000.00) MC - Minor Currency Units (x0.01) P - Percent (%) Recommendatio Recommendations. ns STOpinion Opinions. DetOpinion Consensus Opinion. Contains the following attribute(s): set: Opinion Set. Can have the following values: STD - Standard code: Opinion Code. Can have the following values: 1 - Buy 2 - Outperfrom 3 - Hold 4 - Underperform 5 - Sell 6 - No Opinion desc:. Opinion Description. Can have the following values: BUY - Buy OUTPERFROM - Outperfrom HOLD - Hold UNDERPERFORM - Underperform SELL - Sell NA - No Opinion SupOpinions.

SupOpinion

260

TRKD API Developer's Guide

chapter 15

File Content Retrieval

The File Content Retrieval service returns the content of the requested file as the response. The service can be used when you need to display a message that is independent of user entitlements like Privacy Policy or End User Agreement.

15.1

Authentication and Authorization

Authorization All requests to the TRKD API require an authorization token. For details, see section Understanding Authentication Tokens. Authentication TRKD API uses Reuters impersonation tokens for each effective user. In this case, Thomson Reuters must create each user before your application authenticates them. Unmanaged effective users are not supported in TRKD API. See section Creating a Token for more information.

15.2

File Content Retrieval (RetrieveFileContent_1)

The RetrieveFileContent_1 is a special type of service. Requests to this service are made via HTTP GET, request parameters are passed in URL, authentication information is passed in HTTP cookies. The service returns the content of the requested file as the response. The following example retrieves the content of the 'eua.txt' file: Http Sample Request - Retrieving File Content
http://api.rkd.reuters.com/api/2008/01/12/F ileC ontentRetriev al_1.sv c/files/en-us/eua.txt C ookie: RkdA ppId= [A ppID]; RkdToken=[RkdToken]

Http Sample Response - Retrieving File Content

H TTP /1.1 200 O K C ontent-Disposition: inline; filename=eua.txt C ontent-Title: eua.txt C ontent-Length: 15520 C ache-C ontrol: public, must-rev alidate, max-age=0 C ontent-Ty pe: text/html Date: Tue, 25 M ar 2008 15:36:22 G M T E xpires: Tue, 25 M ar 2008 15:36:22 G M T E Tag: http://api.rkd.reuters.com/api/2008/01/12/F ileC ontentRetriev al_1.sv c/files/en-us/eua.txt Tue, 18 M ar 2008 12:44:16 G M T Last-M odified: Tue, 18 M ar 2008 17:44:16 G M T S erv er: M icrosoft-IIS /6.0 X-A spN et-V ersion: 2.0.50727 X-P ow ered-By : A S P .N E T

15.3

Error Handling
If the file does not exist, the response returns HTTP status 401.

File Content Retrieval

261

The service logs the errors in the following HTTP headers: - RkdFaultCode : the EventID full name - RkdFaultReason: exception message - ClientErrorReference : unique error reference number Please check HTTP headers to find the cause of errors.

262

TRKD API Developer's Guide

chapter 16

Fund Screener

The Fund Screener provides easy access to funds from Lipper's extensive database of collective investments, allowing clients to quickly find funds based on hundreds of criteria items and to compare those funds across a wide range of timely characteristics. Thomson Reuters Fund Screener provides users with highly selective fund-related information based on their specific requirements. These requirements form the selection criteria, stated in terms of expressions and variables. The high level of flexibility possible in the specification of the selection criteria guarantees the desired granularity in the information made available by Fund Screener. The source data used by Fund Screener comes from the Lipper database. DataSets are generated from the database and provide up-to-date information on more than 400,000 funds, from all over the world. This information includes fundamental, financial, analytical, statistical, and research data. The ability to select from such high quality, up-to-date and varied data provides the users the best tools to assist them in the decision making process. You can use the following operations in order to retrieve Fund Screener data: Get Screening Meta Data (GetScreeningMetaData_1) - retrieves meta data for screening expressions. Get Screening Counts (GetScreeningCounts_1) - use this method to start a new screening operation or alter an existing screening operation. Get Screening Results Synch (GetScreeningResultsSynch_1) - gets the screening results.

16.1

Authentication/Authorization, Service Endpoint, and Required Headers

Authorization All requests to Fund Screener service require an authorization token. For details, see section Understanding Authentication Tokens. Authentication Fund Screener uses Reuters impersonation tokens for each effective user. In this case, Thomson Reuters must create each user before your application authenticates them. Unmanaged effective users are not supported in Fund Screener. For additional information on creating a Service Token, see section Creating a Token. Service Endpoint Fund Screener Endpoint
http://api.rkd.reuters.com/api/2009/01/01/LipperS creening_1.sv c

Required Header Required HTTP Headers

P O S T /api/2009/01/01/LipperS creening_1.sv c H TTP /1.1 C ontent-Ty pe: application/soap+xml H ost: api.rkd.reuters.com C ontent-Length: [length]

Fund Screener

263

16.2

WSDL
WSDL:
http://api.rkd.reuters.com/schemas/w sdl/LipperS creening_1_H ttpA ndRKDToken.w sdl

16.3

How to Get Screen Results?

In order to get screen results you need to do the following: 1. Use GetScreeningCounts_1 method to start a new screening operation. Pass 'null' for 'operationId' and specify a set of criteria. See section Get Screening Counts (GetScreeningCounts_1) for more details. 2. Use the GetScreeningResultsSynch_1 method to retrieve the data.

16.4

Get Screening Meta Data (GetScreeningMetaData_1)

Use the GetScreeningMetaData_1 method to retrieve the metadata for screening expressions. Metadata for each language is different and currently Fund Screener supports the following languages: Chinese Simplified Chinese Taiwan Dutch English French German Italian Japanese Korean Language Neutral (default) Spanish Thai Traditional Chinese XML Sample Request - Getting Screening Meta Data
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperS creening_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperS creening_1/ G etS creeningM etaData_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etS creeningM etaData_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperS creening_1"> <language>C hineseSimplified</language> </G etS creeningM etaData_Request_1> </Body > </E nv elope>

The response returns a DataSet that is organized by rows into a parent/child structure. The rows in the DataSet can represent a criteria category, such as "Attributes"; a criteria field, such as "Domiciles"; or a value for a criteria field, such as "Japan" for Domicile. XML Sample Response - Getting Screening Meta Data
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing">

264

TRKD API Developer's Guide

<s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperS creening_1/ G etS creeningM etaData_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etS creeningM etaData_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperS creening_1"> <S creeningM etaDataResult> <xs:schema id="N ew DataS et" xmlns:xs="http://w w w .w 3.org/2001/XM LS chema" xmlns="" xmlns:msdata="urn:schemasmicrosoft-com:xml-msdata" xmlns:msprop="urn:schemas-microsoft-com:xml-msprop"> <xs:element name="N ew DataS et" msdata:IsDataS et="true" msdata:U seC urrentLocale="true"> <xs:complexTy pe> <xs:choice minO ccurs="0" maxO ccurs="unbounded"> <xs:element name="Table"> <xs:complexTy pe> <xs:sequence> <xs:element name="C A P TIO N _ID" msprop:O raDbTy pe="112" ty pe="xs:int" minO ccurs="0"/> <xs:element name="P A RE N T_C A P TIO N _ID" msprop:O raDbTy pe="112" ty pe="xs:int" minO ccurs="0"/> <xs:element name="LA N G U A G E _ID" msprop:O raDbTy pe="107" ty pe="xs:decimal" minO ccurs="0"/> <xs:element name="N A M E " msprop:O raDbTy pe="119" ty pe="xs:string" minO ccurs="0"/> <xs:element name="V A RIA BLE _TYP E _ID" msprop:O raDbTy pe="112" ty pe="xs:int" minO ccurs="0"/> <xs:element name="DE F A U LT_LO G IC A L_O P E RA TO R_ID" msprop:O raDbTy pe="112" ty pe="xs:int" minO ccurs="0"/> <xs:element name="E DITO R_ID" msprop:O raDbTy pe="107" ty pe="xs:decimal" minO ccurs="0"/> <xs:element name="IN _RE S U LTS " msprop:O raDbTy pe="107" ty pe="xs:decimal" minO ccurs="0"/> </xs:sequence> </xs:complexTy pe> </xs:element> </xs:choice> </xs:complexTy pe> </xs:element> </xs:schema> <diffgr:diffgram xmlns:diffgr="urn:schemas-microsoft-com:xml-diffgram-v 1" xmlns:msdata="urn:schemas-microsoft-com:xmlmsdata"> <N ew DataS et xmlns=""> <Table diffgr:id="Table1" msdata:row O rder="0"> <C A P TIO N _ID>12232</C A P TIO N _ID> <P A RE N T_C A P TIO N _ID>10619</P A RE N T_C A P TIO N _ID> <LA N G U A G E _ID>2</LA N G U A G E _ID> <N A M E >BV I E q S ect Raw M at/E nergy </N A M E > <V A RIA BLE _TYP E _ID>2</V A RIA BLE _TYP E _ID> <DE F A U LT_LO G IC A L_O P E RA TO R_ID>0</DE F A U LT_LO G IC A L_O P E RA TO R_ID> <E DITO R_ID>0</E DITO R_ID> <IN _RE S U LTS >0</IN _RE S U LTS > </Table> <Table diffgr:id="Table2" msdata:row O rder="1"> <C A P TIO N _ID>32241</C A P TIO N _ID> <P A RE N T_C A P TIO N _ID>32307</P A RE N T_C A P TIO N _ID> <LA N G U A G E _ID>2</LA N G U A G E _ID> <N A M E >P ercentage G row th - 3 M onth Rank</N A M E > <V A RIA BLE _TYP E _ID>4</V A RIA BLE _TYP E _ID> <DE F A U LT_LO G IC A L_O P E RA TO R_ID>1</DE F A U LT_LO G IC A L_O P E RA TO R_ID> <E DITO R_ID>5</E DITO R_ID> <IN _RE S U LTS >1</IN _RE S U LTS > </Table> <Table diffgr:id="Table3" msdata:row O rder="2"> <C A P TIO N _ID>10981</C A P TIO N _ID> <P A RE N T_C A P TIO N _ID>10953</P A RE N T_C A P TIO N _ID> <LA N G U A G E _ID>2</LA N G U A G E _ID> <N A M E >C ambial O utros sem alav ancagem</N A M E > <V A RIA BLE _TYP E _ID>2</V A RIA BLE _TYP E _ID> <DE F A U LT_LO G IC A L_O P E RA TO R_ID>0</DE F A U LT_LO G IC A L_O P E RA TO R_ID> <E DITO R_ID>0</E DITO R_ID> <IN _RE S U LTS >0</IN _RE S U LTS > </Table> .... <Table diffgr:id="Table3611" msdata:row O rder="3610"> <C A P TIO N _ID>845</C A P TIO N _ID> <P A RE N T_C A P TIO N _ID>27820</P A RE N T_C A P TIO N _ID> <LA N G U A G E _ID>4842</LA N G U A G E _ID> <N A M E > </N A M E > <V A RIA BLE _TYP E _ID>2</V A RIA BLE _TYP E _ID>

Fund Screener

265

<DE F A U LT_LO G IC A L_O P E RA TO R_ID>1</DE F A U LT_LO G IC A L_O P E RA TO R_ID> <E DITO R_ID>1</E DITO R_ID> <IN _RE S U LTS >1</IN _RE S U LTS > </Table> </N ew DataS et> </diffgr:diffgram> </S creeningM etaDataResult> </G etS creeningM etaData_Response_1> </Body > </E nv elope>

The DataSet includes the following items for each row: Attribute CAPTION_ID PARENT_CAPTION_ID LANGUAGE_ID NAME VARIABLE_TYPE_ID Description All rows in the DataSet contain a numerical CaptionID that represents the row value. It is used in GetScreeningCounts_1 and GetScreeningResultsSynch_1 operations. The Caption ID number of the row's parent row. The language of the data in the row. You set this in the language parameter when invoking GetScreeningMetaData_1 method. The name of the criteria group, criteria field, or value. For internal Lipper use only.

DEFAULT_LOGICAL_OPERA The logical operator (AND or OR) to be used when joining multiple instances of the same criteria TOR field in a screening operation. For example, OR is the default logical operator for Caption ID "299" (Domicile) because an asset can only have one domicile country in the Lipper database. EDITOR_ID IN_RESULTS For internal Lipper use only. Defines whether this variable will be included only in the criteria or in results as well.

16.5

Get Screening Counts (GetScreeningCounts_1)

Use the GetScreeningCounts_1 method to start a new screening operation or alter an existing screening operation. The method takes the <screeningOperationId> parameter (pass null to start a new screening operation) and a set of criteria. Fund Screener remembers the specified set of criteria as 'operationId'. Later, when you need to retrieve the data itself, you can just pass 'operationId' without the list of criteria. XML Sample Request - Getting Screening Counts
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperS creening_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperS creening_1/ G etS creeningcounts_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etS creeningC ounts_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperS creening_1"> <screeningO perationId/> <screeningC riteria> <S creeningS tepC riteria> <C riteria> <C riteriaItem> <O penP arenC ount>0</O penP arenC ount> <C ompareV alue>100</C ompareV alue> <C ompareV alueDataTy pe>N umber</C ompareV alueDataTy pe> <C urrency >U S D</C urrency > <U niv erse>U S A </U niv erse> <O peration>G reaterThanO rE qual</O peration> <S electedItem>32271</S electedItem> <C loseP arenC ount>0</C loseP arenC ount>

266

TRKD API Developer's Guide

<LogicalO perator xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> </C riteriaItem> </C riteria> </S creeningS tepC riteria> </screeningC riteria> <language>E nglish</language> </G etS creeningC ounts_Request_1> </Body > </E nv elope>

Parameter OpenParenCount CompareValue

Description Specifies the number of open parentheses for this criteria item. Parentheses are used to group criteria items together so that the criteria group executes as one criteria item. Specifies the compare value or criteria value that will be compared or evaluated in the screening operation. The criteria value will be a Caption ID from the screening metadata only for those criteria where the value was selected from a list - for example: country, currency, etc. For example, if <SelectedItem> is set to "1034" for Asset Type, <CompareValue> might be "1035" for Money Market. For criteria where values are entered manually - for example, date, number, etc - then the entered value is specified in <CompareValue> and <CompareValueDataType> specifies data type for <CompareValue>.

CompareValueDataTyp Defines the data type of the <CompareValue>. Allowed values for <CompareValueDataType>: e MetaData Date Number String Currency Symbol Currency Universe Operation Sets the currency (three-digit currency code) used in this criteria item. The alphabetic universe code (f.e. 'USA', 'ITA', etc). There are 30 universes in the Lipper database, and assets belong to one or more universes. Specifies the comparison operator used in this criteria item. Can have the following values: None GreaterThan GreaterThanOrEqual LessThan LessThanOrEqual Equal NotEqual Contains StartsWith NotContains NotStartsWith Defines the selected item or criteria field. The criteria field value will be a Caption ID from the screening metadata. For example, "1034" for the Asset Type criteria field. Specifies the number of closed parentheses for this criteria item. Parentheses are used to group criteria items together so that the criteria group executes as one criteria item. Defines the logical operator, which joins this criterion to the next criteria. Possible values are: And Or

SelectedItem CloseParenCount LogicalOperator

The response returns operationId and number of funds that meet the specified criteria. XML Sample Response - Getting Screening Counts
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperS creening_1/ G etS creeningC ounts_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date>

Fund Screener

267

<DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etS creeningC ounts_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperS creening_1"> <G etS creeningC ountsResult> <S creeningO perationId>C D8758E 8968B41D98E C 7158E 4E 263255</S creeningO perationId> <S teps> <S tepC ount> <C ount>28</C ount> </S tepC ount> </S teps> </G etS creeningC ountsResult> </G etS creeningC ounts_Response_1> </Body > </E nv elope>

Attribute ScreeningOperationId StepCount

Description The screening operation ID. The screening step counts.

16.6

Get Screening Results Synch (GetScreeningResultsSynch_1)

GetScreeningResultsSynch_1 method gets the screening results synch. XML Sample Request - Getting Screening Results Synch
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperS creening_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperS creening_1/ G etS creeningResultsS y nch_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etS creeningResultsS y nch_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperS creening_1"> <screeningO perationId>C D8758E 8968B41D98E C 7158E 4E 263255</screeningO perationId> <columnsF ilter> <int>28029</int> <int>32271</int> </columnsF ilter> <generateResultset>true</generateResultset> </G etS creeningResultsS y nch_Request_1> </Body > </E nv elope>

Parameter Description screeningOperationId The screening operation id. pagingSortingFilter The paging sorting filter. Can have the following attributes: PageNumber - sets the page number. RowsPerPage - sets the rows per page. SortColumn - sets sort column. SortDirection - sets sort direction. screeningGridFilter The screening grid filter. Can have the following attributes: ClassificationScheme - sets the classification scheme. Currency - sets the currency. Language - sets the language. Universe - sets the universe.

268

TRKD API Developer's Guide

columnsFilter generateResultset

The columns filter. Contain a list of Column IDs to be retrieved by the request. If set to true generates resultset. Note: You should set <generateResultset> to 'true' only when making the request for the first time. All consecutive times, you should set <GenerateResultset> to 'false' unless you change the screening criteria used to generate the counts.

The response returns funds and their data according to the specified criteria: XML Sample Response - Getting Screening Results Synch
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperS creening_1/ G etS creeningResultsS y nch_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etS creeningResultsS y nch_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperS creening_1"> <G etS creeningResultsS y nchResult> <Results> <S creeningG ridRow > <LipperId>65060311</LipperId> <V alues> <G ridV alue> <C olumn>28029</C olumn> <V alue xsi:ty pe="p8:string" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:p8="http://w w w .w 3. org/2001/XM LS chema">Brazilian Real</V alue> </G ridV alue> <G ridV alue> <C olumn>32271</C olumn> <V alue xsi:ty pe="p8:decimal" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:p8="http://w w w .w 3. org/2001/XM LS chema">120.3040</V alue> </G ridV alue> </V alues> </S creeningG ridRow > <S creeningG ridRow > <LipperId>65060312</LipperId> <V alues> <G ridV alue> <C olumn>28029</C olumn> <V alue xsi:ty pe="p8:string" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:p8="http://w w w .w 3. org/2001/XM LS chema">Brazilian Real</V alue> </G ridV alue> <G ridV alue> <C olumn>32271</C olumn> <V alue xsi:ty pe="p8:decimal" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:p8="http://w w w .w 3. org/2001/XM LS chema">121.9315</V alue> </G ridV alue> </V alues> </S creeningG ridRow > ... <S creeningG ridRow > <LipperId>65065859</LipperId> <V alues> <G ridV alue> <C olumn>28029</C olumn> <V alue xsi:ty pe="p8:string" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:p8="http://w w w .w 3. org/2001/XM LS chema">Brazilian Real</V alue> </G ridV alue> <G ridV alue> <C olumn>32271</C olumn> <V alue xsi:ty pe="p8:decimal" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:p8="http://w w w .w 3. org/2001/XM LS chema">136.7597</V alue> </G ridV alue> </V alues> </S creeningG ridRow > </Results> </G etS creeningResultsS y nchResult>

Fund Screener

269

</G etS creeningResultsS y nch_Response_1> </Body > </E nv elope>

Attribute LipperId Values

Description A unique eight- or nine-digit number that identifies an asset. The list of <GridValue> elements. A GridValue represents one cell in the grid. Contains the following subelements: Column - the column's ID. Value - the column's value.

270

TRKD API Developer's Guide

chapter 17

Fundamentals

You can access Thomson Reuters Fundamentals through the Thomson Reuters Knowledge API for timely, accurate, and comprehensive financial information. The information is collected in an "as reported" and "company specific" manner. The "as reported" aspect indicates that financial values are not adjusted or changed. The "company specific" aspect indicates that Thomson Reuters is able to collect and display financial statement information while retaining each companys line item descriptions, currencies, periods etc. Thomson Reuters Fundamentals includes: industry aggregates fundamental reference data ratios and statistics company-specific and standardized financials originally reported and restated information business and geographic segments business descriptions and web-links officers and directors company's competitors and customers consistency with other Thomson Reuters Company Databases, such as Thomson Reuters Estimates and Business Intelligence databases

17.1

Authentication/Authorization, Service Endpoint, and Required Headers

Authorization All requests to the Fundamentals service require an authorization token. For details, see section Understanding Authentication Tokens. Authentication Fundamentals use Reuters impersonation tokens for each effective user. In this case, Thomson Reuters must create each user before your application authenticates them. Unmanaged effective users are not supported in Fundamentals. For additional information on creating a Service Token, see section Creating a Token. Service Endpoint Fundamentals Endpoint
http://api.rkd.reuters.com/api/2009/01/26/F undamentals_1.sv c

Required Header Required HTTP Headers

P O S T /api/2009/01/26/F undamentals_1.sv c H TTP /1.1 C ontent-Ty pe: application/soap+xml H ost: api.rkd.reuters.com C ontent-Length: [length]

17.2

WSDL
WSDL:
http://api.rkd.reuters.com/schemas/w sdl/F undamentals_1_H ttpA ndRKDToken.w sdl

Fundamentals

271

17.3

Interpreting Common Fundamental Elements

Many of the Thomson Reuters Knowledge Direct API fundamentals methods use common request and response elements for company identifiers, issues, and general company information. The following requests all use 'companyId' and 'companyIdType' attributes and return 'CoIDs', 'Issues', and 'CoGeneralInfo' elements: GetLongCompanyDescription_1 GetMajorCustomers_1 GetCompetitors_1 GetRatiosStatistics_1 GetFinancialStatementsReports_1 GetRatiosReports_1 GetSnapshotReports_1

17.3.1 companyIdType and companyId - Request Attributes

The companyId attribute is used across all Fundamentals requests to identify a particular company for which to obtain information. The value of this attribute is dependent upon the company being queried and the value of the companyIdType attribute. The companyIdType attribute specifies what type of company identifier is being used in companyId. "repono" provides the greatest probability of targeting the desired company because a repono is a unique, un-ambiguous identifier for fundamentals information and does not require symbology resolution. This value is case-insensitive. Value TICKER RIC REPONO Description Exchange ticker symbol Reuters Instrument Code Unique ID for companies in the Fundamentals API Example TRIN TRIN.O B0867

17.3.2 CoIDs - Response Element

The CoIDs element provides detail on company level identifiers and is similar to the CompanyXRef information found in financials responses. These identifiers are issued at a company level - therefore there is only one of each for every company. Please note that the required attribute 'RepNo' is the permanent identifier for a company in the Thomson Reuters database. XML Sample - CoIDs Response Element
<C oIDs xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ompany C ontentC ommon_1"> <C oID Ty pe="RepN o">B0867</C oID> <C oID Ty pe="C ompany N ame">Thomson Reuters P LC (A DR)</C oID> <C oID Ty pe="C IKN o">0001056084</C oID> </C oIDs>

Value RepNo

Description Thomson Reuters internal company identifier for fundamentals.

Companyn Descriptive company name. ame MXID CIKNo IRSNo Reuters internal company identifier. SEC Central Index Key identifier. IRS Employer identification Number.

17.3.3 Issues, Issue, and IssueID - Response Elements

The Issues section provides information on issue-specific identifiers.

272

TRKD API Developer's Guide

XML Sample - Issues Element

<Issues xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ompany C ontentC ommon_1"> <Issue ID="1" Ty pe="C " Desc="C ommon S tock" O rder="1"> <IssueID Ty pe="N ame">O rdinary S hares</IssueID> <IssueID Ty pe="Ticker">TRIN </IssueID> <IssueID Ty pe="RIC ">TRIN .O </IssueID> <IssueID Ty pe="Display RIC ">TRIN .O Q </IssueID> <E xchange C ode="N A S D" C ountry ="U S A ">N A S DA Q </E xchange> <G lobalListingTy pe S haresP erListing="6.0">A DR</G lobalListingTy pe> </Issue> <Issue ID="2" Ty pe="C " Desc="C ommon S tock" O rder="2"> <IssueID Ty pe="N ame">C ommon S tock</IssueID> <E xchange C ode="N YS E " C ountry ="U S A ">N ew York S tock E xchange</E xchange> </Issue> </Issues>

17.3.3.1 Issue Type and Order - Response Elements

Thomson Reuters tracks information on both common and preferred equity types, as well as on multiple classes of each. When a company has both common and preferred equity stock trading, Thomson Reuters Knowledge Direct API designates the common stock as the primary stock. The primary stock has an order of 1. If a company has more than one class of common, then the class of common stock with the higher trading volume or the larger float is designated as the primary class. Please note that the financial statement information is not issue specific, but is published at the company level.

17.3.3.2 Global Listings

Some company issues often trade on multiple exchanges throughout the world. These cross exchange listings generally represent the same issue of stock, and therefore the same fundamental information. Reuters only tracks the listing on the primary exchange in these cases. However, certain cross border listings such as American Depository Receipt's (ADR's) and Global Shares are stored as separate 'issuers' in the Thomson Reuters Knowledge fundamental database because regulatory bodies of certain markets require the disclosure of financial statements per local accounting. Each of these 'companies' have their own set of financial statements. Specifically, to meet the listing requirements in the US, companies have to file US GAAP financial statements in addition to the local accounting system or the International Accounting System (IAS) that they may be reporting for their local markets. For these companies, the US GAAP financial statements are available from the North American region or Global subscription. Global Listing Type ADR LDR ROF EDR CCR GSR Description American Depository Receipt Level I ADR Rule 144 shares European Depository Receipt Canadian Cross Listing Global Share

17.3.3.3 Stock Splits

If there has been a stock split since the company was first added to the Thomson Reuters database the most recent split date and split factor will be provided in the XML data. For example, a split factor of 2 indicates that a 2-for-1 stock split has occurred. When the stock split becomes effective, Thomson Reuters Knowledge Direct API uses the split factor to adjust all per share and shares outstanding fields in the fundamental database. As such all data is adjusted to reflect the current share capital structure. If there have been no stock splits since the company was added to the database, the element will not be published.

Fundamentals

273

17.3.4 CoGeneralInfo Element

The CoGeneralInfo element provides company-specific information about primary issues, latest statement filing dates, and the status of the company in the Fundamentals database. XML Sample - CoGeneralInfo Element
<C oG eneralInfo xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ompany C ontentC ommon_1"> <C oS tatus C ode="1">A ctiv e</C oS tatus> <C oTy pe C ode="E Q U ">E quity Issue</C oTy pe> <LastM odified>2008-11-14</LastM odified> <LatestA v ailableA nnual>2007-12-31</LatestA v ailableA nnual> <E mploy ees LastU pdated="2008-04-17">50000</E mploy ees> <S haresO ut Date="2008-11-11" TotalF loat="816100000.0">824277974.0</S haresO ut> <ReportingC urrency C ode="U S D">U .S . Dollars</ReportingC urrency > <M ostRecentE xchange Date="2008-11-21">1.0</M ostRecentE xchange> </C oG eneralInfo>

17.3.4.1 CoStatus Element

The company status level indicates whether a company is still active in the Thomson Reuters fundamental database. Thomson Reuters changes the status to inactive when the company stops trading as the result of certain business events. These events include acquisitions, mergers, bankruptcy or taken private. Code 0 1 Description Inactive Active Note Company is not inactive in the Reuters fundamental database. Company is currently active in the Reuters fundamental database.

17.3.4.2 CoType Element

This indicates the type of capital structure a company has or the type of issues the company primarily trades. Please note that the Thomson Reuters fundamental database primarily covers financial statement information for publicly traded equities. The majority of companies trade Equity and a minority trade Debt Issues only, with the other types appearing infrequently. If a company trades more than one type of the stock, only the primary stock will be used to describe the company type. Code EQU DBT PRE LPS Description Equity Debt Issue Limited Partnership Pre-IPO Private Special Note Company trades common shares. Additionally, the company may have other types of securities such as debt and preferred stock issued. Company has publicly traded debt but no common or preferred stock trading. A partnership with two kinds of partners: limited partners, who provide financial backing and have little role in management and no personal liability, and general partners, who are responsible for managing the entity and have unlimited personal liability for its debts. Company has filed an IPO registration statement, but shares are not trading in the market. Company is private. Special Companies.

Preferred Issue Company had preferred stock but no common stock trading.

IPO PVT SPL

17.3.4.3 Fiscal Period Information

This level of the files provides the date the financial report was last modified, the current fiscal period, the most current quarter and the year-end month. The number of employees and the date this figure was last updated is also provided.

274

TRKD API Developer's Guide

17.3.4.4 Share Information

The number of shares outstanding as well as the total float is also provided at this level. The shares outstanding are the most recently reported total number of shares as reported by the company. The total float is the most recently reported total number of shares outstanding which are not owned by insiders or the majority shareholders. The update date can differ from the most recent reported results of the company. This section also describes the currency each issuer used in its most recent financial statement, and the current exchange rate to the US Dollar.

17.4

Get Business And Geographic Segments (GetBusinessAndGeographicSegments_1)

Companies reporting segment information usually report Business Segments, Geographic Segments or both. For companies that report Business Segment and Geographic Segment information, Thomson Reuters captures financial information for each segment on both an annual and interim basis. Both Geographical and Business Segments use the GetBusinessAndGeographicSegments_1 request to retrieve the information. The required segmentType element in the method is used to indicate which segment to retrieve by having a value of either "BS" for Business Segment or "GS" for Geographic Segment. The following table shows all the attributes the method offers that can be used to narrow down a search: Nam Enumera Default e tion Comp anyID Comp anyId Type count ryCod e segm BS, GS entTy pe numP 5 eriods startD ate endD ate startF Y endFY fpNu 0 mber coaCo All des displa All yType s show 0 Comp anyIn fo show 0 State mentI nfo showI 0 Required x x

Fundamentals

275

ssues show Availa bility Period A, I Type updat OriginallyR eType eported, MostRece nt, AllTypes compl Partial, eteSt Complete, ateme AllStateme nt nts finalFil Final, ing Preliminar y, AllFilings

A MostRecent

AllStatement s

AllFilings

numPeriods - To retrieve the most recent periods the value for numPeriods has to be positive. By default, the value 5 is retrieving five most recent periods. To retrieve the earliest periods the value has to be negative. For example entering - 3 will retrieve the earliest periods available on that company. coaCodes - By default, the value of coaCodes are ALL , which returns all coa codes for the company. To get only a small set of specific COA codes, specify the individual COA codes in a comma separated list (e.g. AITL,LLTD,QEDG). countryCode - countryCode only applies if a TICKER was chosen for companyIDtype and the TICKER entered does not specify the location of the company. Note: Thomson Reuters recommends using REPNO for CompanyID Type.

17.4.1 Making a Geographic Segment Request

Shows financial information for that company broken up into the following geographic regions: Americas Europe/Middle East/Africa Asia/Pacific Global The following example makes a request for Geographic Segment that will retrieve financial information for only one period, in this case it will be for the previous year since periodType is by default set to annual. XML Sample Request - Making a Geographic Segment Request
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/26/F undamentals_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentals_1/ G etBusinessA ndG eogrpahicS egments_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etBusinessA ndG eographicS egments_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentals_1" segmentTy pe="G S " company IdTy pe="ticker" company Id="TRIN " numP er iods="1 " country C ode="" startF Y="0" endF Y="0" fpN umber="0" periodTy pe="A " coaC odes="A ll" show C ompany Info="false" show Issues="false" show S tatementInfo="false" show A v ailability ="false" /> </Body > </E nv elope>

276

TRKD API Developer's Guide

XML Sample Response - Making a Geographic Segment Request

<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentals_1/ G etBusinessA ndG eographicS egments_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-14T12:56:25.3036846Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etBusinessA ndG eographicS egments_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentals_1"> <BG S Information M ajor="2" M inor="0" Rev ision="1" xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/ BusinessA ndG eographicS egments_1"> <RepN o>B0867</RepN o> <ReferenceInformation xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/C ommonC ontent_1"></ ReferenceInformation> <F inancialInformation> <F inancialsLay out> ... <M apItem LineID="8" C O A ="RTLR">Total Rev enue</M apItem> <M apItem LineID="9" C O A ="E C O R">C ost of Rev enue</M apItem> <M apItem LineID="10" C O A ="G RP ">G ross P rofit</M apItem> <M apItem LineID="11" C O A ="G RO S M ">G ross M argin (% )</M apItem> ... </F inancialsLay out> <F inancialS tatements> <P eriod P eriodE ndDate="2007-12-31" P eriodTy pe="A nnual"> <P eriodH eader> <F iscalP eriod Year="2007" F iscalM onth="12"></F iscalP eriod> </P eriodH eader> <S tatements> <S tatement P eriodE ndDate="2007-12-31" P eriodTy pe="A nnual" S tatementDate="2007-12-31" Ty pe="BU S "> <S tatementH eader> <F inalF iling>1</F inalF iling> <O riginalA nnouncement>2008-04-17T21:27:00</O riginalA nnouncement> <C urrencies C onv ertedTo="U S D" Reported="U S D" RepToC onv E xRate="1.000000"></C urrencies> <U nits C onv ertedTo="M " Reported="M "></U nits> <C onsolidated>1</C onsolidated> <P eriodLength Ty pe="M onths" C ode="M ">12</P eriodLength> <U pdatedTy pe C ode="U P D">U pdated N ormal</U pdatedTy pe> <S ource Date="2008-04-17">20-F </S ource> <Document ID="10085415" IsInternal="0"></Document> <S y stemDate>2008-04-18</S y stemDate> </S tatementH eader> <F inancialV alues> <S egmentDetails O rder="1"> <S egmentC ode1>514191</S egmentC ode1> <S egmentC ode2>523999</S egmentC ode2> <S egmentN ame>M arkets Div ision</S egmentN ame> <S egmentV alues> <S V C O A ="RE XR">7332.000000</S V > <S V C O A ="RTLR">7332.000000</S V > </S egmentV alues> </S egmentDetails> ... <S egmentDetails O rder="5"> <S egmentC ode1>C O N S TL</S egmentC ode1> <S egmentN ame>C onsolidated Total</S egmentN ame> <S egmentV alues> ... </S egmentV alues> </S egmentDetails> </F inancialV alues> </S tatement> </S tatements> </P eriod> </F inancialS tatements> </F inancialInformation> </BG S Information>

Fundamentals

277

</G etBusinessA ndG eographicS egments_Response_1> </Body > </E nv elope>

FinancialLayout - this section appears once per file. Its purpose is to lay out the order in which financial values will appear for each period and each Business or Geographic Segment. This map gives the line item COA code, description and LineID. See Chart of Account (COA) Codes for more information. Period - a Period element has two main sub-elements PeriodHeader and Statements. PeriodHeader contains additional information about the period, including the Fiscal Year of the period, the interim type and interim number, and the true fiscal month of the period. Interim type and number are only applicable to interim statements. Statement contains one financial statement per period and all of its associated financial values (BusinessAndGeographicSegments is a restated product; therefore each statement indicates most recent restated statements only). In this example numPeriods attribute was set to 1 so there is only information for one period. If the element was left blank financial information for five periods would have been retrieved. For more information on Periods see section Periods and Filings. SegmentDetails has the bulk of the information. It contains Segment Code elements that list the regions covered in each SegmentName. Segment Codes are assigned by Thomson Reuters based on the segment description as provided by the company. Each segment can be assigned up to four codes. Its sub-element SegmentValue shows financial information for that period. The SegmentDetail is displayed in a predefined order stated in the Order attribute. SegmentValues section indicates the financial values and ratios for each segments as reported by the company. Each to financial value and/or ratio is assigned to a COA code.

17.4.2 Making a Business Segment Request

The Business Segment divides the information into business segments defined by the SegmentCode that contains the 1997 NAICS code(s) that describe each segment. This example retrieves Business Segment for one period as well as the company info. XML Sample Request - Making a Business Segment Request
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/26/F undamentals_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentals_1/ G etBusinessA ndG eogrpahicS egments_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etBusinessA ndG eographicS egments_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentals_1" segmentTy pe="BS " company IdTy pe="ticker" company Id="TRIN " numP er iods="1 " country C ode="" startF Y="0" endF Y="0" fpN umber="0" periodTy pe="A " coaC odes="A ll" showC ompanyInfo="tr ue" show Issues="false" show S tatementInfo="false" show A v ailability ="false" /> </Body > </E nv elope>

XML Sample Response - Making a Business Segment Request

<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader>

278

TRKD API Developer's Guide

<a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentals_1/ G etBusinessA ndG eographicS egments_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-14T12:56:25.3036846Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etBusinessA ndG eographicS egments_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentals_1"> <BG S Information M ajor="2" M inor="0" Rev ision="1" xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/ BusinessA ndG eographicS egments_1"> <RepN o>B0867</RepN o> <ReferenceInformation xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/C ommonC ontent_1"></ ReferenceInformation> <F inancialInformation> <F inancialsLay out> ... <M apItem LineID="8" C O A ="RTLR">Total Rev enue</M apItem> <M apItem LineID="9" C O A ="E C O R">C ost of Rev enue</M apItem> <M apItem LineID="10" C O A ="G RP ">G ross P rofit</M apItem> <M apItem LineID="11" C O A ="G RO S M ">G ross M argin (% )</M apItem> ... </F inancialsLay out> <F inancialS tatements> <P eriod P eriodE ndDate="2007-12-31" P eriodTy pe="A nnual"> <P eriodH eader> <F iscalP eriod Year="2007" F iscalM onth="12"></F iscalP eriod> </P eriodH eader> <S tatements> <S tatement P eriodE ndDate="2007-12-31" P eriodTy pe="A nnual" S tatementDate="2007-12-31" Ty pe="BU S "> <S tatementH eader> <F inalF iling>1</F inalF iling> <O riginalA nnouncement>2008-04-17T21:27:00</O riginalA nnouncement> <C urrencies C onv ertedTo="U S D" Reported="U S D" RepToC onv E xRate="1.000000"></C urrencies> <U nits C onv ertedTo="M " Reported="M "></U nits> <C onsolidated>1</C onsolidated> <P eriodLength Ty pe="M onths" C ode="M ">12</P eriodLength> <U pdatedTy pe C ode="U P D">U pdated N ormal</U pdatedTy pe> <S ource Date="2008-04-17">20-F </S ource> <Document ID="10085415" IsInternal="0"></Document> <S y stemDate>2008-04-18</S y stemDate> </S tatementH eader> <F inancialV alues> <S egmentDetails O rder="1"> <S egmentC ode1>514191</S egmentC ode1> <S egmentC ode2>523999</S egmentC ode2> <S egmentN ame>M arkets Div ision</S egmentN ame> <S egmentV alues> <S V C O A ="RE XR">7332.000000</S V > <S V C O A ="RTLR">7332.000000</S V > </S egmentV alues> </S egmentDetails> ... <S egmentDetails O rder="5"> <S egmentC ode1>C O N S TL</S egmentC ode1> <S egmentN ame>C onsolidated Total</S egmentN ame> <S egmentV alues> ... </S egmentV alues> </S egmentDetails> </F inancialV alues> </S tatement> </S tatements> </P eriod> </F inancialS tatements> </F inancialInformation> </BG S Information> </G etBusinessA ndG eographicS egments_Response_1> </Body > </E nv elope>

The breakdown is similar to Geographic Segment except rather the presenting the information broken up by regions it is presented by financial categories specified in segmentName. The sub-element Segment code indicates 1997 NAICS codes as

Fundamentals

279

values which describe each segment rather than the country or region code.

17.5

Financial Statements Concepts

The Thomson Reuters Knowledge Direct API provides access to all financial line items reported by companies on the annual and interim financial statements. This information is available in one of two views: The Company Specific view displays all items collected from the income statement, balance sheet and cash flow with line descriptions and values as reported by companies. This facilitates complete reconciliation to source documents. The Standardized view aggregates relevant line items to provide a more standard view of company financials. This makes ratio calculations and comparison across companies easier. API requests and responses for company-specific and standardized financials are very similar, with most differences occurring in the line-item element detail. Section Getting Financial Statements will cover the concepts and data points common to both APIs. For an explanation of making specific requests and responses and details specific to each API, see section Interpreting Financials Responses.

17.5.1 Types of Statements

For both company-specific and standardized financials, the Thomson Reuters Knowledge Direct API offers access to annual and interim data for balance sheets, income statements, and statements of cash flow. Balance Sheet - A balance sheet is the financial statement of a business that lists the assets, debts, and owners' investment as of a specific date. You can use the Thomson Reuters Knowledge Direct API to return annual or interim balance sheet information for a company. Income Statement - An income statement is the financial statement of business that lists revenues, expenses, and net income for a given period. You can use the Thomson Reuters Knowledge Direct API to return annual or interim income sheet information for a company. Cash Flow - Cash flow is the amount of net cash generated by a business during a specific period. You can use the Thomson Reuters Knowledge Direct API to return annual or interim cash flow information for a company.

17.5.2 Unique Identifiers

Issuers Thomson Reuters Report Numbers (RepNo) uniquely identify each issuer covered by Thomson Reuters. These numbers are generated and maintained by Thomson Reuters, do not change over time and are never re-used. Certain procedures determine the handling of RepNo's in the case of mergers, acquisitions, divestitures etc. In general, ~ If a merger or acquisition involving two entities causes a new entity to be created, then both of the existing RepNo's are considered inactive, and the new entity is given its own unique RepNo. ~ If one of the original entities survive as the new, merged entity, then it retains the original RepNo. Issues Issue ID will uniquely identify each issue for a specific issuer. These numbers are generated and maintained by Thomson Reuters, do not change over time and are never re-used. To identify an issue uniquely within Standardized Financials, users need to use a combination of Report Number and Issue ID.

17.5.3 Dual Listed Companies

While Thomson Reuters collects information about multiple issues per company (i.e. shares outstanding, DPS for various classes of share etc), these multiple classes of share do not add to the total company count. An exception occurs to this rule when one company reports financials using two different accounting standards. This could happen, for example, for a non-US company with American Depository Receipts (ADRs) trading in the US and a local issue trading in its home exchange. If these two instruments are associated with financials using different accounting standards, then Thomson Reuters Fundamentals will contain two companies - one to represent each of the above examples. A similar dual listing (with different accounting standards) could occur with other pairs of countries, such as UK/Australia etc. Currently there are about 1,000 companies in

280

TRKD API Developer's Guide

the database that are dual listed in this manner. Users can use the country of exchange for each company to determine the origin of each version of the company.

17.5.4 Primary Issue and Exchange

Primary Issue In cases where a company has multiple issues, various factors are taken into account in deciding what the primary issue is. These include whether or not the issue trades, the number of shares outstanding, float, trading volumes, voting power etc. This primary issue is always assigned Order number = 1. If the primary issue changes, the order number is reassigned. The Fundamentals API displays information (i.e. identifiers) on only the Primary Issue. Primary Exchange In cases where a company trades on multiple exchanges, Thomson Reuters assigns an exchange to be the primary exchange. This assignment is based on several factors including the accounting standard used by company, volume traded on each exchange etc. The exchange code and country code is given in the company-specific and standardized financials responses. Country codes used are ISO-3166 three character codes.

17.5.5 Periods and Filings

Thomson Reuters uses a certain concept to model periods and filings for companies. Users may chose to use a different model, but it is useful to understand the Thomson Reuters perspective when working with Thomson Reuters Financials files. While the file presents data in a three-tier hierarchy, users can think of four different entities: Period - A unique period can be identified by the combination of RepNo, PeriodType (e.g. Annual) and PeriodEndDate. For RepNo 12345, examples of unique periods include Annual 2003, Q3 2001 and Q1 1994. Filing - A filing is similar in concept to an actual document published by a company. A filing can be uniquely identified by the combination of RepNo and StatementDate. PeriodFiling - A PeriodFiling is a set of Statements that belong to the same Period and the same Filing. To uniquely identify a PeriodFiling, the user requires RepNo, PeriodType (e.g. Annual), PeriodEndDate and StatementDate. A PeriodFiling is a child of both a Period, and a Filing. Statement - A statement is a single Income Statement, a single Balance Sheet etc. An original Income Statement and its restatement are considered different statements. A unique statement is found by a key comprised of RepNo, PeriodType, PeriodEndDate, StatementDate and StatementType (e.g. Income Statement). Period: RepNo + PeriodType + PeriodEndDate Filing: RepNo + StatementDate PeriodFiling: Period + Filing Statement: PeriodFiling + StatementType

17.5.6 General Response Structure for All Financials

In the financials XML responses, the layout contains three of these four entities - Period, PeriodFiling and Statement. Each one of these is a child of the preceding entity. Because of this more flat layout, items that belong to the Filing level are represented on the PeriodFiling level in the response XML. Within the response XML, each of Period, PeriodFiling and Statement levels contain elements which describe the entire key (excluding RepNo), even though this introduces some redundancy in the response data. For example, the key for a Statement is PeriodType, PeriodEndDate, StatementDate and StatementType. While all Statements within the same Period will have the same PeriodEndDate, this information is still expressed within the Statement element. The entities described above make use of a number of specific data items, which are defined below.

Fundamentals

281

PeriodEndDate - This is the date at which a fiscal period is considered to have ended for a company. A company may have Period End Dates of March 31, 2000, December 31, 2003 etc. PeriodType - This is the type of Period, specifically, an Annual or an Interim. For the purpose of this file, the file type implies the PeriodType. The combination of a PeriodEndDate and a PeriodType identifies a unique Period. For example, the Annual Period ending December 2002 is a different period from the Quarterly Period ending December 2002. StatementDate - This is the PeriodEndDate for the latest Period in a Filing such as a 10K. If the 2003 Annual Report for ABC Company has financials for periods ending 12/31/2002 and 12/31/2003, then the StatementDate is 12/31/2003. A press release with this same information has the same StatementDate. Note that this date is different (usually earlier) than the date a Filing first becomes available to the public (labeled 'SourceDate'). SourceDate - This is the date that a Source (or Filing) became available to the public. If a company announces its 2003 results via a press release on 2/15/2004, then the SourceDate is 2/15/2004. If the financials are then filed with the SEC on 3/15/2004 then the SourceDate is 3/15/2004. Source - This is the source from which information is taken, for example a 10-K, 10-Q or a Press Release. StatementType - This is the type of statement, such as Income Statement, Balance Sheet, Statement of Cash Flows, Business Segment etc.

17.5.7 Period Lengths

Thomson Reuters does not restrict the number of interim periods a company may report per year, and therefore does not place restrictions on the length of each interim period. Each financial period is associated with a period length, expressed in months or weeks, depending on the company's reporting practices. In some instances, particularly when companies make year-end-changes, companies may report overlapping financial periods. Thus, a company changing its year-ending month from November to December may report two interim reports, one ending in November and one ending in December, and each three months in length. Similarly, a company changing its year-end-month from June to September may report two interim periods ending in March, where one has a length of three months and the other has a length of six months. The combination of PeriodEndDate and PeriodLength can be used to identify the amount of overlap between statements, if any.

17.5.8 Preliminary Statements

The Thomson Reuters Fundamentals database uses the concept of Preliminary Statements and Final Statements. Final Statements are those statements that are not expected to be changed or re-confirmed by the company. Usually these statements are derived from documents filed by the company with regulators or exchanges. While Restatements and Reclassifications do change values within a statement, these are considered to be different Statements from the original Statement. A flag at the PeriodFiling level indicates whether a set of Statements within a PeriodFiling is considered Preliminary or Final. Preliminary Statements are those statements that are considered preliminary in nature - it is expected that these will be replaced in the near future by another set of statements. In some instances the financial values are not changed - they are simply confirmed by an officially filed document. In most instances, preliminary statements are sourced from press releases.

17.5.9 Complete Statements

The Thomson Reuters Knowledge Direct Fundamentals API uses the concept of Complete and Partial Statements. A Statement is considered complete if the reporting company reports a specific set of data items for that Statement. If any one of these data items are missing, the Statement is considered Partial. A flag at the Statement level indicates whether any given Statement is Complete or Partial. The concept of Partial Statements was introduced in April 2004, and therefore all statements entered in the database prior to that are flagged Complete. Users may make use of this concept in creating restrictions for analytic or display purposes. For example, users may choose not to display any Partial Statements, or may apply special logic when calculating ratios using Partial Statements. In general, company documents filed with exchanges and/or regulators will have sufficient information to be tagged Complete. Most Partial statements will likely be sourced from press releases.

282

TRKD API Developer's Guide

17.5.10 Restatements/Reclassifications
From December 1997 onwards, Reuters has collected and saved all originally reported and restated / reclassified financial statements provided by companies. Thomson Reuters Knowledge Direct Fundamentals API reports only the most recent version of financials information for each period.

17.5.11 Chart of Account (COA) Codes

This section contains details on chart of account (COA) codes.

17.5.11.1 Concept and Process

The concept of COA codes is utilized across various Thomson Reuters Fundamental APIs such as Company Specific Financials, Standardized Financials and Business and Geographic Segments (BGS). Thomson Reuters collects and stores every line item reported by a company directly on the income statement, balance sheet and statement of cash flow, and up to approximately 50 line items reported in business or geographic segment information. Each of these items is then assigned a Chart Of Account (COA) code, which helps classify these various entries. For example, a utility company may report various line items related to Fuel Expenses. While all these items will be collected by Thomson Reuters, they will all be assigned the same COA code. Due to inherent differences among industries, one set of COA codes cannot be used effectively for all companies covered by Thomson Reuters Fundamentals. For example, Interest Expense for a financial institution usually has a different meaning from Interest Expense for an industrial enterprise. Thomson Reuters therefore has created four sets of COA codes - one each for Banks, Industrials, Utilities and Insurance companies.

17.5.11.2 Uniqueness of COA Codes

The definition of each COA code is unique. Each statement within the Standardized Financials product may have only one occurrence of a COA code (e.g. 'Revenue' will appear only once in a given Income Statement). However, a COA code may appear multiple times within a statement in Company Specific Financials - see section Mapping to STD for examples. Items with the same definitions in general have the same COA code in the STD and CSF APIs. The exception occurs for the list of codes below. For this list of codes, different codes are used to express the same item in the two products due to legacy compatibility issues. COA Code Variance between Company-Specific and Standardized Financials Standardized CompanyCode Specific Code SBAS SBBF SBAI SDAJ SDNI SDWS SDBF SDAI GBAS GBBF GBAI GDAJ GDNI GDWS GDBF GDAI Description Basic Weighted Average Shares Basic EPS Excluding Extraordinary Items Basic EPS Including Extraordinary Items Dilution Adjustment Diluted Net Income Diluted Weighted Average Shares Diluted EPS Excluding Extraordinary Items Diluted EPS Including Extraordinary Items

17.5.12 Mapping to STD

All line items collected by Thomson Reuters are displayed in the Thomson Reuters company-specific Financials. Thus, if an airline company reports three lines of 'Revenue', all of these are displayed through Company Specific Financials. Each of these line items are assigned a COA code as described above. In the above example, the three 'Revenue' items would all be assigned the same COA code. Sample Mapping of Company-Specific Items to Standard Items

Fundamentals

283

CompanyReported Line Description Passenger Revenue Cargo Revenue Salaries/Benefits Fuel/Oil Aircraft Rentals Landing Fees Commissions

Assigned COA Code RNTS RNTS ECOR ECOR ECOR ECOR ECOR

Standardized Description

Revenue Revenue Revenue Cost of Revenue Cost of Revenue Cost of Revenue Cost of Revenue Cost of Revenue

Charter Ops Revenue RNTS

In the standardized display, each COA code appears only once. Thus, displays for all airline companies will show only one 'Net Sales' item - for the above example the three company specific line items would be aggregated to give a single standardized line item. This helps create a more standard display across various companies, and allows for easier cross-company comparison. Note: Mapping from Company Specific to Standardized financials only involves grouping like items together. It is, therefore, always easy to reconcile Thomson Reuters Standardized Financials with the source documents.

17.5.13 Currencies
Up to three currencies may be relevant to each company. These are Pricing Currency (the currency that the primary issue of the company is priced in), the Reporting Currency (the currency that a financial report is originally reported in by the company) and the Converted To (i.e. published) Currency, which is the currency in which the xml files publish financial values. Thomson Reuters Fundamentals collects all financial values in Reported Currency. The company-specific requests return all data in Reported Currency. In the Standardized Financials API financials for each company are reported in one currency - the Most Recent Reporting Currency. Thus, a company reporting in USD or JP Yen in all of its history will have all its financials in USD or JP Yen respectively. But if a company changed its currency from Italian Lira to Euro at some point, then all its financials are presented in Euro. For each period, the reporting currency, published currency and conversion rate is provided. The conversion rate is based on the exchange rate of the most recent period with the old (in above example, Lira) currency. Currency codes used are ISO-4217 three character codes.

17.5.14 Exchange Rates

Up to three exchange rates may be expressed in financials responses. The USDToRepExRate is the most recent exchange rate between the US Dollar and the most recently reported currency. If the value is x, then 1 USD = x Most Recent Reported Currency. The PriceToRepExRate is the exchange rate between Pricing Currency and Most Recent Reporting currency. This rate is as of the most recent period end date (the date for which most recent price is provided). If the value is y, then 1 Pricing Currency = y Most Recent Reported Currency. The RepToConvExRate is the exchange rate used to convert Reported Currency into ConvertedTo Currency. If the value is z, then 1 Reported Currency = z Converted Currency.

17.5.15 Units
Financial values in Standardized Financials (except per share values) are always converted to Millions for all periods. For company-specific Financials, all financials values are expressed in the unit of the most recent report. Thus, if company switches from reporting in millions to reporting in billions in its most recent set of financials, then all financials are converted to billions.

284

TRKD API Developer's Guide

17.5.16 Footnote Items

In addition to presenting the information provided by companies in their financial statements, Thomson Reuters collects and displays a number of 'footnote' items in the CSF presentation. These items may include general information such as Number of Employees, footnote information such as number of Employees, number of common shareholders and frequently used information such as depreciation and amortization with the income statement.

17.5.17 Number of Shares

Basic vs. Primary Many companies (depending on country accounting standards) are currently required to report two weighted average share numbers for EPS calculations: Basic shares and Diluted shares. However, historically (pre-1997) US companies used to report Primary and Fully Diluted share numbers which are similar, but not identical, concepts. For display purposes the Financials API displays only one pair of share figures: 'Basic' and 'Diluted'. Note that prior to 1998, this item may reflect Primary and Fully Diluted Shares. Timeliness of Share Counts Companies provide share counts per issue on the Balance Sheet, and these are collected and displayed on a per issue basis. These share counts are as of the Balance Sheet date. The Income Statement provides share numbers that are an average of the period beginning and ending dates. Companies also provide shares outstanding figures near the front of financial publications (e.g. Annual Reports) - these numbers are more current than the Balance Sheet figures, and are provided in the Thomson Reuters Knowledge Direct GetGeneralInformation_1 request. Usually Market Capitalization and related analytics are performed using this up-to-date number.

17.5.18 Creating a Display

All COA codes given in CSF financials may be displayed for users. However, the line item map includes an attribute to indicate the type of each COA code that might assist users in creating views that hide or show certain COA codes. For example, footnote items may be set to a default of 'hide'. Each COA code is assigned one of five display attributes. These are described below: Financial items collected from the face of the financial statements will carry a display attribute value of 'Regular'. Examples include Net Sales and Gross Revenue. 'Regular' line items should always be displayed. Commonly used items collected from footnotes and other sources will carry a display attribute value of 'Footnote'. Examples include 'Number of Employees' and 'Rental Expense, Supplemental'. These items may be hidden. Items used to calculate the Thomson Reuters Normalized earnings will carry a display attribute value of 'Normalized'. Examples include 'Normalized Income Before Taxes'. Items related to Extraordinary expenses as defined by US GAAP are given the attribute value of 'Extraordinary'. These items appear infrequently in financial statements, but should be displayed when they do appear. Items that are collected from the face of the financial statements (when available) but appear infrequently, and do not have a direct impact on the bottom line financial results (i.e. Net Income, Total Assets etc.) are given the value 'Supplemental'. Examples include 'Shares Outstanding - Preferred Stock 2', 'Shares Outstanding - Preferred Stock 3' etc.

17.6

Getting Financial Statements

Requests for company-specific financial statements look nearly identical to requests for standardized financial statements, with the exception of the method name and namespace. Company-Specific requests use the <GetCompanySpecificFinancials_Request_1> element, while standardized requests use the <GetStandardFinancials_Request_1> element. The type of financial statement requested (e.g. Annual Income Statement vs. Interim Cash Flow Statement) is specified in the finStatement attribute on the request element. XML Sample Request - Getting a Company-Specific Statement (Annual Income Statement)

Fundamentals

285

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/26/F undamentals_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentals_1/ G etC ompany S pecificF inancials_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etC ompany S pecificF inancials_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentals_1" finStatement="A IS" numP eriods="1" company IdTy pe="ticker" company Id="TRIN " country C ode="" startF Y="0" endF Y="0" fpN umber="0" coaC odes="A ll" display Ty pes="A ll" updateTy pe="M ostRecent" completeS tatement="A llS tatements" finalF iling="A llF ilings" show C ompany Info="true" show Issues="true" show S tatementInfo="true" show A v ailability ="true" /> </Body > </E nv elope>

Compare the above company-specific request with the below request for a standardized cash-flow statement. XML Sample Request - Getting a Company-Specific Statement (Annual Income Statement)
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/26/F undamentals_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentals_1/ G etC ompany S pecificF inancials_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etS tandardF inancials_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentals_1" finStatement="IC F" numP eriods="1" company IdTy pe="ticker" company Id="TRIN " country C ode="" startF Y="0" endF Y="0" fpN umber="0" coaC odes="A ll" display Ty pes="A ll" updateTy pe="M ostRecent" completeS tatement="A llS tatements" finalF iling="A llF ilings" show C ompany Info="true" show Issues="true" show S tatementInfo="true" show A v ailability ="true" /> </Body > </E nv elope>

286

TRKD API Developer's Guide

17.6.1 companyIdType Attribute

Specifies the type of company identifier. Thomson Reuters recommends using RepoNo because it is the only truly unique type for identifying companies with fundamental data. The actual value is case-insensitive. companyIdType Values for "Thomson Reuters" Type TICKER RIC REPONO VALOR Description Exchange ticker symbol Reuters Instrument Code Unique ID for companies in the fundamentals API Swiss local security identifier Value Example TRIN TRIN.O B0867

17.6.2 companyId Attribute

The value of companyId is dependent upon the value specified in companyIdType attribute.

17.6.3 finStatement Attribute

The type of financial statement being requested. See the below table for an enumeration of values. Enumeration of finStatement Attribute Values: ABS - Annual Balance Sheet IBS - Interim Balance Sheet AIS - Annual Income Statement IIS - Interim Income Statement ACF - Annual Cash Flow Statement ICF - Interim Cash Flow Statement

17.6.4 Limiting Number of Periods Returned

Financials requests provide a number of attributes for limiting the number of periods returned in the response. numPeriods Attribute - specifies the number of periods to report or value of All to return all recorded periods. A positive number n indicates to return the n most recent periods of data. A negative value indicates to return the n earliest periods of data. The default value is 5. startFY/EndFY Attributes - Alternative to numPeriods, you can also use startFY and endFY to specify beginning and ending fiscal years. All periods between those years (inclusive) will be returned. startDate/EndDate Attributes - Another alternative to numPeriods is to use startDate and endDate. All periods between those dates (inclusive) will be returned. The date must be in the format YYYY-MM-DD.

17.6.5 coaCodes Attribute

Controls which Chart of Account line-item values are returned in the response. To get all COA codes, specify value of All, which is also the default. To get only a small set of specific COA codes, specify the individual COA codes in a comma separated list (e.g. AITL,LLTD,QEDG).

17.6.6 displayTypes Attribute

Alternative to coaCodes, you can use the displayTypes attribute to specify specific categories of COA codes to be returned. The allowable values are Regular, Supplemental, Normalized, Extraordinary, Footnote, Other. Multiple values can be specified in the form of a comma delimited list (e.g. Regular,Footnote).

Fundamentals

287

17.6.7 show* Attributes

The Company-Specific and Standardized financials requests contain a number of attributes that control the presence or absence of general reference and availability information in the responses. These attributes are boolean, so a value of 1 or true indicates the corresponding element should be included in the response, while a value of 0 or false indicates those elements to be left out of responses. See the below table for the elements controlled by each attribute. show* Attributes and Corresponding Response Elements Attribut Element in Response e showCom CompanyInformation panyInfo showState StatementInfo mentInfo showIssue Issues s showAvail Availability ability

17.6.8 updateType Attribute

Determines whether to return original filings, re-stated or re-classified filings, or both. The possible values are Original for original, un-restated filings, MostRecent for re-stated or re-classified filings, or All for all filings.

17.6.9 completeStatement Attribute

Determines whether to show partial statements, complete statements, or both. The possible values are Partial, Complete, or All. For more information on partial vs. complete statements, see section Complete Statements.

17.6.10 finalFiling Attribute

Determines whether to show preliminary statements, final statements, or both. The possible values are Preliminary, Final, or All. For more information on preliminary vs. final statements, see section Preliminary Statements.

17.7

Interpreting Financials Responses

The first part of this section will discuss those parts of the responses that are common to both Company-Specific and Standardized financials. The later sections will deal with items specific to the different APIs.

17.7.1 Response Overview

Financials responses contains two main sections: ReferenceInformation and FinancialInformation. ReferenceInformation element - this section contains information such as various identifiers for the company at both a company level (e.g. IRS Number) and issue level (e.g. CUSIP or ISIN). In addition, the section contains information on the company's most recent reported financials, active/inactive status, currency of reports etc. The section has three main sub-sections: CompanyInformation, Issues and StatementInformation. Reference Information is similar (in some cases identical) across various Thomson Reuters Fundamentals XML files. FinancialInformation element - FinancialInformation contains details about the periods and actual financial values for the company. It has three main sub-sections: Availability, FinancialsLayout and FinancialStatements. The FinancialStatements section contains the financial data compiled from various company documents. The layout of this section uses a number of concepts and implies a certain database structure described in detail in chapter Authentication and Authorization of this document.

288

TRKD API Developer's Guide

17.7.2 CompanyInformation Element

The presence of the <CompanyInformation> element is dependent upon the value of the 'showCompanyInfo' attribute in the request. This section contains company level information including company name, type, company identifiers etc. XML Sample - CompanyInformation Element
<C ompany Information> <C ompany A ctiv eS tatus="1" N ame="Thomson Reuters P LC (A DR)" Ty pe="E Q U "></C ompany > <C ompany Xref Ty pe="C IKN o">0001430287</C ompany Xref> <LastM odified F inancials="2008-05-15T07:47:18" O ther="2008-05-15T07:47:18"></LastM odified> <LatestF inancials A nnual="2007-12-31"/> <ReportingC urrency C ode="U S D" E xRateDate="2008-05-14" U S DToRepE xRate="1.0">U .S . Dollars</ReportingC urrency > </C ompany Information>

ActiveStatus Attribute - this flag indicates whether a company is active in the Thomson Reuters fundamental database. Thomson Reuters inactivates companies when they stop trading as the result of certain business events. These events include acquisitions, mergers, bankruptcy etc. The flag is derived from the status of the IssueActiveStatus for all issues that belong to the company. The Company ActiveStatus is Active if any one of the IssueActiveStatus flags are Active. Type Attribute - this indicates the type of capital structure a company has or the type of issues the company primarily trades. Note that the Thomson Reuters fundamental database primarily covers financial statement information for companies with publicly traded equity. The majority of companies trade Equity and a minority trade Debt Issues only, with the other types appearing infrequently. If a company trades more than one type of the stock, only the primary stock will be used to describe the company type. Type Attribute Values Co Description Note de EQ EQUITY U DB Debt T PR Preferred E Issue IPO Pre-IPO LPT Limited Partnership IDX Index PV Private T Company trades common shares. Additionally, the company may have other types of securities such as debt and preferred stock issued. IssueCompany has publicly traded debt but no common or preferred stock trading. Company has preferred stock but no common stock trading. Company has filed an IPO registration statement, but shares are not trading in the market. Reserved for future use. Reserved for future use. Company is private.

CompanyXref element - in general, users should use the RepNo to map to issuers (companies) with data from outside the Thomson Reuters data set, such as users- internal data or data from other vendors. Other than the Report Number, Reuters Knowledge Direct uses the following company identifiers (distinct from Issue identifiers, described later in this document): IRSNo (US co's only): As reported by the Internal Revenue Service. CIKNo (US co's only): Central Index Key as assigned by the SEC. LastModified Element - Time and date give indications to when a company was most recently updated in the Thomson Reuters Fundamentals database. Two distinct time/date values are provided. The time/date associated with the 'Financials' attribute indicates an update done via the Financials data entry application. Updates to any financial figures (e.g. financials for a new period), issue specific details (e.g. share counts) company name and address, CUSIP and ticker/exchange are updated through this application. Updates made through other applications (e.g. those that update company description, officer and director information etc) are reflected in the time/ date associated with the 'Other' attribute. Latest Financials Element - provides the period end dates for the latest available annual and interim financials for the company.

Fundamentals

289

ReportingCurrency Element - indicates the currency of the company's most recent financial report. CurrentAuditor Element - indicates the name and code for the company's current Auditor. This may be different from the Auditor on the most recent financial statement if company announces an auditor change between periods. Data for this item is expected to be available after Q3 2004.

17.7.3 Issues Element

Issues Element - this section provides Issue level information for the company's issues. While a company may have multiple issues (e.g. multiple classes of common, preferred) outstanding, some Thomson Reuters Knowledge Direct Fundamentals API requests (Company-Specific financials, Standardized financials, and Business and Geographic Segments) provide information on only one issue - the 'Primary' issue. Other methods (General Information, Ratios) provide information on all outstanding issues. In cases where a company has multiple issues, various factors are taken into account in deciding what the primary issue is. These include whether or not the issue trades, the number of shares outstanding, float, trading volumes, voting power etc. In general, the primary issue is the company's Common issue that is most actively traded and that has the largest float. The information in this section allows user to cross-reference the issues with some commonly used identifiers, and also get other basic information on the issue. XML Sample - Issues Element
<Issues> <Issue Desc="C ommon S tock" ID="1" IssueA ctiv eS tatus="1" O rder="1" Ty pe="C "> <IssueXref Ty pe="N ame">O rdinary S hares</IssueXref> <IssueXref Ty pe="Ticker">TRIN </IssueXref> <IssueXref Ty pe="RIC ">TRIN .O </IssueXref> <E xchange C ode="N A S D" C ountry ="U S A " Region="N A ">N A S DA Q </E xchange> <ListingTy pe S haresP erListing="6.0">A DR</ListingTy pe> <IssueDetails C onv ersionF actor="1.0" F loat="188300000.0" S hsO ut="190153372.0" V otes="1.0" /> </Issue> </Issues>

Issue Type, Order, IssueActiveStatusand ID Attributes - Thomson Reuters tracks information on both common and preferred equity types, as well as on multiple classes of each type. Each of these issues is assigned an Order number, with the primary issue receiving an Order of 1. The order assigned to a specific issue may change over time. Thomson Reuters also assigns an Issue ID for each of an Issuer's issues. These Issue ID's do not change over time, and can be used to uniquely identify an issue in combination with the Report Number (RepNo). Each issue is also tagged with an attribute that indicates whether the issue is active or inactive. A company is deemed inactive if all of its issues are tagged inactive. The file also provides a company level active/inactive flag. Please note that the financial statement information is not issue specific, but is published at the company level. ListingType Element - Some company issues trade on multiple exchanges around the world. These cross exchange listings generally represent the same issue of stock, and therefore the same fundamental information. Thomson Reuters only tracks the listing on the primary exchange in these cases. However, certain cross border listings such as American Depository Receipt's (ADR's) are stored as separate 'issuers' in the Thomson Reuters Fundamental database because regulatory bodies of certain markets require the disclosure of financial statements per local accounting. Each of these 'companies' has its own set of financial statements. In the Thomson Reuters database these companies will appear more than once - each 'issuer' with its own RepNo. A full list of companies that appear more than once in the database may be provided on request. Specifically, to meet the listing requirements in the US, companies have to file US GAAP financial statements in addition to the local accounting system or the International Accounting System (IAS) that they may be reporting for their local markets. For these companies, the US GAAP financial statements will be available from the 'Americas' or Global subscription. See also section Global Listings. Listing Types Listing Type OSR ADR LDR ROF Tracked by Thomson Reuters Description Ordinary Shares American Depository Receipt Level I ADR Rule 144 shares

290

TRKD API Developer's Guide

EDR CCR GSR

European Depository Receipt Canadian Cross Listing Global Share

MostRecentSplit Element - If there has been a stock split since the company was first added to the Thomson Reuters database the most recent split date and split factor will be provided in the API. For example, a split factor of 2 indicates that a 2-for-1 stock split has occurred. When the stock split becomes effective, Thomson Reuters uses the split factor to adjust all per share and shares outstanding fields in the

17.7.4 StatementInfo Element

The StatementInfo element groups elements containing information about how the company treats certain statement information. XML Sample - Statement Element
<S tatementInfo> <C O A Ty pe C ode="IN D">Industry </C O A Ty pe> <BalanceS heetDisplay C ode="C U R">Differentiates</BalanceS heetDisplay > <C ashF low M ethod C ode="IN D">Indirect</C ashF low M ethod> </S tatementInfo>

COAType Element - As described in the section on COA Codes, Thomson Reuters categorizes companies in four different industry groups for the purposes of creating standardized financial reports. The Statement Information segment indicates which of these industry groups is being used for each company. COAType Code and Element Text Element Code Description IND BNK FIN UTL Industry Bank Insurance Utilities

BalanceSheetDisplay Element - This code indicates whether or not the company differentiates between current and long-term assets and liabilities. A Code value of CUR indicates that the company differentiates between current and long-term assets and liabilities. A value of LNG indicates that the company does not differentiate between current and long-term assets and liabilities. When the Balance Sheet Display code is LNG (No differentiation), certain COA codes, e.g. ATCA (Total Current Assets), and LTCL (Total Current Liabilities) must be ignored, as there will not be any usage of these items in Nondifferentiating Balance Sheets. CashFlowMethod - Statements of Cash Flow can be compiled using either the Indirect or Direct Method of presentation. A majority of companies use the Indirect Method of presentation. Items specific to companies using the Indirect Method are denoted by 'I' and items specific to companies using the direct method are denoted by 'D'.

17.7.5 Availability Element

This element gives the user an indication of what financial statements are available for each company. At least one Annual Income Statement and Annual Balance Sheet will always be provided for every company available through the Thomson Reuters Standardized Financials API (Income statement will be available for every fiscal period - annual or interim, and at least one annual balance sheet will be available for every company). The Annual Cash flow and Interim Financials (I/S, B/S, C/F) are not always available. Therefore, we indicate in the files which of these four reports are available for each company. If the report is available the associated code will be '1'. If the report is not available the associated code will be '0'. There is a generic code for all the interim statements, if the associated code is '1', at least one of the interim reports will be available, if the associated code is '0', none of the interim reports are available and their associated codes will also be zero. Note: These codes refer to all fiscal periods and not only the most current fiscal period. For example, the code for Annual Cash Flow will equal '1' even if the financial statement for the current period is not available for the current period but is

Fundamentals

291

available for a previous fiscal period.

17.7.6 FinancialsLayout Element

The Financials Layout section appears once per file. It contains three Layouts, one for each of Income Statement, Balance Sheet and Cash Flow. Its purpose is to lay out the order in which financial values will appear for each period. This map gives the line item COA code, description, LineID, the aggregation and precision levels, and the display type. The MapItem elements in the layout section differ between the Company-Specific and Standardized financials APIs. For details on the MapItem element, see section Company-Specific Financials and section Standard Financials Responses.

17.7.7 Period Element

A Period contains all statements of the same period type (annual vs. interim) with the same Period End Date. This includes income statements, balance sheets, and cash flow statements, as well as original and re-stated/ re-classified reports. The <Period> element includes the key for identifying a period within the file uniquely, i.e. the PeriodEndDate and PeriodType. The <Period> element has two main sub-elements - <PeriodHeader> and <PeriodFilings>.

17.7.8 PeriodHeader Element

The Period Header contains additional information about the period, including the Fiscal Year of the period, the interim type and interim number, and the 'true' fiscal month of the period. Interim type and number are only applicable to interim statements. The Fiscal Year is the year the financial report is relating to. It is common industry practice, and Reuters Fundamentals policy, to assign the prior year as the fiscal year when a company's fiscal year ends between January 1st and January 15th. If the company's fiscal year ends between January 16th and December 31st, the fiscal year will be the current year. For example, if the fiscal period end date is 5 January 2003, the fiscal year will be 2002. If the fiscal period end date is 18 January 2003, the fiscal year is 2003. Fiscal Period Number is only provided in the Interim reports to indicate which interim period the information refers to. For example, the first interim of a company's fiscal year would have a period number of one. Possible values are 1 through 4. Note that for companies with bi-annual reporting, interim numbers displayed are 2 and 4 (as opposed to 1 and 2 or 1 and 3). In the June 2004 release (version 2.0.1), the interim type and 'true' fiscal month values will not be populated. Both values should be available later in 2004 or early 2005. Once interim type is made available, the numbering for interim number will be changed such that semi-annuals have values 1,2 and tri-annuals have values 1,2,3. Period Length is not provided in this level because various statements within a Period may have different lengths (e.g. a 3month Income Statement and 9-month Cash Flow). In addition, Period Length is not applicable to the Balance Sheet. The Period Header will also provide information about period ending stock price when applicable. This is the most recent closing price for the primary issue of the company as of the Period End Date. Prices are provided in the currency quoted by the relevant exchange. Pricing information will not be available in the June 2004 release of the product, but is expected be in products later in 2004.

17.7.9 PeriodFilings Element

A PeriodFiling contains all statements of the same period type (annual vs. interim) with the same Period End Date and same Statement End Date. One PeriodFiling may contain at most one income statement, one balance sheet and one cash flow statement. The PeriodFiling element includes the key for identifying a period within the file uniquely, i.e. the PeriodEndDate, PeriodType and StatementDate. A PeriodFiling element will have two main sub-elements - PeriodFilingHeader and Statements.

292

TRKD API Developer's Guide

17.7.10 PeriodFilingHeader Element

Final Filing indicates whether all statements within a PeriodFiling are considered final (as opposed to preliminary). The Period Filing header indicates whether a period filing is Final or Preliminary. The header contains the Original Announcement date. This date appears for period filings that were first initiated in the database as a Preliminary period filing. The date indicates the source date of the first preliminary report for that period filing. In effect indicates the first date when any information for that period filing was made available to the public. The date does not get overwritten even as the financial data gets overwritten by 'final' filings. Auditor Name and Opinion are only supplied in the Annual Statements. The auditor (an independent certified public accountant) is responsible for ensuring that the financial reports of a company conform with GAAP accounting principles. Each Auditor provides a report on the company's accountants that contain an 'opinion'. The opinion code and description is provided in the XML files. Opinion Values Co Description Note de UN Unqualified Q UW Unqualified E with Explanation AO Adverse P Opinion NO No Opinion P QU Qualified A UN Un-audited A XML Sample - PeriodFilingHeader Element
<P eriodF ilings> <P eriodF iling P eriodE ndDate="2002-12-31" P eriodTy pe="A nnual" S tatementDate="2003-12-31"> <P eriodF ilingH eader> <F inalF iling>1</F inalF iling> <C urrencies C onv ertedTo="G BP " RepToC onv E xRate="1.000000" Reported="G BP "></C urrencies> <U nits C onv ertedTo="M " Reported="M "></U nits> <A uditor C ode="P WC L" N ame="P ricew aterhouseC oopers LLP " O pinion="U nqualified" O pinionC ode="U N Q "></A uditor> </P eriodF ilingH eader> <P eriodF iling> ... </P eriodF ilings> ...

The accounts represent a fair and true view of the financial situation of the company and comply with accounting principles. An explanation will be given if there are uncertainties in the accounts that will be resolved in the future, if the company has changed its accounting principles which in turn effect the comparability of the reports or if there is a material deemed important enough to mention. The accounts have not complied with generally accepted accounting principles. Not enough information was provided to enable the auditor to express an opinion or the auditor refuses to express an opinion regarding the company's ability to sustain operations. The accounts have been presented fairly however, the scope of the examination is limited/affected by conditions or restrictions or the accounts do not give a fair view because of a lack of conformity with GAAP or inadequate disclosure.

17.7.11 Statement Element

A Statement contains one financial statement and all of its associated financial values. The <Statement> element includes the key for identifying a period within the file uniquely, i.e. the PeriodEndDate, PeriodType, StatementDate and StatementType. The Statement Type identifies whether a statement is an Income Statement, Balance Sheet or Cash Flow Statement. A <Statement> element will have two main sub-elements - <StatementHeader> and <FinancialValues>.

Fundamentals

293

17.7.12 StatementHeader Element

The statement header contains information about whether statements are partial vs. complete, original vs. restated, as well details about the filing dates and accounting standards. The following sections detail the elements in the StatementHeader section of financials responses. CompleteStatement Element - The Statement Header includes information that identifies a statement as being either Complete or Partial. See 23.6.9, Complete Statements for more detail on how Reuters categorizes statements as partial or complete. PeriodLength Element - Period length and type are provided in the Income Statement and Cash Flow Statements. It indicates the length of the fiscal period of the financial report and states whether the length is in weeks or months. For example, an annual report could have 52 week fiscal period or a 12 month fiscal period. Since the Balance Sheet is a snapshot of the company's assets and liabilities at one point in time, a period length is not applicable to this statement. UpdateType Element - A company can submit an original update to their financials, a reclassification or a restatement. When updating a company's information the Data Analysts have to choose from one of these three update options: ~ Normal Update (first letter of update code is U) - the date is updated from the original financial report. ~ Reclassification (first letter of update code is C) - this can occur when, for instance the company's auditor or accounting department discover that an item such as cost of revenue or accounts payable has been classified incorrectly. Reclassifications will generally change the breakdown within the major number, but leave the bottom line numbers, such as Net Income, Total Assets or Total Change in Cash unchanged. ~ Restatement (first letter of update code is R) - this can occur, when for instance: an acquisition is made using the pooling-of-interest method of accounting; a sale of a division or a business (which would be accounted for as discontinued operations); a change in the company's accounting policies; there were errors in reporting procedures or in previously reported financials. Restatements will result in a change in the bottom line numbers - revenues, net income, total assets, net change in cash, etc. The most common update types are Update Normal and Restated Normal. UpdateType Possible Values Co Description de UPD Update Note UC Update A Calculated Note Adding the most recent annual or quarterly data. The Data Analyst calculates the financials, deriving the information from existing reports, to enable an update. For example, if a company has only filed the 1st, and 3rd interim statements, the figures for the 2nd interim can be derived from these.

USP Update Special A company files financial reports that are not a of a standard length. For example, a newly listed company's first annual report may only be for ten months and not the standard twelve. RES Restated Normal RC Restated A Calculated RSP Restated Special CLA Reclassified Normal CC Reclassified A Calculated CSP Reclassified Special Restating a prior period using the most recent period's source document. For example, figures in the 2000 annual income statement are revised using the 2001 annual income statement. The Data Analyst calculates the financials for a period as the result of a restatement. Restating a period resulting in a non-standard filing length. Reclassifying a prior period using the most recent period's source document. For example, figures in the 2000 annual income statement are revised using the 2001 annual income statement. The Data Analyst calculates the financials for a period as the result of a reclassification. Reclassifying a prior period which results in a non standard period length.

Source and SystemDate Elements - The Source Date is the date that the source documentation was filed by the company to the regulatory body or when a press release became available to the public. Various types of source documents are used to record company financials. The source document used for each period is also provided. The System date indicates what date a statement was first added to the Reuters Fundamentals database.

294

TRKD API Developer's Guide

ReportedAccountingStandard Element - This element indicates the code and description for the accounting standard used by the company. A list of accounting standards codes can be obtained by issuing a GetFundamentalsReferenceListsRequest request using a Category of AccountingStandards. XML Sample - StatementHeader Element
<S tatementH eader> <C ompleteS tatement>true</C ompleteS tatement> <P eriodLength C ode="M " Ty pe="M onths">12</P eriodLength> <U pdateTy pe C ode="C LA ">Reclassified N ormal</U pdateTy pe> <S ource Date="2004-02-17">20-F </S ource> <S y stemDate>2004-05-25</S y stemDate> <ReportedA ccountingS tandard C ode="U S G ">U .S . G A A P </ReportedA ccountingS tandard> <S TE C F lag>false</S TE C F lag> </S tatementH eader>

17.7.13 FinancialValues
The FinancialValues element contains the actual line item values for the COA codes found in the FinancialsLayout section. Actual line items are represented by FV elements. For details on the FV element, see section Making Company-Specific Financials Requests and section Making Standardized Financials Requests.

17.8

Company Specific Financials Responses

This section covers response details that are specific to the Company-Specific Financials API. For details on elements common to both Company-Specific and Standardized financials, please see section Interpreting Financials Responses.

17.8.1 MapItem Element (Company-Specific)

The 'MapItem' in the Company Specific Financials API is the company specific description of the line item (e.g. "Revenue from Passenger Operations"), and will match the description provided by the reporting company. In some instances descriptions may be abbreviated to fit limitations of some products. This is different from the Standardized financials API, where MapItem refers to a standardized description for a COA code. LineIDs are unique IDs assigned to each item, and are used to link descriptions to financial values in each period. The assigned LineIDs Company Specific financials are applicable for all periods within the file, but may change when the company is next updated. The codes can be used to order the values for display purposes. COA is the COA code (e.g. RREV) as described in the section above on Chart of Account (COA) Codes. STDLineIDs are Summary Standardized LineIDs that can be used to create a summary display of Standardized Financials. For such a display all items with identical STDLineIDs would be aggregated to create STDLineID items. For any given period, a company may or may not have values for each of the COA codes. As discussed in the section on COA codes there are four Chart of Account templates: Industrial, Banking, Insurance and Utility, and each company is assigned one of these templates. Each company will therefore have one of four possible Financial Statement Maps. Note: While each Financial Statement Map contains descriptions about each item that could be part of the template, not all companies will have values for each item in the map for each period supplied. For example, some companies may report 'Inventories - Raw Materials (AIRM)' in one period, but not on a subsequent period. The STD Financials file will then contain a value for AIRM in some periods but not others. Similarly, a company may never report the item 'Inventories - Finished Goods'. In this case the item will still appear in the Financial Statement Map, but will not appear in any of the Fiscal Periods reported for the company. XML Sample of Company Specific Financials Layout
<F inancialsLay out> <Lay out Ty pe="BA L">

Fundamentals

295

<M apItem C O A ="A ITL" Display ="Regular" LineID="1" S TDLineID="A ITL">S tocks</M apItem> <M apItem C O A ="A IWP " Display ="Regular" LineID="2" S TDLineID="A ITL">Work in P rogress</M apItem> <M apItem C O A ="A IO T" Display ="Regular" LineID="3" S TDLineID="A ITL">P rogress P ay ment</M apItem> ...[content elided]... <M apItem C O A ="Q TS N 1" Display ="S upplemental" LineID="75" S TDLineID="Q TS N 1">T/S -C ommon S tock</M apItem> <M apItem C O A ="Q TP O " Display ="Regular" LineID="76" S TDLineID="Q TP O ">Total P referred S hares O utstanding</ M apItem> <M apItem C O A ="M E TL" Display ="F ootnote" LineID="79" S TDLineID="M E TL">E mploy ees</M apItem> <M apItem C O A ="M N O S " Display ="F ootnote" LineID="80" S TDLineID="M N O S ">N umber of C ommon S hareholders</ M apItem> </Lay out> </F inancialsLay out>

17.8.2 FV Element (Company-Specific)

In the Company Specific financials responses, the FV element contains the LineID attribute that maps the line item value to a MapItem in the Layout section. The FV element value is the value corresponding to the COA code for that line item. See section Mapping to STD for details on mapping between Company Specific and Standardized line items.

17.9

Standardized Financials Responses

This section covers response details that are specific to the Standard Financials API. For details on elements common to both Company Specific and Standardized financials, please see section Interpreting Financials Responses.

17.9.1 MapItem Element (Standardized)

The MapItem is the standardized description of the COA code (e.g. 'Gross Revenue'), and will not match the description provided by the reporting company. COA is the COA code (e.g. RREV) as described in the section above on Chart of Account (COA) Codes. LineIDs in Standardized financials are pre-assigned to each COA code, and remain constant over time for each code. The codes can be used to order the values for display purposes. The Level can be used to help create a summary standardized financials display. The 'level' can have one of three values: A value of 'det' indicates the detailed type of COA codes. These items are appropriate for a detailed view of financial statements and directly map to the line items reported by the companies. A value of 'sum' indicates the summarized type of COA codes, and should be used for a summary view of financial statements. A value of 'both' reflects items that may be reported by the companies or calculated by Thomson Reuters. Most displays of Thomson Reuters standardized data reflect only the line items at the 'sum' or 'both' levels. The Aggregation level can be used in formatting the standardized display. The 'Agg' numbers can be used to determine the level of indentation, with 'Agg=1' values on the far left and 'Agg=3' values most indented. The Precision number can be used to format the data items. This indicates the type of data item and can take the following values: '1' indicates financial values such as Net Sales or Current Assets. '2' indicates share amounts such as Total Shares Outstanding. '3' indicates per share values such as Dividends per Share For any given period, a company may or may not have values for each of the COA codes. As discussed in the section on COA codes there are four Chart of Account templates: Industrial, Banking, Insurance and Utility, and each company is assigned one of these templates. Each company will therefore have one of four possible Financial Statement Maps. Note: While each Financial Statement Map contains descriptions about each item that could be part of the template, not all companies will have values for each item in the map for each period supplied. For example, some companies may report 'Inventories - Raw Materials (AIRM)' in one period, but not on a subsequent period. The Standardized financials API will then contain a value for AIRM in some periods but not others. Similarly, a company may never report the item 'Inventories Finished Goods'. In this case, the item will still appear in the Financial Statement Map, but will not appear in any of the Fiscal Periods reported for the company. XML Sample of Standard Financials Layout

296

TRKD API Developer's Guide

<F inancialsLay out> <Lay out Ty pe="IN C "> <M apItem A gg="2" C O A ="RN TS " Display ="Regular" Lev el="det" LineID="10" P recision="1">N et S ales</M apItem> <M apItem A gg="2" C O A ="RRE V " Display ="Regular" Lev el="det" LineID="20" P recision="1">G ross Rev enue</M apItem> ...[content elided]... <M apItem A gg="1" C O A ="V RXP " Display ="F ootnote" Lev el="both" LineID="1800" P recision="1">Rental E xpense, S upplemental</M apItem> <M apItem A gg="1" C O A ="V E P S " Display ="F ootnote" Lev el="both" LineID="1810" P recision="1">E P S , S upplemental</ M apItem> </Lay out> </F inancialsLay out>

17.9.2 Obtaining a List of All COA Codes

A complete list of line item codes can be obtained by issuing a GetFundamentalsReferenceLists_1 request: using a Category of "LineItems": XML Sample Request - Obtaining a List of Line Item Codes
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/26/F undamentals_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentals_1/ G etF undamentalsReferenceLists_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > G etF undamentalsReferenceLists_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentals_1" C ategory =" LineItems " /> </Body > </E nv elope>

17.9.3 FV Element (Standardized)

In the Standardized financials responses, the FV elements map directly to standard chart of account (COA) codes, rather than to line item IDs in the Layout section. The COA attribute specifies the COA code and FV element text represents the statement line-item value corresponding to that COA code.

17.10 Get Ratios And Statistics (GetRatiosAndStatistics_1)

You can use the GetRatiosAndStatistics_1 request to generate ratios and statistics for a company. This request generates a wide range of both issue specific and company specific data. XML Sample Request - Getting Ratios and Statistics
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/26/F undamentals_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentals_1/ G etRatiosA ndS tatistics_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body >

Fundamentals

297

G etRatiosA ndS tatistics_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentals_1" company IdTy pe=" T IC KER " company Id=" T RIN" country C ode="" /> </Body > </E nv elope>

For example, GetRatiosAndStatistics_1 request for Thomson Reuters (Ticker 'TRIN') returns the following: XML Sample Response - Getting Ratios and Statistics
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentals_1/ G etRatiosA ndS tatistics_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-14T12:56:25.3036846Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etRatiosA ndS tatistics_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentals_1"> <RatiosA ndS tatistics M ajor="1" M inor="0" Rev ision="1" xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/ RatiosA ndS tatistics_1"> <C oIDs xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ompany C ontentC ommon_1"> <C oID Ty pe="RepN o">B0867</C oID> <C oID Ty pe="C ompany N ame">Thomson Reuters P LC (A DR)</C oID> <C oID Ty pe="C IKN o">0001056084</C oID> </C oIDs> <Issues xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ompany C ontentC ommon_1"> <Issue ID="1" Ty pe="C " Desc="C ommon S tock" O rder="1"> <IssueID Ty pe="N ame">O rdinary S hares</IssueID> <IssueID Ty pe="Ticker">TRIN </IssueID> <IssueID Ty pe="RIC ">TRIN .O </IssueID> <IssueID Ty pe="Display RIC ">TRIN .O Q </IssueID> <E xchange C ode="N A S D" C ountry ="U S A ">N A S DA Q </E xchange> <G lobalListingTy pe S haresP erListing="6.0">A DR</G lobalListingTy pe> </Issue> <Issue ID="2" Ty pe="C " Desc="C ommon S tock" O rder="2"> <IssueID Ty pe="N ame">C ommon S tock</IssueID> <E xchange C ode="N YS E " C ountry ="U S A ">N ew York S tock E xchange</E xchange> </Issue> </Issues> <C oG eneralInfo xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ompany C ontentC ommon_1"> <C oS tatus C ode="1">A ctiv e</C oS tatus> <C oTy pe C ode="E Q U ">E quity Issue</C oTy pe> <LastM odified>2008-11-14</LastM odified> <LatestA v ailableA nnual>2007-12-31</LatestA v ailableA nnual> <E mploy ees LastU pdated="2008-04-17">50000</E mploy ees> <S haresO ut Date="2008-11-11" TotalF loat="816100000.0">824277974.0</S haresO ut> <ReportingC urrency C ode="U S D">U .S . Dollars</ReportingC urrency > <M ostRecentE xchange Date="2008-11-21">1.0</M ostRecentE xchange> </C oG eneralInfo> <Ratios P riceC urrency ="U S D" ReportingC urrency ="U S D" E xchangeRate="1.00000"> <IssueS pecific O rder="1"> <G roup ID="Div idend"> <Ratio F ieldN ame="DIV N Q " Ty pe="N ">1.62000</Ratio> ... <Ratio F ieldN ame="YIE LD" Ty pe="N ">6.69600</Ratio> </G roup> <G roup ID="G row th Rates"></G roup> ... <G roup ID="S hare Related Items"> ... </G roup> <G roup ID="S hort Interest"> <Ratio F ieldN ame="S IC H G 1" Ty pe="N ">-37.28800</Ratio> ... <Ratio F ieldN ame="S IV O L4" Ty pe="N ">0.02700</Ratio> </G roup> </C ompany S pecific> </Ratios> </RatiosA ndS tatistics>

298

TRKD API Developer's Guide

</G etRatiosA ndS tatistics_Response_1> </Body > </E nv elope>

See section Interpreting Common Fundamental Elements for explanations on the CoIDs, Issues, and CoGeneralInfo elements. The <Ratios/> element contains all the ratios, both issue specific and company specific. These values are broken into logical groups, indicated by the <Group/> element. Each ratio is identified using a 'FieldName' attribute. Note: The value '-99999.99000' means N/A (not available).

17.11 Getting a Company's Officers and Directors

The GetOfficersAndDirectors_1 request provides information about officers and directors of companies that are part of the Thomson Reuters coverage universe. Information includes officer names and titles, including historical titles, biographical information and compensation related information. Officers and Directors data are compiled primarily from company filed documents, company web-sites and other company sources. This data is usually updated once a year, unless significant officer/director changes are announced. Officer and Director names and titles are collected for all companies that report such data (required reporting in the US). Biographies are created, primarily using annual reports or an equivalent, for all officers where available. Biographical information is collected at the company level. Therefore, if John Lennon belongs to four companies assuming each provided a biography he will appear with four biographies. This is due to the uniqueness of each biography presented by the company an officer/director is affiliated with. Each officer and director can be recognized via two identifiers, Person ID and Officer ID. This presents a two-tier structure for individuals within the Thomson Reuters People database. That is, person-level data and company-level data. Person ID indicates a unique person within the Thomson Reuters People database. This ID will allow users to build unique relationships between individuals and view an officer/director's corporate affiliation and employment history. Note that Person ID will not change for a unique individual and is never reused. Officer ID indicates a unique person within a company. The same officer/director will be assigned a different Officer ID in the context of a different company. Thus, if John Lennon is currently an officer of one company and director of two companies, and in addition is an ex-officer of a fourth company, he will appear with one Person ID and four Officer ID's in the file. Note that Officer ID will not change and is never reused. In addition, Officer ID should not be used to identify relationships between individuals and companies. Remuneration related information is updated once a year and a new record is created even if there are no changes from the previous instance of this data. Information is collected at the company level and will be available for all companies in the Thomson Reuters Fundamental universe if provided in the source document. This information is available since 1997 for US markets and 2005 for non-US markets. Title related information is updated, and new records are created, each time new information is made available. Thus, if John Lennon begins and ends his 5 year tenure at a company as CFO, there will only one 'title' record for this person. However, if within these 5 years there are changes to his title (e.g. he adds the title 'COO', and later transitions to role as 'CEO') then each of these changes will cause a new record to be created. For an inactive person, all sets of designations will have a valid 'end date'. For a current (active) person, one set of designations will have no end date. Committee Membership information displays board committees as established by the company's bylaws, as well as memberships for each director and their title/date held. A committee enables a small group of relevant directors to focus on a specific issue and bring it to a resolution. Each committee performs a complementary function, permitting the board to address areas of corporate governance in more depth than may be possible within its own capacity. Therefore if ABC Corp. has three committees: Audit, Compensation and Executive, and John Lennon is a member of the Compensation Committee, both his title, membership and tenure will be provided. The data available is for both active and inactive companies. Also, within each company, there may be information for current (active) persons and inactive (i.e. ex-officers and ex-directors). A person's status is clearly indicated by the 'Status' tag, which takes values of 'officer', 'director', 'both' or 'inactive'. Once a person becomes 'inactive', his information is no longer updated (e.g. Age remains static).

Fundamentals

299

17.11.1 Get Officers And Directors (GetOfficersAndDirectors_1)

Requests for a company's officers and directors are made using the GetOfficersAndDirectors_1 request, which, like most fundamentals methods, specifies a company id and id type. XML Sample Request - Getting Officers and Directors
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/26/F undamentals_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentals_1/ G etO fficersA ndDirectors_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etO fficersA ndDirectors_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentals_1" company Id="IBM .N " company IdTy pe="RIC " /> </Body > </E nv elope>

17.11.2 GetOfficersAndDirectors_Response_1 Element

Competitors responses, like most fundamentals methods, contain company-level and issue-level identifiers in addition to their main content. Please see section Interpreting Common Fundamental Elements for a description of these elements. XML Sample Response - Getting Officers and Directors
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentals_1/ G etO fficersA ndDirectors_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-14T12:56:25.3036846Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etO fficersA ndDirectors_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentals_1"> <O fficers M ajor="3" M inor="0" Rev ision="2" lang="en-U S " xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/ O fficersDirectors_1"> <RepN o>4741N </RepN o> <C ompany N ame Ty pe="P rimary ">International Business M achines C orp.</C ompany N ame> <P roduction Date="2008-05-19T17:05:38"></P roduction> <O fficersInformation> <O fficer ID="28503" S tatus="Both" Rank="1" A ctiv e="1"> ... </O fficer> ... <O fficer ID="28519" S tatus="Inactiv e" A ctiv e="0"> ... </O fficer> </O fficersInformation> </O fficers> </G etO fficersA ndDirectors_Response_1> </Body > </E nv elope>

300

TRKD API Developer's Guide

17.11.2.1 OfficerInformation and Officer Elements

The OfficersInfo element is the main element of interest. This section contains all of the officers and directors related information. Information for each officer begins with an Officer ID tag. Each officer within each company is assigned a unique Officer ID. This ID does not change, and is not re-used. While an Officer ID indicates a unique person within a company, the same person will be assigned a different Officer ID in the context of a different company. In addition to Officer ID, the Person ID will be presented as a separate element and will enable identification of the relationship between the individual and companies. Officer Status indicates whether a person is an Officer, Director or Both. Officer Active indicates whether an officer and/or director is 1 (active) or 2 (inactive). If the individual no longer holds an Officer or Director title, their Officer Active will be 0 (inactive). Active persons are ordered in the file by their rank. Each active person is ranked using a system of sub-ranks for each title (e.g. Chairman of the Board ranked higher than CEO, which in turn is ranked higher than VP). Inactive persons are not ranked in the OD file, and are ordered by their most recent End Date. Person Active indicates whether an individual (person) is 1 (active) or 2 (inactive) and is derived from Officer Status and Company Status. If a person is active, all person-specific fields, will be updated regardless of Officer Active status. A person is "active" when at least one associated Officer ID is active, and the company associated with that Officer ID is active. If all associated Officer ID's are inactive or the Company Status for each active officer is inactive, then the Person Active will be 0 (inactive). Therefore, if a person belongs to two companies and one is inactive, the age will continue to be updated for both the active issue and the inactive issue. When companies themselves are inactivated, no changes are made to the officer information contained in the database. Therefore Inactive companies will contain 'active' persons. XML Sample - Officer Information Elements
<O fficersInformation> <O fficer ID="28503" S tatus="Both" Rank="1" A ctiv e="1"> <P erson ID="28503" A ctiv e="1"></P erson> <S ubmission Ty pe="DE F 14A " Year="2007" M onth="01" Day ="31"></S ubmission> <S ubmission Ty pe="DE F 14A " Year="2007" M onth="03" Day ="12"></S ubmission> <S ubmission Ty pe="10-K" Year="2008" M onth="02" Day ="26"></S ubmission> <S ubmission Ty pe="DE F 14A " Year="2008" M onth="03" Day ="10"></S ubmission> ... </O fficer> </O fficersInformation>

Each Officer element will also contain the following information divided up into sub_elements: Person Information Contact Information Corporate Affiliations Position Information Biographical Information Salary Information

17.11.2.2 Person Information

PersonInformation section contains information pertaining to the person's name, age (and date of birth), sex and educational background including certifications. Note: Person-specific fields are maintained on an individual level i.e. as reported in a company's latest source document that an officer is associated with. All fields within the "PersonInformation" container element will be maintained until a persons status becomes inactive. PersonInformation contains elements for each of the following: Name Certifications Education

Fundamentals

301

Name - Contains all information pertinent to an individual's name. Fields include first, middle, last and preferred name in addition to prefix and suffix. First and last name are required fields. Preferred name may include an officers/directors nickname and/or "western" name depending on their preference and origin. Certifications - The certifications element will display a certificate obtained by a person during his/her lifetime. This information will not be linked to a date and will only display the certificate. Education - This section provides information on the person's educational background. Fields include college, degree, major and graduation date, and will be listed per Degree record. If a person has multiple degrees from the same college, then two records are created. XML Sample - Person Information Element
<P ersonInformation> <LastM odified Date="2008-04-11T03:10:29"></LastM odified> <N ame> <Info Ty pe="LastN ame">P almisano</Info> <Info Ty pe="F irstN ame">S amuel</Info> <Info Ty pe="M iddle/Initial">J.</Info> <Info Ty pe="A ge">56</Info> <Info Ty pe="S ex">M </Info> </N ame> <E ducationH istory > <Degree O rder="1"> <C ollege ID="1144">John H opkins U niv ersity </C ollege> </Degree> </E ducationH istory > </P ersonInformation>

17.11.2.3 Contact Information

The ContactInformation element provides information on an officer's contact details. Fields include e-mail, messenger address, web-site, phone, fax, mobile number, and contact person. The "ContactInformation" container element is optional; therefore, an element/attribute will not be available if it is null. XML Sample - Contact Information Element
<C ontactInformation> <E M ail>Thomas.G locer@thomsonreuters.com</E M ail> <M essenger>thomas.glocer.reuters.com@reuters.net</M essenger> <Website>http://thomas.glocer.ime.reuters.com</Website> <C ontactP erson> <C ontact N ame="Jane Welch" Title="E xecutiv e A ssistant"/> <P honeN umbers> <P hone Ty pe="M ainP hone"> <C ountry P honeC ode>44</C ountry P honeC ode> <C ity A reaC ode>20</C ity A reaC ode> <N umber>75427711</N umber> </P hone> <P hone Ty pe="M ainF ax"> <C ountry P honeC ode>44</C ountry P honeC ode> <C ity A reaC ode>20</C ity A reaC ode> <N umber>75191210</N umber> </P hone> <P hone Ty pe="M obileP hone"> <C ountry P honeC ode>44</C ountry P honeC ode> <C ity A reaC ode>79</C ity A reaC ode> <N umber>90567711</N umber> </P hone> </P honeN umbers> </C ontactP erson> </C ontactInformation><P ersonInformation>

302

TRKD API Developer's Guide

17.11.2.4 Corporate Affiliations

CorporateAffiliations section provides information on an officer's corporate affiliations or relationships within companies on the Thomson Reuters Fundamental database. Fields include Report Number, Company Name, Officer ID and Title and will be listed per Order record. XML Sample - Corporate Affiliations Element
<C orporateA ffiliations> <A ffiliation O rder="0"> <C ompany RepN o="3526N " N ame="F ord M otor C ompany " A ctiv e="1"></C ompany > <O fficer ID="55653" Title="C hairman of the Board, P resident, C hief E xecutiv e O fficer, Director" A ctiv e="0"></O fficer> </A ffiliation> <A ffiliation O rder="0"> <C ompany RepN o="4625N " N ame="Imperial C hemical Industries P LC (A DR)" A ctiv e="0"></C ompany > <O fficer ID="117205" Title="C hairman of the Board" A ctiv e="0"></O fficer> </A ffiliation> <A ffiliation O rder="0"> <C ompany RepN o="4741N " N ame="International Business M achines C orp." A ctiv e="1"></C ompany > <O fficer ID="28518" Title="Director" A ctiv e="0"></O fficer> </A ffiliation> <A ffiliation O rder="0"> <C ompany RepN o="A 493B" N ame="Imperial C hemical Industries P LC " A ctiv e="0"></C ompany > <O fficer ID="605085" Title="C hairman of the Board" A ctiv e="0"></O fficer> </A ffiliation> </C orporateA ffiliations>

17.11.2.5 Position Information

PositionInformation contains an element on each of the following items: Tenure Dates Titles Committee Memberships Tenure Dates - Tenure dates indicate the length of service for this person with this company. Tenure may be indicated for an Officer, Director or both. The existence of an End Date indicates that the person is no longer an Officer (or Director) with the company. Note: The date is not given in regular Date format (YYYYMMDD) because some components of the date (e.g. the Day) may not be available. In some instances the Start Year may also not be available to Thomson Reuters. In such instances Start Year is populated with the string NA. Titles - The Titles section details the various titles a person has held with a company, over time. Each Designation has a Start date, may have an End date, has a Long Title as reported by the company, and up to four titles. Thus a company may report a person's most recent title as 'Chairman of the Board and Chief Executive Officer'. This will appear as the Long Title. The person will also be tagged with two 'title ID's': CHM =Chairman and CEO = Chief Executive Officer. If available, this title will also have a Start date. However, as the most current title, this will not have an End date. If this person was previously a VP of the company, then there will be another Designation record in the file. This could have a Long Title of Vice President and a title ID VP=Vice President. As this is not the most current title, this designation will have an End date. Committee Memberships - This section details the various board committees a director sits on. Fields include committee, title and start/end date. XML Sample - Position Information Element
<P ositionInformation> <TenureDates> <O fficerS tart Year="1997"></O fficerS tart> <DirectorS tart Year="2000" M onth="07" Day ="25"></DirectorS tart> </TenureDates> <Titles> <Designation> <S tart Year="2003" M onth="01" Day ="01"></S tart>

Fundamentals

303

<LongTitle>C hairman of the Board, P resident, C hief E xecutiv e O fficer</LongTitle> <Title O rder="0" ID="C H M ">C hairman</Title> <Title O rder="1" ID="DRC ">Director</Title> <Title O rder="2" ID="P RE ">P resident</Title> <Title O rder="3" ID="C E O ">C hief E xecutiv e O fficer</Title> </Designation> ... <Designation> <S tart Year="1997"></S tart> <E nd Year="2000" M onth="07" Day ="25"></E nd> <LongTitle>S enior V ice P resident and G roup E xecutiv e</LongTitle> <Title O rder="0" ID="S V P ">S enior V ice P resident</Title> </Designation> </Titles> <C ommitteeM emberships> <C ommittee> <C ommitteeN ame ID="4">E xecutiv e</C ommitteeN ame> <Title>C hairman</Title> </C ommittee> </C ommitteeM emberships> </P ositionInformation>

17.11.2.6 Biographical Information

This section provides an officer's biography. Information is collected for all companies on the Thomson Reuters Fundamental database where available and is unique per company. XML Sample - Biographical Information Element
<BiographicalInformation> <Text Ty pe="Biography ">S amuel J. P almisano is chairman of the Board, president and chief executiv e officer of IBM and chairman of IBM 's E xecutiv e C ommittee. M r. P almisano joined IBM in 1973. H e w as elected senior v ice president and group executiv e of the P ersonal S y stems G roup in 1997, senior v ice president and group executiv e of IBM G lobal S erv ices in 1998, senior v ice president and group executiv e of E nterprise S y stems in 1999, president and chief operating officer in 2000, chief executiv e officer in 2002 and chairman of the Board in 2003. M r. P almisano is a director of E xxon M obil C orporation. M r. P almisano became an IBM director in 2000.</Text> </BiographicalInformation>

17.11.2.7 Salary Information

This section contains information about an officers' remuneration, both salary (CompensationInformation) and stock options related (OptionsInformation). The information is provided on a periodic basis, with a period end date identifying each period. The currency for the reported remuneration is provided with the tag CompensationCurrency. This currency may change over time. Non-stock option related compensation is listed under Compensation. For stock options, number of options and value is listed for Exercised', 'Unexercised-Exercisable', and 'Unexercisedunexercisable'. XML Sample - Salary Information Element
<S alary Information> <C ompensationP eriod E ndDate="2007-12-31"> <S ubmission Ty pe="DE F 14A " Year="2008" M onth="03" Day ="10"></S ubmission> <C ompensationC urrency >U S D</C ompensationC urrency > <C ompany S pecificC ompensation> <C ompensationInformation> <C ompensation C O A ="S A L" Line="S alary ">620417</C ompensation> <C ompensation C O A ="BO N " Line="Bonus">220000</C ompensation> <C ompensation C O A ="TA C " Line="Total A nnual C ompensation">840417</C ompensation> <C ompensation C O A ="RS A " Line="Restricted S tock A w ards">446201</C ompensation> <C ompensation C O A ="A O C " Line="A ll O ther C ompensation">102778</C ompensation> <C ompensation C O A ="A O C " Line="C hange in P ension V alue">748545</C ompensation> <C ompensation C O A ="A O C " Line="C hange in Retention P lan V alue">541037</C ompensation>

304

TRKD API Developer's Guide

<C ompensation C O A ="A O C " Line="M arket P riced O ptions">33531</C ompensation> <C ompensation C O A ="A O C " Line="N on-E quity Incentiv e P lan C ompensation">1066400</C ompensation> <C ompensation C O A ="A O C " Line="P erformance S hare U nits">1325988</C ompensation> <C ompensation C O A ="A O C " Line="P remium P riced O ptions">796085</C ompensation> <C ompensation C O A ="A O C " Line="Restricted S tock U nits">736847</C ompensation> <C ompensation C O A ="TLC " Line="Total Long Term C ompensation">5797412</C ompensation> <C ompensation C O A ="F YT" Line="F iscal Year Total C ompensation">6637829</C ompensation> </C ompensationInformation> </C ompany S pecificC ompensation> <S tandardizedC ompensation> <C ompensationInformation> <C ompensation C O A ="S A L" Ty pe="S alary ">620417</C ompensation> <C ompensation C O A ="BO N " Ty pe="Bonus">220000</C ompensation> <C ompensation C O A ="TA C " Ty pe="Total A nnual C ompensation">840417</C ompensation> <C ompensation C O A ="RS A " Ty pe="Restricted S tock A w ards">446201</C ompensation> <C ompensation C O A ="A O C " Ty pe="A ll O ther C ompensation">5351211</C ompensation> <C ompensation C O A ="TLC " Ty pe="Total Long Term C ompensation">5797412</C ompensation> <C ompensation C O A ="F YT" Ty pe="F iscal Year Total C ompensation">6637829</C ompensation> </C ompensationInformation> </S tandardizedC ompensation> <O ptionsInformation> <O ption Ty pe="E xercised"> <N umber>1466</N umber> <V alue>76261</V alue> </O ption> </O ptionsInformation> </C ompensationP eriod> </S alary Information>

17.12 Getting a Company's Competitors

The Thomson Reuters Knowledge Direct API allows users to find out about the competitors of companies traded in the major US exchanges only. As of April 2004, there were over 11,000 US active and inactive companies with reported competitor information.

17.12.1 Get Competitors (GetCompetitors_1)

Requests for a companys major competitors are made using the GetCompetitors_1 request, which, like most fundamentals methods, uses a company id and id type. XML Sample Request - Getting Company's Competitors
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/26/F undamentals_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentals_1/ G etC ompetitors_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etC ompetitors_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentals_1" company Id="IBM " company IdTy pe="ticker" /> </Body > </E nv elope>

17.12.2 GetCompetitors_Response_1 Element

Competitors responses, like most fundamentals methods, contain company-level and issue-level identifiers in addition to their main content. Please see section Interpreting Common Fundamental Elements for a description of these elements.

Fundamentals

305

XML Sample Response - Getting Company's Competitors

<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentals_1/G etC ompetitors_1_Reply </a: A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-14T12:56:25.3036846Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etC ompetitors_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentals_1"> <C ompetitors M ajor="1" M inor="0" Rev ision="1" xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/C ompetitors_1"> <C oIDs xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ompany C ontentC ommon_1"> <C oID Ty pe="RepN o">4741N </C oID> <C oID Ty pe="C ompany N ame">International Business M achines C orp.</C oID> <C oID Ty pe="IRS N o">130871985</C oID> <C oID Ty pe="C IKN o">0000051143</C oID> </C oIDs> <Issues xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ompany C ontentC ommon_1"> ... </Issues> <C oG eneralInfo xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ompany C ontentC ommon_1"> ... </C oG eneralInfo> <C ompetitorsInfo LastM odified="2008-01-08T01:04:19.433"> <C ompetitor O rder="1"> <C ompID Ty pe="RepN o">4302N </C ompID> <C ompID Ty pe="C ompany N ame">H ew lett-P ackard C ompany </C ompID> <C ompID Ty pe="Ticker">H P Q </C ompID> <C ompC oTy pe C ode="E Q U ">E quity Issue</C ompC oTy pe> <C ompC oS tatus C ode="1">A ctiv e</C ompC oS tatus> </C ompetitor> ... <C ompetitor O rder="19"> <C ompID Ty pe="RepN o">A 17C 8</C ompID> <C ompID Ty pe="C ompany N ame">A pplied M icro C ircuits C orporation</C ompID> <C ompID Ty pe="Ticker">A M C C </C ompID> <C ompC oTy pe C ode="E Q U ">E quity Issue</C ompC oTy pe> <C ompC oS tatus C ode="1">A ctiv e</C ompC oS tatus> </C ompetitor> ... <C ompetitor O rder="9"> <C ompID Ty pe="RepN o">57840</C ompID> <C ompID Ty pe="C ompany N ame">M icrosoft C orporation</C ompID> <C ompID Ty pe="Ticker">M S F T</C ompID> <C ompC oTy pe C ode="E Q U ">E quity Issue</C ompC oTy pe> <C ompC oS tatus C ode="1">A ctiv e</C ompC oS tatus> </C ompetitor> </C ompetitorsInfo> </C ompetitors> </G etC ompetitors_Response_1> </Body > </E nv elope>

The <Competitor> element is the container element for each competitor of the company. The order number is assigned based on the original entry of the competitor company. For example, if a competitor company is added in the order of 2 (order = 2), but it is no longer competing with the company, then you will see the competitor companies 1, 3, 4, But there will not be any competitor company order = 2. The real order of the competitors is based on the size of their market caps and/or revenues. Note: The order of Competitor nodes in the response XML does not necessarily follow the numeric sort order of the Order attribute value. CompID Element - There are currently four identifiers used for each competitor where available. These id types are Repo Number, Company Name, Ticker and Symbol. Competitors can contain information about private, non-trading companies, in

306

TRKD API Developer's Guide

which case the API will show empty elements for all identifiers except RepNo and CompanyName. CompCoType - This element indicates the type of capital structure a competitor has or the type of issues the competitor company primarily trades.

17.13 Getting a List of Major Customers

The Thomson Reuters Knowledge Direct API provides access for a limited set of companies to names of major customers and revenue attributable to these customers. As of November, 2003, approximately 10%-15% of companies covered in the Thomson Reuters fundamentals database have reported information about their major customers. Many companies will not have this data available.

17.13.1 Get Major Customers (GetMajorCustomers_1)

Requests for a company's major customers are made using the GetMajorCustomers_1 request element, which, like most fundamentals methods, uses a company id and id type. XML Sample Request - Getting a List of Major Customers
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/26/F undamentals_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentals_1/ G etM ajorC ustomers_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etM ajorC ustomers_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentals_1" companyId="IBM . N" companyIdT ype="RIC " /> </Body > </E nv elope>

17.13.2 GetMajorCustomers_Response_1 Element

Major customers responses, like most fundamentals methods, contain company-level and issue-level identifiers in addition to their main content. Please see section Interpreting Common Fundamental Elements for a description of these elements. The MCInformation element contains information about attributable customer revenues for each period for which revenue information is available. The detail for a particular period is contained within a FiscalPeriod element. XML Sample - FiscalPeriod Element Containing Customer Details
<F iscalP eriod E ndDate="2002-12-31" F iscalYear="2002" Ty pe="A nnual"> <F P H eader> <P eriodLength>12</P eriodLength> <P eriodTy pe C ode="M ">M onths</P eriodTy pe> <U pdatedTy pe C ode="U P D">U pdated N ormal</U pdatedTy pe> <S tatementDate>2002-12-31</S tatementDate> <S ource Date="2003-06-30">20-F </S ource> </F P H eader> <C ustomerDetails> <C ustomerO rderN umber N ame="Infineon Technologies, Inc." P ercent="21.900563" Rev enue="15.448000">1</ C ustomerO rderN umber> <C ustomerO rderN umber N ame="S emiconductor C omponent Industries, Ltd." P ercent="19.900194" Rev enue="14.037000">2</ C ustomerO rderN umber> <C ustomerO rderN umber N ame="Texas Instruments, Inc." P ercent="18.499511" Rev enue="13.049000">3</ C ustomerO rderN umber> <C ustomerO rderN umber N ame="P hilips C omponents P hilippines, Inc." P ercent="8.999532" Rev enue="6.348000">4</

Fundamentals

307

C ustomerO rderN umber> <C ustomerO rderN umber N ame="F airchild S emiconductor" P ercent="7.000581" Rev enue="4.938000">5</C ustomerO rderN umber> <C ustomerO rderN umber N ame="Total Rev enue" P ercent="100.000000" Rev enue="70.537000">0</C ustomerO rderN umber> </C ustomerDetails> </F iscalP eriod>

17.13.3 FPHeader Element

Thomson Reuters collects both originally reported and revised (or restated) data. However, the GetMajorCustomers_1 request only displays the most recent (restated) data. Any given period can therefore be uniquely identified using the combination of Fiscal Period EndDate Date. Major Customer data is collected only on an annual basis. The Fiscal Period Header section described here is common across various Thomson Reuters financials APIs, and has the flexibility to accommodate information about interim (quarterly) periods. Users of Major Customers information can ignore references to interim periods, because for Major Customers responses, all referenced periods will be of type 'Annual'.

17.13.4 CustomerDetails Element

This section provides the names of customers and respective revenues associated with each customer. In some instances, customer 'names' are proxies such as 'Customer A', 'Customer B' etc. CustomerOrderNumber Element - The CustomerOrderNumber element indicates the order that each segment is reported in by the company. Name Attribute - The Name attribute indicates the name of the customer as provided by the company. In many cases this includes actual customer name - in some cases the company is reported anonymously, and so it is a proxy for the customer name (e.g. Customer A). Revenue Attribute - The Revenue attribute specifies the revenue attributable to the customer, as reported by the reporting company. Percent Attribute - The Percent attribute specifies the percent of total company revenue attributed to the customer.

17.14 Getting a Detailed Company Description

The GetLongCompanyDescription_1 request of the Thomson Reuters Knowledge Direct API provides a detailed business description about companies, including information about the company's current operations, history, its different divisions and products, and the markets it serves. The information is primarily collected from annual reports, with periodic updates to reflect substantial changes in the company's business during the year. A more concise description, the Thomson Reuters Short Business Description can be obtained via the GetGeneralInformation_1 request.

17.14.1 Get Long Company Description (GetLongCompanyDescription_1)

Requests for general company information are made using the GetLongCompanyDescription_1 request, which, like most fundamentals methods, uses a company id and id type. XML Sample Request - Getting Long Company Description
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/26/F undamentals_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentals_1/ G etLongC ompany Description_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID>

308

TRKD API Developer's Guide

<Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etLongC ompany Description_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentals_1" companyId="IBM .N" companyIdT ype="RIC " /> </Body > </E nv elope>

17.14.2 GetLongDescription_Response_1 Element

Long description responses, like most fundamentals methods, contain company-level and issue-level identifiers in addition to their main content. Please see section Interpreting Common Fundamental Elements for a description of these elements. IndustryInfo Element - This section contains information about the Thomson Reuters assigned industry and sectors that the company belongs to. It is similar to the industry information provided in the peerInfo element of GetGeneralInformationResponse. XML Sample - IndustryInfo Element
<Industry Info> <Industry Ty pe="M G IN DU S TRY" C ode="0909" M nem="S V S BU S ">Business S erv ices</Industry > <Industry Ty pe="M G S E C TO R" C ode="09" M nem="S E RV IC ">S erv ices</Industry > </Industry Info>

Text Element - The Text element contains the long business description for the company. XML Sample - Text Element
<Text LastM odified="2008-01-03" S ourceF ilingDate="2007-02-27" S ourceF ilingTy pe="10K; P RS ; P RS ">International Business M achines C orporation (IBM ), incorporated on June 16, 1911, is an information technology (IT) company . IBM also prov ides business, technology and consulting serv ices. The C ompany 's major operations comprise a G lobal S erv ices segment, a S y stems and Technology G roup, a S oftw are segment and a G lobal F inancing segment. IBM 's business comprises three principal business segments: S y stems and F inancing, S oftw are and S erv ices. The majority of the C ompany 's enterprise business, w hich excludes the C ompany 's original equipment manufacturer (O E M ) technology business, occurs in industries that are broadly grouped into six sectors: financial serv ices (banking, financial markets and insurance), public (education, gov ernment, healthcare and life sciences), industrial (aerospace, automotiv e, defense, chemical and petroleum and electronics), distribution (consumer products, retail, trav el and transportation), communications (telecommunications, media and entertainment, and energy and utilities) and small and medium business (mainly companies w ith less than 1,000 employ ees). .... .... .... </Text>

17.15 Getting General Company Information

Requests for General Company Information have been created to meet the demands of users who wish to use and display non-financial information such as company contact information, related industries, hyperlinks of related web content, and descriptive company information.

17.15.1 Get General Information (GetGeneralInformation_1)

Requests for general company information are made using the GetGeneralInformation_1 request, which, like most fundamentals methods, specifies a 'companyId' and 'idType'. In addition, a country code can be specified as well as the option to include or exclude the company's reference information. See section Getting Company Reference Information for more information. The following example passes RIC id for IBM and requests to return reference information in the response by setting <ShowReferenceInformation> to 'true'.

Fundamentals

309

XML Sample Request - Getting General Information

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/26/F undamentals_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentals_1/ G etG eneralInformation_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etG eneralInformation_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentals_1" companyId="IBM .N" companyIdT ype="RIC " country C ode="" lang="en-U S " ShowRefer enceInfor mation="tr ue" /> </Body > </E nv elope>

17.15.2 GetGeneralInformation_Response_1 elements

The response for GetGeneralInformation_1 request returns the following information in the GeneralInformation element: Industry Classification General Information Issue Information Contact Information Web links Descriptive sections Advisors Officers If <ShowReferenceInformation> is set to 'true' in the request the response will also contain the company reference information (see section Getting Company Reference Information for more details). XML Sample Response - Getting General Information
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentals_1/ G etG eneralInformation_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-14T12:56:25.3036846Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etG eneralInformation_Response_1 xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/ XM LS chema" xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentals_1"> <ReferenceInformation M ajor="3" M inor="0" Rev ision="1" xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/ ReferenceInformation_1"> <RepN o>4741N </RepN o> <P roduction Date="2008-01-26T21:59:55" /> <C ompany Information> <C ompany Xrefs> <C ompany Xref Ty pe="IRS N o">130871985</C ompany Xref> ... <C ompany N ame Ty pe="P rimary ">International Business M achines C orp.</C ompany N ame> </C ompany Xrefs> <C ompany S tatus> ... </C ompany S tatus> <C ompany U pdates> ...

310

TRKD API Developer's Guide

</C ompany U pdates> <C urrencies> ... </C urrencies> <Industry C lassification> <Taxonomy Ty pe="RBS S 2004"> <Detail O rder="1" C ode="57211" Description="IT S erv ices &amp; C onsulting" /> </Taxonomy > ... <Taxonomy Ty pe="M G IN DU S TRY"> <Detail O rder="1" C ode="0909" M nemonic="S V S BU S " Description="Business S erv ices" /> </Taxonomy > </Industry C lassification> </C ompany Information> <IssueInformation> <Issue ID="1" Ty pe="C " O rder="1"> ... </Issue> <Issue ID="2" Ty pe="P " O rder="1"> ... </Issue> </IssueInformation> </ReferenceInformation> <G eneralInformation M ajor="3" M inor="0" Rev ision="1" xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/ G eneralInformation_1"> <RepN o>4741N </RepN o> <C ompany N ame Ty pe="P rimary ">International Business M achines C orp.</C ompany N ame> <P roduction Date="2008-05-19T10:45:48" /> <Industry C lassification> <Taxonomy Ty pe="RBS S 2004"> <Detail O rder="1" C ode="57211" Description="IT S erv ices &amp; C onsulting" /> </Taxonomy > <Taxonomy Ty pe="N A IC S 1997"> <Detail O rder="1" C ode="541611" Description="A dministrativ e M anagement and G eneral M anagement C onsulting S erv ices" /> ... <Detail O rder="10" C ode="334119" Description="O ther C omputer P eripheral E quipment M anufacturing" /> </Taxonomy > ... </Industry C lassification> <IndexM emberships> <C onstituentO f IndexRIC =".DJI">Dow Industry </C onstituentO f> <C onstituentO f IndexRIC =".G S P C ">S &amp;P 500</C onstituentO f> </IndexM emberships> <C ompany G eneralInfo> <E mploy ees LastU pdated="2007-12-31">386558</E mploy ees> <TotalS haresO ut Date="2008-03-31" TotalF loat="1365000000.0">1373478587.0</TotalS haresO ut> <IncorporatedIn Date="1911-06-16" C ountry ="U S A ">N Y</IncorporatedIn> </C ompany G eneralInfo> <IssueInformation> <Issue ID="1" Ty pe="C " O rder="1"> <IssueDetails P arC urrency ="U S D" P arV alue="0.2" S hsA uthorized="4.6875E +09" S hsO ut="1.37347853E +09" S hsO utDate="2008-03-31" F loat="1.365E +09" V otes="1" C onv ersionF actor="1" /> </Issue> <Issue ID="2" Ty pe="P " O rder="1"> <IssueDetails P arC urrency ="U S D" P arV alue="0.01" S hsA uthorized="1.5E +08" S hsO ut="0" S hsO utDate="2008-03-31" /> </Issue> </IssueInformation> <C ontactInfo LastU pdated="2008-04-29T17:13:54"> <A ddress> ... </A ddress> <C ontactP erson> ... </C ontactP erson> <P honeN umbers> ... </P honeN umbers> </C ontactInfo> <WebLinksInfo LastU pdated="2008-02-27T09:14:48"> <WebS ite Ty pe="H ome P age">http://w w w .ibm.com/</WebS ite> <WebS ite Ty pe="Inv estor Relations">http://w w w .ibm.com/inv estor/?cm_re=rcol-_-link-_-inv estor</WebS ite> <WebS ite Ty pe="F inancial Information">http://w w w .ibm.com/inv estor/filings/index.phtml</WebS ite> <WebS ite Ty pe="C orporate H istory /P rofile">http://w w w .ibm.com/inv estor/company /index.phtml</WebS ite> <WebS ite Ty pe="E xecutiv es">http://w w w .ibm.com/inv estor/corpgov ernance/cgmgmt.phtml</WebS ite> <WebS ite Ty pe="P roducts/S erv ices">http://w w w .ibm.com/sandbox/homepage/v ersion-b/</WebS ite> <WebS ite Ty pe="E mploy ment O pportunities">http://w w w -03.ibm.com/employ ment/</WebS ite> </WebLinksInfo>

Fundamentals

311

<TextInfo> <Text Ty pe="Business S ummary " LastU pdated="2008-04-29T21:08:17" lang="en-U S " S ourceF ilingDate="2008-01-02T00:00:00" S ourceF ilingTy pe="P RS ; P RS ; P RS ">International Business M achines C orporation (IBM ) is an information technology (IT) company . The C ompany 's major operations include a G lobal Technology S erv ices (G TS ) segment, a G lobal Business S erv ices (G BS ) segment, a S y stems and Technology segment, a S oftw are segment and a G lobal F inancing segment. In F ebruary 2008, the C ompany acquired A rsenal Digital S olutions and N et Integration Technologies Inc. A rsenal is a priv ately held company based in C ary , N orth C arolina, w ith a suite of ondemand data protection solutions. In January 2008, IBM announced that it has completed its acquisition of C ognos Incorporated. In January 2008, IBM acquired XIV , a priv ately held storage technology company based in Tel A v iv , Israel. In S eptember 2007, IBM completed the acquisition of DataM irror C orporation. In A ugust 2007, IBM acquired WebDialogs, Inc. In A pril 2008, the C ompany completed the acquisition of Telelogic A B, Diligent Technologies, F ilesX and InfoDy ne C orporation. </Text> ... </TextInfo> <A dv isors> <A uditor C ode="P WC L" N ame="P ricew aterhouseC oopers LLP " /> <TransferA gent C ode="137" N ame="C omputershare Trust C ompany " /> </A dv isors> <O fficersInfo> <O fficer ID="28503" S tatus="Both" Rank="1" P ersonID="28503" lang="en-U S "> <S ubmission Ty pe="DE F 14A " Year="2008" M onth="03" Day ="10" /> <N ameA ndTitle> <P ersonalInfo> ... </P ersonalInfo> <TenureDates> <O fficerS tart Year="1997" /> <DirectorS tart Year="2000" M onth="07" Day ="25" /> </TenureDates> <Titles> <Designation> <S tart Year="2003" M onth="01" Day ="01" /> <LongTitle>C hairman of the Board, P resident, C hief E xecutiv e O fficer</LongTitle> <Title O rder="0" ID="C H M ">C hairman</Title> <Title O rder="1" ID="DRC ">Director</Title> <Title O rder="2" ID="P RE ">P resident</Title> <Title O rder="3" ID="C E O ">C hief E xecutiv e O fficer</Title> </Designation> ... <Designation> ... </Designation> </Titles> </N ameA ndTitle> </O fficer> ... </O fficersInfo> </G eneralInformation> </G etG eneralInformation_Response_1> </Body > </E nv elope>

17.15.2.1 GeneralInformation Element

GeneralInformation is the main element that contains all the information listed above as well as: RepNo - RepNo is the permanent identifier for a company in the Thomson Reuters Fundamentals database. CompanyName - states the full name of the company. Production Date - this section contains the date and time for when the information was last generated. XML Sample - General Information Element
<G eneralInformation M ajor="3" M inor="0" Rev ision="1" xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/ G eneralInformation_1"> <RepN o>4741N </RepN o> <C ompany N ame Ty pe="P rimary ">International Business M achines C orp.</C ompany N ame> <P roduction Date="2008-05-19T10:45:48" />

312

TRKD API Developer's Guide

17.15.2.2 Industry Classification

Information is provided on the Thomson Reuters Industry, Thomson Reuters Sector, NAICS and SIC codes that are applicable to the company. Thomson Reuters has created industry and sector classification schemas which currently include 112 industries and 12 sectors. Each company in the database is assigned a Thomson Reuters industry and sector code. Each company is also assigned a number of NAICS 1997 and SIC codes, depending on the lines of businesses the company is involved in. Some of these codes are company reported (reported code = 1) while others are assigned by Thomson Reuters. Note: Company reported SIC and NAICS codes will always be tagged Order = 0 (concurrently with reported code = 1). Thomson Reuters assigned codes will be tagged with Order codes 1-10. Since the Thomson Reuters assigned codes will often include the company reported code, there will often be duplication in the list of Order codes 0-10. Users should note this potential duplication when using these codes. Industry Codes Taxono my Description

NAICS199 Based on NAICS codes published in 1997. 7 SIC1987 Based on SIC codes published in 1987. Note that this is the last set of SIC codes published; SIC codes were subsequently replaced by NAICS codes.

RBSS2004 Thomson Reuters Business Sector Schema - Thomson Reuters proprietary industry codes. A four tier industry classification system. MGSECTO Legacy sector codes; to be retired from Thomson Reuters products in 2006. R MGINDUS Legacy industry codes; to be retired from Thomson Reuters products in 2006. TRY XML Sample - Industry Classification Element
<Industry C lassification> <Taxonomy Ty pe="RBS S 2004"> <Detail O rder="1" C ode="57211" Description="IT S erv ices &amp; C onsulting" /> </Taxonomy > <Taxonomy Ty pe="N A IC S 1997"> <Detail O rder="1" C ode="541611" Description="A dministrativ e M anagement and G eneral M anagement C onsulting S erv ices" /> <Detail O rder="2" C ode="561439" Description="O ther Business S erv ice C enters (including C opy S hops)" /> ... <Detail O rder="9" C ode="42142" Description="O ffice E quipment Wholesalers" /> <Detail O rder="10" C ode="334119" Description="O ther C omputer P eripheral E quipment M anufacturing" /> </Taxonomy > <Taxonomy Ty pe="S IC 1987"> <Detail O rder="1" C ode="8742" Description="M anagement C onsulting S erv ices" /> <Detail O rder="2" C ode="7389" Description="Business S erv ices, N ec" /> ... <Detail O rder="10" C ode="3577" Description="C omputer P eriph'L E quipment, N ec" /> </Taxonomy > <Taxonomy Ty pe="M G S E C TO R"> <Detail O rder="1" C ode="09" M nemonic="S E RV IC " Description="S erv ices" /> </Taxonomy > <Taxonomy Ty pe="M G IN DU S TRY"> <Detail O rder="1" C ode="0909" M nemonic="S V S BU S " Description="Business S erv ices" /> </Taxonomy > </Industry C lassification>

Element Taxonomy Type Order Code Mnemonic Description

Description Schema being used. Order number for the given industry type. Code number for the given industry type. Market Guide Mnemonic (used only for MGSector and MGIndustry). Description of assigned code.

Fundamentals

313

17.15.2.3 Company General Information

The Company General Information section contains some frequently used company level information such as number of employees, shares outstanding and float. Where available (for US companies only), information is provided about when the company went public, and where the company is incorporated in. Note: The shares outstanding and float numbers are derived from the issue level shares outstanding and float figures. Share counts from all issues are added up, weighted by the conversion factor to the primary class of shares, and expressed in equivalent to primary class basis. XML Sample - Company General Information Element
<C ompany G eneralInfo> <E mploy ees LastU pdated="2007-12-31">386558</E mploy ees> <TotalS haresO ut Date="2008-03-31" TotalF loat="1365000000.0">1373478587.0</TotalS haresO ut> <IncorporatedIn Date="1911-06-16" C ountry ="U S A ">N Y</IncorporatedIn> </C ompany G eneralInfo>

Employees: Number of employees. LastUpdated: Date this value was last updated. TotalSharesOut: Shares outstanding, in equivalent to primary class basis. Date: Date this value was last updated. TotalFloat: Float, derived from issue level data. CommonShareholders: Number of common shareholders. Date: Date this value was last updated. IncorporatedIn: State of incorporation (US only). Date: Date of incorporation. PublicSince: Date company went public.

17.15.2.4 Issue Information

The issue information section provides certain details about each equity issue that the company has authorized. Please see section Issues, Issue, and IssueID - Response Elements for explanations of Issue ID and Issue Order. The Issue Type denotes whether an Issue is Common (C) or Preferred (P). Issue Details contain the Par Currency, Par Value, Shares Authorized and other values. XML Sample - Issue Information Element
<IssueInformation> <Issue ID="1" Ty pe="C " O rder="1"> <IssueDetails P arC urrency ="U S D" P arV alue="0.2" S hsA uthorized="4.6875E +09" S hsO ut="1.37347853E +09" S hsO utDate="2008-03-31" F loat="1.365E +09" V otes="1" C onv ersionF actor="1" /> </Issue> <Issue ID="2" Ty pe="P " O rder="1"> <IssueDetails P arC urrency ="U S D" P arV alue="0.01" S hsA uthorized="1.5E +08" S hsO ut="0" S hsO utDate="2008-03-31" /> </Issue> </IssueInformation>

Element Issue ID Issue Type Issue Order ParCurrency ParValue

Description Unique, Thomson Reuters assigned issue ID within a company. Please see details in section Issues, Issue, and IssueID - Response Elements. Common or Preferred Issue. Thomson Reuters assigned Order ID. Please see details in section Issues, Issue, and IssueID - Response Elements. Order = 1 denotes primary issue. The currency of the Par value. Par value.

314

TRKD API Developer's Guide

ShsAuthorized ShsOut Float Votes ConversionFa ctor

Number of shares authorized for the issue. Number of shares outstanding for the issue. Float. Vote per share for this issue. Conversion factor to primary issue.

17.15.2.5 Contact Information

This section provides contact information for the company, including an address, a contact person with title, phone/fax number(s) and e-mail. XML Sample - Contact Information Element
<C ontactInfo LastU pdated="2008-04-29T17:13:54"> <A ddress> <S treetA ddress Line="1">O ne N ew O rchard Road</S treetA ddress> <C ity >A rmonk</C ity > <S tateO rRegion>N Y</S tateO rRegion> <P ostalC ode>10504</P ostalC ode> <C ountry C ode="U S A ">U nited S tates</C ountry > </A ddress> <C ontactP erson> <C ontactN ame>E dw ard Barbini</C ontactN ame> <C ontactTitle>Inv estor Relations</C ontactTitle> </C ontactP erson> <P honeN umbers> <P hone Ty pe="M ainP hone"> <C ountry P honeC ode>1</C ountry P honeC ode> <C ity A reaC ode>914</C ity A reaC ode> <N umber>4991900</N umber> </P hone> <P hone Ty pe="M ainF ax"> <C ountry P honeC ode>1</C ountry P honeC ode> <C ity A reaC ode>914</C ity A reaC ode> <N umber>7656021</N umber> </P hone> <P hone Ty pe="C ontactP hone"> <C ountry P honeC ode>1</C ountry P honeC ode> <C ity A reaC ode>914</C ity A reaC ode> <N umber>4996565</N umber> </P hone> </P honeN umbers> </C ontactInfo>

17.15.2.6 Web Links

This section lists various commonly used web page addresses for the company, including home page, 'news releases' page, 'profile' page, the investor relations page, etc. XML Sample - Web Links Element
<WebLinksInfo LastU pdated="2008-02-27T09:14:48"> <WebS ite Ty pe="H ome P age">http://w w w .ibm.com/</WebS ite> <WebS ite Ty pe="Inv estor Relations">http://w w w .ibm.com/inv estor/?cm_re=rcol-_-link-_-inv estor</WebS ite> <WebS ite Ty pe="F inancial Information">http://w w w .ibm.com/inv estor/filings/index.phtml</WebS ite> <WebS ite Ty pe="C orporate H istory /P rofile">http://w w w .ibm.com/inv estor/company /index.phtml</WebS ite> <WebS ite Ty pe="E xecutiv es">http://w w w .ibm.com/inv estor/corpgov ernance/cgmgmt.phtml</WebS ite> <WebS ite Ty pe="P roducts/S erv ices">http://w w w .ibm.com/sandbox/homepage/v ersion-b/</WebS ite> <WebS ite Ty pe="E mploy ment O pportunities">http://w w w -03.ibm.com/employ ment/</WebS ite> </WebLinksInfo>

Fundamentals

315

17.15.2.7 Descriptive Sections

TextInfo segment provides various descriptive information sets on the company, including the following: Business Summary: Short business description, limited to 1,000 characters. Equity Composition: For US exchange traded co's, par values of common issues, treasury stock info and beneficial ownership info if available. Analyst Footnotes: Comments from Thomson Reuters analyst responsible for updating company. Financial Summary: Summary of most recently reported results. Note: Thomson Reuters also has a separate XML product that provides Long Business Descriptions (approx. 8,000 characters) for US exchange traded companies. XML Sample - Text Information Element
<TextInfo> <Text Ty pe="Business S ummary " LastU pdated="2008-04-29T21:08:17" lang="en-U S " S ourceF ilingDate="2008-01-02T00:00:00" S ourceF ilingTy pe="P RS ; P RS ; P RS ">International Business M achines C orporation (IBM ) is an information technology (IT) company . The C ompany 's major operations include a G lobal Technology S erv ices (G TS ) segment, a G lobal Business S erv ices (G BS ) segment, a S y stems and Technology segment, a S oftw are segment and a G lobal F inancing segment. In F ebruary 2008, the C ompany acquired A rsenal Digital S olutions and N et Integration Technologies Inc. A rsenal is a priv ately held company based in C ary , N orth C arolina, w ith a suite of ondemand data protection solutions. In January 2008, IBM announced that it has completed its acquisition of C ognos Incorporated. In January 2008, IBM acquired XIV , a priv ately held storage technology company based in Tel A v iv , Israel. In S eptember 2007, IBM completed the acquisition of DataM irror C orporation. In A ugust 2007, IBM acquired WebDialogs, Inc. In A pril 2008, the C ompany completed the acquisition of Telelogic A B, Diligent Technologies, F ilesX and InfoDy ne C orporation. </Text> <Text Ty pe="E quity C omposition" LastU pdated="2008-04-30T00:00:00">C ommon S tock $ .20 P ar, 3/08, 4,687,500,000 auth., 2,069,370,899 issd., less 695,892,312 shs. in Treas. @ $ 3.3B. Insiders ow n less than 1% (incl. 5.3M O ptions). P O 12/68, 50K shs. @ $ 328.50 by M errill Ly nch. 5/99, 5/97, 2-for-1 stock splits. F Y'04 Q 's are restated.</Text> <Text Ty pe="A naly st F ootnotes" LastU pdated="2008-04-30T00:00:00">7/95, C o. acq. Lotus Dev elopment C orp. for $ 3.2B. F Y'98-'00 financials and '99-'00 Q 's are reclass. F Y'01-'02 Q 's are restated for discontinued operations.</Text> <Text Ty pe="F inancial S ummary " LastU pdated="2008-04-30T00:00:00">BRIE F : F or the three months ended 31 M arch 2008, International Business M achines C orporation's rev enues increased 11% to $ 24.5B. N et income from continuing operations increased 26% to $ 2.32B. Rev enues reflect an increase in income from G lobal Technology S erv ices segment, higher sales from S oftw are segment and G lobal Business serv ices segment. N et income also reflects higher gross margin and increased intellectual property income.</Text> </TextInfo>

Element Type LastUpdated LanguageCod e SourceFilingD ate SourceFilingTy pe

Description Type of descriptive information. Last update date and time for the textual data. Language in which text is presented. Applicable only to Business summary. Currently the only available language in v3 files is English (en). Filing date of source document. Type of source document, such as 10-K.

17.15.2.8 Advisors
This section provides information on the company's current auditor and transfer agent/registrar where available. Where available, phone numbers for transfer agents are also provided. The phone number format is similar to phone number in the ContactInfo section of this file. XML Sample - Advisors Element
<A dv isors> <A uditor C ode="P WC L" N ame="P ricew aterhouseC oopers LLP " /> <TransferA gent C ode="137" N ame="C omputershare Trust C ompany " /> </A dv isors>

Element Auditor Code

Description 4-letter code for auditor.

316

TRKD API Developer's Guide

Auditor Name TransferAgent Code TransferAgent Name Phone

Full name of auditing firm. Numeric code for transfer agent. Current company transfer agent/registrar. Contains the following advisor information: CountryPhoneCode: Country codes of phone numbers. City-areacode: City area codes of phone numbers. Number: Phone numbers.

17.15.2.9 Officers
This section provides information on company executives, including name, age, title(s) and source document where officer information was collected from. Codes are used to represent officer titles and source document types. While Thomson Reuters collects information on all officers and directors listed in company filings, the GenInfo file contains information about up to 10 officers and 5 directors. Person Identifiers Each person within each company is assigned a unique Officer ID. This ID does not change, and is not re-used. However, no relationship is indicated between persons that belong to more than one company. While an Officer ID indicates a unique person within a company, the same person will be assigned a different OfficerID in the context of a different company. Thus, if John Lennon is currently an officer of one company and director of two companies, and in addition is an ex-officer of a fourth company, he will appear with four ID's in the file, with no link indicated between the four people. A person can be an officer, a director or both an officer and a director within a firm. While no ranking is provided by reporting companies, Thomson Reuters will assign a rank to each person based on their title(s), with the highest ranking person having the lowest rank number. Officer specific data Within the Personal Info section, the First, Middle and Last name, and person's age is provided. Tenure dates indicate the length of service for this person with this company. Tenure may be indicated for Officer, Director or both. The existence of an End Date indicates that the person is no longer an Officer (or Director) with the company. Note: The date is not given in regular Date format (YYYYMMDD) because some components of the date (e.g. the Day) may not be available. In some instances the Start Year may also not be available to Thomson Reuters. In such instances Start Year is populated with the string NA. The Titles section details the various titles a person has held with a company, over time. Each Designation has a Start date, may have an End date, has a Long Title as reported by the company, and up to four titles. Thus, a company may report a person's most recent title as 'Chairman of the Board and Chief Executive Officer'. This will appear as the Long Title. The person will also be tagged with two 'title ID's': CHM = Chairman and CEO = Chief Executive Officer. If available, this title will also have a Start date. However, as the most current title, this will not have an End date. If this person was previously a VP of the company, then there will be another Designation record in the file. This could have a Long Title of Vice President and a title ID VP=Vice President. As this is not the most current title, this designation will have an End date. XML Sample - Officers Element
<O fficersInfo> <O fficer ID="28503" S tatus="Both" Rank="1" P ersonID="28503" lang="en-U S "> <S ubmission Ty pe="DE F 14A " Year="2008" M onth="03" Day ="10" /> <N ameA ndTitle> <P ersonalInfo> <Info Ty pe="LastN ame">P almisano</Info> <Info Ty pe="F irstN ame">S amuel</Info>

Fundamentals

317

<Info Ty pe="S uffix" /> <Info Ty pe="P refix" /> <Info Ty pe="P referredN ame" /> <Info Ty pe="M iddle/Initial">J.</Info> <Info Ty pe="A ge">56</Info> <Info Ty pe="S ex">M </Info> </P ersonalInfo> <TenureDates> <O fficerS tart Year="1997" /> <DirectorS tart Year="2000" M onth="07" Day ="25" /> </TenureDates> <Titles> <Designation> <S tart Year="2003" M onth="01" Day ="01" /> <LongTitle>C hairman of the Board, P resident, C hief E xecutiv e O fficer</LongTitle> <Title O rder="0" ID="C H M ">C hairman</Title> <Title O rder="1" ID="DRC ">Director</Title> <Title O rder="2" ID="P RE ">P resident</Title> <Title O rder="3" ID="C E O ">C hief E xecutiv e O fficer</Title> </Designation> ... <Designation> <S tart Year="1997" /> <E nd Year="2000" M onth="07" Day ="25" /> <LongTitle>S enior V ice P resident and G roup E xecutiv e</LongTitle> <Title O rder="0" ID="S V P ">S enior V ice P resident</Title> </Designation> </Titles> </N ameA ndTitle> </O fficer> ... <O fficer ID="381182" S tatus="Director" Rank="22" P ersonID="923422" lang="en-U S "> ... </O fficer> </O fficersInfo>

Element Officer ID Officer Status Officer Rank PersonalInfo TenureDates Titles

Description ID number for the officer. Denotes whether individual is an officer of company, director or both. Rank order of the officer. Last name, first name, middle initial, age or sex of officer. Contains start dates as a director or/and as an Officer. Contains designations for the title , start date under the title, title order and abbreviation.

Officer PersonID ID number for person.

17.16 Get Industry Aggregate (GetIndustryAggregate_1)

You can use GetIndustryAggregate_1 request to generate ratios and statistics for an industry, sector, or index. This data includes the following groups: Price and Volume Dividend Growth Rates Income Statement Management Effectiveness Per Share Ratios Prices Related Instutional Ownership Financial Strength Efficiency Ratios Profitability Ratios Share Related Items XML Sample Request - Getting Industry Aggregates

318

TRKD API Developer's Guide

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/26/F undamentals_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentals_1/ G etIndustry A ggregate_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etIndustry A ggregate_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentals_1" company IdTy pe="RE P O N O " company Id="[agg repono]" country C ode="" /> </Body > </E nv elope>

For retrieving ratios for an aggregate, the "REPONO" companyIdType should always be used. Specify the repono for a single industry, sector, or index. Note: You can get a list of aggregate reponos by using GetFundamentalsReferenceLists_1 request (see section Getting a List of Industries, Sectors, and Indexes (Aggregates)). For example, GetIndustryAggregate_1 request for industry "A5C6B" returns the following: XML Sample Response - Getting Industry Aggregates
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentals_1/ G etIndustry A ggregates_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-14T12:56:25.3036846Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etIndustry A ggregate_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentals_1"> <M G IA M ajor="1" M inor="0" Rev ision="1" xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/Industry A ggregate_1"> <A ggIDs C ategory ="Index"> <A ggID Ty pe= "REP O ">A 5C 6B</A ggID> <A ggID Ty pe= "C O DE">S P 600</A ggID> <A ggID Ty pe= "NA M E">S &amp;P 600</A ggID> </A ggIDs> <A ggregates> <Gr oup ID="P r ice & amp; V olume"> <A gg FieldName="BET A " T ype="N">1.01100</A gg> <A gg F ieldN ame="N P RIC E " Ty pe="N ">21.47000</A gg> <A gg F ieldN ame="P R04WKP C T" Ty pe="N ">-100.00000</A gg> ... <A gg F ieldN ame="P R5DA YP RC " Ty pe="N ">-100.00000</A gg> <A gg F ieldN ame="P RYTDP C T" Ty pe="N ">-100.00000</A gg> <A gg F ieldN ame="V O L1DP RC " Ty pe="N ">19.98800</A gg> </G roup> <G roup ID="Div idend"> <A gg F ieldN ame="YIE LD" Ty pe="N ">3.98600</A gg> <A gg F ieldN ame="A DIV 5YA V G " Ty pe="N ">1.26200</A gg> </G roup> ... <G roup ID="S hare Related Items"> <A gg F ieldN ame="M KTC A P " Ty pe="N ">481.62800</A gg> </G roup> </A ggregates> </M G IA > </G etIndustry A ggregate_Response_1> </Body >

Fundamentals

319

</E nv elope>

Attribute REPO CODE NAME GROUP ID

FieldName Type

Category Value Thomson Reuters repo (report) number for the industry. Thomson Reuters code for the industry. Descriptive name for the industry. The ratios and statistics are broken into related groups. These groups are Price & Volume, Dividend, Growth Rates, Income Statement, Management Effectiveness, Per Share Ratios, Price Related, Institutional Ownership, Financial Strength, Efficiency Ratios, Profitability Ratios, and Share Related Items. Each item is identified by a field name. The <Type> attribute indicates the data type: <N> = number, <D> = date, or <C> = character.

17.17 Getting Company Reference Information

Company Reference information provides the following company information: Company Information: This section contains information relevant to the Company. It contains information about external Company ID's (e.g. IRS Number, Company Name etc), about what content sets (e.g. financial statements, estimates, officer data etc) are available from Thomson Reuters, how recently such information has been updated, and other relevant details. Issue Information: IssueInformation contains details specific to the various equity issues that belong to a company (e.g. Common Issue 1, Preferred issue 4 etc). Information includes external ID's (CUSIP, SEDOL Ticker, primary RIC etc), about whether the issue is public or private etc.

17.17.1 Get Fundamentals Reference Info (GetFundamentalsReferenceInfo_1)

By specifying 'companyID', 'companyIDType' and an optional 'countryCode' we are able to retrieve that company's reference information. The following example passes RIC for IBM. XML Sample Request - Getting Fundamentals Reference Information
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/26/F undamentals_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentals_1/ G etF undamentalsReferenceInfo_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etF undamentalsReferenceInfo_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentals_1" company Id=" IBM .N" company IdTy pe=" RIC " country C ode="" /> </Body > </E nv elope>

The response retrieves the following information: XML Sample Response - Getting Fundamentals Reference Information
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentals_1/ G etF undamentalsReferenceInfo_1_Reply </a:A ction>

320

TRKD API Developer's Guide

<C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-14T12:56:25.3036846Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etF undamentalsReferenceInfo_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentals_1"> <ReferenceInformation M ajor="3" M inor="0" Rev ision="1" xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/ ReferenceInformation_1"> <RepN o>4741N </RepN o> <P roduction Date="2008-01-26T21:59:55"></P roduction> <C ompany Information> <C ompany Xrefs> <C ompany Xref Ty pe="IRS N o">130871985</C ompany Xref> <C ompany Xref Ty pe="C IKN o">0000051143</C ompany Xref> <C ompany Xref Ty pe="F P roXRef">100002523</C ompany Xref> <C ompany Xref Ty pe="O rgID">18228</C ompany Xref> <C ompany N ame Ty pe="P rimary ">International Business M achines C orp.</C ompany N ame> </C ompany Xrefs> <C ompany S tatus> <C ompany Ty pe="E Q U "></C ompany > <A v ailableInfo Ty pe="BusinessIntelligence">1</A v ailableInfo> <A v ailableInfo Ty pe="F inancials">1</A v ailableInfo> <A v ailableInfo Ty pe="E stimates">1</A v ailableInfo> <A v ailableInfo Ty pe="S ignificantDev elopment">1</A v ailableInfo> <A v ailableInfo Ty pe="O fficers">1</A v ailableInfo> <F ilingS tatus C urrentS tatus="F iling" ReasonC ode="0"></F ilingS tatus> <H asP ublicDebt>0</H asP ublicDebt> </C ompany S tatus> <C ompany U pdates> <LastM odified Ty pe="F inancials">2008-01-24T18:44:27</LastM odified> <LastM odified Ty pe="O ther">2008-01-25T10:22:02</LastM odified> <LatestInformation Ty pe="A nnualF inancials">2007-12-31</LatestInformation> <LatestInformation Ty pe="InterimF inancials">2007-12-31</LatestInformation> </C ompany U pdates> <C urrencies> <C urrency Ty pe="F inancialS tatements">U S D</C urrency > <C urrency Ty pe="E stimates">U S D</C urrency > <C urrency Ty pe="P rimary IssueP rice">U S D</C urrency > </C urrencies> <Industry C lassification> <Taxonomy Ty pe="RBS S 2004"> <Detail O rder="1" C ode="57211" Description="IT S erv ices &amp; C onsulting"></Detail> </Taxonomy > ... <Taxonomy Ty pe="M G IN DU S TRY"> <Detail O rder="1" C ode="0909" Description="Business S erv ices" M nemonic="S V S BU S "></Detail> </Taxonomy > </Industry C lassification> </C ompany Information> <IssueInformation> <Issue ID="1" Ty pe="C " O rder="1"> <IssueXrefs> <IssueXref Ty pe="N ame">C ommon S tock</IssueXref> <IssueXref Ty pe="Ticker">IBM </IssueXref> <IssueXref Ty pe="RIC ">IBM </IssueXref> <IssueXref Ty pe="Display RIC ">IBM .N </IssueXref> </IssueXrefs> <IssueS tatus> <IssueTy pe>C ommon S tock</IssueTy pe> </IssueS tatus> <IssueS pecifics> <E xchange C ode="N YS E " C ountry ="U S A " Region="N A ">N ew York S tock E xchange</E xchange> <ListingTy pe>O S R</ListingTy pe> <M ostRecentS plit Date="1999-05-27">2.0</M ostRecentS plit> <S plitH istory > <S plit Date="1999-05-27">2.0</S plit> <S plit Date="1997-05-28">2.0</S plit> </S plitH istory > </IssueS pecifics> </Issue> <Issue ID="2" Ty pe="P " O rder="1"> <IssueXrefs> <IssueXref Ty pe="N ame">P referred S tock- 7.5% </IssueXref> </IssueXrefs>

Fundamentals

321

<IssueS tatus> <IssueTy pe>P referred S tock</IssueTy pe> </IssueS tatus> <IssueS pecifics> <E xchange C ode="N YS E " C ountry ="U S A " Region="N A ">N ew York S tock E xchange</E xchange> </IssueS pecifics> </Issue> </IssueInformation> </ReferenceInformation> </G etF undamentalsReferenceInfo_Response_1> </Body > </E nv elope>

17.17.2 ReferenceInformation Element

ReferenceInformation is the main element that contains the CompanyInformation Element and Issue element as well as: RepNo: Permanent identifier for a company assigned by Thomson Reuters. Production Date: This section contains the date and time for when the information was last generated. XML Sample - ReferenceInformation Element
<ReferenceInformation M ajor="3" M inor="0" Rev ision="1" xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/ ReferenceInformation_1"> <RepN o>4741N </RepN o> <P roduction Date="2008-01-26T21:59:55"></P roduction> <C ompany Information> ... </C ompany Information> <IssueInformation> ... </IssueInformation> </ReferenceInformation>

17.17.3 Company Xrefs

This section contains company level reference information including company name and external company identifiers. Available external identifiers at a company level are the IRS Number, CIK number and XRef; both are specific to US companies. In addition, the Company Name is provided. Note: Currently, only one version of Company Name (labeled 'Primary') is provided in the file. In the future, other versions, such as a local version or a more abbreviated version of the name may be provided. XML Sample - ReferenceInformation Element
<C ompany Xrefs> <C ompany Xref Ty pe="IRS N o">130871985</C ompany Xref> <C ompany Xref Ty pe="C IKN o">0000051143</C ompany Xref> <C ompany Xref Ty pe="F P roXRef">100002523</C ompany Xref> <C ompany Xref Ty pe="O rgID">18228</C ompany Xref> <C ompany N ame Ty pe="P rimary ">International Business M achines C orp.</C ompany N ame> </C ompany Xrefs>

17.17.4 Company Status

CompanyStatus contains information about the type of content available for the company, and the company classification according to Thomson Reuters. The following is the breakdown of information provided in CompanyStatus:

322

TRKD API Developer's Guide

Element Company Type

Description This indicates the type of capital structure a company has or the type of issues the company primarily trades. Note: The Thomson Reuters fundamental database primarily covers financial statement information for companies with publicly traded equity. The majority of companies trade Equity and a minority trade Debt Issues only, with the other types appearing infrequently. If a company trades more than one type of the stock, only the primary stock will be used to describe the company type.

The following is the list of values and their descriptions: EQU: Stands for Equity. Company trades common shares. Additionally, the company may have other types of securities such as debt and preferred stock issued. DBT: Stands for Debt Issue. Company has publicly traded debt but no common or preferred stock trading. PRE: Stands for Preferred. Issue Company has preferred stock but no common stock trading. IPO: Stands for Pre-IPO. Company has filed an IPO registration statement, but shares are not trading in the market. LPT Limited: Stands for Partnership, Reserved for future use. IDX: Stands for Index. Reserved for future use. PVT: Stands for Private. Company is private. Company Contains the following status information: Status Type ActiveStatus: This flag indicates whether a company is active in the Thomson Reuters fundamental database. The flag can take one of two values: ~ 0 means the company is inactive due to all of its issues being inactive. ~ 1 means the company is active due to at least one issue being considered active. CurrentEstimates: This flag indicates whether there are any 'current' or valid' estimates for the company. ~ 0 stands for no current estimates. No brokers have any estimates that are considered current or active. The company may have had active estimates in the past. ~ 1 stands for current estimates exist. At least one broker has one estimate that is currently considered 'active'. AvailableInfo: Indicated what type of company information is available from Thomson Reuters Company Content. The types of content referred to here are: ~ Financials: History of company financials. ~ Estimates: Estimates from brokers, plus Thomson Reuters Consensus Estimates. ~ Significant Developments: filtering service. See chapter Significant Developments for more information. ~ BusinessIntelligence: Descriptive information, including company address, business description etc. ~ Officers: Names, titles, bios and compensation on company officers and directors. FilingStatus Indicates whether or not the company is currently filing financial statements. There are instances when the company is active and public, but not filing financials statements. This flag will indicate when an active, public company is not filing, and why it is not filing. HasPublicDe Indicates whether or not the company has any outstanding public debt. bt XML Sample - Company Status Element
<C ompany S tatus> <C ompany Ty pe="E Q U "></C ompany > <A v ailableInfo Ty pe="BusinessIntelligence">1</A v ailableInfo> <A v ailableInfo Ty pe="F inancials">1</A v ailableInfo> <A v ailableInfo Ty pe="E stimates">1</A v ailableInfo> <A v ailableInfo Ty pe="S ignificantDev elopment">1</A v ailableInfo> <A v ailableInfo Ty pe="O fficers">1</A v ailableInfo> <F ilingS tatus C urrentS tatus="F iling" ReasonC ode="0"></F ilingS tatus> <H asP ublicDebt>0</H asP ublicDebt> </C ompany S tatus>

17.17.5 Company Updates

This section contains information about when certain types of content were last updated as well as data regarding the most current fiscal period for which financial data. The LatestInformation element contains the period end dates for the latest

Fundamentals

323

available financials. XML Sample - Company Updates Element

<C ompany U pdates> <LastM odified Ty pe="F inancials">2008-01-24T18:44:27</LastM odified> <LastM odified Ty pe="O ther">2008-01-25T10:22:02</LastM odified> <LatestInformation Ty pe="A nnualF inancials">2007-12-31</LatestInformation> <LatestInformation Ty pe="InterimF inancials">2007-12-31</LatestInformation> </C ompany U pdates>

17.17.6 Currencies
This section contains information about the various currencies that may be applicable to a specific company. This includes the following: FinancialStatements: Currency of the most current financial statements. Estimates: The currency of the estimates for this company. PrimaryIssuePrice: The pricing currency for the primary issue for the company. XML Sample - Currencies Element
<C urrencies> <C urrency Ty pe="F inancialS tatements">U S D</C urrency > <C urrency Ty pe="E stimates">U S D</C urrency > <C urrency Ty pe="P rimary IssueP rice">U S D</C urrency > </C urrencies>

17.17.7 Industry Classification

This section contains information about the companys primary industry classifications. While Thomson Reuters Fundamentals tags each company by up to 10 NAICS and 10 SIC codes, GetFundamentalsReferenceInfo only contains the primary classification for each industry classification system (taxonomy). XML Sample - Industry Classification Element
<Industry C lassification> <Taxonomy Ty pe="RBS S 2004"> <Detail O rder="1" C ode="57211" Description="IT S erv ices &amp; C onsulting"></Detail> </Taxonomy > <Taxonomy Ty pe="N A IC S 1997"> <Detail O rder="1" C ode="541611" Description="A dministrativ e M anagement and G eneral M anagement C onsulting S erv ices"></ Detail> </Taxonomy > <Taxonomy Ty pe="S IC 1987"> <Detail O rder="1" C ode="8742" Description="M anagement C onsulting S erv ices"></Detail> </Taxonomy > <Taxonomy Ty pe="M G S E C TO R"> <Detail O rder="1" C ode="09" Description="S erv ices" M nemonic="S E RV IC "></Detail> </Taxonomy > <Taxonomy Ty pe="M G IN DU S TRY"> <Detail O rder="1" C ode="0909" Description="Business S erv ices" M nemonic="S V S BU S "></Detail> </Taxonomy > </Industry C lassification>

Element Type Order

Description Indicates type of classification. In this case the order will always be 1 indicating primary classification.

324

TRKD API Developer's Guide

Code Description Mnemonic

Unique industry code. Name of the industry. A mnemonic for the code.

17.17.8 Issue Information

This section provides Issue level information for the company's issues. While a company may have multiple issues (e.g. multiple classes of common, preferred) outstanding, one of these is considered to be the 'Primary' Issue. Various factors are taken into account in deciding what the primary issue is. These include whether or not the issue trades, the number of shares outstanding, float, trading volumes, voting power etc. In general, the primary issue is the company's Common issue that is most actively traded and that has the largest float. The information in this section allows user to cross-reference the issues with some commonly used identifiers, and also get other basic information on the issue. Thomson Reuters tracks information on both common and preferred equity types, as well as on multiple classes of each type. Each of these issues is assigned an Order number, with the primary issue receiving an Order of 1. The Order assigned to a specific issue may change over time. Thomson Reuters also assigns an IssueID for each of an Issuers issues. These IssueID's do not change over time, and can be used to uniquely identify an issue in combination with the Report Number (RepNo). Note: The financial statement information is not issue specific, but is published at the company level. XML Sample - Issue Information Element
<IssueInformation> <Issue ID="1" Ty pe="C " O rder="1"> <IssueXrefs> ... </IssueXrefs> <IssueS tatus> ... </IssueS tatus> <IssueS pecifics> ... </IssueS pecifics> </Issue> <Issue ID="2" Ty pe="P " O rder="1"> ... </Issue> </IssueInformation>

ID: Unique, non-changing ID. Type: Common (C) or Preferred (P). Order: Order of the issue. Order = 1 denotes primary issue.

17.17.9 Issue Xref

This section contains issue level reference information including company name, and external identifiers. Current identifiers at the issue level are: Issue Name Ticker RIC Pricing RIC Since an issue may have multiple RIC's (RIC's are per listing, and not per issue), the RIC in GetFundamentalsReferenceInfo_1 Response is the 'primary RIC'.

Fundamentals

325

The Pricing RIC is a market-level code structured as a number of elements. Most ordinary equities have a three- or fourcharacter code used to create the RIC and are followed by a delimiter and source code. Lower case characters are sometimes used to denote A/B Class Shares or Preference Shares. The Delisted RIC Syntax consists of a ^ after the original RIC followed by a month and year could that signifies when the RIC was actually de-listed. Examples include TRIN.O, MLTX^C03. XML Sample - IssueXref Element
<IssueXrefs> <IssueXref Ty pe="N ame">C ommon S tock</IssueXref> <IssueXref Ty pe="Ticker">IBM </IssueXref> <IssueXref Ty pe="RIC ">IBM </IssueXref> <IssueXref Ty pe="Display RIC ">IBM .N </IssueXref> </IssueXrefs>

17.17.10 Issue Status

This section contains further information about the issue whether the issue is active (still exists, or has been retired etc), whether the issue is public, or if it is expected to IPO. The status types are as follows: ActiveStatus: Whether issue is currently active (1 = active). PublicStatus: Whether issue is public or private (1 = public). ExpectedIPO: Whether the private issue is expected to IPO (1= expected to IPO). XML Sample - IssueStatus Element
<IssueS tatus> <IssueTy pe>C ommon S tock</IssueTy pe> <S tatus Ty pe="A ctiv eS tatus">1</S tatus> <S tatus Ty pe="P ublicS tatus">1</S tatus> <S tatus Ty pe="E xpectedIP O ">0</S tatus> </IssueS tatus>

17.17.11 Issue Specific

This section contains details about where the exchange is listed and the type of listing this is. Some company issues trade on multiple exchanges around the world. These cross exchange listings generally represent the same issue of stock, and therefore the same fundamental information. Thomson Reuters only tracks the listing on the primary exchange in these cases. However, certain cross border listings such as American Depository Receipt's (ADR's) are stored as separate 'issuers' in the Thomson Reuters Fundamental database because regulatory bodies of certain markets require the disclosure of financial statements per local accounting. Each of these 'companies' has its own set of financial statements. In the Thomson Reuters database these companies will appear more than once each 'issuer' with its own RepNo. A full list of companies that appear more than once in the database may be provided on request. Thomson Reuters tracks the following types of listing types: Listing Types Type OSR ADR LDR ROF EDR Description Ordinary Shares. American Depository Receipt. Level I ADR. Rule 144 shares. European Depository Receipt.

326

TRKD API Developer's Guide

CCR GSR

Canadian Cross Listing. Global Share.

If there has been a stock split since the company was first added to the Thomson Reuters database the most recent split date and split factor will be provided. For example, a split factor of 2 indicates that a 2-for-1 stock split has occurred. When the stock split becomes effective, Thomson Reuters uses the split factor to adjust all per share and shares outstanding fields in the fundamental database. As such all data is adjusted to reflect the current share capital structure. If there have been no stock splits since the company was added to the database, the element will not be published. XML Sample - IssueSpecific Element
<IssueS pecifics> <E xchange C ode="N YS E " C ountry ="U S A " Region="N A ">N ew York S tock E xchange</E xchange> <ListingTy pe>O S R</ListingTy pe> <M ostRecentS plit Date="1999-05-27">2.0</M ostRecentS plit> <S plitH istory > <S plit Date="1999-05-27">2.0</S plit> <S plit Date="1997-05-28">2.0</S plit> </S plitH istory > </IssueS pecifics>

Exchange: Contains Exchange Code, three-letter country code and name of the exchange. Listing Type: Contains one of listing type values described above. MostRecentSplit: Contains the split factor and a date of the most recent split.

17.18 Getting a List of Industries, Sectors, and Indexes (Aggregates)

To request ratios for specific industries, sectors, or indexes (aggregates) you must first retrieve the Thomson Reuters code for the aggregate. Use GetFundamentalsReferenceList_1 request to generate a list of aggregates and their associated codes. For information about requesting the ratios for the aggregate, see section Get Industry Aggregate. Note: The data in this list rarely changes. Thomson Reuters recommends only requesting the aggregate list once a day and caching the data. XML Sample Request - Getting a List of Aggregates
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/26/F undamentals_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentals_1/ G etF undamentalsReferenceLists_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etF undamentalsReferenceLists_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentals_1" C ategory ="A ggregate" /> </Body > </E nv elope>

The response returns the following when querying for Aggregates: XML Sample Response - Getting a List of Aggregates
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentals_1/ G etF undamentalsReferenceLists_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1"

Fundamentals

327

xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-14T12:56:25.3036846Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etF undamentalsReferenceLists_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentals_1"> <F undamentalLookU p xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/LookU p_1"> <A ggregates> <A ggregate RepoNo ="A 5BF 7" C ategor y ="M G S ector" A ggC ode ="01" A ggM nem ="BA S IC M " A ggN ame="Basic M aterials" P ar entIC C ode =""></A ggregate> <A ggregate RepoN o="A 5BF 8" C ategory ="M G Industry " A ggC ode="0103" A ggM nem="C H M M F G " A ggN ame="C hemical M anufacturing" P arentIC C ode="01"></A ggregate> ... <A ggregate RepoN o="A 6A 48" C ategory ="Index" A ggC ode="S P 500" A ggM nem="" A ggN ame="S &amp;P 500" P arentIC C ode=""></A ggregate> <A ggregate RepoN o="A 5C 6B" C ategory ="Index" A ggC ode="S P 600" A ggM nem="" A ggN ame="S &amp;P 600" P arentIC C ode=""></A ggregate> </A ggregates> </F undamentalLookU p> </G etF undamentalsReferenceLists_Response_1> </Body > </E nv elope>

Attribut Description e AggCode Thomson Reuters code for the industry, sector or index. AggMne Mnemonic code for the industry, sector or index. m Categor Aggregate type. "MGSector" = Sector, "MGIndustry" = Industry, "Index" = Index. y ParentIC Indicates the parent sector code for an industry. Code RepoNo Thomson Reuters repo (report) number for the industry, sector, or index.

17.18.1 Get Fundamentals Reference Lists (GetFundamentalsReferenceLists_1)

In addition to retrieving a list of Aggregates showed in the previous example GetFundamentalsReferenceLists_1 request method can be used to retrieve other reference lists by setting the value of the Category attribute to one of the following: Fundamental Reference Category List Name Accounting Standards Aggregates Auditors Auditors Opinions Balance Sheet Types Cash Flow Methods COA Types Colleges Co-Statuses Countries Currencies Date Units Degrees Category Value AccountingStandards Aggregate Auditor AuditorsOpinions BalanceSheetTypes CashFlowMethods COATypes Colleges CoStatuses Countries Currencies DateUnits Degrees

328

TRKD API Developer's Guide

Exchanges Financial Statements Issue Types Issuer Types Line Items Report Units Titles Topic Type Taxonomy Update Types

Exchanges FinancialStatements IssueTypes IssuerTypes LineItems ReportUnits Titles TopicType TaxonomyCodes UpdateTypes

XML Sample Request - Getting Fundamentals Reference List

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/26/F undamentals_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentals_1/ G etF undamentalsReferenceLists_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etF undamentalsReferenceLists_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentals_1" C ategor y="C ashFlowM ethods" /> </Body > </E nv elope>

The response returns the following when querying for CashFlowMethods: XML Sample Response - Getting Fundamentals Reference List
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentals_1/ G etF undamentalsReferenceLists_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-14T12:56:25.3036846Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etF undamentalsReferenceLists_Response_1 xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3. org/2001/XM LS chema" xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentals_1"> < FundamentalLookUp xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/LookU p_1"> <C ashF low M ethods> <C ashF low M ethod C ode="DIR">Direct</C ashF low M ethod> <C ashF low M ethod C ode="IN D">Indirect</C ashF low M ethod> </C ashF low M ethods> </F undamentalLookU p> </G etF undamentalsReferenceLists_Response_1> </Body > </E nv elope>

Response Format - the FundumnetalLookUp element will contain the sub-element requested for in the Category attribute that will in turn contain a node for each reference value. In the example above since the list for CashFlowMethods was requested the FundumentalLookUp element has a sub element called CashFlowMethods (plural), which is made up of CashFlowMethod (singular) nodes. If the request was for Currencies, the fundumentLookUp element would have contained Currencies sub-element with Currency nodes.

Fundamentals

329

17.19 Industry Classification Schema (ICS)

This chapter provides details and examples on taxonomies and their hierarchy as well as descriptive information for each industry code.

17.19.1 Overview
Companies in the Thomson Reuters Fundamental database (approx 39,000 companies as of May 2005) are all tagged with a number of industry classification tags. Each company is tagged with a Thomson Reuters Business Sector Schema (RBSS) code, up to ten North American Industry Classification System (NAICS) codes and up to ten Standard Industry Classification (SIC) codes. The ICS requests allow users to view the hierarchy for each of these three taxonomies, descriptive information for each industry code and the list of companies that have been assigned to each of these codes.

17.19.1.1 Reuters Business Sector Schema (RBSS)

The Thomson Reuters Business Sector Schema (RBSS) is a four-tier industry classification system introduced by Reuters in 2004. This replaces the two-tier classification system (MGIndustry) used previously by Thomson Reuters Fundamentals, (previously Multex Fundamentals). RBSS has xx sectors at the top level and 108 industries at the bottom level.

17.19.1.2 Standard Industry Classification (SIC)

Standard Industry Classification (SIC) codes were the primary classification system used by the US government until its replacement by the NAICS. The Bureau has revised the classification system a number of times, with the final revision in 1987. Thomson Reuters Fundamentals tagging is based on SIC 1987 definitions. While these codes were superseded by NAICS codes (see below) in 1997, the codes continue to have wide following, and therefore are maintained by Thomson Reuters.

17.19.1.3 North American Industry Classification System (NAICS)

The North American Industry Classification System (NAICS) codes were introduced by the US Census Bureau to replace SIC codes. There have also been revisions of NAICS codes; Thomson Reuters Fundamentals currently uses the definitions published in 1997.

17.19.1.4 Industry Tagging

As described above, each company in the database is tagged with one RBSS code, and up to ten SIC and NAICS codes. In addition, if companies self-report SIC and/or NAICS codes, these are also provided - a special flag is used to indicate company reported codes. Most US companies will list one SIC or NAICS code. Industry tagging is based on Thomson Reuters- understanding of the company's main line of business, as described by the company in its financials reports, including management discussion and analysis, business segment reporting etc. Industry tagging is reviewed at least once a year, with more frequent reviews if company announces a substantial change in its business lines due to expansion, contraction, M&A activity etc.

17.19.2 ICS Requests

There are two requests that can be used to retrieve ICS information: FindIndustryClassificationSchema_1 request - retrieves information about an industry and all its 'children' industries. GetIndustryClassificationSchemaFullHierarchy_1 request - retrieves full hierarchy for a Taxonomy type specified in the request.

17.19.2.1 Find Industry Classification Schema (FindIndustryClassificationSchema_1)

This request allows a user to pass a taxonomy type and a sector/industry code, and see information about that industry and all its 'children' industries. For all industries returned, an industry code and title, and optional descriptions, are provided. A further option allows the user to ask to see Report Numbers (unique company identifiers) for all companies that belong to

330

TRKD API Developer's Guide

these industries. The request has the following attributes: FindIndustryClassificationSchema_1 Request Attributes Attribute Name TaxonomyCode IndustryCode WantToSeeCom panies WantToSeeDesc riptions LanguageCode Requi Description red x x Code for Taxonomy of interest. Code for industry within the specified Taxonomy. Default value is 'false'. Default value is 'false'. Default values is 'en-US'.

The attribute <TaxonomyCode> can take one of the following values: Taxonomy Codes Code RBSS2004 NAICS1997 SIC1987 Description Thomson Reuters Business Sector Schema, a 4-tier schema introduced by Reuters in 2004. See section Reuters Business Sector Schema (RBSS) for more detail. NAICS codes introduced in 1997. See section North American Industry Classification System (NAICS) for more detail. 1987 SIC codes, replaced by NAICS codes in 1997. See section Standard Industry Classification (SIC) for more detail.

XML Sample Request - Searching for Industry Classification Schema

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/26/F undamentals_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentals_1/ F indIndustry C lassificationS chema_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <F indIndustry C lassificationS chema_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentals_1" Taxonomy C ode="RBS S 2004" Industry C ode="50" WantToS eeC ompanies="true" WantToS eeDescriptions="true" LanguageC ode="en-U S " /> </Body > </E nv elope>

The response to the FindICSRequest method contains two parts: Parent and Children. Parent element is displayed if the requested industry has any parents - i.e. it is NOT displayed for requests for the highest level Economic Sector codes. The Parent element contains the attributes Code, Mnemonic, Title and Description. Children container element contains within it the hierarchy of industry codes that belong to the requested industry code. Each 'Child' element within the Children container element contains four attributes similar to the 'Parent' element described above. XML Sample Response - Searching for Industry Classification Schema
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader>

Fundamentals

331

<a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentals_1/ F indIndustry C lassificationS chema_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-14T12:56:25.3036846Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <F indIndustry C lassificationS chema_Response_1 xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3. org/2001/XM LS chema" xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentals_1"> <Industry C ode="50" M nemonic="E N E R" Title="E nergy " Description="The E nergy economic sector consists of companies engaged in the exploration, extraction and refining of coal, oil and natural gas." xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/ Industry C lassification_1"> <C hildren> <C hild C ode ="501" M nemonic="E N E R" T itle ="E nergy " Descr iption="The E nergy business sector consists of companies engaged in the exploration, extraction and refining of coal, oil and natural gas."> <C hildren> <C hild C ode="5011" M nemonic="C O A L" Title="C oal" Description="The C oal industry group consists of companies engaged in the mining and beneficiating of coal and prov iding support serv ice for coal."> <C hildren> <C hild C ode="50111" M nemonic="50111" Title="C oal" Description="The coal industry consists of companies engaged in the exploration, mining, beneficiating, crushing, screening, w ashing and sizing of coal and other alternativ e energy resources. The industry also includes companies engaged in testing, tunneling, blasting, training, and other contract based coal related serv ices. The coal industry excludes: (coal tar for pav ing, classified in C onstruction M aterials), (coal breakers, cutters, and pulv erizers manufacturing, classified in C onstruction A gricultural M achinery ), (coke coal, classified in S teel), (coal tar resin and distillation, classified in C hemicals - C ommodity .)"> <C hildren /> <C ompanies> <C ompany RepoN o="0066A " /> ... <C ompany RepoN o="B3C 3A " /> </C ompanies> ... </Industry > </F indIndustry C lassificationS chema_Response_1> </Body > </E nv elope>

Attribute Code Mnemonic Title Companies

Description Unique code (per taxonomy) for the industry code. A mnemonic for the code; values available only for RBSS codes. A descriptive title. Container element, contains list of Report Numbers (RepoNos), of constituent companies, for the lowest tier of the hierarchy.

Description Optional description of this industry, available for RBSS Taxonomy only.

17.19.2.2 Get Industry Classification Schema Full Hierarchy (GetIndustryClassificationSchemaFullHierarchy_1)

This request allows the user to pass a taxonomy type and see the full hierarchy for that taxonomy. It also allows the user to see textual descriptions for the various industry types returned. The request for this method has the following attributes: GetIndustryClassificationSchemaFullHierarchy_1 Request Attributes Attribute Require Description Name d TaxonomyC x Code for Taxonomy of interest. See table Taxonomy Codes in section Find Industry Classification ode Schema for more details. WantToSeeD x Default value is 'false'. escriptions LanguageCo Default values is 'en-US'. de

332

TRKD API Developer's Guide

XML Sample Request - Getting Industry Classification Schema Full Hierarchy

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/26/F undamentals_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentals_1/ G etIndustry C lassificationS chemaF ullH ierarchy _1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etIndustry C lassificationS chemaF ullH ierarchy _Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/ F undamentals_1" Taxonomy C ode="RBS S 2004" WantToS eeDescriptions="true" LanguageC ode="en-U S " /> </Body > </E nv elope>

The response to the GetFullICSHierarchy method produces the full hierarchy for the requested taxonomy. For example, for the RBSS2004 taxonomy, it will provide all Economic Sectors, all Business Sectors, all Industry Groups and all Industries. For each type, a code and a title, and optionally a description is provided. A list of companies cannot be requested through this method, even though there will be empty elements in the response to denote placeholders for constituent companies. The response will begin with the 'Industry' element to denote the highest level of the hierarchy, the Economic Sector. Within this element, the Code, Mnemonic, Title and Description are attributes. These are identical to the list of attributes described below for the 'Child' element. Each Industry then will have multiple 'Children' sub-elements, which contain the hierarchy of Business Sectors, Industry Groups and Industries that belong to the Economic Sector. Each Child Element has a structure parallel to the Industry Element structure, with the Code, Mnemonic, Title and Description elements. Each Child element may also have a 'Children' sub-element to denote the hierarchy of industries that belong to the Child. XML Sample Response - Getting Industry Classification Schema Full Hierarchy
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentals_1/ F indIndustry C lassificationS chema_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-14T12:56:25.3036846Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etIndustry C lassificationS chemaF ullH ierarchy _Response_1 xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns: xsd="http://w w w .w 3.org/2001/XM LS chema" xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentals_1"> <Industry C ode ="50" M nemonic="E N E R" T itle ="E nergy " Descr iption="The E nergy economic sector consists of companies engaged in the exploration, extraction and refining of coal, oil and natural gas." xmlns="http://w w w .reuters.com/ns/2009/01/26/ w ebserv ices/rkd/Industry C lassification_1"> <C hildren> <C hild C ode="501" M nemonic="E N E R" Title="E nergy " Description="The E nergy business sector consists of companies engaged in the exploration, extraction and refining of coal, oil and natural gas."> <C hildren> <C hild C ode="5011" M nemonic="C O A L" Title="C oal" Description="The C oal industry group consists of companies engaged in the mining and beneficiating of coal and prov iding support serv ice for coal."> <C hildren> <C hild C ode="50111" M nemonic="50111" Title="C oal" Description="The coal industry consists of companies engaged in the exploration, mining, beneficiating, crushing, screening, w ashing and sizing of coal and other alternativ e energy resources. The industry also includes companies engaged in testing, tunneling, blasting, training, and other contract based coal related serv ices. The coal industry excludes: (coal tar for pav ing, classified in C onstruction M aterials), (coal breakers, cutters, and pulv erizers manufacturing, classified in C onstruction A gricultural M achinery ), (coke coal, classified in S teel), (coal tar resin and distillation, classified in C hemicals - C ommodity .)"> <C hildren />

Fundamentals

333

<C ompanies /> </C hild> </C hildren> <C ompanies /> </C hild> ... </C hildren> <C ompanies /> </Industry > </G etIndustry C lassificationS chemaF ullH ierarchy _Response_1> </Body > </E nv elope>

Attribute Code Mnemonic Title Companies

Description Unique code (per taxonomy) for the industry code. A mnemonic for the code; values available only for RBSS codes. A descriptive title. Container element, contains list of Report Numbers (RepoNos), of constituent companies, for the lowest tier of the hierarchy.

Description Optional description of this industry, available for RBSS Taxonomy only.

17.20 Fundamental Reports

Thomson Reuters Fundamental Reports have been created to meet the demands of users who primarily intend to display or print information about publicly traded companies. The reports contain general information such as business descriptions and officer names, historical financial statements, estimated financials variables and a number of frequently used ratios. Currently the following reports are available: Get Snapshot Reports (GetSnapshotReports_1) retrieves a company description, address, contact details, officer names and a limited number of financial ratios and estimates. Get Financial Statements Reports (GetFinancialStatementsReports_1) contains six years of financials and five quarters (or interims) of financials. Financials include I/S, B/S and C/F. Get Ratios Reports (GetRatiosReports_1) contains a larger (compared to Snapshot report) number of financial ratios and estimate figures. The reports contain information on all active companies available on the Thomson Reuters financial database. As of January 2004, there were over 26,000 active companies including US and non-US, in the Thomson Reuters financial database. No reports are generated for the 7,500+ inactive companies in the database.

17.20.1 Get Ratios Reports (GetRatiosReports_1)

The Ratio Reports contain three sets of information: Ratios: ~40 commonly used ratios based on pricing data and historical financials. Forecasted data: 10 frequently used forecasted metrics, including consensus recommendation, target price, projected sales, eps, etc. Estimates trend: Trend in analyst recommendation for the company over the past three months. The following tables list detailed information provided by each of the three sections: 1. Ratios Category Pricing: Ratio Current price 52 wk hi/lo Pricing date Volume (avg last ten days) Market cap EPS excluding extraordinary items EPS Normalized

Per Share Data:

334

TRKD API Developer's Guide

Valuation:

Financial Strength:

BV per share Tangible BV per share Cash per share Cash flow per share Indicated Annual Dividend (currently US) P/E excluding extraordinary items P/E Normalized P/Sales P/Tangible book P/Cash FlowI Current ratio Quick ratio LT debt/equity Total debt/equity Payout ratio

2. Forecasted Data Category Income Statement Ratio Revenue EBITDA Earnings before taxes Net Income Normalized earnings before taxes Normalized Net Income Gross margin Net Profit margin Operating margin Pretax margin ROA ROE ROI (qoprioryearq, yoy, 5 yr compound) Sales EPS Dividend growth

Margins

Mgmt effectiveness Growth (US only)

3. Estimates Trend

Recommendation analysis (35 items - 1-6+mean x 5 periods) Target Price Proj. LT Growth Rate P/E Price/Sales Sales/Share EPS surprise (actual, estimate, surprise, %) Sales (mean/median, high, low, # est) EPS (mean/median, high, low, # est) Profit (mean/median, high, low, # est) DPS (mean/median, high, low, # est)

North America

Non-North America

curr yr curr yr curr yr prev yr/qrt curr yr/qrt curr yr/qtr n/a n/a

curr yr curr yr curr yr prev yr curr yr curr yr curr yr curr yr

Fundamentals

335

Note: Not all items are available for all companies. The following request retrieves Ratios Reports for IBM. XML Sample Request - Getting Ratios Reports
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/26/F undamentals_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentals_1/ G etRatiosReports_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etRatiosReports_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentals_1" company Id=" IBM " company IdTy pe="Ticker" /> </Body > </E nv elope>

XML Sample Response - Getting Ratios Reports

<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentals_1/G etRatiosReports_1_Reply </ a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-14T12:56:25.3036846Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etRatiosReports_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentals_1"> <F undamentalReports xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentalReportsP art_1"> <ReportRatios M ajor="1" M inor="0" Rev ision="2" xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/ F undamentalReports_1"> < C oIDs xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ompany C ontentC ommon_1"> <C oID Ty pe="RepN o">4741N </C oID> <C oID Ty pe="C ompany N ame">International Business M achines C orp.</C oID> <C oID Ty pe="IRS N o">130871985</C oID> <C oID Ty pe="C IKN o">0000051143</C oID> </C oIDs> < Issues xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ompany C ontentC ommon_1"> <Issue ID="1" Ty pe="C " Desc="C ommon S tock" O rder="1"> <IssueID Ty pe="N ame">C ommon S tock</IssueID> <IssueID Ty pe="Ticker">IBM </IssueID> <IssueID Ty pe="RIC ">IBM </IssueID> <IssueID Ty pe="Display RIC ">IBM .N </IssueID> <E xchange C ode="N YS E " C ountry ="U S A ">N ew York S tock E xchange</E xchange> <M ostRecentS plit Date="1999-05-27">2.0</M ostRecentS plit> </Issue> <Issue ID="2" Ty pe="P " Desc="P referred S tock" O rder="1"> <IssueID Ty pe="N ame">P referred S tock- 7.5% </IssueID> <E xchange C ode="N YS E " C ountry ="U S A ">N ew York S tock E xchange</E xchange> </Issue> </Issues> < C oGener alInfo xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ompany C ontentC ommon_1"> <C oS tatus C ode="1">A ctiv e</C oS tatus> <C oTy pe C ode="E Q U ">E quity Issue</C oTy pe> <LastM odified>2008-01-24</LastM odified> <LatestA v ailableA nnual>2007-12-31</LatestA v ailableA nnual> <LatestA v ailableInterim>2007-12-31</LatestA v ailableInterim> <E mploy ees LastU pdated="2006-12-31">355766</E mploy ees> <S haresO ut Date="2007-09-30" TotalF loat="1364200000.0">1377955258.0</S haresO ut> <ReportingC urrency C ode="U S D">U .S . Dollars</ReportingC urrency >

336

TRKD API Developer's Guide

<M ostRecentE xchange Date="2008-01-22">1.0</M ostRecentE xchange> </C oG eneralInfo> <Ratios P riceC urrency ="U S D" ReportingC urrency ="U S D" E xchangeRate="1.00000" LatestA v ailableDate="2007-12-31"> <G roup ID="P rice and V olume"> <Ratio F ieldN ame="N P RIC E " Ty pe="N ">104.52000</Ratio> ... <Ratio F ieldN ame="M KTC A P " Ty pe="N ">144023.90000</Ratio> </G roup> ... <G roup ID="G row th"> ... </G roup> </Ratios> <For ecastData C onsensusTy pe="M ean" C urF iscalYear="2008" C urF iscalYearE ndM onth="12" C urInterimE ndC alYear="2008" C urInterimE ndM onth="3" E arningsBasis="P RX"> <Ratio F ieldN ame="P rojS ales" Ty pe="N "> <V alue P eriodTy pe="C U RR">104486.50250</V alue> </Ratio> ... <Ratio F ieldN ame="P rojDP S N umO fE st" Ty pe="N "> <V alue P eriodTy pe="C U RR">4</V alue> </Ratio> </F orecastData> <C onsRecommendationT r end> <S TO pinion> <O pinion C ode="1" Desc="BU Y"> <V alue P eriodTy pe="C U RR">6</V alue> ... <V alue P eriodTy pe="3M A ">0</V alue> </O pinion> </S TO pinion> <M eanRating> <V alue P eriodTy pe="C U RR">2.0556</V alue> ... <V alue P eriodTy pe="3M A ">1.9524</V alue> </M eanRating> <N oO fA naly sts> <V alue P eriodTy pe="C U RR">18</V alue> ... <V alue P eriodTy pe="3M A ">21</V alue> </N oO fA naly sts> </C onsRecommendationTrend> </ReportRatios> </F undamentalReports> </G etRatiosReports_Response_1> </Body > </E nv elope>

Attribute CoIDs

Description These identifiers are issued at a company level therefore there is only one of each for every company. The required attribute 'RepoNo' is the permanent identifier for a company in the Thomson Reuters database. Issues This information allows user to cross-reference the issues with some commonly used identifiers, and also get other basic information on the issue. CoGeneralInfo This section provides general information pertaining to the primary issue and the most recent set of financials. Historical This section provides the pre-calculated ratios and values. Both issue level and company level ratios are Ratios provided. A total of up to 390 ratios may be available per company. Ratios - Ratios is the container element for all ratios. It also includes information about currency types and the exchange rate between Reporting and Pricing Currency. The exchange rate is the direct rate for the Pricing Currency, i.e. Reporting Currency / Pricing Currency. Finally, it also has a date field to indicate the twelve month ending date. For US companies this date is the ending date of the most recent quarter; for non-US companies it is the ending date for the most recent annual. Groups - The ratios in this file have been grouped for organizational purposes. Each group has a distinct name. Ratio - Each ratio has two attributes as the types and field names. Types indicate if the ratio includes numeric "N" or a date "D" type data. Field Names are abbreviations for ratios and should be used in mapping with ratio descriptions. Forecast Data This section provides information on the latest Consensus Estimates and calculated Ratio's, including

Fundamentals

337

Revenues, EPS, P/E, Target Price and Long Term Growth Rate. All values within this section will be in Major Currency. ConsRecomm This section provides the trend of changes to broker recommendations over the previous three months. endationTren These recommendations are based on the Thomson Reuters Estimates Standardised Recommendation d scale where Thomson Reuters will assign from one to five rating to each broker recommendation. Thomson Reuters will capture the substance of the recommendation rather than its ascribed name. We work with our contributors to ensure that we map our numerical rating to their preferred value. As such some brokerspecific "Buy" recommendations may map to a value of 1, whereas others may map to a value of 2. Note: The value '-99999.99000' means N/A (not available).

17.20.2 Get Financial Statements Reports (GetFinancialStatementsReports_1)

Financial Statements are provided for the six most recent annual statements and five most recent quarterly statement. The following table shows the information included in the report: Category Issue Information Company General Information Statement Information Financial Statements Description Issue Type, Order and ID Global Listings Stock Splits Company Status Company Type Fiscal Period Information Balance Sheet Display Code Cash Flow Method Financial statements notes Financial Statement Map (COA) Fiscal Period Period Length and Period Type Update types Statement Date Auditor Name and Opinion Source Date LineItem

Note: Not all items are available for all companies. The information retrieved presents all annual periods followed by all interim periods, both in reverse chronological order. Within each fiscal period (e.g. the 2000 annual period or the Q3 2002 interim period) statements are presented in the order: Income Statement, Balance Sheet, Statement of Cash Flows. The following example shows how to retrieve Financial Statements Report for Microsoft. XML Sample Request - Getting Financial Statements Reports
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/26/F undamentals_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentals_1/ G etF inancialS tatementsReports_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etRatiosReports_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentals_1" company Id=" M SFT .O " company IdTy pe=" RIC " /> </Body > </E nv elope>

338

TRKD API Developer's Guide

XML Sample Response - Getting Financial Statements Reports

<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentals_1/ G eF inancialS tatementsReports_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-14T12:56:25.3036846Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etF inancialS tatementsReports_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentals_1"> <F undamentalReports xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentalReportsP art_1"> <ReportF inancialS tatements M ajor="1" M inor="0" Rev ision="1" xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/ F undamentalReports_1"> <C oIDs xmlns="http://www.r euter s.com/ns/2 0 0 6 /0 5 /0 1 /webser vices/r kd/C ompanyC ontentC ommon_1 "> <C oID Ty pe="RepN o">57840</C oID> <C oID Ty pe="C ompany N ame">M icrosoft C orporation</C oID> <C oID Ty pe="IRS N o">911144442</C oID> <C oID Ty pe="C IKN o">0000789019</C oID> </C oIDs> <Issues xmlns="http://www.r euter s.com/ns/2 0 0 6 /0 5 /0 1 /webser vices/r kd/C ompanyC ontentC ommon_1 "> <Issue ID="1" Ty pe="C " Desc="C ommon S tock" O rder="1"> <IssueID Ty pe="N ame">C ommon S tock</IssueID> <IssueID Ty pe="Ticker">M S F T</IssueID> <IssueID Ty pe="RIC ">M S F T.O </IssueID> <IssueID Ty pe="Display RIC ">M S F T.O Q </IssueID> <E xchange C ode="N A S D " C ountry ="U S A ">N A S DA Q </E xchange> <M ostRecentS plit Date="2003-02-18">2.0</M ostRecentS plit> </Issue> </Issues> <C oGener alInfo xmlns="http://www.r euter s.com/ns/2 0 0 6 /0 5 /0 1 /webser vices/r kd/ C ompanyC ontentC ommon_1 "> <C oS tatus C ode="1">A ctiv e</C oS tatus> <C oTy pe C ode="E Q U ">E quity Issue</C oTy pe> <LastM odified>2008-01-24</LastM odified> <LatestA v ailableA nnual>2007-06-30</LatestA v ailableA nnual> <LatestA v ailableInterim>2007-12-31</LatestA v ailableInterim> <ReportingC urrency C ode="U S D ">U .S . Dollars</ReportingC urrency > <M ostRecentE xchange Date="2008-01-22">1.0</M ostRecentE xchange> </C oG eneralInfo> <Notes> <C F A A v ailability C ode="true" /> <IA v ailability C ode="true" /> <IS IA v ailability C ode="true" /> <BS IA v ailability C ode="true" /> <C F IA v ailability C ode="true" /> </N otes> <FinancialStatements> <C O A M ap> <mapItem coaItem="S RE V " statementTy pe="IN C " lineID="100" precision="1">Rev enue</mapItem> <mapItem coaItem="S O RE " statementTy pe="IN C " lineID="300" precision="1">O ther Rev enue, Total</mapItem> ... </mapItem> <mapItem coaItem="S C IP " statementTy pe="C A S " lineID="1040" precision="1">C ash Interest P aid</mapItem> <mapItem coaItem="S C TP " statementTy pe="C A S " lineID="1050" precision="1">C ash Taxes P aid</mapItem> </C O A M ap> <A nnualP eriods> <F iscalP eriod Ty pe="A nnual" E ndDate="2007-06-30" F iscalYear="2007"> <S tatement Ty pe="IN C "> <F P H eader> <P eriodLength>12</P eriodLength> <periodTy pe C ode="M ">M onths</periodTy pe> <U pdateTy pe C ode="U P D ">U pdated N ormal</U pdateTy pe> <S tatementDate>2007-06-30</S tatementDate><A uditorN ame C ode="DT">Deloitte & Touche, LLP (Deloitte H askins & S ells)</A uditorN ame> <A uditorO pinion C ode="U N Q ">U nqualified</A uditorO pinion> <S ource Date="2007-08-03">10-K</S ource> </F P H eader> <lineItem coaC ode="S RE V ">51122.000000</lineItem> ... <lineItem coaC ode="DDP S 1">0.400000</lineItem>

Fundamentals

339

<lineItem coaC ode="V DE S ">1.458890</lineItem> </S tatement> ... </F iscalP eriod> <F iscalP eriod Ty pe="Interim " E ndDate="2006-12-31" F iscalYear="2007" F iscalP eriodN umber="2"> <S tatement Ty pe="IN C "> ... </S tatement> </F iscalP eriod> </InterimP eriods> </F inancialS tatements> </ReportF inancialS tatements> </F undamentalReports> </G etF inancialS tatementsReports_Response_1> </Body > </E nv elope>

Attribute CoIDs

Description These identifiers are issued at a company level therefore there is only one of each for every company. The required attribute 'RepoNo' is the permanent identifier for a company in the Thomson Reuters database. This information allows user to cross-reference the issues with some commonly used identifiers, and also get other basic information on the issue. This section provides general information pertaining to the primary issue and the most recent set of financials. This segment gives the user an indication of what financial statements are available for each company. At least one Annual Income Statement and Annual Balance Sheet will always be provided for every company in the Thomson Reuters Standardized Financials product (Income statement will be available for every fiscal period - annual or interim, and at least one annual balance sheet will be available for every company). The Annual Cash flow and Interim Financials (I/S, B/S, C/F) are not always available. Therefore we indicate which of these four reports are available for each company. If the report is available the associated code will be '1'. If the report is not available the associated code will be '0'. There is a generic code for all the interim statements, if the associated code is '1', at least one of the interim reports will be available, if the associated code is '0', none of the interim reports are available and their associated codes will also be zero. The following is an example of associated codes and their availability: CFAAvailability Code="1" - Annual Cash flow available; Iavailablity Code="0"- Interims not available; ISIAvailablity Code="0" - Interim Income Statement not available; BSIAvailablity Code="0" - Interim Balance Sheet not available; CFIAvailablity Code="0" - Interim Cash Flow not available. This section is split into two main parts: Financial Statement Map - with the purpose of laying out the order in which financial values will appear for each period. This map gives the line item COA code, description, LineID, the aggregation and precision levels, and the display type. Financial Statement - This section provides financial statements for the company. Up to 6 annual statements and five interim statements are provided. Each Fiscal Period contains the following information: Fiscal Period Period Length and Period Type Update types Statement Date Auditor Name and Opinion Source Date LineItem

Issues CoGeneralInfo Notes

Financial Statements

Note: The value '-99999.99000' means N/A (not available).

17.20.3 Get Snapshot Reports (GetSnapshotReports_1)

Snapshot Reports contain three sets of information: Business Intelligence:

340

TRKD API Developer's Guide

Short business description; Financial summary; Address/Phone number; Web links; Industry/Sector information; Officer names/ages/titles; Ratios 20+ commonly used ratios based on pricing data and historical financials. They can be grouped by the following categories: Pricing: Current price; 52 week hi/lo; Pricing date; Volume (avg last ten days); Size: Market cap; Revenues; EBITDA; Net income; No. of employees; Enterprise value; Per Share Data: EPS; Rev per share; BV per share; Cash per share; Cashflow per share; Dividends per share; Ratios: Gross margin; ROE; Price/Sales; P/E; P/Book; Forecasted Data 8 frequently used forecasted matrix: Consensus recommendation; Target price; LT growth rate; Projected P/E (North America/Non-North American - current year); Sales (North America - current year, quarter; Non-North American - current year); EPS (North America - current year, quarter; Non-North American - current year); Profit (North America - n/a; Non-North American - current year); DPS (North America - n/a; Non-North American - current year). Note: Not all items are available for all companies. The request below retrieves Snap Shot reports for IBM. XML Sample Request - Getting Snapshot Reports
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/26/F undamentals_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentals_1/ G etS napshotReports_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etS napshotReports_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentals_1" company Id=" IBM "

Fundamentals

341

company IdTy pe=" T icker " /> </Body > </E nv elope>

XML Sample Response - Getting Snapshot Reports

<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentals_1/ G eS napshotReports_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-14T12:56:25.3036846Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etS napshotReports_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentals_1"> <F undamentalReports xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/F undamentalReportsP art_1"> <ReportS napshot M ajor="1" M inor="0" Rev ision="1" xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/ F undamentalReports_1"> <C oIDs xmlns="http://www.r euter s.com/ns/2 0 0 6 /0 5 /0 1 /webser vices/r kd/C ompanyC ontentC ommon_1 "> <C oID Ty pe="RepN o">4741N </C oID> <C oID Ty pe="C ompany N ame">International Business M achines C orp.</C oID> <C oID Ty pe="IRS N o">130871985</C oID> <C oID Ty pe="C IKN o">0000051143</C oID> </C oIDs> <Issues xmlns="http://www.r euter s.com/ns/2 0 0 6 /0 5 /0 1 /webser vices/r kd/C ompanyC ontentC ommon_1 "> <Issue ID="1" Ty pe="C " Desc="C ommon S tock" O rder="1"> <IssueID Ty pe="N ame">C ommon S tock</IssueID> <IssueID Ty pe="Ticker">IBM </IssueID> <IssueID Ty pe="RIC ">IBM </IssueID> <IssueID Ty pe="Display RIC ">IBM .N </IssueID> <E xchange C ode="N YS E " C ountry ="U S A ">N ew York S tock E xchange</E xchange> <M ostRecentS plit Date="1999-05-27">2.0</M ostRecentS plit> </Issue> <Issue ID="2" Ty pe="P " Desc="P referred S tock" O rder="1"> <IssueID Ty pe="N ame">P referred S tock- 7.5% </IssueID> <E xchange C ode="N YS E " C ountry ="U S A ">N ew York S tock E xchange</E xchange> </Issue> </Issues> <C oGener alInfo xmlns="http://www.r euter s.com/ns/2 0 0 6 /0 5 /0 1 /webser vices/r kd/ C ompanyC ontentC ommon_1 "> <C oS tatus C ode="1">A ctiv e</C oS tatus> <C oTy pe C ode="E Q U ">E quity Issue</C oTy pe> <LastM odified>2007-09-10</LastM odified> <LatestA v ailableA nnual>2006-12-31</LatestA v ailableA nnual> <LatestA v ailableInterim>2007-06-30</LatestA v ailableInterim> <E mploy ees LastU pdated="2006-12-31">355766</E mploy ees> <S haresO ut Date="2007-06-30" TotalF loat="1352500000.0">1360406581.0</S haresO ut> <C ommonS hareholders Date="2006-12-31">609928</C ommonS hareholders> <ReportingC urrency C ode="U S D">U .S . Dollars</ReportingC urrency > <M ostRecentE xchange Date="2007-09-10">1.0</M ostRecentE xchange> </C oG eneralInfo> <T extInfo> <Text Ty pe="Business S ummary " lastM odified="2007-09-05T00:09:26">International Business M achines C orporation (IBM ) is an information technology company . IBM also prov ides business, technology and consulting serv ices. The C ompany 's major operations comprise a G lobal S erv ices segment, a S y stems and Technology G roup, a S oftw are segment and a G lobal F inancing segment. IBM 's business comprises three principal business segments: S y stems and F inancing, S oftw are and S erv ices. The majority of the C ompany 's enterprise business, w hich excludes the C ompany 's original equipment manufacturer technology business, occurs in industries that are grouped into six sectors: financial serv ices, public, industrial, distribution, communications, and small and medium business. In July 2007, IBM acquired Watchfire C orporation, a priv ately held security and compliance testing softw are company based in Waltham, M assachusetts. In A ugust 2007, IBM acquired WebDialogs, Inc. In S eptember 2007, IBM completed the acquisition of DataM irror C orporation.</Text> ... </TextInfo> <contactInfo lastUpdated="2 0 0 7 -0 9 -1 0 T 1 6 :0 9 :4 2 "> <streetA ddress line="1">O ne N ew O rchard Road</streetA ddress> <streetA ddress line="2" /> <streetA ddress line="3" /> <city >A rmonk</city > <state-region>N Y</state-region>

342

TRKD API Developer's Guide

<postalC ode>10504</postalC ode> <country code="U S A ">U nited S tates</country > <contactN ame>John Bukov insky </contactN ame> <contactTitle>Inv estor Relations</contactTitle> <phone> ... </phone> </contactInfo> <webLinks lastUpdated="2 0 0 7 -0 6 -2 8 T 1 4 :2 7 :2 0 "> <w ebS ite mainC ategory ="H ome P age">http://w w w .ibm.com/</w ebS ite> .... <w ebS ite mainC ategory ="E mploy ment O pportunities">http://w w w -03.ibm.com/employ ment/</w ebS ite> <eM ail mainC ategory ="" /> </w ebLinks> <peerInfo lastU pdated="2007-09-10T16:09:42"> <Industr yInfo> <Industry ty pe="M G IN DU S TRY" order="1" reported="0" code="0909" mnem="S V S BU S ">Business S erv ices</ Industry > <Industry ty pe="M G S E C TO R" order="1" reported="0" code="09" mnem="S E RV IC ">S erv ices</Industry > ... <Industry ty pe="S IC " order="10" reported="0" code="3577" mnem="">C omputer P eriph'L E quipment, N ec</Industry > </Industry Info> <Indexconstituet>S &P 500</Indexconstituet> <Indexconstituet>Dow Industry </Indexconstituet> </peerInfo> <officer s> <officer rank="1" since="1997"> ... </officer> ... <officer rank="10" since="2000"> ... </officer> </officers> <Ratios P r iceC ur r ency="USD" Repor tingC ur r ency="USD" ExchangeRate="1 .0 0 0 0 0 " LatestA vailableDate="2 0 0 7 -0 6 -3 0 "> <G roup ID="P rice and V olume"> <Ratio F ieldN ame="N P RIC E " Ty pe="N ">115.80000</Ratio> <Ratio F ieldN ame="N H IG " Ty pe="N ">118.89000</Ratio> <Ratio F ieldN ame="N LO W" Ty pe="N ">81.01000</Ratio> <Ratio F ieldN ame="P DA TE " Ty pe="D">2007-09-10T00:00:00</Ratio> <Ratio F ieldN ame="V O L10DA V G " Ty pe="N ">6.76582</Ratio> <Ratio F ieldN ame="M KTC A P " Ty pe="N ">157535.10000</Ratio> </G roup> <G roup ID="Income S tatement"> ... </G roup> <G roup ID="P er share data"> ... </G roup> <G roup ID="O ther Ratios"> ... </G roup> </Ratios> <For ecastData C onsensusT ype="M ean" C ur FiscalY ear ="2 0 0 7 " C ur FiscalY ear EndM onth="1 2 " C ur Inter imEndC alY ear ="2 0 0 7 " C ur Inter imEndM onth="9 " Ear ningsBasis="P RX"> <Ratio F ieldN ame="C onsRecom" Ty pe="N "> <V alue P eriodTy pe="C U RR">2.1364</V alue> </Ratio> <Ratio F ieldN ame="TargetP rice" Ty pe="N "> <V alue P eriodTy pe="C U RR">122.29410</V alue> </Ratio> ... <Ratio F ieldN ame="P rojDP S " Ty pe="N "> <V alue P eriodTy pe="C U RR">1.24880</V alue> </Ratio> </F orecastData> </ReportS napshot> </F undamentalReports> </G etS napshotReports_Response_1> </Body > </E nv elope>

Attribute

Description

Fundamentals

343

CoIDs

These identifiers are issued at a company level therefore there is only one of each for every company. The required attribute 'RepoNo' is the permanent identifier for a company in the Thomson Reuters database. Issues This information allows user to cross-reference the issues with some commonly used identifiers, and also get other basic information on the issue. CoGeneralInfo This section provides general information pertaining to the primary issue and the most recent set of financials. TextInfo This segment provides various descriptive information sets on the company, including the following: Business Summary - Short business description, limited to 1,000 characters; Financial Summary - Summary of most recently reported results. contactInfo This section provides contact information for the company, including an address, a contact person with title, and phone/fax number(s). webLinks This section lists various commonly used web page addresses for the company, include home page, 'news releases' page, 'profile' page, the investor relations page etc. This section also contains a contact email address. IndustryInfo This section provides information on company executives, including name, age, title(s) and source document where officer information was collected from. Codes are used to represent officer titles and source document types. officers This section provides information on company executives, including name, age, title(s) and source document where officer information was collected from. Codes are used to represent officer titles and source document types. Ratios This section provides the pre-calculated ratios and values. Both issue level and company level ratios are provided. A total of up to 390 ratios may be available per company. ForecastData This section provides information on the latest Consensus Estimates, including Revenues, EPS, P/E, Target Price and Long Term Growth Rate. All values within this section will be in Major Currency. Note: The value '-99999.99000' means N/A (not available).

344

TRKD API Developer's Guide

chapter 18

Lipper Asset Views

The Lipper Asset Views web service provides methods that allow the client to view a wide range of Lipper fundamental data for an asset. The following methods are available through Lipper Asset Views service: Get Asset Holdings (GetAssetHoldings_1) - returns the assets holdings information. Get Asset Overview (GetAssetOverview_1) - returns a detailed overview for the specified asset. Get Asset Quantitative Analysis (GetAssetQuantitativeAnalysis_1) - returns the asset's quantitative analysis.

18.1

Authentication/Authorization, Service Endpoint, and Required Headers

Authorization All requests to the Lipper Asset Views service require an authorization token. For details, see section Understanding Authentication Tokens. Authentication The Lipper Asset Views service uses Reuters impersonation tokens for each effective user. In this case, Thomson Reuters must create each user before your application authenticates them. Unmanaged effective users are not supported in the Lipper Asset Views service. For additional information on creating a Service Token, see section Creating a Token. Service Endpoint Lipper Asset Views Endpoint
http://api.rkd.reuters.com/api/2010/03/17/LipperA ssetV iew s_1.sv c

Required Header Required HTTP Headers

P O S T /api/2010/03/17/LipperA ssetV iew s_1.sv c H TTP /1.1 C ontent-Ty pe: application/soap+xml H ost: api.rkd.reuters.com C ontent-Length: [length]

18.2

WSDL
WSDL:
http://api.rkd.reuters.com/schemas/w sdl/LipperA ssetV iew s_1_H ttpA ndRKDToken.w sdl

18.3

Get Asset Holdings (GetAssetHoldings_1)

You can use the GetAssetHoldings_1 method to retrieve Lipper allocation, portfolio, and fund characteristic data for the specified asset(s). The example below gets asset holdings details for the asset with '40000700' LipperID:

Lipper Asset Views

345

XML Sample Request - Getting Asset Holdings

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2010/03/17/LipperA ssetV iew s_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2010/03/17/w ebserv ices/rkd/LipperA ssetV iew s_1/ G etA ssetH oldings_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etA ssetH oldings_Request_1 xmlns="http://w w w .reuters.com/ns/2010/03/17/w ebserv ices/rkd/LipperA ssetV iew s_1"> <lipperID> 4 0 0 0 0 7 0 0 </lipperID> <language> LanguageNeutr al </language> <currency C ode> None </currency C ode> </G etA ssetH oldings_Request_1> </Body > </E nv elope>

Paramete Description r lipperID A unique eight- or nine-digit number that identifies an asset. currencyCo The display currency for the returned data. For full listing of available currency codes, see section Currency de Code Enumeration in the Lipper Data Enumerations chapter. language The display language for the returned data.

Note: Lipper automatically defaults to American English if the requested data is unavailable in the language specified in the language option. The response returns the analysis details for the specified asset ('40000700'): XML Sample Response - Getting Asset Holdings
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2010/03/17/w ebserv ices/rkd/LipperA ssetV iew s_1/ G etA ssetH oldings_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etA ssetH oldings_Response_1 xmlns="http://w w w .reuters.com/ns/2010/03/17/w ebserv ices/rkd/LipperA ssetV iew s_1"> <A ssetH oldingsResult> <TotalN etA sset> <LipperId>40000700</LipperId> <TotalN etA ssetList> <TotalN etA ssetItem> <DataDate>2010-12-31</DataDate> <C urrency C ode>N one</C urrency C ode> <TotalN etA ssets xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <TotalN etA ssetsInM illions xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> </TotalN etA ssetItem> ... </TotalN etA ssetList> </TotalN etA sset> <A llocationS chemes> <A llocationS chemeTy pe> <LipperId>40000700</LipperId> <A llocationS chemeId>Top10H oldings</A llocationS chemeId> <A llocationS chemeC ode>H O LD</A llocationS chemeC ode> <A llocationS chemeN ame>H LDG Top H oldings</A llocationS chemeN ame>

346

TRKD API Developer's Guide

<Language>E nglish</Language> <A llocationsO rganization>By DateBy Item</A llocationsO rganization> <A llocationsBy DateBy Item> <A llocationsBy Date> <Date>2010-09-30T00:00:00</Date> <A llocationItems> <A llocationV alueBy Item> <A llocationItem> <Id>-1</Id> <N ame>U S TRE A S U RY 4.000% 15-F E B-2015</N ame> <Language>E nglish</Language> <A llocationS chemeId>Top10H oldings</A llocationS chemeId> <Lev el>1</Lev el> </A llocationItem> <C hangeF romP rev ious xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <V alue>0.8</V alue> </A llocationV alueBy Item> ... </A llocationItems> </A llocationsBy Date> </A llocationsBy DateBy Item> </A llocationS chemeTy pe> ... </A llocationS chemes> </A ssetH oldingsResult> </G etA ssetH oldings_Response_1> </Body > </E nv elope>

Element LipperId TotalNetAssetList

AllocationSchemes

AllocationItem

Description A unique eight- or nine-digit number that identifies an asset. A list of Total Net Asset Items that contains the asset's TNA values. Can have the following values: DataDate - the date for which the TNA value is valid. CurrencyCode - the currency code that represents the currency for the TNA value. TotalNetAssets - the TNA value for the stated data date. TotalNetAssetsInMillions - the TNA value in millions for the stated data date. The allocation schemes. Can have the following values: AllocationSchemeId - the allocation scheme ID. AllocationSchemeCode - the alphabetic allocation scheme code. AllocationSchemeName - the allocation scheme name (e.g., asset's allocation). Language - the Language ID that represents the data language for the allocation information. AllocationsOrganization - the scheme structure. AllocationsByDateByItem - the asset's list of allocations. Represents an asset's list of allocation values in date order. Can have the following values: Id - A unique integer that identifies the item. Name - The name of the item. Language - The language of the item. AllocationSchemeId - the allocation scheme ID. Level - the allocation level. The level is 1 for all allocations except for ICB allocations, which are either level 1, 2, or 3. ChangeFromPrevious - the change from previous. Value - the value.

18.4

Get Asset Overview (GetAssetOverview_1)

You can use the GetAssetOverview_1 method to retrieve a wide range of data such as allocation, portfolio, fund characteristic data, etc for the specified asset(s). The example below gets asset overview information for the asset with '40000700' LipperID: XML Sample Request - Getting Asset Overview
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2010/03/17/LipperA ssetV iew s_1.sv c</To>

Lipper Asset Views

347

<M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2010/03/17/w ebserv ices/rkd/LipperA ssetV iew s_1/ G etA ssetO v erv iew _1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etA ssetO v erv iew _Request_1 xmlns="http://w w w .reuters.com/ns/2010/03/17/w ebserv ices/rkd/LipperA ssetV iew s_1"> <lipperID> 4 0 0 0 0 7 0 0 </lipperID> <language> English</language> <currency C ode> USD</currency C ode> <lipperLeaderS coreU niv erse> A RG </lipperLeaderS coreU niv erse> </G etA ssetO v erv iew _Request_1> </Body > </E nv elope>

Parameter lipperID language currencyCode

Description A unique eight- or nine-digit number that identifies an asset. The display language for the returned data. The display currency for the returned data. For full listing of available currency codes, see section Currency Code Enumeration in the Lipper Data Enumerations chapter.

lipperLeaderScoreU The lipper leader universe. Please see section Universe Enumeration in the Lipper Data Enumerations niverse chapter. Note: Lipper automatically defaults to American English if the requested data is unavailable in the language specified in the language option. The response returns the asset overview results for the specified asset ('40000700'): XML Sample Response - Getting Asset Overview
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2010/03/17/w ebserv ices/rkd/LipperA ssetV iew s_1/ G etA ssetH oldings_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etA ssetO v erv iew _Response_1 xmlns="http://w w w .reuters.com/ns/2010/03/17/w ebserv ices/rkd/LipperA ssetV iew s_1"> <A ssetO v erv iew Result> <F undTy pe>Bond</F undTy pe> <LaunchDate>1974-05-28</LaunchDate> <Q ualifiedH istory Date xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"></Q ualifiedH istory Date> <G eographicalF ocus>U nited S tates of A merica</G eographicalF ocus> <Domicile>U S A </Domicile> <A ssetC urrency >U S D</A ssetC urrency > <P rev iousA ssetC urrency xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"></P rev iousA ssetC urrency > <E xDiv idendDate>2008-12-24</E xDiv idendDate> <Div idendsP erYear>0</Div idendsP erYear> <O bjectiv eText>The F und seeks to maximize current income and preserv e capital by inv esting primarily in bonds rated A and abov e.</ O bjectiv eText> <IncomeDistribution>P aid</IncomeDistribution> <Div idendP ay ment>0.0675</Div idendP ay ment> <TN A >25627300000</TN A > <TN A Date>2010-12-31</TN A Date> <TN A C urrency >U S D</TN A C urrency > <P rice> <DataDate>2011-01-13</DataDate> <C urrency C ode>U S D</C urrency C ode> <N av >12.21</N av > <N av E stimated>false</N av E stimated> <O ffer xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"></O ffer>

348

TRKD API Developer's Guide

<O fferE stimated xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"></O fferE stimated> <Bid xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"></Bid> <BidE stimated xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"></BidE stimated> <M id xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"></M id> <M idE stimated xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"></M idE stimated> </P rice> <S upportC ompanies> <F undS upportC ompany Ty pe> <LipperId>40000700</LipperId> <C ompany Role>C ustodian</C ompany Role> <C ompany Ty pe> <Language>E nglish</Language> <C ompany Id>857810</C ompany Id> <C ompany F ullN ame>JP M organ C hase Bank N A </C ompany F ullN ame> <LipperId>0</LipperId> <C ompany C ode>E KRH </C ompany C ode> <C ompany S hortN ame>JP M organ C hase Bank N A </C ompany S hortN ame> <BusinessN ame>F inance</BusinessN ame> <C ontactInformation> <A ddressLine1>Tw o C hase M anhattan P laza</A ddressLine1> <A ddressLine3>N Y</A ddressLine3> <C ity >N ew York</C ity > <P ostcode>10081</P ostcode> <Telephone>212-552-2222</Telephone> </C ontactInformation> </C ompany Ty pe> </F undS upportC ompany Ty pe> ... </S upportC ompanies> <Benchmarks> <BenchmarkTy pe> <LipperId>40000700</LipperId> <BenchmarkList> <BenchmarkItem> <Language>E nglish</Language> <BenchmarkId>11025566</BenchmarkId> <BenchmarkN ame>Barclay s C apital U .S . A ggregate Bond TR</BenchmarkN ame> <BenchmarkC ategory >A ssetM anager</BenchmarkC ategory > <S hortBenchmarkN ame>Barclay s C apital U .S . A ggregate Bond TR</S hortBenchmarkN ame> </BenchmarkItem> ... </BenchmarkList> </BenchmarkTy pe> </Benchmarks> <M inimumInv estments> <M inimumInv estmentTy pe> <LipperId>40000700</LipperId> <Language>LanguageN eutral</Language> <S tartDate>1800-01-01</S tartDate> <E ndDate>4000-01-01</E ndDate> <C urrency C ode>U S D</C urrency C ode> <N ame>P aid</N ame> <M inimumInv estmentTy peId xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"></ M inimumInv estmentTy peId> <M inimumInv estmentInitial>250</M inimumInv estmentInitial> <M inimumInv estmentRegular>50</M inimumInv estmentRegular> <M inimumInv estmentIRRegular xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"></ M inimumInv estmentIRRegular> <M inimumInv estmentInitialS hare xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"></ M inimumInv estmentInitialS hare> </M inimumInv estmentTy pe> </M inimumInv estments> <C harges> <C hargesTy pe> <LipperId>40000700</LipperId> <N ame>A merican F unds Bond F und of A merica;A </N ame> <C hargesList> <C hargesItem> <DataDate>2000-03-15</DataDate> <C hargeId>777</C hargeId> <C hargeN ame>Initial</C hargeN ame> <M inimum xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"></M inimum> <M aximum xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"></M aximum> <A ctual>2.5</A ctual> </C hargesItem> ... </C hargesList>

Lipper Asset Views

349

</C hargesTy pe> </C harges> <LipperLeaderS cores></LipperLeaderS cores> <F lags> <F lagTy pe> <LipperId>40000700</LipperId> <Language>E nglish</Language> <F lagList> <F lagItem> <F lagId>27301</F lagId> <F lagN ame>Reinv ests on x-date</F lagN ame> <F lagC ode>Y</F lagC ode> <F lagV alue>Yes</F lagV alue> </F lagItem> ... </F lagList> </F lagTy pe> </F lags> <C rossReferences> <C rossReferenceTy pe> <LipperId>40000700</LipperId> <C rossReferenceList> <C rossReferenceItemV alue> <Language>E nglish</Language> <XrefId>26</XrefId> <ReferenceC ode>RIC </ReferenceC ode> <C odeS hortN ame>RIC </C odeS hortN ame> <C odeF ullN ame>RIC </C odeF ullN ame> <XrefV alue>A BN DX.O </XrefV alue> </C rossReferenceItemV alue> ... </C rossReferenceList> </C rossReferenceTy pe> </C rossReferences> <C lassifications> <C lassS chemeTy pe> <C lassS chemeId>2506</C lassS chemeId> <C lassS chemeC ode>A </C lassS chemeC ode> <C lassS chemeN ame>U S M utual F und O bjectiv e</C lassS chemeN ame> <Language>E nglish</Language> <C lassList> <C lassTy pe> <C lassId>2507</C lassId> <C lassN ame>C orp Debt A Rated</C lassN ame> <Language>E nglish</Language> </C lassTy pe> </C lassList> <LipperId>40000700</LipperId> </C lassS chemeTy pe> ... </C lassifications> </A ssetO v erv iew Result> </G etA ssetO v erv iew _Response_1> </Body > </E nv elope>

Element FundType LaunchDate QualifiedHistoryDate

Description The type of the fund. The fund's launch date. The qualified history date, which is the date at which the fund had a fundamental change in objective or strategy that makes performance data prior to this date irrelevant to the fund's current peer group. GeographicalFocus The fund's geographical focus. Domicile The asset's domicile. AssetCurrency The asset's currency. PreviousAssetCurre The asset's previous currency. ncy ExDividendDate The ex dividend date. DividendsPerYear The dividends per year. ObjectiveText The objective text, which is based up on information supplied in the fund's prospectus.

350

TRKD API Developer's Guide

IncomeDistribution DividendPayment TNA TNADate TNACurrency Price

The income distribution. The dividend payment. The fund's total net assets (TNA). The TNA date. The currency of the TNA value. The price value. Can have the following sub-values: DataDate - the date for which the price is valid. CurrencyCode - the currency for the price data. Nav - the net asset value price, which is the dollar value of a single mutual fund share, based on the value of the underlying assets of the fund minus its liablities, divided by the number of outstanding shares. NavEstimated - a flag that indicates if a calculated net asset value price was not supplied by the data provider so that an estimated value was used instead. Offer - the launch offer, which is the first pricing of the fund after the subscription period is over plus the fund's initial sales charge. OfferEstimated - a flag that indicates if a calculated offer value was not supplied by the data provider so that an estimated value was used instead. Bid - the bid price, which is the net asset value minus redemption charges. BidEstimated - a flag that indicates if a calculated bid value was not supplied by the data provider so that an estimated value was used instead. Mid - the fund's first mid pricing after the subscription period is over (i.e., the mid-point between the bid and the offer). MidEstimated - a flag that indicates if a calculated mid value was not supplied by the data provider so that an estimated value was used instead. FundSupportCompa Represents an asset's general company details. Can have the following values: nyType LipperId - the Lipper ID is an eight- or nine-digit number that represents an asset. CompanyRole - the company role. CompanyType - the asset's general company details. Language - language ID. CompanyId - the company's numeric ID. CompanyFullName - the company's full name. CompanyCode - the company's alphabetic code. CompanyShortName - the company's short name. BusinessName - the company's business name. ContactInformation - the company's contact information. BenchmarkItem Represents a single benchmark for an asset. Can have the following sub-values: BenchmarkId - the benchmark ID. BenchmarkName - the benchmark name. BenchmarkCategory - the benchmark category. ShortBenchmarkName - the short benchmark name. MinimumInvestment Represents an asset's minimum investment data, including minimum regular investment, minimum Type irregular investment, minimum investment, and minimum initial share investment. Can have the following sub-values: StartDate - the minimum investment start date. EndDate - the minimum investment end date. CurrencyCode - the currency code of the currency in which the minimum investment data is expressed. Name - the asset name. MinimumInvestmentTypeId - the minimum investment id. MinimumInvestmentInitial - the minimum initial investment amount. MinimumInvestmentRegular - the minimum amount of investment that can be accepted on a regular basis, such as to be part of a regular savings plan. MinimumInvestmentIRRegular - the minimum number of shares or currency amount that investors can subsequently invest in the fund (on an ad hoc basis) after purchasing initial shares. MinimumInvestmentInitialShare - minimum initial share investment. ChargesList The list of all the charges for the asset. Contains the following elements: DataDate - the data date for the charge. ChargeId - the numeric ID of the charge item. ChargeName - the name of the charge. Minimum - the minimum charge for the charge item. Maximum - the maximum charge for the charge item. Actual - the actual charge for the item.

Lipper Asset Views

351

FlagList

The asset's list of flags and values. A flag represents an attribute that Lipper has assigned to the asset. Contains the following elements: FlagId - the numeric flag ID. FlagName - the name of the flag. FlagCode - the alphabetic flag code. FlagValue - the flag value, which is either Yes or No. If the value of this flag is yes, then the fund is listed on an exchange. CrossReferenceList The asset's list of cross-reference codes. Contains the following elements: Language - the display language for the cross-reference information. XrefId - the numeric Cross-reference ID. ReferenceCode - the alphabetic cross-reference code (e.g., the five-character symbol for a NASDAQ cross-reference). CodeShortName - the cross-reference short name (e.g., NASDAQ Ticker). CodeFullName - the full name of the cross-reference. XrefValue - the value for the cross reference code. ClassSchemeId The classification scheme's numeric ID. ClassSchemeCode The classification scheme's numeric code. ClassSchemeName The name of the classification scheme. ClassList The asset's classification list for the classification scheme set in ClassSchemeName. Contains the following elements: ClassId - the classification type's numeric ID. ClassName - the name of the classification type. Language - the display language for classification data.

18.5

Get Asset Quantitative Analysis (GetAssetQuantitativeAnalysis_1)

You can use the GetAssetQuantitativeAnalysis_1 method to retrieve asset's quantitative analysis. The example below gets asset quantitative analysis for the asset with '40000700' LipperID: XML Sample Request - Getting Asset Quantitative Analysis
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2010/03/17/LipperA ssetV iew s_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2010/03/17/w ebserv ices/rkd/LipperA ssetV iew s_1/ G etA ssetQ uantitativ eA naly sis_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etA ssetQ uantitativ eA naly sis_Request_1 xmlns="http://w w w .reuters.com/ns/2010/03/17/w ebserv ices/rkd/LipperA ssetV iew s_1"> <lipperID> 4 0 0 0 0 7 0 0 </lipperID> <language> English</language> <currency C ode> USD</currency C ode> </G etA ssetQ uantitativ eA naly sis_Request_1> </Body > </E nv elope>

Paramete Description r lipperID A unique eight- or nine-digit number that identifies an asset. currencyCo The display currency for the returned data. For full listing of available currency codes, see section Currency de Code Enumeration in the Lipper Data Enumerations chapter. language The display language for the returned data.

Note: Lipper automatically defaults to American English if the requested data is unavailable in the language specified in the

352

TRKD API Developer's Guide

language option. The response returns the analysis details for the specified asset ('40000700'): XML Sample Response - Getting Asset Quantitative Analysis
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2010/03/17/w ebserv ices/rkd/LipperA ssetV iew s_1/ G etA ssetH oldings_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etA ssetQ uantitativ eA naly sis_Response_1 xmlns="http://w w w .reuters.com/ns/2010/03/17/w ebserv ices/rkd/LipperA ssetV iew s_1"> <A ssetQ uantitativ eA naly sisResult> <A ssetN ame>A merican F unds Bond F und of A merica;A </A ssetN ame> <A ssetId>40000700</A ssetId> <A ssetN ameLanguage>E nglish</A ssetN ameLanguage> <C urrency >U S D</C urrency > <TechnicalIndicatorBenchmark> <Language>E nglish</Language> <BenchmarkId>11000490</BenchmarkId> <BenchmarkN ame>BofA M errill Ly nch U .S . C orporate M aster TR</BenchmarkN ame> <BenchmarkC ategory >TechnicalIndicator</BenchmarkC ategory > <S hortBenchmarkN ame>BofA M errill Ly nch U .S . C orporate M aster TR</S hortBenchmarkN ame> </TechnicalIndicatorBenchmark> <RiskF reeIndexBenchmark> <Language>E nglish</Language> <BenchmarkId>11025615</BenchmarkId> <BenchmarkN ame>U S Treasury Bills 3 M onths TR</BenchmarkN ame> <BenchmarkC ategory >RiskF reeIndex</BenchmarkC ategory > <S hortBenchmarkN ame>U S Treasury Bills 3 M onths TR</S hortBenchmarkN ame> </RiskF reeIndexBenchmark> <A ssetM anagerBenchmark> <Language>E nglish</Language> <BenchmarkId>11025566</BenchmarkId> <BenchmarkN ame>Barclay s C apital U .S . A ggregate Bond TR</BenchmarkN ame> <BenchmarkC ategory >A ssetM anager</BenchmarkC ategory > <S hortBenchmarkN ame>Barclay s C apital U .S . A ggregate Bond TR</S hortBenchmarkN ame> </A ssetM anagerBenchmark> <C lassificationBenchmark> <Language>E nglish</Language> <BenchmarkId>19057061</BenchmarkId> <BenchmarkN ame>Lipper G lobal Bond U S D C orporates</BenchmarkN ame> <BenchmarkC ategory >C lassification</BenchmarkC ategory > <S hortBenchmarkN ame>Lipper G lobal Bond U S D C orporates</S hortBenchmarkN ame> </C lassificationBenchmark> <C umulativ eP erformanceC alculations> <P erformanceC alculationTy pe> <LipperId>11000490</LipperId> <P erformanceC alculationList> <P erformanceC alculationItem> <C urrency C ode>U S D</C urrency C ode> <S tatTy peId>26594</S tatTy peId> <E stimate>false</E stimate> <S tartDate>2009-12-31</S tartDate> <E ndDate>2010-12-31</E ndDate> <C alcP eriodN ame>1_y ear</C alcP eriodN ame> <Language>E nglish</Language> <V alue>9.51997</V alue> <C alculationTy pe>O neYearP erformancetoLastM onthE nd</C alculationTy pe> </P erformanceC alculationItem> ... </P erformanceC alculationList> </P erformanceC alculationTy pe> ... </P erformanceC alculationTy pe> </C umulativ eP erformanceC alculations> <C alendarYearC alculations>

Lipper Asset Views

353

<RollingP erformancesA ssetV iew > <LipperId>11000490</LipperId> <C urrency >U S D</C urrency > <RollingP erformances> <RollingP erformanceTy pe> <V alue>4.39076</V alue> <DataDate>2006-12-31</DataDate> </RollingP erformanceTy pe> ... </RollingP erformances> </RollingP erformancesA ssetV iew > ... </RollingP erformancesA ssetV iew > </C alendarYearC alculations> <TechnicalA naly sisC alculations> <P erformanceC alculationTy pe> <LipperId>40000700</LipperId> <P erformanceC alculationList> <P erformanceC alculationItem> <C urrency C ode>U S D</C urrency C ode> <S tatTy peId>26589</S tatTy peId> <E stimate>true</E stimate> <S tartDate>2009-12-31</S tartDate> <E ndDate>2010-12-31</E ndDate> <Language>LanguageN eutral</Language> <V alue>-0.03656</V alue> <C alculationTy pe>A lphafor1YeartoLastM onthE nd</C alculationTy pe> </P erformanceC alculationItem> ... </P erformanceC alculationList> </P erformanceC alculationTy pe> </TechnicalA naly sisC alculations> </A ssetQ uantitativ eA naly sisResult> </G etA ssetQ uantitativ eA naly sis_Response_1> </Body > </E nv elope>

Element AssetQuantitativeA nalysisResult AssetName AssetId AssetNameLanguag e Currency TechnicalIndicatorBe nchmark

Description Shows the results of asset's quantitative analysis. Shows the asset name. Shows the asset id. Shows the asset name language.

Shows the currency ID. Shows the Technical Indicator Benchmark. Can have the following elements: Language - the language for the benchmark information. BenchmarkId - the Benchmark ID. BenchmarkName - the name of the benchmark. BenchmarkCategory - the benchmark category. ShortBenchmarkName - the short benchmark name. RiskFreeIndexBench Shows the Risk Free Index Benchmark. mark AssetManagerBench Shows the Asset Manager Benchmark. mark ClassificationBenchm Shows the Classification Benchmark. ark PerformanceCalculat The asset's performance calculation list. Contains the following elements: ionItem CurrencyCode - the currency code that represents the currency of the performance calculation data. StartTypeId - the stat type id. Estimate - a flag that indicates if the value of this performance calculation is an estimate. StartDate - the start date for the time period used for the performance calculation. EndDate - the end date for the time period used for the performance calculation. CalcPeriodName - the name of the performance calculation. Language - the display language for the performance calculation data. Value - the value of the performance calculation.

354

TRKD API Developer's Guide

CalculationType - the type of the calculation. RollingPerformances Shows rolling performance calculation for the given asset. Contains the following elements: AssetView RollingPerformanceType - rolling performance calculation data point with date and value. Value - The data value for the period. DataDate - the date for which the data is valid.

Lipper Details

355

chapter 19

Lipper Details

The Lipper Details section provides easy access to fund characteristics from Lipper's extensive database of collective investments, allowing clients to quickly find fund details based on hundreds of criteria items and to compare those funds across a wide range of timely characteristics. Methods in this section are grouped under the following categories: 1. Lipper Holdings - GetCollectedAllocations_1 method gets Lipper allocation, portfolio, and fund characteristic data. 2. Lipper Time Series - GetPrice_1 and GetPrices_1 methods are used for retrieving fund prices on a single date or over a rolling period of time. 3. Lipper Calculations - GetBestWorstPerformance_1, GetRollingPerformance_1, GetStoredPerformanceByCalculationsFilter_1, GetStoredPerformanceCalculation_1, GetStoredPerformanceCalculations_1 methods are used for getting stored and dynamic Lipper performance calculation data. 4. Lipper Fundamentals - all other methods are used to retrieve a wide range of basic Lipper fund data.

19.1

Lipper Holdings
The Lipper Holdings section provides access to Lipper allocation, portfolio, and fund characteristic data from Lipper's extensive database.

19.1.1 Authentication/Authorization, Service Endpoint, and Required Headers

Authorization All requests to the Lipper services require an authorization token. For details, see section Understanding Authentication Tokens. Authentication The Lipper services use Reuters impersonation tokens for each effective user. In this case, Thomson Reuters must create each user before your application authenticates them. Unmanaged effective users are not supported in the Lipper services. For additional information on creating a Service Token, see section Creating a Token. Service Endpoint Lipper Holdings Endpoint
http://api.rkd.reuters.com/api/2009/01/01/LipperH oldings_1.sv c

Required Headers Lipper Holdings Required HTTP Headers

P O S T /api/2009/01/01/LipperH oldings_1.sv c H TTP /1.1 C ontent-Ty pe: application/soap+xml H ost: api.rkd.reuters.com C ontent-Length: [length]

19.1.2 WSDL
Lipper Holdings WSDL:
http://api.rkd.reuters.com/schemas/w sdl/LipperH oldings_1_H ttpA ndRKDToken.w sdl

356

TRKD API Developer's Guide

19.1.3 Get Collected Allocations (GetCollectedAllocations_2)

You can use the GetCollectedAllocations_2 method to retrieve collected allocations for the given asset(s) as of the given effective date. The example below retrieves collected allocations in English language for the 'Asset' allocation scheme as of the specified date for the specified assets: XML Sample Request - Getting Collected Allocations
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperH oldings_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperH oldings_1/ G etC ollectedA llocations_2</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etC ollectedA llocations_Request_2 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperH oldings_1"> <lipperIDs> <int>65028707</int> <int>60003333</int> </lipperIDs> <allocation>A sset</allocation> <allocationDate>2008-12-12T09:30:47Z</allocationDate> <language>E nglish</language> </G etC ollectedA llocations_Request_2> </Body > </E nv elope>

Paramete Description r lipperID allocation A unique eight- or nine-digit number that identifies an asset. The allocation scheme. For full listing of allocation schemes see section Allocation Enumeration in the Lipper Data Enumerations chapter.

allocationD The allocation date. ate language The display language for the collected allocations data.

The response returns collected allocations data for the specified assets: XML Sample Response - Getting Collected Allocations
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperH oldings_1/ G etC ollectedA llocations_2_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etC ollectedA llocations_Response_2 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperH oldings_1"> <C ollectedA llocationsResult> <A llocationS chemeTy pe> <LipperId>65028707</LipperId> <A llocationS chemeId>A sset</A llocationS chemeId> <A llocationS chemeC ode>A S S TA LL</A llocationS chemeC ode>

Lipper Details

357

<A llocationS chemeN ame>A sset A llocation</A llocationS chemeN ame> <Language>E nglish</Language> <A llocationsO rganization>By ItemBy Date</A llocationsO rganization> <A llocationsBy ItemBy Date> <A llocationItem> <Id>-1</Id> <N ame>Liquid A ssets</N ame> <Language>E nglish</Language> <A llocationS chemeId>A sset</A llocationS chemeId> <Lev el>1</Lev el> <V aluesBy Date> <A llocationV alueBy Date> <V alue>0.34</V alue> <Date>2007-09-28</Date> <C hangeF romP rev ious xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> </A llocationV alueBy Date> </V aluesBy Date> <P arentA llocationItemID xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> </A llocationItem> <A llocationItem> <Id>-1</Id> <N ame>E tc</N ame> <Language>E nglish</Language> <A llocationS chemeId>A sset</A llocationS chemeId> <Lev el>1</Lev el> <V aluesBy Date> <A llocationV alueBy Date> <V alue>99.66</V alue> <Date>2007-09-28</Date> <C hangeF romP rev ious xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> </A llocationV alueBy Date> </V aluesBy Date> <P arentA llocationItemID xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> </A llocationItem> </A llocationsBy ItemBy Date> </A llocationS chemeTy pe> </C ollectedA llocationsResult> </G etC ollectedA llocations_Response_2> </Body > </E nv elope>

Element LipperId AllocationSchemeId AllocationSchemeC ode AllocationSchemeN ame Language AllocationsOrganiz ation AllocationsByItemB yDate

Description The asset identifier of a particular collective investment within Lipper. The allocation scheme ID. The alphabetic allocation scheme code. The name of the allocation name. The display language for the collected allocations data. The organization of collected allocations.

The asset's list of allocation values. Contains the following elements: Id - a unique integer that identifies the item. Name - the name of the item. Language - the display language for the item. AllocationSchemeId - the allocation scheme ID. Level - the allocation level. The level is 1 for all allocations except for ICB allocations, which are either level 1, 2, or 3. ValuesByDate - the asset's list of allocation values. Contains the following elements: Value - the allocation value. Date - the date for which the allocation data is valid. ChangeFromPrevious - the change in value from the previous data date. ParentAllocationIte The parent allocation item ID. mID

358

TRKD API Developer's Guide

19.2

Lipper Time Series

The Lipper Time Series section provides easy access to fund prices on a single date or over a rolling period of time from Lipper's extensive database.

19.2.1 Authentication/Authorization, Service Endpoint, and Required Headers

Authorization All requests to the Lipper services require an authorization token. For details, see section Understanding Authentication Tokens. Authentication The Lipper services use Reuters impersonation tokens for each effective user. In this case, Thomson Reuters must create each user before your application authenticates them. Unmanaged effective users are not supported in the Lipper services. For additional information on creating a Service Token, see section Creating a Token. Service Endpoint Lipper Time Series Endpoint
http://api.rkd.reuters.com/api/2009/01/01/LipperTimeS eries_1.sv c

Required Headers Lipper Time Series Required HTTP Headers

P O S T /api/2009/01/01/LipperTimeS eries_1.sv c H TTP /1.1 C ontent-Ty pe: application/soap+xml H ost: api.rkd.reuters.com C ontent-Length: [length]

19.2.2 WSDL
Lipper Time Series WSDL:
http://api.rkd.reuters.com/schemas/w sdl/LipperTimeS eries_1_H ttpA ndRKDToken.w sdl

19.2.3 Get Price (GetPrice_1)

You can use the GetPrice_1 method to retrieve the listed price for the given asset(s) on a given date. This method is used to return the price for a single date for one or more funds. To get prices for a rolling period that contains multiple data points, use the GetPrices_1 method. The example below gets price expressed in US dollars for the asset with '60003333' LipperID without including estimated prices: XML Sample Request - Getting Price
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperTimeS eries_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperTimeS eries_1/ G etP rice_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etP rice_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperTimeS eries_1"> <lipperIDs>

Lipper Details

359

<int>60003333</int> </lipperIDs> <dataDate>2008-01-23</dataDate> <currency C ode>U S D</currency C ode> <allow E stimates>false</allow E stimates> </G etP rice_Request_1> </Body > </E nv elope>

Paramete Description r lipperID dataDate A unique eight- or nine-digit number that identifies an asset. The date for which the price will be returned.

currencyCo The currency for the returned price. For full listing of available currency codes, see section Currency Code de Enumeration in the Lipper Data Enumerations chapter. allowEstima A flag that indicates if estimated prices are allowed in the result set. tes The response returns the prices as of the dataDate for the specified assets: XML Sample Response - Getting Price
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperTimeS eries_1/G etP rice_1_Reply </a: A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etP rice_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperTimeS eries_1"> <P riceResult> <P riceTy pe> <LipperId>60003333</LipperId> <S tartDate>2008-01-23</S tartDate> <E ndDate>2008-01-23</E ndDate> <P riceList> <P riceItem> <DataDate>2008-01-23</DataDate> <C urrency C ode>U S D</C urrency C ode> <N av >16.4775561</N av > <N av E stimated>false</N av E stimated> <O ffer xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <O fferE stimated xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <Bid xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <BidE stimated xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <M id xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <M idE stimated xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> </P riceItem> </P riceList> </P riceTy pe> </P riceResult> </G etP rice_Response_1> </Body > </E nv elope>

Elemen t LipperId StartDat e EndDate

Description The asset's Lipper ID. The start date for the price data. The end date for the price data.

360

TRKD API Developer's Guide

PriceList The price list. Contains the following elements: DataDate - the date for which the price is valid. CurrencyCode - the currency for the price data. Nav - the net asset value price, which is the dollar value of a single mutual fund share, based on the value of the underlying assets of the fund minus its liabilities, divided by the number of outstanding shares. NavEstimated - a flag that indicates if a calculated net asset value price was not supplied by the data provider so that an estimated value was used instead. Offer - the offer price, which is the net asset value plus initial sales charges. OfferEstimated - a flag that indicates if a calculated offer value was not supplied by the data provider so that an estimated value was used instead. Bid - the bid price, which is the net asset value minus redemption charges. BidEstimated - a flag that indicates if a calculated bid value was not supplied by the data provider so that an estimated value was used instead. Mid - the mid price of the fund after the subscription period is over. This is the mid point between the bid and the offer. MidEstimated - a flag that indicates if a calculated mid value was not supplied by the data provider so that an estimated value was used instead.

19.2.4 Get Prices (GetPrices_1)

You can use the GetPrices_1 method to retrieve listed prices for the given asset(s) for a rolling period. This method is used to get data for a rolling period with a start date and end date. To get a price for a single date, use the GetPrice_1 method. The example below gets price expressed in US dollars for the asset with '11006603' LipperID including estimated prices: XML Sample Request - Getting Prices
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperTimeS eries_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperTimeS eries_1/ G etP rices_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etP rices_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperTimeS eries_1"> <lipperIDs> <int>11006603</int> </lipperIDs> <startDate>2007-01-27</startDate> <endDate>2009-03-27</endDate> <currency C ode>U S D</currency C ode> <alignment>M onthE nd</alignment> <allow E stimates>true</allow E stimates> </G etP rices_Request_1> </Body > </E nv elope>

Paramete r lipperID startDate endDate currencyCo de alignment

Description A unique eight- or nine-digit number that identifies an asset. The start date for the rolling period. The end date for the rolling period. The currency for the returned prices. For full listing of available currency codes, see section Currency Code Enumeration in the Lipper Data Enumerations chapter. The alignment of the data in the result set. Can have the following values: YearEnd - will include a datapoint for every year end in a given time period.

Lipper Details

361

Month End - will include a datapoint for every month end in a given time period. WeekEnd - will include a datapoint for every week end in a given time period. Day - will include a datapoint for every business day in a given time period. Default - is MonthEnd. allowEstima A flag that indicates if estimated prices are allowed in the result set. tes The response returns the prices for the specified assets for the specified time period: XML Sample Response - Getting Prices
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperTimeS eries_1/G etP rices_1_Reply </a: A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etP rices_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperTimeS eries_1"> <P ricesResult> <P riceTy pe> <LipperId>11006603</LipperId> <S tartDate>2007-01-27</S tartDate> <E ndDate>2009-03-27</E ndDate> <P riceList> <P riceItem> <DataDate>2008-12-31</DataDate> <C urrency C ode>U S D</C urrency C ode> <N av xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <N av E stimated xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <O ffer xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <O fferE stimated xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <Bid xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <BidE stimated xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <M id>27889.0282176</M id> <M idE stimated>true</M idE stimated> </P riceItem> <P riceItem> <DataDate>2008-10-31</DataDate> <C urrency C ode>U S D</C urrency C ode> <N av xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <N av E stimated xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <O ffer xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <O fferE stimated xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <Bid xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <BidE stimated xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <M id>27927.544212</M id> <M idE stimated>false</M idE stimated> </P riceItem> ... <P riceItem> <DataDate>2007-01-31</DataDate> <C urrency C ode>U S D</C urrency C ode> <N av xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <N av E stimated xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <O ffer xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <O fferE stimated xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <Bid xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <BidE stimated xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <M id>54769.7762276</M id> <M idE stimated>false</M idE stimated> </P riceItem> </P riceList> </P riceTy pe> </P ricesResult> </G etP rices_Response_1> </Body > </E nv elope>

362

TRKD API Developer's Guide

Elemen t LipperId StartDat e EndDate PriceList

Description The asset's Lipper ID. The start date for the price data. The end date for the price data. The price list. Contains the following elements: DataDate - the date for which the price is valid. CurrencyCode - the currency for the price data. Nav - the net asset value price, which is the dollar value of a single mutual fund share, based on the value of the underlying assets of the fund minus its liabilities, divided by the number of outstanding shares. NavEstimated - a flag that indicates if a calculated net asset value price was not supplied by the data provider so that an estimated value was used instead. Offer - the offer price, which is the net asset value plus initial sales charges. OfferEstimated - a flag that indicates if a calculated offer value was not supplied by the data provider so that an estimated value was used instead. Bid - the bid price, which is the net asset value minus redemption charges. BidEstimated - a flag that indicates if a calculated bid value was not supplied by the data provider so that an estimated value was used instead. Mid - the mid price of the fund after the subscription period is over. This is the mid point between the bid and the offer. MidEstimated - a flag that indicates if a calculated mid value was not supplied by the data provider so that an estimated value was used instead.

19.3

Lipper Calculations
The Lipper Calculations section provides easy access to stored and dynamic Lipper performance calculation data from Lipper's extensive database.

19.3.1 Authentication/Authorization, Service Endpoint, and Required Headers

Authorization All requests to the Lipper services require an authorization token. For details, see section Understanding Authentication Tokens. Authentication The Lipper services use Reuters impersonation tokens for each effective user. In this case, Thomson Reuters must create each user before your application authenticates them. Unmanaged effective users are not supported in the Lipper services. For additional information on creating a Service Token, see section Creating a Token. Service Endpoint Lipper Calculations Endpoint
http://api.rkd.reuters.com/api/2009/01/01/LipperC alculations_1.sv c

Required Headers Lipper Calculations Required HTTP Headers

P O S T /api/2009/01/01/LipperC alculations_1.sv c H TTP /1.1 C ontent-Ty pe: application/soap+xml H ost: api.rkd.reuters.com C ontent-Length: [length]

19.3.2 WSDL
Lipper Calculations WSDL:
http://api.rkd.reuters.com/schemas/w sdl/LipperC alculations_1_H ttpA ndRKDToken.w sdl

Lipper Details

363

19.3.3 Get Best Worst Performance (GetBestWorstPerformance_1)

You can use the GetBestWorstPerformance_1 method to retrieve the best and worst performance (date and price) within the last three years for the given asset(s). The example below gets best and worst performance expressed in Euro for the assets with '19048139', '11020455' and '11006603' LipperIDs: XML Sample Request - Getting Best Worst Performance
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperC alculations_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperC alculations_1/ G etBestWorstP erformance_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etBestWorstP erformance_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperC alculations_1"> <lipperIDs> <int>19048139</int> <int>11020455</int> <int>11006603</int> </lipperIDs> <currency C ode>E U R</currency C ode> </G etBestWorstP erformance_Request_1> </Body > </E nv elope>

Paramet Description er lipperID A unique eight- or nine-digit number that identifies an asset. currencyC The currency for the returned data. For full listing of available currency codes, see section Currency Code ode Enumeration in the Lipper Data Enumerations chapter. The response returns the date and price of the best and worst performance for the specified assets: XML Sample Response - Getting Best Worst Performance
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperC alculations_1/ G etBestWorstP erformance_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etBestWorstP erformance_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperC alculations_1"> <BestWorstP erformanceResult> <BestWorstP erformanceTy pe> <LipperId>11006603</LipperId> <S eriesS tartDate>2006-03-31</S eriesS tartDate> <C urrency C ode>E U R</C urrency C ode> <WorstS tartDate>2008-08-29</WorstS tartDate> <WorstV alue>-29.86491</WorstV alue> <WorstE stimate>false</WorstE stimate> <BestS tartDate>2006-09-29</BestS tartDate> <BestV alue>8.17069</BestV alue>

364

TRKD API Developer's Guide

<BestE stimate>false</BestE stimate> </BestWorstP erformanceTy pe> <BestWorstP erformanceTy pe> <LipperId>11020455</LipperId> <S eriesS tartDate>2006-03-31</S eriesS tartDate> <C urrency C ode>E U R</C urrency C ode> <WorstS tartDate>2008-08-29</WorstS tartDate> <WorstV alue>-19.77107</WorstV alue> <WorstE stimate>false</WorstE stimate> <BestS tartDate>2008-12-31</BestS tartDate> <BestV alue>9.7311</BestV alue> <BestE stimate>false</BestE stimate> </BestWorstP erformanceTy pe> <BestWorstP erformanceTy pe> <LipperId>19048139</LipperId> <S eriesS tartDate>2006-03-31</S eriesS tartDate> <C urrency C ode>E U R</C urrency C ode> <WorstS tartDate>2008-08-29</WorstS tartDate> <WorstV alue>-12.73273</WorstV alue> <WorstE stimate>false</WorstE stimate> <BestS tartDate>2006-07-31</BestS tartDate> <BestV alue>3.8811</BestV alue> <BestE stimate>false</BestE stimate> </BestWorstP erformanceTy pe> </BestWorstP erformanceResult> </G etBestWorstP erformance_Response_1> </Body > </E nv elope>

Element LipperId SeriesStartD ate CurrencyCod e WorstStartD ate WorstValue WorstEstima te BestStartDat e BestStartVal ue BestEstimate

Description The asset's Lipper ID. The start date of the time period. The currency for the values. The date of the worst performance date. The worst performance value (i.e., worst price per share). A flag that indicates if the worst performance value is estimated. The date of the best performance date. The best performance value (i.e., best price per share). A flag that indicates if the best performance value is estimated.

19.3.4 Get Rolling Performance (GetRollingPerformance_1)

You can use the GetRollingPerformance_1 method to retrieve data for the requested rolling performance calculation for the given asset(s), time period and interval. Rolling performance is a performance calculation for a specific period of time: yearly, daily, weekly, monthly. The example below gets rolling performance calculation for the specified time period and intervals and expressed in US dollars for the asset with '60003333' LipperID: XML Sample Request - Getting Rolling Performance
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperC alculations_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperC alculations_1/ G etRollingP erformance_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1">

Lipper Details

365

<A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etRollingP erformance_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperC alculations_1"> <lipperID>60003333</lipperID> <currency C ode>U S D</currency C ode> <periods>1</periods> <timeF rame>A ll</timeF rame> <interv al>Weekly </interv al> <interv alF requency >A utomatic</interv alF requency > </G etRollingP erformance_Request_1> </Body > </E nv elope>

Paramet Description er lipperID A unique eight- or nine-digit number that identifies an asset. currencyC The currency for the returned data. For full listing of available currency codes, see section Currency Code ode Enumeration in the Lipper Data Enumerations chapter. periods interval Periods are reference to days, weeks, months, quarters or years. The rolling period interval, which sets the intervals for the performance data with the given timeFrame. timeFrame The time frame for which performance data will be returned ( A ll, Daily , W eekly , Monthly or Yearly ). intervalFr The interval frequency. The possible value could be weekly, monthly, automatic, yearly, semiAnnualy or equency quarterly. Note: IntervalFrequency tells the service whether you want to perform a calculation using daily, weekly, monthly, quarterly, or yearly samples. It is best to set it to Automatic setting. The response returns the data for the given rolling performance calculation and asset: XML Sample Response - Getting Rolling Performance
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperC alculations_1/ G etRollingP erformance_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etRollingP erformance_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperC alculations_1"> <RollingP erformanceResult> <RollingP erformanceTy pe> <V alue>-0.9515</V alue> <DataDate>2002-12-27</DataDate> </RollingP erformanceTy pe> <RollingP erformanceTy pe> <V alue>2.58453</V alue> <DataDate>2003-03-07</DataDate> </RollingP erformanceTy pe> <RollingP erformanceTy pe> <V alue>-3.49702</V alue> <DataDate>2003-03-14</DataDate> </RollingP erformanceTy pe> ... <RollingP erformanceTy pe> <V alue>-0.53725</V alue> <DataDate>2009-04-03</DataDate> </RollingP erformanceTy pe> <RollingP erformanceTy pe> <V alue>-0.59132</V alue> <DataDate>2009-04-10</DataDate>

366

TRKD API Developer's Guide

</RollingP erformanceTy pe> </RollingP erformanceResult> </G etRollingP erformance_Response_1> </Body > </E nv elope>

Elemen Description t Value The data value for the period. DataDat The date for which the data is valid. e

19.3.5 Get Stored Performance By Calculations Filter (GetStoredPerformanceByCalculationsFilter_1)

You can use the GetStoredPerformanceByCalculationsFilter_1 method to retrieve a list of performance calculations for a specific fund, currency ID and a list of calculation period type IDs. Performance calculation is a calculation that measures the percentage change in price from start period to end period. Note: PerformanceCalculation contains dynamic calculations while StoredPerformanceCalculation methods contain the various performance and statistic calculations. The example below gets performance calculations expressed in US dollars for the assets with '60003333' LipperIDs based on 'OneMonthPerformanceLastMonthEnd' calculation type: XML Sample Request - Getting Stored Performance By Calculations Filter
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperC alculations_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperC alculations_1/ G etS toredP erformanceBy C alculationsF ilter_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etS toredP erformanceBy C alculationsF ilter_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/ LipperC alculations_1"> <lipperID>60003333</lipperID> <currency C ode>U S D</currency C ode> <calcP eriodTy peIDs> <C alculationTy peId>O neM onthP erformancetoLastM onthE nd</C alculationTy peId> </calcP eriodTy peIDs> </G etS toredP erformanceBy C alculationsF ilter_Request_1> </Body > </E nv elope>

Paramet Description er lipperID A unique eight- or nine-digit number that identifies an asset. currencyC The currency for the returned data. For full listing of available currency codes, see section Currency Code ode Enumeration in the Lipper Data Enumerations chapter. calcPeriod The list of calculation period type IDs. For full listing of available calculation typeIDs, see section Calculation TypeIDs TypeId Enumeration in the Lipper Data Enumerations chapter. The response returns a list of performance calculations the specified asset:

Lipper Details

367

XML Sample Response - Getting Stored Performance By Calculations Filter

<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperC alculations_1/ G etS toredP erformanceBy C alculationsF ilter_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etS toredP erformanceBy C alculationsF ilter_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/ LipperC alculations_1"> <S toredP erformanceBy C alculationsF ilterResult> <P erformanceC alculationTy pe> <LipperId>60003333</LipperId> <P erformanceC alculationList> <P erformanceC alculationItem> <C urrency C ode>U S D</C urrency C ode> <S tatTy peId>26594</S tatTy peId> <E stimate>false</E stimate> <S tartDate>2009-02-28</S tartDate> <E ndDate>2009-03-31</E ndDate> <C alcP eriodN ame>O neM onthP erformancetoLastM onthE nd</C alcP eriodN ame> <Language>LanguageN eutral</Language> <V alue>10.24352</V alue> <C alculationTy pe>O neM onthP erformancetoLastM onthE nd</C alculationTy pe> </P erformanceC alculationItem> </P erformanceC alculationList> </P erformanceC alculationTy pe> </S toredP erformanceBy C alculationsF ilterResult> </G etS toredP erformanceBy C alculationsF ilter_Response_1> </Body > </E nv elope>

Element Description LipperId The asset's Lipper ID. Performance The asset's performance calculation list. Contains the following elements: CalculationLi CurrencyCode - the currency code that represents the currency of the performance calculation data. st StatTypeId - the stat type id. This is a simple numeric reference identifier used to identify the various statistics and calculations available through the service. Estimate - a flag that indicates if the value of this performance calculation is an estimate. StartDate - the start date for the time period used for the performance calculation. EndDate - the end date for the time period used for the performance calculation. CalcPeriodName - the name of the performance calculation.

19.3.6 Get Stored Performance Calculation (GetStoredPerformanceCalculation_1)

You can use the GetStoredPerformanceCalculation_1 method to retrieve the value of the requested stored performance calculation for the given asset(s). PerformanceCalculation contains dynamic calculations while StoredPerformanceCalculation methods contain the various performance and statistic calculations. The example below gets performance calculations expressed in US dollars for the assets with '60003333' LipperIDs based on 'OneMonthPerformanceLastMonthEnd' calculation type: XML Sample Request - Getting Stored Performance Calculation
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperC alculations_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID>

368

TRKD API Developer's Guide

<A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperC alculations_1/ G etS toredP erformanceC alculation_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etS toredP erformanceC alculation_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperC alculations_1"> <lipperIDs> <int>60003333</int> </lipperIDs> <currency C ode>U S D</currency C ode> <calcP eriodTy peID>O neM onthP erformancetoLastM onthE nd</calcP eriodTy peID> <language>E nglish</language> </G etS toredP erformanceC alculation_Request_1> </Body > </E nv elope>

Paramet Description er lipperID A unique eight- or nine-digit number that identifies an asset. currencyC The currency for the returned data. For full listing of available currency codes, see section Currency Code ode Enumeration in the Lipper Data Enumerations chapter. calcPeriod The list of calculation period type IDs. For full listing of available calculation typeIDs, see section Calculation TypeID TypeId Enumeration in the Lipper Data Enumerations chapter. language The display language for the returned data.

Note: Lipper automatically defaults to American English if the requested data is unavailable in the language specified in the language option. The response returns requested stored performance calculation data for the specified asset: XML Sample Response - Getting Stored Performance Calculation
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperC alculations_1/ G etS toredP erformanceC alculation_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etS toredP erformanceC alculation_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperC alculations_1"> <S toredP erformanceC alculationResult> <P erformanceC alculationTy pe> <LipperId>60003333</LipperId> <P erformanceC alculationList> <P erformanceC alculationItem> <C urrency C ode>U S D</C urrency C ode> <S tatTy peId>4</S tatTy peId> <E stimate>false</E stimate> <S tartDate>2009-02-28</S tartDate> <E ndDate>2009-03-31</E ndDate> <C alcP eriodN ame>1 M onth P erformance to Last M onth E nd</C alcP eriodN ame> <Language>E nglish</Language> <V alue>10.24352</V alue> <C alculationTy pe>N one</C alculationTy pe> </P erformanceC alculationItem> </P erformanceC alculationList> </P erformanceC alculationTy pe> </S toredP erformanceC alculationResult> </G etS toredP erformanceC alculation_Response_1> </Body > </E nv elope>

Lipper Details

369

Element Description LipperId The asset's Lipper ID. Performance The asset's performance calculation list. Contains the following elements: CalculationLi CurrencyCode - the currency code that represents the currency of the performance calculation data. st StartTypeId - the stat type id. Estimate - a flag that indicates if the value of this performance calculation is an estimate. StartDate - the start date for the time period used for the performance calculation. EndDate - the end date for the time period used for the performance calculation. CalcPeriodName - the name of the performance calculation. Language - the display language for the performance calculation data. Value - the value of the performance calculation. CalculationType - the type of the calculation.

19.3.7 Get Stored Performance Calculations (GetStoredPerformanceCalculations_1)

You can use the GetStoredPerformanceCalculations_1 method to retrieve all of the available performance calculations and values for the given asset(s). PerformanceCalculation contains dynamic calculations while StoredPerformanceCalculation methods contain the various performance and statistic calculations. The example below gets performance calculations expressed in Euro and displayed in English language for the given assets: XML Sample Request - Getting Stored Performance Calculations
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperC alculations_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperC alculations_1/ G etS toredP erformanceC alculations_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etS toredP erformanceC alculations_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperC alculations_1"> <lipperIDs> <int>65028707</int> <int>19005018</int> <int>19008018</int> <int>19005027</int> <int>19008027</int> <int>19005028</int> <int>19008028</int> <int>19005026</int> <int>19005024</int> <int>19005003</int> <int>19008003</int> <int>60087648</int> <int>60079650</int> <int>11029714</int> <int>11029717</int> <int>11027921</int> <int>11027924</int> <int>11000423</int> <int>19048072</int> <int>19048155</int> <int>19048217</int> <int>19048136</int> <int>19048138</int> <int>19048139</int> <int>11020455</int> <int>11006603</int> </lipperIDs>

370

TRKD API Developer's Guide

<currency C ode>E U R</currency C ode> <language>E nglish</language> </G etS toredP erformanceC alculations_Request_1> </Body > </E nv elope>

Paramet Description er lipperID A unique eight- or nine-digit number that identifies an asset. currencyC The currency for the returned data. For full listing of available currency codes, see section Currency Code ode Enumeration in the Lipper Data Enumerations chapter. language The display language for the returned data.

Note: Lipper automatically defaults to American English if the requested data is unavailable in the language specified in the language option. The response returns requested stored performance calculation data for the specified assets: XML Sample Response - Getting Stored Performance Calculations
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperC alculations_1/ G etS toredP erformanceC alculations_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etS toredP erformanceC alculations_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperC alculations_1"> <S toredP erformanceC alculationsResult> <P erformanceC alculationTy pe> <LipperId>60079650</LipperId> <P erformanceC alculationList> <P erformanceC alculationItem> <C urrency C ode>E U R</C urrency C ode> <S tatTy peId>4</S tatTy peId> <E stimate>true</E stimate> <S tartDate>2009-02-28</S tartDate> <E ndDate>2009-03-31</E ndDate> <C alcP eriodN ame>1 M onth P erformance to Last M onth E nd</C alcP eriodN ame> <Language>E nglish</Language> <V alue>0.04256</V alue> <C alculationTy pe>N one</C alculationTy pe> </P erformanceC alculationItem> <P erformanceC alculationItem> <C urrency C ode>E U R</C urrency C ode> <S tatTy peId>5</S tatTy peId> <E stimate>true</E stimate> <S tartDate>2008-12-31</S tartDate> <E ndDate>2009-03-31</E ndDate> <C alcP eriodN ame>3 M onth P erformance to Last M onth E nd</C alcP eriodN ame> <Language>E nglish</Language> <V alue>-2.59882</V alue> <C alculationTy pe>N one</C alculationTy pe> </P erformanceC alculationItem> ... <P erformanceC alculationItem> <C urrency C ode>E U R</C urrency C ode> <S tatTy peId>55</S tatTy peId> <E stimate>false</E stimate> <S tartDate>1999-03-31</S tartDate> <E ndDate>2009-03-31</E ndDate> <C alcP eriodN ame>M ax Draw dow n for 10 Years to Last M onth E nd</C alcP eriodN ame> <Language>E nglish</Language> <V alue>-66.96854</V alue> <C alculationTy pe>N one</C alculationTy pe>

Lipper Details

371

</P erformanceC alculationItem> </P erformanceC alculationList> </P erformanceC alculationTy pe> </S toredP erformanceC alculationsResult> </G etS toredP erformanceC alculations_Response_1> </Body > </E nv elope>

Element Description LipperId The asset's Lipper ID. Performance The asset's performance calculation list. Contains the following elements: CalculationLi CurrencyCode - the currency code that represents the currency of the performance calculation data. st StartTypeId - the stat type id. Estimate - a flag that indicates if the value of this performance calculation is an estimate. StartDate - the start date for the time period used for the performance calculation. EndDate - the end date for the time period used for the performance calculation. CalcPeriodName - the name of the performance calculation. Language - the display language for the performance calculation data. Value - the value of the performance calculation. CalculationType - the type of the calculation.

19.4

Lipper Fundamentals
The Lipper Details section provides easy access to a wide range of basic Lipper fund data from Lipper's extensive database of collective investments, allowing clients to quickly find fund details based on hundreds of criteria items and to compare those funds across a wide range of timely characteristics.

19.4.1 Authentication/Authorization, Service Endpoint, and Required Headers

Authorization All requests to the Lipper services require an authorization token. For details, see section Understanding Authentication Tokens. Authentication The Lipper services use Reuters impersonation tokens for each effective user. In this case, Thomson Reuters must create each user before your application authenticates them. Unmanaged effective users are not supported in the Lipper services. For additional information on creating a Service Token, see section Creating a Token. Service Endpoints Lipper Fundamentals Endpoint
http://api.rkd.reuters.com/api/2009/01/01/LipperF undamentals_1.sv c

Required Headers Lipper Fundamentals Required HTTP Headers

P O S T /api/2009/01/01/LipperF undamentals_1.sv c H TTP /1.1 C ontent-Ty pe: application/soap+xml H ost: api.rkd.reuters.com C ontent-Length: [length]

19.4.2 WSDL
Lipper Fundamentals WSDL:
http://api.rkd.reuters.com/schemas/w sdl/LipperF undamentals_1_H ttpA ndRKDToken.w sdl

372

TRKD API Developer's Guide

19.4.3 Get Asset Is Primary (GetAssetIsPrimary_1)

You can use the GetAssetIsPrimary_1 method to retrieve flags that indicate whether the given assets are the primary funds for a fund series with multiple share classes for the same portfolio of investments. A flag represents an attribute that Lipper has assigned to the asset. The example below gets flags for the asset with '60003333' and '60003331' LipperIDs: XML Sample Request - Getting Asset Is Primary
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperF undamentals_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etA ssetIsP rimary _1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etA ssetIsP rimary _Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1"> <lipperIDs> <int>60003333</int> <int>60003331</int> </lipperIDs> </G etA ssetIsP rimary _Request_1> </Body > </E nv elope>

Paramet Description er lipperID Contains a list of one or more Lipper IDs for which data will be returned. A Lipper ID is a unique eight- or ninedigit number (e.g., 60003333) that identifies an asset.

The response returns the following information for the specified assets: XML Sample Response - Getting Asset Is Primary
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etA ssetIsP rimary _1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etA ssetIsP rimary _Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1"> <A ssetIsP rimary Result> <V alidationTy pe> <LipperId>60003331</LipperId> <IsV alid>false</IsV alid> </V alidationTy pe> <V alidationTy pe> <LipperId>60003333</LipperId> <IsV alid>false</IsV alid> </V alidationTy pe> </A ssetIsP rimary Result> </G etA ssetIsP rimary _Response_1> </Body >

Lipper Details

373

</E nv elope>

Elemen Description t LipperId The asset's Lipper ID. IsValid A flag that indicates whether this instance is true or false.

19.4.4 Get Benchmark (GetBenchmark_1)

You can use the GetBenchmark_1 method to retrieve the benchmarks for the given benchmark category and asset(s). A benchmark is a standard against which the performance of a security, index or investor can be measured. The example below gets benchmarks for the asset with '60003333' LipperID under the 'AssetManager' category and displayed in English language: XML Sample Request - Getting Benchmark
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperF undamentals_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etBenchmark_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etBenchmark_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1"> <lipperIDs> <int>60003333</int> </lipperIDs> <benchmarkC ategory >A ssetM anager</benchmarkC ategory > <language>E nglish</language> </G etBenchmark_Request_1> </Body > </E nv elope>

Parameter lipperID

Description A Lipper ID is a unique eight- or nine-digit number (e.g., 60003333) that identifies a collective investment.

benchmarkCate The benchmark category for which benchmarks should be returned. Possible values are: gory AssetManager - a benchmark that defines the asset manager (the same as fund manager). RiskFreeIndex - risk free index is a benchmark comprised of riskless assets such as three month Treasury Bills. TechnicalIndicator - technical indicator is a benchmark that, based on statistical calculations, makes a very good benchmark for the asset. PriceEstimation - a benchmark that defines price estimates. Classification - a benchmark that defines asset classification. language The display language for the returned data.

Note: Lipper automatically defaults to American English if the requested data is unavailable in the language specified in the language option. The response returns a list of <BenchmarkType> elements that contain the benchmarks for the requested benchmark category data for the given asset(s): XML Sample Response - Getting Benchmark
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing">

374

TRKD API Developer's Guide

<s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etBenchmark_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > G etBenchmark_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1"> <BenchmarkResult> <BenchmarkTy pe> <LipperId>60003333</LipperId> <BenchmarkList> <BenchmarkItem> <Language>E nglish</Language> <BenchmarkId>11005483</BenchmarkId> <BenchmarkN ame>M S C I World/H ealth C are TR</BenchmarkN ame> <BenchmarkC ategory >A ssetM anager</BenchmarkC ategory > </BenchmarkItem> </BenchmarkList> </BenchmarkTy pe> </BenchmarkResult> </G etBenchmark_Response_1> </Body > </E nv elope>

Element Description LipperId The asset's Lipper ID. BenchmarkL The list of BenchmarkItems that contain the asset's list of benchmarks. Contains the following elements: ist Language - the language for the benchmark information. BenchmarkId - the Benchmark ID. BenchmarkName - the name of the benchmark. BenchmarkCategory - the benchmark category.

19.4.5 Get Benchmarks (GetBenchmarks_1)

You can use the GetBenchmarks_1 method to retrieve benchmarks for the given asset(s). A benchmark is a standard against which the performance of a security, index or investor can be measured. The example below gets benchmarks for the asset with '60003333' LipperID displayed in English language: XML Sample Request - Getting Benchmarks
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperF undamentals_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etBenchmarks_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etBenchmarks_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1"> <lipperIDs> <int>60003333</int> </lipperIDs> <language>E nglish</language> </G etBenchmarks_Request_1> </Body > </E nv elope>

Lipper Details

375

Paramet Description er lipperID language A unique eight- or nine-digit number that identifies an asset. The display language for the returned data.

Note: Lipper automatically defaults to American English if the requested data is unavailable in the language specified in the language option. The response returns a list of <BenchmarkType> elements that contain the benchmark information: XML Sample Response - Getting Benchmarks
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etBenchmarks_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etBenchmarks_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1"> <BenchmarksResult> <BenchmarkTy pe> <LipperId>60003333</LipperId> <BenchmarkList> <BenchmarkItem> <Language>E nglish</Language> <BenchmarkId>11005483</BenchmarkId> <BenchmarkN ame>M S C I World/H ealth C are TR</BenchmarkN ame> <BenchmarkC ategory >A ssetM anager</BenchmarkC ategory > </BenchmarkItem> <BenchmarkItem> <Language>E nglish</Language> <BenchmarkId>11020242</BenchmarkId> <BenchmarkN ame>LIBO R U S D 3 M onths</BenchmarkN ame> <BenchmarkC ategory >RiskF reeIndex</BenchmarkC ategory > </BenchmarkItem> <BenchmarkItem> <Language>E nglish</Language> <BenchmarkId>11005483</BenchmarkId> <BenchmarkN ame>M S C I World/H ealth C are TR</BenchmarkN ame> <BenchmarkC ategory >TechnicalIndicator</BenchmarkC ategory > </BenchmarkItem> </BenchmarkList> </BenchmarkTy pe> </BenchmarksResult> </G etBenchmarks_Response_1> </Body > </E nv elope>

Element Description LipperId The asset's Lipper ID. BenchmarkL The list of BenchmarkItems that contain the asset's list of benchmarks. Contains the following elements: ist Language - the language for the benchmark information. BenchmarkId - the Benchmark ID. BenchmarkName - the name of the benchmark. BenchmarkCategory - the benchmark category.

19.4.6 Get Bottom Performers (GetBottomPerformers_1)

You can use the GetBottomPerformers_1 method to retrieve the poorest or bottom-performing funds for the given country or

376

TRKD API Developer's Guide

countries. The example below gets the poorest funds for the USA expressed in US dollars and displayed in English language. The request is also configured to retrieve only 10 poorest funds and include hedge funds in the results. XML Sample Request - Getting Bottom Performers
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperF undamentals_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etBottomP erformers_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etBottomP erformers_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1"> <country C ode> <C ountries>U S A </C ountries> </country C ode> <currency C ode>U S D</currency C ode> <numberO fA ssets>10</numberO fA ssets> <language>E nglish</language> <includeH edgeF unds>true</includeH edgeF unds> </G etBottomP erformers_Request_1> </Body > </E nv elope>

Parameter Countries currencyCode

Description The country for which the poorest-performing funds should be returned. For full listing of available country codes, see section Countries Enumeration in the Lipper Data Enumerations chapter. The display currency for the returned list. For full listing of available currency codes, see section Currency Code Enumeration in the Lipper Data Enumerations chapter.

numberOfAsset The number of funds that should be included in the list of poorest performers. s language The display language for the returned data. includeHedgeF If true, hedge funds will be included in the returned list of poorest-performing funds; otherwise, hedge unds funds will not be included in the results. Hedge funds are investment funds open to a limited range of investors. A hedge fund allows more investment and trading activities than other investment funds and an investor pays a special performance fee to its investment manager. Note: Lipper automatically defaults to American English if the requested data is unavailable in the language specified in the language option. The response returns a list of <PerformerType> elements that contain the poorest performing funds: XML Sample Response - Getting Bottom Performers
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etBottomP erformers_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader>

Lipper Details

377

<s:Body > <G etBottomP erformers_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1"> <BottomP erformersResult> <P erformerTy pe> <C ountry C ode>U S A </C ountry C ode> <P erformerList> <P erformerItem> <LipperId>40000354</LipperId> <Language>E nglish</Language> <F undS hortN ame>A meritor Inv estment</F undS hortN ame> <P erfYTD>-85.71429</P erfYTD> </P erformerItem> <P erformerItem> <LipperId>40105153</LipperId> <Language>E nglish</Language> <F undS hortN ame>Direxion:E M Br 2x;Inv </F undS hortN ame> <P erfYTD>-50.35505</P erfYTD> </P erformerItem> ... <P erformerItem> <LipperId>40096684</LipperId> <Language>E nglish</Language> <F undS hortN ame>P roF unds:U ltS h Dow 30;S v c</F undS hortN ame> <P erfYTD>-23.85066</P erfYTD> </P erformerItem> <P erformerItem> <LipperId>40096683</LipperId> <Language>E nglish</Language> <F undS hortN ame>P roF unds:U ltS h Dow 30;Inv </F undS hortN ame> <P erfYTD>-23.06207</P erfYTD> </P erformerItem> </P erformerList> </P erformerTy pe> </BottomP erformersResult> </G etBottomP erformers_Response_1> </Body > </E nv elope>

Element Description CountryCo The country code that represents the country to which the performance list pertains. de PerformerLi The list of the country's fund performance data. Contains the following elements: st LipperId - the asset's Lipper ID. Language - the display language for the fund performance data. FundShortName - the fund's short name. PerfYTD - the asset's year-to-date performance value (capital gains).

19.4.7 Get Bottom Performers By Classification Scheme (GetBottomPerformersByClassificationScheme_1)

You can use the GetBottomPerformersByClassificationScheme_1 method to retrieve the poorest or bottom-performing funds (based on year-to-date performance) for the given classification scheme. A classification is a designation assigned to assets based on various characteristics of the assets. For example, Equity North America is a classification assigned to an asset. Classifications are organized into classification schemes. Lipper offers or tracks multiple classification schemes around the world. For example, Equity North America is a classification within the Lipper Global Classification scheme. The example below retrieves 10 poorest funds for the 'ABILIFE2008' classification scheme expressed in US dollars and displayed in English language: XML Sample Request - Getting Bottom Performers By Classification Scheme
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperF undamentals_1.sv c</To>

378

TRKD API Developer's Guide

<M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etBottomP erformersBy C lassificationS cheme_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etBottomP erformersBy C lassificationS cheme_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/ LipperF undamentals_1"> <classificationS chemeC ode>A BILIF E 2008</classificationS chemeC ode> <language>E nglish</language> <currency C ode>U S D</currency C ode> <numberO fC lasses>10</numberO fC lasses> <calculationP eriodN ame> <C alculationTy peId>O neM onthP erformancetoLastM onthE nd</C alculationTy peId> </calculationP eriodN ame> </G etBottomP erformersBy C lassificationS cheme_Request_1> </Body > </E nv elope>

Parameter

Description

classificationSch The classification scheme for which bottom-performing funds should be returned. See the list of available emeCode classification schemes in the Classification Scheme Enumeration section in the Lipper Data Enumerations chapter. language currencyCode The display language for the returned list. The display currency for the returned data. For full listing of available currency codes, see section Currency Code Enumeration in the Lipper Data Enumerations chapter.

numberOfClasse The number of classes to include in the search results. s calculationPeriod One or more calculation periods for which performance data will be returned. Contains <CalculationTypeId> element that represents a static performance calculation supported by Lipper. For full listing of available calculation typeIDs, see section Calculation TypeId Enumeration in the Lipper Data Enumerations chapter. Note: The GetBottomPerformersByClassificationScheme_1 operation works as desired only if a single <CalculationTypeId> is specified though declared as multiple in the schema. Note: Lipper automatically defaults to American English if the requested data is unavailable in the language specified in the language option. The response returns performance data for the given classification scheme and time period: XML Sample Response - Getting Bottom Performers By Classification Scheme
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etBottomP erformersBy C lassificationS cheme_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etBottomP erformersBy C lassificationS cheme_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/ LipperF undamentals_1"> <BottomP erformersBy C lassificationS chemeResult> <C lassificationS chemeC ode>A BILIF E 2008</C lassificationS chemeC ode> <C lassificationS chemeN ame>A BI Life S cheme</C lassificationS chemeN ame> <Language>E nglish</Language> <C alculationList> <P erformanceC alculation> <Language>E nglish</Language>

Lipper Details

379

<C alculationP eriodN ame>1 M onth P erformance to Last M onth E nd</C alculationP eriodN ame> <C alculationA crony m>1mP erf:</C alculationA crony m> <A sO fDate>2009-03-31T00:00:00</A sO fDate> <P erformerList> <P erformerC alculationItem> <IndexIdentity > <LipperId>19074021</LipperId> <Language>E nglish</Language> <N ame>A BI U K - S terling C orporate Bond-Life</N ame> </IndexIdentity > <C lassId>28981</C lassId> <Language>E nglish</Language> <V alue>-1.784970</V alue> </P erformerC alculationItem> <P erformerC alculationItem> <IndexIdentity > <LipperId>19074024</LipperId> <Language>E nglish</Language> <N ame>A BI U K - S terling H igh Yield-Life</N ame> </IndexIdentity > <C lassId>28984</C lassId> <Language>E nglish</Language> <V alue>-1.596770</V alue> </P erformerC alculationItem> ... <P erformerC alculationItem> <IndexIdentity > <LipperId>19074030</LipperId> <Language>E nglish</Language> <N ame>A BI U K - M oney M arket-Life</N ame> </IndexIdentity > <C lassId>28990</C lassId> <Language>E nglish</Language> <V alue>0.579320</V alue> </P erformerC alculationItem> </P erformerList> </P erformanceC alculation> </C alculationList> </BottomP erformersBy C lassificationS chemeResult> </G etBottomP erformersBy C lassificationS cheme_Response_1> </Body > </E nv elope>

Element ClassificationScheme Code ClassificationScheme Name Language CalculationList

Description The classification type's ID. The name of the classification scheme. The display language for the asset identity information. The performance calculation data. Contains the following elements: Language - the display language for the asset identity information. CalculationPeriodName - the name of the performance calculation period. CalculationAcronym - the calculation acronym. AsOfDate - the date for which the retrieved data is valid. PerformerList - the performer value. A list of <PerformerCalculationItem> elements. Contains the following elements: Index Identity - the asset identity (LipperId, Language and Name). C lassId - the class ID. Language - the display language for the performance calculation data. Value - the value of the performance calculation.

19.4.8 Get Bottom Performers By LG Classification Schema (GetBottomPerformersByLGClassificationSchema_1)

You can use the GetBottomPerformersByLGClassificationSchema_1 method to retrieve the bottom or poorest-performing funds (based on year-to-date performance) for one or more Lipper Global Classification Schema.

380

TRKD API Developer's Guide

A classification is a designation assigned to assets based on various characteristics of the assets. For example, Equity North America is a classification assigned to an asset. Classifications are organized into classification schemes. Lipper offers or tracks multiple classification schemes around the world. For example, Equity North America is a classification within the Lipper Global Classification scheme. Lipper Fund Classifications Lipper fund classifications provide the ability to make meaningful 'like for like' comparisons across funds with similar investment mandates. Choose from style based holdings classifications; proprietary fund association local market schemes; or take a much broader approach by using the Lipper Global Classification which encompasses all funds tracked by Lipper. The example below retrieves 10 poorest funds for the 'LipperGlobal' classification schema expressed in US dollars and displayed in English language: XML Sample Request - Getting Bottom Performers By LG Classification Schema
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperF undamentals_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etBottomP erformersBy LG C lassificationS chema_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etBottomP erformersBy LG C lassificationS chema_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/ LipperF undamentals_1"> <lG C lassificationS chemaN ame> <LG C lassificationS chema>LipperG lobal</LG C lassificationS chema> </lG C lassificationS chemaN ame> <currency C ode>U S D</currency C ode> <language>E nglish</language> <numberO fA ssets>10</numberO fA ssets> </G etBottomP erformersBy LG C lassificationS chema_Request_1> </Body > </E nv elope>

Parameter

Description

lGClassificationS The Lipper Global Classification schema for which bottom-performing funds should be returned. Available chemaName Lipper Global Classification schemes are listed in the LG Classification Scheme Enumeration section in the Lipper Data Enumerations chapter. currencyCode language The display currency for the returned data. For full listing of available currency codes, see section Currency Code Enumeration in the Lipper Data Enumerations chapter. The display language for the returned data.

numberOfAssets The number of bottom-performing assets to be returned. Note: Lipper automatically defaults to American English if the requested data is unavailable in the language specified in the language option. The response returns the bottom-performing funds for the given Lipper Classification Schema: XML Sample Response - Getting Bottom Performers By LG Classification Schema
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etBottomP erformersBy LG C lassificationS chema_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo>

Lipper Details

381

</s:H eader> <s:Body > <G etBottomP erformersBy LG C lassificationS chema_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/ LipperF undamentals_1"> <BottomP erformersBy LG C lassificationS chemaResult> <LG P erformerTy pe> <LG C lassificationS chemeN ame>LipperG lobal</LG C lassificationS chemeN ame> <LG P erformerList> <LG P erformerItem> <LipperId>65030166</LipperId> <Language>E nglish</Language> <F undS hortN ame>A LA - A sia G lobal Balanced</F undS hortN ame> <P erfYTD>-93.52841</P erfYTD> </LG P erformerItem> <LG P erformerItem> <LipperId>67008651</LipperId> <Language>E nglish</Language> <F undS hortN ame>Blackrock U K E m C os E U R</F undS hortN ame> <P erfYTD>-87.06229</P erfYTD> </LG P erformerItem> ... <LG P erformerItem> <LipperId>62005268</LipperId> <Language>E nglish</Language> <F undS hortN ame>S BI S oftbank S BI G roup E Q </F undS hortN ame> <P erfYTD>-54.60367</P erfYTD> </LG P erformerItem> <LG P erformerItem> <LipperId>67004319</LipperId> <Language>E nglish</Language> <F undS hortN ame>H asenbichler DRC A G </F undS hortN ame> <P erfYTD>-49.98813</P erfYTD> </LG P erformerItem> </LG P erformerList> </LG P erformerTy pe> </BottomP erformersBy LG C lassificationS chemaResult> </G etBottomP erformersBy LG C lassificationS chema_Response_1> </Body > </E nv elope>

Element Description LGClassificationSche The Lipper Global Classification Scheme name. meName LGPerformerList The list of funds. Contains the following elements: LipperId - the asset's Lipper ID. Language - the display language for the data. FundShortName - the short name of the asset. PerfYTD - the fund's year-to-date performance.

19.4.9 Get Charges (GetCharges_1)

You can use the GetCharges_1 method to retrieve the information about various charges paid by the given asset(s) as of the given effective date. The example below retrieves charges information for the asset with '60003333' LipperID as of 2009-03-03. XML Sample Request - Getting Charges
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperF undamentals_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etC harges_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization>

382

TRKD API Developer's Guide

</H eader> <Body > <G etC harges_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1"> <lipperIDs> <int>60003333</int> </lipperIDs> <effectiv eDate>2009-03-03</effectiv eDate> </G etC harges_Request_1> </Body > </E nv elope>

Paramete Description r lipperID A unique eight- or nine-digit number that identifies an asset. effectiveDa The effective date for the charges data. te The response returns the charges data for the specified asset(s): XML Sample Response - Getting Charges
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/G etC harges_1_Reply </ a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etC harges_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1"> <C hargesResult> <C hargesTy pe> <LipperId>60003333</LipperId> <N ame>Janus G lobal Life S ciences E U R A A cc</N ame> <C hargesList> <C hargesItem> <DataDate>1800-01-01</DataDate> <C hargeId>777</C hargeId> <C hargeN ame>Initial</C hargeN ame> <M inimum xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <M aximum>6.25</M aximum> <A ctual xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> </C hargesItem> <C hargesItem> <DataDate>1800-01-01</DataDate> <C hargeId>779</C hargeId> <C hargeN ame>Redemption</C hargeN ame> <M inimum>0</M inimum> <M aximum>1</M aximum> <A ctual xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> </C hargesItem> <C hargesItem> <DataDate>1800-01-01</DataDate> <C hargeId>778</C hargeId> <C hargeN ame>A nnual</C hargeN ame> <M inimum xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <M aximum xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <A ctual>1.5</A ctual> </C hargesItem> </C hargesList> </C hargesTy pe> </C hargesResult> </G etC harges_Response_1> </Body > </E nv elope>

Lipper Details

383

Element LipperId Name ChargesLi st

Description The asset identifier of a particular collective investment within Lipper. The name of the asset. The list of all the charges for the asset. Contains the following elements: DataDate - the data date for the charge. ChargeId - the numeric ID of the charge item. ChargeName - the name of the charge. Minimum - the minimum charge for the charge item. Maximum - the maximum charge for the charge item. Actual - the actual charge for the item.

19.4.10 Get Classification (GetClassification_1)

You can use the GetClassification_1 method to retrieve classification types for the given asset(s) based on the classSchemeID. A classification is a designation assigned to assets based on various characteristics of the assets. For example, Equity North America is a classification assigned to an asset. Classifications are organized into classification schemes. Lipper offers or tracks multiple classification schemes around the world. For example, Equity North America is a classification within the Lipper Global Classification scheme. Lipper Fund Classifications Lipper fund classifications provide the ability to make meaningful 'like for like' comparisons across funds with similar investment mandates. Choose from style based holdings classifications; proprietary fund association local market schemes; or take a much broader approach by using the Lipper Global Classification which encompasses all funds tracked by Lipper. The example below retrieves classification types for the asset with '60003333' LipperID based on '1671' classSchemeID for the specified date and displayed in English language. XML Sample Request - Getting Classification
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperF undamentals_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etC lassification_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etC lassification_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1"> <lipperIDs> <int>60003333</int> </lipperIDs> <classS chemeID>1671</classS chemeID> <language>E nglish</language> <dataDate>2009-03-27</dataDate> </G etC lassification_Request_1> </Body > </E nv elope>

Paramete r lipperIDs classSchem eID language dataDate

Description A list of one or more Lipper IDs for which data will be returned. The classification scheme ID. The display language for the returned list. The date for which classification data will be returned.

384

TRKD API Developer's Guide

Note: Lipper automatically defaults to American English if the requested data is unavailable in the language specified in the language option. The response returns the classification data: XML Sample Response - Getting Classification
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etC lassification_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etC lassification_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1"> <C lassificationResult> <C lassS chemeA ssetTy pe> <LipperId>60003333</LipperId> <Language>E nglish</Language> <C lassS chemeId>1671</C lassS chemeId> <C lassId>1690</C lassId> <C lassN ame>E quity G lobal E q S pecialist</C lassN ame> </C lassS chemeA ssetTy pe> </C lassificationResult> </G etC lassification_Response_1> </Body > </E nv elope>

Element LipperId Language ClassScheme Id ClassId ClassName

Description The asset's Lipper ID. The display language for the class scheme information. The numeric classification scheme ID for which the classification type represented in ClassId is valid. The numeric classification type ID. The name of the classification type.

19.4.11 Get Classifications (GetClassifications_1)

You can use the GetClassifications_1 method to retrieve all of the classification information for the given asset(s), including classification schemes and the corresponding classification types. A classification is a designation assigned to assets based on various characteristics of the assets. For example, Equity North America is a classification assigned to an asset. Classifications are organized into classification schemes. Lipper offers or tracks multiple classification schemes around the world. For example, Equity North America is a classification within the Lipper Global Classification scheme. The example below retrieves classification data for the asset with '60003333' LipperID as of 2009-03-27 and displayed in English language. XML Sample Request - Getting Classifications
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperF undamentals_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etA ssetDetailsA naly sisS P _1</A ction>

Lipper Details

385

<A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etC lassifications_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1"> <lipperIDs> <int>60003333</int> </lipperIDs> <language>E nglish</language> <dataDate>2009-03-27</dataDate> </G etC lassifications_Request_1> </Body > </E nv elope>

Paramet Description er lipperID language A list of one or more Lipper IDs for which data will be returned. The display language for the returned data.

dataDate The date for which a classification must be in effect in order to be returned. Note: Lipper automatically defaults to American English if the requested data is unavailable in the language specified in the language option. Assets can belong to one or more classification schemes and within each scheme, the asset is assigned a classification code. For example, "Lipper Global" is a classification scheme and a fund's Lipper Global scheme type can be any type that is valid for the Lipper Global scheme, such as "Equity North America" or "Equity Global". The response returns the classification information for the specified asset:

XML Sample Response - Getting Classifications

<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etA ssetDetailsA naly sisS P _1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etC lassifications_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1"> <C lassificationsResult> <C lassS chemeTy pe> <C lassS chemeId>1671</C lassS chemeId> <C lassS chemeC ode>U KO F F S H O RE </C lassS chemeC ode> <C lassS chemeN ame>Lipper U K O ffshore F und</C lassS chemeN ame> <Language>E nglish</Language> <C lassList> <C lassTy pe> <C lassId>1690</C lassId> <C lassN ame>E quity G lobal E q S pecialist</C lassN ame> <Language>E nglish</Language> </C lassTy pe> </C lassList> <LipperId>60003333</LipperId> </C lassS chemeTy pe> <C lassS chemeTy pe> <C lassS chemeId>3289</C lassS chemeId> <C lassS chemeC ode>LIP P E RITG </C lassS chemeC ode> <C lassS chemeN ame>Lipper Italian G eneral</C lassS chemeN ame> <Language>E nglish</Language> <C lassList> <C lassTy pe> <C lassId>3322</C lassId>

386

TRKD API Developer's Guide

<C lassN ame>E quity S ector N on-C y c C onsumer</C lassN ame> <Language>E nglish</Language> </C lassTy pe> </C lassList> <LipperId>60003333</LipperId> </C lassS chemeTy pe> ... <C lassS chemeTy pe> <C lassS chemeId>1784</C lassS chemeId> <C lassS chemeC ode>LIP P E RC H </C lassS chemeC ode> <C lassS chemeN ame>Lipper S chw eiz</C lassS chemeN ame> <Language>E nglish</Language> <C lassList> <C lassTy pe> <C lassId>10253</C lassId> <C lassN ame>E quity S ector P harma&amp;H ealth</C lassN ame> <Language>E nglish</Language> </C lassTy pe> </C lassList> <LipperId>60003333</LipperId> </C lassS chemeTy pe> </C lassificationsResult> </G etC lassifications_Response_1> </Body > </E nv elope>

Element ClassSchemeI d ClassSchemeC ode ClassSchemeN ame Language ClassList

Description The classification scheme's numeric ID. The classification scheme's numeric code. The name of the classification scheme. The display language for classification data. The asset's classification list for the classification scheme set in ClassSchemeName. Contains the following elements: ClassId - the classification type's numeric ID. ClassName - the name of the classification type. Language - the display language for classification data.

19.4.12 Get Cross Reference (GetCrossReference_1)

You can use the GetAssetDetailsAnalysisSP_1 method to retrieve the cross-reference information (asset identifier and Lipper ID) for the given cross-reference code. A cross-reference code is generally a unique identifier that is used to represent an asset. For example, ticker symbol or CUSIP, or ISIN are cross-reference codes. The example below retrieves the cross-reference information for the '1438' xRefID with 'KR5102563818' code and displayed in English language. XML Sample Request - Getting Cross Reference
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperF undamentals_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etC rossReference_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body >

Lipper Details

387

<G etC rossReference_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1"> <code>KR5102563818</code> <xRefID>1438</xRefID> <language>E nglish</language> </G etC rossReference_Request_1> </Body > </E nv elope>

Paramet Description er code xRefID language An asset's alphabetic cross-reference code. Cross-reference data will be returned for this asset based on the code. An asset can have many codes because each of the asset identifiers has its own code. The numeric cross-reference ID. The display language for the returned cross-reference data.

Note: Lipper automatically defaults to American English if the requested data is unavailable in the language specified in the language option. Note: This method returns cross-reference information for only one cross-reference code. To retrieve information for more than one code, use the CrossReferenceBulk_1 method. The response returns the cross-reference information for the given code: XML Sample Response - Getting Cross Reference
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etC rossReference_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etC rossReference_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1"> <C rossReferenceResult> <LipperId>65028707</LipperId> <C rossReferenceList> <C rossReferenceItemV alue> <Language>E nglish</Language> <XrefId>1438</XrefId> <ReferenceC ode>KO RE A </ReferenceC ode> <C odeS hortN ame>Korea C ode</C odeS hortN ame> <C odeF ullN ame>Korea C ode</C odeF ullN ame> <XrefV alue>KR5102563818</XrefV alue> </C rossReferenceItemV alue> </C rossReferenceList> </C rossReferenceResult> </G etC rossReference_Response_1> </Body > </E nv elope>

Element Description LipperId The asset's Lipper ID. CrossReferenc The asset's list of cross-reference codes. Contains the following elements: eList Language - the display language for the cross-reference information. XrefId - the numeric Cross-reference ID. ReferenceCode - the alphabetic cross-reference code (e.g., the five-character symbol for a NASDAQ cross-reference). CodeShortName - the cross-reference short name (e.g., NASDAQ Ticker). CodeFullName - the full name of the cross-reference. XrefValue - the value for the cross reference code.

388

TRKD API Developer's Guide

19.4.13 Get Cross Reference Bulk (GetCrossReferenceBulk_1)

You can use the GetCrossReferenceBulk_1 method to retrieve the cross-reference information (asset identifier and Lipper ID) for the given cross-reference codes. A cross-reference code is generally a unique identifier that is used to represent an asset. For example, ticker symbol or CUSIP, or ISIN are cross-reference codes. The example below retrieves the cross-reference information displayed in English language for the specified cross-reference codes. XML Sample Request - Getting Cross Reference Bulk
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperF undamentals_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etC rossReferenceBulk_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etC rossReferenceBulk_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1"> <codes> <string>4JG A 1E </string> <string>KR5102563818</string> <string>1060678</string> </codes> <xRefID>1438</xRefID> <language>E nglish</language> </G etC rossReferenceBulk_Request_1> </Body > </E nv elope>

Paramet Description er codes xRefID language An asset's alphabetic cross-reference code. Cross-reference data will be returned for this asset based on the code. An asset can have many codes because each of the asset's asset identifiers has its own code. The numeric cross-reference ID. The display language for the returned cross-reference data.

Note: Lipper automatically defaults to American English if the requested data is unavailable in the language specified in the language option. The response returns the cross-reference information for the given codes: XML Sample Response - Getting Cross Reference Bulk
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etC rossReferenceBulk_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etC rossReferenceBulk_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1"> <C rossReferenceBulkResult>

Lipper Details

389

<C rossReferenceTy pe> <LipperId>65028707</LipperId> <C rossReferenceList> <C rossReferenceItemV alue> <Language>E nglish</Language> <XrefId>1438</XrefId> <ReferenceC ode>KO RE A </ReferenceC ode> <C odeS hortN ame>Korea C ode</C odeS hortN ame> <C odeF ullN ame>Korea C ode</C odeF ullN ame> <XrefV alue>KR5102563818</XrefV alue> </C rossReferenceItemV alue> </C rossReferenceList> </C rossReferenceTy pe> </C rossReferenceBulkResult> </G etC rossReferenceBulk_Response_1> </Body > </E nv elope>

Element Description LipperId The asset's Lipper ID. CrossReferenc The asset's list of cross-reference codes. Contains the following elements: eList Language - the display language for the cross-reference information. XrefId - the numeric Cross-reference ID. ReferenceCode - the alphabetic cross-reference code (e.g., the five-character symbol for a NASDAQ cross-reference). CodeShortName - the cross-reference short name (e.g., NASDAQ Ticker). CodeFullName - the full name of the cross-reference. XrefValue - the value for the cross reference code.

19.4.14 Get Cross Reference By Identifier Type (GetCrossReferenceByIdentifierType_2)

You can use the GetCrossReferenceByIdentifierType_2 method to retrieve all of the available cross-reference codes (including CUSIP, ISIN, and NASDAQ, among others) based on the identifier type filter to which the Lipper IDs for the given asset(s) map. A cross reference code is generally a unique identifier that is used to represent an asset. For example, ticker symbol or CUSIP, or ISIN are cross reference codes. Note: The GetCrossReferenceByIdentifierType_2 method requires at least 1 XREF Code and validates whether the user has access to the specified XREF code. The example below gets cross-reference codes for the assets with '65028707' and '60003333' LipperIDs based on the '1438' identifier type and displayed in English language. XML Sample Request - Getting Cross Reference By Identifier Type
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperF undamentals_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etC rossReferenceBy IdentifierTy pe_2</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etC rossReferenceBy IdentifierTy pe_Request_2 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/ LipperF undamentals_1"> <lipperIDs> <int>65028707</int> <int>60003333</int> </lipperIDs> <language>E nglish</language>

390

TRKD API Developer's Guide

<identifierTy peF ilter> <int>1438</int> </identifierTy peF ilter> </G etC rossReferenceBy IdentifierTy pe_Request_2> </Body > </E nv elope>

Parameter lipperID language

Description A unique eight- or nine-digit number that identifies an asset. The display currency for the returned cross-reference data.

identifierTypeFi The identifier type filter. lter Note: Lipper automatically defaults to American English if the requested data is unavailable in the language specified in the language option. The response returns the cross-reference codes for the given asset(s): XML Sample Response - Getting Cross Reference By Identifier Type
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etC rossReferenceBy IdentifierTy pe_2_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etC rossReferenceBy IdentifierTy pe_Response_2 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/ LipperF undamentals_1"> <C rossReferenceBy IdentifierTy peResult> <C rossReferenceTy pe> <LipperId>65028707</LipperId> <C rossReferenceList> <C rossReferenceItemV alue> <Language>E nglish</Language> <XrefId>1438</XrefId> <ReferenceC ode>KO RE A </ReferenceC ode> <C odeS hortN ame>Korea C ode</C odeS hortN ame> <C odeF ullN ame>Korea C ode</C odeF ullN ame> <XrefV alue>KR5102563818</XrefV alue> </C rossReferenceItemV alue> </C rossReferenceList> </C rossReferenceTy pe> </C rossReferenceBy IdentifierTy peResult> </G etC rossReferenceBy IdentifierTy pe_Response_2> </Body > </E nv elope>

Element Description LipperId The asset's Lipper ID. CrossReferenc The asset's list of cross-reference codes. Contains the following elements: eList Language - the display language for the cross-reference information. XrefId - the numeric Cross-reference ID. ReferenceCode - the alphabetic cross-reference code (e.g., the five-character symbol for a NASDAQ cross-reference). CodeShortName - the cross-reference short name (e.g., NASDAQ Ticker). CodeFullName - the full name of the cross-reference. XrefValue - the value for the cross reference code.

Lipper Details

391

19.4.15 Get Cross Reference To Lipper Id (GetCrossReferenceToLipperId_1)

You can use the GetCrossReferenceToLipperId_1 method to retrieve the Lipper ID for the given asset identifier (i.e., CUSIP, ISIN, etc.). A cross reference code is generally a unique identifier that is used to represent an asset. For example, ticker symbol or CUSIP, or ISIN are cross reference codes. The example below gets Lipper ID for the 'KR102563818' asset identifier: XML Sample Request - Getting Cross Reference To Lipper Id
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperF undamentals_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etC rossReferenceToLipperId_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > G etC rossReferenceToLipperId_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1" xmlns: xsi="http://w w w .w 3.org/2001/XM LS chema-instance"> <code>KR5102563818</code> <language>E nglish</language> </G etC rossReferenceToLipperId_Request_1> </Body > </E nv elope>

Paramet Description er code language The asset identifier code. The display language for the returned data.

Note: Lipper automatically defaults to American English if the requested data is unavailable in the language specified in the language option. The response returns Lipper ID for the specified asset identifier: XML Sample Response - Getting Cross Reference To Lipper Id
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etC rossReferenceToLipperId_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > G etC rossReferenceToLipperId_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1"> <C rossReferenceToLipperIdResult> <S earchResultTy pe> <LipperId>65028707</LipperId> <Language>E nglish</Language> <A ssetN ame>H ana U BS F C LG E lec / S amsung F ire Deriv ativ es 1</A ssetN ame> <Domicile>Korea (Republic of)</Domicile> <A ssetC ategory >M utual F unds</A ssetC ategory > <P romoter>H ana U BS A sset</P romoter>

392

TRKD API Developer's Guide

<A dministrator>H S BC F und S erv ice</A dministrator> </S earchResultTy pe> </C rossReferenceToLipperIdResult> </G etC rossReferenceToLipperId_Response_1> </Body > </E nv elope>

Element LipperId Language

Description The asset's Lipper ID. The display language for the asset identity information. Asset identity is the information used to characterize the fund such as LipperID or fund name. AssetName The asset's name. Domicile The asset's domicile. AssetCatego The asset's category. Asset Category identifies the universe that the asset belongs to, such as, mutual fund, ry indices, exchange traded fund, etc. Promoter The asset's promoter's name. A promoter is the company responsible for promoting the fund. Administrato The asset's administrator's name. The administrator provides back office support and compliance services to r the fund.

19.4.16 Get Distribution (GetDistribution_1)

You can use the GetDistribution_1 method to retrieve distribution data for the given asset(s). If distribution data is returned for a fund then the fund distributes income as opposed to accumulating income. The example below gets the latest available distribution data for the asset with '65028707' LipperID: XML Sample Request - Getting Distribution
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperF undamentals_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etDistribution_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etDistribution_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1"> <lipperIDs> <int>65028707</int> </lipperIDs> <latestO nly >true</latestO nly > </G etDistribution_Request_1> </Body > </E nv elope>

Paramet Description er lipperID A unique eight- or nine-digit number that identifies an asset. latestOnly If set to true then only the latest available data will be returned without any previous data. Note: The income that is generated from an investment trust is given to investors through monthly or quarterly distributions. In this manner, distributions are similar to stock dividends; however, they usually offer much higher yields of up to 10% a year. The distributions received reduces a trust's taxable income, therefore, little or no income tax is paid. The response returns the distribution data for the specified asset:

Lipper Details

393

XML Sample Response - Getting Distribution

<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etDistribution_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etDistribution_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1"> <DistributionResult> <DistributionTy pe> <LipperId>65028707</LipperId> <DistributionList> <DistributionItem> <DataDate>2007-04-24</DataDate> <C urrency C ode>KRW</C urrency C ode> <DistributionV alue>0</DistributionV alue> <Reinv estmentDate>2007-04-24</Reinv estmentDate> <P ay mentDate>2007-04-24</P ay mentDate> <M axDate>2007-04-24</M axDate> <TaxO peration xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <TaxableInterestIncome xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <IncomeO peration>P A ID</IncomeO peration> </DistributionItem> </DistributionList> </DistributionTy pe> </DistributionResult> </G etDistribution_Response_1> </Body > </E nv elope>

Element Description LipperId The asset's Lipper ID. Distribution The fund's distribution list. Contains the following elements: List DataDate - the date of the distribution. CurrencyCode - the currency of the distribution. DistributionValue - the amount of the distribution. ReinvestmentDate - the date on which reinvestible dividends were reinvested in the fund. PaymentDate - the payment date, which is the date the distribution payment is made available to the investors. MaxDate - the date at which distribution expires. TaxOperation - the tax operation. Tax operation refers to whether the distribution was Paid or Retained (or null) which matters for certain tax bodies such as the European Union. TaxableInterestIncome - the taxable interest income amount. Distributions paid by a fund from interest received from taxable securities in its portfolio, net of fund expenses. Interest income is taxable at the highest marginal income tax rate. IncomeOperation - the income operation. The income operation value indicates whether the dividend is paid to the investor (PAID), retained and automatically reinvested by the fund (RETAINED), the fund is interest paying fund, or distribution is not applicable (e.g., Currencies).

19.4.17 Get Dividend Details (GetDividendDetails_1)

You can use the GetDividendDetails_1 method to retrieve the dividend details for the given asset(s). "Dividend" is a portion of a company's generated income (expressed in local currency) distributed to investors on a per share basis. The example below gets dividend details with previous data for the asset with '65028707' LipperID: XML Sample Request - Getting Dividend Details

394

TRKD API Developer's Guide

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperF undamentals_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etDiv idendDetails_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etDiv idendDetails_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1"> <lipperIDs> <int>65028707</int> </lipperIDs> <latestO nly >false</latestO nly > </G etDiv idendDetails_Request_1> </Body > </E nv elope>

Paramet Description er lipperID A unique eight- or nine-digit number that identifies an asset. latestOnly If set to true then only the latest available data will be returned without any previous data. The response returns the dividend details for the specified asset: XML Sample Response - Getting Dividend Details
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etDiv idendDetails_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etDiv idendDetails_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1"> <Div idendDetailsResult> <Div idendTy pe> <LipperId>65028707</LipperId> <Div idendList> <Div idendItem> <Div idendTy peId xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <XDDate>2007-04-24</XDDate> <V alue>0</V alue> <C urrency C ode>KRW</C urrency C ode> <RecordDate>2007-04-24</RecordDate> <P ay mentDate>2007-04-24</P ay mentDate> <IncomeO peration>P A ID</IncomeO peration> <TaxableInterestIncome xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <M axDate>2007-04-24</M axDate> </Div idendItem> </Div idendList> </Div idendTy pe> </Div idendDetailsResult> </G etDiv idendDetails_Response_1> </Body > </E nv elope>

Element Description LipperId The asset's Lipper ID.

Lipper Details

395

DividendLi The fund's dividend list. Contains the following elements: st DividendTypeId - the numeric dividend Type ID. XDDate - the ex-dividend date, which is the date the security will begin trading without its dividence. If an investor buys a dividend-paying security before its ex-dividend date, the investor will receive the dividend. The ex-dividend date is the second business day before the record date. CurrencyCode - the currency of the dividend payment. RecordDate - the record date, which is the date a company will examine its records to find out who are the its shareholders. An investor must be listed as a holder of record on this date to ensure the right of a dividend payment. PaymentDate - the payment date, which is the date the dividend payment is made available to the investors. IncomeOperation - the income operation. The income operation value indicates whether the dividend is paid to the investor (PAID), retained and automatically reinvested by the fund (RETAINED), the fund is interest paying fund, or distribution is not applicable (e.g., Currencies). TaxableInterestIncome - the taxable interest income. Distributions paid by a fund from interest received from taxable securities in its portfolio, net of fund expenses. Interest income is taxable at the highest marginal income tax rate. MaxDate - the maximum date.

19.4.18 Get Dividends Per Year (GetDividendsPerYear_1)

You can use the GetDividendsPerYear_1 method to retrieve the number of times per year that the given asset(s) is expected to pay dividends. The example below gets number of times the asset with '65028707' LipperID is expected to pay dividends: XML Sample Request - Getting Dividends Per Year
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperF undamentals_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etDiv idendsP erYear_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etDiv idendsP erYear_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1"> <lipperIDs> <int>65028707</int> </lipperIDs> </G etDiv idendsP erYear_Request_1> </Body > </E nv elope>

Paramet Description er lipperID A unique eight- or nine-digit number that identifies an asset.

The response returns the number of times the asset with '65028707' LipperID is expected to pay dividends: XML Sample Response - Getting Dividends Per Year
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etDiv idendsP erYear_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore />

396

TRKD API Developer's Guide

</C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etDiv idendsP erYear_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1"> <Div idendsP erYearResult> <V alueN umberTy pe> <LipperId>65028707</LipperId> <V alue>1</V alue> </V alueN umberTy pe> </Div idendsP erYearResult> </G etDiv idendsP erYear_Response_1> </Body > </E nv elope>

Elemen Description t LipperId The asset's Lipper ID. Value The value showing the number of times the specified asset is expected to pay dividends per year.

19.4.19 Get Domiciles (GetDomiciles_1)

You can use the GetDomiciles_1 method to retrieve the domicile details, such as domicile name and code, for the given asset (s). A domicile is the jurisdiction under which a fund is legally incorporated. The example below gets domiciles details for the assets with '60003333' and '60003331' LipperIDs displayed in English language. XML Sample Request - Getting Domiciles
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperF undamentals_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etDomiciles_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etDomiciles_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1"> <lipperIDs> <int>60003333</int> <int>60003331</int> </lipperIDs> <language>E nglish</language> </G etDomiciles_Request_1> </Body > </E nv elope>

Paramet Description er lipperID language A unique eight- or nine-digit number that identifies an asset. The display language for the returned data.

Note: Lipper automatically defaults to American English if the requested data is unavailable in the language specified in the language option. The response returns the domicile details for the specified assets:

Lipper Details

397

XML Sample Response - Getting Domiciles

<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etDomiciles_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etDomiciles_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1"> <DomicilesResult> <DomicileTy pe> <LipperId>60003333</LipperId> <Language>E nglish</Language> <DomicileId>310</DomicileId> <DomicileC ode>DU B</DomicileC ode> <DomicileN ame>Dublin</DomicileN ame> </DomicileTy pe> <DomicileTy pe> <LipperId>60003331</LipperId> <Language>E nglish</Language> <DomicileId>310</DomicileId> <DomicileC ode>DU B</DomicileC ode> <DomicileN ame>Dublin</DomicileN ame> </DomicileTy pe> </DomicilesResult> </G etDomiciles_Response_1> </Body > </E nv elope>

Element LipperId Language DomicileId DomicileCod e DomicileNa me

Description The asset's Lipper ID. The display language for the domicile information. The numerical Domicile ID (e.g., 345) that represents the asset's domicile. The alphabetic Domicile Code (e.g., GBR) that represents the asset's domicile. The name of the domicile.

19.4.20 Get EU Tax Directive (GetEUTaxDirective_1)

You can use the GetEUTaxDirective_1 method to retrieve EU tax directive information for the given asset(s). The EU Tax Directive applies only to bank interest, bond interest, and analogous income, such as income from bond funds, money-market funds, loans and mortgages. The example below gets EU tax directive data for the asset with '60003333' LipperID displayed in English language: XML Sample Request - Getting EU Tax Directive
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperF undamentals_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etE U TaxDirectiv e_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization>

398

TRKD API Developer's Guide

</H eader> <Body > <G etE U TaxDirectiv e_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1"> <lipperIDs> <int>60003333</int> </lipperIDs> <language>E nglish</language> </G etE U TaxDirectiv e_Request_1> </Body > </E nv elope>

Paramet Description er lipperID language A unique eight- or nine-digit number that identifies an asset. The display language for the returned data.

Note: Lipper automatically defaults to American English if the requested data is unavailable in the language specified in the language option. The response returns the EU tax directive information for the specified assets: XML Sample Response - Getting EU Tax Directive
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etE U TaxDirectiv e_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etE U TaxDirectiv e_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1"> <E U TaxDirectiv eResult> <E U TaxDirectiv eTy pe> <LipperId>60003333</LipperId> <Language>E nglish</Language> <S tartDate>2001-04-30</S tartDate> <E ndDate>2002-04-30</E ndDate> <Directiv eS tatus>O ut of S cope</Directiv eS tatus> <Directiv e15P ercentThreshold>false</Directiv e15P ercentThreshold> <Directiv e40P ercentThreshold>false</Directiv e40P ercentThreshold> <N onG randfatheredH oldings xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <P rospectus_V s_A ssetA llocation>false</P rospectus_V s_A ssetA llocation> <N av TIIA >false</N av TIIA > <Div idendTIIA >false</Div idendTIIA > <KG Ty peF unds>false</KG Ty peF unds> <S w issF undsE xBankA ffidav it>false</S w issF undsE xBankA ffidav it> </E U TaxDirectiv eTy pe> </E U TaxDirectiv eResult> </G etE U TaxDirectiv e_Response_1> </Body > </E nv elope>

Element LipperId Language StartDate EndDate DirectiveStatus

Description The asset's Lipper ID. The display language for the EU tax directive information. The start date of the EU tax directive information. The end date of the EU tax directive information. The asset's EU tax directive status. EU Tax Directive Status refers to the scope of the Tax Directive for example, a fund may be declared in-scope taxable and based on the fund domiciles specific legislation, a tax will be levied.

Lipper Details

399

Directive15PercentT hreshold Directive40PercentT hreshold NonGrandfatheredH oldings Prospectus_Vs_Asse tAllocation NavTIIA

A flag that indicates if this fund invests less than (or equal to) 15% of the fund's assets in debt claims with non-grandfathered status. A flag that indicates if this fund invests less than (or equal to) 40% of the fund's assets in debt claims with non-grandfathered status. The percentage of this fund's assets invested in debt claims with non-grandfathered status. A value indicating whether [prospectus_ VS_ asset allocation].

A flag that indicates if the fund is calculating the amount of taxable interest income within the daily net asset value (NAV). DividendTIIA A flag that indicates if the fund is calculating the amount of taxable interest income per dividend distribution. KGTypeFunds A value indicating whether [KG type funds]. SwissFundsExBankA A value indicating whether [swiss funds ex bank affidavit]. ffidavit

19.4.21 Get Flags (GetFlags_1)

You can use the GetFlags_1 method to retrieve the available flags for the given asset(s). A flag's value is either true or false. There are a large number of flags available in the Lipper database, but not all flags apply for all assets. A flag represents an attribute that Lipper has assigned to the asset. The example below gets all flags for the asset with '60003333' LipperID displayed in English language: XML Sample Request - Getting Flags
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperF undamentals_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etF lags_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etF lags_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1"> <lipperIDs> <int>60003333</int> </lipperIDs> <language>E nglish</language> </G etF lags_Request_1> </Body > </E nv elope>

Paramet Description er lipperID language A unique eight- or nine-digit number that identifies an asset. The display language for the returned data.

Note: Lipper automatically defaults to American English if the requested data is unavailable in the language specified in the language option. The response returns all of the flags for the specified asset: XML Sample Response - Getting Flags
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing">

400

TRKD API Developer's Guide

<s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/G etF lags_1_Reply </a: A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etF lags_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1"> <F lagsResult> <F lagTy pe> <LipperId>60003333</LipperId> <Language>E nglish</Language> <F lagList> <F lagItem> <F lagId>1340</F lagId> <F lagN ame>H edged</F lagN ame> <F lagC ode>Y</F lagC ode> <F lagV alue>Yes</F lagV alue> </F lagItem> <F lagItem> <F lagId>1350</F lagId> <F lagN ame>U C ITS </F lagN ame> <F lagC ode>Y</F lagC ode> <F lagV alue>Yes</F lagV alue> </F lagItem> ... <F lagItem> <F lagId>5400</F lagId> <F lagN ame>S G - S ophisticated F und</F lagN ame> <F lagC ode>Y</F lagC ode> <F lagV alue>Yes</F lagV alue> </F lagItem> </F lagList> </F lagTy pe> </F lagsResult> </G etF lags_Response_1> </Body > </E nv elope>

Elemen t LipperId Languag e FlagList

Description The asset's Lipper ID. The display language for the flag list. The asset's list of flags and values. A flag represents an attribute that Lipper has assigned to the asset. Contains the following elements: FlagId - the numeric flag ID. FlagName - the name of the flag. FlagCode - the alphabetic flag code. FlagValue - the flag value, which is either Yes or No. If the value of this flag is yes, then the fund is listed on an exchange.

19.4.22 Get IPO Info (GetIPOInfo_1)

You can use the GetIPOInfo_1 method to retrieve Initial Public Offering (IPO) data, such as IPO date and value, for the given asset(s). IPO - Initial Public Offering is when a company issues company's stock or shares to the public or interested investors. The example below gets IPO data for the asset with '60003333' LipperID expressed in US dollars and displayed in English language. XML Sample Request - Getting IPO Information

Lipper Details

401

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperF undamentals_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etIP O Info_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etIP O Info_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1"> <lipperIDs> <int>60003333</int> </lipperIDs> </G etIP O Info_Request_1> </Body > </E nv elope>

Paramet Description er lipperID A unique eight- or nine-digit number that identifies an asset.

The response returns IPO information for the specified asset ('60003333'): XML Sample Response - Getting IPO Information
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/G etIP O Info_1_Reply </ a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etIP O Info_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1"> <IP O InfoResult> <IP O InfoTy pe> <LipperId>60003333</LipperId> <LaunchDate>2000-03-31</LaunchDate> <C urrency C ode>E U R</C urrency C ode> <IP O V alue>10</IP O V alue> <IP O Date>2000-03-31</IP O Date> <N av >10</N av > <Bid xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <O ffer xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <M id xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> </IP O InfoTy pe> </IP O InfoResult> </G etIP O Info_Response_1> </Body > </E nv elope>

Element LipperId LaunchDate CurrencyCo de IPOValue IPODate

Description The asset's Lipper ID. The fund's launch date, which is the date that the subscription period for the fund ends. The currency of the fund's base IPO currency. The share value of the fund on the IPO date. The date of the fund's IPO.

402

TRKD API Developer's Guide

Nav Bid Offer Mid

The share value at the fund's first valuation with any shareholders. The Bid value, which is the first pricing of the fund after the subscription period is over minus the fund's redemption fees. The launch offer, which is the first pricing of the fund after the subscription period is over plus the fund's initial sales charge. The fund's first mid pricing after the subscription period is over (i.e., the mid-point between the bid and the offer).

19.4.23 Get Legal Structure (GetLegalStructure_1)

You can use the GetLegalStructure_1 method to retrieve information about the legal structure (name, code, and ID) to which the given assets conform. A legal structure is an attribute of the asset and represents the way the asset has been formed for operation. The example below gets legal structure information in English language for the asset with '60003333' LipperID. XML Sample Request - Getting Legal Structure
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperF undamentals_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etLegalS tructure_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etLegalS tructure_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1"> <lipperIDs> <int>60003333</int> </lipperIDs> <language>E nglish</language> </G etLegalS tructure_Request_1> </Body > </E nv elope>

Paramet Description er lipperID language A unique eight- or nine-digit number that identifies an asset. The display language for the returned data.

Note: Lipper automatically defaults to American English if the requested data is unavailable in the language specified in the language option. The response returns legal structure data for the specified asset ('60003333'): XML Sample Response - Getting Legal Structure
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etLegalS tructure_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader>

Lipper Details

403

<s:Body > <G etLegalS tructure_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1"> <LegalS tructureResult> <LegalS tructureTy pe> <LipperId>60003333</LipperId> <Language>E nglish</Language> <LegalS tructureId>1129</LegalS tructureId> <LegalS tructureC ode>V C IC </LegalS tructureC ode> <LegalS tructureN ame>IC V C </LegalS tructureN ame> </LegalS tructureTy pe> </LegalS tructureResult> </G etLegalS tructure_Response_1> </Body > </E nv elope>

Element LipperId Language LegalStuctureI d LegalStuctureC ode LegalStuctureN ame

Description The asset's Lipper ID. The display language for the legal structure information. The legal structure numeric ID. The legal structure alphabetic code. The name of the legal structure.

19.4.24 Get Lipper Leader Scores (GetLipperLeaderScores_1)

You can use the GetLipperLeaderScores_1 method to retrieve Lipper Leader Scores for the given asset(s) based on the universe and data date. The example below gets Lipper Leader Scores for the asset with '60087648' LipperID based on 'INTL' universe and the specified date: XML Sample Request - Getting Lipper Leader Scores
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperF undamentals_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etLipperLeaderS cores_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etLipperLeaderS cores_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1"> <lipperIDs> <int>60087648</int> </lipperIDs> <univ erseC ode>IN TL</univ erseC ode> <dataDate>2009-03-27T00:00:00Z</dataDate> </G etLipperLeaderS cores_Request_1> </Body > </E nv elope>

Paramete r lipperID universeCo de

Description A unique eight- or nine-digit number that identifies an asset. The code that represents the Universe, for which the Lipper Leader Scores will be returned. For the list of available Universes, see the Universe Enumeration section in the Lipper Data Enumerations chapter.

404

TRKD API Developer's Guide

dataDate

The date for which Lipper Leader score data will be returned.

Note: Lipper Leader Scores are derived from highly sophisticated formulas that analyze funds against clearly defined criteria. Funds are compared to similar funds, and only those that truly stand out are awarded Lipper Leader status. There are five Lipper Leader Score Categories: Consistent Return, Expense, Preservation, Tax Efficiency, and Total Return. For each of these categories, there are three year, five year, ten year, and overall scores. Funds are rated on a numeric sale of 5 to 1; 5 represents funds with the highest rating, and 1 represents the lowest rating. The response returns Lipper Leader Scores for the specified asset: XML Sample Response - Getting Lipper Leader Scores
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etLipperLeaderS cores_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etLipperLeaderS cores_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1"> <LipperLeaderS coresResult> <LipperLeaderS coresTy pe> <LipperId>60087648</LipperId> <P ublishedDate xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <DataDate>2005-03-31</DataDate> <LipperLeaderU niv erseId>5680</LipperLeaderU niv erseId> <C onsistentReturnO v erallS core>5</C onsistentReturnO v erallS core> <C onsistentReturnC ount>10035</C onsistentReturnC ount> <C onsistentReturn3y rS core>5</C onsistentReturn3y rS core> <C onsistentReturn3y rC ount>10035</C onsistentReturn3y rC ount> <C onsistentReturn5y rS core xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <C onsistentReturn5y rC ount>5871</C onsistentReturn5y rC ount> <C onsistentReturn10y rS core xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <C onsistentReturn10y rC ount>1780</C onsistentReturn10y rC ount> <E xpenseO v erallS core xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <E xpenseC ount xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <E xpense3y rS core xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <E xpense3y rC ount xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <E xpense5y rS core xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <E xpense5y rC ount xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <E xpense10y rS core xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <E xpense10y rC ount xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <P reserv ationO v erallS core>3</P reserv ationO v erallS core> <P reserv ationC ount>10194</P reserv ationC ount> <P reserv ation3y rS core>3</P reserv ation3y rS core> <P reserv ation3y rC ount>10194</P reserv ation3y rC ount> <P reserv ation5y rS core>3</P reserv ation5y rS core> <P reserv ation5y rC ount>6049</P reserv ation5y rC ount> <P reserv ation10y rS core xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <P reserv ation10y rC ount>1922</P reserv ation10y rC ount> <TaxE fficiency C ount xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <TaxE fficiency O v erallS core xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <TaxE fficiency 3y rS core xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <TaxE fficiency 3y rC ount xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <TaxE fficiency 5y rS core xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <TaxE fficiency 5y rC ount xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <TaxE fficiency 10y rS core xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <TaxE fficiency 10y rC ount xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <TotalReturnO v erallS core>5</TotalReturnO v erallS core> <TotalReturnC ount>10035</TotalReturnC ount> <TotalReturn3y rS core>5</TotalReturn3y rS core> <TotalReturn3y rC ount>10035</TotalReturn3y rC ount> <TotalReturn5y rS core xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <TotalReturn5y rC ount>5871</TotalReturn5y rC ount> <TotalReturn10y rS core xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <TotalReturn10y rC ount>1780</TotalReturn10y rC ount> </LipperLeaderS coresTy pe> </LipperLeaderS coresResult>

Lipper Details

405

</G etLipperLeaderS cores_Response_1> </Body > </E nv elope>

Element LipperId PublishedDate DataDate LipperUniverseId ConsistentRetur nOverallScore ConsistentRetur nCount ConsistentRetur n3yrScore ConsistentRetur n3yrCount ConsistentRetur n5yrScore ConsistentRetur n5yrCount ConsistentRetur n10yrScore ConsistentRetur n10yrCount ExpenseOverallS core ExpenseCount Expense3yrScor e Expense3yrCou nt Expense5yrScor e Expense5yrCou nt Expense10yrSco re Expense10yrCo unt PreservationOve rallScore PreservationCou nt Preservation3yr Score Preservation3yr Count Preservation5yr Score Preservation5yr Count Preservation10y rScore Preservation10y rCount TaxEfficiencyCo

Description The asset's Lipper ID. The date the Lipper Leader Score was published. The date for which data will be returned. The Universe ID for which the Lipper Leader score is applicable. The Consistent Return overall score. The Consistent Return count. The Consistent Return 3 Year score. The Consistent Return 3 Year count. The Consistent Return 5 Year score. The Consistent Return 5 Year count. The Consistent Return 10 Year score. The Consistent Return 10 Year count. The Expense overall score. The Expense count. The Expense 3 Year score. The Expense 3 Year count. The Expense 5 Year score. The Expense 5 Year count. The Expense 10 Year score. The Expense 10 Year count. The Preservation overall score. The Preservation count. The Preservation 3 Year score. The Preservation 3 Year count. The Preservation 5 Year score. The Preservation 5 Year count. The Preservation 10 Year score. The Preservation 10 Year count. The Tax Efficiency count.

406

TRKD API Developer's Guide

unt TaxEfficiencyOv erallScore TaxEfficiency3yr Score TaxEfficiency3yr Count TaxEfficiency5yr Score TaxEfficiency5yr Count TaxEfficiency10 yrScore TaxEfficiency10 yrCount TotalReturnOver allScore TotalReturnCou nt TotalReturn3yrS core TotalReturn3yrC ount TotalReturn5yrS core TotalReturn5yrC ount TotalReturn10yr Score TotalReturn10yr Count

The Tax Efficiency overall score. The Tax Efficiency 3 Year score. The Tax Efficiency 3 Year count. The Tax Efficiency 5 Year score. The Tax Efficiency 5 Year count. The Tax Efficiency 10 Year score. The Tax Efficiency 10 Year count. The Total Return overall score. The Total Return count. The Total Return 3 Year score. The Total Return 3 Year count. The Total Return 5 Year score. The Total Return 5 Year count. The Total Return 10 Year score. The Total Return 10 Year count.

1. The Lipper Rating for Consistent Return identifies a fund that has provided relatively superior consistency and risk-adjusted returns when compared to a group of similar funds. 2. The Lipper Rating for Expense identifies a fund that has successfully managed to keep its expenses low relative to its peers and within its load structure. 3. Preservation is a fund that has demonstrated a superior ability to preserve capital in a variety of markets when compared with other funds in its asset class. 4. Tax Efficiency identifies a fund that has been successful at deferring taxes over the measurement period relative to similar funds. 5. Total Return denotes a fund that has provided superior total returns (income from dividends and interest as well as capital appreciation) when compared to a group of similar funds.

19.4.25 Get Minimum Investment (GetMinimumInvestment_1)

You can use the GetMinimumInvestment_1 method to retrieve minimum investment data for the given asset(s). Minimum investment data includes minimum regular investment, minimum irregular investment, minimum investment, and minimum initial share investment. The example below gets minimum investment information for the asset with '60003333' LipperID: XML Sample Request - Getting Minimum Investment
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperF undamentals_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etM inimumInv estment_1</A ction>

Lipper Details

407

<A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etM inimumInv estment_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1"> <lipperIDs> <int>60003333</int> </lipperIDs> </G etM inimumInv estment_Request_1> </Body > </E nv elope>

Paramet Description er lipperID A unique eight- or nine-digit number that identifies an asset.

The response returns the minimum investment information for the specified asset ('60003333'): XML Sample Response - Getting Minimum Investment
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etM inimumInv estment_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etM inimumInv estment_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1"> <M inimumInv estmentResult> <M inimumInv estmentTy pe> <LipperId>60003333</LipperId> <Language>E nglish</Language> <S tartDate xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <E ndDate xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <C urrency C ode>E U R</C urrency C ode> <N ame>Janus G lobal Life S ciences E U R A A cc</N ame> <M inimumInv estmentTy peId>0</M inimumInv estmentTy peId> <M inimumInv estmentInitial>2500</M inimumInv estmentInitial> <M inimumInv estmentRegular xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <M inimumInv estmentIRRegular>100</M inimumInv estmentIRRegular> <M inimumInv estmentInitialS hare xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> </M inimumInv estmentTy pe> </M inimumInv estmentResult> </G etM inimumInv estment_Response_1> </Body > </E nv elope>

Element LipperId Language StartDate EndDate CurrencyCode Name MinimumInvestment TypeId MinimumInvestment TypeInitial

Description The asset's Lipper ID. The display language for the minimum investment data. The minimum investment start date. The minimum investment end date. The currency code of the currency in which the minimum investment data is expressed. The name of the asset. This is a simple numeric reference identifier used to identify various minimum investment types available through the service. The minimum initial investment amount.

408

TRKD API Developer's Guide

MinimumInvestment TypeRegular MinimumInvestment TypeIRRegular MinimumInvestment TypeInitialShare

The minimum amount of investment that can be accepted on a regular basis, such as to be part of a regular savings plan. The minimum number of shares or currency amount that investors can subsequently invest in the fund (on an ad hoc basis) after purchasing initial shares. The minimum initial share investment amount.

19.4.26 Get Newly Available Funds by RFS (GetNewlyAvailableFundsByRfs_1)

You can use the GetNewlyAvailableFundsByRfs_1 method to retrieve the asset(s) that are new to the Lipper database for the specified country since the given inception date. The example below gets new funds in English language added since the specified inception date: XML Sample Request - Getting Newly Available Funds by RFS
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperF undamentals_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etN ew ly A v ailableF undsBy Rfs_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etN ew ly A v ailableF undsBy Rfs_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1"> <language>E nglish</language> <inceptionDate>2011-01-12T00:00:00</inceptionDate> <rfs>N one</rfs> </G etN ew ly A v ailableF undsBy Rfs_Request_1> </Body > </E nv elope>

Parameter language inceptionDate rfs

Description The language for the displayed asset. The date when asset was added to the Lipper database. The country code for which new assets were added. See section Countries Enumeration in the Lipper Data Enumerations chapter for the full list of available country codes.

Note: Lipper automatically defaults to American English if the requested data is unavailable in the language specified in the language option. The response returns he asset(s) that are new to the Lipper database since the given inception date: XML Sample Response - Getting Newly Available Funds by RFS
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etN ew ly A v ailableF undsBy Rfs_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etN ew ly A v ailableF undsBy Rfs_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1"> <N ew ly A v ailableF undsBy RfsResult>

Lipper Details

409

<A ssetIdentity Ty pe> <LipperId>68082043</LipperId> <Language>E nglish</Language> <N ame>A llianz V olatility S trategy - IT - E U R</N ame> </A ssetIdentity Ty pe> <A ssetIdentity Ty pe> <LipperId>68078223</LipperId> <Language>E nglish</Language> <N ame>Bualuang Thanarat 1/11</N ame> </A ssetIdentity Ty pe> ... </N ew ly A v ailableF undsBy RfsResult> </G etN ew ly A v ailableF undsBy Rfs_Response_1> </Body > </E nv elope>

Element LipperId Language Name

Description The asset's Lipper ID. The display language for the asset identity information. The full name of the asset.

19.4.27 Get Registered Countries Of Sale (GetRegisteredCountriesOfSale_1)

You can use the GetRegisteredCountriesOfSale_1 method to retrieve a list of the countries where the given assets are registered for sale. The example below gets a list of countries displayed in English language for the asset with '60003333' LipperID: XML Sample Request - Getting Registered Countries Of Sale
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperF undamentals_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etRegisteredC ountriesO fS ale_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etRegisteredC ountriesO fS ale_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1"> <lipperIDs> <int>60003333</int> </lipperIDs> <language>E nglish</language> </G etRegisteredC ountriesO fS ale_Request_1> </Body > </E nv elope>

Paramet Description er lipperID language A unique eight- or nine-digit number that identifies an asset. The display language for the returned data.

Note: Lipper automatically defaults to American English if the requested data is unavailable in the language specified in the language option. The response returns the registered for sale information for the specified asset ('60003333'): XML Sample Response - Getting Registered Countries Of Sale

410

TRKD API Developer's Guide

<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etRegisteredC ountriesO fS ale_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etRegisteredC ountriesO fS ale_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1"> <RegisteredC ountriesO fS aleResult> <RegisteredC ountry O fS aleTy pe> <LipperId>60003333</LipperId> <C ountry List> <C ountry Ty pe> <C ountry Id>796</C ountry Id> <Language>E nglish</Language> <C ountry N ame>A ustria</C ountry N ame> <C ountry C ode>A U T</C ountry C ode> </C ountry Ty pe> <C ountry Ty pe> <C ountry Id>1004</C ountry Id> <Language>E nglish</Language> <C ountry N ame>U nited Kingdom</C ountry N ame> <C ountry C ode>G BR</C ountry C ode> </C ountry Ty pe> ... <C ountry Ty pe> <C ountry Id>988</C ountry Id> <Language>E nglish</Language> <C ountry N ame>Taiw an</C ountry N ame> <C ountry C ode>TWN </C ountry C ode> </C ountry Ty pe> <C ountry Ty pe> <C ountry Id>803</C ountry Id> <Language>E nglish</Language> <C ountry N ame>Belgium</C ountry N ame> <C ountry C ode>BE L</C ountry C ode> </C ountry Ty pe> </C ountry List> </RegisteredC ountry O fS aleTy pe> </RegisteredC ountriesO fS aleResult> </G etRegisteredC ountriesO fS ale_Response_1> </Body > </E nv elope>

Element Description LipperId The asset's Lipper ID. CountryLis The list of countries where the asset is registered for sale. Contains the following elements: t CountryId - the country's numerical Country ID. Language - the display language for the country information. CountryName - the name of the country. CountryCode - the alphabetic country code.

19.4.28 Get Registered Country Of Sale (GetRegisteredCountryOfSale_1)

You can use the GetRegisteredCountryOfSale_1 method to retrieve a flag that tells whether the given asset(s) is registered for sale in the given country. The example below gets a flag showing whether the asset with '60003333' LipperID is registered for sale in France: XML Sample Request - Getting Registered Country Of Sale
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope">

Lipper Details

411

<H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperF undamentals_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etRegisteredC ountry O fS ale_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etRegisteredC ountry O fS ale_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1"> <lipperIDs> <int>60003333</int> </lipperIDs> <country C ode>F RA </country C ode> </G etRegisteredC ountry O fS ale_Request_1> </Body > </E nv elope>

Paramet Description er lipperID A unique eight- or nine-digit number that identifies an asset. countryCo The country code that represents the country that is being validated. This method will determine whether the de given lipperID is for sale in this country. For full listing of available country codes, see section Countries Enumeration in the Lipper Data Enumerations chapter. The response returns a flag that indicates whether the given assets are registered for sale country represented by countryCode: XML Sample Response - Getting Registered Country Of Sale
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etRegisteredC ountry O fS ale_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etRegisteredC ountry O fS ale_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1"> <RegisteredC ountry O fS aleResult> <V alidationTy pe> <LipperId>60003333</LipperId> <IsV alid>true</IsV alid> </V alidationTy pe> </RegisteredC ountry O fS aleResult> </G etRegisteredC ountry O fS ale_Response_1> </Body > </E nv elope>

Elemen Description t LipperId The Lipper ID for the asset's benchmark fund. IsValid The flag indicating whether this instance is true or false.

19.4.29 Get Support Company (GetSupportCompany_1)

You can use the GetSupportCompany_1 method to retrieve company information for the given asset(s) and company role.

412

TRKD API Developer's Guide

The example below gets company information in English language for the assets with '60003333' and '65028707' LipperIDs for the 'Administrator' company role alongside with contact information. XML Sample Request - Getting Support Company
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperF undamentals_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etS upportC ompany _1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etS upportC ompany _Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1"> <lipperIDs> <int>60003333</int> <int>65028707</int> </lipperIDs> <language>E nglish</language> <company Role>A dministrator</company Role> <prov ideC ontactInformation>true</prov ideC ontactInformation> </G etS upportC ompany _Request_1> </Body > </E nv elope>

Parameter lipperID language companyRole

Description A unique eight- or nine-digit number that identifies an asset. The display language for the returned data. The company role for which support company information will be returned. A support company can have the following roles: Administrator: the name of the company identified as the administrator, who provides back office support and compliance services to the fund. This may include maintaining financial records, furnishing statistical and research data, providing data processing, etc. Custodian: the name of the company responsible for holding the assets (securities) of the mutual fund. Insurer: the name of the Insurance Company that is marketing a variable product. Portfolio Manager: the company responsible for managing the portfolio of investments on behalf of the fund manager. Promoter: the company responsible for the marketing of the fund. It is usually the name of this company that is prefixed to the name of the fund. Investment Advisor: the company responsible for actually managing the investment of the available funds. Sub-Advisor: an entity that assists in the operation of the fund by providing services on behalf of the Investment Advisor.

provideContactI If true contact information (phone number, address, etc.) for the company will be returned; if false, the nformation contact information will not be included in the results. Note: Lipper automatically defaults to American English if the requested data is unavailable in the language specified in the language option. The response returns the company information for the specified assets and company role: XML Sample Response - Getting Support Company
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etS upportC ompany _1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema">

Lipper Details

413

<Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etS upportC ompany _Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1"> <S upportC ompany Result> <S upportC ompany Ty pe> <Language>E nglish</Language> <C ompany Id>1272526</C ompany Id> <C ompany F ullN ame>C iti F und S erv ices (Ireland) Ltd</C ompany F ullN ame> <LipperId>60003333</LipperId> <C ompany C ode>105626158</C ompany C ode> <C ompany S hortN ame>C iti F und S erv ices Ltd</C ompany S hortN ame> <BusinessN ame>F inance</BusinessN ame> <C ontactInformation> <A ddressLine1>Brooklaw n H ouse,</A ddressLine1> <A ddressLine2>C rampton A v enue /</A ddressLine2> <A ddressLine3>S hellbourne Road,</A ddressLine3> <A ddressLine4>Ballsbridge, Dublin 4</A ddressLine4> <Telephone>+353 1 637 6300</Telephone> <F ax>+353 1 637 6400</F ax> <WebsiteU rl> <F ragment/> <H ost>w w w .transactionserv ices.citigroup.com</H ost> <P assw ord/> <P ath>/</P ath> <P ort>80</P ort> <Q uery /> <S cheme>http</S cheme> <U serN ame/> </WebsiteU rl> <U rl>http://w w w .transactionserv ices.citigroup.com/</U rl> <H ost>w w w .transactionserv ices.citigroup.com</H ost> </C ontactInformation> </S upportC ompany Ty pe> ... </S upportC ompany Result> </G etS upportC ompany _Response_1> </Body > </E nv elope>

Element Language CompanyId CompanyFullNa me LipperId CompanyCode CompanyShort Name BusinessName ContactInform ation

Description The display language for the company information. The company's numeric ID. The full name of the company. The asset's Lipper ID. The company's alphabetic code. The short name of the company. The type of business in which the company engages. The company's contact information.

19.4.30 Get Top Performers (GetTopPerformers_1)

You can use the GetTopPerformers_1 method to retrieve the given country's best or top-performing funds. The example below gets the top-performing funds for the USA expressed in US dollars and displayed in English language. The request is also configured to retrieve only 10 best funds and include hedge funds in the results. XML Sample Request - Getting Top Performers

414

TRKD API Developer's Guide

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperF undamentals_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etTopP erformers_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > G etTopP erformers_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1"> <country C ode> <C ountries>U S A </C ountries> </country C ode> <currency C ode>U S D</currency C ode> <numberO fA ssets>10</numberO fA ssets> <language>E nglish</language> <includeH edgeF unds>true</includeH edgeF unds> </G etTopP erformers_Request_1> </Body > </E nv elope>

Parameter Countries currencyCode

Description The country for which the best performing funds should be returned. For full listing of available country codes, see section Countries Enumeration in the Lipper Data Enumerations chapter. The display currency for the returned list. For full listing of available currency codes, see section Currency Code Enumeration in the Lipper Data Enumerations chapter. The display language for the returned data.

numberOfAssets The number of funds that should be included in the list of poorest performers. language includeHedgeFu If true, hedge funds will be included in the returned list of best performing funds; otherwise, hedge funds nds will not be included in the results. Hedge funds are investment funds open to a limited range of investors. A hedge fund allows more investment and trading activities than other investment funds and an investor pays a special performance fee to its investment manager. Note: Lipper automatically defaults to American English if the requested data is unavailable in the language specified in the language option. The response returns a list of <PerformerType> elements that contain the top-performing funds: XML Sample Response - Getting Top Performers
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etTopP erformers_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etTopP erformers_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1"> <TopP erformersResult> <P erformerTy pe> <C ountry C ode>U S A </C ountry C ode> <P erformerList> <P erformerItem> <LipperId>60047781</LipperId> <Language>E nglish</Language> <F undS hortN ame>Russian O pps Ltd</F undS hortN ame> <P erfYTD>106.611</P erfYTD> </P erformerItem>

Lipper Details

415

<P erformerItem> <LipperId>40035798</LipperId> <Language>E nglish</Language> <F undS hortN ame>Drey fus G reatr C hina;I</F undS hortN ame> <P erfYTD>86.12433</P erfYTD> </P erformerItem> ... <P erformerItem> <LipperId>40106105</LipperId> <Language>E nglish</Language> <F undS hortN ame>O ld M utual:C F C hina;I</F undS hortN ame> <P erfYTD>79.53796</P erfYTD> </P erformerItem> </P erformerList> </P erformerTy pe> </TopP erformersResult> </G etTopP erformers_Response_1> </Body > </E nv elope>

Element Description CountryCo The country code that represents the country to which the performance list pertains. de PerformerLi The list of the country's fund performance data. Contains the following elements: st LipperId - the asset's Lipper ID. Language - the display language for the fund performance data. FundShortName - the fund's short name. PerfYTD - the asset's year-to-date performance value.

19.4.31 Get Top Performers By Classification Scheme (GetTopPerformersByClassificationScheme_1)

You can use the GetTopPerformersByClassificationScheme_1 method to retrieve the top, or best-performing funds (based on year-to-date performance) for the given classification scheme. A classification is a designation assigned to assets based on various characteristics of the assets. For example, Equity North America is a classification assigned to an asset. Classifications are organized into classification schemes. Lipper offers or tracks multiple classification schemes around the world. For example, Equity North America is a classification within the Lipper Global Classification scheme. The example below retrieves 10 best funds for the 'ABILIFE2008' classification scheme expressed in US dollars and displayed in English language. XML Sample Request - Getting Top Performers By Classification Scheme
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperF undamentals_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etTopP erformersBy C lassificationS cheme_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etTopP erformersBy C lassificationS cheme_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/ LipperF undamentals_1"> <classificationS chemeC ode>A BILIF E 2008</classificationS chemeC ode> <language>E nglish</language> <currency C ode>U S D</currency C ode> <numberO fC lasses>10</numberO fC lasses> <calculationP eriodN ame> <C alculationTy peId>O neM onthP erformancetoLastM onthE nd</C alculationTy peId> </calculationP eriodN ame>

416

TRKD API Developer's Guide

</G etTopP erformersBy C lassificationS cheme_Request_1> </Body > </E nv elope>

Parameter

Description

classificationSch The classification scheme for which best-performing funds should be returned. See the list of available emeCode classification schemes in the Classification Scheme Enumeration section in the Lipper Data Enumerations chapter. language currencyCode The display language for the returned list. The display currency for the returned data. For full listing of available currency codes, see section Currency Code Enumeration in the Lipper Data Enumerations chapter.

numberOfClasse The number of classes to include in the search results. s calculationPeriod One or more calculation periods for which performance data will be returned. Contains <CalculationTypeId> element that represents a static performance calculation supported by Lipper. For full listing of available calculation typeIDs, see section Calculation TypeId Enumeration in the Lipper Data Enumerations chapter. Note: The GetTopPerformersByClassificationScheme_1 operation works as desired only if a single <CalculationTypeId> is specified though declared as multiple in the schema. Note: Lipper automatically defaults to American English if the requested data is unavailable in the language specified in the language option. The response returns performance data for the given classification scheme and time period: XML Sample Response - Getting Top Performers By Classification Scheme
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etTopP erformersBy C lassificationS cheme_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etTopP erformersBy C lassificationS cheme_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/ LipperF undamentals_1"> <TopP erformersBy C lassificationS chemeResult> <C lassificationS chemeC ode>A BILIF E 2008</C lassificationS chemeC ode> <C lassificationS chemeN ame>A BI Life S cheme</C lassificationS chemeN ame> <Language>E nglish</Language> <C alculationList> <P erformanceC alculation> <Language>E nglish</Language> <C alculationP eriodN ame>1 M onth P erformance to Last M onth E nd</C alculationP eriodN ame> <C alculationA crony m>1mP erf:</C alculationA crony m> <A sO fDate>2009-03-31T00:00:00</A sO fDate> <P erformerList> <P erformerC alculationItem> <IndexIdentity > <LipperId>19074032</LipperId> <Language>E nglish</Language> <N ame>A BI U K - C ommodity /E nergy -Life</N ame> </IndexIdentity > <C lassId>28992</C lassId> <Language>E nglish</Language> <V alue>11.796210</V alue> </P erformerC alculationItem> <P erformerC alculationItem> <IndexIdentity > <LipperId>19074016</LipperId> <Language>E nglish</Language>

Lipper Details

417

<N ame>A BI U K - G lobal E merging M arkets E q-Life</N ame> </IndexIdentity > <C lassId>28976</C lassId> <Language>E nglish</Language> <V alue>11.103360</V alue> </P erformerC alculationItem> ... <P erformerC alculationItem> <IndexIdentity > <LipperId>19074010</LipperId> <Language>E nglish</Language> <N ame>A BI U K - E urope inc U K E quities-Life</N ame> </IndexIdentity > <C lassId>28970</C lassId> <Language>E nglish</Language> <V alue>3.289920</V alue> </P erformerC alculationItem> </P erformerList> </P erformanceC alculation> </C alculationList> </TopP erformersBy C lassificationS chemeResult> </G etTopP erformersBy C lassificationS cheme_Response_1> </Body > </E nv elope>

Element ClassificationScheme Code ClassificationScheme Name Language CalculationList

Description The classification type's ID. The name of the classification scheme. The display language for the asset identity information. The performance calculation data. Contains the following elements: Language - the display language for the asset identity information. CalculationPeriodName - the name of the performance calculation period. CalculationAcronym - the calculation acronym. AsOfDate - the date for which the retrieved data is valid. PerformerList - the performer value. A list of <PerformerCalculationItem> elements. Contains the following elements: Index Identity - the asset identity (LipperId, Language and Name). C lassId - the class ID. Language - the display language for the performance calculation data. Value - the value of the performance calculation.

19.4.32 Get Top Performers By LG Classification Schema (GetTopPerformersByLGClassificationSchema_1)

You can use the GetTopPerformersByLGClassificationSchema_1 method to retrieve the top or best-performing funds (based on year-to-date performance) for one or more Lipper Global Classification Schemas. Lipper Fund Classifications Lipper fund classifications provide the ability to make meaningful 'like for like' comparisons across funds with similar investment mandates. Choose from style based holdings classifications; proprietary fund association local market schemes; or take a much broader approach by using the Lipper Global Classification which encompasses all funds tracked by Lipper. The example below retrieves 10 best funds for the 'LipperGlobal' classification schema expressed in US dollars and displayed in English language: XML Sample Request - Getting Top Performers By LG Classification Schema
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperF undamentals_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/

418

TRKD API Developer's Guide

G etTopP erformersBy LG C lassificationS chema_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etTopP erformersBy LG C lassificationS chema_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/ LipperF undamentals_1"> <lG C lassificationS chemaN ame> <LG C lassificationS chema>LipperG lobal</LG C lassificationS chema> </lG C lassificationS chemaN ame> <currency C ode>U S D</currency C ode> <language>E nglish</language> <numberO fA ssets>10</numberO fA ssets> </G etTopP erformersBy LG C lassificationS chema_Request_1> </Body > </E nv elope>

Parameter

Description

lGClassificationS The Lipper Global Classification schema for which top-performing funds should be returned. Available chemaName Lipper Global Classification schemes are listed in the LG Classification Scheme Enumeration section in the Lipper Data Enumerations chapter. currencyCode language The display currency for the returned data. For full listing of available currency codes, see section Currency Code Enumeration in the Lipper Data Enumerations chapter. The display language for the returned data.

numberOfAssets The number of top-performing assets to be returned. Note: Lipper automatically defaults to American English if the requested data is unavailable in the language specified in the language option. The response returns the best-performing funds for the given Lipper Classification Schema: XML Sample Response - Getting Top Performers By LG Classification Schema
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etTopP erformersBy LG C lassificationS chema_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etTopP erformersBy LG C lassificationS chema_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/ LipperF undamentals_1"> <TopP erformersBy LG C lassificationS chemaResult> <LG P erformerTy pe> <LG C lassificationS chemeN ame>LipperG lobal</LG C lassificationS chemeN ame> <LG P erformerList> <LG P erformerItem> <LipperId>65011402</LipperId> <Language>E nglish</Language> <F undS hortN ame>N ordea S aasto 25 Tuotto</F undS hortN ame> <P erfYTD>268.1287</P erfYTD> </LG P erformerItem> <LG P erformerItem> <LipperId>63500563</LipperId> <Language>E nglish</Language> <F undS hortN ame>Inv esco G reatw all Dom Demd G th</F undS hortN ame> <P erfYTD>191.7876</P erfYTD> </LG P erformerItem> ... <LG P erformerItem> <LipperId>63500860</LipperId> <Language>E nglish</Language>

Lipper Details

419

<F undS hortN ame>Industrial Trend Inv estment H y </F undS hortN ame> <P erfYTD>169.0458</P erfYTD> </LG P erformerItem> </LG P erformerList> </LG P erformerTy pe> </TopP erformersBy LG C lassificationS chemaResult> </G etTopP erformersBy LG C lassificationS chema_Response_1> </Body > </E nv elope>

Element Description LGClassificationSche The Lipper Global Classification Scheme name. meName LGPerformerList The list of funds. Contains the following elements: LipperId - the asset's Lipper ID. Language - the display language for the data. FundShortName - the short name of the asset. PerfYTD - the fund's year-to-date performance.

19.4.33 Get Total Net Asset By Period Advanced (GetTotalNetAssetByPeriodAdvanced_1)

You can use the GetTotalNetAssetByPeriodAdvanced_1 method to retrieve a detailed list of the Total Net Asset (TNA) values for the specified period for the given asset(s). TNA stands for Total Net Asset or the total funds under management, expressed in millions in currency of the fund. Note: The GetTotalNetAssetByPeriodAdvanced_1 method provides 2 years of monthly Total Net Assets while GetTotalNetAssetByPeriodBasic_1 - only the latest TNAs. The example below gets detailed list of all available TNA values expressed in US dollars for the specified period for the assets with '60003333' and '60003331' LipperIDs: XML Sample Request - Getting Total Net Asset By Period Advanced
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperF undamentals_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etTotalN etA ssetBy P eriodA dv anced_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etTotalN etA ssetBy P eriodA dv anced_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/ LipperF undamentals_1"> <lipperIDs> <int>60003333</int> <int>60003331</int> </lipperIDs> <currency C ode>U S D</currency C ode> <beginDate>2009-01-01</beginDate> <endDate>2009-03-03</endDate> <latestO nly >false</latestO nly > </G etTotalN etA ssetBy P eriodA dv anced_Request_1> </Body > </E nv elope>

Paramete Description r

420

TRKD API Developer's Guide

lipperID currencyCo de beginDate endDate latestOnly

A unique eight- or nine-digit number that identifies an asset. The display currency for returned TNA values. For full listing of available currency codes, see section Currency Code Enumeration in the Lipper Data Enumerations chapter. The begin date of the specified period. The end date of the specified period. If set to true then only data for the most recently available date will be returned. If false then all available TNA data will be returned.

The response returns a detailed list of all available TNA values for the specified period for the specified assets: XML Sample Response - Getting Total Net Asset By Period Advanced
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etTotalN etA ssetBy P eriodA dv anced_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etTotalN etA ssetBy P eriodA dv anced_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/ LipperF undamentals_1"> <TotalN etA ssetBy P eriodResult> <TotalN etA ssetTy pe> <LipperId>60003333</LipperId> <TotalN etA ssetList> <TotalN etA ssetItem> <DataDate>2009-01-30</DataDate> <C urrency C ode>U S D</C urrency C ode> <TotalN etA ssets>25997631.23237</TotalN etA ssets> <TotalN etA ssetsInM illions>25.9976312</TotalN etA ssetsInM illions> </TotalN etA ssetItem> <TotalN etA ssetItem> <DataDate>2009-02-27</DataDate> <C urrency C ode>U S D</C urrency C ode> <TotalN etA ssets>22260226.19184</TotalN etA ssets> <TotalN etA ssetsInM illions>22.2602262</TotalN etA ssetsInM illions> </TotalN etA ssetItem> </TotalN etA ssetList> </TotalN etA ssetTy pe> <TotalN etA ssetTy pe> <LipperId>60003331</LipperId> <TotalN etA ssetList> <TotalN etA ssetItem> <DataDate>2009-01-30</DataDate> <C urrency C ode>U S D</C urrency C ode> <TotalN etA ssets>7339300</TotalN etA ssets> <TotalN etA ssetsInM illions>7.3393</TotalN etA ssetsInM illions> </TotalN etA ssetItem> <TotalN etA ssetItem> <DataDate>2009-02-27</DataDate> <C urrency C ode>U S D</C urrency C ode> <TotalN etA ssets>7536600</TotalN etA ssets> <TotalN etA ssetsInM illions>7.5366</TotalN etA ssetsInM illions> </TotalN etA ssetItem> </TotalN etA ssetList> </TotalN etA ssetTy pe> </TotalN etA ssetBy P eriodResult> </G etTotalN etA ssetBy P eriodA dv anced_Response_1> </Body > </E nv elope>

Element Description LipperId The asset's Lipper ID. TotalnetAsset The list of TNA values for the specified asset. Contains the following elements:

Lipper Details

421

List

DataDate - the date for which the TNA value is valid. CurrencyCode - the currency code that represents the currency for the TNA value. TotalNetAssets - the TNA value for the stated data date. TotalNetAssetsInMillions - the TNA value in millions for the stated data date.

19.4.34 Get Total Net Asset By Period Basic (GetTotalNetAssetByPeriodBasic_1)

You can use the GetTotalNetAssetByPeriodBasic_1 method to retrieve a basic list of the Total Net Asset (TNA) values for the specified period for the given asset(s). Note: The GetTotalNetAssetByPeriodBasic_1 method provides only the latest Total Net Assets while GetTotalNetAssetByPeriodAdvanced_1 - two years of monthly TNAs. The example below gets list of TNA values expressed in US dollars for the specified period for the assets with '60003333' and '60003331' LipperIDs: XML Sample Request - Getting Total Net Asset By Period Basic
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperF undamentals_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etTotalN etA ssetBy P eriodBasic_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etTotalN etA ssetBy P eriodBasic_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1"> <lipperIDs> <int>60003333</int> <int>60003331</int> </lipperIDs> <currency C ode>U S D</currency C ode> <beginDate>2009-01-01</beginDate> <endDate>2009-03-03</endDate> </G etTotalN etA ssetBy P eriodBasic_Request_1> </Body > </E nv elope>

Paramete Description r lipperID A unique eight- or nine-digit number that identifies an asset. currencyCo The display currency for returned TNA values. For full listing of available currency codes, see section Currency de Code Enumeration in the Lipper Data Enumerations chapter. beginDate endDate The begin date of the specified period. The end date of the specified period.

The response returns a list of basic TNA values for the specified period for the specified assets: XML Sample Response - Getting Total Net Asset By Period Basic
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etTotalN etA ssetBy P eriodBasic_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo>

422

TRKD API Developer's Guide

</s:H eader> <s:Body > <G etTotalN etA ssetBy P eriodBasic_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1"> <TotalN etA ssetBy P eriodResult> <TotalN etA ssetTy pe> <LipperId>60003331</LipperId> <TotalN etA ssetList> <TotalN etA ssetItem> <DataDate>2009-02-27</DataDate> <C urrency C ode>U S D</C urrency C ode> <TotalN etA ssets>7536600</TotalN etA ssets> <TotalN etA ssetsInM illions>7.5366</TotalN etA ssetsInM illions> </TotalN etA ssetItem> </TotalN etA ssetList> </TotalN etA ssetTy pe> <TotalN etA ssetTy pe> <LipperId>60003333</LipperId> <TotalN etA ssetList> <TotalN etA ssetItem> <DataDate>2009-02-27</DataDate> <C urrency C ode>U S D</C urrency C ode> <TotalN etA ssets>22260226.19184</TotalN etA ssets> <TotalN etA ssetsInM illions>22.2602262</TotalN etA ssetsInM illions> </TotalN etA ssetItem> </TotalN etA ssetList> </TotalN etA ssetTy pe> </TotalN etA ssetBy P eriodResult> </G etTotalN etA ssetBy P eriodBasic_Response_1> </Body > </E nv elope>

Element Description LipperId The asset's Lipper ID. TotalnetAsset The list of TNA values for the specified asset. Contains the following elements: List DataDate - the date for which the TNA value is valid. CurrencyCode - the currency code that represents the currency for the TNA value. TotalNetAssets - the TNA value for the stated data date. TotalNetAssetsInMillions - the TNA value in millions for the stated data date.

19.5

Lipper Data Enumerations

This chapter provides reference information on Lipper data that can be requested/retrieved by making requests using Lipper services.

19.5.1 Allocation Enumeration

The table below lists available allocations and their descriptions: Allocati Description on Asset Asset allocation shows the percentage of the portfolio's assets invested in Cash, Common Stock, Preferred Stock, Convertible, Bonds, Other, and Fund (if a fund of a fund). Exchang e Currency Currency allocation shows the percentage of the portfolio's assets invested in each currency. DebtorQ Quality allocation displays the percentage of the portfolio's assets invested in the quality ratings (e.g., Gov't/AAA, uality AA, A, BBB, NR, etc). EquityQu Equity Quality. ality EquityCo Equity Country. untry EquityRe Equity Region. gion

Lipper Details

423

FixedInc omeCoun try FixedInc omeRegi on ICB Region FTSEInd ustrySec tor Capitalis ation Country Maturity

Fixed Income Country.

Fixed Income Region.

Industry Classification Benchmark. Region. FTSE Industry Sector Allocation shows the percentage of the portfolio's assets invested in each sector.

Top10Hol dings DebtorD omicile AssetAllo cationEle ctronic All All shows all types of allocation for the portfolio.

Capitalisation allocation shows the portfolio's current price multiplied by the number of outstanding shares. Shows the corporate size of a stock. Country allocation shows the percentage of the portfolio's assets invested in each country, based on company domicile. Maturity allocation shows the percentage of the portfolio's assets invested in a specified maturity range (e.g., < 1 year, 1-3 years, 3-5 years, 5-10 years, 10-20 years, 20-30 years, > 30 years, equity/other). The Top 10 Holdings allocation shows the portfolio's top ten holdings with the greatest asset weighting (by % TNA). Debtor Domicile allocation shows the percentage of the portfolio's fixed-income assets allocated to each country of debtor domicile. Asset Allocation Electronic.

19.5.2 Countries Enumeration

The table below lists available country codes and their descriptions: Country Code None AND AUS AUT ARG ANT ARE BEL BHS BHR BMU BRB BGR BRA CAN CHE CHL CHN COK CYM CYP CZE Description None Andorra Australia Austria Argentina Netherlands Antilles United Arab Emirates Belgium Bahamas Bahrain Bermuda Barbados Bulgaria Brazil Canada Switzerland Chile China Cook Islands Cayman Islands Cyprus Czech Republic

424

TRKD API Developer's Guide

DEU DNK DUB ESP EST EXTAIWAN FIN FRA GBR GIB GRC GGY HKG HUN HFF IDN IND IMN IRL ISL ITA ISR INTL JPN JEY KWT KOR LAT LBN LIE LTU LIT LVA LUX MAC MCO MLT MUS MYS MEX NLD NZL NOR OMN OFFSHORE PAN PER PHL POL PRI PRT QAT SAU

Germany Denmark Dublin Spain Estonia Taiwan De-Authorised Finland France United Kingdom Gibraltar Greece Guernsey Hong Kong Hungary Hedge Fund Indonesia India Isle of Man Ireland Iceland Italy Israel International Japan Jersey Kuwait Korea, Republic Of Latvia Lebanon Liechtenstein Lithuania Lithuania Latvia Luxembourg Macau Monaco Malta Mauritius Malaysia Mexico Netherlands New Zealand Norway Oman Offshore Fund Panama Peru Philippines Poland Puerto Rico Portugal Qatar Saudi Arabia

Lipper Details

425

SGP SVK SVN ZAF SWE THA TTO TUR TWN USA USAFI VUT VGB AUR NZD CAD JOR MAR PAK TUN VNM EGY USAEQ BWA PRK RUS SWZ

Singapore Slovakia (Slovak Republic) Slovenia ZAF (South Africa) Sweden Thailand Trinidad and Tobago Turkey Taiwan United States USA Fixed Income Vanuatu The British Virgin Islands Aurum Mining Funds New Zealand Dollars Canadian Dollars Jordan Morocco Pakistan Tunisia Vietnam Egypt USA Equity Botswana North Korea Russian Federation Swaziland

19.5.3 Currency Code Enumeration

The table below lists available currency codes and their descriptions: Currency Code GBX GBP USD AUD BEF CAD NLG FRF HKD DKK ITL DEM NZD CHF JPY IEP PTE ESP NOK Description British Penny Sterling British Pound United States Dollar Australian Dollar Belgian Franc Canadian Dollar Dutch Guilder French Franc Hong Kong Dollars Danish Krone Italian Lira German Mark New Zealand Dollar Swiss Franc Japanese Yen Irish Pound Portuguese Escudo Spanish Peseta Norwegian Kroner

426

TRKD API Developer's Guide

SEK ATS SGD XEU IRUP ZAR MYR THB MXN LC FIM ARS BRL GRD IDR IRR KWD LUF PHP SAR KRW TWD AED ILS TRY AFA ALL DZD ESPA AOA AMD AWG AZN BSD BHD BDT BBD BYR BZD XOF BMD BTN BOB BWP BND BUK BIF KHR XAF CISP CVE KYD CLP

Swedish Krona Austrian Schilling Singapore Dollar European Currency Unit IRUP (Indian Rupee) South African Rand Malaysian Ringgit Thai Baht Mexican Peso Local Currency Finnish Markka Argentine Peso Brazilian Real Greek Drachma Indonesian Rupiah Iranian Rial Kuwaiti Dinar Luxembourg Franc Philippine Peso Saudi Riyal Korean Won Taiwan Dollar United Arab Emirates Dirham Israeli New Shekel Turkish Lira Afghanistan Afghani Albanian Lek Algerian Dinar Spanish Espana Angolan Kwanza Armenia Dram Aruban Florin Azerbaijani Manat Bahamian Dollar Bahraini Dinar Bangladeshi Taka Barbadian Dollar Belarusian Ruble Belize Dollar CFA Franc BCEAO (West African CFA Franc) Bermudian Dollar Bhutan Ngultrum Bolivian Boliviano Botswana Pula Brunei Dollar Burmese Kyat Burundi Franc Kampuchean (Cambodian) Riel CFA Franc BEAC (Central African CFA Franc) CISP Cape Verde Escudo Cayman Islands Dollar Chilean Peso

Lipper Details

427

CNY COP KMF CRC HRK CUP CYP CZK DJF XCD DOP ECS EGP SVC MTL EEK ETB FKP FJD IQD GMD GHC GIP GTQ MRO MUR MDL FRF MNT MAD MZN NPR XDR ANG UAH NIC NGN OMR PKR PAB PGK PYG PEN PLN USDP QAR RON RWF SHP STD SCR SLL SKK

Chinese Yuan Renminbi Colombian Peso Comoros Franc Costa Rican Colon Croatain Kuna Cuban Peso Cyrprus Pound Czech Koruan Dijibouti Franc East Caribbean Dollar Dominican Peso Ecuador Sucre Egyptian Pound El Savador Colon Maltese Lira Estonian Kroon Ethiopian Birr Falkland Islands Pound Fiji Dollar Iraqi Dinar Gambian Dalasi Ghannaian Cedi Gibraltor Pound Guatemalan Quetzal Mauritanian Ouguiya Mauritius Rupee Moldavan Leu French Franc Mongolian Tugrik Moroccan Dirham Mozambique Meticais Nepalese Rupee International Monetary Fund Special Drawing Rights Netherlands Antillian Guilder Ukraine Hryvnia Nicaraguan Crdoba Nigerian Naira Oman Rial Pakistan Rupee Panamanian Balboa Papua New Guinea Kina Paraguay Gurani Peruvian Nuevo Sol Polish Zloty USDP Qatari Rial Romanian Leu Rwandan Franc St. Helena Pound Sao Tome and Principe Dobra Seychelles Rupee Sierra Leone Leone Slovak Koruna

428

TRKD API Developer's Guide

SIT SBD SOS LKR SDD SRD SZL SYP BGN TZS EUR TOP TTD TND UGX RUB INR RUR UYU VUV VEB VND USDB WST YER YUD ZRZ ZMK ZWD GNF GWP GYD HTG HNL HUF ISK JMD JOD KZT KES KPW LAK LVL LBP LSM LRD LYD CHFL LTL MOP MKD MGA MWK

Slovenian Tolar Solomon Islands Dollar Somali Schilling Sri Lanka Rupee Sudanese Dinar Suriname Dollar Swaziland Lilangeni Syrian Pound Bulgarian Lev Tanzanian Schilling European Union Euro Tongan Pa'anga Trinidad and Tobago Dollar Tunisian Dinar Uganda Shilling Russian Rouble Indian Rupee Russian Ruble (pre-1997) Uruguayan Peso Vanuatu Vatu Venezuelan Bolivar Vietnamese Dong USDB Samoan Tala Yemen Rials New Yugoslavian Dinar Zaureab Zaire Zambian Kwacha Zimbabwe Dollar Guinea Franc Guinea-Bissau Peso Guyanan Dollar Haitian Gourde Honduran Lempira Hungarian Forint Iceland Krona Jamaican Dollar Jordanian Dinar Kazakhstan Tenge Kenyan Schilling North Korean Won Lao Kip Latvian Lats Lebanese Pound Lesotho Maloti Liberian Dollar Libyan Dinar CHFL Lithuanian Litas Macau Pataca Macedonian Denar Malagasy Ariary Malawi Kwacha

Lipper Details

429

MVR MLF BAM CDF GEL KGS LSL NAD NIO RSD SRG UZS XPF TRL GHC SDG VEF None

Maldive Rufiyaa Mali Franc Bosnia and Herzegovina Convertible Mark Congolese Franc Georgian Lari Kyrgyzstanian Som Lesotho Loti Namibian Dollar Nicaraguan Cordoba Oro Serbian Dinar Suriname Guilder Uzbekistani Sum Comptoirs Franais du Pacifique Francs Turkish Lira Ghana Cedi Sudanese Pound Venezuelan Bolivar Fuerte None

19.5.4 Universe Enumeration

The table below lists available universe codes and their descriptions: Code INTL GBR CHE DEU FRA ITA HKG SGP MYS TWN THA JPN ESP AUT IND CHN GBRLF GBRPF USA KOR BEL HKPF NLD AUS FIN NOR SWE DNK CAN Description International Offshore United Kingdom Switzerland Germany France Italy Hong Kong Singapore Malaysia Taiwan Thailand Japan Spain Austria India China UK Life Assets UK Pension Assets United States Korea Belgium Hong Kong Pension Funds Netherlands Australia Finland Norway Sweden Denmark Canada

430

TRKD API Developer's Guide

LUX ESPPF ITAPF CZE POL SVK

Luxembourg Spain Pension Funds Italy Pension Funds Czech Republic Poland Slovakia

19.5.5 Calculation TypeId Enumeration

The table below lists available calculation type IDs and their descriptions: Calculation TypeID OneMonthPerformancetoLastM onthEnd ThreeMonthPerformancetoLast MonthEnd SixMonthPerformancetoLastMo nthEnd OneYearPerformancetoLastMon thEnd ThreeYearPerformancetoLastM onthEnd FiveYearPerformancetoLastMon thEnd TenYearPerformancetoLastMon thEnd YeartoMonthEndPerformance Best3MonthswithintheLast3Yea rstoLastMonthEnd Worst3MonthswithintheLast3Ye arstoLastMonthEnd Alphafor1YeartoLastMonthEnd Alphafor3YearstoLastMonthEnd Alphafor5YearstoLastMonthEnd Alphafor10YearstoLastMonthEn d Betafor1YeartoLastMonthEnd Betafor3YearstoLastMonthEnd Betafor5YearstoLastMonthEnd Betafor10YearstoLastMonthEnd RSquaredfor1YeartoLastMonth End RSquaredfor3YearstoLastMont hEnd RSquaredfor5YearstoLastMont hEnd RSquaredfor10YearstoLastMon thEnd RelativePerformancefor6Month stoLastMonthEnd RelativePerformancefor1Yearto LastMonthEnd RelativePerformancefor3Yearst oLastMonthEnd RelativePerformancefor5Yearst Description One Month Performance to Last Month End Three Month Performance to Last Month End Six Month Performance to Last Month End One Year Performance to Last Month End (the performance is calculated backward from last month for 1 year) Three Year Performance to Last Month End Five Year Performance to Last Month End Ten Year Performance to Last Month End Year to Month End Performance (the performance is calculated from Jan 1st to last month) Best 3 Months within the Last 3 Years to Last Month End Worst 3 Months within the Last 3 Years to Last Month End Alpha for1 Year to Last Month End Alpha for 3 Years to Last Month End Alpha for 5 Years to Last Month End Alpha for 10 Years to Last Month End Beta for 1 Year to Last Month End Beta for 3 Years to Last Month End Beta for 5 Years to Last Month End Beta for 10 Years to Last Month End R Squared for 1 Year to Last Month End R Squared for 3 Years to Last Month End R Squared for 5 Years to Last Month End R Squared for 10 Years to Last Month End Relative Performance for 6 Months to Last Month End Relative Performance for 1 Year to Last Month End Relative Performance for 3 Years to Last Month End Relative Performance for 5 Years to Last Month End

Lipper Details

431

oLastMonthEnd RelativePerformancefor10Years toLastMonthEnd StandardDeviationfor1YeartoLa stMonthEnd StandardDeviationfor3YearstoL astMonthEnd StandardDeviationfor5YearstoL astMonthEnd StandardDeviationfor10Yearsto LastMonthEnd SharpeRatiofor1YeartoLastMon thEnd SharpeRatiofor3YearstoLastMo nthEnd SharpeRatiofor5YearstoLastMo nthEnd SharpeRatiofor10YearstoLastM onthEnd InformationRatiofor1YeartoLast MonthEnd InformationRatiofor3YearstoLa stMonthEnd InformationRatiofor5YearstoLa stMonthEnd InformationRatiofor10YearstoL astMonthEnd ReturnRiskRatiofor1YeartoLast MonthEnd ReturnRiskRatiofor3YearstoLas tMonthEnd ReturnRiskRatiofor5YearstoLas tMonthEnd ReturnRiskRatiofor10YearstoLa stMonthEnd MaxDrawdownfor1YeartoLastM onthEnd MaxDrawdownfor3YearstoLast MonthEnd MaxDrawdownfor5YearstoLast MonthEnd MaxDrawdownfor10YearstoLas tMonthEnd TreynorRatiofor1YeartoLastMo nthEnd TreynorRatiofor3YearstoLastM onthEnd TreynorRatiofor5YearstoLastM onthEnd TreynorRatiofor10YearstoLast MonthEnd Correlationfor1YeartoLastMont hEnd Correlationfor3YearstoLastMon thEnd Correlationfor5YearstoLastMon thEnd Correlationfor10YearstoLastMo

Relative Performance for 10 Years to Last Month End Standard Deviation for 1 Year to Last Month End Standard Deviation for 3 Years to Last Month End Standard Deviation for 5 Years to Last Month End Standard Deviation for 10 Years to Last Month End Sharpe Ratio for 1 Year to Last Month End Sharpe Ratio for 3 Years to Last Month End Sharpe Ratio for 5 Years to Last Month End Sharpe Ratio for 10 Years to Last Month End Information Ratio for 1 Year to Last Month End Information Ratio for 3 Years to Last Month End Information Ratio for 5 Years to Last Month End Information Ratio for 10 Years to Last Month End Return Risk Ratio for 1 Year to Last Month End Return Risk Ratio for 3 Years to Last Month End Return Risk Ratio for 5 Years to Last Month End Return Risk Ratio for 10 Years to Last Month End Max Drawdown for 1 Year to Last Month End Max Drawdown for 3 Years to Last Month End Max Drawdown for 5 Years to Last Month End Max Drawdown for 10 Years to Last Month End Treynor Ratio for 1 Year to Last Month End Treynor Ratio for 3 Years to Last Month End Treynor Ratio for 5 Years to Last Month End Treynor Ratio for 10 Years to Last Month End Correlation for 1 Year to Last Month End Correlation for 3 Years to Last Month End Correlation for 5 Years to Last Month End Correlation for 10 Years to Last Month End

432

TRKD API Developer's Guide

nthEnd TrackingErrorfor1YeartoLastMo nthEnd TrackingErrorfor3YearstoLastM onthEnd TrackingErrorfor5YearstoLastM onthEnd TrackingErrorfor10YearstoLast MonthEnd RelativePerformancefor3Month stoLastMonthEnd RelativePerformancefor1Month toLastMonthEnd PerformanceFromInceptiontoLa stMonthEnd RelativePerformanceYeartoMon thEnd OneMonthIndexedPerformance toLastMonthEnd ThreeMonthIndexedPerformanc etoLastMonthEnd SixMonthIndexedPerformancet oLastMonthEnd OneYearIndexedPerformanceto LastMonthEnd ThreeYearIndexedPerformance toLastMonthEnd FiveYearIndexedPerformanceto LastMonthEnd TenYearIndexedPerformanceto LastMonthEnd OneMonth10KReinvestPerform ancetoLastMonthEnd ThreeMonth10KReinvestPerfor mancetoLastMonthEnd SixMonth10KReinvestPerforma ncetoLastMonthEnd OneYear10KReinvestPerforman cetoLastMonthEnd ThreeYear10KReinvestPerform ancetoLastMonthEnd FiveYear10KReinvestPerforman cetoLastMonthEnd TenYear10KReinvestPerforman cetoLastMonthEnd None

Tracking Error for 1 Year to Last Month End Tracking Error for 3 Years to Last Month End Tracking Error for 5 Years to Last Month End Tracking Error for 10 Years to Last Month End Relative Performance for 3 Months to Last Month End Relative Performance for 1 Month to Last Month End Performance From Inception to Last Month End Relative Performance Year to Month End OneMonthPerformancetoLastMonthEnd * 100 ThreeMonthPerformancetoLastMonthEnd * 100 SixMonthPerformancetoLastMonthEnd * 100 OneYearPerformancetoLastMonthEnd * 100 ThreeYearPerformancetoLastMonthEnd * 100 FiveYearPerformancetoLastMonthEnd * 100 TenYearPerformancetoLastMonthEnd * 100 OneMonthPerformancetoLastMonthEnd * 10000 ThreeMonthPerformancetoLastMonthEnd * 10000 SixMonthPerformancetoLastMonthEnd * 10000 OneYearPerformancetoLastMonthEnd * 10000 ThreeYearPerformancetoLastMonthEnd * 10000 FiveYearPerformancetoLastMonthEnd * 10000 TenYearPerformancetoLastMonthEnd * 10000 None

19.5.6 Classification Scheme Enumeration

The table below lists available classification schemes and their descriptions: Classification Scheme ABILIFE2008 ABIPEN2008 ABIUKLIFE ABIUKPENSION Description ABI Life Scheme ABI Pension Scheme ABI UK Old Life Fund ABI UK Old Pension Fund

Lipper Details

433

AITCINVTRUST FRANCE ARGCAM ASSOGESTIONI ASSOGPF ASSOGEST2003 BRAZANBID CIFSC2 CIFSCDONOTUSE CHILESVS CzechRepublicAFAM BVI2006 HEXCLASS HBC HKPC AUTIFUNITTR JAPANITA JPNITABROAD JPNITAFINE JPNITAMED KOREAAMAK AMAKDETAIL AMAKEQRATIO AMAKINV AMAKRANK LGC2005 LIPPERITG LipperKoreaZeroin LIPPERMALAY LIPPERCH LIPPERCHP LIPPERTW2 UKOFFSHORE MEXCNBV MONEYFACTSSA NMFA PERUCONCLA PHTOAP APFIPP TAIWAN SAUIPC SASS SPAIN SPINV TAIMCB TAIMCD THAISEC ABIUKBROKER UKFTSESE US_FUND_OBJ USMSECTOR

AIC Investment Trust AMF Argentina Camara Assogestioni Assogestioni Fondi Pensione Assogestioni 2003 Brazil Anbid CIFSC CIFSC DO NOT USE Chile SVS Czech Republic AFAM German BVI HEX Classification Holdings Based Classification Hong Kong Pension Funds IMA Japanese ITA Japanese ITA Broad Japanese ITA Fine Japanese ITA Intermediary Korea AMAK Korea AMAK Detail Korea AMAK Equity Ratio Korea AMAK Investment Korea AMAK Rank Lipper Global Lipper Italian General Lipper Korea Zeroin Lipper Malaysia Lipper Schweiz Lipper Swiss Pension Lipper Taiwan Lipper UK Offshore Fund Mexican CNBVV Money Facts Savings Account Norwegian Mutual Fund Assoc Peru CONASEV Phillipines TOAP Portugese APIFIPPCMVM SITCA Domestic Saudi Arabia IPC Slovakia SASS Spanich Inverco CNMV Spanish Pension Inverco Thailand AIMC Broad Thailand AIMC Detailed Thailand SEC UK Broker Fund UKFTSE Stock Exchange US Mutual Fund Objective US Mutual Fund Sector

434

TRKD API Developer's Guide

19.5.7 LG Classification Scheme Enumeration

The table below lists available Lipper Global classification schemes and their descriptions: Classification Scheme LipperGlobal LipperGlobalBonds LipperGlobalEquities LipperGlobalHedge LipperGlobalMixedAss ets LipperGlobalMoneyMa rket LipperGlobalRealEstat e LipperGlobalOther None Description Lipper Global Lipper Global Bonds Lipper Global Equities Lipper Global Hedge Lipper Global Mixed Assets Lipper Global Money Market Lipper Global Real Estate Lipper Global Other No Schema (Default)

Lipper Overview

435

chapter 20

Lipper Overview

The Lipper Overview service provides methods that allow the user to retrieve a wide range of basic Lipper fund data. The following methods are available through Lipper Overview: Get Asset Details Analysis SP (GetAssetDetailsAnalysisSP_1) - returns asset analysis details (performance calculations) for the given asset(s). Get Asset Details Attributes (GetAssetDetailsAttributes_1) - returns a detailed list of attributes for the given asset(s). Get Asset Details Financial Advanced (GetAssetDetailsFinancialAdvanced_1) - returns financial details for the given asset(s). Get Asset Details Financial Basic (GetAssetDetailsFinancialBasic_1) - returns basic financial information for the given asset(s). Get Asset Details Overview Basic (GetAssetDetailsOverviewBasic_1) - returns asset details for the given asset(s). Get Asset Details Prices Basic (GetAssetDetailsPricesBasic_1) - returns listed prices for the given asset(s). Get Asset Details Ratings (GetAssetDetailsRatings_1) - returns all of the Lipper Leader scores for the given asset(s).

20.1

Authentication/Authorization, Service Endpoint, and Required Headers

Authorization All requests to the Lipper Overview service require an authorization token. For details, see section Understanding Authentication Tokens. Authentication Lipper Overview uses Reuters impersonation tokens for each effective user. In this case, Thomson Reuters must create each user before your application authenticates them. Unmanaged effective users are not supported in Lipper Overview. For additional information on creating a Service Token, see section Creating a Token. Service Endpoint Lipper Overview Endpoint
http://api.rkd.reuters.com/api/2009/01/01/LipperF undamentals_1.sv c

Required Header Required HTTP Headers

P O S T /api/2009/01/01/LipperF undamentals_1.sv c H TTP /1.1 C ontent-Ty pe: application/soap+xml H ost: api.rkd.reuters.com C ontent-Length: [length]

20.2

WSDL
WSDL:
http://api.rkd.reuters.com/schemas/w sdl/LipperF undamentals_1_H ttpA ndRKDToken.w sdl

436

TRKD API Developer's Guide

20.3

Get Asset Details Analysis SP (GetAssetDetailsAnalysisSP_1)

You can use the GetAssetDetailsAnalysisSP_1 method to retrieve asset analysis details (performance calculations) for the specified asset(s). A performance calculation is a calculation that measures fund's past performance. The example below gets asset analysis details for the asset with '60003333' LipperID expressed in US dollars and displayed in English language. XML Sample Request - Getting Asset Details Analysis SP
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperF undamentals_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etA ssetDetailsA naly sisS P _1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etA ssetDetailsA naly sisS P _Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1"> <lipperID> 6 0 0 0 3 3 3 3 </lipperID> <currency C ode> USD</currency C ode> <language> English</language> </G etA ssetDetailsA naly sisS P _Request_1> </Body > </E nv elope>

Paramete Description r lipperID A unique eight- or nine-digit number that identifies an asset. currencyCo The display currency for the returned data. For full listing of available currency codes, see section Currency de Code Enumeration in the Lipper Data Enumerations chapter. language The display language for the returned data.

Note: Lipper automatically defaults to American English if the requested data is unavailable in the language specified in the language option. The response returns the analysis details for the specified asset ('60003333'): XML Sample Response - Getting Asset Details Analysis SP
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etA ssetDetailsA naly sisS P _1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etA ssetDetailsA naly sisS P _Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1"> <A ssetDetailsA naly sisS P Result> <A ssetDetailsA naly sisS P Ty pe> <LipperId>11005483</LipperId> <Language>E nglish</Language> <N ame>M S C I World/H ealth C are TR</N ame>

Lipper Overview

437

<BenchmarkC ategory >A ssetM anager</BenchmarkC ategory > <P erformanceC alculationList> <P erformanceC alculationItem> <C urrency C ode>U S D</C urrency C ode> <S tatTy peId>26593</S tatTy peId> <E stimate>false</E stimate> <S tartDate>1999-03-31</S tartDate> <E ndDate>2009-03-31</E ndDate> <C alcP eriodN ame>M ax Draw dow n</C alcP eriodN ame> <Language>E nglish</Language> <V alue>-35.24138</V alue> <C alculationTy pe>M axDraw dow nfor10YearstoLastM onthE nd</C alculationTy pe> </P erformanceC alculationItem> ... <A ssetDetailsA naly sisS P Ty pe> <LipperId>60003333</LipperId> <Language>E nglish</Language> <N ame>Janus G lobal Life S ciences E U R A A cc</N ame> <BenchmarkC ategory xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <P erformanceC alculationList> <P erformanceC alculationItem> <C urrency C ode>U S D</C urrency C ode> <S tatTy peId>26589</S tatTy peId> <E stimate>false</E stimate> <S tartDate>2004-03-31</S tartDate> <E ndDate>2009-03-31</E ndDate> <C alcP eriodN ame>A lpha</C alcP eriodN ame> <Language>E nglish</Language> <V alue>0.25717</V alue> <C alculationTy pe>A lphafor5YearstoLastM onthE nd</C alculationTy pe> </P erformanceC alculationItem> .... <P erformanceC alculationItem> <C urrency C ode>U S D</C urrency C ode> <S tatTy peId>26601</S tatTy peId> <E stimate>false</E stimate> <S tartDate>2004-03-31</S tartDate> <E ndDate>2009-03-31</E ndDate> <C alcP eriodN ame>Trey nor Ratio</C alcP eriodN ame> <Language>E nglish</Language> <V alue>-0.34437</V alue> <C alculationTy pe>Trey norRatiofor5YearstoLastM onthE nd</C alculationTy pe> </P erformanceC alculationItem> </P erformanceC alculationList> </A ssetDetailsA naly sisS P Ty pe> </A ssetDetailsA naly sisS P Result> </G etA ssetDetailsA naly sisS P _Response_1> </Body > </E nv elope>

Element LipperId Language Name BenchmarkCategory PerformanceCalculat ionsList

Description The Lipper ID for the asset's benchmark fund. The display language for the asset analysis data. The benchmark index fund's name. The benchmark category for the benchmark identified in LipperId. The asset's performance calculation list. Can have the following values: CurrencyCode - the currency code that represents the currency of the performance calculation data. StatTypeId - the stat type id. StatTypeId is a simple numeric reference identifier used to identify the various statistics and calculations available through the service. Estimate - a flag that indicates if the value of this performance calculation is an estimate. StartDate - the start date for the time period used for the performance calculation. EndDate - the end date for the time period used for the performance calculation. CalcPeriodName - the name of the performance calculation. Language - the Language ID that represents the display language for the performance calculation data. Value - the value of the performance calculation. CalculationType - the type of the calculation.

438

TRKD API Developer's Guide

20.4

Get Asset Details Attributes (GetAssetDetailsAttributes_1)

Use the GetAssetDetailsAttributes_1 method to retrieve a detailed list of attributes for the specified asset(s). Attributes are basic characteristics of a fund, like asset type, status, universe, etc. The example below requests attributes for the asset with '65028707' LipperID and to be displayed in English language. XML Sample Request - Getting Asset Details Attributes
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperF undamentals_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etA ssetDetailsA ttributes_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etA ssetDetailsA ttributes_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1"> <lipperID>65028707</lipperID> <language>E nglish</language> </G etA ssetDetailsA ttributes_Request_1> </Body > </E nv elope>

Paramet Description er lipperID language A unique eight- or nine-digit number that identifies an asset. The display language for the returned data.

Note: Lipper automatically defaults to American English if the requested data is unavailable in the language specified in the language option. The response returns a detailed list of attributes for the specified asset: XML Sample Response - Getting Asset Details Attributes
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etA ssetDetailsA ttributes_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etA ssetDetailsA ttributes_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1"> <A ssetDetailsA ttributesResult> <RegisteredC ountry O fS ale> <RegisteredC ountry O fS aleTy pe> <LipperId>65028707</LipperId> <C ountry List> <C ountry Ty pe> <C ountry Id>895</C ountry Id> <Language>E nglish</Language> <C ountry N ame>Korea</C ountry N ame> <C ountry C ode>KO R</C ountry C ode> </C ountry Ty pe> </C ountry List> </RegisteredC ountry O fS aleTy pe>

Lipper Overview

439

</RegisteredC ountry O fS ale> <F lags> <F lagTy pe> <LipperId>65028707</LipperId> <Language>E nglish</Language> <F lagList> <F lagItem> <F lagId>1354</F lagId> <F lagN ame>Linked F und</F lagN ame> <F lagC ode>Y</F lagC ode> <F lagV alue>Yes</F lagV alue> </F lagItem> ... </F lagList> </F lagTy pe> </F lags> <A ttributes> <A ttributeTy pe> <LipperId>65028707</LipperId> <A ttributeList> <A ttributeItem> <Language>E nglish</Language> <V alueId>1276</V alueId> <V alueN ame>V aluation / P ricing F requency </V alueN ame> <V alueC ode>P RDA ILY</V alueC ode> <V alue>P ricing Daily , M on-F ri</V alue> </A ttributeItem> ... <A ttributeItem> <Language>E nglish</Language> <V alueId>1083</V alueId> <V alueN ame>G eographical F ocus</V alueN ame> <V alueC ode>KO R</V alueC ode> <V alue>Korea</V alue> </A ttributeItem> </A ttributeList> </A ttributeTy pe> </A ttributes> <Domicile> <DomicileTy pe> <LipperId>65028707</LipperId> <Language>E nglish</Language> <DomicileId>326</DomicileId> <DomicileC ode>KO R</DomicileC ode> <DomicileN ame>Korea (Republic of)</DomicileN ame> </DomicileTy pe> </Domicile> <G uaranteeA sset> <G uaranteeA ssetTy pe> <LipperId>65028707</LipperId> <G uarantee xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <M aturity Date xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> </G uaranteeA ssetTy pe> </G uaranteeA sset> </A ssetDetailsA ttributesResult> </G etA ssetDetailsA ttributes_Response_1> </Body > </E nv elope>

Attributes returned by this method include valuation and pricing frequency, domicile, flags, registered country of sale, and guarantee asset: Element Description RegisteredCount The asset's registered country of sale information. Contains the following sub-elements: ryOfSale LipperID - an eight- or nine-digit number that identifies an asset. CountryList - the list of countries where the asset is registered for sale. Contains the following sub-attributes: C ountry Id - the country's numerical Country ID. Language - the display language for the country information. C ountry Name - the name of the country. C ountry C ode - the alphabetic country code. Flags The asset's flags. Can have the following sub-attributes:

440

TRKD API Developer's Guide

LipperID - an eight- or nine-digit number that identifies an asset. Language - the display language for the flag list. FlagList - the asset's list of flags and values. There are a large number of flags available in the Lipper database, but not all flags apply for all assets. An example would be exchanged listed. Can have the following sub-elements: F lagId - the numeric flag ID. F lagName - the name of the flag. F lagC ode - the alphabetic flag code. F lagValue - the flag value, which is either Yes or No. If the value of this flag is yes, then the fund is listed on an exchange. Attributes The asset's attribute list. Can have the following sub-attributes: LipperID - an eight- or nine-digit number that identifies an asset. AttributeList - the asset's attribute list that includes all of the asset's available attributes and associated values. Contains the following sub-attributes: Language - the display language for the attribute information. ValueId - the numeric attribute value ID. ValueName - the name of the attribute value. ValueC ode - the alphabetic attribute value code. Value - the attribute value. Domicile The asset's domicile data. Can have the following sub-attributes: LipperID - an eight- or nine-digit number that identifies an asset. Language - the display language for the domicile information. DomicileId - the numerical Domicile ID that represents the asset's domicile. DomicileCode - the alphabetic Domicile Code (e.g., GBR) that represents the asset's domicile. DomicileName - the name of the domicile. GuaranteeAsset The asset's guarantee data. Can have the following sub-attributes: LipperID - an eight- or nine-digit number that identifies an asset. Guarantee - the asset's guarantee percentage. MaturityDate - the guarantee's maturity date.

20.5

Get Asset Details Financial Advanced (GetAssetDetailsFinancialAdvanced_1)

Use the GetAssetDetailsFinancialAdvanced_1 method to retrieve financial details for the specified asset(s). The example below gets financial details for the asset with '65028707' LipperID expressed in Euro and displayed in English language. XML Sample Request - Getting Asset Details Financial Advanced
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperF undamentals_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etA ssetDetailsF inancialA dv anced_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etA ssetDetailsF inancialA dv anced_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1"> <lipperID>65028707</lipperID> <language>E nglish</language> <currency C ode>E U R</currency C ode> </G etA ssetDetailsF inancialA dv anced_Request_1> </Body > </E nv elope>

Paramete Description r

Lipper Overview

441

lipperID currencyCo de language

A unique eight- or nine-digit number that identifies an asset. The display currency for the returned data. For full listing of available currency codes, see section Currency Code Enumeration in the Lipper Data Enumerations chapter. The display language for the returned data.

Note: Lipper automatically defaults to American English if the requested data is unavailable in the language specified in the language option. The response returns financial details for the specified asset: XML Sample Response - Getting Asset Details Financial Advanced
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etA ssetDetailsF inancialA dv anced_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etA ssetDetailsF inancialA dv anced_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/ LipperF undamentals_1"> <A ssetDetailsF inancialResult> <Income> <IncomeTy pe> <LipperId>65028707</LipperId> <Distribution>P aid</Distribution> <DefaultTax>G ross</DefaultTax> <IncomeIsInterest>false</IncomeIsInterest> <C anReInv estIncome>true</C anReInv estIncome> <U KN et xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <G ross>true</G ross> <C anWithdraw Income xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <DistributionTy pe>P aid</DistributionTy pe> <DefaultTaxBasis>G ross</DefaultTaxBasis> </IncomeTy pe> </Income> <C harges> <C hargesTy pe> <LipperId>65028707</LipperId> <N ame>H ana U BS F C LG E lec / S amsung F ire Deriv ativ es 1</N ame> <C hargesList> <C hargesItem> <DataDate>1800-01-01</DataDate> <C hargeId>777</C hargeId> <C hargeN ame>Initial</C hargeN ame> <M inimum xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <M aximum xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <A ctual>0</A ctual> </C hargesItem> ... </C hargesList> </C hargesTy pe> </C harges> <E U TaxP ercentages/> <TotalN etA ssets> <TotalN etA ssetTy pe> <LipperId>65028707</LipperId> <TotalN etA ssetList> <TotalN etA ssetItem> <DataDate>2007-09-28</DataDate> <C urrency C ode>E U R</C urrency C ode> <TotalN etA ssets>9141186.076</TotalN etA ssets> <TotalN etA ssetsInM illions>9.1411861</TotalN etA ssetsInM illions> </TotalN etA ssetItem> ... </TotalN etA ssetList> </TotalN etA ssetTy pe> </TotalN etA ssets>

442

TRKD API Developer's Guide

<M inimumInv estments/> <Yield/> <Zw ist/> </A ssetDetailsF inancialResult> </G etA ssetDetailsF inancialA dv anced_Response_1> </Body > </E nv elope>

Element Income

Description The asset's income data. Contains the following sub-attributes: LipperId - the Lipper ID is an eight- or nine-digit number that represents an asset. Distribution - the type of distribution for the income, either paid or retained. DefaultTax - the default tax basis. The default tax basis tells whether the income will be stored on a Gross or UK Net tax basis. IncomeIsInterest - a flag that indicates if more than 60% of the fund is invested in bond or income securities and is, therefore, taxed at a different rate. CanReInvestIncome - a flag that indicates if the appropriate income data has been collected and stored in the Lipper database to enable the reinvested income calculation. UKNet - a flag that indicates if the income is reinvested on a net basis. Gross - a flag that indicates if the income is reinvested on a gross basis. CanWithdrawIncome - a flag that indicates if the appropriate income data has been collected and stored in the Lipper database to enable the withdraw income calculation. DistributionType - the IncomeDistribution ID that represents the Income Distribution type for the Income type. DefaultTaxBasis - the Tax Id that represents the Tax Status for the Income type. Charges The assets charges data. Contains the following sub-attributes: LipperId - the Lipper ID is an eight- or nine-digit number that represents an asset. Name - the asset name. ChargesList - the list of all the charges for the asset. Contains the following sub-attributes: DataDate - the data date for the charge. C hargeId - the ID of the charge item. C hargeName - the name of the charge. Minimum - the minimum charge for the charge item. Max imum - the maximum charge for the charge item. A ctual - the actual charge for the item. EUTaxPercentag The asset's EU tax percentages data. Contains the following elements: es LipperId - the asset's Lipper ID. DataDate - the date for which the EU Tax information is valid. EUTaxStartDate - the tax period start date. EUTaxEndDate - the tax period end date. EUTaxPercent - The percentage of the funds assets that are invested in debt claims with nongrandfathered status. TotalNetAssets The asset's total net assets (TNA) details. Contains the following sub-elements: LipperId - the Lipper ID is an eight- or nine-digit number that represents an asset. TotalNetAssetList - the asset's list of TNA values. Contains the following sub-attributes: DataDate - the date for which the TNA value is valid. C urrency C ode - the currency code that represents the currency for the TNA value. TotalNetA ssets - the TNA value for the stated data date. TotalNetA ssetsInMillions - the TNA value in millions for the stated data date. MinimumInvestm The asset's minimum investment data. A Minimum Investment is a minimum number of shares or currency ents amount that investors must purchase. Contains the following elements: LipperId - the asset's Lipper ID. Language - the display language for the minimum investment data. StartDate - the minimum investment start date. EndDate - the minimum investment end date. CurrencyCode - the display currency for the minimum investment data. Name - the name of the asset. MinimumInvestmentTypeId - the ID of the minimum investment type. MinimumInvestmentInitial - minimum number of shares or currency amount that investors must initially purchase. MinimumInvestmentRegular - minimum amount of investment accepted on a regular basis, like to be part of regular savings plan. MinimumInvestmentIRRegular - minimum number of shares or currency amount that investors can subsequently invest (on an ad hoc basis) in the fund after initial shares are

Lipper Overview

443

Yield

Zwist

purchased. MinimumInvestmentInitialShare - the minimum initial share investment amount. The asset's yield (return on investment) data. Yield represents a single yield value for an asset. Contains the following elements: LipperId - the asset's Lipper ID. YieldList - the asset's yield data. Contains the following elements: DataDate - the date for which the yield data is valid. Name - the name of the yield type. There are four available yield types: overall, one-year, fiveyear, and ten-year. Value - the yield's value. YieldTy peId - the yield type's ID. The asset's zwist data. Zwist is the percentage of a German fund's distributions that are refundable to investors as a result of corporate income and withholding taxes paid by the fund. Contains the following elements: LipperId - the asset's Lipper ID. DataDate - the date for which zwist data is valid. Zwist - the Zwist value. MaxDate - the date at which zwist expires. CurrencyCode - the display currency for zwist data.

20.6

Get Asset Details Financial Basic (GetAssetDetailsFinancialBasic_1)

Use the GetAssetDetailsFinancialBasic_1 method to retrieve basic financial information for the given asset(s). The example below gets financial details for the asset with '65028707' LipperID expressed in Euro and displayed in English language. XML Sample Request - Getting Asset Details Financial Basic
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperF undamentals_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etA ssetDetailsF inancialBasic_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etA ssetDetailsF inancialBasic_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1"> <lipperID>65028707</lipperID> <language>E nglish</language> <currency C ode>E U R</currency C ode> </G etA ssetDetailsF inancialBasic_Request_1> </Body > </E nv elope>

Paramete Description r lipperID A unique eight- or nine-digit number that identifies an asset. currencyCo The display currency for the returned data. For full listing of available currency codes, see section Currency de Code Enumeration in the Lipper Data Enumerations chapter. language The display language for the returned data.

Note: Lipper automatically defaults to American English if the requested data is unavailable in the language specified in the language option. The response returns the following financial information for the specified asset:

444

TRKD API Developer's Guide

XML Sample Response - Getting Asset Details Financial Basic

<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etA ssetDetailsF inancialBasic_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etA ssetDetailsF inancialBasic_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1"> <A ssetDetailsF inancialBasicResult> <Income> <IncomeTy pe> <LipperId>65028707</LipperId> <Distribution>P aid</Distribution> <DefaultTax>G ross</DefaultTax> <IncomeIsInterest>false</IncomeIsInterest> <C anReInv estIncome>true</C anReInv estIncome> <U KN et xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <G ross>true</G ross> <C anWithdraw Income xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <DistributionTy pe>P aid</DistributionTy pe> <DefaultTaxBasis>G ross</DefaultTaxBasis> </IncomeTy pe> </Income> <C harges> <C hargesTy pe> <LipperId>65028707</LipperId> <N ame>H ana U BS F C LG E lec / S amsung F ire Deriv ativ es 1</N ame> <C hargesList> <C hargesItem> <DataDate>1800-01-01</DataDate> <C hargeId>777</C hargeId> <C hargeN ame>Initial</C hargeN ame> <M inimum xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <M aximum xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <A ctual>0</A ctual> </C hargesItem> ... </C hargesList> </C hargesTy pe> </C harges> <E U TaxP ercentages/> <TotalN etA ssets> <TotalN etA ssetTy pe> <LipperId>65028707</LipperId> <TotalN etA ssetList> <TotalN etA ssetItem> <DataDate>2007-09-28</DataDate> <C urrency C ode>E U R</C urrency C ode> <TotalN etA ssets>9141186.076</TotalN etA ssets> <TotalN etA ssetsInM illions>9.1411861</TotalN etA ssetsInM illions> </TotalN etA ssetItem> </TotalN etA ssetList> </TotalN etA ssetTy pe> </TotalN etA ssets> <M inimumInv estments/> <Yield/> <Zw ist/> </A ssetDetailsF inancialBasicResult> </G etA ssetDetailsF inancialBasic_Response_1> </Body > </E nv elope>

Element Income

Description The asset's income data. Contains the following sub-attributes:

Lipper Overview

445

LipperId - the Lipper ID is an eight- or nine-digit number that represents an asset. Distribution - the type of distribution for the income, either paid or retained. DefaultTax - the default tax basis. The default tax basis tells whether the income will be stored on a Gross or UK Net tax basis. IncomeIsInterest - a flag that indicates if more than 60% of the fund is invested in bond or income securities and is, therefore, taxed at a different rate. CanReInvestIncome - a flag that indicates if the appropriate income data has been collected and stored in the Lipper database to enable the reinvested income calculation. UKNet - a flag that indicates if the income is reinvested on a net basis. Gross - a flag that indicates if the income is reinvested on a gross basis. CanWithdrawIncome - a flag that indicates if the appropriate income data has been collected and stored in the Lipper database to enable the withdraw income calculation. DistributionType - the IncomeDistribution ID that represents the Income Distribution type for the Income type. DefaultTaxBasis - the Tax Id that represents the Tax Status for the Income type. Charges The assets charges data. Charges are fees associated with investing in the fund which are incurred by investors. Contains the following sub-attributes: LipperId - the Lipper ID is an eight- or nine-digit number that represents an asset. Name - the asset name. ChargesList - the list of all the charges for the asset. Contains the following sub-attributes: DataDate - the data date for the charge. C hargeId - the ID of the charge item. C hargeName - the name of the charge. Minimum - the minimum charge for the charge item. Max imum - the maximum charge for the charge item. A ctual - the actual charge for the item. EUTaxPercentag The asset's EU tax percentages data. Contains the following elements: es LipperId - the asset's Lipper ID. DataDate - the date for which the EU Tax information is valid. EUTaxStartDate - the tax period start date. EUTaxEndDate - the tax period end date. EUTaxPercent - the percentage of the given funds' assets that are invested in debt claims with non-grandfathered status. TotalNetAssets The asset's total net assets (TNA) details. Contains the following sub-attributes: LipperId - the Lipper ID is an eight- or nine-digit number that represents an asset. TotalNetAssetList - the asset's list of TNA values. Contains the following sub-attributes: DataDate - the date for which the TNA value is valid. C urrency C ode - the currency code that represents the currency for the TNA value. TotalNetA ssets - the TNA value for the stated data date. TotalNetA ssetsInMillions - the TNA value in millions for the stated data date. MinimumInvestm The asset's minimum investment data. A Minimum Investment is a minimum number of shares or currency ents amount that investors must purchase. Contains the following elements: LipperId - the asset's Lipper ID. Language - the display language for the minimum investment data. StartDate - the minimum investment start date. EndDate - the minimum investment end date. CurrencyCode - the display currency for the minimum investment data. Name - the name of the asset. MinimumInvestmentTypeId - the ID of the minimum investment type. MinimumInvestmentInitial - minimum number of shares or currency amount that investors must initially purchase. MinimumInvestmentRegular - minimum amount of investment accepted on a regular basis, like to be part of regular savings plan. MinimumInvestmentIRRegular - minimum number of shares or currency amount that investors can subsequently invest (on an ad hoc basis) in the fund after initial shares are purchased. MinimumInvestmentInitialShare - the minimum initial share investment amount. Yield The asset's yield (return on investment) data. Yield represents a single yield value for an asset. Contains the following elements: LipperId - the asset's Lipper ID. YieldList - the asset's yield data. Contains the following elements: DataDate - the date for which the yield data is valid. Name - the name of the yield type. There are four available yield types: overall, one-year, fiveyear, and ten-year.

446

TRKD API Developer's Guide

Zwist

Value - the yield's value. YieldTy peId - the yield type's ID. The asset's zwist data. Zwist is the percentage of a German fund's distributions that are refundable to investors as a result of corporate income and withholding taxes paid by the fund. Contains the following elements: LipperId - the asset's Lipper ID. DataDate - the date for which zwist data is valid. Zwist - the Zwist value. MaxDate - the date at which zwist expires. CurrencyCode - the display currency for zwist data.

20.7

Get Asset Details Overview Basic (GetAssetDetailsOverviewBasic_1)

Use the GetAssetDetailsOverviewBasic_1 method to retrieve asset details for the given asset(s). The example below gets financial details for the asset with '65028707' LipperID and displayed in English language. XML Sample Request - Getting Asset Details Overview Basic
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperF undamentals_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etA ssetDetailsO v erv iew Basic_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etA ssetDetailsO v erv iew Basic_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1"> <lipperID>65028707</lipperID> <language>E nglish</language> </G etA ssetDetailsO v erv iew Basic_Request_1> </Body > </E nv elope>

Paramet Description er lipperID language A unique eight- or nine-digit number that identifies an asset. The display language for the returned data.

Note: Lipper automatically defaults to American English if the requested data is unavailable in the language specified in the language option. The response returns asset details for the specified asset. Asset details include benchmarks, classification schemes, cross references, currencies, IPO information, asset identity, manager, objectives, asset relationships, successions, support companies, and umbrella funds. XML Sample Response - Getting Asset Details Overview Basic
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etA ssetDetailsO v erv iew Basic_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse>

Lipper Overview

447

<a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etA ssetDetailsO v erv iew Basic_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1"> <A ssetDetailsO v erv iew BasicResult> <Identity > <LipperId>65028707</LipperId> <Language>E nglish</Language> <F ullN ame>H ana U BS F C LG E lec / S amsung F ire Deriv ativ es 1</F ullN ame> <S hortN ame>H ana U BS F C LG E /S amsungF ireDe1</S hortN ame> <N ickN ame/> </Identity > <M anager> <M anagerTy pe> <LipperId>65028707</LipperId> <M anagerN ame>Team-managed</M anagerN ame> <S tartDate>2006-04-24</S tartDate> <E ndDate>4000-01-01</E ndDate> </M anagerTy pe> </M anager> <S upportC ompany > <S upportC ompaniesTy pe> <C ompany Role>A dministrator</C ompany Role> <C ompany Ty pe> <Language>E nglish</Language> <C ompany Id>1276096</C ompany Id> <C ompany F ullN ame>H S BC F und S erv ice</C ompany F ullN ame> <LipperId>65028707</LipperId> <C ompany C ode>105628003</C ompany C ode> <C ompany S hortN ame>H S BC F und S erv ice</C ompany S hortN ame> <BusinessN ame>F inance</BusinessN ame> <C ontactInformation> <A ddressLine1>6F Ky obo S ec. B/D</A ddressLine1> <A ddressLine2>26-4 Yeoido-dong Youngdungpo-go</A ddressLine2> <A ddressLine3>S eoul Korea</A ddressLine3> <A ddressLine4/> <C ity /> <P ostcode/> <Telephone>(82) 2 3771 9824</Telephone> <F ax>(82) 2 3771 9900</F ax> <E mail>kms111@amtek.co.kr</E mail> <WebsiteU rl> <F ragment/> <H ost>w w w .amtek.co.kr</H ost> <P assw ord/> <P ath>/</P ath> <P ort>80</P ort> <Q uery /> <S cheme>http</S cheme> <U serN ame/> </WebsiteU rl> <U rl>http://w w w .amtek.co.kr/</U rl> <H ost>w w w .amtek.co.kr</H ost> </C ontactInformation> </C ompany Ty pe> </S upportC ompaniesTy pe> ... </S upportC ompany > <IP O Info> <LipperId>65028707</LipperId> <LaunchDate>2006-04-24</LaunchDate> <C urrency C ode>KRW</C urrency C ode> <IP O V alue xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <IP O Date xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <N av >1000</N av > <Bid xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <O ffer xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <M id xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> </IP O Info> <BenchmarkList> <BenchmarkItem> <Language>E nglish</Language> <BenchmarkId>11026143</BenchmarkId> <BenchmarkN ame>Korean Treasury 1 Year</BenchmarkN ame> <BenchmarkC ategory >RiskF reeIndex</BenchmarkC ategory > </BenchmarkItem> ...

448

TRKD API Developer's Guide

<S uccession> <S uccessionTy pe> <LipperId>65028707</LipperId> <S uccessionKind/> <S uccessionDate>2007-10-29</S uccessionDate> </S uccessionTy pe> </S uccession> <O bjectiv e> <LipperId>65028707</LipperId> <Language>E nglish</Language> <O bjectiv eText>This fund aims to achiev e stable interest income and capital grow th.</O bjectiv eText> <DataDate>1800-01-01</DataDate> </O bjectiv e> <P rimary > <A ssetRelationTy pe> <LipperId>65028707</LipperId> <P arentId>65028707</P arentId> <A ssetRelationList> <A ssetIdentity Ty pe> <LipperId>65028707</LipperId> <Language>E nglish</Language> <N ame>H ana U BS F C LG E lec / S amsung F ire Deriv ativ es 1</N ame> </A ssetIdentity Ty pe> </A ssetRelationList> </A ssetRelationTy pe> </P rimary > <U mbrella/> <C lassification> <C lassS chemeTy pe> <C lassS chemeId>6052</C lassS chemeId> <C lassS chemeC ode>U N C LA S S </C lassS chemeC ode> <C lassS chemeN ame>Lipper G lobal</C lassS chemeN ame> <Language>E nglish</Language> <C lassList> <C lassTy pe> <C lassId>6218</C lassId> <C lassN ame>U nclassified</C lassN ame> <Language>E nglish</Language> </C lassTy pe> </C lassList> <LipperId>65028707</LipperId> </C lassS chemeTy pe> ... </C lassification> <C urrency > <C urrency Id>10000040</C urrency Id> <Language>E nglish</Language> <C urrency C ode>KRW</C urrency C ode> <N ame>S outh Korean Won</N ame> </C urrency > </A ssetDetailsO v erv iew BasicResult> </G etA ssetDetailsO v erv iew Basic_Response_1> </Body > </E nv elope>

Element Identity

Manager

Description the asset's identity details, which includes the fund's full name, nickname, and short name. Contains the following elements: LipperId - the asset's Lipper ID. The Lipper ID is an eight- or nine-digit number that represents an asset. Language - the Language ID that represents the language for the asset information. FullName - the asset's full name. ShortName - the asset's short name. NickName - the asset's nickname. PrivateFundCode - the private fund code. Private Fund Code refers to an identifier that is a possibility within the CrossReferenceCodes list. This value will be available only for private funds. The asset's manager details. Contains the following elements: LipperId - the asset's Lipper ID. ManagerName - the asset manager's name. StartDate - the asset manager's start date. The year the manager of the fund started managing the fund.

Lipper Overview

449

EndDate - the asset manager's end date. The year the manager of the fund finished managing the fund. SupportComp The asset's support company details. Support Companies refer to the various entities which provide key any services to the overall operation of the fund. For example, the Fund Management Company supports the fund by providing the talent necessary to pick investments for the fund. It contains the following elements: CompanyRole - the company role. CompanyType - the asset's general company details. Language - the display language for the support company information. CompanyId - the company's numeric ID. CompanyFullName - the company's full name. LipperId - the asset's Lipper ID. CompanyCode - the company's alphabetic code. CompanyShortName - the company's short name. BusinessName - the type of business in which the company engages. ContactInformation - the company's contact information (address, phone and fax numbers, email, Web-site URL and host). IPOInfo The asset's Initial Public Offering (IPO) details. Initial Public Offering is when a company issues company's stock shares to the public or interested investors. Contains the following elements: LipperId - the asset's Lipper ID. LaunchDate - the fund's launch date, which is the date that the subscription period for the fund ends. CurrencyCode - the currency of the fund's base launch currency. IPOValue - the share value of the fund on the IPO date. IPODate - the date of the fund's IPO. Nav - the share value at the fund's first valuation with any shareholders. Bid - the Bid value, which is the first pricing of the fund after the subscription period is over minus the fund's redemption fees. Offer - the launch offer, which is the first pricing of the fund after the subscription period is over plus the fund's initial sales charge. Mid - the fund's first mid pricing after the subscription period is over (i.e., the mid-point between the bid and the offer). BenchmarkList The asset's benchmark details. Contains the following elements: Language - the Language ID that represents the language for the benchmark information. BenchmarkId - the Benchmark ID. BenchmarkName - the benchmark name. BenchmarkCategory - the benchmark category. Succession The asset's successor details. Contains the following elements: LipperId - the asset's Lipper ID. SuccessionKind - the type of succession. SuccessionDate - the succession date. Successor - the name of the surviving fund in a fund merger. Objective The asset's objective details. Contains the following elements: LipperId - the asset's Lipper ID. Language - the Language ID. ObjectiveText - the objective text, which is based up on information supplied in the fund's prospectus. DataDate - the date of the objective. Primary The assets primary fund details. A primary fund is the primary fund for a fund series with multiple share classes for the same portfolio of investments. Contains the following elements: LipperId - the asset's Lipper ID. ParentId - The Lipper ID of the parent fund of which the asset is a member. AssetRelationLis t - the list of assets that are members of the same umbrella fund as this asset. Umbrella The asset's umbrella fund details. Umbrella fund refers typically to Insurance Funds where a single fund acts as the central repository for assets and various sub-funds each with unique characteristics such as fees or benefits, then feeds the invested assets to the umbrella. The umbrella fund itself is not available to be invested in. Contains the following elements: LipperId - the asset's Lipper ID. ParentId - The Lipper ID of the parent fund of which the asset is a member. AssetRelationList - the list of assets that are members of the same umbrella fund as this asset. Classification The asset's classification scheme details. Contains the following elements: ClassSchemeId - the classification scheme's numeric ID. ClassSchemeCode - the classification scheme's numeric code. ClassSchemeName - the name of the classification scheme.

450

TRKD API Developer's Guide

Currency

Language - the display language for classification data. ClassList - the asset's classification list for the classification scheme. Contains the following subelements: C lassId - the classification type's numeric ID. C lassName - the name of the classification type. Language - the display language for classification data. LipperId - the asset's Lipper ID. The asset's currency details. Contains the following elements: CurrencyId - the numeric Currency ID. Language - the Language ID that represents the language for the currency. CurrencyCode - the alphabetic currency code. Name - the name of the currency.

20.8

Get Asset Details Prices Basic (GetAssetDetailsPricesBasic_1)

Use the GetAssetDetailsPricesBasic_1 method to retrieve listed prices for the given asset(s). The example below gets prices for the asset with '65028707' LipperID expressed in Euros and displayed in English language. XML Sample Request - Getting Asset Details Prices Basic
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperF undamentals_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etA ssetDetailsP ricesBasic_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etA ssetDetailsP ricesBasic_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1"> <lipperID>65028707</lipperID> <language>E nglish</language> <currency C ode>E U R</currency C ode> </G etA ssetDetailsP ricesBasic_Request_1> </Body > </E nv elope>

Paramete Description r lipperID A unique eight- or nine-digit number that identifies an asset. currencyCo The display currency for the returned data. For full listing of available currency codes, see section Currency de Code Enumeration in the Lipper Data Enumerations chapter. language The display language for the returned data.

Note: Lipper automatically defaults to American English if the requested data is unavailable in the language specified in the language option. The response returns the following price information for the specified asset: XML Sample Response - Getting Asset Details Prices Basic
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etA ssetDetailsP ricesBasic_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date>

Lipper Overview

451

<DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etA ssetDetailsP ricesBasic_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1"> <A ssetDetailsP ricesBasicResult> <LipperId>65028707</LipperId> <S tartDate>2006-04-24</S tartDate> <E ndDate>2009-04-20</E ndDate> <P riceList> <P riceItem> <DataDate>2007-10-29</DataDate> <C urrency C ode>E U R</C urrency C ode> <N av >0.9525901</N av > <N av E stimated>false</N av E stimated> <O ffer xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <O fferE stimated xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <Bid xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <BidE stimated xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <M id xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <M idE stimated xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> </P riceItem> </P riceList> </A ssetDetailsP ricesBasicResult> </G etA ssetDetailsP ricesBasic_Response_1> </Body > </E nv elope>

Element DataDate

Description The date for which the price is valid.

CurrencyCod The currency for the price data. e Nav The net asset value price, which is the dollar value of a single mutual fund share, based on the value of the underlying assets of the fund minus its liabilities, divided by the number of outstanding shares.

NavEstimate A flag that indicates if a calculated net asset value price was not supplied by the data provider so that an d estimated value was used instead. Offer The offer price, which is the net asset value plus initial sales charges. OfferEstimat A flag that indicates if a calculated offer value was not supplied by the data provider so that an estimated ed value was used instead. Bid The bid price, which is the net asset value minus redemption charges. BidEstimated A flag that indicates if a calculated bid value was not supplied by the data provider so that an estimated value was used instead. Mid The mid price of the fund after the subscription period is over. This is the mid point between the bid and the offer.

MidEstimated A flag that indicates if a calculated mid value was not supplied by the data provider so that an estimated value was used instead.

20.9

Get Asset Details Ratings (GetAssetDetailsRatings_1)

Use the GetAssetDetailsRatings_1 method to retrieve all of the Lipper Leader scores for the given asset(s). The example below gets Lipper Leader scores for the asset with '60003333' LipperID displayed in English language. XML Sample Request - Getting Asset Details Ratings
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperF undamentals_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etA ssetDetailsRatings_1</A ction>

452

TRKD API Developer's Guide

<A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etA ssetDetailsRatings_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1"> <lipperID>60003333</lipperID> <language>E nglish</language> </G etA ssetDetailsRatings_Request_1> </Body > </E nv elope>

Paramet Description er lipperID language A list of one or more Lipper IDs for which data will be returned. A Lipper ID is a unique eight- or nine-digit number that identifies an asset. The display language for the returned data.

Note: Lipper automatically defaults to American English if the requested data is unavailable in the language specified in the language option. The response returns Lipper Leader scores for the specified asset: XML Sample Response - Getting Asset Details Ratings
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1/ G etA ssetDetailsRatings_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etA ssetDetailsRatings_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperF undamentals_1"> <A ssetDetailsRatingsResult> <LipperId>60003333</LipperId> <U niv erseList> <U niv erseTy pe> <U niv erseId>5681</U niv erseId> <Language>E nglish</Language> <U niv erseC ode>G BR</U niv erseC ode> <U niv erseN ame>U K</U niv erseN ame> </U niv erseTy pe> ... </U niv erseList> <LipperLeaderS coresList> <LipperLeaderS coresTy pe> <LipperId>60003333</LipperId> <P ublishedDate xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <DataDate>2009-02-27</DataDate> <LipperLeaderU niv erseId>5681</LipperLeaderU niv erseId> <C onsistentReturnO v erallS core>1</C onsistentReturnO v erallS core> <C onsistentReturnC ount>10808</C onsistentReturnC ount> <C onsistentReturn3y rS core>1</C onsistentReturn3y rS core> <C onsistentReturn3y rC ount>10808</C onsistentReturn3y rC ount> <C onsistentReturn5y rS core>1</C onsistentReturn5y rS core> <C onsistentReturn5y rC ount>7514</C onsistentReturn5y rC ount> <C onsistentReturn10y rS core xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <C onsistentReturn10y rC ount xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <E xpenseO v erallS core xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <E xpenseC ount xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <E xpense3y rS core xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <E xpense3y rC ount xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <E xpense5y rS core xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <E xpense5y rC ount xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/>

Lipper Overview

453

<E xpense10y rS core xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <E xpense10y rC ount xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <P reserv ationO v erallS core>4</P reserv ationO v erallS core> <P reserv ationC ount>11097</P reserv ationC ount> <P reserv ation3y rS core>4</P reserv ation3y rS core> <P reserv ation3y rC ount>11097</P reserv ation3y rC ount> <P reserv ation5y rS core>3</P reserv ation5y rS core> <P reserv ation5y rC ount>7817</P reserv ation5y rC ount> <P reserv ation10y rS core xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <P reserv ation10y rC ount xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <TaxE fficiency C ount xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <TaxE fficiency O v erallS core xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <TaxE fficiency 3y rS core xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <TaxE fficiency 3y rC ount xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <TaxE fficiency 5y rS core xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <TaxE fficiency 5y rC ount xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <TaxE fficiency 10y rS core xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <TaxE fficiency 10y rC ount xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <TotalReturnO v erallS core>2</TotalReturnO v erallS core> <TotalReturnC ount>10808</TotalReturnC ount> <TotalReturn3y rS core>2</TotalReturn3y rS core> <TotalReturn3y rC ount>10808</TotalReturn3y rC ount> <TotalReturn5y rS core>2</TotalReturn5y rS core> <TotalReturn5y rC ount>7514</TotalReturn5y rC ount> <TotalReturn10y rS core xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <TotalReturn10y rC ount xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> </LipperLeaderS coresTy pe> ... </LipperLeaderS coresList> </A ssetDetailsRatingsResult> </G etA ssetDetailsRatings_Response_1> </Body > </E nv elope>

Element LipperID UniverseList

Description The asset's Lipper ID. The list of universes to which the asset belongs. Contains the following elements: UniverseId - the numeric Universe ID. Language - the Language ID that represents the display language for the universe information. UniverseCode - the alphabetic universe code. UniverseName - the name of the universe. LipperLeaderSco The asset's Lipper Leader scores. Lipper Leader Score is a rating (1-5, with 5 being the highest) that Lipper resList assigns to a fund. Lipper Leader Scores are given for a number of categories: total return, consistent return, preservation, tax efficiency, and expense. Contains the following elements: LipperId - the Lipper ID. PublishedDate - the date the Lipper Leader Score was published. DataDate - the date for which data will be returned. LipperLeaderUniverseId - the Universe ID for which the Lipper Leader score is applicable. ConsistentReturnOverallScore - the Consistent Return overall score. ConsistentReturnCount - the Consistent Return count. ConsistentReturn3yrScore - the Consistent Return 3 Year score. ConsistentReturn3yrCount - the Consistent Return 3 Year count. ConsistentReturn5yrScore - the Consistent Return 5 Year score. ConsistentReturn5yrCount - the Consistent Return 5 Year count. ConsistentReturn10yrScore - the Consistent Return 10 Year score. ConsistentReturn10yrCount - the Consistent Return 10 Year count. ExpenseOverallScore - the Expense overall score. ExpenseCount - the Expense count. Expense3yrScore - the Expense 3 Year score. Expense3yrCount - the Expense 3 Year count. Expense5yrScore - the Expense 5 Year score. Expense5yrCount - the Expense 5 Year count. Expense10yrScore - the Expense 10 Year score. Expense10yrCount - the Expense 10 Year count. PreservationOverallScore - the Preservation overall score. PreservationCount - the Preservation count. Preservation3yrScore - the Preservation 3 Year score. Preservation3yrCount - the Preservation 3 Year count.

454

TRKD API Developer's Guide

Preservation5yrScore - the Preservation 5 Year score. Preservation5yrCount - the Preservation 5 Year count. Preservation10yrScore - the Preservation 10 Year score. Preservation10yrCount - the Preservation 10 Year count. TaxEfficiencyCount - the Tax Efficiency count. TaxEfficiencyOverallScore - the Tax Efficiency overall score. TaxEfficiency3yrScore - the Tax Efficiency 3 Year score. TaxEfficiency3yrCount - the Tax Efficiency 3 Year count TaxEfficiency5yrScore - the Tax Efficiency 5 Year score. TaxEfficiency5yrCount - the Tax Efficiency 5 Year count TaxEfficiency10yrScore - the Tax Efficiency 10 Year score. TaxEfficiency10yrCount - the Tax Efficiency 10 Year count TotalReturnOverallScore - the Total Return overall score. TotalReturnCount - the Total Return count. TotalReturn3yrScore - the Total Return 3 Year score. TotalReturn3yrCount - the Total Return 3 Year count. TotalReturn5yrScore - the Total Return 5 Year score. TotalReturn5yrCount - the Total Return 5 Year count. TotalReturn10yrScore - the Total Return 10 Year score. TotalReturn10yrCount - the Total Return 10 Year count. 1. The Lipper Rating for Consistent Return identifies a fund that has provided relatively superior consistency and risk-adjusted returns when compared to a group of similar funds. 2. The Lipper Rating for Expense identifies a fund that has successfully managed to keep its expenses low relative to its peers and within its load structure. 3. Preservation is a fund that has demonstrated a superior ability to preserve capital in a variety of markets when compared with other funds in its asset class. 4. Tax Efficiency identifies a fund that has been successful at deferring taxes over the measurement period relative to similar funds. 5. Total Return denotes a fund that has provided superior total returns (income from dividends and interest as well as capital appreciation) when compared to a group of similar funds.

Lipper Search

455

chapter 21

Lipper Search

The Lipper Search web service provides methods that allow the client to look for an asset based on several types of characteristics. For example, Lipper Search gives the user the ability to search for assets with a name that 'begins with' or 'contains' certain words or phrases. The following methods are available through Lipper Search service: Get Class Scheme Search (GetClassSchemeSearch_1) - returns the assets along with their classification list. Get Class Scheme Search By RFS (GetClassSchemeSearchGetClassSchemeSearchByRFS_1) - returns a list of classification schemes available for the given country. Get Cross Reference Search - (GetCrossReferenceSearch_1) - returns the assets that have cross-reference codes matching the given search string. Get Cross Reference Search By Universe (GetCrossReferenceSearchByUniverse_1) - returns crossreference codes matching the search string and search style based on universe. Get Fund Name Search Max Records (GetFundNameSearchMaxRecords_1) - returns the assets that meet the given criteria. Get Fund Name Search Max Records By Universe (GetFundNameSearchMaxRecordsByUniverse_1) returns funds name search max records by universe. Get Fund Name Search Paging (GetFundNameSearchPaging_1) - returns the assets that meet the given criteria. Get Fund Name Search Pagination By RFS (GetFundNameSearchPaginationByRFS_1) - returns funds name search pagination for the specified country. Get Legal Structure Search (GetLegalStructureSearch_1) - returns the assets that have the given legal structure. Get Lipper Leader Score Search (GetLipperLeaderScoreSearch_1) - returns Lipper Leader Scores that meet the specified criteria. Get Search Keyword By Asset Type (GetSearchKeywordByAssetType_1) - searches the type of the keyword by asset.

21.1

Authentication/Authorization, Service Endpoint, and Required Headers

Authorization All requests to the Lipper Search service require an authorization token. For details, see section Understanding Authentication Tokens. Authentication Lipper Search uses Reuters impersonation tokens for each effective user. In this case, Thomson Reuters must create each user before your application authenticates them. Unmanaged effective users are not supported in Lipper Search. For additional information on creating a Service Token, see section Creating a Token. Service Endpoint Lipper Search Endpoint
http://api.rkd.reuters.com/api/2009/01/01/LipperS earch_1.sv c

Required Header Required HTTP Headers

P O S T /api/2009/01/01/LipperS earch_1.sv c H TTP /1.1 C ontent-Ty pe: application/soap+xml H ost: api.rkd.reuters.com

456

TRKD API Developer's Guide

C ontent-Length: [length]

21.2

WSDL
WSDL:
http://api.rkd.reuters.com/schemas/w sdl/LipperS earch_1_H ttpA ndRKDToken.w sdl

21.3

Get Class Scheme Search (GetClassSchemeSearch_1)

Use the GetClassSchemeSearch_1 method to retrieve assets, along with their classification list according to the classification scheme specified as a parameter in the search string. Class is an abbreviation for 'classification'. A classification is a designation assigned to assets based on various characteristics of the assets. For example, "Equity North America" is a classification assigned to an asset. Classifications are organized into classification schemes. Lipper provides multiple classification schemes around the world. For example, Equity North America is a classification within the Lipper Global Classification scheme. The example below retrieves class schemes which names begin with 'Ab' and are displayed in English language: XML Sample Request - Making Class Scheme Search
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperS earch_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperS earch_1/ G etC lassS chemeS earch_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etC lassS chemeS earch_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperS earch_1"> <searchstring>A b</searchstring> <language>E nglish</language> </G etC lassS chemeS earch_Request_1> </Body > </E nv elope>

Paramet Description er searchstri The classification scheme for which to search according to the specified search string value. Note that this field ng does not accept any special characters. language The display language for the search results.

Note: Lipper automatically defaults to American English if the requested data is unavailable in the language specified in the language option. The response returns a list of <ClassSchemeType> elements that contain the assets and their classification schemes that meet the given search criteria. XML Sample Response - Making Class Scheme Search
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperS earch_1/ G etC lassS chemeS earch_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1"

Lipper Search

457

xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etC lassS chemeS earch_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperS earch_1"> <C lassS chemeS earchResult> <C lassS chemeTy pe> <C lassS chemeId>1594</C lassS chemeId> <C lassS chemeC ode>A BIU KLIF E </C lassS chemeC ode> <C lassS chemeN ame>A BI U K O ld Life F und</C lassS chemeN ame> <Language>E nglish</Language> <LipperId>0</LipperId> </C lassS chemeTy pe> <C lassS chemeTy pe> <C lassS chemeId>1735</C lassS chemeId> <C lassS chemeC ode>A BIU KP E N S IO N </C lassS chemeC ode> <C lassS chemeN ame>A BI U K O ld P ension F und</C lassS chemeN ame> <Language>E nglish</Language> <LipperId>0</LipperId> </C lassS chemeTy pe> <C lassS chemeTy pe> <C lassS chemeId>29029</C lassS chemeId> <C lassS chemeC ode>A BILIF E 2008</C lassS chemeC ode> <C lassS chemeN ame>A BI Life S cheme</C lassS chemeN ame> <Language>E nglish</Language> <LipperId>0</LipperId> </C lassS chemeTy pe> <C lassS chemeTy pe> <C lassS chemeId>29030</C lassS chemeId> <C lassS chemeC ode>A BIP E N 2008</C lassS chemeC ode> <C lassS chemeN ame>A BI P ension S cheme</C lassS chemeN ame> <Language>E nglish</Language> <LipperId>0</LipperId> </C lassS chemeTy pe> </C lassS chemeS earchResult> </G etC lassS chemeS earch_Response_1> </Body > </E nv elope>

Element ClassSchemeI d ClassSchemeC ode ClassSchemeN ame Language LipperId

Description The classification scheme's numeric ID. The classification scheme's numeric code. The name of the classification scheme. The display language for classification data. The asset's Lipper ID.

21.4

Get Class Scheme Search By RFS (GetClassSchemeSearchByRFS_1)

Use the GetClassSchemeSearch_1 method to retrieve a list of classification schemes that are available for the specified country. A classification is a designation assigned to assets based on various characteristics of the assets. For example, "Equity North America" is a classification assigned to an asset. Classifications are organized into classification schemes. Lipper provides multiple classification schemes around the world. For example, Equity North America is a classification within the Lipper Global Classification scheme. The example below retrieves class schemes which names begin with 'Ab' and are displayed in English language: XML Sample Request - Making Class Scheme Search By RFS

458

TRKD API Developer's Guide

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperS earch_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperS earch_1/ G etC lassS chemeS earchBy RF S _1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etC lassS chemeS earchBy RF S _Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperS earch_1"> <country C ode>U S A </country C ode> <language>E nglish</language> <prov ideC lasses>true</prov ideC lasses> </G etC lassS chemeS earchBy RF S _Request_1> </Body > </E nv elope>

Paramet Description er countryCo The country for which classification schemes will be returned. For full listing of available counties, see section de Countries Enumeration in the Lipper Data Enumerations chapter. language The display language for the search results. provideCla If set to 'true' then the classifications for each classification scheme will be included in the results; if set to 'false' sses then no classification types will be included in the results. Note: Lipper automatically defaults to American English if the requested data is unavailable in the language specified in the language option. The response returns a list of <ClassSchemeType> elements that contain the classification schemes that are registered for sale in the country specified in the <countryCode> parameter. XML Sample Response - Making Class Scheme Search By RFS
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperS earch_1/ G etC lassS chemeS earchBy RF S _1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etC lassS chemeS earchBy RF S _Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperS earch_1"> <C lassS chemeS earchBy RF S Result> <C lassS chemeTy pe> <C lassS chemeId>2067</C lassS chemeId> <C lassS chemeC ode>F RA N C E </C lassS chemeC ode> <C lassS chemeN ame>A M F </C lassS chemeN ame> <Language>E nglish</Language> <C lassList> <C lassTy pe> <C lassId>4383</C lassId> <C lassN ame>A ctions C ommunaute E uropeenne</C lassN ame> <Language>E nglish</Language> </C lassTy pe> <C lassTy pe> <C lassId>2071</C lassId> <C lassN ame>A ctions F rance</C lassN ame> <Language>E nglish</Language> </C lassTy pe> <C lassTy pe>

Lipper Search

459

<C lassId>2073</C lassId> <C lassN ame>A ctions Internationales</C lassN ame> <Language>E nglish</Language> </C lassTy pe> ... </C lassList> <LipperId>0</LipperId> </C lassS chemeTy pe> ... </C lassS chemeS earchBy RF S Result> </G etC lassS chemeS earchBy RF S _Response_1> </Body > </E nv elope>

Element

Description

ClassSchemeI The classification scheme's numeric ID. d ClassSchemeC The classification scheme's numeric code. ode ClassSchemeN The name of the classification scheme. ame Language ClassList The display language for classification data. The asset's classification list for the classification scheme set in <ClassSchemeName>. A ClassificationList is the set of classifications that belong to a classification scheme. Contains the following elements: ClassId - the classification type's numeric ID. ClassName - the name of the classification type. Language - the display language for classification data. The asset's Lipper ID.

LipperId

21.5

Get Cross Reference Search (GetCrossReferenceSearch_1)

The GetCrossReferenceSearch_1 method can be used to retrieve assets that have cross-reference codes that match the given search string. A cross-reference code is a unique identifier that represents an asset. For example, "ticker symbol" or CUSIP, or ISIN are cross-reference codes. The example below retrieves assets with their cross-reference codes and which names begin with 'Ab': XML Sample Request - Making Cross Reference Search
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperS earch_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperS earch_1/ G etC rossReferenceS earch_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etC rossReferenceS earch_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperS earch_1"> <searchS tring>A b</searchS tring> <crossReferenceS earchS ty le>BeginsWith</crossReferenceS earchS ty le> </G etC rossReferenceS earch_Request_1> </Body > </E nv elope>

Paramet Description

460

TRKD API Developer's Guide

er searchstri The cross-reference code (or a set of codes) that correspond to the specified search string value. ng crossRefe The search style, either Begins W ith or Ex act. 'BeginsWith' will search for assets based on the specified name, renceSear while 'Exact' is used with Symbol search and requires an exact identifier such as CUSIP. chStyle The response returns a list of <SearchResultType> elements that contain the assets that meet the search criteria. XML Sample Response - Making Cross Reference Search
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperS earch_1/ G etC rossReferenceS earch_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etC rossReferenceS earch_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperS earch_1"> <C rossReferenceS earchResult> <S earchResultTy pe> <LipperId>11031841</LipperId> <Language>E nglish</Language> <A ssetN ame>Brazil P olicy Rates C DI (% p.y ., basic 252)</A ssetN ame> <A ssetC ategory >Indices</A ssetC ategory > <C ode>aBRC DIY</C ode> <C odeN ame>RIC / Triarch C ode</C odeN ame> </S earchResultTy pe> <S earchResultTy pe> <LipperId>11031842</LipperId> <Language>E nglish</Language> <A ssetN ame>Brazil S elic Rate</A ssetN ame> <A ssetC ategory >Indices</A ssetC ategory > <C ode>aBRS E LIC </C ode> <C odeN ame>RIC / Triarch C ode</C odeN ame> </S earchResultTy pe> ... <S earchResultTy pe> <LipperId>77009707</LipperId> <Language>E nglish</Language> <A ssetN ame>N U O v erseas E quity BRA S S P M 02-P en</A ssetN ame> <Domicile>U K</Domicile> <A ssetC ategory >P ension F unds</A ssetC ategory > <P romoter>N orw ich U nion</P romoter> <A dministrator>N orw ich U nion Life S erv ices Limited</A dministrator> <C ode>A BI0274</C ode> <C odeN ame>A dministrator C ode</C odeN ame> </S earchResultTy pe> </C rossReferenceS earchResult> </G etC rossReferenceS earch_Response_1> </Body > </E nv elope>

Element LipperId Language AssetName Domicile AssetCatego ry Promoter Administrato

Description The asset's Lipper ID. The display language for the asset identity information. The name of the asset. The asset's domicile. The asset's category. Asset Category identifies the universe that the asset belongs to, such as, mutual fund, indices, exchange traded fund, etc. The asset's promoter's name. A promoter is the company responsible for promoting the fund. The asset's administrator's name. The administrator provides back office support and compliance services to

Lipper Search

461

r Code CodeName

the fund. The alphabetic code of the asset. The name of the code.

21.6

Get Cross Reference Search By Universe (GetCrossReferenceSearchByUniverse_1)

The GetCrossReferenceSearchByUniverse_1 method can be used to retrieve cross-reference codes matching the search string and search style based on universe. A cross-reference code is a unique identifier that represents an asset. For example, "ticker symbol" or CUSIP, or ISIN are cross-reference codes. The example below retrieves assets with their cross-reference codes and which names begin with 'Ab' for the USA universe: XML Sample Request - Making Cross Reference Search By Universe
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperS earch_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperS earch_1/ G etC rossReferenceS earchBy U niv erse_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etC rossReferenceS earchBy U niv erse_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperS earch_1"> <searchS tr>A b</searchS tr> <univ erseC ode>U S A </univ erseC ode> <crossreferencesearchS ty le>BeginsWith</crossreferencesearchS ty le> </G etC rossReferenceS earchBy U niv erse_Request_1> </Body > </E nv elope>

Paramet Description er searchStr The search string. universeC The code of the Universe. For full listing of universe codes, see section Universe Enumeration in the Lipper Data ode Enumerations chapter. crossrefer Specifies how the search should be performed. The possible value could be ' BeginsW ith' and 'Ex act'. 'BeginsWith' encesearc will search for assets based on the specified name, while 'Exact' is used with Symbol search and requires an hStyle exact identifier such as CUSIP. The response returns a list of <LipperLeaderSearchResultType> matching the specified criteria using the specified search style. XML Sample Response - Making Cross Reference Search By Universe
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperS earch_1/ G etC rossReferenceS earchBy U niv erse_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader>

462

TRKD API Developer's Guide

<s:Body > <G etC rossReferenceS earchBy U niv erse_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperS earch_1"> <C rossReferenceS earchBy U niv erseResult> <LipperLeaderS earchResultTy pe> <LipperId>40001457</LipperId> <Language>E nglish</Language> <A ssetN ame>M under Bond F und;K</A ssetN ame> <Domicile>U S A </Domicile> <A ssetC ategory >M utual F unds</A ssetC ategory > <P romoter>M U N DE R C A P ITA L M A N A G E M E N T</P romoter> <A dministrator>M U N DE R C A P ITA L M A N A G E M E N T</A dministrator> <C ode>A BDIX.O ^F 95</C ode> <C odeN ame>RIC </C odeN ame> <A ssetTy peN ame>Bond</A ssetTy peN ame> <DataDate>2009-03-31</DataDate> <RecordC ount>324</RecordC ount> </LipperLeaderS earchResultTy pe> <LipperLeaderS earchResultTy pe> <LipperId>40001460</LipperId> <Language>E nglish</Language> <A ssetN ame>M under Bond F und;A </A ssetN ame> <Domicile>U S A </Domicile> <A ssetC ategory >M utual F unds</A ssetC ategory > <P romoter>M U N DE R C A P ITA L M A N A G E M E N T</P romoter> <A dministrator>M U N DE R C A P ITA L M A N A G E M E N T</A dministrator> <C ode>A BRA X.O ^F 95</C ode> <C odeN ame>RIC </C odeN ame> <A ssetTy peN ame>Bond</A ssetTy peN ame> <DataDate>2009-03-31</DataDate> <RecordC ount>324</RecordC ount> </LipperLeaderS earchResultTy pe> ... <LipperLeaderS earchResultTy pe> <LipperId>40094506</LipperId> <Language>E nglish</Language> <A ssetN ame>Riv erS ource P ortfolio Builder C onserv ativ e F und;B</A ssetN ame> <Domicile>U S A </Domicile> <A ssetC ategory >M utual F unds</A ssetC ategory > <P romoter>RIV E RS O U RC E IN V E S TM E N TS LLC </P romoter> <A dministrator>A M E RIP RIS E F IN A N C IA L IN C </A dministrator> <C ode>A BBDX</C ode> <C odeN ame>N A S DA Q Ticker</C odeN ame> <A ssetTy peN ame>M ixed A ssets</A ssetTy peN ame> <DataDate>2009-03-31</DataDate> <RecordC ount>324</RecordC ount> </LipperLeaderS earchResultTy pe> </C rossReferenceS earchBy U niv erseResult> </G etC rossReferenceS earchBy U niv erse_Response_1> </Body > </E nv elope>

Element LipperId Language AssetName Domicile AssetCatego ry Promoter Administrato r Code CodeName AssetTypeN ame DataDate RecordCount

Description The asset's Lipper ID. The display language for the asset identity information. The name of the asset. The asset's domicile. The asset's category. An asset category identifies the universe that the asset belongs to, such as, mutual fund, indices, exchange traded fund, etc. The asset's promoter's name. A promoter is the company responsible for promoting the fund. The asset's administrator's name. The administrator provides back office support and compliance services to the fund. The alphabetic code of the asset. The name of the code. The name of the asset type. The data date. The number of found records.

Lipper Search

463

21.7

Get Fund Name Search Max Records (GetFundNameSearchMaxRecords_1)

You can use the GetFundNameSearchMaxRecords_1 method to perform a search by fund name and retrieve the assets that meet the given criteria. The number of assets returned is controlled by maximum records setting. The example below searches for assets, the names of which begin with 'Ab' and returns maximum 100 records: XML Sample Request - Retrieving Fund Name Search Max Records
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperS earch_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperS earch_1/ G etF undN ameS earchM axRecords_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etF undN ameS earchM axRecords_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperS earch_1"> <searchS tring>A b</searchS tring> <searchS ty le>BeginsWith</searchS ty le> <maxRecords>100</maxRecords> </G etF undN ameS earchM axRecords_Request_1> </Body > </E nv elope>

Paramet Description er searchStri The search string. ng searchStyl The search style, either Begins W ith or C ontains. Both values search assets based on the specified name. e 'BeginsWith' searches only for assets which names begin with the specified values, while 'Contains' - which names contain the specified value in any position. maxRecor The maximum number of assets to be returned at one time. ds The response returns a list of <AssetIdentityType> elements that contain the assets that meet the given search criteria. XML Sample Response - Retrieving Fund Name Search Max Records
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperS earch_1/ G etF undN ameS earchM axRecords_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etF undN ameS earchM axRecords_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperS earch_1"> <F undN ameS earchM axRecordsResult> <A ssetIdentity Ty pe> <LipperId>11028279</LipperId> <Language>E nglish</Language> <N ame>A BG N ordic TM T C R</N ame> </A ssetIdentity Ty pe> <A ssetIdentity Ty pe>

464

TRKD API Developer's Guide

<LipperId>19074014</LipperId> <Language>E nglish</Language> <N ame>A BI U K - A sia P acific ex Japan E quities-Life</N ame> </A ssetIdentity Ty pe> <A ssetIdentity Ty pe> <LipperId>19074013</LipperId> <Language>E nglish</Language> <N ame>A BI U K - A sia P acific inc Japan E quities-Life</N ame> </A ssetIdentity Ty pe> ... <A ssetIdentity Ty pe> <LipperId>11029236</LipperId> <Language>E nglish</Language> <N ame>A bu Dhabi S ecurities M arket C R</N ame> </A ssetIdentity Ty pe> </F undN ameS earchM axRecordsResult> </G etF undN ameS earchM axRecords_Response_1> </Body > </E nv elope>

Elemen t LipperId Languag e Name

Description The asset's Lipper ID. The display language for asset identity information. The full name of the asset.

21.8

Get Fund Name Search Max Records By Universe (GetFundNameSearchMaxRecordsByUniverse_1)

You can use the GetFundNameSearchMaxRecordsByUniverse_1 method to perform a search by fund name and retrieve the assets that meet the given criteria by universe. The number of assets returned is controlled by maximum records setting. The example below searches for assets, the names of which begin with 'Ab' and returns maximum 100 records: XML Sample Request - Retrieving Fund Name Search Max Records By Universe
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperS earch_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperS earch_1/ G etF undN ameS earchM axRecordsBy U niv erse_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etF undN ameS earchM axRecordsBy U niv erse_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/ LipperS earch_1"> <searchS tring>A b</searchS tring> <univ erseC ode>U S A </univ erseC ode> <searchS ty le>BeginsWith</searchS ty le> <maxRecords>100</maxRecords> </G etF undN ameS earchM axRecordsBy U niv erse_Request_1> </Body > </E nv elope>

Paramet Description er searchStri The search string. ng

Lipper Search

465

universeC ode searchStyl e

The universe code. For full listing of universe codes, see section Universe Enumeration in the Lipper Data Enumerations chapter. The search style, either Begins W ith or C ontains. Both values search assets based on the specified name. 'BeginsWith' searches only for assets which names begin with the specified values, while 'Contains' - which names contain the specified value in any position. maxRecor The maximum number of assets to be returned at one time. ds The response returns a list of <AssetIdentityType> elements that contain the assets that meet the given search criteria. XML Sample Response - Retrieving Fund Name Search Max Records By Universe
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperS earch_1/ G etF undN ameS earchM axRecordsBy U niv erse_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etF undN ameS earchM axRecordsBy U niv erse_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/ LipperS earch_1"> <F undN ameS earchM axRecordsBy U niv erseResult> <A ssetIdentity Ty pe> <LipperId>40095941</LipperId> <Language>E nglish</Language> <N ame>A berdeen C hina O pportunities F und;A </N ame> </A ssetIdentity Ty pe> <A ssetIdentity Ty pe> <LipperId>40095942</LipperId> <Language>E nglish</Language> <N ame>A berdeen C hina O pportunities F und;B</N ame> </A ssetIdentity Ty pe> <A ssetIdentity Ty pe> <LipperId>40095943</LipperId> <Language>E nglish</Language> <N ame>A berdeen C hina O pportunities F und;C </N ame> </A ssetIdentity Ty pe> <A ssetIdentity Ty pe> <LipperId>40095946</LipperId> <Language>E nglish</Language> <N ame>A berdeen C hina O pportunities F und;Inst S erv ice</N ame> </A ssetIdentity Ty pe> <A ssetIdentity Ty pe> <LipperId>40095945</LipperId> <Language>E nglish</Language> <N ame>A berdeen C hina O pportunities F und;Institutional</N ame> </A ssetIdentity Ty pe> ... <A ssetIdentity Ty pe> <LipperId>40039305</LipperId> <Language>E nglish</Language> <N ame>A BN A M RO /C hicago Trust S m C ap V al F und (C lass N )</N ame> </A ssetIdentity Ty pe> </F undN ameS earchM axRecordsBy U niv erseResult> </G etF undN ameS earchM axRecordsBy U niv erse_Response_1> </Body > </E nv elope>

Elemen Description t LipperId The asset's Lipper ID. Languag The display language for asset identity information. e

466

TRKD API Developer's Guide

Name

The full name of the asset.

21.9

Get Fund Name Search Paging (GetFundNameSearchPaging_1)

By using the GetFundNameSearchPaging_1 method you can perform a search by fund name and returns the assets that meet the given criteria. The number of assets returned is controlled by paging, for example, setting 'paginationStart' to 1 'paginationEnd' to 5 will return results one through five pages only. The example below searches for attributes of Asset Type, the names of which begin with 'Ab' and shows pages from 1 to 3: XML Sample Request - Getting Fund Name Search Paging
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperS earch_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperS earch_1/ G etF undN ameS earchP aging_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etF undN ameS earchP aging_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperS earch_1"> <searchS tring>A b</searchS tring> <searchS ty le>BeginsWith</searchS ty le> <paginationS tart>1</paginationS tart> <paginationE nd>3</paginationE nd> </G etF undN ameS earchP aging_Request_1> </Body > </E nv elope>

Paramet Description er searchStri The search string. ng searchStyl The search style, either Begins W ith or C ontains. Both values search assets based on the specified name. e 'BeginsWith' searches only for assets which names begin with the specified values, while 'Contains' - which names contain the specified value in any position. pagination The pagination start number. Start pagination The pagination end number. End Note: 'PaginationStart' and 'PaginationEnd' give a user the ability to control the returned results from the search query. For example, setting 'paginationStart' to 1 and 'paginationEnd' to 5 will return results one through five page only. The response returns a list of <AssetIdentityType> elements that contain the assets that meet the search criteria. XML Sample Response - Getting Fund Name Search Paging
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperS earch_1/ G etF undN ameS earchP aging_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader>

Lipper Search

467

<s:Body > <G etF undN ameS earchP aging_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperS earch_1"> <F undN ameS earchP agingResult> <A ssetIdentity Ty pe> <LipperId>11028279</LipperId> <Language>E nglish</Language> <N ame>A BG N ordic TM T C R</N ame> </A ssetIdentity Ty pe> <A ssetIdentity Ty pe> <LipperId>11029236</LipperId> <Language>E nglish</Language> <N ame>A bu Dhabi S ecurities M arket C R</N ame> </A ssetIdentity Ty pe> <A ssetIdentity Ty pe> <LipperId>11033050</LipperId> <Language>E nglish</Language> <N ame>A BN A M RO LLB M E N A Top 20 V alue C R</N ame> </A ssetIdentity Ty pe> </F undN ameS earchP agingResult> </G etF undN ameS earchP aging_Response_1> </Body > </E nv elope>

Elemen t LipperId Languag e Name

Description The asset's Lipper ID. The display language for asset identity information. Asset identity is the information used to characterize the fund such as LipperID or fund name. The full name of the asset.

21.10 Get Fund Name Search Pagination By RFS (GetFundNameSearchPaginationByRFS_1)

By using the GetFundNameSearchPaginationByRFS_1 method you can search for funds that belong to the specified country. The number of funds returned is controlled by paging, for example, setting 'paginationStart' to 1 'paginationEnd' to 5 will return results one through five pages only. Pagination are controls that allow the user to control the results from requests passed into the services. For example, if a client is using Lipper Web Services to build a web-site, they can use pagination to control how many search results display on the screen. The example below searches for attributes of Asset Type, the names of which begin with 'Int' and shows pages from 10 to 20 for the USA: XML Sample Request - Making Fund Name Search Pagination By RFS
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperS earch_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperS earch_1/ G etF undN ameS earchP aginationBy RF S _1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etF undN ameS earchP aginationBy RF S _Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperS earch_1"> <searchS tring>Int</searchS tring> <searchS ty le>BeginsWith</searchS ty le> <paginationS tart>10</paginationS tart> <paginationE nd>20</paginationE nd> <countries> <C ountries>U S A </C ountries>

468

TRKD API Developer's Guide

</countries> </G etF undN ameS earchP aginationBy RF S _Request_1> </Body > </E nv elope>

Paramet Description er searchStri The search string. ng searchStyl The search style, either Begins W ith or C ontains. Both values search assets based on the specified name. e 'BeginsWith' searches only for assets which names begin with the specified values, while 'Contains' - which names contain the specified value in any position. pagination The pagination start number. Start pagination The pagination end number. End countries The country (list of countries) for which assets will be returned. For full listing of available counties, see section Countries Enumeration in the Lipper Data Enumerations chapter.

Note: 'PaginationStart' and 'PaginationEnd' give a user the ability to control the returned results from the search query. For example, setting 'paginationStart' to 1 and 'paginationEnd' to 5 will return results one through five page only. The response returns a list of <SearchResultType> elements that contain the assets that meet the search criteria. XML Sample Response - Making Fund Name Search Pagination By RFS
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperS earch_1/ G etF undN ameS earchP aginationBy RF S _1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > G etF undN ameS earchP aginationBy RF S _Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperS earch_1"> <F undN ameS earchP aginationBy RF S Result> <S earchResultTy pe> <LipperId>40003911</LipperId> <Language>E nglish</Language> <A ssetN ame>Integrity Income F und (C lass N )</A ssetN ame> <Domicile>U S A </Domicile> <A ssetC ategory >M utual F unds</A ssetC ategory > <P romoter>IN TE G RITY M O N E Y M A N A G E M E N T IN C </P romoter> <A dministrator>IN TE G RITY F U N D S E RV IC E S IN C </A dministrator> </S earchResultTy pe> <S earchResultTy pe> <LipperId>40003912</LipperId> <Language>E nglish</Language> <A ssetN ame>Integrity E quity F und;N </A ssetN ame> <Domicile>U S A </Domicile> <A ssetC ategory >M utual F unds</A ssetC ategory > <P romoter>IN TE G RITY M O N E Y M A N A G E M E N T IN C </P romoter> <A dministrator>IN TE G RITY F U N D S E RV IC E S IN C </A dministrator> </S earchResultTy pe> <S earchResultTy pe> <LipperId>40005204</LipperId> <Language>E nglish</Language> <A ssetN ame>Integrity N D Tax-F ree F und;B</A ssetN ame> <Domicile>U S A </Domicile> <A ssetC ategory >M utual F unds</A ssetC ategory > <P romoter>IN TE G RITY M O N E Y M A N A G E M E N T IN C </P romoter> </S earchResultTy pe> ... <S earchResultTy pe>

Lipper Search

469

<LipperId>40009462</LipperId> <Language>E nglish</Language> <A ssetN ame>Integ "I"G mst:V IP M M ;I</A ssetN ame> <Domicile>U S A </Domicile> <A ssetC ategory >Insurance F unds</A ssetC ategory > <P romoter>IN TE G RITY LIF E IN S U RA N C E C O </P romoter> </S earchResultTy pe> </F undN ameS earchP aginationBy RF S Result> </G etF undN ameS earchP aginationBy RF S _Response_1> </Body > </E nv elope>

Element LipperId Language AssetName Domicile AssetCatego ry Promoter Administrato r Code CodeName

Description The asset's Lipper ID. The display language for the asset identity information. The name of the asset. The asset's domicile. The asset's category. An asset category identifies the universe that the asset belongs to, such as, mutual fund, indices, exchange traded fund, etc. The asset's promoter's name. A promoter is the company responsible for promoting the fund. The asset's administrator's name. The administrator provides back office support and compliance services to the fund. The alphabetic code of the asset. The name of the code.

21.11 Get Legal Structure Search (GetLegalStructureSearch_1)

The GetLegalStructureSearch_1 method can be used to retrieve the assets that have the specified legal structure. Legal structure is treated like an attribute of the asset and represents the way the asset has been formed for operation. The example below retrieves assets which contain 'Inv' in their names and are displayed in English language: XML Sample Request - Making Legal Structure Search
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperS earch_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperS earch_1/ G etLegalS tructureS earch_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etLegalS tructureS earch_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperS earch_1"> <searchS tring>Inv </searchS tring> <language>E nglish</language> </G etLegalS tructureS earch_Request_1> </Body > </E nv elope>

Paramet Description er searchStri The legal structure according to the specified search string value for which assets will be returned. Note that this ng field does not accept any special characters. language The display language for the search results.

470

TRKD API Developer's Guide

Note: Lipper automatically defaults to American English if the requested data is unavailable in the language specified in the language option. The response returns a list of <LegalStructureType> elements that contain the assets that meet the given search criteria. XML Sample Response - Making Legal Structure Search
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperS earch_1/ G etLegalS tructureS earch_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etLegalS tructureS earch_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperS earch_1"> <LegalS tructureS earchResult> <LegalS tructureTy pe> <LipperId>60095668</LipperId> <Language>E nglish</Language> <LegalS tructureId>1129</LegalS tructureId> <LegalS tructureC ode>IN V F O N DS </LegalS tructureC ode> <LegalS tructureN ame>DE - Inv estmentfonds</LegalS tructureN ame> </LegalS tructureTy pe> <LegalS tructureTy pe> <LipperId>60036311</LipperId> <Language>E nglish</Language> <LegalS tructureId>1129</LegalS tructureId> <LegalS tructureC ode>IN V F O N DS </LegalS tructureC ode> <LegalS tructureN ame>DE - Inv estmentfonds</LegalS tructureN ame> </LegalS tructureTy pe> <LegalS tructureTy pe> <LipperId>60055269</LipperId> <Language>E nglish</Language> <LegalS tructureId>1129</LegalS tructureId> <LegalS tructureC ode>IN V F O N DS </LegalS tructureC ode> <LegalS tructureN ame>DE - Inv estmentfonds</LegalS tructureN ame> </LegalS tructureTy pe> <LegalS tructureTy pe> <LipperId>60074804</LipperId> <Language>E nglish</Language> <LegalS tructureId>1129</LegalS tructureId> <LegalS tructureC ode>IN V F O N DS </LegalS tructureC ode> <LegalS tructureN ame>DE - Inv estmentfonds</LegalS tructureN ame> </LegalS tructureTy pe> ... <LegalS tructureTy pe> <LipperId>65139728</LipperId> <Language>E nglish</Language> <LegalS tructureId>1129</LegalS tructureId> <LegalS tructureC ode>IN V F O N DS </LegalS tructureC ode> <LegalS tructureN ame>DE - Inv estmentfonds</LegalS tructureN ame> </LegalS tructureTy pe> </LegalS tructureS earchResult> </G etLegalS tructureS earch_Response_1> </Body > </E nv elope>

Element LipperId Language LegalStructur eId LegalStructur eCode

Description The asset's Lipper ID. The Language ID that represents the data language for the legal structure information. The legal structure numeric ID. The legal structure alphabetic code.

Lipper Search

471

LegalStructur The name of the legal structure. eName

21.12 Get Lipper Leader Score Search (GetLipperLeaderScoreSearch_1)

The GetLipperLeaderScoreSearch_1 method can be used to retrieve Lipper Leader Scores that meet the specified criteria. Lipper Leader Score is a rating (1-5, with 5 being high) that Lipper assigns to a fund. Lipper Leader Scores are given for a number of categories: total return, consistent return, preservation, tax efficiency, and expense. The example below retrieves Lipper Leader Scores for the assets with the specified LipperIDs for International Offshore Universe, displayed in English language and sorted by default in ascending order and shows pages from 1 to 20: XML Sample Request - Making Lipper Leader Score Search
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperS earch_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperS earch_1/ G etLipperLeaderS coreS earch_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etLipperLeaderS coreS earch_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperS earch_1"> <lipperIds> <int>60087648</int> <int>65145151</int> <int>60003332</int> <int>60003331</int> <int>60003333</int> </lipperIds> <language>E nglish</language> <univ erseId>IN TL</univ erseId> <sortBy >Default</sortBy > <sortingO rder>A scending</sortingO rder> <paginationS tart>1</paginationS tart> <paginationE nd>20</paginationE nd> </G etLipperLeaderS coreS earch_Request_1> </Body > </E nv elope>

Paramet er lipperIds language universeId sortBy

Description The Lipper IDs of the assets to be included in the response. The display language for the search results. The ID of the Universe. For full listing of universes, see section Universe Enumeration in the Lipper Data Enumerations chapter. The value by which the results must be sorted. Possible values are: Asset Type Class Name Consistent Return Rating Default Expense Rating Fund Company Name Preservation Rating Return Value Tax Efficiency Rating

472

TRKD API Developer's Guide

Total Return Rating sortingOrd The order by which results must sorted - A scending or Descending. er pagination The pagination start number. Start pagination The pagination end number. End Note: 'PaginationStart' and 'PaginationEnd' give a user the ability to control the returned results from the search query. For example, setting 'paginationStart' to 1 and 'paginationEnd' to 5 will return results one through five page only. Note: Lipper automatically defaults to American English if the requested data is unavailable in the language specified in the language option. The response returns a list of <LipperLeaderClassItems> that contain the assets that meet the given search criteria. XML Sample Response - Making Lipper Leader Score Search
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperS earch_1/ G etLipperLeaderS coreS earch_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etLipperLeaderS coreS earch_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperS earch_1"> <LipperLeaderS coreS earchResult> <LipperLeaderC lassItem> <LipperLeaderC lassListTy pe> <LipperId>60003332</LipperId> <Language>E nglish</Language> <N ame>Janus G lobal Life S ciences A U S D A cc</N ame> <DataDate>2009-04-30</DataDate> <C lassN ame>E quity S ector P harma&amp;H ealth</C lassN ame> <A ssetTy peN ame>E quity </A ssetTy peN ame> <F undC ompany >Janus C apital F unds P lc</F undC ompany > <F undC ompany P romoterId>1277696</F undC ompany P romoterId> <F undC ompany P romoterN ame>Janus</F undC ompany P romoterN ame> <P eriod>O v erall</P eriod> <TotalReturnRating>2</TotalReturnRating> <C onsistentReturnRating>2</C onsistentReturnRating> <P reserv ationRating>5</P reserv ationRating> <TaxE fficiency Rating xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <E xpenseRating xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <ReturnV alue>-6.242040</ReturnV alue> <RecordC ount>3</RecordC ount> </LipperLeaderC lassListTy pe> ... <LipperLeaderC lassListTy pe> <LipperId>60003331</LipperId> <Language>E nglish</Language> <N ame>Janus U S F lexible Income B U S D A cc</N ame> <DataDate>2009-04-30</DataDate> <C lassN ame>Bond U S D</C lassN ame> <A ssetTy peN ame>Bond</A ssetTy peN ame> <F undC ompany >Janus C apital F unds P lc</F undC ompany > <F undC ompany P romoterId>1277696</F undC ompany P romoterId> <F undC ompany P romoterN ame>Janus</F undC ompany P romoterN ame> <P eriod>O v erall</P eriod> <TotalReturnRating>2</TotalReturnRating> <C onsistentReturnRating>3</C onsistentReturnRating> <P reserv ationRating>5</P reserv ationRating> <TaxE fficiency Rating xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <E xpenseRating xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"/> <ReturnV alue>1.617650</ReturnV alue> <RecordC ount>3</RecordC ount>

Lipper Search

473

</LipperLeaderC lassListTy pe> </LipperLeaderC lassItem> <U niv erseC ode>IN TL</U niv erseC ode> </LipperLeaderS coreS earchResult> </G etLipperLeaderS coreS earch_Response_1> </Body > </E nv elope>

Element LipperId Language Name DataDate Classname AssetTypeN ame FundCompan y FundCompan yPromoterId FundCompan yPromoterNa me Period TotalReturn Rating ConsistentR eturnRating Preservation Rating TaxEfficienc yRating ExpenseRati ng ReturnValue RecordCount UniverseCod e

Description The asset's Lipper ID. The language that represents the display language for the Lipper Leader Score information. The full name of the asset. The date for which the information is valid. The name of the classification type. The name of the asset type. The full name of the fund company. The name (ID) of the fund company promoter. A promoter is an insurance company or its subsidiary that underwrites and guarantees the death benefits and other aspects of Variable Insurance Product contracts. The name of the fund company promoter.

The period for which the data is shown. The Total Return Rating denotes a fund that has provided superior total returns (income from dividends and interest as well as capital appreciation) when compared to a group of similar funds. The Consistent Return Rating identifies a fund that has provided relatively superior consistency and riskadjusted returns when compared to a group of similar funds. The Preservation Rating identifies a fund that has demonstrates a superior ability to preserve capital in a variety of markets when compared with other funds in its asset class. The Tax Efficiency Rating identifies a fund that has been successful at deferring taxes over the measurement period relative to similar funds. The Expense Rating identifies a fund that has successfully managed to keep its expenses low relative to its peers and within its load structure. The overall return value. The overall return. The code of the Universe.

21.13 Get Search Keyword By Asset Type (GetSearchKeywordByAssetType_1)

Use the GetSearchKeywordByAssetType_1 method to search for assets and asset types by the specified keyword. The number of assets returned is controlled by maximum records setting. The example below searches for asset, the names of which begin with 'ABI' in 'Mixed Assets' and returns maximum 100 records: XML Sample Request - Performing Search Keyword By Asset Type
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperS earch_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperS earch_1/ G etS earchKey w ordBy A ssetTy pe_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1">

474

TRKD API Developer's Guide

<A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etS earchKey w ordBy A ssetTy pe_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperS earch_1"> <key w ord>A BI</key w ord> <searchS ty le>BeginsWith</searchS ty le> <assetTy peN ame>M ixedA ssets</assetTy peN ame> <maxRecords>100</maxRecords> </G etS earchKey w ordBy A ssetTy pe_Request_1> </Body > </E nv elope>

Paramet Description er keyword The keyword by which the search must be performed. searchStyl The search style, either Begins W ith or C ontains. Both values search assets based on the specified name. e 'BeginsWith' searches only for assets which names begin with the specified values, while 'Contains' - which names contain the specified value in any position. assetType The name of the asset type. Available asset type names are: Name Bond - Bond Equity - Equity MixedAssets - Mixed Assets MoneyMarket - Money Market RealEstate - Real Estate Other - Other Unassigned - Unassigned Unknown - Unknown maxRecor The maximum number of assets to be returned at one time. ds The response returns a list of <AssetIdentityType> elements that contain the assets that meet the given search criteria. XML Sample Response - Performing Search Keyword By Asset Type
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperS earch_1/ G etS earchKey w ordBy A ssetTy pe_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etS earchKey w ordBy A ssetTy pe_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperS earch_1"> <S earchKey w ordBy A ssetTy peResult> <A ssetIdentity Ty pe> <LipperId>19005018</LipperId> <Language>E nglish</Language> <N ame>A BI U K O ld - Balanced M anaged-Life</N ame> </A ssetIdentity Ty pe> <A ssetIdentity Ty pe> <LipperId>19008018</LipperId> <Language>E nglish</Language> <N ame>A BI U K O ld - Balanced M anaged-P en</N ame> </A ssetIdentity Ty pe> <A ssetIdentity Ty pe> <LipperId>19005027</LipperId> <Language>E nglish</Language> <N ame>A BI U K O ld - C autious M anaged-Life</N ame> </A ssetIdentity Ty pe> <A ssetIdentity Ty pe> <LipperId>19008027</LipperId> <Language>E nglish</Language>

Lipper Search

475

<N ame>A BI U K O ld - C autious M anaged-P en</N ame> </A ssetIdentity Ty pe> ... <A ssetIdentity Ty pe> <LipperId>60087648</LipperId> <Language>E nglish</Language> <N ame>A BIC O U K Balanced</N ame> </A ssetIdentity Ty pe> <A ssetIdentity Ty pe> <LipperId>60079650</LipperId> <Language>E nglish</Language> <N ame>A BIS F lessibile</N ame> </A ssetIdentity Ty pe> </S earchKey w ordBy A ssetTy peResult> </G etS earchKey w ordBy A ssetTy pe_Response_1> </Body > </E nv elope>

Elemen t LipperId Languag e Name

Description The asset's Lipper ID. The display language for asset identity information. Asset identity is the information used to characterize the fund such as LipperID or fund name. The full name of the asset.

476

TRKD API Developer's Guide

chapter 22

Lipper Utilities

The Lipper Utilities service provides methods that allow the user to retrieve auxiliary data that may be used as parameter values by other Lipper methods in Lipper, such as lists of enumerations for Lipper data types. The following methods are available in Lipper Utilities: Get Benchmarks (GetBenchmarks_1) - returns the benchmarks exposed by Lipper. Get Class Schemes (GetClassSchemes_1) - returns a list of classification schemes supported by Lipper. Get Class Schemes Details (GetClassSchemesDetails_1) - returns all available information for the given classification scheme and the scheme's classes. Get Country List (GetCountryList_1) - returns a list of the countries supported in Lipper. Get Cross Reference Codes (GetCrossReferenceCodes_1) - returns a list of the cross-reference codes supported by Lipper. Get Currency List (GetCurrencyList_1) - returns a list of the currencies that are supported by Lipper. Get Domiciles (GetDomiciles_1) - returns a list of the domiciles supported by Lipper. Get EU Tax Directive - (GetEUTaxDirective_1) - returns the European Union tax directives supported by Lipper. Get Flag Groups (GetFlagGroups_1) - returns a list of the flag groups supported by Lipper. Get Languages (GetLanguages_1) - returns a list of the languages supported by Lipper. Get Lipper Leader Score Dates (GetLipperLeaderScoreDates_1) - returns the date when Lipper Leader Scores (LLS) were last updated. Get Price Estimation (GetPriceEstimation_1) - returns the price estimation benchmarks exposed by Lipper. Get Risk Free Index (GetRiskFreeIndex_1) - returns the risk free index benchmarks exposed by Lipper. Get Technical Indicators (GetTechnicalIndicators_1) - returns the Lipper technical indicators that are exposed by Lipper. Get Universes (GetUniverses_1) - returns the list of asset universes supported by Lipper.

22.1

Authentication/Authorization, Service Endpoint, and Required Headers

Authorization All requests to the Lipper Utilities service require an authorization token. For details, see section Understanding Authentication Tokens. Authentication The Lipper Utilities service uses Reuters impersonation tokens for each effective user. In this case, Thomson Reuters must create each user before your application authenticates them. Unmanaged effective users are not supported in the Lipper Utilities service. For additional information on creating a Service Token, see section Creating a Token. Service Endpoint Lipper Utilities Endpoint
http://api.rkd.reuters.com/api/2009/01/01/LipperU tilities_1.sv c

Required Header Required HTTP Headers

P O S T /api/2009/01/01/LipperU tilities_1.sv c H TTP /1.1 C ontent-Ty pe: application/soap+xml H ost: api.rkd.reuters.com C ontent-Length: [length]

Lipper Utilities

477

22.2

WSDL
WSDL:
http://api.rkd.reuters.com/schemas/w sdl/LipperU tilities_1_H ttpA ndRKDToken.w sdl

22.3

Get Benchmarks (GetBenchmarks_1)

Use the GetBenchmarks_1 method to retrieve the benchmarks exposed by Lipper. The example below gets the benchmarks displayed in English language. XML Sample Request - Getting Benchmarks
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperU tilities_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperU tilities_1/ G etBenchmarks_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etBenchmarks_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperU tilities_1"> <language>E nglish</language> </G etBenchmarks_Request_1> </Body > </E nv elope>

Paramet Description er language The display language for the returned list of benchmarks.

Note: Lipper automatically defaults to American English if the requested data is unavailable in the language specified in the language option. The response returns a list of all benchmarks: XML Sample Response - Getting Benchmarks
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperU tilities_1/G etBenchmarks_1_Reply </a: A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etBenchmarks_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperU tilities_1"> <G etBenchmarksResult> <A ssetIdentity Ty pe> <LipperId>11033839</LipperId> <Language>E nglish</Language> <N ame>50% M S C I G olden Dragon N et + 50% JP M G l G ov t Bd TR</N ame> </A ssetIdentity Ty pe>

478

TRKD API Developer's Guide

<A ssetIdentity Ty pe> <LipperId>11028279</LipperId> <Language>E nglish</Language> <N ame>A BG N ordic TM T C R</N ame> </A ssetIdentity Ty pe> <A ssetIdentity Ty pe> <LipperId>19074014</LipperId> <Language>E nglish</Language> <N ame>A BI U K - A sia P acific ex Japan E quities-Life</N ame> </A ssetIdentity Ty pe> ... <A ssetIdentity Ty pe> <LipperId>11020285</LipperId> <Language>E nglish</Language> <N ame>hm. C S F und of F unds (L) G row th</N ame> </A ssetIdentity Ty pe> </G etBenchmarksResult> </G etBenchmarks_Response_1> </Body > </E nv elope>

The list consists of <AssetIdentityType> elements representing asset identities, which are comprised of the asset's Lipper ID, name, and base language. Element LipperID Languag e Name Description An eight- or nine-digit number that identifies an asset. The display language for the asset identity information. The full name of the asset.

22.4

Get Class Schemes (GetClassSchemes_1)

Use the GetClassSchemes_1 method to retrieve a list of classification schemes supported by Lipper. Class is an abbreviation for 'classification'. A classification is a designation assigned to assets based on various characteristics of the assets. For example, Equity North America is a classification assigned to an asset. Classifications are organized into classification schemes. Lipper provides multiple classification schemes around the world. For example, Equity North America is a classification within the Lipper Global Classification scheme. The example below gets classification schemes and their classes displayed in English language. XML Sample Request - Getting Class Schemes
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperU tilities_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperU tilities_1/ G etC lassS chemes_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etC lassS chemes_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperU tilities_1"> <language>E nglish</language> <prov ideC lasses>true</prov ideC lasses> </G etC lassS chemes_Request_1> </Body > </E nv elope>

Parameter Description language The display language for the returned list of classification schemes.

Lipper Utilities

479

provideClass If set to true each classification scheme's classes will be included in the results. es searchString The classification scheme name for which results should be returned. To receive a list that contains all classification schemes set <searchString> to null. Note: Lipper automatically defaults to American English if the requested data is unavailable in the language specified in the language option. The response returns a list of ClassSchemes that contain the supported classification schemes and (optionally) their classes: XML Sample Response - Getting Class Schemes
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperU tilities_1/G etC lassS chemes_1_Reply </ a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etC lassS chemes_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperU tilities_1"> <G etC lassS chemesResult> <C lassS chemeO fC lassTy pe> <C lassS chemeId>1462</C lassS chemeId> <C lassS chemeC ode>A BIU KBRO KE R</C lassS chemeC ode> <C lassS chemeN ame>U K Broker F und</C lassS chemeN ame> <Language>E nglish</Language> <C lassList> <C lassTy pe> <C lassId>1463</C lassId> <C lassN ame>Life A dv enturous</C lassN ame> <Language>E nglish</Language> </C lassTy pe> <C lassTy pe> <C lassId>1464</C lassId> <C lassN ame>P ension A dv enturous</C lassN ame> <Language>E nglish</Language> </C lassTy pe> ... <C lassTy pe> <C lassId>30152</C lassId> <C lassN ame>S P M M F G nrl U ndef Dur</C lassN ame> <Language>E nglish</Language> </C lassTy pe> </C lassList> </C lassS chemeO fC lassTy pe> </G etC lassS chemesResult> </G etC lassS chemes_Response_1> </Body > </E nv elope>

Element ClassSchemeI d ClassSchemeC ode ClassSchemeN ame Language ClassList

Description The classification scheme's numeric ID. The classification scheme's numeric code. The name of the classification scheme. The display language for classification data. The asset's classification list for the classification scheme. Contains the following elements: ClassId - the classification type's numeric ID. ClassName - the name of the classification type. Language - the display language for classification data.

480

TRKD API Developer's Guide

22.5

Get Class Scheme Details (GetClassSchemeDetails_1)

Use the GetClassSchemes_1 method to retrieve the classifications which are contained within the classification scheme. The example below requests all information for the classification scheme with '167' ID and its classes displayed in English language. XML Sample Request - Getting Class Scheme Details
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperU tilities_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperU tilities_1/ G etC lassS chemeDetails_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etC lassS chemeDetails_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperU tilities_1"> <classS chemeIDs> <int>1671</int> </classS chemeIDs> <language>E nglish</language> </G etC lassS chemeDetails_Request_1> </Body > </E nv elope>

Parameter Description classScheme The ID of the classification scheme for which results should be returned. IDs language The display language for the returned classification scheme information.

Note: Lipper automatically defaults to American English if the requested data is unavailable in the language specified in the language option. The response returns a list of ClassSchemeType that contain information about the specified classification scheme: XML Sample Response - Getting Class Scheme Details
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperU tilities_1/ G etC lassS chemeDetails_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etC lassS chemeDetails_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperU tilities_1"> <G etC lassS chemeDetailsResult> <C lassS chemeO fC lassTy pe> <C lassS chemeId>1671</C lassS chemeId> <C lassS chemeC ode>U KO F F S H O RE </C lassS chemeC ode> <C lassS chemeN ame>Lipper U K O ffshore F und</C lassS chemeN ame> <Language>E nglish</Language> <C lassList> <C lassTy pe> <C lassId>5467</C lassId> <C lassN ame>E quity N th A merica S maller C os</C lassN ame> <Language>E nglish</Language>

Lipper Utilities

481

</C lassTy pe> <C lassTy pe> <C lassId>5468</C lassId> <C lassN ame>E quity U K S maller C ompanies</C lassN ame> <Language>E nglish</Language> </C lassTy pe> ... <C lassTy pe> <C lassId>1732</C lassId> <C lassN ame>E quity E uropean E x U K</C lassN ame> <Language>E nglish</Language> </C lassTy pe> </C lassList> </C lassS chemeO fC lassTy pe> </G etC lassS chemeDetailsResult> </G etC lassS chemeDetails_Response_1> </Body > </E nv elope>

Element ClassSchemeI d ClassSchemeC ode ClassSchemeN ame Language ClassList

Description The classification scheme's numeric ID. The classification scheme's numeric code. The name of the classification scheme. The display language for classification data. The asset's classification list for the classification scheme. Contains the following elements: ClassId - the classification type's numeric ID. ClassName - the name of the classification type. Language - the display language for classification data.

22.6

Get Country List (GetCountryList_1)

You can use the GetCountryList_1 method to retrieve a list of the countries supported in Lipper. The example below gets all countries supported in Lipper and displayed in English language. XML Sample Request - Getting Country List
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperU tilities_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperU tilities_1/ G etC ountry List_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etC ountry List_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperU tilities_1"> <language>E nglish</language> </G etC ountry List_Request_1> </Body > </E nv elope>

Paramet Description er language The display language for the returned list of countries.

Note: Lipper automatically defaults to American English if the requested data is unavailable in the language specified in the

482

TRKD API Developer's Guide

language option. See also the GetDomiciles_1 section. The response returns a list of <CountryType> attributes that include all of the supported countries: XML Sample Response - Getting Country List
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperU tilities_1/G etC ountry List_1_Reply </a: A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etC ountry List_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperU tilities_1"> <G etC ountry ListResult> <C ountry Ty pe> <C ountry Id>787</C ountry Id> <Language>E nglish</Language> <C ountry N ame>A ndorra</C ountry N ame> <C ountry C ode>A N D</C ountry C ode> </C ountry Ty pe> <C ountry Ty pe> <C ountry Id>792</C ountry Id> <Language>E nglish</Language> <C ountry N ame>A rgentina</C ountry N ame> <C ountry C ode>A RG </C ountry C ode> </C ountry Ty pe> ... <C ountry Ty pe> <C ountry Id>1012</C ountry Id> <Language>E nglish</Language> <C ountry N ame>V ietnam</C ountry N ame> <C ountry C ode>V N M </C ountry C ode> </C ountry Ty pe> </G etC ountry ListResult> </G etC ountry List_Response_1> </Body > </E nv elope>

Element CountryId Language CountryNa me CountryCo de

Description The country's numerical Country ID. The display language for the country information. the name of the country. the alphabetic country code.

22.7

Get Cross Reference Codes (GetCrossReferenceCodes_1)

Use the GetCrossReferenceCodes_1 method to retrieve a list of the cross-reference codes supported by Lipper. A cross-reference code is generally a unique identifier that is used to represent an asset. For example, ticker symbol or CUSIP, or ISIN are cross-reference codes. The example below requests all cross-reference codes displayed in English: XML Sample Request - Getting Cross Reference Codes

Lipper Utilities

483

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperU tilities_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperU tilities_1/ G etC rossReferenceC odes_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etC rossReferenceC odes_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperU tilities_1"> <language>E nglish</language> </G etC rossReferenceC odes_Request_1> </Body > </E nv elope>

Paramet Description er language The display language for the returned list of benchmarks.

Note: Lipper automatically defaults to American English if the requested data is unavailable in the language specified in the language option. The response returns a list of <CrossReferenceItem> elements that contain all supported cross-reference codes: XML Sample Response - Getting Cross Reference Codes
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperU tilities_1/ G etC rossReferenceC odes_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etC rossReferenceC odes_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperU tilities_1"> <G etC rossReferenceC odesResult> <C rossReferenceItem> <Language>E nglish</Language> <XrefId>4861</XrefId> <ReferenceC ode>LIP P E RS YM BO L</ReferenceC ode> <C odeF ullN ame>Lipper S y mbol (LA N A C ode)</C odeF ullN ame> </C rossReferenceItem> <C rossReferenceItem> <Language>E nglish</Language> <XrefId>4862</XrefId> <ReferenceC ode>C U S IP </ReferenceC ode> <C odeF ullN ame>C U S IP </C odeF ullN ame> </C rossReferenceItem> ... <C rossReferenceItem> <Language>E nglish</Language> <XrefId>31421</XrefId> <ReferenceC ode>BC N P J2</ReferenceC ode> <C odeF ullN ame>Brazilian C N P J</C odeF ullN ame> </C rossReferenceItem> </G etC rossReferenceC odesResult> </G etC rossReferenceC odes_Response_1> </Body > </E nv elope>

Element

Description

484

TRKD API Developer's Guide

Language XrefId ReferenceCo de CodeFullNam e

The display language for the cross-reference information.. The numeric cross-reference ID. The alphabetic cross-reference code (e.g., the five-character symbol for a NASDAQ cross-reference). The full name of the cross-reference.

22.8

Get Currency List (GetCurrencyList_1)

To get a list of the currencies that are supported by Lipper use the GetCurrencyList_1 method. The example below get all the currencies displayed in English language. XML Sample Request - Getting Currency List
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperU tilities_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperU tilities_1/ G etC urrency List_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etC urrency List_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperU tilities_1"> <language>E nglish</language> </G etC urrency List_Request_1> </Body > </E nv elope>

Paramet Description er language The display language for the returned list of currencies.

Note: Lipper automatically defaults to American English if the requested data is unavailable in the language specified in the language option. The response returns a list of currencies: XML Sample Response - Getting Currency List
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperU tilities_1/G etC urrency List_1_Reply </a: A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etC urrency List_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperU tilities_1"> <G etC urrency ListResult> <C urrency Ty pe> <C urrency Id>10000029</C urrency Id> <Language>E nglish</Language> <C urrency C ode>LC </C urrency C ode> <N ame>&lt;N o C urrency &gt;</N ame> </C urrency Ty pe>

Lipper Utilities

485

<C urrency Ty pe> <C urrency Id>10000046</C urrency Id> <Language>E nglish</Language> <C urrency C ode>A LL</C urrency C ode> <N ame>A lbania Lek</N ame> </C urrency Ty pe> <C urrency Ty pe> <C urrency Id>10000047</C urrency Id> <Language>E nglish</Language> <C urrency C ode>DZD</C urrency C ode> <N ame>A lgeria Dinar</N ame> </C urrency Ty pe> ... <C urrency Ty pe> <C urrency Id>10000208</C urrency Id> <Language>E nglish</Language> <C urrency C ode>ZWD</C urrency C ode> <N ame>Zimbabw e Dollar</N ame> </C urrency Ty pe> </G etC urrency ListResult> </G etC urrency List_Response_1> </Body > </E nv elope>

Element Language

Description The Language ID that represents the language for the currency.

CurrencyId The numeric Currency ID. CurrencyCo The alphabetic currency code. de Name The name of the currency.

22.9

Get Domiciles (GetDomiciles_1)

To get a list of the domiciles supported by Lipper use the GetDomiciles_1 method. GetDomiciles_1 is a method that retrieves the set of possible asset domiciles that Lipper tracks globally, while GetCountryList_1 is a method that retrieves the set of possible asset registered for sale countries that Lipper tracks globally. The domicile of a fund is the country in which the asset is incorporated whereas the registered for sale country is/are the country(s) where shares in the asset can be can be bought and sold. The example below shows how to request a list of domiciles displayed in English language: XML Sample Request - Getting Domiciles
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperU tilities_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperU tilities_1/ G etDomiciles_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etDomiciles_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperU tilities_1"> <language>E nglish</language> </G etDomiciles_Request_1> </Body > </E nv elope>

486

TRKD API Developer's Guide

Paramet Description er language The display language for the returned domicile list. Note: Lipper automatically defaults to American English if the requested data is unavailable in the language specified in the language option. The response returns a list of <CountryType> elements that include all of the domiciles: XML Sample Response - Getting Domiciles
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperU tilities_1/G etDomiciles_1_Reply </a: A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etDomiciles_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperU tilities_1"> <G etDomicilesResult> <C ountry Ty pe> <C ountry Id>13567</C ountry Id> <Language>E nglish</Language> <C ountry N ame>A lgeria</C ountry N ame> <C ountry C ode>DZA </C ountry C ode> </C ountry Ty pe> <C ountry Ty pe> <C ountry Id>300</C ountry Id> <Language>E nglish</Language> <C ountry N ame>A ndorra</C ountry N ame> <C ountry C ode>A N D</C ountry C ode> </C ountry Ty pe> ... <C ountry Ty pe> <C ountry Id>10114</C ountry Id> <Language>E nglish</Language> <C ountry N ame>V irgin Islands (U .S .)</C ountry N ame> <C ountry C ode>V IR</C ountry C ode> </C ountry Ty pe> </G etDomicilesResult> </G etDomiciles_Response_1> </Body > </E nv elope>

Element CountryId Language CountryNa me CountryCo de

Description The country's numerical Country ID. The display language for the country information. The name of the country. The alphabetic country code.

22.10 Get EU Tax Directive (GetEUTaxDirective_1)

Use the GetEUTaxDirective_1 method to retrieve the possible set of attributes that identify interest income information pertinent to the European Union Savings Directive. The example below requests EU tax directives displayed in English language: XML Sample Request - Getting EU Tax Directives

Lipper Utilities

487

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperU tilities_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperU tilities_1/ G etE U TaxDirectiv e_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etE U TaxDirectiv e_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperU tilities_1"> <language>E nglish</language> </G etE U TaxDirectiv e_Request_1> </Body > </E nv elope>

Paramet Description er language The display language for the returned list of EU Tax Directives.

Note: Lipper automatically defaults to American English if the requested data is unavailable in the language specified in the language option. The response returns a list of <EUTaxAttributeType> elements that contain EU tax directives: XML Sample Response - Getting EU Tax Directives
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperU tilities_1/ G etE U TaxDirectiv e_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etE U TaxDirectiv e_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperU tilities_1"> <G etE U TaxDirectiv eResult> <E U TaxA ttributeTy pe> <A ttributeId>1395</A ttributeId> <Language>E nglish</Language> <A ttributeN ame>C hina Q DII</A ttributeN ame> </E U TaxA ttributeTy pe> <E U TaxA ttributeTy pe> <A ttributeId>1396</A ttributeId> <Language>E nglish</Language> <A ttributeN ame>Infrastructure F und</A ttributeN ame> </E U TaxA ttributeTy pe> ... <E U TaxA ttributeTy pe> <A ttributeId>7805</A ttributeId> <Language>E nglish</Language> <A ttributeN ame>Div idend TIIA </A ttributeN ame> </E U TaxA ttributeTy pe> </G etE U TaxDirectiv eResult> </G etE U TaxDirectiv e_Response_1> </Body > </E nv elope>

Element Description AttributeId The numerical EU Tax Attribute ID.

488

TRKD API Developer's Guide

Language The display language for the EU tax attributes. AttributeNa The name of the EU Tax Attribute. me

22.11 Get Flag Groups (GetFlagGroups_1)

The GetFlagGroups_1 method is used to retrieve a list of the flag groups supported by Lipper along with each group's associated flag list, if requested. In this method, a flag is specifically a Boolean asset attribute. Flags are organized into flag groups so that a flag is a part of a flag group. Note: Flag is another term for attribute. In the context of Lipper Web Services, the <flag> element represents an attribute that Lipper has assigned to the asset. The example below requests data for the flag group with '7800' ID along with associated flag list and flag with '7805' ID and displayed in English language: XML Sample Request - Getting Flag Groups
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperU tilities_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperU tilities_1/ G etF lagG roups_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etF lagG roups_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperU tilities_1"> <language>E nglish</language> <flagG roup>7800</flagG roup> <flagID>7805</flagID> <prov ideF lagList>true</prov ideF lagList> </G etF lagG roups_Request_1> </Body > </E nv elope>

Parameter Description language flagGroup flagID The language ID that represents the display language for the returned flag group list. The ID of the flag group for which information should be returned. If set to null all flag groups will be included. The ID of the flag for which information should be returned. If set to null all flags will be returned.

provideFlagLi A flag that indicates if the flag group's associated flag list should be included in the results. st Note: Lipper automatically defaults to American English if the requested data is unavailable in the language specified in the language option. Note: If <flagID> is not null and <provideFlagList> is true then only information for the given Flag ID will be returned. If <flagID> is null and <provideFlagList> is true all flags for the flag set in <flagGroup> will be returned. The response returns a list of <FlagGroupType> elements that contain the flag groups and their associated flag lists: XML Sample Response - Getting Flag Groups
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader>

Lipper Utilities

489

<a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperU tilities_1/G etF lagG roups_1_Reply </a: A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etF lagG roups_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperU tilities_1"> <G etF lagG roupsResult> <F lagG roupTy pe> <Language>E nglish</Language> <F lagG roupId>7800</F lagG roupId> <F lagG roupC ode>E U TA X</F lagG roupC ode> <F lagG roupN ame>E U Tax Directiv e</F lagG roupN ame> <F lagList> <F lagItem> <F lagId>7805</F lagId> <F lagN ame>Div idend TIIA </F lagN ame> <F lagC ode>E U DIV </F lagC ode> </F lagItem> <F lagItem> <F lagId>7805</F lagId> <F lagN ame>Div idend TIIA </F lagN ame> <F lagC ode>E U DIV </F lagC ode> <F lagV alue>Y</F lagV alue> </F lagItem> </F lagList> </F lagG roupTy pe> </G etF lagG roupsResult> </G etF lagG roups_Response_1> </Body > </E nv elope>

Element Language FlagGroupId FlagGroupCo de FlagGroupNa me FlagList

Description The display language for the flag group information. The numerical flag group ID. The alphabetic flag group code. The name of the flag group. The flag group's flag list consisting of <FlagItem> elements. Contains the following elements: FlagId - the numeric flag ID. FlagName - the name of the flag. FlagCode - the alphabetic flag code. FlagValue - the flag value, which is either 'Y' (YES) or 'N' (NO).

22.12 Get Languages (GetLanguages_1)

To get a list of all languages supported by Lipper use the GetLanguages_1 method. The example below retrieves data for Thai language. XML Sample Request - Getting Languages
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperU tilities_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperU tilities_1/ G etLanguages_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token>

490

TRKD API Developer's Guide

</A uthorization> </H eader> <Body > <G etLanguages_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperU tilities_1"> <language>Thai</language> </G etLanguages_Request_1> </Body > </E nv elope>

Paramet Description er language The display language for the returned list of languages.

Note: Lipper automatically defaults to American English if the requested data is unavailable in the language specified in the language option. The response returns a list of <LanguageType> elements that contain all of the supported languages: XML Sample Response - Getting Languages
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperU tilities_1/G etLanguages_1_Reply </a: A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etLanguages_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperU tilities_1"> <G etLanguagesResult> <LanguageTy pe> <Language>Thai</Language> <LanguageN ame>E nglish</LanguageN ame> <LanguageC ode>E N G </LanguageC ode> <ResultLanguageId>2</ResultLanguageId> </LanguageTy pe> <LanguageTy pe> <Language>Thai</Language> <LanguageN ame>F rench</LanguageN ame> <LanguageC ode>F RE </LanguageC ode> <ResultLanguageId>2</ResultLanguageId> </LanguageTy pe> ... <LanguageTy pe> <Language>Thai</Language> <LanguageN ame>Thai</LanguageN ame> <LanguageC ode>TH A </LanguageC ode> <ResultLanguageId>2</ResultLanguageId> </LanguageTy pe> </G etLanguagesResult> </G etLanguages_Response_1> </Body > </E nv elope>

Element Language LanguageNam e LanguageCod e ResultLangua geId

Description The display language for the language information. The name of the language. The alphabetic language code. The numerical language ID.

Lipper Utilities

491

22.13 Get Lipper Leader Score Dates (GetLipperLeaderScoreDates_1)

You can use the GetLipperLeaderScoreDates_1 method to retrieve the dates when Lipper Leader Scores (LLS) were last updated for the specified asset(s). Lipper Leader Score is a rating (1-5, with 5 being high) that Lipper assigns to a fund. Lipper Leader Scores are given for a number of categories: total return, consistent return, preservation, tax efficiency, and expense. The example below requests dates for the assets with '65028707' and '60003333' IDs: XML Sample Request - Getting Lipper Leader Score Dates
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperU tilities_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperU tilities_1/ G etLipperLeaderS coreDates_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etLipperLeaderS coreDates_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperU tilities_1"> <lipperIDs> <int>65028707</int> <int>60003333</int> </lipperIDs> </G etLipperLeaderS coreDates_Request_1> </Body > </E nv elope>

Paramet Description er lipperIDs A list of one or more Lipper IDs for which data will be returned. A Lipper ID is a unique eight- or nine-digit number (e.g., 60003333) that identifies an asset.

The response returns a list of <DataDateType> elements that contain the list of dates for which Lipper Leader Scores are available. XML Sample Response - Getting Lipper Leader Score Dates
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperU tilities_1/ G etLipperLeaderS coreDates_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etLipperLeaderS coreDates_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperU tilities_1"> <G etLipperLeaderS coreDatesResult> <DataDateTy pe> <LipperId>60003333</LipperId> <DataDate>2009-02-27</DataDate> </DataDateTy pe> <DataDateTy pe> <LipperId>60003333</LipperId> <DataDate>2009-01-30</DataDate>

492

TRKD API Developer's Guide

</DataDateTy pe> <DataDateTy pe> <LipperId>60003333</LipperId> <DataDate>2008-12-31</DataDate> </DataDateTy pe> ... <DataDateTy pe> <LipperId>60003333</LipperId> <DataDate>2004-04-30</DataDate> </DataDateTy pe> </G etLipperLeaderS coreDatesResult> </G etLipperLeaderS coreDates_Response_1> </Body > </E nv elope>

Elemen Description t LipperId The asset's Lipper ID. DataDat The date when LLS was last updated. e

22.14 Get Price Estimation (GetPriceEstimation_1)

Use the GetPriceEstimation_1 method to retrieve the price estimation benchmarks exposed by Lipper. A price estimation benchmark is a benchmark that allows for future development of estimated price technology. The example below returns price estimation displayed in English language: XML Sample Request - Getting Price Estimation
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperU tilities_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperU tilities_1/ G etP riceE stimation_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etP riceE stimation_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperU tilities_1"> <language>E nglish</language> </G etP riceE stimation_Request_1> </Body > </E nv elope>

Paramet Description er language The display language for the returned price estimation list.

Note: Lipper automatically defaults to American English if the requested data is unavailable in the language specified in the language option. The response returns a list <AssetIdentityType> elements that contains the price estimation benchmarks: XML Sample Response - Getting Price Estimation
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader>

Lipper Utilities

493

<a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperU tilities_1/G etP riceE stimation_1_Reply </ a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etP riceE stimation_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperU tilities_1"> <G etP riceE stimationResult> <A ssetIdentity Ty pe> <LipperId>11000480</LipperId> <Language>E nglish</Language> <N ame>Barclay s C apital E uro A ggregate TR</N ame> </A ssetIdentity Ty pe> <A ssetIdentity Ty pe> <LipperId>11000481</LipperId> <Language>E nglish</Language> <N ame>Barclay s C apital U .S . C orporate H igh Yield TR</N ame> </A ssetIdentity Ty pe> <A ssetIdentity Ty pe> <LipperId>11000714</LipperId> <Language>E nglish</Language> <N ame>C itigroup E M U G BI TR</N ame> </A ssetIdentity Ty pe> ... <A ssetIdentity Ty pe> <LipperId>11020028</LipperId> <Language>E nglish</Language> <N ame>Topix TR</N ame> </A ssetIdentity Ty pe> </G etP riceE stimationResult> </G etP riceE stimation_Response_1> </Body > </E nv elope>

Elemen t LipperId Languag e Name

Description The asset's Lipper ID. The display language for the price estimation data. The full name of the asset.

22.15 Get Risk Free Index (GetRiskFreeIndex_1)

The GetRiskFreeIndex_1 method retrieves the risk free index benchmarks exposed by Lipper. A risk free index is a benchmark comprised of 'riskless' assets such as three-month Treasury Bills. The example below returns Risk Free Index benchmarks displayed in English language: XML Sample Request - Getting Risk Free Index
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperU tilities_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperU tilities_1/ G etRiskF reeIndex_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body >

494

TRKD API Developer's Guide

<G etRiskF reeIndex_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperU tilities_1"> <language>E nglish</language> </G etRiskF reeIndex_Request_1> </Body > </E nv elope>

Paramet Description er language The display language for the returned list of Risk Free index benchmarks.

Note: Lipper automatically defaults to American English if the requested data is unavailable in the language specified in the language option. The response returns a list of <AssetIdentityType> elements that contain the risk free index benchmarks: XML Sample Response - Getting Risk Free Index
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperU tilities_1/G etRiskF reeIndex_1_Reply </ a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etRiskF reeIndex_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperU tilities_1"> <G etRiskF reeIndexResult> <A ssetIdentity Ty pe> <LipperId>11029718</LipperId> <Language>E nglish</Language> <N ame>A rgentinian P eso 3 M onths</N ame> </A ssetIdentity Ty pe> <A ssetIdentity Ty pe> <LipperId>11020090</LipperId> <Language>E nglish</Language> <N ame>BIBO R TH B 3 M onths</N ame> </A ssetIdentity Ty pe> ... <A ssetIdentity Ty pe> <LipperId>11032859</LipperId> <Language>E nglish</Language> <N ame>V N IBO R V N D 3 M onths</N ame> </A ssetIdentity Ty pe> </G etRiskF reeIndexResult> </G etRiskF reeIndex_Response_1> </Body > </E nv elope>

Elemen t LipperId Languag e Name

Description The asset's Lipper ID. The display language for the Risk Free Index information. The full name of the asset.

22.16 Get Technical Indicators (GetTechnicalIndicators_1)

The GetTechnicalIndicators_1 method retrieves the Lipper technical indicators that are exposed by Lipper. A technical indicator is a benchmark that, based on statistical calculations, makes a very good benchmark for the asset.

Lipper Utilities

495

The example below requests data for technical indicators displayed in English language: XML Sample Request - Getting Technical Indicators
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperU tilities_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperU tilities_1/ G etTechnicalIndicators_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etTechnicalIndicators_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperU tilities_1"> <language>E nglish</language> </G etTechnicalIndicators_Request_1> </Body > </E nv elope>

Paramet Description er language The display language for the returned list of technical indicators.

Note: Lipper automatically defaults to American English if the requested data is unavailable in the language specified in the language option. The response returns a list of <AssetIdentityType> elements that contain the technical indicators: XML Sample Response - Getting Technical Indicators
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperU tilities_1/ G etTechnicalIndicators_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etTechnicalIndicators_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperU tilities_1"> <G etTechnicalIndicatorsResult> <A ssetIdentity Ty pe> <LipperId>19005011</LipperId> <Language>E nglish</Language> <N ame>A BI U K O ld - E uropean Inc U K-Life</N ame> </A ssetIdentity Ty pe> <A ssetIdentity Ty pe> <LipperId>11000654</LipperId> <Language>E nglish</Language> <N ame>A E X C R</N ame> </A ssetIdentity Ty pe> ... <A ssetIdentity Ty pe> <LipperId>11029151</LipperId> <Language>E nglish</Language> <N ame>V ietnam C R</N ame> </A ssetIdentity Ty pe> </G etTechnicalIndicatorsResult> </G etTechnicalIndicators_Response_1> </Body > </E nv elope>

496

TRKD API Developer's Guide

Elemen t LipperId Languag e Name

Description The asset's Lipper ID. The display language for the Risk Free Index information. The full name of the asset.

22.17 Get Universes (GetUniverses_1)

Use the GetUniverses_1 method to retrieve the list of asset universes supported by Lipper. See also the GetDomiciles_1 method. The example below requests universes displayed in English language: XML Sample Request - Getting Universes
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/01/LipperU tilities_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperU tilities_1/ G etU niv erses_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etU niv erses_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperU tilities_1"> <language>E nglish</language> </G etU niv erses_Request_1> </Body > </E nv elope>

Paramet Description er language The display language for the returned list of benchmarks.

Note: Lipper automatically defaults to American English if the requested data is unavailable in the language specified in the language option. The response returns a list of <UniverseType> elements that contain the supported asset universes: XML Sample Response - Getting Universes
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperU tilities_1/G etU niv erses_1_Reply </a: A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-04-17T10:41:48.639875Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etU niv erses_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/01/w ebserv ices/rkd/LipperU tilities_1"> <G etU niv ersesResult> <U niv erseTy pe>

Lipper Utilities

497

<U niv erseId>11528</U niv erseId> <Language>E nglish</Language> <U niv erseC ode>A U S </U niv erseC ode> <U niv erseN ame>A ustralia</U niv erseN ame> </U niv erseTy pe> <U niv erseTy pe> <U niv erseId>5693</U niv erseId> <Language>E nglish</Language> <U niv erseC ode>A U T</U niv erseC ode> <U niv erseN ame>A ustria</U niv erseN ame> </U niv erseTy pe> ... <U niv erseTy pe> <U niv erseId>5700</U niv erseId> <Language>E nglish</Language> <U niv erseC ode>U S A </U niv erseC ode> <U niv erseN ame>U nited S tates</U niv erseN ame> </U niv erseTy pe> </G etU niv ersesResult> </G etU niv erses_Response_1> </Body > </E nv elope>

Element UniverseId Language UniverseCo de UniverseNa me

Description The numeric Universe ID. The language ID that represents the display language for the universe information. The alphabetic universe code. The name of the universe.

498

TRKD API Developer's Guide

chapter 23

News

The Thomson Reuters News service allows you to query for headlines and also retrieve news content. The service also includes symbol resolution and ambiguous symbol handling. Note: Thomson Reuters News service can retrieve news content in Traditional Chinese format. To convert it to Simplified Chinese, pass the "ZH-Hans" parameter in the request.

23.1

Authentication/Authorization, Service Endpoint, and Required Headers

Authorization All requests to the Thomson Reuters News service require an authorization token. For details, see section Understanding Authentication Tokens. Authentication Thomson Reuters News uses Reuters impersonation tokens for each effective user. In this case, Thomson Reuters must create each user before your application authenticates them. Unmanaged effective users are not supported in Thomson Reuters News. For additional information on creating a Service Token, see section Creating a Token. Service Endpoint Thomson Reuters News Endpoint
http://api.rkd.reuters.com/api/2006/05/01/N ew s_1.sv c

Required Header Required HTTP Headers

P O S T /api/2006/05/01/N ew s_1.sv c H TTP /1.1 C ontent-Ty pe: application/soap+xml H ost: api.rkd.reuters.com C ontent-Length: [length]

23.2

WSDL
WSDL:
http://api.rkd.reuters.com/schemas/w sdl/N ew s_1_H ttpA ndRKDToken.w sdl

23.3

Retrieve Headlines (RetrieveHeadlineML_Request_1)

The RetrieveHeadlineML_1 request retrieves headlines for stories that match specific requirements. For complex searches, RetrieveHeadlineML_1 supports sophisticated search filters that express complex Boolean criteria. These filters can incorporate keywords, companies, products, etc., as well as meta-data such as story time, news provider, and language and can be used in a single query.

News

499

Note: The number of headlines returned by a response is limited to 4020 in TRKD API.

23.3.1 Retrieve Headlines Request

The following example shows how to retrieve headlines. XML Sample Request - Retrieve Headlines
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/N ew s_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/N ew s_1/ Retriev eH eadlineM L_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <Retriev eH eadlineM L_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/N ew s_1"> <H eadlineM LRequest> <T imeO ut>6 0 0 </T imeO ut> <M axC ount>1 0 </M axC ount> <M axC ountP er Filter >tr ue</M axC ountP er Filter > <Star tT ime>2 0 0 7 -0 9 -2 8 T 0 0 :0 0 :0 0 </Star tT ime> <EndT ime>2 0 0 7 -0 9 -2 9 T 0 0 :0 0 :0 0 </EndT ime> <Dir ection>Newer </Dir ection> <F ilter> <F reeTextC onstraint xmlns="http://schemas.reuters.com/ns/2006/04/14/rmds/w ebserv ices/new s/filter" w here="body "> <V alue modifier ="not">micr osoft</V alue> </F reeTextC onstraint> </F ilter> </H eadlineM LRequest> </Retriev eH eadlineM L_Request_1> </Body > </E nv elope>

Attribute TimeOut MaxCount MaxCountPer Filter

StartTime EndTime Direction

Filter

Description Defines maximum time in seconds to wait for a response (optional). Default is 60 seconds. Defines maximum number of items to be fetched (optional). Default is 20. A Boolean that applies only when more than one filter is in effect. If it is set to true, the service will attempt to return MaxCount items for every filter (optional). If it is set to false, the service will return only the first headlines found, up to a maximum of MaxCount. This means that the results of some filters are not included in the returned data. Default is false. Defines the start of a time window within which news stories must fall (optional). Every story returned will have a revision time that is greater than or equal to this value. Defines the end of a time window within which news stories must fall (optional). Every story returned will have a revision time that is less than or equal to this value. Default is the current time. Specifies whether the search begins at the EndTime and moves backward ("Older"), or begins at the StartTime and moves forward ("Newer") (optional). In either case, the results will be sequenced from newest to oldest. Default is "Older". Complex search criteria, as discussed below. Optional.

23.3.2 Filters
Complex search criteria are specified by using XML elements called filters and constraints to represent the terms of a Boolean expression. Like the terms of a Boolean expression, these elements contain one or more statements to evaluate, can be combined using logical operators (AND, OR, ANDNOT), and can be nested within other terms. Searches can be constructed to perform free text searches (e.g., look for "Sun" anywhere in the headline), or look for specific meta-data (e.g., COMPANY="SUNW", LANGUAGE="EN", etc.), or both.

500

TRKD API Developer's Guide

Filters are composed of one or more constraints. Similar to an Internet search expression, a constraint supports an arbitrarily complex set of criteria for a single field (or for the combined text of the headline and body, treated as a single field). For instance, a constraint might require that the body of a story must contain either "IBM" or "Lenovo", and either "Linux" or "Unix", and "laptop", and "China". A constraint can be either a free-text constraint (which searches the headline, body, or both) or a meta-data constraint (which searches meta-data fields). Since a filter can contain more than one constraint, it can specify search criteria for more than one field. For instance, a filter might use multiple constraints to specify a story on the topic "iPod", written in French, with the word "video" anywhere in the text. Multiple fields can be involved, and free-text searches can be combined with meta-data searches. Logical operations are represented by using a corresponding element type. There are filters and constraints for AND, OR, and ANDNOT. For an AND element to evaluate as True, all its sub-elements must be True. For an OR element to evaluate as True, at least one of its sub-elements must be True. For an ANDNOT element to evaluate as True, its first element must be True and all of its subsequent elements must be False. In a FreeTextConstraint, the optional "Where" attribute specifies the field in which to perform the free text search "headline", "body", or "both". The default value is "both". In a MetaDataConstraint, the required Class attribute specifies the metadata fields in which to search. Since the NDS category list is not fixed, this attribute is not restricted either. However, any NDS installation is expected to support at least the following metadata categories: "companies"; "products"; "topics"; "attribution"; "provider"; "language"; "instruments"; "any" (i.e., any of the available metadata). In addition, "providedby" is a special pseudo-category, used only to allow for "match-all" expression. The following expression always matches every story in the NDS news archive:
<M etaDataC onstraint xmlns="http://schemas.reuters.com/ns/2006/04/14/rmds/w ebserv ices/new s/filter" class="prov idedby "> <V alue>N DS </V alue> </M etaDataC onstraint>

The following sample XML describes a Filter element that would search for Reuters stories about Microsoft and Yahoo that include the word "merger" in the headline text:
<F ilter> <A nd xmlns="http://schemas.reuters.com/ns/2006/04/14/rmds/w ebserv ices/new s/filter"> <M etaDataC onstraint class="A ttribution"> <V alue>Reuters</V alue> </M etaDataC onstraint> <M etaDataC onstraint class="C ompanies"> <A nd> <V alue>M S F T.O </V alue> <V alue>YH O O .O </V alue> </A nd> </M etaDataC onstraint> <F reeTextC onstraint w here="headline"> <V alue>M erger</V alue> </F reeTextC onstraint> </A nd> </F ilter>

Note: You have to use RICs to identify a company.

23.3.3 Understanding Retrieve Headlines Response

XML Sample Response - Retrieve Headlines
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope">

News

501

<H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/ N ew s_1/Retriev eH eadlineM L_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <Retriev eH eadlineM L_Response_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/N ew s_1"> <H eadlineM LResponse> <Status> <S tatusM sg>O K </S tatusM sg> <S tatusC ode>0</S tatusC ode> </S tatus> <C ontext> <N ew er>2008-02-05T14:51:05+02:00</N ew er> <O lder>2008-02-05T14:48:55+02:00</O lder> </C ontext> <H EA DLINEM L> <H L xmlns="http://schemas.reuters.com/ns/2006/04/14/rmds/w ebserv ices/new s/headlineml" space="preserv e"> <ID>urn:new sml:reuters.com:20080205:nL05165606:2</ID> <RE>2</RE > <ST >U sable</S T> <C T >2008-02-05T14:51:05+02:00</C T> <RT >2008-02-05T14:51:05+02:00</RT> <LT >2008-02-05T14:48:44+02:00</LT> <P R>reuters.com</P R> <A T >RTRS </A T> <UR>4</U R> <LN>en</LN > <H T >U P DA TE 1-Kuw ait c.bank unhappy about high domestic inflation</H T> <T Y >story </TY> <P E>511 376 381 405 416 432 434 461 478</P E > <C O /> <T N>1</TN > </H L> <H L xmlns="http://schemas.reuters.com/ns/2006/04/14/rmds/w ebserv ices/new s/headlineml" space="preserv e"> <ID>urn:new sml:reuters.com:20080205:nBN G 143954:2</ID> <RE >2</RE > <S T>U sable</S T> <C T>2008-02-05T14:50:53+02:00</C T> <RT>2008-02-05T14:50:53+02:00</RT> <LT>2008-02-05T14:48:31+02:00</LT> <P R>reuters.com </P R> <A T>RTRS </A T> <U R>4</U R> <LN >en</LN > <H T>U S RE S E A RC H N E WS -P iper cuts V C A A ntech - thefly onthew all.com </H T> <TY>story </TY> <P E >511 394 433 452 492</P E > <C O >A P D.N G BX.N WO O F .O </C O > <TN >1</TN > </H L> ... <H L xmlns="http://schemas.reuters.com/ns/2006/04/14/rmds/w ebserv ices/new s/headlineml" space="preserv e"> <ID>urn:new sml:reuters.com:20080205:nV M N 258c9a:2</ID> <RE >2</RE > <S T>U sable</S T> <C T>2008-02-05T14:48:55+02:00</C T> <RT>2008-02-05T14:48:55+02:00</RT> <LT>2008-02-05T14:46:34+02:00</LT> <P R>reuters.com </P R> <A T>V M N </A T> <U R>4</U R> <LN >en</LN > <H T>To P resent at the BIO C E O &amp; Inv estor C onference A nd P articipate on the N on C ancer Immunotherapy P anel <O rigin H ref='Q uoteRef'>V A S .TO </O rigin> </H T> <TY>story </TY> <P E >339</P E > <C O >V S G N .O V A S .TO </C O > <TN >1</TN > </H L> </H E A DLIN E M L> </H eadlineM LResponse> </Retriev eH eadlineM L_Response_1> </Body > </E nv elope>

502

TRKD API Developer's Guide

Note: The number of headlines returned by a response is limited to 4020 in TRKD API. The Status contains an integer StatusCode and a StatusMsg for which values include: "OK", "ACCESS_DENIED", " INVALID_REQUEST". If headlines are found, the Context element contains two values Newer and Older that provide the revision times of the oldest and newest headlines returned. Although the xsd:dateTime supports millisecond precision, NDS revision times are incremented in whole seconds, so the actual values of Newer and Older will always be in whole seconds. These values may be used as the StartTime or EndTime elements in subsequent headline requests in order to page forward or backward in time through more search results. However, using this technique will always result in at least one headline from the last set being returned in the next set and in some cases more than one, since it will sometimes be the case that multiple headlines have the same revision time. Headlines are represented as zero or more HL elements in a HeadlineML structure. Mandatory Element ID RE ST Description Globally unique ID. News item revision number. Status (as defined by IPTS dictionary): 1. Usable 2. Embargoed 3. Withheld 4. Canceled News item Creation Time in ISO format. News item Revision Time in ISO format. Local Time in ISO format. News item provider. News attribution. News item urgency (as defined by IPTS dictionary). These are actually numeric values from 1 to 5. The default value is 4 - Normal. 1. Bulletin 2. Alert 3. News Break 4. Normal 5. Feature 2-letter ISO language code. News item headline text. This field may contain the following values: "story" - the story contains no alerts; "alert" - the story contains alert(s) only; "both" - the story contains both alert (s) and headline/body.

CT RT LT PR AT UR

LN HT TY

Optional Element PE CO TO NI TN

Description PE values - multiple values are separated by a space. Companies (RICs) - multiple values are separated by a space. Topics - multiple values are separated by a space. Named item. Take Number is used to indicate the story "take", which is incremented with each story revision. If it equals zero, then the headline does not yet have a story. If it is greater than zero, then there is some story associated with the headline. Story text. Products.

TE PD

News

503

23.4

Retrieve Story (RetrieveStoryML_Request_1)

This operation performs the simple task of retrieving a single news item based on a unique story ID. The data is returned in the Thomson Reuters proprietary StoryML format (contains more detailed information). The StoryRequest structure consists of zero or more StoryID elements and an optional TimeOut (in whole seconds) that specifies how long the application can wait for a response. The StoryID is a NewsML URN, of the form urn:newsml:[provider id]:[date]:[doc id], e.g., "urn:newsml:reuters.com:20001106:nJIJ6SS016". Note: The full <StoryId>=urn:newsml:[provider id]:[date]:[newsstoryid]:[digit] where the last digit after the colon states the specific news story version number. So, this urn "urn:newsml:reuters.com:20090617:<newsstoryid>:6" means that the specified story has 6 versions. By default, the most recent version is automatically selected and displayed. Or you can manually request the most recent version by eliminating the last digit after the colon ("6") to display the most recent version of the news story. The following example shows how to retrieve news. XML Sample Request - Retrieve Story
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/N ew s_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/N ew s_1/ Retriev eS tory M L_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <Retriev eS tory M L_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/N ew s_1"> <S tory M LRequest> <TimeO ut> 6 0 0 </TimeO ut> <S tory Id> ur n:newsml:r euter s.com:2 0 0 8 0 2 0 5 :nRNSE3 2 8 4 N:5 </S tory Id> </S tory M LRequest> </Retriev eS tory M L_Request_1> </Body > </E nv elope>

XML Sample Response - Retrieve Story

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/ rkd/N ew s_1/Retriev eS tory M L_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <Retriev eS tory M L_Response_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/N ew s_1"> <S tory M LResponse> <Status> <S tatusM sg>O K </S tatusM sg> <S tatusC ode>0</S tatusC ode> </S tatus> <ST O RY M L> <H L xmlns="http://schemas.reuters.com/ns/2006/04/14/rmds/w ebserv ices/new s/headlineml" space="preserv e"> <ID>urn:new sml:reuters.com:20080205:nRN S E 3284N :5</ID> <RE >5</RE > <S T>U sable</S T> <C T>2008-02-05T14:50:39+02:00</C T> <RT>2008-02-05T14:50:39+02:00</RT> <LT>2008-02-05T14:48:18+02:00</LT> <P R>reuters.com </P R> <A T>RN S </A T> <U R>4</U R> <LN >en</LN >

504

TRKD API Developer's Guide

<H T>RE G -BN P P aribas London E P T Disclosure <O rigin H ref="Q uoteRef">BLT.L</O rigin> </H T> <TY>story </TY> <P E >439</P E > <C O >BLT.L</C O > <TO >WE U E U RO P E LE N RE G G B M E T </TO > <N I /> <TN >1</TN > <TE ><pre> . </pre><pre>RN S N umber:3284N BN P P aribas London 05 F ebruary 2008 DE A LIN G S BY C O N N E C TE D E XE M P T P RIN C IP A L TRA DE RS WITH O U T RE C O G N IS E D IN TE RM E DIA RY S TA TU S , O R WITH RI S TA TU S BU T N O T DE A LIN G IN A C LIE N T-S E RV IN G C A P A C ITY (Rule 38.5(b) of the Takeov er C ode) 1. KE Y IN F O RM A TIO N

N ame of exempt principal trader BN P P A RIBA S A RBITRA G E S N C C ompany dealt in BH P BILLITO N P LC C lass of relev ant security to w hich the O rdinary S hares dealings being disclosed relate (N ote 1) Date of dealing 2. 04 F ebruary 2008

IN TE RE S TS , S H O RT P O S ITIO N S A N D RIG H TS TO S U BS C RIBE

(a) Interests and short positions (follow ing dealing) in the class of relev ant security dealt in (N ote 2) Long S hort N umber (% ) N umber (1) Relev ant securities (2) Deriv ativ es (other than options) 6,707,236 0.2972

(% )

(3) O ptions and agreements to purchase/sell

Total

6,707,236

0.2972

(b) Interests and short positions in relev ant securities of the company , other than the class dealt in (N ote 2)

C lass of relev ant security : N umber (1) Relev ant securities (2) Deriv ativ es (other than options) (3) O ptions and agreements to purchase/sell Total (c) Rights to subscribe (N ote 2)

Long (% )

S hort N umber (% )

C lass of relev ant security : 3. (a) DE A LIN G S (N ote 3) P urchases and sales

Details</pre><pre>

P urchases 8214 ... 197 Total 832864 S ales 93 16.04 16.00 16.69

News

505

... -1463 Total -983422 (b) 16.70

Deriv ativ es transactions (other than options) N umber of securities (N ote 6) P rice per unit (N ote 4)

P roduct name, Long/short (N ote 5) e.g. C F D</pre><pre> (c) (i)

O ptions transactions in respect of existing securities Writing, selling, purchasing or v ary ing

P roduct name,

Writing, selling, N umber of securities E xercise Ty pe, e.g. E xpiry O ption money purchasing, to w hich the option A merican, e.g. call option v ary ing etc. relates (N ote 6) price E uropean etc. date paid/receiv ed per unit (N ote 4) (ii) E xercising

P roduct name, e.g. call option (d)

N umber of securities

E xercise price per unit (N ote 4)

O ther dealings (including new securities) (N ote 3)

N ature of transaction (N ote 7)

Details

P rice per unit (if applicable) (N ote 4)

4.

O TH E R IN F O RM A TIO N

A greements, arrangements or understandings relating to options or deriv ativ es F ull details of any agreement, arrangement or understanding betw een the person disclosing and any other person relating to the v oting rights of any relev ant securities under any option referred to on this form or relating to the v oting rights or future acquisition or disposal of any relev ant securities to w hich any deriv ativ e referred to on this form is referenced. If none, this should be stated.

N one Is a S upplemental F orm 38.5(b) attached? (N ote 8) YE S /N O Date of disclosure C ontact name Telephone number N ame of offeree/offeror w ith w hich connected N ature of connection (N ote 9) 05 F ebruary 2008 Darren C larke 020 7595 4821 BH P Billiton A dv isor

N otes

The N otes on F orm 38.5(b) can be v iew ed on the Takeov er P anel&apos;s w ebsite at <O rigin H ref="Link">w w w .thetakeov erpanel.org.uk</O rigin>

This information is prov ided by RN S The company new s serv ice from the London S tock E xchange END E M M F KP KQ BBKDF BK</pre> </TE > <P D>RN S </P D> </H L> </S TO RYM L> </S tory M LResponse> </Retriev eS tory M L_Response_1> </Body > </E nv elope>

506

TRKD API Developer's Guide

Attribute Status StoryML

Description Contains an integer StatusCode and a StatusMsg for which values include: "OK", "ACCESS_DENIED", " INVALID_REQUEST". Contains zero or more StoryML-formatted news stories as HL elements.

23.5

Retrieve News (RetrieveNewsML_Request_1)

This operation performs the simple task of retrieving a single news item based on a unique story ID. The data is returned as a NewsML string. The schema for NewsML is available at newsml.org. This function allows you to retrieve a list of news headlines or an individual news story. Each news story has a Story ID, a unique text identifier that can be used to request that story text. The StoryRequest structure consists of zero or more StoryID elements and an optional TimeOut (in whole seconds) that specifies how long the application can wait for a response. The StoryID is a full NewsML URN, of the form urn:newsml: [provider id]:[date]:[doc id], e.g., "urn:newsml:reuters.com:20001106:nJIJ6SS016". Note: The full <StoryId>=urn:newsml:[provider id]:[date]:[newsstoryid]:[digit] where the last digit after the colon states the specific news story version number. So, this urn "urn:newsml:reuters.com:20090617:<newsstoryid>:6" means that the specified story has 6 versions. By default, the most recent version is automatically selected and displayed. Or you can manually request the most recent version by eliminating the last digit after the colon ("6") to display the most recent version of the news story. The following example shows how to retrieve news. XML Sample Request - Retrieve News
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/N ew s_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/N ew s_1/ Retriev eN ew sM L_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <Retriev eN ew sM L_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/N ew s_1"> <N ew sM LRequest> <Stor yId>ur n:newsml:r euter s.com:2 0 0 8 0 2 0 5 :nP nNET U0 5 8 :2 </Stor yId> </N ew sM LRequest> </Retriev eN ew sM L_Request_1> </Body > </E nv elope>

Note: To search for news on a specific company using Thomson Reuters News service, you have to specify "class=companies" and the RIC of the company. The following example searches for news on Yahoo: XML Sample Request
<F ilter> <M etaDataC onstraint class="companies" xmlns="http://schemas.reuters.com/ns/2006/04/14/rmds/w ebserv ices/new s/filter"> <V alue> Y H O O .O </V alue> </M etaDataC onstraint> </F ilter>

XML Sample Response - Retrieve News

News

507

The Story is a string containing the news story in NewsML format.

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/ rkd/N ew s_1/Retriev eN ew sM L_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <Retriev eN ew sM L_Response_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/N ew s_1"> <N ew sM LResponse> <S tatus> <S tatusM sg>O K </S tatusM sg> <S tatusC ode>0</S tatusC ode> </S tatus> <S tory ><N ew sM L><C atalog H ref="http://localhost/new sml/catalog-reuters-master_catalog.xml"/ ><N ew sE nv elope><DateA ndTime>20080205T131545-0000</DateA ndTime><N ew sS erv ice F ormalN ame="headline_pes:336"/ ><N ew sS erv ice F ormalN ame="story _pes:336"/><P riority F ormalN ame="4"/></N ew sE nv elope><N ew sItem xml: space="preserv e"><Identification><N ew sIdentifier><P rov iderId>reuters.com</P rov iderId><DateId>20080205</ DateId><N ew sItemId>nP nN E TU 058</N ew sItemId><Rev isionId P rev iousRev ision="1" U pdate="N ">2</ Rev isionId><P ublicIdentifier>urn:new sml:reuters.com:20080205:nP nN E TU 058:2</P ublicIdentifier></N ew sIdentifier></ Identification><N ew sM anagement><N ew sItemTy pe F ormalN ame="N ew s"/><F irstC reated>20080205T131806-0000</ F irstC reated><ThisRev isionC reated>20080205T131806-0000</ThisRev isionC reated><S tatus F ormalN ame="U sable"/ ><U rgency F ormalN ame="4"/></N ew sM anagement><N ew sC omponent xml:lang="en" E ssential="no" E quiv alentsList="no" Duid="N C 00001"><TopicS et F ormalN ame="nds.topics"><Topic Duid="TC _LE N "><TopicTy pe F ormalN ame="Language"/ ><F ormalN ame S cheme="N 2000"><![C DA TA [LE N ]]></F ormalN ame><Description xml:lang="en">E nglish</Description></ Topic><Topic Duid="TC _LE I"><TopicTy pe F ormalN ame="Tourism and leisure"/><F ormalN ame S cheme="N 2000"><![C DA TA [LE I]]></F ormalN ame><Description xml:lang="en">Leisure facilities</Description></Topic><Topic Duid="RT_N E WR"><TopicTy pe F ormalN ame="Reuters_Topic"/><F ormalN ame S cheme="Reuters_S cheme"><![C DA TA [N E WR]]></F ormalN ame><Description xml:lang="en">Description is not av ailable</Description></Topic></TopicS et><Role F ormalN ame="M A IN "/><A dministrativ eM etadata><P rov ider><P arty F ormalN ame="N DS "/></P rov ider><S ource><P arty F ormalN ame="P RN "/></S ource></A dministrativ eM etadata><Descriptiv eM etadata><Language F ormalN ame="en"/></ Descriptiv eM etadata><N ew sC omponent xml:lang="en" E ssential="no" E quiv alentsList="no" Duid="N C 00002"><Role F ormalN ame="M A IN TE XT"/><N ew sLines><H eadLine>P atron H its for $ 160,000 at M ount A iry C asino Resort</H eadLine></ N ew sLines><Descriptiv eM etadata><G enre F ormalN ame="Immediacy "/><O fInterestTo F ormalN ame="P RN "/ ><TopicO ccurrence Topic="#TC _LE N "/><TopicO ccurrence Topic="#TC _LE I"/><TopicO ccurrence Topic="#RT_N E WR"/></ Descriptiv eM etadata><C ontentItem Duid="C I00001"><M ediaTy pe F ormalN ame="text"/><F ormat F ormalN ame="XH TM L"/ ><DataC ontent><html><head><title></title></head><body ><pre>S troudsburg resident latest w inner at C asino Resort, w hich has the best odds in the state P A RA DIS E TO WN S H IP , P a., F eb. 5 /P RN ew sw ire/ -- G regg A rtzt of S troudsburg is the latest big w inner at M ount A iry C asino Resort, hitting a jackpot for $ 160,000 w hile play ing the slot machines on S aturday . A rtzt&apos;s big w in comes on the heels of a $ 100,000 w inner in December. That patron took home the resort&apos;s S uperS hot Jackpot. S ince its opening, M ount A iry C asino Resort has maintained the highest pay out percentage of any casino in P ennsy lv ania and is approximately 1.2 percentage points higher than the state av erage. When applied to M ount A iry &apos;s av erage w eekly slot handle since opening, the higher pay out percentage results in an extra $ 450,000 being paid to patrons per w eek. M ount A iry has the most fav orable odds for patrons in the C ommonw ealth of P ennsy lv ania. The current S uperS hot Jackpot, w hich grow s on a continual basis, is more than $ 107,000. It is open to all M ount A iry P lay ers C lub members and any patron w ith a P lay er&apos;s C lub card inserted in a slot machine is eligible to w in, regardless of the ty pe of machine being play ed or denomination w agered. P atrons w ho w ant to try their luck at M ount A iry C asino Resort can take adv antage of special getaw ay packages for V alentine&apos;s Day and P resident&apos;s Day Weekend. S tarting at $ 150.00 per person (based on double occupancy ), each package includes room accommodations in the casino resort&apos;s beautifully decorated hotel rooms, featuring pillow top beds, 37&quot; LC D TV s and elegant ov ersized bathrooms. The package also includes $ 50 in dining or retail credits, plus $ 25 in free slot play upon joining the P lay er&apos;s C lub and complimentary access to G y psies N ightclub and Lounge. P ackages, w hich are quickly selling out, can be purchased by calling 1-877-M T-A IRY-1. M ount A iry C asino Resort features a mix of more than 2,500 reel-spinning machines and the new est themed v ideo slots, as w ell as progressiv e jackpots. Dining options at the new resort include Red S teakhouse, offering prime steaks and the freshest seafood; Le S orelle C ucina, offering Italian delicacies; Betty &apos;s Diner, featuring A ll-A merican dining, open 24 hours a day ; and The Buffet at M ount A iry . E ach room and suite in M ount A iry C asino Resort&apos;s luxury hotel w as designed w ith the goal of obtaining a four-star rating, making them the highest quality rooms av ailable in the P ocono M ountains. The casino resort&apos;s upscale G y psies Lounge N ightclub, w hich offers a mix of liv e bands and other

508

TRKD API Developer's Guide

acts, has one of the best sound sy stems in the M id-A tlantic region. Later this month, M ount A iry C asino Resort w ill open its luxury spa and salon, prov iding guests w ith a range of inv igorating spa treatments, including facials, skin treatments, personalized massages and more. S O U RC E M ount A iry C asino Resort P ete P eterson of Bellev ue C ommunications G roup, +1-215-893-4297 (o), +1-215-990-8928 (cell), for M ount A iry C asino Resort</pre></body ></html></DataC ontent></C ontentItem></ N ew sC omponent></N ew sC omponent></N ew sItem></N ew sM L> </S tory > </N ew sM LResponse> </Retriev eN ew sM L_Response_1> </Body > </E nv elope>

Attribute Status Story

Description Contains an integer StatusCode and a StatusMsg for which values include: "OK", "ACCESS_DENIED", " INVALID_REQUEST". A string that contains the news story in NewsML format.

23.6

Get News Topics (GetTopics_Request_1)

The following example shows how to retrieve news topics. XML Sample Request - Get News Topics
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/N ew s_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/N ew s_1/ G etN ew sTopics_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <GetNewsT opics_Request_1 xmlns="http://www.r euter s.com/ns/2 0 0 6 /0 5 /0 1 /webser vices/r kd/News_1 " /> </Body > </E nv elope>

XML Sample Response - Get News Topics

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/ rkd/N ew s_1/G etN ew sTopics_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <G etN ew sTopics_Response_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/N ew s_1"> <topics> <group> <topic code="A D"> <Description V ariant="S hort" lang="en">A ndorra</Description> <Description V ariant="Long" lang="en">P rincipality of A ndorra</Description> <Description V ariant="IsoS hort" lang="en">A N DO RRA </Description> <Description V ariant="IsoLong" lang="en">P rincipality of A ndorra</Description> <Description V ariant="A djectiv al" lang="en">A ndorran</Description> </topic> ... <topic code="ZW"> <Description V ariant="S hort" lang="en">Zimbabw e</Description> <Description V ariant="Long" lang="en">Republic of Zimbabw e</Description> <Description V ariant="IsoS hort" lang="en">ZIM BA BWE </Description>

News

509

<Description V ariant="IsoLong" lang="en">Republic of Zimbabw e</Description> <Description V ariant="A lternate" lang="en">S outhern Rhodesia</Description> <Description V ariant="A lternate" lang="en">Rhodesia</Description> <Description V ariant="A djectiv al" lang="en">Zimbabw ean</Description> </topic> </group> <group> <topic code="DIA RY"> <Description V ariant="S hort" lang="en">Diary </Description> <Description V ariant="Long" lang="en">The object contains scheduled ev ents, such as conv entions, summits, etc.</ Description> </topic> ... </group> <group> ... <topic code="RA W"> <description V ariant="S hort" lang="en">Basic M aterials</description> <description V ariant="Long" lang="en">C ompanies engaged in the extraction and primary refinement of chemicals, metals, non-metallic and construction materials, forest, w ood and paper products and containers and packaging products.</description> <description V ariant="Detailed" lang="en">The Basic M aterials economic sector consists of companies engaged in the extraction and primary refinement of chemicals, metals, non-metallic and construction materials, forest, w ood and paper products and containers and packaging products.</description> </topic> ... </group> <group> ... <topic code="ZA R/P O LL"> <Description V ariant="S hort" lang="en">S outh A frican rand F X outlook poll</Description> </topic> </group> </topics> </G etN ew sTopics_Response_1> </Body > </E nv elope>

23.7

Classes for Metadata Search on News

The simplest approach is to use all as the MetaDataConstraint. However, you may find that performance is improved by specifying a MetaDataConstraint. The possible values for this are: all companies topics product attribution language nameditem Please see related articles: How to see how a specific news stories has been categorized? What values can I use in order to filter on News? How does the companies news metadata constraint work? How does the topics news metadata constraint work? How does the products news metadata constraint work? How does the attribution news metadata constraint work? What is a named item?

23.7.1 How to See how a Specific News Stories has been Categorized?
It is possible to see the values for these metadata constraints on the stories which are returned by TRKD in the RetrieveStoryML_1 method: CO element contains the value for companies referred to in the story

510

TRKD API Developer's Guide

TO element contains the value for the topic codes assigned to the story PD element contains the value for products assigned to the story AT element contains the value for attribution LN element contains the value for the language the story is written in NI element contains the value for named items assigned to the story In addition, the TO element and LN elements are available in the RetrieveHeadlineML_1 method. The metadata on each story can be used to retrieve related headlines, by requesting the RetrieveHeadlineML_1 method for the appropriate metadata class and value.

23.7.2 What Values Can I Use in Order to Filter on News?

There are various sources for the values for the news metadata: 1. The TRKD Data Guide contains information on metadata filters which are appropriate for each of the news packages. 2. Each story contains information about how the story has been categorized. This can be used to search on related articles. 3. The GetNewsTopics_1 method retrieves possible values which can be used as news topics, together with a detailed description.

23.7.3 How Does the Companies News Metadata Constraint Work?

When stories are filed, the journalist tags stories with RICs (Reuters Instrument Codes) for each of the companies which are mentioned in the article. News is always tagged with the primary listing for a company (news on Microsoft is always tagged MSFT.O, for example). When you make a request against the RetrieveHeadlineML_1 method and specify companies as the metadataconstraint, TRKD looks up what the primary listing for the RIC is, and retrieves news for the company. This means that even if you request MSFT, news will be returned for MSFT.O.

23.7.4 How Does the Topics News Metadata Constraint Work?

When stories are filed, journalists specify what the topics for the stories are. In addition topics are added to stories automatically based on their content. Each story frequently has many different topic codes. For example, a story whose headline is "MSN unveils a wall of entertainment news" might have the following topic codes: TECH - Technology DPUB Media Diversified MDIA - Media SOFW - Software DPR Computers / Office Equipment CYCS Cyclical Consumer Goods / Services CCOS Cyclical Consumer Services PUB Media / Publishing LEN English Language US United States SWIT Software / IT Services RTRS - Reuters LEI - Leisure ENT Entertainment Topic codes typically include information on the industry sectors and the countries referred to in the story as well as what might more normally be thought of as topics.

23.7.5 How Does the Products News Metadata Constraint Work?

The products metadata constraint describes what internal Thomson Reuters News product the particular story has been assigned to. It is of limited use to TRKD users.

News

511

23.7.6 How Does the Attribution News Metadata Constraint Work?

Attribution describes what organization the story is attributed to. Most stories on TRKD are attributed to Thomson Reuters and the attribution is RTRS. However, selected third parties are also available on TRKD, and stories attributed to third parties can be filtered on using the attribution metadata constraint.

23.7.7 What is a Named Item?

Most news available via TRKD is in response to events. However, there are some stories which are regular reports which give a summary of events since the last report for example the US Market Summary report. Such reports are typically assigned a value for the named item metadata constraint.

23.8

Special Characters in Thomson Reuters News

When news headline/text contains xml special characters (&quot;) Request Builder displays them as escaped on Design view. NDSNewsService responses have special characters (&, ", <, > etc.) which are escaped twice. For example "&amp;quot;" value in the response context is erroneous and should be "&quot;". To solve this issue it is necessary to decode the response once. For example, in C#:
string decoded_v alue = H ttpU tility .H tmlDecode("&amp;quot;"); result in xml: &quot; result in html: "

512

TRKD API Developer's Guide

chapter 24

Online Reports

The Online Reports service provides access to online news reports and allows the rendering of text and pictures from the reports.

24.1

Authentication/Authorization, Service Endpoint, and Required Headers

Authorization All requests to the Online Reports web service require an authorization token. For details, see section Understanding Authentication Tokens. Authentication Thomson Reuters Online Reports uses Reuters impersonation tokens for each effective user. In this case, Thomson Reuters must create each user before your application authenticates them. Unmanaged effective users are not supported in Thomson Reuters Online Reports. For additional information on creating a Service Token, see section Creating a Token. Service Endpoint Online Reports Endpoint
http://api.rkd.reuters.com/api/2006/05/01/O nlineReports_1.sv c

Required Header Required HTTP Headers

P O S T api/2006/05/01/O nlineReports_1.sv c H TTP /1.1 C ontent-Ty pe: application/soap+xml H ost: api.rkd.reuters.com C ontent-Length: [length]

24.2

WSDL
WSDL:
http://api.rkd.reuters.com/schemas/w sdl/O nlineReports_1_H ttpA ndRKDToken.w sdl

24.3

Get Summary by Topic (GetSummaryByTopic_1)

The following example shows how to retrieve summary by OLCABUS_US topic. See section Get Topics (GetTopics_Request_1) to know how to retrieve a topic. XML Sample Request - Get Summary by Topic
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/O nlineReports_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/O nlineReports_1/

Online Reports

513

G etS ummary By Topic_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etS ummary By Topic_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/O nlineReports_1" /> <Topic> O LC A BUS_US </Topic> <M axC ount> 2 </M axC ount> </G etS ummary By Topic_Request_1> </Body > </E nv elope>

XML Sample Response - Get Summary by Topic

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/ rkd/O nlineReports_1/G etS ummary By Topic_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <G etS ummary By Topic_Response_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/O nlineReports_1"> <S tory M LResponse xmlns="http://schemas.reuters.com/ns/2006/04/14/rmds/w ebserv ices/N DS N ew sS erv ice_1/ty pes"> <S tatus> <S tatusM sg>O K</S tatusM sg> <S tatusC ode>0</S tatusC ode> </S tatus> <S TO RYM L /> <H L xmlns="http://schemas.reuters.com/ns/2006/04/14/rmds/w ebserv ices/new s/headlineml" space="preserv e"> <ID>urn:new sml:onlinereport.com:20080731:nO LC A BU S :4</ID> <RE >4</RE > <S T>U sable</S T> <C T>2008-07-31T02:42:02-05:00</C T> <RT>2008-07-31T02:42:02-05:00</RT> <LT>2008-07-31T02:42:32-05:00</LT> <P R>onlinereport.com</P R> <A T>IDS </A T> <U R>4</U R> <LN >en</LN > <H T>Reuters C anada O nline Report Business N ew s</H T> <TY>story </TY> <P E >99999 10100 10101</P E > <S TO RY_P E >99999 10100 10101</S TO RY_P E > <C O /> <TO >O C A BS RTRS Y O LC A BU S O LRLN K O LC A BU S _U S O LC A BU S _S P O RTR.L LIN K</TO > <N I /> <TN >1</TN > <TE > <p> <O rigin H ref="S tory Ref">urn:new sml:onlinereport.com:20080730:nM TF H 4667820080730212843N 28409392</ O rigin>Toronto stocks soar on energy and miners<p> TO RO N TO (Reuters) - The Toronto S tock E xchange&apos;s main index jumped more than 2 percent on Wednesday , spurred by resource issues, especially the energy sector, w hich rallied along w ith oil prices.</p><O rigin H ref="ThumbnailRef">2008-07-30T144816Z_01_N O O TR_RTRIDS P _1_BU S IN E S S -M A RKE TS C A N A DA -S TO C KS -C O L.jpg</O rigin><O rigin H ref="ImageRef">urn:new sml:onlinereport.com:20080730: nM TF H 3764420080730144816N O O TR</O rigin><O rigin H ref="ImageTitle">Toronto S tock E xchange logo is seen in Toronto</O rigin><O rigin H ref="S tory C reationDate">20080730T212843+0000</O rigin><O rigin H ref="ImageC reationDate">20080730T144816+0000</O rigin> </p> ... <p> <O rigin H ref="S tory Ref">urn:new sml:onlinereport.com:20080730:nM TF H 4627720080730210505WN A 5092</ O rigin>M DA &apos;s profit dented by blocked asset sale<p> TO RO N TO (Reuters) - Data-processing and space technology company M acDonald, Dettw iler and A ssociates Ltd &lt;M DA .TO &gt; reported a drop in quarterly profit on Wednesday , as costs related to the blocked sale of one of its units ate into results.</p><O rigin H ref="S tory C reationDate">20080730T210505+0000</O rigin> </p> <p> <O rigin H ref="S tory Ref">urn:new sml:onlinereport.com:20080730:nM TF H 4134820080730172210N 30294927</ O rigin>TM X G roup profit up on M ontreal contribution<p> TO RO N TO (Reuters) - C anadian exchange operator TM X G roup Inc

514

TRKD API Developer's Guide

&lt;X.TO &gt; said on Wednesday its second-quarter profit rose 26 percent as the M ay 1 acquisition of the M ontreal E xchange deriv ativ es operation helped to boost its bottom line.</p><O rigin H ref="S tory C reationDate">20080730T172210+0000</O rigin> </p> </TE > <P D /> <S R> <O rigin Ty pe="S tory Ref">urn:new sml:onlinereport.com:20080730:nM TF H 4667820080730212843N 28409392</O rigin> <O rigin Ty pe="ThumbnailRef">http://S TLD-RKWA P IA B/api/onlinereports/2008-0730T144816Z_01_N O O TR_RTRIDS P _1_BU S IN E S S -M A RKE TS -C A N A DA -S TO C KS -C O L.jpg.ashx</O rigin> <O rigin Ty pe="ImageRef">urn:new sml:onlinereport.com:20080730:nM TF H 3764420080730144816N O O TR</O rigin> ... <O rigin Ty pe="S tory C reationDate">20080730T172210+0000</O rigin> </S R> </H L> <H L xmlns="http://schemas.reuters.com/ns/2006/04/14/rmds/w ebserv ices/new s/headlineml" space="preserv e"> <ID>urn:new sml:onlinereport.com:20080731:nM TF H 5644020080731074151T140485:1</ID> <RE >1</RE > <S T>U sable</S T> <C T>2008-07-31T02:41:51-05:00</C T> <RT>2008-07-31T02:41:51-05:00</RT> <LT>2008-07-31T02:42:32-05:00</LT> <P R>onlinereport.com</P R> <A T>IDS </A T> <U R>4</U R> <LN >en</LN > <H T>O il steady after gain from U .S . gasoline stock fall</H T> <TY>story </TY> <P E >99999 10100 10102</P E > <S TO RY_P E >99999 10100 10102</S TO RY_P E > <C O /> <TO >O LRTXT O C A BS RTRS Y O LC A BU S O LC A BU S _U S O LC A BU S _S P O RTR.L TE XT</TO > <N I /> <TN >1</TN > <TE > <p> By James Topham</p> <p> TO KYO (Reuters) - O il prices steadied on Thursday , after U .S . gov ernment data on Wednesday show ed an unexpected drop in gasoline stocks as suppliers facing w eak consumer demand cut production and imports, sending prices surging more than $ 4.</p> <p> The rebound on Wednesday came after oil prices pulled back sharply since hitting an all-time peak abov e $ 147 on July 11, on concerns ov er falling demand, especially in the U nited S tates, the w orld&apos;s largest oil consumer.</p> ... <p> A bill aimed at prev enting excessiv e speculation in oil and other futures trading did not get enough v otes to pass in the U .S . H ouse of Representativ es on Wednesday , as Republicans complained the measure did not also open more offshore areas to oil drilling.</p> <p> (E diting by Ramthan H ussain)</p> <O rigin H ref="ThumbnailRef">2008-07-30T202501Z_01_N O O TR_RTRIDS P _1_BU S IN E S S -M A RKE TS -O IL-C O L. jpg</O rigin> <O rigin H ref="ImageRef">urn:new sml:onlinereport.com:20080730:nM TF H 4530820080730202501N O O TR</ O rigin> <O rigin H ref="ImageTitle">N ew York C ity cab driv er</O rigin> <O rigin H ref="C hannelC ode">O LC A BU S </O rigin> <O rigin H ref="LinkTitle">Reuters C anada O nline Report Business N ew s</O rigin> <O rigin H ref="S tory C reationDate">20080731T074151+0000</O rigin> <O rigin H ref="ImageC reationDate">20080730T202501+0000</O rigin> </TE > <P D /> <S R> <O rigin Ty pe="ThumbnailRef">http://S TLD-RKWA P IA B/api/onlinereports/2008-0730T202501Z_01_N O O TR_RTRIDS P _1_BU S IN E S S -M A RKE TS -O IL-C O L.jpg.ashx</O rigin> <O rigin Ty pe="ImageRef">urn:new sml:onlinereport.com:20080730:nM TF H 4530820080730202501N O O TR</O rigin> <O rigin Ty pe="ImageTitle">N ew York C ity cab driv er</O rigin> <O rigin Ty pe="C hannelC ode">O LC A BU S </O rigin> <O rigin Ty pe="LinkTitle">Reuters C anada O nline Report Business N ew s</O rigin> <O rigin Ty pe="S tory C reationDate">20080731T074151+0000</O rigin> <O rigin Ty pe="ImageC reationDate">20080730T202501+0000</O rigin> </S R> </H L> </S TO RYM L> </S tory M LResponse> </G etS ummary By Topic_Response_1> </Body > </E nv elope>

Online Reports

515

24.4

Get Summaries by Stories (GetSummaryByStories_1)

The following example shows how to retrieve summary of a story by Online Reports StoryID. XML Sample Request - Get Summary by Stories
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/O nlineReports_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/O nlineReports_1/ G etS ummary By S tories_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etS ummary By S tories_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/O nlineReports_1"> <Stor yId>urn:new sml:onlinereport.com:20070726:nM TF H 7653620070726204707N O O TR:1</S tory Id> </G etS ummary By S tories_Request_1> </Body > </E nv elope>

XML Sample Response - Get Summary by Stories

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/ rkd/O nlineReports_1/G etS ummary By S tories_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <G etS ummary By S tories_Response_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/O nlineReports_1"> <S tory M LResponse xmlns="http://schemas.reuters.com/ns/2006/04/14/rmds/w ebserv ices/N DS N ew sS erv ice_1/ty pes"> <S tatus> <S tatusM sg>O K</S tatusM sg> <S tatusC ode>0</S tatusC ode> </S tatus> <S TO RYM L> <H L xmlns="http://schemas.reuters.com/ns/2006/04/14/rmds/w ebserv ices/new s/headlineml" space="preserv e"> <ID>urn:new sml:onlinereport.com:20070726:nM TF H 7653620070726204707N O O TR:1</ID> <RE >1</RE > <S T>U sable</S T> <C T>2007-07-26T20:47:07-00:00</C T> <RT>2007-07-26T20:47:07-00:00</RT> <LT>2007-08-14T10:34:16-00:00</LT> <P R>onlinereport.com</P R> <A T>IDS </A T> <U R>4</U R> <LN >en</LN > <H T>C E O of H S BC F inance C orporation Brendan M cDonagh listens to questions during the S enate Banking, H ousing and U rban A ffairs C ommittee on the mortgage market turmoil on C apitol H ill in Washington</H T> <TY>story </TY> <P E >99999 10260 10263</P E > <C O /> <TO >iptc:04000000 O LRP IX O LG BBU S P IC T RTRS Y F IN O U KBS O LG BBU S _S P O O LG BBU S _U S RTR.L</TO > <N I /> <TN >1</TN > <TE ><O rigin H ref="S tory Ref">urn:new sml:onlinereport.com:20070726:nM TF H 7653520070726204705N 26227325</ O rigin><O rigin H ref="ThumbnailRef">2007-07-26T204707Z_01_N O O TR_RTRIDS P _1_O U KBS -U K-U S A -S U BP RIM E H S BC .jpg</O rigin><O rigin H ref="V iew Ref">2007-07-26T204707Z_01_N O O TR_RTRIDS P _2_O U KBS -U K-U S A S U BP RIM E -H S BC .jpg</O rigin><O rigin H ref="BaseRef">2007-07-26T204707Z_01_N O O TR_RTRIDS P _3_O U KBS -U KU S A -S U BP RIM E -H S BC .jpg</O rigin><O rigin H ref="S tory Title">H S BC braces for mortgage price hikes</O rigin><O rigin H ref="S tory C reationDate">20070726T204705+0000</O rigin><O rigin H ref="ImageC reationDate">20070726T204707 +0000</O rigin><O rigin H ref="C hannelC ode">O LG BBU S </O rigin><O rigin H ref="LinkTitle">Reuters U K O nline Report Business N ew s</O rigin> <p>C E O of H S BC F inance C orporation Brendan M cDonagh listens to questions during the S enate Banking, H ousing and U rban A ffairs C ommittee on the mortgage market turmoil, on C apitol H ill in Washington, in this M arch 22, 2007 file photo. A $ 9 billion w av e of risky mortgages resetting at higher interest rates in the U nited S tates could force

516

TRKD API Developer's Guide

H S BC H oldings P lc to absorb another big hit to profits as more customers default. RE U TE RS /Jim Young</p> </TE > <P D /> <S R> <O rigin Ty pe="S tory Ref">urn:new sml:onlinereport.com:20070726:nM TF H 7653520070726204705N 26227325</O rigin> <O rigin Ty pe="ThumbnailRef">http://api.rkd.reuters.com/api/onlinereports/2007-0726T204707Z_01_N O O TR_RTRIDS P _1_O U KBS -U K-U S A -S U BP RIM E -H S BC .jpg.ashx</O rigin> <O rigin Ty pe="V iew Ref">http://api.rkd.reuters.com/api/onlinereports/2007-0726T204707Z_01_N O O TR_RTRIDS P _2_O U KBS -U K-U S A -S U BP RIM E -H S BC .jpg.ashx</O rigin> <O rigin Ty pe="BaseRef">http://api.rkd.reuters.com/api/onlinereports/2007-0726T204707Z_01_N O O TR_RTRIDS P _3_O U KBS -U K-U S A -S U BP RIM E -H S BC .jpg.ashx</O rigin> <O rigin Ty pe="S tory Title">H S BC braces for mortgage price hikes</O rigin> <O rigin Ty pe="S tory C reationDate">20070726T204705+0000</O rigin> <O rigin Ty pe="ImageC reationDate">20070726T204707+0000</O rigin> <O rigin Ty pe="C hannelC ode">O LG BBU S </O rigin> <O rigin Ty pe="LinkTitle">Reuters U K O nline Report Business N ew s</O rigin> </S R> </H L> </S TO RYM L> </S tory M LResponse> </G etS ummary By S tories_Response_1> </Body > </E nv elope>

Note: Url of Online Report picture is contained in the Origin tag, for example:
<S R> <O rigin Ty pe="V iew Ref">http://api.rkd.reuters.com/api/onlinereports/2007-07-26T204707Z_01_N O O TR_RTRIDS P _2_O U KBS -U K-U S A S U BP RIM E -H S BC .jpg.ashx </O rigin> </S R>

24.5

Get Headlines (GetHeadlines_Request_1)

The following example shows how to retrieve headlines for OLCABUS_US topic. XML Sample Request - Get Headlines
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/O nlineReports_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/O nlineReports_1/ G etH eadlines_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etH eadlines_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/O nlineReports_1" /> <Topic> O LC A BUS_US </Topic> <M axC ount> 5 </M axC ount> </G etH eadlines_Request_1> </Body > </E nv elope>

XML Sample Response - Get Headlines

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/ rkd/O nlineReports_1/G etH eadlines_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <G etH eadlines_Response_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/O nlineReports_1"> <H eadlineM LResponse xmlns="http://schemas.reuters.com/ns/2006/04/14/rmds/w ebserv ices/N DS N ew sS erv ice_1/ty pes"> <S tatus>

Online Reports

517

<S tatusM sg>O K</S tatusM sg> <S tatusC ode>0</S tatusC ode> </S tatus> <C ontext> <N ew er>2008-08-01T05:56:04-05:00</N ew er> <O lder>2008-08-01T05:09:00-05:00</O lder> </C ontext> <H E A DLIN E M L> <H L xmlns="http://schemas.reuters.com/ns/2006/04/14/rmds/w ebserv ices/new s/headlineml" space="preserv e"> <ID>urn:new sml:onlinereport.com:20080801:nO LC A BU S :7</ID> <RE >7</RE > <S T>U sable</S T> <C T>2008-08-01T05:56:04-05:00</C T> <RT>2008-08-01T05:56:04-05:00</RT> <LT>2008-08-01T05:55:23-05:00</LT> <P R>onlinereport.com</P R> <A T>IDS </A T> <U R>4</U R> <LN >en</LN > <H T>Reuters C anada O nline Report Business N ew s</H T> <TY>story </TY> <P E >99999 10100 10101</P E > <C O /> <TN >1</TN > </H L> <H L xmlns="http://schemas.reuters.com/ns/2006/04/14/rmds/w ebserv ices/new s/headlineml" space="preserv e"> <ID>urn:new sml:onlinereport.com:20080801:nM TF H 8906820080801105548N 01226939:1</ID> <RE >1</RE > <S T>U sable</S T> <C T>2008-08-01T05:55:48-05:00</C T> <RT>2008-08-01T05:55:48-05:00</RT> <LT>2008-08-01T05:55:23-05:00</LT> <P R>onlinereport.com</P R> <A T>IDS </A T> <U R>4</U R> <LN >en</LN > <H T>N ortel quarterly loss triples; charges w eigh</H T> <TY>story </TY> <P E >99999 10100 10102</P E > <C O /> <TN >1</TN > </H L> <H L xmlns="http://schemas.reuters.com/ns/2006/04/14/rmds/w ebserv ices/new s/headlineml" space="preserv e"> <ID>urn:new sml:onlinereport.com:20080801:nM TF H 8847120080801102358N 31363853:2</ID> <RE >2</RE > <S T>U sable</S T> <C T>2008-08-01T05:23:58-05:00</C T> <RT>2008-08-01T05:23:58-05:00</RT> <LT>2008-08-01T05:55:23-05:00</LT> <P R>onlinereport.com</P R> <A T>IDS </A T> <U R>4</U R> <LN >en</LN > <H T>G M inv estors brace for brutal results</H T> <TY>story </TY> <P E >99999 10100 10102</P E > <C O /> <TN >1</TN > </H L> <H L xmlns="http://schemas.reuters.com/ns/2006/04/14/rmds/w ebserv ices/new s/headlineml" space="preserv e"> <ID>urn:new sml:onlinereport.com:20080801:nM TF H 8836720080801101832WN A B4336:2</ID> <RE >2</RE > <S T>U sable</S T> <C T>2008-08-01T05:18:32-05:00</C T> <RT>2008-08-01T05:18:32-05:00</RT> <LT>2008-08-01T05:24:09-05:00</LT> <P R>onlinereport.com</P R> <A T>IDS </A T> <U R>4</U R> <LN >en</LN > <H T>N ortel quarterly loss triples as charges w eigh</H T> <TY>story </TY> <P E >99999 10100 10102</P E > <C O /> <TN >1</TN > </H L> <H L xmlns="http://schemas.reuters.com/ns/2006/04/14/rmds/w ebserv ices/new s/headlineml" space="preserv e">

518

TRKD API Developer's Guide

<ID>urn:new sml:onlinereport.com:20080801:nM TF H 8814120080801100900N 31363853:2</ID> <RE >2</RE > <S T>U sable</S T> <C T>2008-08-01T05:09:00-05:00</C T> <RT>2008-08-01T05:09:00-05:00</RT> <LT>2008-08-01T05:18:51-05:00</LT> <P R>onlinereport.com</P R> <A T>IDS </A T> <U R>4</U R> <LN >en</LN > <H T>G M inv estors brace for brutal Q 2 results</H T> <TY>story </TY> <P E >99999 10100 10102</P E > <C O /> <TN >1</TN > </H L> </H E A DLIN E M L> </H eadlineM LResponse> </G etH eadlines_Response_1> </Body > </E nv elope>

24.6

Get Topics (GetTopics_Request_2)

The following example shows how to retrieve all Online Reports topics. XML Sample Request - Get Topics
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/O nlineReports_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/O nlineReports_1/ G etTopics_2</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <GetT opics_Request_2 xmlns="http://www.r euter s.com/ns/2 0 0 6 /0 5 /0 1 /webser vices/r kd/O nlineRepor ts_1 " /> </Body > </E nv elope>

Note: The GetTopics_Request_2 supports multiple languages; Japanese and Chinese translations are currently available. XML Sample Response - Get Topics
<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader> <a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" s:mustU nderstand="1">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/ O nlineReports_1/G etTopics_1_Reply </a:A ction> <a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etTopics_Response_2 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/O nlineReports_1"> <Region name="U K O nline Report"> <topic code="O LG BTO P N E WS " desc="Top N ew s"></topic> <topic code="O LG BWO RLD" desc="World"></topic> <topic code="O LG BBU S " desc="Business"></topic> <topic code="O LG BE N T" desc="E ntertainment"></topic> <topic code="O LG BS P O RT" desc="S ports"></topic> <topic code="O LG BIN T" desc="U K Internet Report"></topic> <topic code="O LG BO DD" desc="U K O ddly E nough Report"></topic> </Region> ...

Online Reports

519

<Region name="Brazil O nline Report"> <topic code="O LBRBU S " desc="Business"></topic> <topic code="O LBRTO P N E WS " desc="Top N ew s"></topic> <topic code="O LBRE N T" desc="E ntertainment"></topic> <topic code="O LBRS P O RT" desc="S ports"></topic> <topic code="O LBRWO RLD" desc="World"></topic> <topic code="O LBRIN T" desc="Brazil Technology / Internet O nline Report"></topic> </Region> <Region name="Latam O nline Report"> <topic code="O LLTTO P N E WS " desc="Top N ew s"></topic> <topic code="O LLTBU S " desc="Business"></topic> <topic code="O LLTS P O RT" desc="S ports"></topic> <topic code="O LLTE N T" desc="E ntertainment"></topic> <topic code="O LLTC O U N TRY" desc="Latam C ountry N ew s "></topic> <topic code="O LLTWO RLD" desc="Latam U S and World N ew s "></topic> <topic code="O LLTIN T" desc="Latam Internet Report"></topic> </Region> </G etTopics_Response_2> </Body > </E nv elope>

24.7

Retrieving Images Associated with Online Reports

All online reports images can be accessed at the following url: http://<rkd_server_name>/api/onlinereports/<image_name>. JPG For example: http://api.rkd.reuters.com/api/onlinereports/2009-02-08T153205Z_01_AMSE517175M00_RTROPTP_1_ORUTPUKRAINE-GOVERNMENT-LOAN.JPG To retrieve the thumbnail JPEG images associated with the online report, picture locations are given in the <SR> element in the response body: XML Sample Request
<S R> <O rigin Ty pe="S tory Ref">urn:new sml:onlinereport.com:20090213:nTRE 51C 1C 320090213105951</O rigin> <O rigin Ty pe="ThumbnailRef">http://api.rkd.reuters.com/api/onlinereports/2009-0213T105947Z_01_BTRE 51C 0H ZV 00_RTRO P TP _1_O U KTP -U K-A F G H A N -H O LBRO O KE .JP G .ashx</O rigin> <O rigin Ty pe="V iew Ref">http://api.rkd.reuters.com/api/onlinereports/2009-02-13T105947Z_01_BTRE 51C 0H ZV 00_RTRO P TP _2_O U KTP U K-A F G H A N -H O LBRO O KE .JP G .ashx</O rigin> <O rigin Ty pe="BaseRef">http://api.rkd.reuters.com/api/onlinereports/2009-02-13T105947Z_01_BTRE 51C 0H ZV 00_RTRO P TP _3_O U KTP U K-A F G H A N -H O LBRO O KE .JP G .ashx</O rigin> <O rigin Ty pe="S tory Title">N ew U .S . env oy in A fghanistan</O rigin> <O rigin Ty pe="S tory C reationDate">20090213T105951+0000</O rigin> <O rigin Ty pe="ImageC reationDate">20090213T105947+0000</O rigin> <O rigin Ty pe="C hannelC ode">O LG BTO P N E WS </O rigin> <O rigin Ty pe="LinkTitle">Reuters U K O nline Report Top N ew s</O rigin> </S R>

In order to retrieve a thumbnail image, the required URL is: http://rkd_server_name/api/onlinereports/2009-02-13T105947Z_01_BTRE51C0HZV00_RTROPTP_1_OUKTP-UK-AFGHANHOLBROOKE.JPG Up to three pictures maybe available in one report. These are provided in two resolution variants: 1. 150x106 (approx 8-10 kb) for Thumbnail image 2. 450x319 (approx 19-24 kb) for View and Base images To find the image name for the different sizes, look for the "Type" attribute, which describes type of image (ThumbnailRef, ViewRef and BaseRef): XML Sample Request
<S R>

520

TRKD API Developer's Guide

<O rigin Ty pe="S tory Ref">urn:new sml:onlinereport.com:20090213:nTRE 51C 1C 320090213105951</O rigin> <O rigin Ty pe=" T humbnailRef ">http://api.rkd.reuters.com/api/onlinereports/2009-0213T105947Z_01_BTRE 51C 0H ZV 00_RTRO P TP _1_O U KTP -U K-A F G H A N -H O LBRO O KE .JP G .ashx</O rigin> <O rigin Ty pe=" V iewRef ">http://api.rkd.reuters.com/api/onlinereports/2009-02-13T105947Z_01_BTRE 51C 0H ZV 00_RTRO P TP _2_O U KTP U K-A F G H A N -H O LBRO O KE .JP G .ashx</O rigin> <O rigin Ty pe=" BaseRef ">http://api.rkd.reuters.com/api/onlinereports/2009-02-13T105947Z_01_BTRE 51C 0H ZV 00_RTRO P TP _3_O U KTP U K-A F G H A N -H O LBRO O KE .JP G .ashx</O rigin> <O rigin Ty pe="S tory Title">N ew U .S . env oy in A fghanistan</O rigin> <O rigin Ty pe="S tory C reationDate">20090213T105951+0000</O rigin> <O rigin Ty pe="ImageC reationDate">20090213T105947+0000</O rigin> <O rigin Ty pe="C hannelC ode">O LG BTO P N E WS </O rigin> <O rigin Ty pe="LinkTitle">Reuters U K O nline Report Top N ew s</O rigin> </S R>

Thus, for instance, to retrieve the view image for this story, use the following url: http://rkd_server_name/api/onlinereports/2009-02-13T105947Z_01_BTRE51C0HZV00_RTROPTP_2_OUKTP-UK-AFGHANHOLBROOKE.JPG Note: If "SR" element contains only thumbnail image, it is necessary to make the GetSummaryByStories_Request_1 with 'ImageRef' to retrieve view image. Example: XML Sample Request
<S R> <O rigin Ty pe="ThumbnailRef">http://api.rkd.reuters.com/api/onlinereports/2009-0213T044627Z_01_BTRE 51C 0D9K00_RTRO P TP _1_S P O RTS -U S -C YC LIN G -C A LIF O RN IA .JP G .ashx</O rigin> <O rigin Ty pe="ImageRef"> ur n:newsml:onliner epor t.com:2 0 0 9 0 2 1 3 :nBT RE5 1 C 0 D9 K0 0 2 0 0 9 0 2 1 3 0 4 4 6 2 7 </O rigin> <O rigin Ty pe="ImageTitle">A stana cy clist Lance A rmstrong laughs as he takes questions during pre-race new s conference in S acramento</ O rigin> <O rigin Ty pe="C hannelC ode">O LU S S P O RT</O rigin> <O rigin Ty pe="LinkTitle">Reuters U S O nline Report S ports N ew s</O rigin> <O rigin Ty pe="S tory C reationDate">20090213T032756+0000</O rigin> <O rigin Ty pe="ImageC reationDate">20090213T044627+0000</O rigin> </S R> GetSummar yByStor ies_Response_1 for ur n:newsml:onliner epor t.com:2 0 0 9 0 2 1 3 : nBT RE5 1 C 0 D9 K0 0 2 0 0 9 0 2 1 3 0 4 4 6 2 7 <S R> <O rigin Ty pe="S tory Ref">urn:new sml:onlinereport.com:20090213:nTRE 51C 0T520090213032756</O rigin> <O rigin Ty pe="ThumbnailRef">http://api.rkd.reuters.com/api/onlinereports/2009-0213T044627Z_01_BTRE 51C 0D9K00_RTRO P TP _1_S P O RTS -U S -C YC LIN G -C A LIF O RN IA .JP G .ashx</O rigin> <O rigin Ty pe="V iew Ref">http://api.rkd.reuters.com/api/onlinereports/2009-02-13T044627Z_01_BTRE 51C 0D9K00_RTRO P TP _2_S P O RTS U S -C YC LIN G -C A LIF O RN IA .JP G .ashx</O rigin> <O rigin Ty pe="BaseRef">http://api.rkd.reuters.com/api/onlinereports/2009-02-13T044627Z_01_BTRE 51C 0D9K00_RTRO P TP _3_S P O RTS U S -C YC LIN G -C A LIF O RN IA .JP G .ashx</O rigin> <O rigin Ty pe="S tory Title">A rmstrong feeling fresh for Tour of C alifornia</O rigin> <O rigin Ty pe="S tory C reationDate">20090213T032756+0000</O rigin> <O rigin Ty pe="ImageC reationDate">20090213T044627+0000</O rigin> <O rigin Ty pe="C hannelC ode">O LU S S P O RT</O rigin> <O rigin Ty pe="LinkTitle">Reuters U S O nline Report S ports N ew s</O rigin> </S R>

24.8

Retrieving Stories without Duplicates

One of the possible ways to get relevant and unique headlines is to call the GetSummaryByTopic_1 request and use the body of the first returned story (first OLR Headline). If HTML-decoded it usually looks like the following: XML Sample Request
<p> <O rigin H ref="S tory Ref">urn:new sml:onlinereport.com:20100219:nTRE 61I37Q 20100219144148</O rigin>C ataly st leads second, $ 120 million C anw est bid<p>O TTA WA (Reuters) - A second bid for the broadcast arm of C anada&apos;s C anw est &lt;C G S .V &gt; media empire

Online Reports

521

emerged on F riday as a consortium led by priv ate equity fund C ataly st C apital and backed by G oldman S achs G roup Inc &lt;G S .N &gt; offered $ 120 million for the bankrupt telev ision operation.</p><O rigin H ref="ThumbnailRef">2010-02-19T141835Z_01_BTRE 61I13R300_RTRO P TP _1_C BU S IN E S S -U S -C A N WE S T.JP G </O rigin><O rigin H ref="ImageRef">urn:new sml:onlinereport.com:20100219:nBTRE 61I13R30020100219141835</O rigin><O rigin H ref="ImageTitle">A C anw est sign is seen outside an office building in Toronto</O rigin><O rigin H ref="S tory C reationDate">20100219T144148+0000</O rigin><O rigin H ref="ImageC reationDate">20100219T141835+0000</O rigin> </p> <p> <O rigin H ref="S tory Ref">urn:new sml:onlinereport.com:20100219:nTRE 61I2Z420100219155323</O rigin>C anadians spending w ay to recov ery , data show s<p>O TTA WA (Reuters) - C onsumer spending and a sizzling housing market are pow ering C anada&apos;s economic recov ery , tw o reports show ed on F riday , suggesting a surge in grow th at the end of last y ear w ill lead to a strong start to 2010.</p><O rigin H ref="ThumbnailRef">2010-02-19T133805Z_01_BTRE 61I11V L00_RTRO P TP _1_C BU S IN E S S -U S -E C O N O M Y-RE TA IL.JP G </ O rigin><O rigin H ref="ImageRef">urn:new sml:onlinereport.com:20100219:nBTRE 61I11V L0020100219133805</O rigin><O rigin H ref="ImageTitle">A w oman cleans the shelv es airport</O rigin><O rigin H ref="S tory C reationDate">20100219T155323+0000</O rigin><O rigin H ref="ImageC reationDate">20100219T133805+0000</O rigin> </p> <p> <O rigin H ref="S tory Ref">urn:new sml:onlinereport.com:20100219:nTRE 61I2S R20100219131502</O rigin>C anada to oppose global bank tax: report<p>TO RO N TO (Reuters) - C anada w ill formally oppose international efforts by the w orld&apos;s major economies to impose a global bank tax as the current gov ernment fav ors low er taxes, C anada&apos;s N ational P ost new spaper reported on F riday .</p><O rigin H ref="ThumbnailRef">2010-02-19T131459Z_01_BTRE 61I10T200_RTRO P TP _1_C BU S IN E S S -U S -G 20-BA N KTA X-C A N A DA .JP G </ O rigin><O rigin H ref="ImageRef">urn:new sml:onlinereport.com:20100219:nBTRE 61I10T20020100219131459</O rigin><O rigin H ref="ImageTitle">C anada&apos;s P M H arper meets w ith business professionals in O ttaw a</O rigin><O rigin H ref="S tory C reationDate">20100219T131502+0000</O rigin><O rigin H ref="ImageC reationDate">20100219T131459+0000</O rigin> </p>

Each <p> section represents a unique headline. Removing duplicate stories from the list returned by the GetHeadlines_1 request To filter the duplicate stories from those returned by the GetHeadlines_1 request you need to extract part of the storyID (see below in bold). Here is the example:

XML Sample Request

urn:new sml:onlinereport.com:20100218:nT RE6 1 H 6 2 I 20100218225320:4 urn:new sml:onlinereport.com:20100219:nT RE6 1 H 6 2 I 20100219000548:30 urn:new sml:onlinereport.com:20100219:nT RE6 1 H 6 2 I 20100219031327:4 urn:new sml:onlinereport.com:20100218:nT RE6 1 H 6 2 I 20100218214604:4 urn:new sml:onlinereport.com:20100218:nT RE6 1 H 6 2 I 20100218214923:10

For the story IDs above, the ':nTRE61H62' is equal, which means these all are just different revisions of the same story.

522

TRKD API Developer's Guide

chapter 25

People Search

People Search service provides information about Corporate Officers and Directors. The basic search provides basic information based on either partial name or PersonID. Detailed search provides full detailed information including education, compensation history, certifications, etc. Relationship search gives a list of all other officers and directors of the companies with which a given person is associated. The following operations are available through the People Search service: Get Detail (GetDetail_1) - retrieves corporate officers and director's data including compensation history. Get Person Relationships (GetPersonRelationships_1) - retrieves information on an officer's corporate affiliations or relationships within companies on the Reuters Fundamental database. Get Relational Path (GetRelationalPath_1) - retrieves details about relational path between two specified Person IDs. Get Search (GetSearch_1) - searches for a personal profile in a company.

25.1

Authentication/Authorization, Service Endpoint, and Required Headers

Authorization All requests to the People Search service require an authorization token. For details, see section Understanding Authentication Tokens. Authentication Thomson Reuters People Search uses Reuters impersonation tokens for each effective user. In this case, Thomson Reuters must create each user before your application authenticates them. Unmanaged effective users are not supported in Reuters People Search. For additional information on creating a Service Token, see section Creating a Token. Service Endpoint People Search Endpoint
http://api.rkd.reuters.com/api/2009/02/04/P eopleS earch_1.sv c

Required Header Required HTTP Headers

P O S T api/2009/02/04/P eopleS earch_1.sv c H TTP /1.1 C ontent-Ty pe: application/soap+xml H ost: api.rkd.reuters.com C ontent-Length: [length]

25.2

WSDL
WSDL:
http://api.rkd.reuters.com/schemas/w sdl/P eopleS earch_1_H ttpA ndRKDToken.w sdl

People Search

523

25.3

Get Detail (GetDetail_1)

The GetDetail_1 request is used to access corporate officers and director's data including compensation history. The following example retrieves data for the officer with PersonID="3". XML Sample Request - Retrieving Person Details
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/02/04/P eopleS earch_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/02/04/w ebserv ices/rkd/P eopleS earch_1/ G etDetail_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etDetail_Request_1 xmlns="http://w w w .reuters.com/ns/2009/02/04/w ebserv ices/rkd/P eopleS earch_1" P er sonID="3 " /> </Body > </E nv elope>

The request can take the following attributes: Attribute PersonID TransactionID lang Description Unique person ID (mandatory). Transaction ID (optional). The language used for people search (optional). Can have the following values: en-US (default) ja-JP zh-JHS

The response returns the following information: XML Sample Response - Retrieving Person Details
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/02/04/w ebserv ices/rkd/P eopleS earch_1/G etDetail_1_Reply </a: A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-02-12T14:04:32.1894661Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etDetail_Response_1 xmlns="http://w w w .reuters.com/ns/2009/02/04/w ebserv ices/rkd/P eopleS earch_1"> <RequestA rguments P ersonID="3" lang="en-U S "></RequestA rguments> <P eopleA ffiliations> <P eopleA ffiliationDetail> <P erson ID="3" A ctiv e="false"></P erson> <P ersonInformation> <LastM odified Date="2005-11-12T08:26:54.113"></LastM odified> <N ame> <Info Ty pe="LastN ame">S av itz</Info> <Info Ty pe="F irstN ame">Richard</Info> <Info Ty pe="M iddleInitial">J</Info> <Info Ty pe="A ge">53</Info> <Info Ty pe="S ex">M </Info> </N ame> </P ersonInformation>

524

TRKD API Developer's Guide

<C orporateA ffiliations> <A ffiliation O rder="1"> <C ompany RepN o="48680" N ame="Justin Industries, Inc." A ctiv e="false"></C ompany > <O fficer ID="3" Title="V ice P resident-F inance, Treasurer, S ecretary " A ctiv e="false"></O fficer> <A ddress> <S treetA ddress Line="1">2821 West 7th S treet</S treetA ddress> <C ity >F ort Worth</C ity > <S tateO rRegion>Texas</S tateO rRegion> <P ostalC ode>76107</P ostalC ode> <C ountry C ode="U S A ">U nited S tates</C ountry > </A ddress> <Industry C lassification> <Taxonomy Ty pe="RBS S 2004"> <Detail O rder="1" C ode="51221" M nemonic="51221" Description="C onstruction M aterials"></Detail> </Taxonomy > </Industry C lassification> <P ositionInformation> <TenureDates> <O fficerS tart Year="1982" M onth="3"></O fficerS tart> <O fficerE nd Year="2000" M onth="8"></O fficerE nd> </TenureDates> <Titles> <Designation> <E nd Year="1999"></E nd> <LongTitle>V ice P resident-F inance, Treasurer, S ecretary </LongTitle> <Title O rder="0" ID="V F N ">V ice P resident - F inance</Title> <Title O rder="1" ID="TRS ">Treasurer</Title> <Title O rder="2" ID="S E C ">S ecretary </Title> </Designation> <Designation> <S tart Year="1999"></S tart> <E nd Year="2000" M onth="8"></E nd> <LongTitle>C hief F inancial O fficer, S enior V ice P resident, S ecretary </LongTitle> <Title O rder="0" ID="C F O ">C hief F inancial O fficer</Title> <Title O rder="1" ID="S V P ">S enior V ice P resident</Title> <Title O rder="2" ID="S E C ">S ecretary </Title> </Designation> </Titles> </P ositionInformation> <BiographicalInformation> <Text Ty pe="Biography "></Text> </BiographicalInformation> <S alary Information> <C ompensationP eriod E ndDate="1999-12-31"> <S ubmission Ty pe="10-K405" Year="2000" M onth="3" Day ="29"></S ubmission> <C ompensationC urrency >U S D</C ompensationC urrency > <C ompensationInformation> <C ompensation Ty pe="S alary ">263000</C ompensation> <C ompensation Ty pe="Bonus">139390</C ompensation> <C ompensation Ty pe="O therS T">148750</C ompensation> <C ompensation Ty pe="TotalS T">551140</C ompensation> <C ompensation Ty pe="A llO therLT">4213</C ompensation> <C ompensation Ty pe="TotalC omp">555353</C ompensation> </C ompensationInformation> <O ptionsInformation> <O ption Ty pe="E xercised"> <N umber>8860</N umber> <V alue>67710</V alue> </O ption> <O ption Ty pe="U nexercised-E xercisable"> <N umber>58200</N umber> <V alue>269724</V alue> </O ption> <O ption Ty pe="U nexercised-U nexercisable"> <N umber>61000</N umber> <V alue>86000</V alue> </O ption> </O ptionsInformation> </C ompensationP eriod> <C ompensationP eriod E ndDate="1998-12-31"> <S ubmission Ty pe="10-K405" Year="1999" M onth="3" Day ="26"></S ubmission> <S ubmission Ty pe="DE F 14A " Year="1999" M onth="3" Day ="12"></S ubmission> <C ompensationC urrency >U S D</C ompensationC urrency > <C ompensationInformation> <C ompensation Ty pe="S alary ">225000</C ompensation> <C ompensation Ty pe="Bonus">90000</C ompensation> <C ompensation Ty pe="TotalS T">315000</C ompensation>

People Search

525

<C ompensation Ty pe="A llO therLT">4660</C ompensation> <C ompensation Ty pe="TotalC omp">319660</C ompensation> </C ompensationInformation> <O ptionsInformation> <O ption Ty pe="E xercised"> <N umber>4640</N umber> <V alue>39225</V alue> </O ption> <O ption Ty pe="U nexercised-E xercisable"> <N umber>57060</N umber> <V alue>249246</V alue> </O ption> <O ption Ty pe="U nexercised-U nexercisable"> <N umber>36000</N umber> <V alue>37620</V alue> </O ption> </O ptionsInformation> </C ompensationP eriod> <C ompensationP eriod E ndDate="1997-12-31"> <S ubmission Ty pe="10-K"></S ubmission> <S ubmission Ty pe="P roxy S tatement"></S ubmission> <C ompensationC urrency >U S D</C ompensationC urrency > <C ompensationInformation> <C ompensation Ty pe="S alary ">213000</C ompensation> <C ompensation Ty pe="Bonus">102240</C ompensation> <C ompensation Ty pe="TotalS T">315240</C ompensation> <C ompensation Ty pe="A llO therLT">4410</C ompensation> <C ompensation Ty pe="TotalC omp">319650</C ompensation> </C ompensationInformation> <O ptionsInformation> <O ption Ty pe="U nexercised-E xercisable"> <N umber>53700</N umber> <V alue>308285</V alue> </O ption> <O ption Ty pe="U nexercised-U nexercisable"> <N umber>29000</N umber> <V alue>32750</V alue> </O ption> </O ptionsInformation> </C ompensationP eriod> </S alary Information> </A ffiliation> </C orporateA ffiliations> </P eopleA ffiliationDetail> </P eopleA ffiliations> </G etDetail_Response_1> </Body > </E nv elope>

For the description of elements returned by the response please see Understanding GetDetail_1 response section.

25.3.1 Understanding GetDetail_1 Response

The PeopleAffiliations element is the main element of interest. This section contains all of the officers and directors related information. Information for each officer begins with a Person ID tag. The Person ID enables identification of the relationship between the individual and companies. Active persons are ordered in the file by their rank. Each active person is ranked using a system of sub-ranks for each title (e.g. Chairman of the Board ranked higher than CEO, which in turn is ranked higher than VP). Inactive persons are not ranked in the OD file, and are ordered by their most recent End Date. Person Active indicates whether an individual (person) is 'true' (active) or 'false' (inactive) and is derived from Officer Status and Company Status. If a person is active, all person-specific fields will be updated regardless of Officer Active status. A person is "active" when at least one associated Officer ID is active, and the company associated with that Officer ID is active. If all associated Officer ID's are inactive or the Company Status for each active officer is inactive, then the Person Active will be 0 (inactive). Therefore, if a person belongs to two companies and one is inactive, the age will continue to be updated for both the active issue and the inactive issue. When companies themselves are inactivated, no changes are made to the officer information contained in the database. Therefore Inactive companies will contain 'active' persons. XML Sample

526

TRKD API Developer's Guide

<P eopleA ffiliations> <P eopleA ffiliationDetail> <P erson ID="3" A ctiv e="false"></P erson> .... </P eopleA ffiliations>

Each PeopleAffiliations element will also contain the following information divided up into sub-elements: Person Information Corporate Affiliations Position Information Biographical Information Salary Information

25.3.1.1 Corporate Affiliations

CorporateAffiliations section provides information on an officer's corporate affiliations or relationships within companies on the Reuters Fundamental database. Fields include RepNo (Report Number that represents the U.S GAAP filing associated to the Thomson Reuters Issue ADR ID), Company Name, Officer ID, Title, Address and Industry Classification for the company and will be listed per Order record. IndustryClassification contains information about the companys primary industry classifications. While Thomson Reuters Fundamentals tags each company by up to 10 NAICS and 10 SIC codes, GetDetail_1 only contains the primary classification for each industry classification system (taxonomy). Each IndustryClassification element contains the following information divided up into sub-elements: Type: Indicates type of classification. Order: In this case the order will always be 1 indicating primary classification. Code: Unique industry code. Description: Name of the industry. Mnemonic: A mnemonic for the code XML Sample
<C orporateA ffiliations> <A ffiliation O rder="1"> <C ompany RepN o="48680" N ame="Justin Industries, Inc." A ctiv e="false"></C ompany > <O fficer ID="3" Title="V ice P resident-F inance, Treasurer, S ecretary " A ctiv e="false"></O fficer> <A ddress> <S treetA ddress Line="1">2821 West 7th S treet</S treetA ddress> <C ity >F ort Worth</C ity > <S tateO rRegion>Texas</S tateO rRegion> <P ostalC ode>76107</P ostalC ode> <C ountry C ode="U S A ">U nited S tates</C ountry > </A ddress> <Industry C lassification> <Taxonomy Ty pe="RBS S 2004"> <Detail O rder="1" C ode="51221" M nemonic="51221" Description="C onstruction M aterials"></Detail> </Taxonomy > </Industry C lassification> ..... </A ffiliation> </C orporateA ffiliations>

25.3.1.2 Position Information

PositionInformation contains an element on each of the following items:

People Search

527

Tenure Dates Titles Committee Membership Tenure Dates - Tenure dates indicate the length of service for this person with this company. Tenure may be indicated for an Officer, Director or both. The existence of an End Date indicates that the person is no longer an Officer (or Director) with the company. Note: The date is not given in regular Date format (YYYYMMDD) because some components of the date (e.g. the Day) may not be available. In some instances the Start Year may also not be available to Reuters. In such instances Start Year is populated with the string NA. Titles - The Titles section details the various titles a person has held with a company, over time. Each Designation has a Start date, may have an End date, has a Long Title as reported by the company, and up to four titles. Thus, a company may report a persons most recent title as Chairman of the Board and Chief Executive Officer. This will appear as the Long Title. The person will also be tagged with two title IDs: CHM =Chairman and CEO = Chief Executive Officer. If available, this title will also have a Start date. However, as the most current title, this will not have an End date. If this person was previously a VP of the company, then there will be another Designation record in the file. This could have a Long Title of Vice President and a title ID VP=Vice President. As this is not the most current title, this designation will have an End date. Committee Memberships - This section details the various board committees a director sits on. Fields include committee, title and start/end date. XML Sample
<P ositionInformation> <TenureDates> <O fficerS tart Year="1982" M onth="3"></O fficerS tart> <O fficerE nd Year="2000" M onth="8"></O fficerE nd> </TenureDates> <Titles> <Designation> <E nd Year="1999"></E nd> <LongTitle>V ice P resident-F inance, Treasurer, S ecretary </LongTitle> <Title O rder="0" ID="V F N ">V ice P resident - F inance</Title> <Title O rder="1" ID="TRS ">Treasurer</Title> <Title O rder="2" ID="S E C ">S ecretary </Title> </Designation> <Designation> <S tart Year="1999"></S tart> <E nd Year="2000" M onth="8"></E nd> <LongTitle>C hief F inancial O fficer, S enior V ice P resident, S ecretary </LongTitle> <Title O rder="0" ID="C F O ">C hief F inancial O fficer</Title> <Title O rder="1" ID="S V P ">S enior V ice P resident</Title> <Title O rder="2" ID="S E C ">S ecretary </Title> </Designation> </Titles> </P ositionInformation>

25.3.1.3 Biographical Information

This section provides an officers biography. Information is collected for all companies on the Reuters Fundamental database where available and is unique per company. XML Sample
<BiographicalInformation> <Text Ty pe="Biography ">M r. Thomas H . G locer is C hief E xecutiv e O fficer of Thomson Reuters P LC . M r. G locer joined Reuters G roup in 1993 as V ice P resident and Deputy C ounsel, Reuters A merica. H e held a number of senior leadership positions at Reuters, including P resident of Reuters LatA m and Reuters A merica, before being named C E O of Reuters G roup P LC in July 2001. H e also serv ed on the Reuters Board from 2000...</Text> </BiographicalInformation>

528

TRKD API Developer's Guide

25.3.1.4 Salary Information

This section contains information about an officers remuneration, both salary (CompensationInformation) and stock options related (OptionsInformation). The information is provided on a periodic basis, with a period end date identifying each period. The currency for the reported remuneration is provided with the tag CompensationCurrency. This currency may change over time. Non-stock option related compensation is listed under Compensation. Various types of Compensation types are listed in the table below: Item Derived from 1 2 3 4 5 6 7 8 Data Entry Data Entry Data Entry =1+2+3 Data Entry Data Entry Data Entry =4+5+6+7 XML Tag Salary Bonus OtherST TotalST Description Salary Bonus Other Short Term Compensation Total Short Term Compensation

RestrictedSt Value of Restricted Stock options ock LTIP AllOtherLT TotalComp Long Term Incentive Payout Other Long Term Compensation Total Compensation

XML Sample
<S alary Information> <C ompensationP eriod E ndDate="1999-12-31"> <S ubmission Ty pe="10-K405" Year="2000" M onth="3" Day ="29"></S ubmission> <C ompensationC urrency >U S D</C ompensationC urrency > <C ompensationInformation> <C ompensation Ty pe="S alary ">263000</C ompensation> <C ompensation Ty pe="Bonus">139390</C ompensation> <C ompensation Ty pe="O therS T">148750</C ompensation> <C ompensation Ty pe="TotalS T">551140</C ompensation> <C ompensation Ty pe="A llO therLT">4213</C ompensation> <C ompensation Ty pe="TotalC omp">555353</C ompensation> </C ompensationInformation> <O ptionsInformation> <O ption Ty pe="E xercised"> <N umber>8860</N umber> <V alue>67710</V alue> </O ption> <O ption Ty pe="U nexercised-E xercisable"> <N umber>58200</N umber> <V alue>269724</V alue> </O ption> <O ption Ty pe="U nexercised-U nexercisable"> <N umber>61000</N umber> <V alue>86000</V alue> </O ption> </O ptionsInformation> </C ompensationP eriod> .... </S alary Information>

25.3.1.5 Person Information

PersonInformation section contains information pertaining to the person's name, age (and date of birth) and sex. Note: Person-specific fields are maintained on an individual level i.e. as reported in a companys latest source document that an officer is associated with. All fields within the "PersonInformation" container element will be maintained until a persons status becomes inactive.

People Search

529

Name - Contains all information pertinent to an individual's name. Fields include first, middle, last and preferred name in addition to prefix and suffix. First and last name are required fields. Preferred name may include an officers/directors nickname and/or western name depending on their preference and origin. Certifications - The certifications element will display a certificate obtained by a person during his/her lifetime. This information will not be linked to a date and will only display the certificate. EducationHistory - This section provides information on the person's educational background. Fields include college, degree, major and graduation date, and will be listed per Degree record. If a person has multiple degrees from the same college, then two records are created. XML Sample
<P ersonInformation> <LastM odified Date="2005-11-12T08:26:54.113"></LastM odified> <N ame> <Info Ty pe="LastN ame">S av itz</Info> <Info Ty pe="F irstN ame">Richard</Info> <Info Ty pe="M iddleInitial">J</Info> <Info Ty pe="A ge">53</Info> <Info Ty pe="S ex">M </Info> </N ame> </P ersonInformation>

25.4

Get Person Relationships (GetPersonRelationships_1)

The GetPersonRelationships_1 request provides information on an officer's corporate affiliations or relationships within companies on the Thomson Reuters Fundamental database. The following example retrieves person relationships information for the PersonID="3". XML Sample Request - Retrieving Person Relationships Information
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/02/04/P eopleS earch_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/02/04/w ebserv ices/rkd/P eopleS earch_1/ G etP ersonRelationships_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etP ersonRelationships_Request_1 xmlns="http://w w w .reuters.com/ns/2009/02/04/w ebserv ices/rkd/P eopleS earch_1" P er sonID ="3"></G etP ersonRelationships_Request_1> </Body > </E nv elope>

The request can take the following attributes: Attribute Person ID Transaction ID Language Description Unique person ID (mandatory). Transaction ID (optional). The language used for people search (optional). Can have the following values: en-US ja-JP zh-JHS Shows current relationships of the person (optional).

Current

530

TRKD API Developer's Guide

Relationships Only Directors Only Exclude

Shows officers and directors or directors only (optional). Allows you to add exclusions (optional).To add an exclusion you need to specify: PersonID - person identifier. RepNo - Report Number ID that represents the U.S. GAAP filing associated to the Reuters Issue ADR ID.

The response returns the following information for the PersonID="3": XML Sample Response - Retrieving Person Relationships Information
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/02/04/w ebserv ices/rkd/P eopleS earch_1/ G etP ersonRelationships_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-02-12T14:04:32.1894661Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etP ersonRelationships_Response_1 xmlns="http://w w w .reuters.com/ns/2009/02/04/w ebserv ices/rkd/P eopleS earch_1"> <RequestA rguments P ersonID="3" lang="en-U S " C urrentRelationshipsO nly ="false" DirectorsO nly ="false"></RequestA rguments> < P er son P ersonID="3" A ctiv eS tatus="false"> <LastM odified Date="2005-11-12T08:26:54.113"></LastM odified> <N ame> <Info Ty pe="LastN ame">S av itz</Info> <Info Ty pe="F irstN ame">Richard</Info> <Info Ty pe="M iddleInitial">J</Info> <Info Ty pe="A ge">53</Info> <Info Ty pe="S ex">M </Info> </N ame> <C orporateA ffiliations> <A ffiliation> < C ompany Issuer ID="2583" RepNo ="48680" Name ="Justin Industries, Inc." O r gID="26283" A ctive ="false"> <O fficersDirectors> <O fficer> < P er son P ersonID="1" A ctiv eS tatus="false"> <LastM odified Date="2005-11-12T08:26:54.113"></LastM odified> <N ame> <Info Ty pe="LastN ame">Justin</Info> <Info Ty pe="F irstN ame">John</Info> <Info Ty pe="A ge">83</Info> <Info Ty pe="S ex">M </Info> </N ame> </P erson> <P osition O fficer ID="1" A ctiveStatus ="false" T itle ="C hairman of the Board, C hief E xecutiv e O fficer, Director"></P osition> </O fficer> ... ... <O fficer> <P erson P ersonID="8540" A ctiv eS tatus="false"> <LastM odified Date="2008-03-26T06:27:55.257" /> <N ame> <Info Ty pe="LastN ame">M usolino</Info> <Info Ty pe="F irstN ame">Joseph</Info> <Info Ty pe="M iddleInitial">R</Info> <Info Ty pe="A ge">67</Info> <Info Ty pe="S ex">M </Info> </N ame> <C orporateA ffiliations> <A ffiliation> <C ompany IssuerID="3698" RepN o="71615" N ame="P ool E nergy S erv ices C o." O rgID="29424" A ctiv e="false"></C ompany > <P osition O fficerID="8540" A ctiv eS tatus="false" Title="Director"></P osition> </A ffiliation> <A ffiliation> <C ompany IssuerID="9319" RepN o="A 12A E " N ame="E dge P etroleum C orp." O rgID="112195" A ctiv e="true"></C ompany > <P osition O fficerID="435074" A ctiv eS tatus="false" Title="Director"></P osition>

People Search

531

</A ffiliation> </C orporateA ffiliations> </P erson> <P osition O fficerID="10" A ctiv eS tatus="false" Title="Director"></P osition> </O fficer> ... </O fficersDirectors> </C ompany > <P osition O fficerID="3" A ctiv eS tatus="false" Title="V ice P resident-F inance, Treasurer, S ecretary "></P osition> </A ffiliation> </C orporateA ffiliations> </P erson> </G etP ersonRelationships_Response_1> </Body > </E nv elope>

The response provides information on officer's corporate affiliations or relationships within companies on the Thomson Reuters Fundamental database. Each response can have the following fields: Attribute Description Person Contains information pertaining to the person's ID, name, age and sex. Company Contains company information. Includes the following fields: IssuerID - unique Thomson Reuters-assigned Issuer ID. RepNo - Report Number that represents the U.S GAAP filing associated to the Reuters Issue ADR ID. Name - company name. OrgID - unique organization identifier (default reference in web services). Active - is company active or not. Position Contains details on person's position. Includes the following fields: OfficerID - unique Officer ID within a company. ActiveStatus - indicates whether an officer or director is 'true' (active) or 'false' (inactive). Title - contains the title the person holds with a company.

25.5

Get Relational Path (GetRelationalPath_1)

The GetRelationalPath_1 request retrieves details about relational path between two specified Person IDs. The following example requests data for PersonID="3" and PersonID="2": XML Sample Request - Retrieving Relational Path Information
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/02/04/P eopleS earch_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/02/04/w ebserv ices/rkd/P eopleS earch_1/ G etRelationalP ath_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etRelationalP ath_Request_1 xmlns="http://w w w .reuters.com/ns/2009/02/04/w ebserv ices/rkd/P eopleS earch_1" P er son1 ID="3" P er son2 ID="2"></G etRelationalP ath_Request_1> </Body > </E nv elope>

The request can take the following attributes: Attribute Person1 ID Person2 ID Description Unique person ID (mandatory). Unique person ID (mandatory).

532

TRKD API Developer's Guide

Show Num Paths Transaction ID Language

Include Inactive Affiliations

Defines number of paths to be displayed in the response (optional). Default value is '10'. Transaction ID (optional). The language used for people search (optional). Can have the following values: en-US (default) ja-JP zh-JHS Allows you to add exclusions (optional). Default value is '1'.

The response returns the following information for the specified Person IDs: XML Sample Response - Retrieving Relational Path Information
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/02/04/w ebserv ices/rkd/P eopleS earch_1/G etRelationalP ath_1_Reply </ a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-02-12T14:04:32.1894661Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etRelationalP ath_Response_1 xmlns="http://w w w .reuters.com/ns/2009/02/04/w ebserv ices/rkd/P eopleS earch_1"> <RequestA rguments P erson1ID="3" P erson2ID="2"></RequestA rguments> <RelationalP ath TotalC onnections="1" Display edC onnections="1" P erson1ID="3" P erson2ID="2"> <C onnection S trength="1" Depth="1"> <Relationship O rder="1"> <P erson ID="3" A ctiv e="false"> <LastM odified Date="2005-11-12T08:26:54.113"></LastM odified> <N ame> <Info Ty pe="LastN ame">S av itz</Info> <Info Ty pe="F irstN ame">Richard</Info> <Info Ty pe="M iddleInitial">J</Info> <Info Ty pe="A ge">53</Info> <Info Ty pe="S ex">M </Info> </N ame> <P ositionInformation> <O fficer ID="3" A ctiv e="false"> <Titles> <Designation> <S tart Year="1999"></S tart> <E nd Year="2000" M onth="8"></E nd> <LongTitle>C hief F inancial O fficer, S enior V ice P resident, S ecretary </LongTitle> </Designation> </Titles> </O fficer> </P ositionInformation> </P erson> <P erson ID="2" A ctiv e="false"> <LastM odified Date="2007-02-22T07:37:59.997"></LastM odified> <N ame> <Info Ty pe="LastN ame">Dickenson</Info> <Info Ty pe="F irstN ame">J.</Info> <Info Ty pe="M iddleInitial">T</Info> <Info Ty pe="A ge">70</Info> <Info Ty pe="S ex">M </Info> </N ame> <P ositionInformation> <O fficer ID="2" A ctiv e="false"> <Titles> <Designation> <S tart Year="1999" M onth="4"></S tart> <E nd Year="2000" M onth="8"></E nd> <LongTitle>P resident, C hief E xecutiv e O fficer, Director</LongTitle> </Designation> </Titles> </O fficer> </P ositionInformation> </P erson>

People Search

533

<C ompany RepN o="48680" N ame="Justin Industries, Inc." A ctiv e="false"></C ompany > </Relationship> </C onnection> </RelationalP ath> </G etRelationalP ath_Response_1> </Body > </E nv elope>

The table below gives details on elements returned by the response: Attribute Description

Relational Shows details about the relational path between the two specified Person IDs. Includes the following Path elements: TotalConnections - total number of connections between the specified Person IDs. DisplayedConnections - number of displayed connections. Connection Provides details about each displayed connection between the specified person IDs. Includes: Strength Depth Person Contains information pertaining to the person's ID, name, age and sex. PositionInf Contains unique Officer ID and details the various titles a person has held with a company, over time. ormation Officer ID - Unique Officer ID. This ID does not change, and is not re-used. While an Officer ID indicates a unique person within a company, the same person will be assigned a different Officer ID in the context of a different company. In addition to Officer ID, the Person ID will be presented as a separate element and will enable identification of the relationship between the individual and companies. Active - indicates whether an officer and/or director is active ('true') or inactive ('false'). Designation - Each Designation has a Start date, may have an End date, has a Long Title as reported by the company, and up to four titles. Thus, a company may report a persons most recent title as Chairman of the Board and Chief Executive Officer. This will appear as the Long Title. The person will also be tagged with two title IDs: CHM =Chairman and CEO = Chief Executive Officer. If available, this title will also have a Start date. However, as the most current title, this will not have an End date. If this person was previously a VP of the company, then there will be another Designation record in the file. This could have a Long Title of Vice President and a title ID VP=Vice President. As this is not the most current title, this designation will have an End date. Company Contains company information. Includes the following fields: RepNo - Report Number that represents the U.S GAAP filing associated to the Reuters Issue ADR ID. Name - company name. Active - is company active or not.

25.6

Get Search (GetSearch_1)

The GetSearch_1 request can be used to search for a personal profile in a company. The following example requests information for PersonID="3": XML Sample Request - Making a Search
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/02/04/P eopleS earch_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/02/04/w ebserv ices/rkd/P eopleS earch_1/ G etS earch_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > G etS earch_Request_1 xmlns="http://w w w .reuters.com/ns/2009/02/04/w ebserv ices/rkd/P eopleS earch_1" P er sonID="3"></ G etS earch_Request_1>

534

TRKD API Developer's Guide

</Body > </E nv elope>

When searching for a personal profile you can use the following attributes: Attribute Person ID Last Name First Name Preferred Name Transaction ID Language Description Unique person ID. Enables search by person's last name. Enables search by person's first name. Enables search by person's preferred name. Enables search by transaction ID. The language used for people search (optional). Can have the following values: en-US (default) ja-JP zh-JHS

Allow Partial Last Name Enables partial search by part of person's last name. Default value is '0'. Allow Partial First Name Enables partial search by part of person's first name. Default value is '0'. Allow Partial Preferred Name Include Inactive Affiliations Enables partial search by part of person's preferred name. Default value is '0'. Includes inactive affiliations. Default value is '1'.

The response returns the following information for the specified Person IDs: XML Sample Response - Making a Search
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/02/04/w ebserv ices/rkd/P eopleS earch_1/G etS earch_1_Reply </a: A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-02-12T14:04:32.1894661Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etS earch_Response_1 xmlns="http://w w w .reuters.com/ns/2009/02/04/w ebserv ices/rkd/P eopleS earch_1"> <RequestA rguments P ersonID="3" A llow P artialLastN ame="false" A llow P artialF irstN ame="false" A llow P artialP referredN ame="false" IncludeInactiv eA ffiliations="true" lang="en-U S "></RequestA rguments> <P eople> <P ersonID>3</P ersonID> <P ersonA ctiv eS tatus>false</P ersonA ctiv eS tatus> <LastN ame>S av itz</LastN ame> <F irstN ame>Richard</F irstN ame> <M iddleInitial>J</M iddleInitial> <S ex>M </S ex> <A ge>53</A ge> <RepN o>48680</RepN o> <C ompany N ame>Justin Industries, Inc.</C ompany N ame> <O fficerID>3</O fficerID> <O fficerA ctiv eS tatus>false</O fficerA ctiv eS tatus> <Title>C hief F inancial O fficer, S enior V ice P resident, S ecretary </Title> </P eople> </G etS earch_Response_1> </Body > </E nv elope>

The table below gives details on elements returned by the response: Attribute PersonID Description Unique person identifier.

People Search

535

PersonActive Status LastName FirstName MiddleInitial Sex Age RepNo CompanyNa me OfficerID OfficerActive Status Title

Indicates whether an individual (person) is active ('true') or inactive ('false') and is derived from Officer Status and Company Status. Person's last name. Person's first name. Person's middle initial. Person's sex. Person's age. Report Number that represents the U.S GAAP filing associated to the Reuters Issue ADR ID. Company name. Unique Officer ID within a company. Indicates whether an officer or director is 'true' (active) or 'false' (inactive). Contains the title the person holds with a company.

536

TRKD API Developer's Guide

chapter 26

Permissioning

The Permissioning service can be used to add or update permission and membership information for users and user groups.

26.1

Authentication/Authorization, Service Endpoint, and Required Headers

Authorization All requests to the Thomson Reuters Permissioning service require an authorization token. For details, see section Understanding Authentication Tokens. Authentication Thomson Reuters Permissioning service uses Reuters impersonation tokens for each effective user. In this case, Thomson Reuters must create each user before your application authenticates them. Unmanaged effective users are not supported in Reuters Permissioning. For additional information on creating a Service Token, see section Creating a Token. Service Endpoint Permissioning Endpoint
http://api.rkd.reuters.com/api/2008/08/08/P ermissioning_1.sv c

Required Header Required HTTP Headers

P O S T api/2008/08/08/P ermissioning_1.sv c H TTP /1.1 C ontent-Ty pe: application/soap+xml H ost: api.rkd.reuters.com C ontent-Length: [length]

26.2

WSDL
WSDL:
http://api.rkd.reuters.com/schemas/w sdl/P ermissioning_1_H ttpA ndRKDToken.w sdl

26.3

Set Permissioning Groups Membership (SetPermGroupsMembership_1)

You can use the SetPermGroupsMembership_1 request to set membership information of users in a particular global user group. In case when members already exist, the membership information is updated. To set membership information you have to specify either user alias OR User ID and Company ID. Also, you need to enter specify Permissioning Group Identity. Note: All users must be assigned permissions in order to access underlying content/functionality. Once a user is created with the Create_1 request, the SetPermGroupsMembership_1 request must be called to assign the new user to the specific permissions as an effective user in TRKD API. The following example sets the membership information for a user with alias 'beth@ztest.com'.

Permissioning

537

XML Sample Request - Setting Permissioning Groups Membership

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2008/08/08/P ermissioning_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/P ermissioning_1</ A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <S etP ermG roupsM embership_Request_1 xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/P ermissioning_1"> <permG roupM embership> <identity xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/RightsO w nerships_1"> <user> < alias xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/C ompany _1">beth@ztest.net</alias> </user> <per mGr oup> < ID xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/Rights_1">5658</ID> </permG roup> </identity > </permG roupM embership> </S etP ermG roupsM embership_Request_1> </Body > </E nv elope>

The response returns the following information: XML Sample Response - Setting Permissioning Groups Membership
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/ rkd/P ermissioning_1/S etP ermG roupsM embership_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <S etP ermG roupsM embership_Response_1 xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/P ermissioning_1"/> </Body > </E nv elope>

Note: Keep in mind that once permission group membership is set, the permissions from that group do not come into effect immediately. They become effective in 4-5 hours depending on NY time (GMT -4/-5).

538

TRKD API Developer's Guide

chapter 27

Portfolio Tracker

The Portfolio Tracker Service lets you or your users create, maintain, view and analyze portfolios and their multi-currency instruments, using latest prices and FX rates from Thomson Reuters Knowledge Direct (TRKD). The portfolios are either hosted by TRKD, or provided by the user in XML format using Client Portfolio View. Unlike Thomson Reuters hosted portfolio, Client Portfolio View is only present in a view based on the information entered into the request and is not saved on Thomson Reuters servers. Note: For Thomson Reuters hosted portfolios, each portfolio may hold up to 75 instruments, and you may create up to 25 portfolios for each user ID.

27.1

Conflation
Thomson Reuters Knowledge Direct utilises a three second conflated feed as a source of its quotes data. This means that every three seconds the Thomson Reuters Knowledge Direct systems receive an update. This feed is used to supply data to TRKD delayed servers and provide real-time snap responses. Clients should be aware of this configuration aspect of the product in case there are differences in data highlighted when compared to alternate sources of the same data. Note: The conflation on data on Thomson Reuters Knowledge API is 3 seconds for non-trade data (bid/ask, etc.).

27.2

Two Methods of Working with Portfolios

There are two different ways of using portfolio tracking, and you may choose one or both of these methods: Thomson Reuters hosted Portfolios As above, each users portfolio details are hosted on the Thomson Reuters Knowledge Direct portfolio servers. In XML programmatic access, a complete set of operations is provided to let you create, calculate, display, amend and delete portfolios. The portfolio servers return data in XML format, giving you full flexibility in how your users access and view their portfolios, and how you integrate the portfolio tracker within your website. See section Working with a Portfolio for details. Client hosted Portfolios If your users' real portfolios are held on your own systems, you may send a portfolio within a single request to the TRKD portfolio server for pricing and calculation, without Thomson Reuters storing any portfolio details. Each request is submitted to the portfolio server as a list of instruments and quantities, with a name and base currency, and the portfolio values are returned in XML format, giving you full flexibility in how you use the calculated portfolios. Here TRKD API is acting as a pricing engine, calculating instrument and portfolio values using the latest available prices and FX rates. See section Client Portfolio View for details.

27.3

Authentication/Authorization, Service Endpoint, and Required Headers

Authorization All requests to the Portfolio Tracker web service require an authorization token. For details, see section Understanding Authentication Tokens. Authentication In most implementations, Portfolio Tracker uses unmanaged impersonation tokens for each effective user. In this case, it is up to your application to supply (and otherwise manage) a unique identifier for each user; Thomson Reuters does not manage the user identities. Portfolio Tracker also supports Reuters impersonation tokens for each effective user. In this case, Thomson Reuters must create each user before your application authenticates them.

Portfolio Tracker

539

For additional information on Service Token creation see section Creating a Token in the Authentication and Authorization chapter. Service Endpoint Portfolio Tracker Endpoint
http://api.rkd.reuters.com/api/2006/05/01/P ortfolioTracker_1.sv c

Required Header Required HTTP Headers

P O S T api/2006/05/01/P ortfolioTracker_1.sv c H TTP /1.1 C ontent-Ty pe: application/soap+xml H ost: api.rkd.reuters.com C ontent-Length: [length]

27.4

WSDL
WSDL:
http://api.rkd.reuters.com/schemas/w sdl/P ortfolioTracker_1_H ttpA ndRKDToken.w sdl

27.5

Instrument Coverage
For Thomson Reuters hosted portfolios, each portfolio may hold up to 75 instruments, and you may create up to 25 portfolios for each user ID. A portfolio may contain any of the following types of instrument, for instruments that are already included within your profile: exchange-traded stocks ( ex ample: RIC MSFT.O) indices ( ex ample: RIC .DJI) exchange warrants ( ex ample: RIC CH1031161.S) exchange bonds ( ex ample: RIC CH1037959=S) bonds ( ex ample: RIC US30YT=RR) exchange funds ( ex ample: RIC SWBZ.S) foreign exchange ( ex ample: RIC CHF=X) You can include indices and FX in a portfolio but Portfolio Tracker excludes them from the portfolio calculations because a user cannot own an index or foreign exchange. Note that the instruments you send to the Portfolio Tracker service for real portfolios hosted on your systems should be valid RICs. A portfolio that contains a non-existent RIC may be processed less quickly.

27.6

Cash holding
The portfolio tracker does not store historical buy and sell records, and thus the portfolio calculations are based on unrealized profits of the instruments currently in the portfolio. However a cash holding lets the user simulate the value of the portfolio over time. The user may choose to have a cash holding with each portfolio, and assign an initial cash value when the portfolio is created. Whenever the user buys a stock, the buy value is deducted from the cash holding. Whenever the user sells a stock, the sale value is added to the cash holding. In addition, the user may adjust the cash based on fees (either fixed or percentage) with each buy and sell. Users can buy the same instrument several times at different buy prices. This may be represented either by an update to the existing instrument, or by adding a second instance of the same instrument in the portfolio.

540

TRKD API Developer's Guide

27.7

Portfolio fields and calculations

The portfolio server uses specific fields to describe a portfolio and its instruments. All the fields are defined in this section. Some fields are provided by the user. Other fields are calculated by the portfolio server using specific formulae. RIC-level fields RIC-level fields apply to the individual instruments within the portfolio. Field Formula for calculated field RICName The RIC (Reuters Instrument Code) that identifies the instrument. N/A Sourced from Portfolio database. SecurityId A number between 1 and 75 that identifies the RIC within the portfolio. N/A Sourced from Portfolio database. InstrumentN The display name for the instrument. N/A Sourced from Portfolio ame database. Quantity The current number of units of the instrument in the portfolio. N/A Sourced from Portfolio database. Buyprc The average buy price for the instrument in its local trading currency. N/A Sourced from Portfolio For an instrument trading in Tokyo Stock exchange, if there are two purchases of database. Qty 2 and Qty 3 at 3000 and 3500 Yen respectively, the average price = (2 * 3000 + 3 * 3500 )/ 5 = 16500 /5 = 3,300 Yen. Ccybuy The average buy FX rate. N/A Sourced from Portfolio If the portfolio base currency is USD and the USD/JPY rates were 100 and 110 at database. the time of two purchases given above, then average buy FX rate = 16500 / (6000/100 + 10500/110) = 16500 / (60 + 95.45) = 16500 / 155.45 = 106.14. Note: Similarly to Ccynow this should accommodate denomination and reverse currencies. See details in Notes On FX Conversion. Prcnow The current price of the instrument in its local trading currency. TRDPRC_1 (unless this value is blank in which case = HST_CLOSE). Valnow The current value of the instrument in its local trading currency. In this current Instrument_Prcnow * example this would be 5 * 4000 = 20,000 Yen Instrument_Quantity. Ccynow The current FX rate between the instruments local trading currency and the Denom_Rate / portfolio base currency. If the portfolios base currency is USD and the Conversion_Rate. instruments local trading currency is JPY, then this value will be say 110, i.e the current FX rate for USD/JPY. See details below in Notes On FX Conversion. CcynowNam The instruments local trading currency. N/A Sourced from Portfolio e database. Valccy The current value of the instrument in the portfolio base currency. In this Instrument_Prcnow / current example, this would be 20,000 / 110 = 181.81. Instrument_Ccynow. Netccy The net change of the instruments value in the portfolio base currency, Instrument_Valccy compared to its buy value. Considering the example used in above items, the net (Instrument_Quantity * change will be = USD 181.81 (5 * 3300 / 106.14) = USD 181.81 155.45 = Instrument_Buyprc / USD 26.36. Instrument_Ccybuy). Pctccy The percent change of the instruments value in the portfolio base currency, ( Instrument_Netccy / compared to its buy value. (Instrument_Valccy Percentage change = ((181.81 / (181.81 26.36)) 1)*100 = 17% Instrument_Netccy) ) * approximately. 100. NetDay The net change of the instruments value in base currency on the current day. Quantity * (Instrument_Netchg / Instrument_Ccynow). Weight The percentage of the portfolio that is held in the instrument. Instrument_valccy / Portfolio_valccy. Display_Nam The instruments display name. DSPLY_NAME from SDS Description

Portfolio Tracker

541

e Currency

The instruments local trading currency. This is identical to Ccynow name.

quote request. N/A Sourced from Portfolio database. Originally sourced from field CURRENCY from SDS quote request. TRD_PRC1 from SDS quote request.

Last NetChg_1 PctChg_1 Bid Ask ACVol_1 PERatio Yield Earnings Dividend DivPayDate ExDivDate

The instruments last price. The instruments net change today. The instruments percent change today. The instruments best bid. The instruments best ask. The instruments todays volume. The instruments PE ratio. The instruments dividend yield. The instruments earnings per share. The instruments dividend per share. The instruments dividend pay date. The instruments ex-dividend date.

Portfolio-level fields Portfolio-level fields apply to the whole portfolio. Some fields are calculated by aggregating RIC-level fields across all the instruments in the portfolio. Field Description Formula for calculated field N/A Sourced from Portfolio database.

PortfolioNam The portfolios name, chosen by the user. For a given User ID, each portfolio e name must be different. CurrencyNa me Valccy Netccy Pctccy

The portfolios base currency, chosen by the user when creating the portfolio. All N/A Sourced from Portfolio instruments prices are converted into this base currency for the portfolio-level database. calculations. Default currency is USD. The current value of the portfolio in base currency. The net change for the portfolio in base currency. The percentage change for the portfolio in base currency. ? (Instrument_Valccy) + Portfolio_Cash. ? (Instrument_Netccy). ( Portfolio_Netccy / (Portfolio_Valccy Portfolio_Netccy Portfolio_Cash) ) * 100. ? (Instrument_Netday). ( Portfolio_Netday/ (Portfolio_Valccy Portfolio_Netday Portfolio_Cash) ) * 100. ? (Instrument_Weight) + Cash_Weight. N/A Sourced from Portfolio database.

Netday Pctday

The net change for the portfolio in base currency on the current day. The percentage change for the portfolio in base currency on the current day.

Weight

The total weight of the portfolio.

CashBalance The current value of the cash holding in base currency. This is optional, if the user requested a cash holding when creating the portfolio. This is updated automatically by the portfolio server whenever the user buys or sells instruments in the portfolio, or if the user manually edits the cash holding. CashWeight The percentage of the portfolio that is held in cash, if the cash is positive.

If Cash > 0 then Cash_Weight = Portfolio_Cash/ Portfolio_Valccy.

542

TRKD API Developer's Guide

27.8

Working with a Portfolio

Each users portfolio details are hosted on the Thomson Reuters server. The portfolio is effectively a model or simulation portfolio. The user can buy or sell shares within this simulation portfolio, but without making any real buy or sell transactions. Whenever the user simulates a buy or sell, portfolio server automatically re-calculates the relevant portfolio values. In XML programmatic access, a complete set of functions is provided to let you create, calculate, display, amend and delete portfolios. The portfolio servers return data in XML format, giving you full flexibility in how your users access and view their portfolios, and how you integrate the portfolio tracker within your website.

27.8.1 Creating a Portfolio (CreatePortfolio_Request_1)

Each user is able to create and maintain up to 25 portfolios. The following example shows the XML Request for profile creation and its format. XSD
XSD: http://api.rkd.reuters.com/schemas/P ortfolioTracker_1.xsd

The following example creates a portfolio with name "ZXCVB" and a cash balance of $1000. XML Sample Request - Creating a Portfolio
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/P ortfolioTracker_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/P ortfolioTracker_1/ C reateP ortfolio_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <C reateP ortfolio_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/P ortfolioTracker_1"> <P ortfolioN ame>ZXC V B</P ortfolioN ame> <C ashBalance>1000</C ashBalance> <Description>Description Text</Description> </C reateP ortfolio_Request_1> </Body > </E nv elope>

Attribute PortfolioName Currency CashBalance

Description Name given to the portfolio. Currency type being used in this portfolio. Cash balance of the portfolio. Note: The maximum allowed decimal that is supported by the Portfolio Tracker service is one digit less precise than CLR decimal and is equal to 9,999,999,999,999,999,999,999,999,999. That precision is considered sufficient and no Portfolio Tracker service modifications are required.

Description

Optional text describing the Portfolio.

XML Sample Response -Creating a Portfolio

<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader> <a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" s:mustU nderstand="1" >http://w w w .reuters.com/ns/2006/05/01/ w ebserv ices/rkd/P ortfolioTracker_1/C reateP ortfolio_1_Reply </a:A ction> <a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</a:RelatesTo> </s:H eader> <s:Body >

Portfolio Tracker

543

<C reateP ortfolio_Response_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/P ortfolioTracker_1"> <P or tfolioId>1 0 0 </P or tfolioId> </C reateP ortfolio_Response_1> </Body > </E nv elope>

Attribute PortfolioID

Description Id of the created portfolio.

27.8.2 Get User Portfolios (GetUserPortfolios_Request_1)

XSD
XSD: http://api.rkd.reuters.com/schemas/P ortfolioTracker_1.xsd

The following example demonstrates how to retrieve the whole Profile list for a user. Note that the user information is included in the Authentication Token eliminating the need to enter it in the request (see section Creating a Service Token for more information). XML Sample Request - Get User Portfolios
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/P ortfolioTracker_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/P ortfolioTracker_1/ G etU serP ortfolios_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <GetUser P or tfolios_Request_1 xmlns="http://www.r euter s.com/ns/2 0 0 6 /0 5 /0 1 /webser vices/r kd/ P or tfolioT r acker _1 " /> </Body > </E nv elope>

XML Sample Response - Get User Portfolios

<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader> <a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" s:mustU nderstand="1" >http://w w w .reuters.com/ns/2006/05/01/ w ebserv ices/rkd/P ortfolioTracker_1/G etU serP ortfolios_1_Reply </a:A ction> <a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essage ID]</a:RelatesTo> </s:H eader> <s:Body > <G etU serP ortfolios_Response_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/P ortfolioTracker_1"> <P or tfolioId>1 0 0 </P or tfolioId> </G etU serP ortfolios_Response_1> </Body > </E nv elope>

Attribute PortfolioID

Description Id of the created portfolio.

544

TRKD API Developer's Guide

27.8.3 Editing a Portfolio (EditPortfolio_Request_1)

This operation lets you edit the portfolios name, the cash value and select a View. Portfolio Tracker uses the view you selected to format the immediate reply and Portfolio Tracker does not save the view. You must not change the portfolios base currency. XSD
XSD: http://api.rkd.reuters.com/schemas/P ortfolioTracker_1.xsd

The following sample demonstrates how to edit a profile by changing its name from ZXCVB to Portfolio1. XML Sample Request - Editing a Portfolio
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/P ortfolioTracker_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/P ortfolioTracker_1/ E ditP ortfolio_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <E ditP ortfolio_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/P ortfolioTracker_1"> <P ortfolioId>100</P ortfolioId> <C urrency >G BP </C urrency > <N ew N ame> P ortfolio1</N ew N ame> <Description>Description Text </Description> </E ditP ortfolio_Request_1> </Body > </E nv elope>

Attribute PortfolioID Currency NewName CashBalance

Description Id of the portfolio that the change applies to. Currency type used in this portfolio. Profile name that will replace the current profile name. Cash balance of the portfolio. Note: The maximum allowed decimal that is supported by the Portfolio Tracker service is one digit less precise than CLR decimal and is equal to 9,999,999,999,999,999,999,999,999,999. That precision is considered sufficient and no Portfolio Tracker service modifications are required.

View

Indicates how the return information should be formatted and what fields should be returned. By default the view is Summary. Other available views are: PL Position Prices Valuation Optional text describing the Portfolio.

Description

XML Sample Response - Editing a Portfolio

<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader> <a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" s:mustU nderstand="1" >http://w w w .reuters.com/ns/2006/05/01/ w ebserv ices/rkd/P ortfolioTracker_1/E ditP ortfolio_1_Reply </a:A ction> <a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <E ditP ortfolio_Response_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/P ortfolioTracker_1">

Portfolio Tracker

545

<P ortfolio xsi:ty pe="P ortfolioS ummary V iew " > <P ortfolioN ame>P ortfolio1</P ortfolioN ame> <C urrency N ame>G BP </C urrency N ame> <V alccy >509.55414</V alccy > <N etccy >0</N etccy > <P ctccy >0</P ctccy > <C ashBalance>509.55414</C ashBalance> <Description>Description Text</Description> <N etday >0</N etday > <P ctday >0</P ctday > </P ortfolio> </E ditP ortfolio_Response_1> </Body > </E nv elope>

Attribute Type PortfolioName CurrencyName Valccy Netccy Pctccy CashBalance Description Netday Pctday

Description Indicates the view type selected on the request. Assigned name of the portfolio. Currency type used in the portfolio. The current value of the portfolio in base currency. The net change for the portfolio in base currency. The percentage change for the portfolio in base currency. The current value of the cash holding in base currency. Optional text describing the Portfolio. The net change for the portfolio in base currency on the current day. The percentage change for the portfolio in base currency on the current day.

27.8.4 Deleting a Portfolio (DeletePortfolio_Request_1)

This operation lets you delete a portfolio along with any Instruments that the portfolio might have. XSD
XSD: http://api.rkd.reuters.com/schemas/P ortfolioTracker_1.xsd

XML Sample Request - Delete Portfolio

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/P ortfolioTracker_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/P ortfolioTracker_1/ DeleteP ortfolio_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <DeleteP ortfolio_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/P ortfolioTracker_1"> <P or tfolioId>1 0 0 </P or tfolioId> </DeleteP ortfolio_Request_1> </Body > </E nv elope>

Attribute PortfolioID

Description Id of the portfolio that should be deleted.

546

TRKD API Developer's Guide

XML Sample Response - Delete Portfolio

<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader> <a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" s:mustU nderstand="1" >http://w w w .reuters.com/ns/2006/05/01/ w ebserv ices/rkd/P ortfolioTracker_1/DeleteP ortfolio_1_Reply </a:A ction> <a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <DeleteP ortfolio_Response_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/P ortfolioTracker_1"> <P ortfolioId>100</P ortfolioId> </DeleteP ortfolio_Response_1> </Body > </E nv elope>

27.9

Working with Instruments

Once you create a portfolio you can fill it with instruments. The following sections describe how to work with instruments by using operations to add, buy, sell, edit and remove them.

27.9.1 Add Instruments (AddInstruments_Request_1)

This operation lets you add new instruments to a portfolio. The cash holding may be automatically adjusted. Only use AddInstruments_Request_1 to add details of instruments that are not already held in the portfolio. Note: Use the BUY Instruments operation to buy more of an existing instrument. XSD
XSD: http://api.rkd.reuters.com/schemas/P ortfolioTracker_1.xsd

XML Sample Request - Add Instruments

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/P ortfolioTracker_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/P ortfolioTracker_1/ A ddInstruments_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <A ddInstruments_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/P ortfolioTracker_1"> <P ortfolioId>2</P ortfolioId> <V iew >P osition</V iew > <Instruments> <A ddInstrumentData> <RIC Id>V O D.L</RIC Id> <Display N ame>V O D</Display N ame> <P ersonalC omments>C omment</P ersonalC omments> <Q uantity >1000</Q uantity > <Buy P rice>5</Buy P rice> <A djustC ash>true</A djustC ash> <F ixedS um>0</F ixedS um> </A ddInstrumentData> </Instruments>

Portfolio Tracker

547

</A ddInstruments_Request_1> </Body > </E nv elope>

Attribute Portfolioid View

Description Id of the portfolio that should be deleted. Indicates how the response should be formatted and what fields will be returned. By default the View is Summary. See section Retrieving Portfolio Views for a full Views listing and information they provide. Contains information on a single or multiple instruments to be added to a Profile: Contains the following Attribute(s): RICId: The RIC (Reuters Instrument Code) that identifies the instrument. DisplayName: The display name for the instrument. PersonalComments: A comment regarding this instrument. Quantity: The current number of units of the instrument in the portfolio. BuyPrice: Price per unit of the instrument being bought. AdjustCash: Determines whether to deduct the added value from the cash holding of the portfolio. FixedSum: The amount to be adjusted if AdjustCash is set to True.

AddInstrumentData

XML Sample Response - Add Instruments

<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader> <a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" s:mustU nderstand="1">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/ P ortfolioTracker_1/A ddInstruments_1_Reply </a:A ction> <a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <A ddInstruments_Response_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/P ortfolioTracker_1"> <P ortfolio xsi:ty pe="P ortfolioS ummary V iew " > <P ortfolioN ame>ZXC V B</P ortfolioN ame> <C urrency N ame>G BP </C urrency N ame> <V alccy >3639.56</V alccy > <N etccy >2639.80</N etccy > <P ctccy >5279.6</P ctccy > <C ashBalance>949.76</C ashBalance> <Description>Description Text</Description> <N etday >-40.00</N etday > <P ctday >-1.46530879</P ctday > <Instrument> <RIC N ame>V O D.L</RIC N ame> <S ecurity Id>1</S ecurity Id> <InstrumentN ame>V O DA F O N E G RO U P </InstrumentN ame> <P ersonalC omments>C omment</P ersonalC omments> <Q uantity >1000</Q uantity > <P rcnow >134.49</P rcnow > <V alnow >134490.00</V alnow > <C cy now >100</C cy now > <C cy now N ame>G Bp</C cy now N ame> <V alccy >1344.90</V alccy > <N etccy >1344.90</N etccy > <P ctccy >0</P ctccy > </Instrument> <Instrument> <RIC N ame>V O D.L</RIC N ame> <S ecurity Id>15</S ecurity Id> <InstrumentN ame>V O D</InstrumentN ame> <P ersonalC omments>C omment</P ersonalC omments> <Q uantity >1000</Q uantity > <P rcnow >134.49</P rcnow > <V alnow >134490.00</V alnow > <C cy now >100</C cy now > <C cy now N ame>G Bp</C cy now N ame> <V alccy >1344.90</V alccy >

548

TRKD API Developer's Guide

<N etccy >1294.90</N etccy > <P ctccy >2589.8</P ctccy > </Instrument> </P ortfolio> </A ddInstruments_Response_1> </Body > </E nv elope>

The information returned shows the View selected in the request. It contains profile information and along with all the instruments previously and currently added. For more information on a full list of Views and what each contains see chapter Retrieving Portfolio Views.

27.9.2 Buy Instruments (BuyInstruments_Request_1)

This operation lets you buy more of existing instruments at a different buy price and buy FX rate. The cash holding may be automatically adjusted. Note : If you want to buy more of an existing instrument by creating a new item (and not adding to the existing item), use the ADD Instruments operation (AddInstrument_Request_1). XSD
XSD: http://api.rkd.reuters.com/schemas/P ortfolioTracker_1.xsd

XML Sample Request - Buy Instruments

<H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/P ortfolioTracker_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/P ortfolioTracker_1/ Buy Instruments_1</A ction><A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <Buy Instruments_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/P ortfolioTracker_1"> <P ortfolioId>2</P ortfolioId> <Instruments> <Buy InstrumentData> <S ecurity Id>1</S ecurity Id> <Display N ame>V O D</Display N ame> <P ersonalC omments>C omment</P ersonalC omments> <Q uantity >12</Q uantity > <Buy P rice>2</Buy P rice> <A djustC ash>true</A djustC ash> <F ixedS um>0</F ixedS um> </Buy InstrumentData> </Instruments> </Buy Instruments_Request_1> </Body > </E nv elope>

Attribute Portfolioid View

Description Id of the portfolio. Indicates how the response should be formatted and what fields will be returned. By default the View is Summary. See section Retrieving Portfolio Views for a full Views listing and information they provide. BuyInstrumentDa Contains information on a single or multiple instruments to be added to a Profile. ta Contains the following Attribute(s): SecurityId: A number between 1 and 75 that identifies the RIC within the portfolio. DisplayName: The display name for the instrument. PersonalComments: A comment regarding this instrument.

Portfolio Tracker

549

Quantity: The current number of units of the instrument that should be added. BuyPrice: Price per unit of the instrument being bought. AdjustCash: Determines whether to deduct the buy value from the cash holding of the portfolio. FixedSum: The amount to be adjusted if AdjustCash is set to True.

XML Sample Response - Buy Instruments

<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader> <a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" s:mustU nderstand="1">http://w w w .reuters.com/ns/2006/05/01/ w ebserv ices/rkd/P ortfolioTracker_1/Buy Instruments_1_Reply </a:A ction> <a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <Buy Instruments_Response_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/P ortfolioTracker_1"> <P ortfolio xsi:ty pe="P ortfolioS ummary V iew " > <P ortfolioN ame>ZXC V B</P ortfolioN ame> <C urrency N ame>G BP </C urrency N ame> <V alccy >3655.4588</V alccy > <N etccy >2655.698956</N etccy > <P ctccy >5286.0415</P ctccy > <C ashBalance>949.52</C ashBalance> <Description>Description Text</Description> <N etday >-40.24</N etday > <P ctday >-1.46530879</P ctday > <Instrument> <RIC N ame>V O D.L</RIC N ame> <S ecurity Id>1</S ecurity Id> <InstrumentN ame>V O DA F O N E G RO U P </InstrumentN ame> <P ersonalC omments>C omment</P ersonalC omments> <Q uantity >1012</Q uantity > <P rcnow >134.49</P rcnow > <V alnow >136103.88</V alnow > <C cy now >100</C cy now > <C cy now N ame>G Bp</C cy now N ame> <V alccy >1361.0388</V alccy > <N etccy >1360.798956</N etccy > <P ctccy >567368.4</P ctccy > </Instrument> <Instrument> <RIC N ame>V O D.L</RIC N ame> <S ecurity Id>15</S ecurity Id> <InstrumentN ame>V O D</InstrumentN ame> <P ersonalC omments>C omment</P ersonalC omments> <Q uantity >1000</Q uantity > <P rcnow >134.49</P rcnow > <V alnow >134490.00</V alnow > <C cy now >100</C cy now > <C cy now N ame>G Bp</C cy now N ame> <V alccy >1344.90</V alccy > <N etccy >1294.90</N etccy > <P ctccy >2589.8</P ctccy > </Instrument> </P ortfolio> </Buy Instruments_Response_1> </Body > </E nv elope>

The information returned shows the View selected in the request. It contains profile information and along with all the instruments previously and currently added. For more information on a full list of Views and what each contains, see section Retrieving Portfolio Views.

27.9.3 Sell Instruments (SellInstruments_Request_1)

This operation lets you sell either part or all of existing instruments in the portfolio. The cash holding may be automatically adjusted with the sale value.

550

TRKD API Developer's Guide

Note: If you want to completely delete an instrument, use the REMOVE Instrument operation (RemoveInstruments_Request_1). XSD
XSD: http://api.rkd.reuters.com/schemas/P ortfolioTracker_1.xsd

XML Sample Request - Sell Instruments

<H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/P ortfolioTracker_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/P ortfolioTracker_1/ S ellInstruments_1</A ction> xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <S ellInstruments_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/P ortfolioTracker_1"> <P ortfolioId>2</P ortfolioId> <V iew >P rices</V iew > <Instruments> <S ellInstrumentData> <S ecurity Id>1</S ecurity Id> <Display N ame>V O D</Display N ame> <P ersonalC omments>C omment</P ersonalC omments> <Q uantity >10</Q uantity > <S ellP rice>5</S ellP rice> <A djustC ash>true</A djustC ash> <F ixedS um>0</F ixedS um> </S ellInstrumentData> </Instruments> </S ellInstruments_Request_1> </Body > </E nv elope>

Attribute Portfolioid View

Description Id of the portfolio. Indicates how the response should be formatted and what fields will be returned. By default the View is Summary. See section Retrieving Portfolio Views for a full Views listing and information they provide.

SellInstrumentD Contains information on a single Instrument or multiple instruments being sold. ata Contains the following Attribute(s): SecurityId: A number between 1 and 75 that identifies the RIC within the portfolio. DisplayName: The display name for the instrument. PersonalComments: A comment regarding this instrument. Quantity: The current number of units of the instrument that should be added. SellPrice: Per unit price of the instrument being sold. AdjustCash: Determines whether to add the sell value to the cash holding of the portfolio. FixedSum: The sum to be adjusted if AdjustCash is set to True. XML Sample Response - Sell Instruments
<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader> <a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" s:mustU nderstand="1">http://w w w .reuters.com/ns/2006/05/01/ w ebserv ices/rkd/P ortfolioTracker_1/S ellInstruments_1_Reply </a:A ction> <a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <S ellInstruments_Response_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/P ortfolioTracker_1"> <P ortfolio xsi:ty pe="P ortfolioP ricesV iew " > <P ortfolioN ame>ZXC V B</P ortfolioN ame> <C urrency N ame>G BP </C urrency N ame>

Portfolio Tracker

551

<V alccy >3642.5098</V alccy > <N etccy >2642.252326</N etccy > <P ctccy >5259.52441</P ctccy > <C ashBalance>950.02</C ashBalance> <Description>Description Text</Description> <N etday >-40.04</N etday > <P ctday >-1.46530879</P ctday > <Instrument> <RIC N ame>V O D.L</RIC N ame> <S ecurity Id>1</S ecurity Id> <InstrumentN ame>V O DA F O N E G RO U P </InstrumentN ame> <P ersonalC omments>C omment</P ersonalC omments> <C urrency >G Bp</C urrency > <Last>134.49</Last> <N etC hg_1>-2</N etC hg_1> <P ctC hg_1>-1.49</P ctC hg_1> <Bid>132.5</Bid> <A sk>133</A sk> <A C V ol_1>313579550</A C V ol_1> </Instrument> <Instrument> <RIC N ame>V O D.L</RIC N ame> <S ecurity Id>15</S ecurity Id> <InstrumentN ame>V O D</InstrumentN ame> <P ersonalC omments>C omment</P ersonalC omments> <C urrency >G Bp</C urrency > <Last>134.49</Last> <N etC hg_1>-2</N etC hg_1> <P ctC hg_1>-1.49</P ctC hg_1> <Bid>132.5</Bid> <A sk>133</A sk> <A C V ol_1>313579550</A C V ol_1> </Instrument> </P ortfolio> </S ellInstruments_Response_1> </Body > </E nv elope>

The information returned shows the View selected in the request. It contains profile information and along with all the instruments previously and currently added. For more information on a full list of Views and what each contains, see chapter Retrieving Portfolio Views.

27.9.4 Edit Instruments (EditInstruments_Request_1)

This operation lets you correct details of one or more instruments in a portfolio. You can use this operation if you need to adjust any values manually, for example, in the event of a stock split or a rights issue. You can also use this operation to correct any value that is incorrect. The cash holding is not updated. Note: For normal buying and selling of instruments within the portfolio, you should use the ADD Instrument, BUY Instrument and SELL Instrument functions. XSD
XSD: http://api.rkd.reuters.com/schemas/P ortfolioTracker_1.xsd

XML Sample Request - Edit Instruments

<H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/P ortfolioTracker_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/P ortfolioTracker_1/ E ditInstruments_1</A ction> xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body >

552

TRKD API Developer's Guide

<E ditInstruments_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/P ortfolioTracker_1"> <P ortfolioId>397</P ortfolioId> <Instruments> <E ditInstrumentData> <S ecurity Id>377</S ecurity Id> <Display N ame>V O D</Display N ame> <P ersonalC omments>C omment</P ersonalC omments> <Q uantity >100</Q uantity > <LocalP rice>10</LocalP rice> <BaseP rice>8</BaseP rice> </E ditInstrumentData> </Instruments> </E ditInstruments_Request_1> </Body > </E nv elope>

Attribute Portfolioid View

Description Id of the portfolio contains the Instruments. Indicates how the response should be formatted and what fields will be returned. By default the View is Summary. See Retrieving Portfolio Views for a full Views listing and information they provide.

EditInstrumentD The following information should be contained in each instrument being edited. ata Contains the following Attribute(s): SecurityId: A number between 1 and 75 that identifies the RIC within the portfolio. DisplayName: The display name for the instrument. PersonalComments: A comment regarding this instrument. Quantity: The number of units of the instrument. LocalPrice: Specifies the buy/sell price of the security in its local currency. BasePrice: Specifies the buy/sell price of the security in the portfolios base currency. XML Sample Response - Edit Instruments
<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader> <a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" s:mustU nderstand="1">http://w w w .reuters.com/ns/2006/05/01/ w ebserv ices/rkd/P ortfolioTracker_1/E ditInstruments_1_Reply </a:A ction> <a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <E ditInstruments_Response_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/P ortfolioTracker_1"> <P ortfolio xsi:ty pe="P ortfolioS ummary V iew " > <P ortfolioN ame>A A </P ortfolioN ame> <C urrency N ame>G BP </C urrency N ame> <V alccy >1036.25</V alccy > <N etccy >-663.75</N etccy > <P ctccy >-82.96875</P ctccy > <C ashBalance>900</C ashBalance> <Description>Description Text</Description> <N etday >-1.7500</N etday > <P ctday >-1.268116</P ctday > <Instrument> <RIC N ame>V O D.L</RIC N ame> <S ecurity Id>377</S ecurity Id> <InstrumentN ame>V O D</InstrumentN ame> <P ersonalC omments>C omment</P ersonalC omments> <Q uantity >100</Q uantity > <P rcnow >136.25</P rcnow > <V alnow >13625.00</V alnow > <C cy now >100</C cy now > <C cy now N ame>G Bp</C cy now N ame> <V alccy >136.25</V alccy > <N etccy >-663.75</N etccy > <P ctccy >-82.96875</P ctccy > </Instrument> </P ortfolio> </E ditInstruments_Response_1> </Body > </E nv elope>

Portfolio Tracker

553

The information returned shows the View selected in the request. It contains profile information and along with all the instruments previously and currently added. For more information on a full list of Views and what each contains, see section Retrieving Portfolio Views.

27.9.5 Remove Instruments (RemoveInstruments_Request_1)

This operation lets you completely delete specific instruments from the portfolio. The cash value is not changed. Note: For normal selling of an instrument, you should use the SELL Instrument operation. XSD
XSD: http://api.rkd.reuters.com/schemas/P ortfolioTracker_1.xsd

XML Sample Request - Remove Instrument

<H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/P ortfolioTracker_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/P ortfolioTracker_1/ Remov eInstruments_1</A ction> xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <Remov eInstruments_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/P ortfolioTracker_1"> <P ortfolioId>2</P ortfolioId> <Instruments> <Remov eInstrumentData> <S ecurity Id>15</S ecurity Id> </Remov eInstrumentData> </Instruments> </Remov eInstruments_Request_1> </Body > </E nv elope>

Attribute Portfolioid View

Description Id of the portfolio. Indicates how the response should be formatted and what fields will be returned. By default the View is Summary. See section Retrieving Portfolio Views for a full Views listing and information they provide.

RemoveInstrum Contains one or multiple SecurityIDs that will be removed. entData Contains the following Element(s): SecurityID: Contains a SecurityID of the instrument that should be removed. If there is more than one Instrument that should be removed then each should have its own SecurityID tag.

XML Sample Response - Remove Instrument

<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader> <a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" s:mustU nderstand="1">http://w w w .reuters.com/ns/2006/05/01/ w ebserv ices/rkd/P ortfolioTracker_1/Remov eInstruments_1_Reply </a:A ction> <a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <Remov eInstruments_Response_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/P ortfolioTracker_1"> <P ortfolio xsi:ty pe="P ortfolioS ummary V iew " > <P ortfolioN ame>ZXC V B</P ortfolioN ame> <C urrency N ame>G BP </C urrency N ame>

554

TRKD API Developer's Guide

<V alccy >2297.6098</V alccy > <N etccy >1347.352326</N etccy > <P ctccy >567368.4</P ctccy > <C ashBalance>950.02</C ashBalance> <P ersonalC omments>C omment</P ersonalC omments> <N etday >-20.04</N etday > <P ctday >-1.46530879</P ctday > <Instrument> <RIC N ame>V O D.L</RIC N ame> <S ecurity Id>1</S ecurity Id> <InstrumentN ame>V O DA F O N E G RO U P </InstrumentN ame> <P ersonalC omments>C omment</P ersonalC omments> <Q uantity >1002</Q uantity > <P rcnow >134.49</P rcnow > <V alnow >134758.98</V alnow > <C cy now >100</C cy now > <C cy now N ame>G Bp</C cy now N ame> <V alccy >1347.5898</V alccy > <N etccy >1347.352326</N etccy > <P ctccy >567368.4</P ctccy > </Instrument> </P ortfolio> </Remov eInstruments_Response_1> </Body > </E nv elope>

The information returned shows the View selected in the request. It contains profile information along with all the instruments previously and currently added. For more information on a full list of Views and what each contains see chapter Retrieving Portfolio Views.

27.10 Retrieving Portfolio Views

Portfolio Tracker provides views as an easy way to show information for Profile analysis. A portfolio may be analyzed in many ways. In XML, the GetView_1 method allows you to choose which particular view to display. The views are: Position View PL View Prices View Summary View Valuation View

27.10.1 Position View

Use Position View to see the current holdings within the portfolio. XSD
XSD: http://api.rkd.reuters.com/schemas/P ortfolioTracker_1.xsd

XML Sample Request - Position View

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/P ortfolioTracker_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/P ortfolioTracker_1/ G etV iew _1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader>

Portfolio Tracker

555

<Body > <G etV iew _Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/P ortfolioTracker_1"> <P ortfolioId>1335382</P ortfolioId> <V iew >P osition</V iew > </G etV iew _Request_1> </Body > </E nv elope>

Attribute PortfolioID View

Description Id of the portfolio to view. The type of the View.

XML Sample Response - Add Instruments

<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader> <a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" s:mustU nderstand="1">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/ P ortfolioTracker_1/G etV iew _1_Reply </a:A ction> <a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etV iew _Response_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/P ortfolioTracker_1"> <P ortfolio xsi:ty pe="P ortfolioP ositionV iew " xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"> <P ortfolioN ame>portfolio1</P ortfolioN ame> <C urrency N ame>U S D</C urrency N ame> <V alccy >1148.16</V alccy > <N etccy >148.160096</N etccy > <P ctccy >61758.08</P ctccy > <C ashBalance>999.76</C ashBalance> <N etday >-2.24</N etday > <P ctday >-1.4869889</P ctday > <C ashWeight>87.0749741</C ashWeight> <Weight>100</Weight> <Instrument> <RIC N ame>IBM .N </RIC N ame> <S ecurity Id>512975</S ecurity Id> <InstrumentN ame>IN TL BU S M A C H IN E </InstrumentN ame> <E xchange>N YS </E xchange> <Q uantity >112</Q uantity > <P rcnow >132.5</P rcnow > <V alnow >14840.0</V alnow > <C cy now >100</C cy now > <C cy now N ame>U S D</C cy now N ame> <V alccy >148.4</V alccy > <Weight>12.9250278</Weight> </Instrument> ... </P ortfolio> </G etV iew _Response_1> </Body > </E nv elope>

Attribute PortfolioName CurrencyName Valccy Netccy Pctccy CashBalance Netday Pctday Cashweight Weight

Description The portfolios name, chosen by the user. The portfolios base currency, chosen by the user when creating the portfolio. The current value of the portfolio in base currency. The net change for the portfolio in base currency. The percentage change for the portfolio in base currency. The current value of the cash holding in base currency. The net change for the portfolio in base currency on the current day. The percentage change for the portfolio in base currency on the current day. The percentage of the portfolio that is held in cash, if the cash is positive. The total weight of the portfolio.

556

TRKD API Developer's Guide

Instrument

Contains instrument information for the current View. Contains the following elements: RICname : The RIC (Reuters Instrument Code) that identifies the instrument. SecurityId: A number between 1 and 75 that identifies the RIC within the portfolio. InstrumentName : The display name for the instrument. Exchange: Name of the exchange where the instrument is traded. Quantity : The current number of units of the instrument in the portfolio. Prcnow: The current price of the instrument in its local trading currency. Valnow: The current value of the instrument in its local trading currency. Ccynow: The current FX rate between the instruments local trading currency and the portfolio base currency. CcynowName : The instruments local trading currency. Valccy : The current value of the instrument in the portfolio base currency. Weight : The percentage of the portfolio that is held in the instrument.

27.10.2 PL View
Use PL View (Profit and Loss) to analyze why a profit or loss has been made on each instrument in the portfolio. XSD
XSD: http://api.rkd.reuters.com/schemas/P ortfolioTracker_1.xsd

XML Sample Request - PL View

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/P ortfolioTracker_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/P ortfolioTracker_1/ G etV iew _1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etV iew _Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/P ortfolioTracker_1"> <P ortfolioId>1335382</P ortfolioId> <V iew >P L</V iew > </G etV iew _Request_1> </Body > </E nv elope>

Attribute PortfolioID View

Description Id of the portfolio to view. The type of the View.

XML Sample Response - PL View

<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader> <a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" s:mustU nderstand="1">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/ P ortfolioTracker_1/G etV iew _1_Reply </a:A ction> <a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etV iew _Response_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/P ortfolioTracker_1"> <P ortfolio xsi:ty pe="P ortfolioP LV iew " xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"> <P ortfolioN ame>portfolio1</P ortfolioN ame> <C urrency N ame>U S D</C urrency N ame>

Portfolio Tracker

557

<V alccy >1148.72</V alccy > <N etccy >148.720096</N etccy > <P ctccy >61991.5039</P ctccy > <C ashBalance>999.76</C ashBalance> <N etday >-1.680</N etday > <P ctday >-1.11524165</P ctday > <Instrument> <RIC N ame>IBM .N </RIC N ame> <S ecurity Id>512975</S ecurity Id> <InstrumentN ame>IN TL BU S M A C H IN E </InstrumentN ame> <Q uantity >112</Q uantity > <P rcnow >133</P rcnow > <Buy prc>0.214285</Buy prc> <C cy now >100</C cy now > <C cy now N ame>U S D</C cy now N ame> <C cy buy >100.03968</C cy buy > <C cy buy N ame>U S D</C cy buy N ame> <N etccy >148.720096</N etccy > <P ctccy >61991.503267974971</P ctccy > </Instrument> ... </P ortfolio> </G etV iew _Response_1> </Body > </E nv elope>

Attribute PortfolioName CurrencyName Valccy Netccy Pctccy CashBalance Netday Pctday Instrument

Description The portfolios name, chosen by the user. The portfolios base currency, chosen by the user when creating the portfolio. The current value of the portfolio in base currency. The net change for the portfolio in base currency. The percentage change for the portfolio in base currency. The current value of the cash holding in base currency. The net change for the portfolio in base currency on the current day. The percentage change for the portfolio in base currency on the current day. Contains instrument information for the current View. Contains the following elements: RICname : The RIC (Reuters Instrument Code) that identifies the instrument. SecurityId: A number between 1 and 75 that identifies the RIC within the portfolio InstrumentName : The display name for the instrument. Quantity : The current number of units of the instrument in the portfolio. Buyprc: The average buy price for the instrument in its local trading currency. Ccybuy : The average buy FX rate. CcybuyName : The instruments local trading currency. This is identical to ccynowName. Prcnow: The current price of the instrument in its local trading currency. Ccynow: The current FX rate between the instruments local trading currency and the portfolio base currency. CcynowName : The instruments local trading currency. Netccy : The net change of the instruments value in the portfolio base currency, compared to its buy value. Pctccy : The percent change of the instruments value in the portfolio base currency, compared to its buy value.

27.10.3 Prices View

Use Pricers View to see the current prices of each instrument in the portfolio using standard exchange pricing fields. XSD
XSD: http://api.rkd.reuters.com/schemas/P ortfolioTracker_1.xsd

XML Sample Request - Prices View

558

TRKD API Developer's Guide

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/P ortfolioTracker_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/P ortfolioTracker_1/ G etV iew _1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etV iew _Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/P ortfolioTracker_1"> <P ortfolioId>1335382</P ortfolioId> <V iew >P rices</V iew > </G etV iew _Request_1> </Body > </E nv elope>

Attribute PortfolioID View

Description Id of the portfolio to view. The type of the View.

XML Sample Response - Prices View

<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader> <a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" s:mustU nderstand="1">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/ rkd/P ortfolioTracker_1/G etV iew _1_Reply </a:A ction> <a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etV iew _Response_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/P ortfolioTracker_1"> <P ortfolio xsi:ty pe="P ortfolioP ricesV iew " xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"> <P ortfolioN ame>portfolio1</P ortfolioN ame> <C urrency N ame>U S D</C urrency N ame> <V alccy >2344.66</V alccy > <N etccy >1344.90</N etccy > <P ctccy >0</P ctccy > <C ashBalance>999.76</C ashBalance> <N etday >-20.00</N etday > <P ctday >-1.46530879</P ctday > <Instrument> <RIC N ame>IBM .N </RIC N ame> <S ecurity Id>512975</S ecurity Id> <InstrumentN ame>IN TL BU S M A C H IN E </InstrumentN ame> <C urrency >U S D</C urrency > <Last>134.49</Last> <N etC hg_1>-2</N etC hg_1> <P ctC hg_1>-1.49</P ctC hg_1> <Bid>132.5</Bid> <A sk>133</A sk> <A C V ol_1>313579550</A C V ol_1> </Instrument> ... </P ortfolio> </G etV iew _Response_1> </Body > </E nv elope>

Attribute PortfolioName CurrencyName Valccy

Description The portfolios name, chosen by the user. The portfolios base currency, chosen by the user when creating the portfolio. The current value of the portfolio in base currency.

Portfolio Tracker

559

Netccy Pctccy CashBalance Netday Pctday Instrument

The net change for the portfolio in base currency. The percentage change for the portfolio in base currency. The current value of the cash holding in base currency. The net change for the portfolio in base currency on the current day. The percentage change for the portfolio in base currency on the current day. Contains instrument information for the current View. Contains the following elements: RICName : The RIC (Reuters Instrument Code) that identifies the instrument. SecurityId: A number between 1 and 75 that identifies the RIC within the portfolio. InstrumentName : The display name for the instrument. Currency : The instruments local trading currency. Last : The instruments last price. NetChg_1: The instruments net change today. PctChng_1: The instruments percent change today. Bid: The instruments best bid. Ask : The instruments best ask. ACVol_1: The instruments todays volume.

27.10.4 Summary View

Use Summary View to see the most important portfolio information. XSD
XSD: http://api.rkd.reuters.com/schemas/P ortfolioTracker_1.xsd

XML Sample Request - Summary View

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/P ortfolioTracker_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/P ortfolioTracker_1/ G etV iew _1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etV iew _Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/P ortfolioTracker_1"> <P ortfolioId>1335382</P ortfolioId> <V iew >S ummary </V iew > </G etV iew _Request_1> </Body > </E nv elope>

Attribute PortfolioID View

Description Id of the portfolio to view. The type of the View.

XML Sample Response - Summary View

<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader> <a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" s:mustU nderstand="1">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/ P ortfolioTracker_1/G etV iew _1_Reply </a:A ction> <a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</a:RelatesTo>

560

TRKD API Developer's Guide

</s:H eader> <s:Body > <G etV iew _Response_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/P ortfolioTracker_1"> <P ortfolio xsi:ty pe="P ortfolioS ummary V iew " xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"> <P ortfolioN ame>portfolio1</P ortfolioN ame> <C urrency N ame>U S D</C urrency N ame> <V alccy >2344.66</V alccy > <N etccy >1344.90</N etccy > <P ctccy >0</P ctccy > <C ashBalance>999.76</C ashBalance> <N etday >-20.00</N etday > <P ctday >-1.46530879</P ctday > <Instrument> <RIC N ame>IBM .N </RIC N ame> <S ecurity Id>512975</S ecurity Id> <InstrumentN ame>IN TL BU S M A C H IN E </InstrumentN ame> <Q uantity >1000</Q uantity > <P rcnow >134.49</P rcnow > <V alnow >134490.00</V alnow > <C cy now >100</C cy now > <C cy now N ame>U S D</C cy now N ame> <V alccy >1344.90</V alccy > <N etccy >1344.90</N etccy > <P ctccy >0</P ctccy > </Instrument> ... </P ortfolio> </G etV iew _Response_1> </Body > </E nv elope>

Attribute PortfolioName CurrencyName Valccy Netccy Pctccy CashBalance Netday Pctday Instrument

Description The portfolios name, chosen by the user. The portfolios base currency, chosen by the user when creating the portfolio. The current value of the portfolio in base currency. The net change for the portfolio in base currency. The percentage change for the portfolio in base currency. The current value of the cash holding in base currency. The net change for the portfolio in base currency on the current day. The percentage change for the portfolio in base currency on the current day. Contains instrument information for the current View. Contains the following elements: RICname : The RIC (Reuters Instrument Code) that identifies the instrument. SecurityId: A number between 1 and 75 that identifies the RIC within the portfolio. InstrumentName : The display name for the instrument. Quantity : The current number of units of the instrument in the portfolio. Prcnow: The current price of the instrument in its local trading currency. Valnow: The current value of the instrument in its local trading currency. Ccynow: The current FX rate between the instruments local trading currency and the portfolio base currency. CcynowName : The instruments local trading currency. Valccy: The current value of the instrument in the portfolio base currency. Netccy : The net change of the instruments value in the portfolio base currency, compared to its buy value. Pctccy : The percent change of the instruments value in the portfolio base currency, compared to its buy value.

27.10.5 Valuation View

Use Valuation View to compare the instruments using standard valuations and see earnings and dividends. XSD
XSD: http://api.rkd.reuters.com/schemas/P ortfolioTracker_1.xsd

Portfolio Tracker

561

XML Sample Request -Valuation View

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/P ortfolioTracker_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/P ortfolioTracker_1/ G etV iew _1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etV iew _Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/P ortfolioTracker_1"> <P ortfolioId>1335382</P ortfolioId> <V iew >V aluation</V iew > </G etV iew _Request_1> </Body > </E nv elope>

Attribute PortfolioID View

Description Id of the portfolio to view. The type of the View.

XML Sample Response - Valuation View

<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader> <a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" s:mustU nderstand="1">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/ P ortfolioTracker_1/G etV iew _1_Reply </a:A ction> <a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etV iew _Response_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/P ortfolioTracker_1"> <P ortfolio> <P ortfolioN ame>portfolio1</P ortfolioN ame> <C urrency N ame>U S D</C urrency N ame> <V alccy >2344.66</V alccy > <N etccy >1344.90</N etccy > <P ctccy >0</P ctccy > <C ashBalance>999.76</C ashBalance> <N etday >-20.00</N etday > <P ctday >-1.46530879</P ctday > <Instrument> <RIC N ame>IBM .N </RIC N ame> <S ecurity Id>512975</S ecurity Id> <InstrumentN ame>IN TL BU S M A C H IN E </InstrumentN ame> <P E Ratio>0</P E Ratio> <Yield>4.625</Yield> <E arnings>-48.21</E arnings> <Div idend>6.22</Div idend> <Div P ay Date>02 F E B 2007</Div P ay Date> <E xDiv Date>22 N O V 2006</E xDiv Date> </Instrument> ... </P ortfolio> </G etV iew _Response_1> </Body > </E nv elope>

Attribute PortfolioName CurrencyName

Description The portfolios name, chosen by the user. The portfolios base currency, chosen by the user when creating the portfolio.

562

TRKD API Developer's Guide

Valccy Netccy Pctccy CashBalance Netday Pctday Instrument

The current value of the portfolio in base currency. The net change for the portfolio in base currency. The percentage change for the portfolio in base currency. The current value of the cash holding in base currency. The net change for the portfolio in base currency on the current day. The percentage change for the portfolio in base currency on the current day. Contains instrument information for the current View. Contains the following elements: RICname : The RIC (Reuters Instrument Code) that identifies the instrument. SecurityId: A number between 1 and 75 that identifies the RIC within the portfolio. InstrumentName : The display name for the instrument. PERatio: The instruments PE ratio. Yield: The instruments dividend yield. Earnings : The instruments earnings per share. Divident : The instruments dividend per share. DivPayDate : The instruments dividend pay date. ExDivDate : The instruments ex-dividend date.

27.11 Client Portfolio View

If your users real portfolios are held on your own systems, you may send a portfolio within a single request to the Thomson Reuters Knowledge Direct portfolio server for pricing and calculation, without Thomson Reuters storing any portfolio details. Each request is submitted to the portfolio server as a list of instruments and quantities, with a name and base currency, and the portfolio values are returned in XML format, giving you full flexibility in how you use the calculated portfolios. Here TRKD is acting as a pricing engine, calculating instrument and portfolio values using the latest available prices and FX rates, and allowing integration with news. XSD
XSD: http://api.rkd.reuters.com/schemas/P ortfolioTracker_1.xsd

XML Sample Request -Client Portfolio View

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/P ortfolioTracker_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/P ortfolioTracker_1/ G etC lientP ortfolioV iew _1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etC lientP ortfolioV iew _Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/P ortfolioTracker_1"> <P ortfolioN ame>ZXC V B</P ortfolioN ame> <C urrency >G BP </C urrency > <C ashBalance>10000</C ashBalance> <Description>Description text</Description> <V iew >P osition</V iew > <H oldings> <H olding> <RIC Id>V O D.L</RIC Id> <Display N ame>V O D</Display N ame> <P ersonalC omments>C omment</P ersonalC omments> <Q uantity >100</Q uantity > <Buy P riceLocal>0</Buy P riceLocal> <Buy P riceBase>0</Buy P riceBase> </H olding> <H olding> <RIC Id>IBM .N </RIC Id> <Display N ame>IBM </Display N ame> <P ersonalC omments>C omment</P ersonalC omments>

Portfolio Tracker

563

<Q uantity >300</Q uantity > <Buy P riceLocal>0</Buy P riceLocal> <Buy P riceBase>0</Buy P riceBase> </H olding> <H olding> <RIC Id>M S F T.O L</RIC Id> <Display N ame>M icrosoft</Display N ame> <P ersonalC omments>C omment</P ersonalC omments> <Q uantity >600</Q uantity > <Buy P riceLocal>0</Buy P riceLocal> <Buy P riceBase>0</Buy P riceBase> </H olding> </H oldings> </G etC lientP ortfolioV iew _Request_1> </Body > </E nv elope>

Attribute PortfolioName Currency CashBalance Description View Holdings Holding

Description The portfolios name, chosen by the user. The portfolios base currency, chosen by the user when creating the portfolio. The current value of the cash holding in base currency. Optional text describing the Portfolio. Defines what information will be returned. See section Retrieving Portfolio Views on information and a listing of all possible views. Contains a list of one or multiple holdings to be analyzed. The following information should be contained in each holding entered. Contains the following elements: RICId: The RIC (Reuters Instrument Code) that identifies the instrument. DisplayName: The display name for the instrument. PersonalComments: A comment regarding this instrument. Quantity: The current number of units of the instrument in the portfolio. BuyPriceLocal: Specifies the buy price of the security in its local currency. BuyPriceBase : Specifies the buy price of the security in the portfolios base currency.

XML Sample Response - Client Portfolio View

<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader> <a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" s:mustU nderstand="1">http://w w w .reuters.com/ns/2006/05/01/ w ebserv ices/rkd/P ortfolioTracker_1/G etC lientP ortfolioV iew _1_Reply </a:A ction> <a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etC lientP ortfolioV iew _Response_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/P ortfolioTracker_1"> <P ortfolio xsi:ty pe="P ortfolioP ositionV iew " > <P ortfolioN ame>ZXC V B</P ortfolioN ame> <C urrency N ame>G BP </C urrency N ame> <V alccy >26580.559763883</V alccy > <N etccy >7480.559763883</N etccy > <P ctccy >82.20396</P ctccy > <C ashBalance>10000</C ashBalance> <Description>Description text</Description> <N etday >-209.474671100</N etday > <P ctday >-1.24761307</P ctday > <C ashWeight>37.62148</C ashWeight> <Weight>100</Weight> <Instrument> <RIC N ame>V O D.L</RIC N ame> <S ecurity Id>1</S ecurity Id> <InstrumentN ame>V O D</InstrumentN ame> <Q uantity >100</Q uantity > <P rcnow >134.49</P rcnow > <V alnow >13449.00</V alnow > <C cy now >100</C cy now > <C cy now N ame>G Bp</C cy now N ame>

564

TRKD API Developer's Guide

<V alccy >134.49</V alccy > <Weight>0.5059713</Weight> </Instrument> <Instrument> <RIC N ame>IBM .N </RIC N ame> <S ecurity Id>2</S ecurity Id> <InstrumentN ame>IBM </InstrumentN ame> <Q uantity >300</Q uantity > <P rcnow >90.62</P rcnow > <V alnow >27186.00</V alnow > <C cy now >1.97995</C cy now > <C cy now N ame>U S D</C cy now N ame> <V alccy >13730.649763883</V alccy > <Weight>51.65674</Weight> </Instrument> <Instrument> <RIC N ame>M S F T.O </RIC N ame> <S ecurity Id>3</S ecurity Id> <InstrumentN ame>M icrosoft</InstrumentN ame> <Q uantity >600</Q uantity > <P rcnow >452.57</P rcnow > <V alnow >271542.00</V alnow > <C cy now >100</C cy now > <C cy now N ame>U S D</C cy now N ame> <V alccy >2715.42</V alccy > <Weight>10.2158117</Weight> </Instrument> </P ortfolio> </G etC lientP ortfolioV iew _Response_1> </Body > </E nv elope>

The response is a Position View based on the information provided in the request. For more information on Views and fields they contain see section Retrieving Portfolio Views .

Profiles

565

chapter 28

Profiles

The Thomson Reuters Profiles service allows users to store their broker research search criteria (referred to as "profiles" or "stored searches") in Thomson Reuters database. These search criteria may be retrieved at any time by their ID, so you won't have to enter them once again. You can also enable an e-mail alert to notify you when a document matching your criteria is contributed. For real-time broker research queries see section Document Search. By using this service you can retrieve, create, delete, reset and update your profile. The following operations are available: Create Profile (CreateProfile_1) - creates a profile for a user. Delete Profile (DeleteProfile_1) - deletes a profile. Get Profile (GetProfile_1) - retrieves information about a particular profile. Get Profile Email (GetProfileEmail_1) - retrieves the e-mail from a particular profile. Get Profile Schedule (GetProfileSchedule_1) - retrieves schedule for a particular profile. Get User Profiles (GetUserProfiles_1) - retrieves user profiles. Get Use Template (GetUseTemplate_1) - shows the format (template) used for the alert e-mail. Set Alert Type (SetAlertType_1) - enables/disables alerts for a profile. Set Profile Email (SetProfileEmail_1) - sets the e-mail address to send alerts to. Set Profile Schedule (SetProfileSchedule_1) - schedules the alert for a particular profile. Set Use Template (SetUseTemplate_1) - sets the format (template) to be used for the alert e-mail. Update Profile (UpdateProfile_1) - updates the profile information by its ID.

28.1

Authentication/Authorization, Service Endpoint, and Required Headers

Authorization All requests to the Thomson Reuters Profiles service require an authorization token. For details, see section Understanding Authentication Tokens. Authentication Thomson Reuters Profiles uses Reuters impersonation tokens for each effective user. In this case, Thomson Reuters must create each user before your application authenticates them. Unmanaged effective users are not supported in Thomson Reuters Profiles. For additional information, see section Creating a Token . Service Endpoint Thomson Reuters Profiles Endpoint
http://api.rkd.reuters.com/api/2008/01/12/P rofiles_1.sv c

Required Header Required HTTP Headers

P O S T /api/2008/01/12/P rofiles_1.sv c H TTP /1.1 C ontent-Ty pe: application/soap+xml H ost: api.rkd.reuters.com C ontent-Length: [length]

566

TRKD API Developer's Guide

28.2

WSDL
WSDL:
http://api.rkd.reuters.com/schemas/w sdl/P rofiles_1_H ttpA ndRKDToken.w sdl

28.3

Create Profile (CreateProfile_1)

The CreateProfile_1 request creates a profile for a user. The following example creates a profile with the name 'testProfile'. Its type is 'profile', alerts are enabled and they will be sent at 5 a.m. and 5 p.m. It also contains document search criteria which can be transformed into a DocSearch request retrieving documents from new submissions having 'Auto' in their headline. XML Sample Request - Creating Profile
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2008/01/12/P rofiles_1.sv c/A nony mous</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/P rofiles_1/ C reateP rofile_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <C reateP rofile_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/P rofiles_1"> <P rofile profileN ame="testP rofile" profileTy pe="profile" alertTy pe="E " schedule="0000010000000000010000000"> <P rofileS tring dateRange="new S ubmissions" maxRow s="100" ppv ="all" tkrE ncoding="tkr" tkrP rimary ="true" acceptLanguage="en" calcP rice="false" sy nC harsRequired="0"> <sort s_d="desc" s_c="score"/> <country >U S A </country > <matchS tr strS rc="hdln" relev ance="100">A uto</matchS tr> </P rofileS tring> <email>test@reuters.com</email> </P rofile> </C reateP rofile_Request_1> </Body > </E nv elope>

Note: The value of the 'email' attribute is limited to 255 characters. Attribute profileID profileName profileType Description ID of the profile (This attribute is ignored in the CreateProfile_1 operation). Name of the profile. Note: This value is limited to 32 characters. Type of the profile. Can have the following values: profile portfolio Enables/disables the alert. Sets alert schedule. Default value is '1000000000000000000000000' (real-time). A "1" in the first position indicates real time; a "1" in any other position indicates an hour in the 24 hour period. A set of attributes and elements containing search criteria. Each value of 'ProfileString' is limited to 255 characters.

alertType schedule ProfileString

Note: For more information on Document Search criteria and Document Search requests see section Document Search. Keep in mind that a profile with the only criteria "docType" is considered too generic by the application. The profiler ignores profiles with too broad criteria.

Profiles

567

The response returns the unique ID of the created profile: XML Sample Response - Creating Profile
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/ rkd/P rofiles_1/C reateP rofile_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <C reateP rofile_Response_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/P rofiles_1"> <P rofileID> 8 8 1 8 0 9 </P rofileID> </C reateP rofile_Response_1> </Body > </E nv elope>

28.4

Delete Profile (DeleteProfile_1)

The DeleteProfile_1 request deletes a user profile. The following example deletes user profile with ID '881631'. XML Sample Request - Deleting Profile
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2008/01/12/P rofiles_1.sv c/A nony mous</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/P rofiles_1/ DeleteP rofile_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <DeleteP rofile_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/P rofiles_1"> <P rofileID> 8 8 1 6 3 1 </P rofileID> </DeleteP rofile_Request_1> </Body > </E nv elope>

The response returns the following: XML Sample Response - Deleting Profile
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/ rkd/P rofiles_1/DeleteP rofile_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <DeleteP rofile_Response_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/P rofiles_1"/> </Body > </E nv elope>

568

TRKD API Developer's Guide

28.5

Get Profile (GetProfile_1)

The GetProfile_1 request retrieves information about a particular profile of a user. The following example retrieves information about a profile with Profile ID 881790. XML Sample Request - Retrieving Profile
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2008/01/12/P rofiles_1.sv c/A nony mous</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/P rofiles_1/ G etP rofile_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etP rofile_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/P rofiles_1"> <P rofileID> 8 8 1 7 9 0 </P rofileID> </G etP rofile_Request_1> </Body > </E nv elope>

The response returns the following information: XML Sample Response - Deleting Profile
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/ rkd/P rofiles_1/G etP rofile_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <G etP rofile_Response_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/P rofiles_1"> <P rofile profileID="881790" profileN ame="testP rofileU pdated" profileTy pe="profile" alertTy pe="" schedule="0000010000000000010000000"> <P rofileS tring tkrP rimary ="true"> <sort /> <ticker>IBM =U S </ticker> <country >U S A </country > </P rofileS tring> </P rofile> </G etP rofile_Response_1> </Body > </E nv elope>

Attribute profileID profileName profileType alertType schedule ProfileString

Description ID of the profile. Name of the profile. Type of the profile. Type of the alert. Shows alert schedule. A set of attributes and elements containing search criteria.

Profiles

569

28.6

Get Profile Email (GetProfileEmail_1)

The GetProfileEmai_1 request retrieves the e-mail from a particular user profile. The following example retrieves the e-mail from a profile with Profile ID 881790. XML Sample Request - Retrieving Profile E-mail
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2008/01/12/P rofiles_1.sv c/A nony mous</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/P rofiles_1/ G etP rofileE mail_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etP rofileE mail_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/P rofiles_1"> <P rofileID> 8 8 1 7 9 0 </P rofileID> </G etP rofileE mail_Request_1> </Body > </E nv elope>

The response returns the following information: XML Sample Response - Retrieving Profile E-mail
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/ rkd/P rofiles_1/G etP rofileE mail_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <G etP rofileE mail_Response_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/P rofiles_1"> <email>test@reuters.com</email> </G etP rofileE mail_Response_1> </Body > </E nv elope>

28.7

Get Profile Schedule (GetProfileSchedule_1)

The GetProfileSchedule_1 request retrieves schedule for a particular user profile. The following example retrieves schedule for the profile with ID '881790'. XML Sample Request - Retrieving Profile Schedule
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2008/01/12/P rofiles_1.sv c/A nony mous</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/P rofiles_1/ G etP rofileS chedule_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization>

570

TRKD API Developer's Guide

</H eader> <Body > <G etP rofileS chedule_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/P rofiles_1"> <P rofileID> 8 8 1 7 9 0 </P rofileID> </G etP rofileS chedule_Request_1> </Body > </E nv elope>

The response returns the following information: XML Sample Response - Retrieving Profile Schedule
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/ rkd/P rofiles_1/G etP rofileE mail_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <G etP rofileS chedule_Response_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/P rofiles_1"> <S chedule>0000000000000000000000000</S chedule> </G etP rofileS chedule_Response_1> </Body > </E nv elope>

Note: A 1 in the first position indicates real time; a 1 in any other position indicates an hour in the 24 hour period.

28.8

Get User Profiles (GetUserProfiles_1)

The GetUserProfiles_1 request retrieves user profiles. The following example retrieves user profiles. XML Sample Request - Retrieving User Profiles
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2008/01/12/P rofiles_1.sv c/A nony mous</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/P rofiles_1/ G etU serP rofiles_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etU serP rofiles_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/P rofiles_1" /> </Body > </E nv elope>

The response returns the following information: XML Sample Response - Retrieving User Profiles
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/ rkd/P rofiles_1/G etU serP rofiles_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body >

Profiles

571

<G etU serP rofiles_Response_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/P rofiles_1"> <P rofile profileID="881826" profileN ame="testP rofile2" profileTy pe="profile" alertTy pe="E " schedule="0000010000000000010000000"> <P rofileS tring dateRange="new S ubmissions" maxRow s="100" ppv ="all" tkrE ncoding="tkr" tkrP rimary ="true" acceptLanguage="en" calcP rice="false" sy nC harsRequired="0"> <sort s_d="desc" s_c="score"/> <country >U S A </country > <matchS tr relev ance="100" strS rc="hdln">A uto</matchS tr> </P rofileS tring> <email>fake1@reuters.com</email> </P rofile> <P rofile profileID="881827" profileN ame="testP rofile2" profileTy pe="profile" alertTy pe="E " schedule="0000010000000000010000000"> <P rofileS tring dateRange="new S ubmissions" exclude3rdP arty ="false" maxRow s="100" ppv ="all" tkrE ncoding="tkr" tkrP rimary ="true"> <sort s_d="desc" s_c="score"/> <ticker>IBM =U S </ticker> <ticker>M S F T=U S </ticker> </P rofileS tring> <email>test1@email.com</email> <email>test2@email.com</email> </P rofile> </G etU serP rofiles_Response_1> </Body > </E nv elope>

Attribute profileID profileName profileType alertType schedule ProfileString

Description ID of the profile. Name of the profile. Type of the profile. Type of the alert. Shows alert schedule. A set of attributes and elements containing search criteria.

28.9

Get Use Template (GetUseTemplate_1)

The GetUseTemplate_1 shows the format (template) of the alert email. The following example retrieves use template: XML Sample Request - Retrieving Use Template
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2008/01/12/P rofiles_1.sv c/A nony mous</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/P rofiles_1/ G etU seTemplate_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etU seTemplate_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/P rofiles_1"/> </Body > </E nv elope>

The response returns the following information: XML Sample Response - Retrieving Use Template

572

TRKD API Developer's Guide

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/ rkd/P rofiles_1/G etU seTemplate_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <G etU seTemplate_Response_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/P rofiles_1"> <U se>RKD_A P I </U se> </G etU seTemplate_Response_1> </Body > </E nv elope>

Note: You can work with your Thomson Reuters project manager to design an appropriate template for your application.

28.10 Set Alert Type (SetAlertType_1)

The SetAlertType_1 request enables/disables alerts for a particular profile. The following example enables alerts for the profile with ID '881790'. XML Sample Request - Setting Alert Type
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2008/01/12/P rofiles_1.sv c/A nony mous</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/P rofiles_1/ S etA lertTy pe_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <S etA lertTy pe_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/P rofiles_1"> <P rofileID> 8 8 1 7 9 0 </P rofileID> <A lertTy pe> E </A lertTy pe> </S etA lertTy pe_Request_1> </Body > </E nv elope>

To enable alerts for a stored query, set the <AlertType> attribute to "E", to disable set the <AlertType> attribute to "". The response returns the following information: XML Sample Response - Setting Alert Type
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/ rkd/P rofiles_1/S etA lertTy pe_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <S etA lertTy pe_Response_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/P rofiles_1"/> </Body > </E nv elope>

Profiles

573

28.11 Set Profile Email (SetProfileEmail_1)

The SetProfileEmail_1 request allows the user to set the e-mail address to send alerts to when a document is contributed that matches the criteria in that user's stored query. The following example sets the e-mail address for the profile with ID '881790'. XML Sample Request - Setting Profile Email
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2008/01/12/P rofiles_1.sv c/A nony mous</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/P rofiles_1/ S etP rofileE mail_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <S etP rofileE mail_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/P rofiles_1"> <P rofileID> 8 8 1 1 7 9 0 </P rofileID> <email>user.name@thomsonreuters.com </email> </S etP rofileE mail_Request_1> </Body > </E nv elope>

Note: When setting new e-mail(s), keep in mind that new values overwrite existing. The response returns the following information: XML Sample Response - Setting Profile Email
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/ rkd/P rofiles_1/S etP rofileE mail_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <S etP rofileE mail_Response_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/P rofiles_1" /> </Body > </E nv elope>

28.12 Set Profile Schedule (SetProfileSchedule_1)

The SetProfileSchedule_1 request schedules the alert for a particular profile. The following example schedules the alert to be sent at 10.00, 11.00, 12.00, 13.00 and 14.00 for the profile with ID '881790'. XML Sample Request - Setting Profile Schedule
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2008/01/12/P rofiles_1.sv c/A nony mous</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/P rofiles_1/ S etP rofileS chedule_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/C ommon_1">

574

TRKD API Developer's Guide

<A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > S etP rofileS chedule_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/P rofiles_1"> <P rofileID> 8 8 1 7 9 0 </P rofileID> <S chedule> 0 0 0 0 0 0 0 0 0 0 1 1 1 1 1 0 0 0 0 0 0 0 0 0 0 </S chedule> </S etP rofileS chedule_Request_1> </Body > </E nv elope>

A 1 in the first position indicates real time; a 1 in any other position indicates an hour in the 24 hour period. Note: To create a real-time alert, set the <Schedule> attribute to '1000000000000000000000000'. The response returns the following information: XML Sample Response - Setting Profile Schedule
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/ rkd/P rofiles_1/S etP rofileS chedule_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <S etP rofileS chedule_Response_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/P rofiles_1" /> </Body > </E nv elope>

28.13 Set Use Template (SetUseTemplate_1)

The SetUseTemplate_1 request sets the format (template) to be used for the alert e-mail. To enable the functionality of getting alerts you should use the SetUseTemplate_1 request on behalf of an effective user with the parameter <Use>RKD_API</Use>. 'RKD_API' is the default value. The following request should be sent to the Profiles service: XML Sample Request - Setting Use Template
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2008/01/12/P rofiles_1.sv c/A nony mous</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/P rofiles_1/ S etU seTemplate_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <S etU seTemplate_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/P rofiles_1"> <U se> RKD_A P I </U se> </S etU seTemplate_Request_1> </Body > </E nv elope>

The response returns the following information:

Profiles

575

XML Sample Response - Setting Use Template

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/ rkd/P rofiles_1/S etU seTemplate_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <S etU seTemplate_Response_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/P rofiles_1"/> </Body > </E nv elope>

28.14 Update Profile (UpdateProfile_1)

The UpdateProfile_1 request updates the profile information by its ID. The following example updates the profile with ID '881790'. XML Sample Request - Updating Profile
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2008/01/12/P rofiles_1.sv c/A nony mous</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/P rofiles_1/ U pdateP rofile_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <U pdateP rofile_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/P rofiles_1"> <P rofile profileID=" 8 8 1 7 9 0 " profileN ame="testP rofileU pdated" alertTy pe="" schedule="0000010000000000010000000"> <P rofileS tring dateRange="new S ubmissions" maxRow s="100" ppv ="all" tkrE ncoding="tkr" tkrP rimary ="true" acceptLanguage="en" calcP rice="false" sy nC harsRequired="0"> <sort s_d="desc" s_c="score"/> <country >U S A </country > <ticker>IBM =U S </ticker> </P rofileS tring> <email>fake_U pdated@reuters.com</email> </P rofile> </U pdateP rofile_Request_1> </Body > </E nv elope>

For more information on profile attributes see section Create Profile (CreateProfile_1). Note: When updating profile with new information, keep in mind that all profiles attributes (except profileID) and elements you submit overwrite existing. The response returns the following information: XML Sample Response - Updating Profile
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/ rkd/P rofiles_1/U pdateP rofile_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body >

576

TRKD API Developer's Guide

<U pdateP rofile_Response_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/P rofiles_1"/> </Body > </E nv elope>

28.15 Mapping from Document Search Set Code to Profile Set Code
In general, the Profiles service (and particularly alerts generator) understands contributor (local) codes. Some search criteria's (like industries, subjects, categories) can be specified in the Profiles service in both variants: local (then Set code should be specified) or global codes. But the Profiles service requires only Multex (global) codes for the following exceptional cases: analyst , currency , and country values. Currency and country are always used in global codes, so there is no need to convert them specially for the Profiles service, but if a site operates with local analyst codes they must be mapped into global (Multex) codes by using the Authors Reference service and then saved in profiles. The following example shows how to get global code using local author code for saving it in a profile. Use the AuthorsList_1 request to get global code of Lehman Brothers (contributor id 10333) analyst John L Butler (local code is LB01154): XML Sample <AuthorsList_Request_1 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/ XMLSchema" xmlns="http://www.reuters.com/ns/2008/01/12/webservices/rkd/Authorsref_1"> <authorSearchCriterion> <basicSearch /> <contribStringsSearch contributionString="LB01154" ctbID="10333" /> </authorSearchCriterion> </AuthorsList_Request_1> Response returns global code (in bold): XML Sample <AuthorsList_Response_1 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3. org/2001/XMLSchema" xmlns="http://www.reuters.com/ns/2008/01/12/webservices/rkd/Authorsref_1"> <author uid="30135425" authorCode="3AMJ "/> </AuthorsList_Response_1> The following set codes must be converted for alerts generator before saving to profile (analystSet is not to be converted, because it is not processed by alert generator and authors codes should be converted instead as specified above): subjectSet ; regionSet ; industrySet ; categorySet . To map a Document Search set code to a Profile Set Code, use the following algorithm of conversion ("MX#001" -> "001" -> 1 -> "1"): 1. Select a number after "#" ("MX#001" -> "001"); 2. Convert it to an integer ("001" -> 1); 3. Store it in a profile as a string (1 -> "1") Note: For more information on local/global codes see sections Using Reuters (Global) Codes and Using Contributor (Local) Codes.

28.16 Alerts Return ctSubjectsResp Different from ctsubjects in Created Profiles

In Thomson Reuters Profiles, the returned alerts may contain "ctSubjectsResp" different from "ctsubjects" in created profiles: alert with ctSubjectsResp=MXAGCM returns to Profile with ctsubjects=MXCMAG (ctSubjectsCodes=120000001);

Profiles

577

alert alert alert alert alert alert

with ctSubjectsResp=MXASFI returns to Profile with ctsubjects=MXFIAS (ctSubjectsCodes=120000002); with ctSubjectsResp=MXBCEC returns to Profile with ctsubjects=MXECBC (ctSubjectsCodes=120000003); with ctSubjectsResp=MXBREC returns to Profile with ctsubjects=MXECBR (ctSubjectsCodes=120000004); with ctSubjectsResp=MXCPIN returns to Profile with ctsubjects=MXINCP (ctSubjectsCodes=120000024); with ctSubjectsResp=MXMFTT returns to Profile with ctsubjects=MXTTMF (ctSubjectsCodes=120000049); with ctSubjectsResp=MXAQCO returns to Profile with ctsubjects=MXCOAQ (ctSubjectsCodes=120000055);

It is a designed behavior and the pairs of IC subjects listed above are completely equivalent (f.e. there is no difference between Multex Agriculture Commodity (MXAGCM) and Multex Commodity Agriculture (MXCMAG), the meaning of those two subjects is completely the same). String values are combined from several abbreviations: MX Multex is general for all; other 2-letter abbreviations mean the respective subjects: You can get the explanations for those 2-letter abbreviations using the Reference Information service. For example: AG Agriculture; CM Commodity.

578

TRKD API Developer's Guide

chapter 29

Purchase History

This chapter describes how to use the Thomson Reuters Knowledge Direct API to retrieve purchase history for documents for particular date range. The following operations are available in the Thomson Reuters Purchase History service: Get Purchase History (GetPurchaseHistory_1) - retrieves the purchase history for effective user. Get Purchase History Admin (GetPurchaseHistoryAdmin_1) - retrieves the purchase history for any user in a channel.

29.1

Authentication/Authorization, Service Endpoint, and Required Headers

Authorization All requests to the Thomson Reuters Purchase History service require an authorization token. For details, see section Understanding Authentication Tokens. Authentication Thomson Reuters Purchase History uses Reuters impersonation tokens for each effective user. In this case, Thomson Reuters must create each user before your application authenticates them. Unmanaged effective users are not supported in Thomson Reuters Purchase History. For additional information, see section Creating a Token . Service Endpoint Thomson Reuters Purchase History Endpoint
http://api.rkd.reuters.com/api/2009/10/01/P urchaseH istory _1.sv c

Required Header Required HTTP Headers

P O S T /api/2009/10/01/P urchaseH istory _1.sv c H TTP /1.1 C ontent-Ty pe: application/soap+xml H ost: api.rkd.reuters.com C ontent-Length: [length]

29.2

WSDL
WSDL:
http://api.rkd.reuters.com/schemas/w sdl/P urchaseH istory _1_H ttpA ndRKDToken.w sdl

29.3

Get Purchase History (GetPurchaseHistory_1)

Use the GetPurchaseHistory_1 request to get purchase history for a particular date range. The example below retrieves purchase history for the period from 02/01/2007 to 12/24/2009:

Purchase History

579

XML Sample Request - Retrieving Purchase History

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/10/01/P urchaseH istory _1.sv c/A nony mous</ To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/rkd/P urchaseH istory _1/ G etP urchaseH istory _1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etP urchaseH istory _Request_1 xmlns="http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/rkd/P urchaseH istory _1" toDate ="2009-1224T00:00:00Z" fr omDate ="2007-02-01T00:00:00Z"></G etP urchaseH istory _Request_1> </Body > </E nv elope>

The response returns the following information: XML Sample Response - Retrieving Purchase History
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/ rkd/P urchaseH istory _1/G etP urchaseH istory _1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <G etP urchaseH istory _Response_1 xmlns="http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/rkd/P urchaseH istory _1"> <getP urchaseH istory Record P age="10" company N ame="C entrum Broking P riv ate Limited" ctbID="47524" docID="44620408" fileE xt="P DF " price="1000" purchaseDate="2009-12-22T15:33:31"> <headline>Zee N ew s - Initiating C ov erage - A ccumulate</headline> <referenceC ode></referenceC ode> </getP urchaseH istory Record> <getP urchaseH istory Record P age="-1" company N ame="C entrum Broking P riv ate Limited" ctbID="47524" docID="44620408" fileE xt="P DF " price="100" purchaseDate="2009-12-22T13:04:49"> <headline>Zee N ew s - Initiating C ov erage - A ccumulate</headline> <referenceC ode></referenceC ode> </getP urchaseH istory Record> <getP urchaseH istory Record P age="-1" company N ame="BofA M errill Ly nch" ctbID="57030" docID="47183933" fileE xt="P DF " price="75000" purchaseDate="2009-12-16T12:21:17"> <headline>E uropean M orning C redit</headline> <referenceC ode></referenceC ode> </getP urchaseH istory Record> <getP urchaseH istory Record P age="-1" company N ame="BofA M errill Ly nch" ctbID="57030" docID="47183933" fileE xt="P DF " price="75000" purchaseDate="2009-12-16T12:21:17"> <headline>E uropean M orning C redit</headline> <referenceC ode></referenceC ode> </getP urchaseH istory Record> <getP urchaseH istory Record P age="-1" company N ame="P lunkett Research, Ltd." ctbID="14899" docID="46366411" fileE xt="P DF " price="1990000" purchaseDate="2009-12-15T16:31:08"> <headline>A irline, H otel &amp; Trav el Industry Trends, S tatistics &amp; A naly sis 2010 (S ummary )</headline> <referenceC ode></referenceC ode> </getP urchaseH istory Record> </G etP urchaseH istory _Response_1> </Body > </E nv elope>

Attribute headline referenceCode

Description The headline of the purchased document. (Optional) Reference code.

580

TRKD API Developer's Guide

29.4

Get Purchase History Admin (GetPurchaseHistoryAdmin_1)

Use the GetPurchaseHistoryAdmin_1 request to get purchase history for a particular user for a particular date range. The example below retrieves purchase history for the period from 02/01/2007 to 12/24/2009: XML Sample Request - Retrieving Purchase History Admin
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/10/01/P urchaseH istory _1.sv c/A nony mous</ To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/rkd/P urchaseH istory _1/ G etP urchaseH istory A dmin_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etP urchaseH istory A dmin_Request_1 xmlns="http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/rkd/P urchaseH istory _1" toDate="2009-12-24T00:00:00Z" fromDate="2007-02-01T00:00:00Z"> <userIdentity > <cid_uid> <company ID>30373</company ID> <ID>32188593</ID> </cid_uid> </userIdentity > </G etP urchaseH istory A dmin_Request_1> </Body > </E nv elope>

Element User Identity

Value Defines user identity. Can be: alias (user alias - f.e. user's e-mail); companyID (Company ID) + ID (user ID)

The response returns the following information: XML Sample Response - Retrieving Purchase History Admin
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/ rkd/P urchaseH istory _1/G etP urchaseH istory A dmin_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <G etP urchaseH istory A dmin_Response_1 xmlns="http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/rkd/P urchaseH istory _1"> <getP urchaseH istory Record P age="10" company N ame="C entrum Broking P riv ate Limited" ctbID="47524" docID="44620408" fileE xt="P DF " price="1000" purchaseDate="2009-12-22T15:33:31"> <headline>Zee N ew s - Initiating C ov erage - A ccumulate</headline> <referenceC ode></referenceC ode> </getP urchaseH istory Record> <getP urchaseH istory Record P age="-1" company N ame="C entrum Broking P riv ate Limited" ctbID="47524" docID="44620408" fileE xt="P DF " price="100" purchaseDate="2009-12-22T13:04:49"> <headline>Zee N ew s - Initiating C ov erage - A ccumulate</headline> <referenceC ode></referenceC ode> </getP urchaseH istory Record> <getP urchaseH istory Record P age="-1" company N ame="BofA M errill Ly nch" ctbID="57030" docID="47183933" fileE xt="P DF " price="75000" purchaseDate="2009-12-16T12:21:17"> <headline>E uropean M orning C redit</headline> <referenceC ode></referenceC ode> </getP urchaseH istory Record> <getP urchaseH istory Record P age="-1" company N ame="BofA M errill Ly nch" ctbID="57030" docID="47183933" fileE xt="P DF " price="75000" purchaseDate="2009-12-16T12:21:17">

Purchase History

581

<headline>E uropean M orning C redit</headline> <referenceC ode></referenceC ode> </getP urchaseH istory Record> <getP urchaseH istory Record P age="-1" company N ame="P lunkett Research, Ltd." ctbID="14899" docID="46366411" fileE xt="P DF " price="1990000" purchaseDate="2009-12-15T16:31:08"> <headline>A irline, H otel &amp; Trav el Industry Trends, S tatistics &amp; A naly sis 2010 (S ummary )</headline> <referenceC ode></referenceC ode> </getP urchaseH istory Record> </G etP urchaseH istory A dmin_Response_1> </Body > </E nv elope>

Attribute headline referenceCode

Description The headline of the purchased document. (Optional) Reference code.

582

TRKD API Developer's Guide

chapter 30

Quote Lists

The QuoteList service lets you retrieve prices on multi-instrument and multi-field quotelists in a single request. You send a list of the instruments (RICs) and the fields to the QuoteList service and the latest available prices for these instruments are returned in the corresponding format. Optionally you may specify a single base currency to convert all prices to that currency. This is the most efficient way for you to access lists of instruments from TRKD, for example a list of indices on your home page, or a watchlist. Otherwise you would need to make one request for each instrument, one-by-one. Up to 75 instruments and 25 fields may be included in each request. A quotelist may contain any of the following types of instrument: exchange-traded stocks (for example: RIC VOD.L) indices (for example: RIC .DJI) exchange warrants (for example: RIC CH1031161.S) exchange bonds (for example: RIC CH1037959=S) bonds (for example: RIC US30YT=RR) exchange funds (for example: RIC SWBZ.S) foreign exchange (for example: RIC CHF=X) Note : The instruments you send in the QuoteList function should be valid RICs. If one of the RICs becomes invalid in the QuoteLists then all operations will return the information about invalid RICs, without providing data for valid RICs.

30.1

Conflation
Thomson Reuters Knowledge Direct utilises a three second conflated feed as a source of its quotes data. This means that every three seconds the Thomson Reuters Knowledge Direct systems receive an update. This feed is used to supply data to TRKD delayed servers and provide real-time snap responses. Clients should be aware of this configuration aspect of the product in case there are differences in data highlighted when compared to alternate sources of the same data. Note: The conflation on data on Thomson Reuters Knowledge API is 3 seconds for non-trade data (bid/ask, etc.).

30.2

Quote data
An instrument is identified by a RIC (Reuters Instrument Code). Each RIC has a series of attached fields that contain different items of information (for example, todays high price, traded volume, etc.). Not all instruments contain the same fields, and the fields are not always returned in the same order; this depends on the type of financial instrument (for example, stock, index, FX rate, fund, etc.). Each field has a label that identifies it and it is called a Field Identifier or FID. Since you are parsing the data returned in XML format, it is essential that your program finds the required values by using these identifiers, not by searching for the third or fourth field (for example), because over time Thomson Reuters may add extra fields or change the field order. Note: The value prior to/in the company name FID indicates the (designed) delay in the quote data. For example: "D15| Microsoft" says that the delay in the quote data for Microsoft is 15 minutes. Full details of RICs, and the fields (FIDs) that accompany them, are provided in the TRKD Data Guide.

30.3

Authentication/Authorization, Service Endpoint, and Required Headers

Authorization All requests to the QuoteList web service require an authorization token. For details, see section Understanding Authentication Tokens.

Quote Lists

583

Authentication In most implementations, QuoteList service uses unmanaged impersonation tokens for each effective user. In this case, it is up to your application to supply (and otherwise manage) a unique identifier for each user; Thomson Reuters does not manage the user identities. QuoteList service also supports Reuters impersonation tokens for each effective user. In this case, Thomson Reuters must create each user before your application authenticates them. For additional information, see section Creating a Token for more information on creating a Service Token. Service Endpoint QuoteList Endpoint
http://api.rkd.reuters.com/api/2006/05/01/Q uoteLists_1.sv c

Required Header Required HTTP Headers

P O S T /api/2006/05/01/Q uoteLists_1.sv c H TTP /1.1 C ontent-Ty pe: application/soap+xml H ost: api.rkd.reuters.com C ontent-Length: [length]

30.4

WSDL
WSDL:
http://api.rkd.reuters.com/schemas/w sdl/Q uoteLists_1_H ttpA ndRKDToken.w sdl

30.5

Working with QuoteLists

The following operations demonstrate how to add, edit, delete and retrieve Quote lists.

30.5.1 Create QuoteList (CreateQuoteList_1)

CreateQuoteList_1 operation creates a Quote list for the user. XSD
XSD: http://api.rkd.reuters.com/schemas/Q uoteLists_1.xsd

The following example creates a QuoteList named TestList7 with instruments IBM.N and MSFT.O. FIDs Currency, TRDPRC_1 and Unit are specified to be returned for each RIC in the response. RICs with FIDs are optional in the Create method. You are also able to add RICs after the QuoteList was created by using AddRICsFIDs_1 method. See section Add RICs and FIDs (AddRICsFIDs_Request_1) for more detail. XML Sample Request - Create Quote List
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/Q uoteLists_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/Q uoteLists_1/ C reateQ uoteList_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader>

584

TRKD API Developer's Guide

<Body > <C reateQ uoteList_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/Q uoteLists_1"> <listN ame>TestList7</listN ame> <RIC s> <RIC >IBM .N </RIC > <RIC >M S F T.O </RIC > </RIC s> <F IDs> <F ID>C U RRE N C Y</F ID> <F ID>TRDP RC _1</F ID> <F ID>U N IT</F ID> </F IDs> </C reateQ uoteList_Request_1> </Body > </E nv elope>

Attribute listName RICs FIDs

Description Name the quote list will be known as. (Optional) The RIC (Reuters Instrument Code) that identifies the instrument. You can enter multiple RICs each in its own RIC tag. (Optional) FID, or Field Identifier, contains a list of fields you want to be shown in the request response for the instrument. Whenever information on the RIC(s) is requested it will return the fields entered here. Note: Ability to view all the fields (FIDs) depends on clients entitlements. The value prior to/in the company name FID indicates the (designed) delay in the quote data. For example: "D15|Microsoft" says that the delay in the quote data for Microsoft is 15 minutes.

XML Sample Response - Create Quote List

<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader> <a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" s:mustU nderstand="1"> http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/ rkd/http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/Q uoteLists_1/C reateQ uoteList_1_Reply </a:A ction> <a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <C reateQ uoteList_Response_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/Q uoteLists_1"> <C reateQ uoteListResult> <ItemResponse> <Item xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/Q uotesC ommon"> <RequestKey N ame="IBM .N " S erv ice="" /> <Q oS > <TimelinessInfo Timeliness="RE A LTIM E " TimeInfo="0" /> <RateInfo Rate="TIC K_BY_TIC K" TimeInfo="0" /> </Q oS > <S tatus> <S tatusM sg>O K</S tatusM sg> <S tatusC ode>0</S tatusC ode> </S tatus> <F ields> <F ield DataTy pe="Double" N ame="TRDP RC _1"> <Double>122.85</Double> </F ield> <F ield DataTy pe="U tf8S tring" N ame="C U RRE N C Y"> <U tf8S tring>U S D</U tf8S tring> </F ield> <F ield DataTy pe="U tf8S tring" N ame="BQ O S "> <U tf8S tring>0</U tf8S tring> </F ield> <F ield DataTy pe="U tf8S tring" N ame="P Q O S "> <U tf8S tring>RT</U tf8S tring> </F ield> <F ield DataTy pe="U tf8S tring" N ame="C oncreteS erv ice"> <U tf8S tring>F D3</U tf8S tring> </F ield> <F ield DataTy pe="Int32" N ame="M S G _TYP E "> <Int32>0</Int32> </F ield>

Quote Lists

585

<F ield DataTy pe="Int32" N ame="RE C _S TA TU S "> <Int32>0</Int32> </F ield> </F ields> </Item> <Item xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/Q uotesC ommon"> <RequestKey N ame="M S F T.O " S erv ice="" /> <Q oS > <TimelinessInfo Timeliness="RE A LTIM E " TimeInfo="0" /> <RateInfo Rate="TIC K_BY_TIC K" TimeInfo="0" /> </Q oS > <S tatus> <S tatusM sg>O K</S tatusM sg> <S tatusC ode>0</S tatusC ode> </S tatus> <F ields> <F ield DataTy pe="Double" N ame="TRDP RC _1"> <Double>0</Double> </F ield> <F ield DataTy pe="U tf8S tring" N ame="C U RRE N C Y"> <U tf8S tring>U S D</U tf8S tring> </F ield> <F ield DataTy pe="U tf8S tring" N ame="BQ O S "> <U tf8S tring>0</U tf8S tring> </F ield> <F ield DataTy pe="U tf8S tring" N ame="P Q O S "> <U tf8S tring>RT</U tf8S tring> </F ield> <F ield DataTy pe="U tf8S tring" N ame="C oncreteS erv ice"> <U tf8S tring>F D3</U tf8S tring> </F ield> <F ield DataTy pe="Int32" N ame="M S G _TYP E "> <Int32>0</Int32> </F ield> <F ield DataTy pe="Int32" N ame="RE C _S TA TU S "> <Int32>0</Int32> </F ield> </F ields> </Item> </ItemResponse> </C reateQ uoteListResult> </C reateQ uoteList_Response_1> </Body > </E nv elope>

Attribute Item RequestKey QoS

Description Each instrument listed in the request is returned in its own Item node containing: RequestKey, QoS, Status, Fields (FIDs). See below for description of each. Contains the instrument name and the Service (data source) that provides the feed. The Service will have a value only if its not the default data source. Note: Each TRKD user ID is permissioned with only one Quality of Service - either Real-time or Delayed data. The Quote schema does provide alternate Qualities of Service (Desired and Worst Acceptable). These should be ignored for now. The TRKD infrastructure may utilize these capabilities in a future release. Should you require both real-time and delayed data, Thomson Reuters will provide you with two IDs, each permissioned with the relevant QoS. Is used to represent the desired quality of service. Quality of Service is a categorical method of classifying traffic into separate tiers to provide differentiated services within a network. Note that a user will only receive the QoS that he/she is permissioned for. Contains the following Attribute(s): TimelinessInfo: Timeliness may be one of the following types: REALTIME - No delay is applied to the data. DELAYED - The data is delayed by the number of whole seconds specified in the TimeInfo attribute. DELAYED_UNKNOWN - A fixed delay (such as 60 seconds) is applied to the data. Valid only in responses, not requests. UNSPECIFIED - In QoS, use this value to request the most timely data allowed by the client's permissions. In WorstQoS, use this value to indicate that any timeliness is acceptable. RateInfo: The actual rate of data as specified by the Rate. Rate may have one of the following

586

TRKD API Developer's Guide

values: TICK_BY_TICK - The data is updated on the server with every tick. JIT_CONFLATED - "Just in time" conflation is applied to the data before it reaches the server's cache. TIME_CONFLATED - Time-based conflation is applied to the data before it reaches the server's cache, in cycles of a duration specified in milliseconds in TimeInfo. PERIODIC_REFRESH - The data is updated on the server by a periodic refresh mechanism (e.g., a "pull"), at periods specified in milliseconds in TimeInfo. UNSPECIFIED - In QoS, this value corresponds with data being updated as often as possible. In WorstQoS, this value indicates that the update method is not critical. Status Fields Status is used to convey the state of an Item. Status is present in each Item node. Status may contain source-specific messages such as a detailed error message, back-end error ID, or both. The Field represents a data field (FID) associated to RICs (Instruments). Each Field object contains information such as field name, value, data type and display hint. Display hints suggest how to display the data: decimal, fraction, date, or date time, and so on.

30.5.2 Get QuoteList (GetQuoteList_Request_1)

GetQuoteList_1 method retrieves Quote list for a specific user. XSD
XSD: http://api.rkd.reuters.com/schemas/Q uoteLists_1.xsd

The following example retrieves all the instruments under a specified QuoteList. XML Sample Request - Get Quote List
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/Q uoteLists_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/Q uoteLists_1/ G etQ uoteList_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etQ uoteList_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/Q uoteLists_1"> <listN ame>TestList</listN ame> </G etQ uoteList_Request_1> </Body > </E nv elope>

Attribute listName

Description Name of the quote list.

XML Sample Response - Get Quote List

<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader> <a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" s:mustU nderstand="1"> http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/ rkd/http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/Q uoteLists_1/G etQ uoteList_1_Reply </a:A ction> <a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etQ uoteList_Response_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/Q uoteLists_1"> <G etQ uoteListResult> <ItemResponse> <Item xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/Q uotesC ommon">

Quote Lists

587

<RequestKey N ame="IBM .N " S erv ice="" /> <Q oS > <TimelinessInfo Timeliness="RE A LTIM E " TimeInfo="0" /> <RateInfo Rate="TIC K_BY_TIC K" TimeInfo="0" /> </Q oS > <S tatus> <S tatusM sg>O K</S tatusM sg> <S tatusC ode>0</S tatusC ode> </S tatus> <F ields> <F ield DataTy pe="Double" N ame="TRDP RC _1"> <Double>122.85</Double> </F ield> <F ield DataTy pe="U tf8S tring" N ame="C U RRE N C Y"> <U tf8S tring>U S D</U tf8S tring> </F ield> <F ield DataTy pe="U tf8S tring" N ame="BQ O S "> <U tf8S tring>0</U tf8S tring> </F ield> <F ield DataTy pe="U tf8S tring" N ame="P Q O S "> <U tf8S tring>RT</U tf8S tring> </F ield> <F ield DataTy pe="U tf8S tring" N ame="C oncreteS erv ice"> <U tf8S tring>F D3</U tf8S tring> </F ield> <F ield DataTy pe="Int32" N ame="M S G _TYP E "> <Int32>0</Int32> </F ield> <F ield DataTy pe="Int32" N ame="RE C _S TA TU S "> <Int32>0</Int32> </F ield> </F ields> </Item> <Item xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/Q uotesC ommon"> <RequestKey N ame="M S F T.O " S erv ice="" /> <Q oS > <TimelinessInfo Timeliness="RE A LTIM E " TimeInfo="0" /> <RateInfo Rate="TIC K_BY_TIC K" TimeInfo="0" /> </Q oS > <S tatus> <S tatusM sg>O K</S tatusM sg> <S tatusC ode>0</S tatusC ode> </S tatus> <F ields> <F ield DataTy pe="Double" N ame="TRDP RC _1"> <Double>0</Double> </F ield> <F ield DataTy pe="U tf8S tring" N ame="C U RRE N C Y"> <U tf8S tring>U S D</U tf8S tring> </F ield> <F ield DataTy pe="U tf8S tring" N ame="BQ O S "> <U tf8S tring>0</U tf8S tring> </F ield> <F ield DataTy pe="U tf8S tring" N ame="P Q O S "> <U tf8S tring>RT</U tf8S tring> </F ield> <F ield DataTy pe="U tf8S tring" N ame="C oncreteS erv ice"> <U tf8S tring>F D3</U tf8S tring> </F ield> <F ield DataTy pe="Int32" N ame="M S G _TYP E "> <Int32>0</Int32> </F ield> <F ield DataTy pe="Int32" N ame="RE C _S TA TU S "> <Int32>0</Int32> </F ield> </F ields> </Item> </ItemResponse> </G etQ uoteListResult> </G etQ uoteList_Response_1> </Body > </E nv elope>

Note: If there are invalid RICs in a listing, the listing will not be displayed. Instead the client gets an error displaying the invalid RICs. The invalid RICs must be deleted in order to get the quote list. All invalid RICs must be removed from the quote

588

TRKD API Developer's Guide

list simultaneously otherwise the delete function won't work. Attribut Description e Item Each instrument listed in the request will be returned in its own Item node containing; RequestKey, QoS, Status, Fields (FIDs). See below for description of each. RequestK Contains the instrument name and the Service (data source) that provides the feed. The Service will have a ey value only if its not the default data source. QoS Note: Each TRKD user ID is permissioned with only one Quality of Service - either Real-time or Delayed data. The Quote schema does provide alternate Qualities of Service (Desired and Worst Acceptable). These should be ignored for now. The TRKD infrastructure may utilize these capabilities in a future release. Should you require both real-time and delayed data,Thomson Reuters will provide you with two IDs, each permissioned with the relevant QoS. Is used to represent the desired quality of service. Quality of Service is a categorical method of classifying traffic into separate tiers to provide differentiated services within a network. Note that a user will only receive the QoS that he/she is permissioned for. Contains the following Attribute(s): TimelinessInfo: Timeliness may be one of the following types: REALTIME - No delay is applied to the data. DELAYED - The data is delayed by the number of whole seconds specified in the TimeInfo attribute. DELAYED_UNKNOWN - A fixed delay (such as 60 seconds) is applied to the data. Valid only in responses, not requests. UNSPECIFIED - In QoS, use this value to request the most timely data allowed by the client's permissions. In WorstQoS, use this value to indicate that any timeliness is acceptable. RateInfo: The actual rate of data as specified by the Rate. Rate may have one of the following values: TICK_BY_TICK - The data is updated on the server with every tick. JIT_CONFLATED - Just in time" conflation is applied to the data before it reached the server's cache. TIME_CONFLATED - Time-based conflation is applied to the data before it reaches the server's cache, in cycles of a duration specified in milliseconds in TimeInfo. PERIODIC_REFRESH - The data is updated on the server by a periodic refresh mechanism (e.g., a "pull"), at periods specified in milliseconds in TimeInfo. UNSPECIFIED - In QoS, this value corresponds with data being updated as often as possible. In WorstQoS, this value indicates that the update method is not critical. Status Fields Status is used to convey the state of an Item. Status is present in each Item node. Status may contain sourcespecific messages such as a detailed error message, back-end error ID, or both. The Field represents a data field (FID) associated to RICs (Instruments). Each Field object contains information such as field name, value, data type and display hint. Display hints suggest how to display the data: decimal, fraction, date, or date time, and so on. Note: The value prior to/in the company name FID indicates the (designed) delay in the quote data. For example: "D15|Microsoft" says that the delay in the quote data for Microsoft is 15 minutes.

30.5.3 Delete QuoteList (DeleteQuoteList_Request_1)

DeleteQuoteList_Request_1 method deletes a specified Quote List belonging to a user. XSD
XSD: http://api.rkd.reuters.com/schemas/Q uoteLists_1.xsd

The following example deletes a QuoteList with name test1. XML Sample Request - Delete Quote List
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/Q uoteLists_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/Q uoteLists_1/ DeleteQ uoteList_1</A ction>

Quote Lists

589

<A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <DeleteQ uoteList_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/Q uoteLists_1"> <listN ame>test1</listN ame> </DeleteQ uoteList_Request_1> </Body > </E nv elope>

Attribute listName

Description List to be deleted.

XML Sample Response - Delete Quote List

<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader> <a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" s:mustU nderstand="1"> http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/ rkd/http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/Q uoteLists_1/DeleteQ uoteList_1_Reply </a:A ction> <a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <DeleteQ uoteList_Response_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/Q uoteLists_1" /> </Body > </E nv elope>

30.5.4 Get Listing (GetListing_Request_1)

GetListing_Request_1 operation returns all QuoteLists for a specified user. XSD
XSD: http://api.rkd.reuters.com/schemas/Q uoteLists_1.xsd

XML Sample Request - Get List

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/Q uoteLists_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/Q uoteLists_1/ G etListing_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etListing_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/Q uoteLists_1"/> </Body > </E nv elope>

XML Sample Response - Get List

<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader> <a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" s:mustU nderstand="1"> ttp://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/ http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/Q uoteLists_1/G etListing_1_Reply

590

TRKD API Developer's Guide

</a:A ction> <a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etListing_Response_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/Q uoteLists_1"> <Q uoteLists> <Q uoteList>TestList</Q uoteList> <Q uoteList>TestList2</Q uoteList> <Q uoteList>TestList1</Q uoteList> <Q uoteList>TestList3</Q uoteList> </Q uoteLists> </G etListing_Response_1> </Body > </E nv elope>

Attribute QuoteLists

Description Contains a listing of all QuoteLists that belong to the specified user.

30.6

Working with Instruments

The following operations demonstrate how to add or remove RICs and FIDs to the QuoteList.

30.6.1 Add RICs and FIDs (AddRICsFIDs_Request_1)

This operation allows you to add additional RICs with defined FID fields. The example below shows how to add two RICs (IBM.N and CSC.O) and three FIDs for them (CURRENCY, TRDPRC_1 and UNIT). XSD
XSD: http://api.rkd.reuters.com/schemas/Q uoteLists_1.xsd

XML Sample Request - Add RICs and FIDs

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/Q uoteLists_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/Q uoteLists_1/ A ddRIC sF IDs_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <A ddRIC sF IDs_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/Q uoteLists_1"> <listN ame>TestList</listN ame> <RIC s> <RIC >IBM .N </RIC > <RIC >C S C .O </RIC > </RIC s> <F IDs> <F ID>C U RRE N C Y</F ID> <F ID>TRDP RC _1</F ID> <F ID>U N IT</F ID> </F IDs> </A ddRIC sF IDs_Request_1> </Body > </E nv elope>

Attribute listName RICs FIDs

Description The list that instruments should be added to. A list of additional instrument(s) that will be added to the List. The FID represents a data field that will be associated to each of the RICs in the RICs node. Each Field

Quote Lists

591

object will contain information such as field name, value, data type and display hint that will be returned whenever that RIC is queried. Note: The value prior to/in the company name FID indicates the (designed) delay in the quote data. For example: "D15|Microsoft" says that the delay in the quote data for Microsoft is 15 minutes. XML Sample Response - Add RICs and FIDs
<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader> <a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" s:mustU nderstand="1"> ttp://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/ http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/Q uoteLists_1/A ddRIC sF IDs_1_Reply </a:A ction> <a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <A ddRIC sF IDs_Response_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/Q uoteLists_1"> <A ddRIC sF IDsResult> <ItemResponse> <Item xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/Q uotesC ommon"> <RequestKey N ame="IBM .N " S erv ice="" /> <Q oS > <TimelinessInfo Timeliness="U N S P E C IF IE D" TimeInfo="0" /> <RateInfo Rate="U N S P E C IF IE D" TimeInfo="0" /> </Q oS > <S tatus> <S tatusM sg>O K</S tatusM sg> <S tatusC ode>0</S tatusC ode> </S tatus> <F ields> <F ield DataTy pe="U tf8S tring" N ame="C U RRE N C Y" > <U tf8S tring>840</U tf8S tring> </F ield> <F ield DataTy pe="Double" N ame="TRDP RC _1" > <Double>94.12</Double> </F ield> <F ield DataTy pe="U tf8S tring" N ame="BQ O S " > <U tf8S tring>0</U tf8S tring> </F ield> <F ield DataTy pe="U tf8S tring" N ame="P Q O S " > <U tf8S tring>RT</U tf8S tring> </F ield> <F ield DataTy pe="Int32" N ame="M S G _TYP E " > <Int32>0</Int32> </F ield> <F ield DataTy pe="Int32" N ame="RE C _S TA TU S " > <Int32>0</Int32> </F ield> </F ields> </Item> <Item xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/Q uotesC ommon"> <RequestKey N ame="C S C O .O " S erv ice="" /> <Q oS > <TimelinessInfo Timeliness="RE A LTIM E " TimeInfo="0" /> <RateInfo Rate="TIC K_BY_TIC K" TimeInfo="0" /> </Q oS > <S tatus> <S tatusM sg>O K</S tatusM sg> <S tatusC ode>0</S tatusC ode> </S tatus> <F ields> <F ield DataTy pe="Double" N ame="TRDP RC _1"> <Double>0</Double> </F ield> <F ield DataTy pe="U tf8S tring" N ame="C U RRE N C Y"> <U tf8S tring>U S D</U tf8S tring> </F ield> <F ield DataTy pe="U tf8S tring" N ame="BQ O S "> <U tf8S tring>0</U tf8S tring> </F ield> <F ield DataTy pe="U tf8S tring" N ame="P Q O S "> <U tf8S tring>RT</U tf8S tring> </F ield> <F ield DataTy pe="U tf8S tring" N ame="C oncreteS erv ice">

592

TRKD API Developer's Guide

<U tf8S tring>F D3</U tf8S tring> </F ield> <F ield DataTy pe="Int32" N ame="M S G _TYP E "> <Int32>0</Int32> </F ield> <F ield DataTy pe="Int32" N ame="RE C _S TA TU S "> <Int32>0</Int32> </F ield> </F ields> </Item> </ItemResponse> </A ddRIC sF IDsResult> </A ddRIC sF IDs_Response_1> </Body > </E nv elope>

Attribute Item RequestKey QoS

Description Each instrument listed in the request is returned in its own Item node containing: RequestKey, QoS, Status, Fields (FIDs). See below for description of each. Contains the instrument name and the Service (data source) that provides the feed. The Service will have a value only if its not the default data source. Note: Each TRKD user ID is permissioned with only one Quality of Service - either Real-time or Delayed data. The Quote schema does provide alternate Qualities of Service (Desired and Worst Acceptable). These should be ignored for now. The TRKD infrastructure may utilize these capabilities in a future release. Should you require both real-time and delayed data, Thomson Reuters will provide you with two IDs, each permissioned with the relevant QoS. Is used to represent the desired quality of service. Quality of Service is a categorical method of classifying traffic into separate tiers to provide differentiated services within a network. Note that a user will only receive the QoS that he/she is permissioned for. Contains the following Attribute(s): TimelinessInfo: Timeliness may be one of the following types: REALTIME - No delay is applied to the data. DELAYED - The data is delayed by the number of whole seconds specified in the TimeInfo attribute. DELAYED_UNKNOWN - A fixed delay (such as 60 seconds) is applied to the data. Valid only in responses, not requests. UNSPECIFIED - In QoS, use this value to request the most timely data allowed by the client's permissions. In WorstQoS, use this value to indicate that any timeliness is acceptable. RateInfo: The actual rate of data as specified by the Rate. Rate may have one of the following values: TICK_BY_TICK - The data is updated on the server with every tick. JIT_CONFLATED - "Just in time" conflation is applied to the data before it reaches the server's cache. TIME_CONFLATED - Time-based conflation is applied to the data before it reaches the server's cache, in cycles of a duration specified in milliseconds in TimeInfo. PERIODIC_REFRESH - The data is updated on the server by a periodic refresh mechanism (e.g., a "pull"), at periods specified in milliseconds in TimeInfo. UNSPECIFIED - In QoS, this value corresponds with data being updated as often as possible. In WorstQoS, this value indicates that the update method is not critical. Status is used to convey the state of an Item. Status is present in each Item node. Status may contain source-specific messages such as a detailed error message, back-end error ID, or both. The Field represents a data field (FID) associated to RICs during QuoteList creation or through the Add RICs and FIDs method. Each Field object contains information such as field name, value, data type and display hint. Display hints suggest how the data is to be displayed: decimal, fraction, date, or date time, and so on.

Status Fields

30.6.2 Remove RICs and FIDs (RemoveRICsFIDs_Request_1)

This operation enables you to remove added instruments from an existing quote list.

Quote Lists

593

XSD
XSD: http://api.rkd.reuters.com/schemas/Q uoteLists_1.xsd

XML Sample Request - Remove RICs with FIDs

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/Q uoteLists_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/Q uoteLists_1/ Remov eRIC sF IDs_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <Remov eRIC sF IDs_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/Q uoteLists_1"> <listN ame>TestList</listN ame> <RIC s> <RIC >C S C O .O </RIC > </RIC s> <F IDs> <F ID>U N IT</F ID> </F IDs> </Remov eRIC sF IDs_Request_1> </Body > </E nv elope>

Attribute listName RICs FIDs

Description The list that instruments should be removed from. A list of instrument(s) that will be removed from the List. This method allows you to remove a specific or multiple FIDs currently under a RIC. The FID represents a data field that will be associated to each of the RICs in the RICs node. Each Field object will contain information such as field name, value, data type and display hint that will be returned whenever that RIC is queried. Note: The value prior to/in the company name FID indicates the (designed) delay in the quote data. For example: "D15|Microsoft" says that the delay in the quote data for Microsoft is 15 minutes.

XML Sample Response - Remove RICs and FIDs

<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader> <a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" s:mustU nderstand="1"> ttp://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/ http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/Q uoteLists_1/A ddRIC sF IDs_1_Reply </a:A ction> <a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <Remov eRIC sF IDs_Response_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/Q uoteLists_1"> <Remov eRIC sF IDsResult> <ItemResponse> <Item xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/Q uotesC ommon"> <RequestKey N ame="IBM .N " S erv ice="" /> <Q oS > <TimelinessInfo Timeliness="U N S P E C IF IE D" TimeInfo="0" /> <RateInfo Rate="U N S P E C IF IE D" TimeInfo="0" /> </Q oS > <S tatus> <S tatusM sg>O K</S tatusM sg> <S tatusC ode>0</S tatusC ode> </S tatus> <F ields> <F ield DataTy pe="U tf8S tring" N ame="C U RRE N C Y"> <U tf8S tring>U S D</U tf8S tring> </F ield>

594

TRKD API Developer's Guide

<F ield DataTy pe="Double" N ame="TRDP RC _1"> <Double>116.4</Double> </F ield> <F ield DataTy pe="U tf8S tring" N ame="BQ O S "> <U tf8S tring>0</U tf8S tring> </F ield> <F ield DataTy pe="U tf8S tring" N ame="P Q O S "> <U tf8S tring>RT</U tf8S tring> </F ield> <F ield DataTy pe="Int32" N ame="M S G _TYP E "> <Int32>0</Int32> </F ield> <F ield DataTy pe="Int32" N ame="RE C _S TA TU S "> <Int32>0</Int32> </F ield> </F ields> </Item> </ItemResponse> </Remov eRIC sF IDsResult> </Remov eRIC sF IDs_Response_1> </Body > </E nv elope>

30.7

Get Simple Data

For cases when all you need is a way to retrieve a single or multiple RICs with the ability to specify fields (FIDs) GetSimpleData method is what you need. This method does not use QuoteLists assigned to any individual but rather just retrieves the RICs and FIDs without saving anything. Note: Ability to view all the fields (FIDs) depends on clients entitlements. XSD
XSD: http://api.rkd.reuters.com/schemas/Q uoteLists_1.xsd

XML Sample Request - Get Simple Data

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/Q uoteLists_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/Q uoteLists_1/ G etS impleData_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token}</Token> </A uthorization> </H eader> <Body > <G etS impleData_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/Q uoteLists_1"> <RIC s> <RIC >IBM .N </RIC > <RIC >V O D.L</RIC > </RIC s> <F IDs> <F ID>C U RRE N C Y</F ID> <F ID>TRDP RC _1</F ID> <F ID>U N IT</F ID> </F IDs> </G etS impleData_Request_1> </Body > </E nv elope>

Attribute RICs

Description The RIC (Reuters Instrument Code) that identifies the instrument. You can enter multiple RICs, each in its own RIC tag.

Quote Lists

595

FIDs

FID, or Field Identifier, contains a list of fields you want to show in the response for the instrument. Note: Ability to view all the fields (FIDs) depends on clients entitlements. The value prior to/in the company name FID indicates the (designed) delay in the quote data. For example: "D15|Microsoft" says that the delay in the quote data for Microsoft is 15 minutes.

XML Sample Response - Get Simple Data

<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader> <a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" s:mustU nderstand="1">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/ Q uoteLists_1/G etS impleData_1_Reply </a:A ction> <a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etS impleData_Response_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/Q uoteLists_1"> <S impleDataResult> <ItemResponse> <Item xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/Q uotesC ommon"> <RequestKey N ame="IBM .N " S erv ice="" /> <Q oS > <TimelinessInfo Timeliness="RE A LTIM E " TimeInfo="0" /> <RateInfo Rate="TIC K_BY_TIC K" TimeInfo="0" /> </Q oS > <S tatus> <S tatusM sg>O K</S tatusM sg> <S tatusC ode>0</S tatusC ode> </S tatus> <F ields> <F ield DataTy pe="Double" N ame="TRDP RC _1"> <Double>122.85</Double> </F ield> <F ield DataTy pe="U tf8S tring" N ame="C U RRE N C Y"> <U tf8S tring>U S D</U tf8S tring> </F ield> <F ield DataTy pe="U tf8S tring" N ame="BQ O S "> <U tf8S tring>0</U tf8S tring> </F ield> <F ield DataTy pe="U tf8S tring" N ame="P Q O S "> <U tf8S tring>RT</U tf8S tring> </F ield> <F ield DataTy pe="U tf8S tring" N ame="C oncreteS erv ice"> <U tf8S tring>F D3</U tf8S tring> </F ield> <F ield DataTy pe="Int32" N ame="M S G _TYP E "> <Int32>0</Int32> </F ield> <F ield DataTy pe="Int32" N ame="RE C _S TA TU S "> <Int32>0</Int32> </F ield> </F ields> </Item> <Item xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/Q uotesC ommon"> <RequestKey N ame="V O D.L" S erv ice="" /> <Q oS > <TimelinessInfo Timeliness="RE A LTIM E " TimeInfo="0" /> <RateInfo Rate="TIC K_BY_TIC K" TimeInfo="0" /> </Q oS > <S tatus> <S tatusM sg>O K</S tatusM sg> <S tatusC ode>0</S tatusC ode> </S tatus> <F ields> <F ield DataTy pe="Double" N ame="TRDP RC _1"> <Double>158.3</Double> </F ield> <F ield DataTy pe="U tf8S tring" N ame="C U RRE N C Y"> <U tf8S tring>G Bp</U tf8S tring> </F ield> <F ield DataTy pe="U tf8S tring" N ame="BQ O S "> <U tf8S tring>0</U tf8S tring> </F ield>

596

TRKD API Developer's Guide

<F ield DataTy pe="U tf8S tring" N ame="P Q O S "> <U tf8S tring>RT</U tf8S tring> </F ield> <F ield DataTy pe="U tf8S tring" N ame="C oncreteS erv ice"> <U tf8S tring>F D3</U tf8S tring> </F ield> <F ield DataTy pe="Int32" N ame="M S G _TYP E "> <Int32>0</Int32> </F ield> <F ield DataTy pe="Int32" N ame="RE C _S TA TU S "> <Int32>0</Int32> </F ield> </F ields> </Item> </ItemResponse> </S impleDataResult> </G etS impleData_Response_1> </Body > </E nv elope>

Note: If one of the RICs is invalid, the response will return an error indicating the number of RICs that failed. Please remove all invalid RICs and try the request again. Attribute Item RequestKey QoS Description Each instrument listed in the request is returned in its own Item node containing: RequestKey, QoS, Status, Fields (FIDs). See below for description of each. Contains the instrument name and the Service (data source) that provides the feed. The Service will have a value only if its not the default data source. Note: Each TRKD user ID is permissioned with only one Quality of Service - either Real-time or Delayed data. The Quote schema does provide alternate Qualities of Service (Desired and Worst Acceptable). These should be ignored for now. The TRKD infrastructure may utilize these capabilities in a future release. Should you require both real-time and delayed data, Thomson Reuters will provide you with two IDs, each permissioned with the relevant QoS. Is used to represent the desired quality of service. Quality of Service is a categorical method of classifying traffic into separate tiers to provide differentiated services within a network. Note that a user will only receive the QoS that he/she is permissioned for. Contains the following Attribute(s): TimelinessInfo: Timeliness may be one of the following types: REALTIME - No delay is applied to the data. DELAYED - The data is delayed by the number of whole seconds specified in the TimeInfo attribute. DELAYED_UNKNOWN - A fixed delay (such as 60 seconds) is applied to the data. Valid only in responses, not requests. UNSPECIFIED - In QoS, use this value to request the most timely data allowed by the client's permissions. In WorstQoS, use this value to indicate that any timeliness is acceptable. RateInfo: The actual rate of data as specified by the Rate. Rate may have one of the following values: TICK_BY_TICK - The data is updated on the server with every tick. JIT_CONFLATED - "Just in time" conflation is applied to the data before it reaches the server's cache. TIME_CONFLATED - Time-based conflation is applied to the data before it reaches the server's cache, in cycles of a duration specified in milliseconds in TimeInfo. PERIODIC_REFRESH - The data is updated on the server by a periodic refresh mechanism (e.g., a "pull"), at periods specified in milliseconds in TimeInfo. UNSPECIFIED - In QoS, this value corresponds with data being updated as often as possible. In WorstQoS, this value indicates that the update method is not critical. Status is used to convey the state of an Item. Status is present in each Item node. Status may contain source-specific messages such as a detailed error message, back-end error ID, or both. The Field represents a data field (FID) associated to RICs during QuoteList creation or through the Add RICs and FIDs method. Each Field object contains information such as field name, value, data type and display hint. Display hints suggest how the data is to be displayed: decimal, fraction, date, or date time, and so on.

Status Fields

Quote

597

chapter 31

Quote

The Quotes service enables you to retrieve a snap quote or a quote chain. TRKD API delivers snap prices only; you may not deliver streaming prices using TRKD API. By default TRKD provides delayed stock prices. However, if your organization has an agreement within an exchange to provide its prices in real-time, then real-time snap prices can be delivered by TRKD for that exchange. Note: Up to 75 instruments and 25 fields may be included in each request.

31.1

Quote Performance
By default, the TRKD API Quote service returns most fields associated with a RIC. This is useful when you are trying to understand the breadth of data available, but it can be wasteful of network bandwidth if you do not limit the fields you request when you implement the definitive version of your solution. TRKD API lets you choose exactly which fields you retrieve when you request a quote for a specific RIC. We strongly recommend that you use this feature in order to decrease response times and bandwidth requirements. How to make a request? The Fields element in RetrieveItem_3 can be used to specify a colon-delimited list of fields you want to retrieve. When you do so, it is necessary to use the Scope attribute on the ItemRequest element to specify 'List'. Without setting the Scope attribute to 'List', the contents of the Fields parameter will be ignored by TRKD API. XML Sample Request
<Retriev eItem_Request_3 xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema" xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/Q uotes_1"> <ItemRequest Scope="List"> <Fields>C F_NA M E:C F_LA ST :C F_DA T E:C F_T IM E</Fields> <RequestKey N ame="M S F T.O " N ameTy pe="RIC "/> </ItemRequest> </Retriev eItem_Request_3>

How to determine which fields to display? Because each asset class has different fields which are important, you need to first determine the asset class of the instrument you are requesting. This can be found by looking up the RIC in the Search service and requesting the AssetCategoryName field.

This can also be found by requesting the RECORDTYPE field in the Quote service:

598

TRKD API Developer's Guide

The main RecordType values and the asset classes they map to are listed below: RecordType 16 17 22 24 30 33 34 38 56 65 72 80 81 97 98 99 101 102 104 112 113 114 115 117 118 120 130 134 136 146 168 178 194 198 200 209 210 211 214 216 225 241 Asset Class Indices Indices Indices Forex Economics Bonds Futures Indices Bonds Bonds Bonds Bonds Bonds Warrant Futures Options Market Stats Indices Equities Indices Equities Futures Options Market Stats Indices Equities Futures Indices Options Futures Futures Futures Futures Indices Futures FX Futures Options Indices FX Equities FX

Quote

599

242 248 255

Futures Futures FX

Once you have determined the asset class for a RIC, then you can find the main fields for each asset class here - https:// customers.reuters.com/a/support/paz/pazDocs.aspx?dId=436066. There may well be other fields which are important to your clients, and each exchange has a different range of fields available. The guide found at the link provided above is intended to be an indicative guide only.

31.2

Conflation
Thomson Reuters Knowledge Direct utilises a three second conflated feed as a source of its quotes data. This means that every three seconds the Thomson Reuters Knowledge Direct systems receive an update. This feed is used to supply data to TRKD delayed servers and provide real-time snap responses. Clients should be aware of this configuration aspect of the product in case there are differences in data highlighted when compared to alternate sources of the same data. Note: The conflation on data on Thomson Reuters Knowledge API is 3 seconds for non-trade data (bid/ask, etc.).

31.3

Quote Data
An instrument is identified by a RIC (Reuters Instrument Code). Each RIC has a series of attached fields that contain different items of information (for example, todays high price, traded volume, etc.). Not all instruments contain the same fields, and the fields are not always returned in the same order; this depends on the type of financial instrument (for example, stock, index, FX rate, fund, etc.). Each field has a label that identifies it and it is called a Field Identifier or FID. Since you are parsing the data returned in XML format, it is essential that your program finds the required values by using these identifiers, not by searching for the third or fourth field (for example), because over time Thomson Reuters may add extra fields or change the field order. Note: The value prior to/in the company name FID indicates the (designed) delay in the quote data. For example: "D15| Microsoft" says that the delay in the quote data for Microsoft is 15 minutes. Full details of RICs, and the fields (FIDs) that accompany them, are provided in the TRKD Data Guide.

31.4

Quote Chain Data

A quote chain provides summary price information for a series of related instruments, such as all the constituents of the FTSE 100 Index, or the highest net gainers of the day on NASDAQ. Most quote chain RICs begin with "0#". The number of instruments in a chain, the order of instruments and the position of any particular instrument, are not always constant and cannot be relied upon. They are often modified to reflect changing market conditions and may also differ between markets. Also, as with quotes, when you are parsing XML data you must search for specific field identifiers within the chain to find the required information.

31.5

Company Background Information

Many stocks have associated background information for the company, including details such as its type of business, its headquarters address, and its summarized financial results. Typically, the background RIC for this information has a suffix ending with "B2" (for example, the background RIC for the stock IBM.N is IBM.NB2). Where a company is traded on different exchanges, the background RIC will be associated with the main exchange only. If necessary, you can find the background RIC by requesting the stock RIC, and the background RIC is returned in the BKGD_REF field.

600

TRKD API Developer's Guide

31.6

Authentication/Authorization, Service Endpoint, and Required Headers

Authorization All requests to Thomson Reuters Quote web service require an authorization token. For details, see section Understanding Authentication Tokens. Authentication Thomson Reuters Quote uses Reuters impersonation tokens for each effective user. In this case, Thomson Reuters must create each user before your application authenticates them. Unmanaged effective users are not supported in Thomson Reuters Quote. For additional information on creating a Service Token, see section Creating a Token.

Service Endpoint Quote Endpoint

http://api.rkd.reuters.com/api/2006/05/01/Q uotes_1.sv c

Required Header Required HTTP Headers

P O S T /api/2006/05/01/Q uotes_1.sv c H TTP /1.1 C ontent-Ty pe: application/soap+xml H ost: api.rkd.reuters.com C ontent-Length: [length]

31.7

WSDL
WSDL:
http://api.rkd.reuters.com/schemas/w sdl/Q uotes_1_H ttpA ndRKDToken.w sdl

31.8

Retrieving Quotes (RetrieveItem_Request_3)

You can use the RetrieveItem_Request_3 operation to specify information you want to see in the response. XSD
XSD: http://api.rkd.reuters.com/schemas/Q uotes_1.xsd

The following is a basic example that shows how to use the RetrieveItem_Request_3 operation to retrieve information for one instrument without filtering on returned fields. XML Sample Request - Get Quotes
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/Q uotes_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/Q uotes_1/ Retriev eItem_3</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <Retriev eItem_Request_3 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/Q uotes_1">

Quote

601

<ItemRequest S cope="A ll" > <RequestKey N ame="M S F T.O "/> </ItemRequest> </Retriev eItem_Request_3> </Body > </E nv elope>

Attribute ItemRequest

Description Specifies request attributes to retrieve a specific or multiple instruments. ItemRequest attributes are listed below. Contains the following Attribute(s): IncludeHints: Setting this attribute to True will display hint attribute for each field in the response on how the data is displayed: decimal, fraction, date, or date time, and so on. This value is False by default. ExpandChain: By default the value is true which results in showing all data (Fields) for each of the Instruments in the chain. If the value is set to false only data about the chain will be sent with a listing of all Instruments contained but without detailed information about them. Scope: You can indicate what fields you want returned for instruments listed in RequestKey by entering one of the following options into the scope: All - Is a default value that returns all the fields. AllExcept - Excludes the fields entered into the Fields attribute. Note: Currently this option does not work. List - Returns only the fields indicated in Fields attribute. Note: Each symbol specified has to have the exchange (example: TRIN.O). Symbol format should be as follows [Sy mbol]. [Ex change].

Fields

(optional) A string containing the names of the desired fields, separated by a colon (no spaces). The Quotes service returns this set of fields for each Request Key in ItemRequest. The service permits the specification of an additional namespace and user-defined data type in this string. Specifies item name and service name.

RequestKey

Note: The quote response (RetrieveItem_3) may say that the data is realtime when you are only permissioned for delayed data. It is a known deficiency of the Thomson Reuters Knowledge API, and it will be fixed in the near future. The table below explains Hint display values: Display Format Integer String Fraction Decimal Date as MM DDD YYYY Time as 00:00 Time as 00:00:00 Hint Value 0 64 1 through 8, indicating one of the following base fractions: 1, 1/2, 1/4, 1/16, 1/32, 1/128, 1/256. 16 through 25, indicating the number of decimal places. 16 indicates zero decimal places, 17 indicates one decimal place, and so on up to nine decimal. 258 259 260

For example: if "Hint"=260 then Field value is time in format 00:00:00. XML Sample Response - Get Quotes
<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader> <a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" s:mustU nderstand="1"> ttp://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/ http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/Q uotes_1/Retriev eItem_3_Reply </a:A ction> <a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <Retriev eItem_Response_3 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/Q uotes_1">

602

TRKD API Developer's Guide

<ItemResponse> <Item> <RequestKey N ame="M S F T.O "/> <S tatus> <S tatusM sg>O K</S tatusM sg> <S tatusC ode>0</S tatusC ode> </S tatus> <F ields> <F ield xmlns="http://schemas.reuters.com/ns/2006/04/14/rmds/w ebserv ices/omm" DataTy pe="Int32" N ame="P RO D_P E RM " > <Int32>74</Int32> </F ield> <F ield xmlns="http://schemas.reuters.com/ns/2006/04/14/rmds/w ebserv ices/omm" N ame="A S K_M M ID1" > <U tf8S tring> A DF </U tf8S tring> </F ield> <F ield xmlns="http://schemas.reuters.com/ns/2006/04/14/rmds/w ebserv ices/omm" > <Int32>66</Int32> </F ield> <F ield xmlns="http://schemas.reuters.com/ns/2006/04/14/rmds/w ebserv ices/omm" N ame="DS P LY_N A M E " > <U tf8S tring>M IC RO S O F T C P </U tf8S tring> </F ield> <F ield xmlns="http://schemas.reuters.com/ns/2006/04/14/rmds/w ebserv ices/omm" > <Double>0</Double> </F ield> <F ield xmlns="http://schemas.reuters.com/ns/2006/04/14/rmds/w ebserv ices/omm" N ame="RDN _E XC H ID" > <U tf8S tring>0</U tf8S tring> </F ield> <F ield xmlns="http://schemas.reuters.com/ns/2006/04/14/rmds/w ebserv ices/omm" <Double>29.89</Double> </F ield> ... </F ields> </Item> </ItemResponse> </Retriev eItem_Response_3> </Body > </E nv elope>

DataTy pe="U tf8S tring"

DataTy pe="Int32" N ame="RDN DIS P LA Y"

DataTy pe="U tf8S tring"

DataTy pe="Double" N ame="P RC _V O LTY"

DataTy pe="U tf8S tring"

DataTy pe="Double" N ame="TRDP RC _1" >

Attribute Item RequestKey Status Fields

Description Instrument listed in the ItemRequest will be returned in its own Item node containing: RequestKey, Status, Fields (FIDs) for each Instrument. See below for description of each. Contains the instrument name and the Service (data source) that provides the feed. The Service will have a value only if its not the default data source. Status is used to convey the state of an Item. Status is present in each Item node. Status may contain source-specific messages such as a detailed error message, back-end error ID, or both. The Field represents a data field (FID) associated to RICs (Instruments). Each Field object contains information such as field name, value, data type and display hint. Display hints suggest how to display the data: decimal, fraction, date, or date time, and so on.

Get Quote Request with Multiple Instruments

Below is another basic example showing how to retrieve information on multiple instruments in the same request. XML Sample Request - Get Quotes with Multiple instruments
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/Q uotes_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/Q uotes_1/ Retriev eItem_3</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization>

Quote

603

</H eader> <Body > <Retriev eItem_Request_3 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/Q uotes_1"> <ItemRequest S cope="A ll" > <RequestKey Name="M SFT .O "/> <RequestKey Name="V O D.L"/> </ItemRequest> </Retriev eItem_Request_3> </Body > </E nv elope>

Get Quote Request with Fields specified

The control over what fields (information) are returned in the response is yours as well. In the request, you enter a colon delimited (':') names of fields and choose if you either want only those fields to be returned or excluded from the response. In the following example only the field NEWS is returned. The Quote service returns NEWS fields along with several mandatory response fields. XML Sample Request - Get Quotes with Specified Fields
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/Q uotes_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/Q uotes_1/ Retriev eItem_3</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <Retriev eItem_Request_3 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/Q uotes_1"> <ItemRequest> <Fields>BID:C F_BID</Fields> <RequestKey N ame="M S F T.O "/> </ItemRequest> </Retriev eItem_Request_3> </Body > </E nv elope>

Get Quote Request with Multiple ItemRequest

Use multiple ItemRequest elements to group instruments. This becomes useful if you want to specify different properties (Fields returned) for one group of instruments and not another. XML Sample Request - Get Quotes with Multiple ItemRequest Sections
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/rkd/2006/05/01/Q uotes_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/Q uotes_1/ Retriev eItem_3</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <Retriev eItem_Request_3 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/Q uotes_1"> <ItemRequest IncludeH ints="tr ue" > <F ields>N E WS </F ields> <RequestKey N ame="M S F T.O "/> </ItemRequest> <ItemRequest Scope="A ll" > <RequestKey N ame="IBM .N "/>

604

TRKD API Developer's Guide

</ItemRequest> </Retriev eItem_Request_3> </Body > </E nv elope>

Note: The only possible value for NameType attribute is RIC.

31.9

Retrieving Quote Chain

Retrieving a Quote chain is as easy as entering the chain symbol (chain symbols usually start with 0#) instead of a regular RIC. However, if a chain is very long, the Quote service brakes the chain into multiple parts. The immediate response has only a part of the result with a link to the next part and so on. The following examples show how to retrieve the information and format of the reply. XSD
XSD: http://api.rkd.reuters.com/schemas/Q uotes_1.xsd

XML Sample Request - Get Quote Chain

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/Q uotes_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/Q uotes_1/ Retriev eItem_3</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <Retriev eItem_Request_3 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/Q uotes_1"> <ItemRequest S cope="A ll"> <RequestKey N ame="0#C S C O .O "/> </ItemRequest> </Retriev eItem_Request_3> </Body > </E nv elope>

Attribute ItemRequest

Description Specifies request attributes to retrieve a specific or multiple instruments. ItemRequest attributes include: Contains the following Attribute(s): IncludeHints: Setting this attribute to True will display hints on how to display the data for each Field: decimal, fraction, date, or date time, and so on. This value is False by default. ExpandChain: By default the value is true which results in showing all data (Fields) for each of the Instruments in the chain. If the value is set to false only data about the chain will be sent with a listing of all Instruments contained but without detailed information about them. Scope: You can indicate what fields you want returned for instruments listed in RequestKey by entering one of the following options into the scope: All - Is a default value that returns all the fields. AllExcept - Exclude the fields entered into the Fields attribute. Note: Currently this option does not work. List - Returns only the fields indicated in Fields attribute. Note: Each symbol specified has to have the exchange (example: TRIN.O). Symbol format should be as follows [Sy mbol]. [Ex change].

Fields

(optional) A string containing the names of the desired fields, separated by a colon (no spaces). This set of fields is returned for each RequestKey in the ItemRequest. The service permits the specification of an additional namespace and user-defined data type in this string. Specifies item name and service name.

RequestKey

Quote

605

The table below explains Hint display values: Display Format Integer String Fraction Decimal Date as MM DDD YYYY Time as 00:00 Time as 00:00:00 Hint Value 0 64 1 through 8, indicating one of the following base fractions: 1, 1/2, 1/4, 1/16, 1/32, 1/128, 1/256. 16 through 25, indicating the number of decimal places. 16 indicates zero decimal places, 17 indicates one decimal place, and so on up to nine decimal. 258 259 260

For example: if "Hint"=260 then Field value is time in format 00:00:00. XML Sample Response - Get Quote Chain
<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader> <a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" s:mustU nderstand="1"> ttp://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/ http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/Q uotes_1/Retriev eItem_3_Reply </a:A ction> <a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <Retriev eItem_Response_3 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/Q uotes_1"> <ItemResponse> <Item> <RequestKey N ame="0#C S C O .O "/> <S tatus> <S tatusM sg>O K</S tatusM sg> <S tatusC ode>0</S tatusC ode> </S tatus> <F ields> <F ield xmlns="http://schemas.reuters.com/ns/2006/04/14/rmds/w ebserv ices/omm" DataTy pe="Int32" N ame="P RO D_P E RM " > <Int32>3056</Int32> </F ield> <F ield xmlns="http://schemas.reuters.com/ns/2006/04/14/rmds/w ebserv ices/omm" DataTy pe="Int32" N ame="RDN DIS P LA Y" > <Int32>200</Int32> </F ield> <F ield xmlns="http://schemas.reuters.com/ns/2006/04/14/rmds/w ebserv ices/omm" DataTy pe="U tf8S tring" N ame="RO W80_1" > <U tf8S tring /> </F ield> <F ield xmlns="http://schemas.reuters.com/ns/2006/04/14/rmds/w ebserv ices/omm" DataTy pe="U tf8S tring" N ame="DS P LY_N A M E " > <U tf8S tring>LV L2_M M _LN K_LIS T</U tf8S tring> </F ield> <F ield xmlns="http://schemas.reuters.com/ns/2006/04/14/rmds/w ebserv ices/omm" DataTy pe="U tf8S tring" N ame="RDN _E XC H ID" > <U tf8S tring>43</U tf8S tring> </F ield> <F ield xmlns="http://schemas.reuters.com/ns/2006/04/14/rmds/w ebserv ices/omm" DataTy pe="Int32" N ame="RE F _C O U N T" > <Int32>14</Int32> </F ield> </F ields> <C hildItem N ame="C S C O .O " > <F ields> <F ield xmlns="http://schemas.reuters.com/ns/2006/04/14/rmds/w ebserv ices/omm" DataTy pe="Int32" N ame="P RO D_P E RM " > <Int32>74</Int32> </F ield> <F ield xmlns="http://schemas.reuters.com/ns/2006/04/14/rmds/w ebserv ices/omm" DataTy pe="U tf8S tring" N ame="A S K_M M ID1" > <U tf8S tring> P S E </U tf8S tring> </F ield> <F ield xmlns="http://schemas.reuters.com/ns/2006/04/14/rmds/w ebserv ices/omm" DataTy pe="Int32" N ame="RDN DIS P LA Y" > <Int32>66</Int32> </F ield> <F ield xmlns="http://schemas.reuters.com/ns/2006/04/14/rmds/w ebserv ices/omm" DataTy pe="U tf8S tring" N ame="DS P LY_N A M E " > <U tf8S tring>C IS C O S YS TE M S </U tf8S tring> </F ield> <F ield xmlns="http://schemas.reuters.com/ns/2006/04/14/rmds/w ebserv ices/omm" DataTy pe="Double" N ame="P RC _V O LTY" >

606

TRKD API Developer's Guide

<Double>0</Double> </F ield> ... </F ields> </C hildItem> <C hildItem N ame="C S C O .O T" > ... </C hildItem> ... </Item> </ItemResponse> </Retriev eItem_Response_3> </Body > </E nv elope>

Attribute Item RequestKey Status Fields

ChildItem

Description Instrument listed in the ItemRequest will be returned in its own Item node containing: RequestKey, Status, Fields (FIDs) for each Instrument. See below for description of each. Contains the instrument name and the Service (data source) that provides the feed. The Service will have a value only if its not the default data source. Status is used to convey the state of an Item. Status is present in each Item node. Status may contain source-specific messages such as a detailed error message, back-end error ID, or both. The Field represents a data field (FID) associated to RICs (Instruments). Each Field object contains information such as field name, value, data type and display hint. Display hints suggest how the data is to be displayed: decimal, fraction, date, or date time, and so on. Each ChildItem represents a constituent of a chain (for example Item RIC .AV.O and constituent RIC MSFT.O).

Reference Information

607

chapter 32

Reference Information

The Reference Information service enables you to retrieve the input criteria used to search for broker research documents (see section Document Search for more details). You can also use this service to associate names with codes and to map local codes (as defined by the contributor) to global codes (as defined by Thomson Reuters). The following reference lists can be retrieved using this service: Category Contributor Country Currency Industry Language Region Contributor Subjects Research Subjects Research Purposes Disciplines Report Styles UIDs

32.1

Authentication/Authorization, Service Endpoint, and Required Headers

Authorization All requests to the Reference Information web service require an authorization token. For details, see section Understanding Authentication Tokens. Authentication Thomson Reuters Reference Information service uses Reuters impersonation tokens for each effective user. In this case, Thomson Reuters must create each user before your application authenticates them. Unmanaged effective users are not supported in Thomson Reuters Reference Information. For additional information on creating a Service Token, see section Creating a Token.

Service Endpoint Reference Information Endpoint

http://api.rkd.reuters.com/api/2008/01/12/RefInfo_1.sv c

Required Header Required HTTP Headers

P O S T api/2008/01/12/RefInfo_1.sv c H TTP /1.1 C ontent-Ty pe: application/soap+xml H ost: api.rkd.reuters.com C ontent-Length: [length]

32.2

WSDL
WSDL:

608

TRKD API Developer's Guide

http://api.rkd.reuters.com/schemas/w sdl/RefInfo_1_H ttpA ndRKDToken.w sdl

32.3

Understanding Reference Information Request

This section provides information on the codes used in Thomson Reuters Knowledge Direct API. These codes include: Global Codes Local Codes Set Codes UIDs Also, this section provides information on the reference lists can be retrieved using the Reference Information service: Category Contributor Country Currency Industry Language Region Contributor Subjects Research Subjects Research Purposes Disciplines Report Styles

32.3.1 Understanding Reuters Knowledge Direct API Codes

The Thomson Reuters Knowledge Direct API uses two type of codes that are defined by either Thomson Reuters (global codes) or the contributor (local codes) that uniquely identify reference records within a particular reference type. You use set codes to designate the specific local codes you want to use. In addition, Thomson Reuters maintains numeric Universal Identifiers (UIDs) to uniquely identify reference records across all reference types.

32.3.1.1 Global Codes

Global codes are defined by Thomson Reuters and uniquely identify reference records within a particular reference type. Your application can use these codes for document searches across multiple contributors where local codes would have no meaning. They are also used for single contributor document searches when a particular contributor does not use local codes for a particular reference type. Although global codes are different from UIDs, the categorization reference types (categorization subject, discipline, reason, and report style) use the UID as the global code since this data is supplied by Thomson Reuters.

32.3.1.2 Local Codes

Local codes are defined by a contributor, and uniquely identify reference records within a particular reference type. These codes may be used for document searches for the contributor. The reference types supporting local codes are as follows: Author/analyst Country Currency Industry Region Subject Contributors may supply local codes for all, some, or none of the reference types. All other reference types support global codes only. Note: The Thomson Reuters Knowledge Direct API does not support searching for local country or currency codes. Also the

Reference Information

609

API always returns global author/analyst codes even if the application searches used local codes.

32.3.1.3 Set Codes

A set code is a contributor specific string used to determine whether the query is using global or local codes. Set codes generally have the form "XX#12345" where "XX" is an abbreviation for the contributor name, and "12345" is the contributor UID. For example, the set code "MX#001" represents Thomson Reuters, and is the set code used for global codes. If you have the proper entitlements, you can determine set codes for a particular contributor using the <contributorSearchCriterion/> element of the <GetReferenceListsRequest>.

32.3.1.4 UIDs
UIDs are numbers consisting of a 1 or 2-digit reference type followed by a 7-digit record number. The currently defined reference types are described in the following table. Code 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 Description Contributors (leading 0's are never included; for example, a typical contributor UID is "12345", not "00012345") Subject Category Country Currency Region N/A N/A Industry Issuer/Parent Company (Symbology) Language Subject (Categorization) Discipline (Categorization) Reason (Categorization) Report Style (Categorization)

32.3.2 Countries
During the contribution process, contributors tag documents with country information. You can use the Reference Information service to generate country information for use in a document search. The following sample code displays how to generate country information. This request returns both the local and global country codes: XML Sample Request - Generating Country Information
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2008/01/12/RefInfo_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/RefInfo_1/ G etInfo_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > G etInfo_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/RefInfo_1">

610

TRKD API Developer's Guide

<genReq> <country S earchC riterion details ="max" sor tBy ="by N ame" sor tO r der ="asc" > <country By C ountry C riterion> <setC odeC riterion/> </country By C ountry C riterion> </country S earchC riterion> <genReq /> </G etInfo_Request_1> </Body > </E nv elope>

Attribute details sortBy sortOrder

Description The amount and type of data returned. Choose from "min", "max","uidOnly", "docsearch", or "default". Choose from "byName", "byLocalCode", or "byGlobalCode". Choose from "asc" or "desc".

32.3.3 Currencies
During the contribution process, contributors tag documents with currency information. You can use the Reference Information service to generate a list of supported currencies. The following sample code displays how to retrieve currency information: XML Sample Request - Generating Currency Information
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2008/01/12/RefInfo_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/RefInfo_1/ G etInfo_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > G etInfo_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/RefInfo_1"> <genReq> <currency S earchC riterion details ="max" sor tBy ="by N ame" sor tO r der ="asc" <setC odeC riterion setC ode="[contr ibutor set code ]"/> </currency S earchC riterion> <genReq /> </G etInfo_Request_1> </Body > </E nv elope>

Attribute details sortBy sortOrder contributor set code

Description The amount and type of data returned. Choose from "min", "max","uidOnly", "docsearch", or "default". Choose from "byName", "byLocalCode", or "byGlobalCode". Choose from "asc" or "desc". Specifies the contributor codes to return (local codes). By default, this request returns Thomson Reuters (global) codes.

32.3.4 Industries
During the contribution process, contributors tag documents by industry. You can use the Reference Information service to generate a list of industries and codes for a contributor.

Reference Information

611

This request returns both the local and global industry codes. The following sample code displays how to generate a list of industries: XML Sample Request - Generating Industries Information
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2008/01/12/RefInfo_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/RefInfo_1/ G etInfo_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > G etInfo_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/RefInfo_1"> <genReq> <industry S earchC riterion details ="docsearch" sor tBy ="by N ame" sor tO r der ="asc" <setC odeC riterion setC ode="[contr ibutor set code ]"/> </industry S earchC riterion> <genReq /> </G etInfo_Request_1> </Body > </E nv elope>

Attribute details sortBy sortOrder contributor set code

Description The amount and type of data returned. Choose from "min", "max","uidOnly", "docsearch", or "default". Choose from "byName", "byLocalCode", or "byGlobalCode". Choose from "asc" or "desc". Specifies the contributor codes to return (local codes). By default, this request returns Thomson Reuters (global) codes.

32.3.5 Regions
During the contribution process, contributors tag documents by region. You can use the Reference Information service to generate a list of regions and codes for a contributor. This request returns both the local and global region codes. The following sample code displays how to generate a list of regions: XML Sample Request - Generating Regions Information
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2008/01/12/RefInfo_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/RefInfo_1/ G etInfo_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > G etInfo_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/RefInfo_1"> <genReq> <regionS earchC riterion details ="docsearch" sor tBy ="by N ame" sor tO r der ="asc" <setC odeC riterion setC ode="[contr ibutor set code ]"/> </regionS earchC riterion> <genReq /> </G etInfo_Request_1> </Body >

612

TRKD API Developer's Guide

</E nv elope>

Attribute details sortBy sortOrder contributor set code

Description The amount and type of data returned. Choose from "min", "max","uidOnly", "docsearch", or "default". Choose from "byName", "byLocalCode", or "byGlobalCode". Choose from "asc" or "desc". Specifies the contributor codes to return (local codes). By default, this request returns Thomson Reuters (global) codes.

32.3.6 Categories
During the contribution process, contributors tag documents by category. You can use the Reference Information service to generate a list of categories and codes for a contributor. This request returns both the local and global category codes. The following sample code displays how to generate a list of categories: XML Sample Request - Generating Categories Information
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2008/01/12/RefInfo_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/RefInfo_1/ G etInfo_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > G etInfo_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/RefInfo_1"> <genReq> <category S earchC riterion details ="docsearch" sor tBy ="by N ame" sor tO r der ="asc" <setC odeC riterion setC ode="[contr ibutor set code ]"/> </category S earchC riterion> <genReq /> </G etInfo_Request_1> </Body > </E nv elope>

Attribute details sortBy sortOrder contributor set code

Description The amount and type of data returned. Choose from "min", "max","uidOnly", "docsearch", or "default". Choose from "byName", "byLocalCode", or "byGlobalCode". Choose from "asc" or "desc". Specifies the contributor codes to return (local codes). By default, this request returns Thomson Reuters (global) codes.

32.3.7 Contributors
You can use the Reference Information service to generate a list of contributor information based on your entitlements. The list returned includes only contributors matching your document entitlements. That is, contributors of documents you can view/download. Note: The "alias" attribute in the returned data is the contributor's set code. The following sample code displays how to generate a list of contributors:

Reference Information

613

XML Sample Request - Generating Contributors Information

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2008/01/12/RefInfo_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/RefInfo_1/ G etInfo_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > G etInfo_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/RefInfo_1"> <genReq> <contributorS earchC riterion details ="docsearch" sor tBy ="by N ame" sor tO r der ="asc" <dsC tbC riterion/> </contributorS earchC riterion> <genReq /> </G etInfo_Request_1> </Body > </E nv elope>

Attribute details sortBy sortOrder

Description The amount and type of data returned. Choose from "min", "max","uidOnly", "docsearch", or "default". Choose from "byName", "byLocalCode", or "byGlobalCode". Choose from "asc" or "desc".

32.3.8 Languages
During the contribution process contributors tag documents by language. You can use the Reference Information service to generate a list of supported languages. The following sample code displays how to generate a list of supported languages: XML Sample Request - Generating Languages Information
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2008/01/12/RefInfo_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/RefInfo_1/ G etInfo_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > G etInfo_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/RefInfo_1"> <genReq> <languageS earchC riterion details ="docsearch"> < r fc1 7 6 6 C r iter ion/> </languageS earchC riterion> <genReq /> </G etInfo_Request_1> </Body > </E nv elope>

Attribute details

Description The amount and type of data returned. Choose from "min", "max","uidOnly", "docsearch", or "default".

614

TRKD API Developer's Guide

rfc1766Criteri Indicates the data conforms to RFC (Request for Comments) 1766. on

32.3.9 Subjects
During the contribution process contributors tag documents by subject. You can use the Reference Information service to generate a list of subjects and codes for a contributor. This request returns both the local and global category codes. The following sample code displays how to generate a list of subjects: XML Sample Request - Generating Subjects Information
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2008/01/12/RefInfo_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/RefInfo_1/ G etInfo_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > G etInfo_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/RefInfo_1"> <genReq> <subjectS earchC riterion details ="docsearch" sor tBy ="by N ame" sor tO r der ="asc" <setC odeC riterion setC ode="[contr ibutor set code ]"/> </subjectS earchC riterion> <genReq /> </G etInfo_Request_1> </Body > </E nv elope>

Attribute details sortBy sortOrder contributor set code

Description The amount and type of data returned. Choose from "min", "max","uidOnly", "docsearch", or "default". Choose from "byName", "byLocalCode", or "byGlobalCode". Choose from "asc" or "desc". Specifies the contributor codes to return (local codes). By default, this request returns Thomson Reuters (global) codes.

32.3.10 Type of Analysis (Disciplines)

During the contribution process Thomson Reuters automatically categorizes documents based on types of analysis (disciplines). You can use the Reference Information service to generate a list of the discipline categories. The following sample code displays how to generate a list of disciplines: XML Sample Request - Generating Type of Analysis (Disciplines) Information
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2008/01/12/RefInfo_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/RefInfo_1/ G etInfo_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token>

Reference Information

615

</A uthorization> </H eader> <Body > G etInfo_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/RefInfo_1"> <genReq> <c12nDisciplineS earchC riterion details ="docsearch" sor tBy ="by N ame" sor tO r der ="asc" /> <genReq /> </G etInfo_Request_1> </Body > </E nv elope>

Attribute details sortBy sortOrder

Description The amount and type of data returned. Choose from "min", "max","uidOnly", "docsearch", or "default". Choose from "byName", "byLocalCode", or "byGlobalCode". Choose from "asc" or "desc".

32.3.11 Research Categories (Report Styles)

During the contribution process Thomson Reuters automatically categorizes documents based on research categories (report styles). You can use the Reference Information service to generate a list of research categories. The following sample code displays how to generate a list of research categories: XML Sample Request - Generating Research Categories (Report Styles) Information
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2008/01/12/RefInfo_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/RefInfo_1/ G etInfo_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > G etInfo_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/RefInfo_1"> <genReq> <c12nRptS ty leS earchC riterion details ="docsearch" sor tBy ="by N ame" sor tO r der ="asc" /> <genReq /> </G etInfo_Request_1> </Body > </E nv elope>

Attribute details sortBy sortOrder

Description The amount and type of data returned. Choose from "min", "max","uidOnly", "docsearch", or "default". Choose from "byName", "byLocalCode", or "byGlobalCode". Choose from "asc" or "desc".

32.3.12 Research Subjects

During the contribution process Thomson Reuters automatically categorizes documents based on research subjects. You can use the Reference Information service to generate a list of research subjects. The following sample code displays how to generate a list of research subjects: XML Sample Request - Generating Research Subjects Information

616

TRKD API Developer's Guide

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2008/01/12/RefInfo_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/RefInfo_1/ G etInfo_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > G etInfo_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/RefInfo_1"> <genReq> <c12nS ubjectS earchC riterion details ="docsearch" sor tBy ="by N ame" sor tO r der ="asc" /> <genReq /> </G etInfo_Request_1> </Body > </E nv elope>

Attribute details sortBy sortOrder

Description The amount and type of data returned. Choose from "min", "max","uidOnly", "docsearch", or "default". Choose from "byName", "byLocalCode", or "byGlobalCode". Choose from "asc" or "desc".

32.3.13 Research Purpose (Reasons)

During the contribution process Thomson Reuters automatically categorizes documents based on the research purpose (reasons). You can use the Reference Information service to generate a list of the research purposes. The following sample code displays how to generate a list of research purposes: XML Sample Request - Generating Research Purpose (Reasons) Information
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2008/01/12/RefInfo_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/RefInfo_1/ G etInfo_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > G etInfo_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/RefInfo_1"> <genReq> <c12nReasonS earchC riterion details ="docsearch" sor tBy ="by N ame" sor tO r der ="asc" /> <genReq /> </G etInfo_Request_1> </Body > </E nv elope>

Attribute details sortBy sortOrder

Description The amount and type of data returned. Choose from "min", "max","uidOnly", "docsearch", or "default". Choose from "byName", "byLocalCode", or "byGlobalCode". Choose from "asc" or "desc".

Reference Information

617

32.4

Get Information (GetInfo_1)

The GetInfo_1 request is used to retrieve necessary reference information. The request also provides various search criteria that you can use to perform a more detailed search for critical information. The search criteria include: Category Contributor Country Currency Industry Language Region Subject See section Understanding Reference Information Request for more details on these criteria. The GetInfo_1 request also has common search criteria that allow you to filter information by specific language; to sort information by name, Global or Local Code; to specify sorting order and set level of details to be returned in the response (Min, Max, UID or DocSearch). For more information on codes and UIDs, see section Understanding Reuters Knowledge Direct API Codes. The following example shows how to retrieve information about languages. XML Sample Request - Get Information
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2008/01/12/RefInfo_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/RefInfo_1/ G etInfo_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etInfo_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/RefInfo_1" acceptLanguage="en"> <genReq> <languageS earchC riterion details="max" sortO rder="desc" sortBy ="by G lobalC ode" mxE xistingLang="false"> <uidC riterion> <id>110000073</id> <id>110000035</id> <id>110000028</id> <id>110000125</id> <id>110000088</id> <id>110000087</id> <id>110000148</id> </uidC riterion> </languageS earchC riterion> </genReq> </G etInfo_Request_1> </Body > </E nv elope>

XML Sample Response - Get Information

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/ rkd/RefInfo_1/G etInfo_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <G etInfo_Response_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/RefInfo_1" containedLanguages="en-us"> <languageInfo containedLanguages="en-us"> <language cp="1252" mxE xistingLang="false" mxLangM ap="" rfc1766="zh-hk" uid="110000028">

618

TRKD API Developer's Guide

<name>C hinese (H ong Kong)</name> </language> <language cp="1252" mxE xistingLang="false" mxLangM ap="" rfc1766="xh" uid="110000125"> <name>Xhosa</name> </language> <language cp="1251" mxE xistingLang="true" mxLangM ap="" rfc1766="sr" uid="110000088"> <name>S erbian (C y rillic)</name> </language> <language cp="1252" mxE xistingLang="false" mxLangM ap="" rfc1766="ru-mo" uid="110000087"> <name>Russian (M oldov a)</name> </language> <language cp="1252" mxE xistingLang="true" mxLangM ap="" rfc1766="no" uid="110000148"> <name>N orw egian</name> </language> <language cp="932" mxE xistingLang="true" mxLangM ap="" rfc1766="ja" uid="110000073"> <name>Japanese</name> </language> <language cp="1252" mxE xistingLang="true" mxLangM ap="en-us, en-ca;q=.9, en-gb;q=.8, en;q=.0001" rfc1766="en" uid="110000035"> <name>E nglish</name> </language> </languageInfo> </G etInfo_Response_1> </Body > </E nv elope>

32.5

Get Information, Extended (GetInfoEx_1)

The GetInfoEx_1 request is similar to the GetInfo_1 request, only it has two additional common search criteria that allow you to separate the information by language and include duplicates into the response. See section Get Information (GetInfo_1) for more details on other request items. The following is an example of GetInfoEx_1 request. XML Sample Request - Get Information, Extended
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2008/01/12/RefInfo_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/RefInfo_1/ G etInfoE x_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etInfoE x_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/RefInfo_1" acceptLanguage="en"> <genReq> <languageS earchC riterion details="max" sortO rder="desc" sortBy ="by G lobalC ode" mxE xistingLang="false"> <uidC riterion> <id>110000073</id> <id>110000035</id> <id>110000028</id> <id>110000125</id> <id>110000088</id> <id>110000087</id> <id>110000148</id> </uidC riterion> </languageS earchC riterion> </genReq> </G etInfoE x_Request_1> </Body > </E nv elope>

Reference Information

619

XML Sample Response - Get Information, Extended

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/ rkd/RefInfo_1/G etInfoE x_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <G etInfoE x_Response_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/RefInfo_1" containedLanguages="en-us"> <languageInfo containedLanguages="en-us"> <language cp="1252" mxE xistingLang="false" mxLangM ap="" rfc1766="zh-hk" uid="110000028"> <name>C hinese (H ong Kong)</name> </language> <language cp="1252" mxE xistingLang="false" mxLangM ap="" rfc1766="xh" uid="110000125"> <name>Xhosa</name> </language> <language cp="1251" mxE xistingLang="true" mxLangM ap="" rfc1766="sr" uid="110000088"> <name>S erbian (C y rillic)</name> </language> <language cp="1252" mxE xistingLang="false" mxLangM ap="" rfc1766="ru-mo" uid="110000087"> <name>Russian (M oldov a)</name> </language> <language cp="1252" mxE xistingLang="true" mxLangM ap="" rfc1766="no" uid="110000148"> <name>N orw egian</name> </language> <language cp="932" mxE xistingLang="true" mxLangM ap="" rfc1766="ja" uid="110000073"> <name>Japanese</name> </language> <language cp="1252" mxE xistingLang="true" mxLangM ap="en-us, en-ca;q=.9, en-gb;q=.8, en;q=.0001" rfc1766="en" uid="110000035"> <name>E nglish</name> </language> </languageInfo> </G etInfoE x_Response_1> </Body > </E nv elope>

32.6

Get Information from UID (GetInfoFromUid_1)

The GetInfoFromUid_1 request is used to retrieve necessary reference information from specific UIDs. See section UIDs for more details on UIDs. The following is an example of GetInfoFromUid_1 request. XML Sample Request - Get Information from UID
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2008/01/12/RefInfo_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/RefInfo_1/ G etInfoF romU id_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etInfoF romU id_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/RefInfo_1" acceptLanguage="ru,ja,es,en, fr"> <id>1</id> <id>2</id> <id>3</id> <id>6</id> <id>6</id> <id>6</id> <id>27</id>

620

TRKD API Developer's Guide

<id>27</id> <id>27</id> <id>5451</id> <id>60000411</id> <id>60000398</id> <id>60000398</id> <id>60000429</id> <id>60000428</id> <id>60000394</id> <id>90060936</id> <id>90060937</id> <id>90060935</id> <id>10000004</id> <id>10000011</id> <id>10000019</id> <id>10000024</id> <id>110000086</id> <id>110000037</id> <id>110000001</id> <id>110000012</id> </G etInfoF romU id_Request_1> </Body > </E nv elope>

XML Sample Response - Get Information from UID

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/ rkd/RefInfo_1/G etInfoF romU id_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <G etInfoF romU id_Response_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/RefInfo_1" containedLanguages="en-us, ru"> <uidInfo containedLanguages="ru,en-us"> <ui uid="10000004"></ui> <ui uid="10000011"> </ui> <ui uid="10000019"> </ui> <ui uid="10000024"> </ui> <ui uid="110000001"> </ui> <ui uid="110000012"> ( )</ui> <ui uid="110000037"> ( )</ui> <ui uid="110000086"> </ui> <ui uid="1">M ultex Task Q ueue M onitoring</ui> <ui uid="2">M errill Ly nch</ui> <ui uid="3">Bankers Trust A ustralia Limited</ui> <ui uid="6">G oldman S achs</ui> <ui uid="27">Banc of A merica S ecurities</ui> <ui uid="5451">Bear S tearns & C o. Inc.</ui> <ui uid="60000394">A merican Region</ui> <ui uid="60000398">A frica/M iddle E ast</ui> <ui uid="60000411">A frica</ui> <ui uid="60000428">A merica-E merging</ui> <ui uid="60000429">A merica-Dev eloped</ui> <ui uid="90060935">A ll O rdinaries excl F inancial S erv ices (A ustralia/N Z)</ui> <ui uid="90060936">20 Leaders (A ustralia/N Z)</ui> <ui uid="90060937">50 Leaders (A ustralia/N Z)</ui> </uidInfo> </G etInfoF romU id_Response_1> </Body > </E nv elope>

32.7

Get Information from UID, Extended (GetInfoFromUidEx_1)

The GetInfoFromUidEx_1 request is similar to the GetInfoFromUid_1 request, only it has two additional common search criteria that allow you to separate the information by language and include duplicates into the response.

Reference Information

621

See also section Get Information from UID (GetInfoFromUid_1). The following is an example of GetInfoFromUidEx_1 request. XML Sample Request - Get Information from UID, Extended
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2008/01/12/RefInfo_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/RefInfo_1/ G etInfoF romU idE x_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etInfoF romU idE x_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/RefInfo_1" acceptLanguage="ru,ja,es, en,fr"> <id>1</id> <id>2</id> <id>3</id> <id>6</id> <id>27</id> <id>5451</id> <id>60000411</id> <id>60000398</id> <id>60000429</id> <id>60000428</id> <id>60000394</id> <id>90060936</id> <id>90060937</id> <id>90060935</id> <id>10000004</id> <id>10000011</id> <id>10000019</id> <id>10000024</id> <id>110000086</id> <id>110000037</id> <id>110000001</id> <id>110000012</id> </G etInfoF romU idE x_Request_1> </Body > </E nv elope>

XML Sample Response - Get Information from UID, Extended

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/ rkd/RefInfo_1/G etInfoF romU idE x_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <G etInfoF romU id_Response_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/RefInfo_1" containedLanguages="en-us, ru"> <uidInfo containedLanguages="ru,en-us"> <ui uid="10000004"></ui> <ui uid="10000011"> </ui> <ui uid="10000019"> </ui> <ui uid="10000024"> </ui> <ui uid="110000001"> </ui> <ui uid="110000012"> ( )</ui> <ui uid="110000037"> ( )</ui> <ui uid="110000086"> </ui> <ui uid="1">M ultex Task Q ueue M onitoring</ui> <ui uid="2">M errill Ly nch</ui> <ui uid="3">Bankers Trust A ustralia Limited</ui> <ui uid="6">G oldman S achs</ui> <ui uid="27">Banc of A merica S ecurities</ui>

622

TRKD API Developer's Guide

<ui uid="5451">Bear S tearns & C o. Inc.</ui> <ui uid="60000394">A merican Region</ui> <ui uid="60000398">A frica/M iddle E ast</ui> <ui uid="60000411">A frica</ui> <ui uid="60000428">A merica-E merging</ui> <ui uid="60000429">A merica-Dev eloped</ui> <ui uid="90060935">A ll O rdinaries excl F inancial S erv ices (A ustralia/N Z)</ui> <ui uid="90060936">20 Leaders (A ustralia/N Z)</ui> <ui uid="90060937">50 Leaders (A ustralia/N Z)</ui> </uidInfo> </G etInfoF romU id_Response_1> </Body > </E nv elope>

32.8

Get Intelligent Categorization Information (IcatGetInfo_1)

The IcatGetInfo_1 request can be used to retrieve information about different criteria: CtSubjects Criteria Disciplines Criteria Reasons Criteria Report Styles Criteria This request also allows you to sort criteria by Name, Global Code, Local Code and Unspecified. See section Understanding Reuters Knowledge Direct API Codes for more details about codes. The following is an example of IcatGetInfo_1 request. XML Sample Request - Get Intelligent Categorization Information
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2008/01/12/RefInfo_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/RefInfo_1/ IcatG etInfo_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <IcatG etInfo_Request_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/RefInfo_1"> <ctS ubjectsC riteria/> <disciplinesC riteria sortBy ="by G lobalC ode"/> <reasonsC riteria/> <rptS ty lesC riteria sortBy ="by LocalC ode"/> </IcatG etInfo_Request_1> </Body > </E nv elope>

XML Sample Response - Get Intelligent Categorization Information

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/ rkd/RefInfo_1/IcatG etInfo_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <IcatG etInfo_Response_1 xmlns="http://w w w .reuters.com/ns/2008/01/12/w ebserv ices/rkd/RefInfo_1"> <ctS ubjects /> <disciplines> <icat_info_record gc="130000001" lc="DIS _A N Q N ">

Reference Information

623

<name>TE C H N IC A L/Q U A N TITA TIV E A N A LYS IS </name> </icat_info_record> <icat_info_record gc="130000002" lc="DIS _F U N D"> <name>F U N DA M E N TA L A N A LYS IS </name> </icat_info_record> <icat_info_record gc="130000003" lc="DIS _S TRT"> <name>S TRA TE G IC A N A LYS IS </name> </icat_info_record> </disciplines> <reasons> <icat_info_record gc="140000001" lc="RE A _C O M M "> <name>C O M M E N TA RY/O V E RV IE W/S U M M A RY</name> </icat_info_record> <icat_info_record gc="140000002" lc="RE A _F O RE "> <name>F O RE C A S T</name> </icat_info_record> ... <icat_info_record gc="140000011" lc="RE A _M E E T"> <name>M E E TIN G S /C O N F E RE N C E N O TIC E </name> </icat_info_record> </reasons> <rptS ty les> <icat_info_record gc="150000001" lc="RP T_C M "> <name>C O M M O DITY RE S E A RC H </name> </icat_info_record> <icat_info_record gc="150000002" lc="RP T_C O "> <name>C O M P A N Y (E Q U ITY) RE P O RTS </name> /icat_info_record> ... <icat_info_record gc="150000012" lc="RP T_TT"> <name>M U TU A L F U N DS / TRU S TS RE S E A RC H </name> </icat_info_record> </rptS ty les> </IcatG etInfo_Response_1> </Body > </E nv elope>

624

TRKD API Developer's Guide

chapter 33

Research On Demand

This chapter describes how to use the Thomson Reuters Research API to implement advanced document searching. These features are often referred to as "Research On Demand" techniques. The appropriate Research-On-Demand (ROD) billing records are created based on the users entitlements and the reseller code (agent ID), if appropriate. The following operations are available through the Thomson Reuters Research on Demand service: Calculate Document Price (CalculateDocPrice_1) - calculates billing based on 24 hour discount. Get Price per Page (GetPricePerPage_1) - returns price per page. Get Document Disclaimer (GetDocDisclaimer_1) - retrieves the text which each contributor specifies to be displayed and accepted by each user buying PPV research. Check per Page Download (CheckPerPageDownload_1) - checks if a document can be retrieved per pages.

33.1

Authentication/Authorization, Service Endpoint, and Required Headers

Authorization All requests to the Thomson Reuters Research on Demand service require an authorization token. For details, see section Understanding Authentication Tokens. Authentication Thomson Reuters Research on Demand uses Reuters impersonation tokens for each effective user. In this case, Thomson Reuters must create each user before your application authenticates them. Unmanaged effective users are not supported in Thomson Reuters Research on Demand. For additional information, see section Creating a Token . Service Endpoint Thomson Reuters Research on Demand Endpoint
http://api.rkd.reuters.com/api/2009/10/01/ResearchO nDemand_1.sv c

Required Header Required HTTP Headers

P O S T /2009/10/01/ResearchO nDemand_1.sv c H TTP /1.1 C ontent-Ty pe: application/soap+xml H ost: api.rkd.reuters.com C ontent-Length: [length]

33.2

WSDL
WSDL:
http://api.rkd.reuters.com/schemas/w sdl/ResearchO nDemand_1_H ttpA ndRKDToken.w sdl

Research On Demand

625

33.3

Calculate Document Price (CalculateDocPrice_1)

The document price returned by the DocInfo_1 request (see also Including the Undiscounted Document Price in the Metadata section in Document Search chapter) is the undiscounted price. However, certain resellers may offer discounts. In addition, "On-Demand" sites generally offer a "24 hour discount". With the "24 hour discount" clients can retrieve a document multiple times in 24 hours and Thomson Reuters only charges for the first download. You can use the CalculateDocPrice_1 request to retrieve the discounted document price of a page, particular pages or the entire document. The example below requests discounted document price for pages 2, 5 and 7 in document with 47259608 docID: XML Sample Request - Calculating Document Price
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/10/01/ResearchO nDemand_1.sv c/ A nony mous</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/rkd/ ResearchO nDemand_1/C alculateDocP rice_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <C alculateDocP rice_Request_1 xmlns="http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/rkd/ResearchO nDemand_1"> <DocumentItem docID=" 4 7 2 5 9 6 0 8 "> < P ageItem P ageNumber ="2" /> <P ageItem P ageN umber="5" /> <P ageItem P ageN umber="7" /> </DocumentItem> </C alculateDocP rice_Request_1> </Body > </E nv elope>

Element Request Type

Value (Optional) Defines either page numbers or page ranges: page number (f.e. <PageItem PageNumber="2" />); page range (f.e. <PageRange>1-5;7,9</PageRange>)

The response returns both the original price and the calculated price for the document and page: XML Sample Response - Calculating Document Price
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/ rkd/ResearchO nDemand_1/C alculateDocP rice_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <C alculateDocP rice_Response_1 xmlns="http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/rkd/ResearchO nDemand_1"> <DocumentItem docID="47259608" originalP rice="1000" calculatedP rice="1000"> <P ageItem pageN umber="2" originalP rice="800" calculatedP rice="800"></P ageItem> <P ageItem pageN umber="5" originalP rice="800" calculatedP rice="0"></P ageItem> <P ageItem pageN umber="7" originalP rice="800" calculatedP rice="200"></P ageItem> </DocumentItem> </C alculateDocP rice_Response_1> </Body > </E nv elope>

Note: The document price returned in the response is in cents. You must code you application to display a meaningful amount

626

TRKD API Developer's Guide

to your users. For example, if the response indicates 4950, your application should display $49.50.

33.4

Get Price per Page (GetPricePerPage_1)

Use the GetPricePerPage_1 request to retrieve price per page for documents with particular IDs. The example below requests price per page for documents with '47259608' and '47282605' IDs: XML Sample Request - Calculating Price per Page
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/10/01/ResearchO nDemand_1.sv c/ A nony mous</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/rkd/ ResearchO nDemand_1/G etP riceP erP age_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etP riceP erP age_Request_1 xmlns="http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/rkd/ResearchO nDemand_1" xmlns:xsi="http:// w w w .w 3.org/2001/XM LS chema-instance"> <DocumentID> 4 7 2 5 9 6 0 8 </DocumentID> <DocumentID> 4 7 2 8 2 6 0 5 </DocumentID> </G etP riceP erP age_Request_1> </Body > </E nv elope>

The response returns the following information: XML Sample Response - Calculating Price per Page
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/ rkd/ResearchO nDemand_1/G etP riceP erP age_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <G etP riceP erP age_Response_1 xmlns="http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/rkd/ResearchO nDemand_1"> <P riceP erP age docID="47282605">0</P riceP erP age> <P riceP erP age docID="47259608">800</P riceP erP age> </G etP riceP erP age_Response_1> </Body > </E nv elope>

Note: The document price returned in the response is in cents. You must code you application to display a meaningful amount to your users. For example, if the response indicates 4950, your application should display $49.50.

33.5

Get Document Disclaimer (GetDocDisclaimer_1)

Particular research contributors require resellers of their research to display disclaimer text which users must acknowledge before purchasing/downloading. The GetDocDisclaimer_1 request retrieves the text which particular contributor specifies to be displayed and accepted by each user before buying PPV (Pay-per-View) research documents. The sample request below specifies to retrieve document disclaimer for contributor with '12345' ID:

Research On Demand

627

XML Sample Request - Retrieving Document Disclaimer

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/10/01/ResearchO nDemand_1.sv c/ A nony mous</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/rkd/ ResearchO nDemand_1/G etDocDisclaimer_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etDocDisclaimer_Request_1 xmlns="http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/rkd/ResearchO nDemand_1"> <C ontributor ID=" 1 2 3 4 5 " /> </G etDocDisclaimer_Request_1> </Body > </E nv elope>

The response returns document disclaimer for the specified contributor: XML Sample Response - Retrieving Document Disclaimer
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/ rkd/ResearchO nDemand_1/G etDocDisclaimer_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <G etDocDisclaimer_Response_1 xmlns="http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/rkd/ResearchO nDemand_1"> <Disclaimer>A LTH O U G H RE U TE RS M A KE S RE A S O N A BLE E F F O RTS TO E N S U RE TH E A C C U RA C Y A N D RE LIA BILITY O F TH E S E RV IC E S , N E ITH E R RE U TE RS N O R A N Y IN F O RM A TIO N P RO V IDE R O R O TH E R TH IRD P A RTY S U P P LIE R G U A RA N TE E S S U C H A C C U RA C Y O R RE LIA BILITY, A N D S U BS C RIBE R A C KN O WLE DG E S TH A T RE U TE RS , ITS E M P LO YE E S , A G E N TS , C O N TRA C TO RS , S U B-C O N TRA C TO RS , IN F O RM A TIO N P RO V IDE RS A N D O TH E R TH IRD P A RTY S U P P LIE RS WILL N O T BE H E LD LIA BLE F O R A N Y DA M A G E S S U F F E RE D O R IN C U RRE D BY S U BS C RIBE R, A N Y C U S TO M E R O F S U BS C RIBE R O R A N Y O TH E R P E RS O N O R E N TITY A RIS IN G O U T O F A N Y F A U LT, IN TE RRU P TIO N O R DE LA Y IN A N Y S E RV IC E O R O U T O F A N Y IN A C C U RA C Y, E RRO R O R O M IS S IO N IN A N Y S E RV IC E S U P P LIE D TO S U BS C RIBE R, H O WE V E R S U C H F A U LTS , IN TE RRU P TIO N S , DE LA YS , IN A C C U RA C IE S , E RRO RS O R O M IS S IO N S A RIS E , U N LE S S DU E TO RE U TE RS G RO S S N E G LIG E N C E O R WILLF U L M IS C O N DU C T.</Disclaimer> </G etDocDisclaimer_Response_1> </Body > </E nv elope>

Note: If your application is contractually obligated to display the appropriate disclaimers, make sure that users of your application read the disclaimer before they purchase/download the document.

33.6

Check per Page Download (CheckPerPageDownload_1)

Use the CheckPerPageDownload_1 request to check whether documents from particular contributors can be retrieved per pages. The sample request below checks whether it is possible to download documents per page from contributors with '12345', '4205' and '2' IDs: XML Sample Request - Checking per Page Downloads
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/10/01/ResearchO nDemand_1.sv c/ A nony mous</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID>

628

TRKD API Developer's Guide

<A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/rkd/ ResearchO nDemand_1/C heckP erP ageDow nload_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <C heckP erP ageDow nload_Request_1 xmlns="http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/rkd/ResearchO nDemand_1" xmlns: xsi="http://w w w .w 3.org/2001/XM LS chema-instance"> <C ontributor ID=" 1 2 3 4 5 " /> <C ontributor ID=" 4 2 0 5 " /> <C ontributor ID=" 2 " /> </C heckP erP ageDow nload_Request_1> </Body > </E nv elope>

The response returns the following information: XML Sample Response - Checking per Page Downloads
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/ rkd/ResearchO nDemand_1/C heckP erP ageDow nload_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <C heckP erP ageDow nload_Response_1 xmlns="http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/rkd/ResearchO nDemand_1"> <A llow P erP ageDow nload C ontributorID="12345">true</A llow P erP ageDow nload> <A llow P erP ageDow nload C ontributorID="4205">true</A llow P erP ageDow nload> <A llow P erP ageDow nload C ontributorID="2">false</A llow P erP ageDow nload> </C heckP erP ageDow nload_Response_1> </Body > </E nv elope>

Thomson Reuters Search

629

chapter 34

Thomson Reuters Search

Thomson Reuters Search web service could be described as a search engine that searches on Thomson Reuters financial information. Primary use case of Search service is as a symbol resolution engine. That is, use search to resolve company identifiers (for example, a company name) into the identifiers required for other APIs. In most cases, this identifier is RIC. Thomson Reuters recommends using the single service user to make the requests (rather than each effective user); this approach simplifies the application and the entitlements structure required to support the search requests. The following operations are available in this web service: Name Search All Organization Commodity Quote Derivative Instruments Derivative Quote Equity Quote Fund Quote Description Searches any item in the index. Searches Organizations involved in the financial markets. Searches Commodity Quotes. Searches on any derivative instrument. Searches on any derivative quote, additional filter or query term required to limit to Option, Future, Warrant etc. Searches Fund Quotes. Searches Government and Corporate Bond instruments.

Government and Corporate Searches Government and Corporate Bond instruments. Bond Instruments Index Instruments Index Quote Searches Indices at Instrument level. Searches Quotes on indices.

Note: Thomson Reuters Search allows you to use Chinese or Japanese characters when searching for data.

34.1

Authentication and Authorization

Authorization All requests to the Thomson Reuters Search web service require an authorization token. For details, see section Understanding Authentication Tokens. Authentication Thomson Reuters Search uses Reuters impersonation tokens for each effective user. In this case, Thomson Reuters must create each user before your application authenticates them. Unmanaged effective users are not supported in Thomson Reuters Search. For additional information, see section Creating a Token for more information on creating a Service Token.

34.2

Common Elements
This section outlines and explains elements that are used in all of the operations of the Thomson Reuters Search web service.

34.2.1 Query Header

Header information is common to every web service implemented for the Search service. The parameters in this section affect the way in which the query will be processed by the search engine. If this section is left out default values are passed. The

630

TRKD API Developer's Guide

following is an example of the Header section with default values: XML Sample Request - Query Header Section
<Q uery H eader xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Q uery S pecDataty pes"> <M axC ount>10</M axC ount> <P iv ot>0</P iv ot> <Timeout>0</Timeout> <S pellcheck>O n</S pellcheck> </Q uery H eader>

Attribute Max Count Pivot Timeout Spellcheck

Description The maximum number of records to be returned by this query. The max number is set to 4020 and the service will throw an exception if it is more. The offset of the first record returned from the total identified by the search engine. The timeout (in seconds) to allow before the query returns an empty result. Default value is 10 seconds. Whether the search engine performs spell checking on the query. This value only affects searches made outside of a criteria value (on the Name, Code or NameSymbol fields). The possible values for Spellcheck are: On Off Suggest

34.2.2 Query
Each Query command contains Expression fields and Value fields. An Expression has a number of characteristics that you will be able to specify. These can be defined as: The expression can include a number of values that could be matched for the query. Indicates what information is returned in the response through the use of Include attribute in each field. The search engine may provide additional information for a particular field, such as Navigation. It may be possible to sort a set of results on a particular field. Note: Query must generally be used only for requests against the default field sets: "Search", "Name" and "Code" as these fields allow ranking to be performed by the search engine based on how well the user query matches the content of these fields. For more information see section Searchable Field Types. Note: The types of request which contain many terms as a part of the <Query/> element are not executed. E.g: If your application sends requests such as: XML Sample Request
<Q uery > <C ode> <S y mbolV alue v alue="V O D.L"/> <S y mbolV alue v alue="BT.L" /> </C ode> </Q uery >

This is no longer considered to be a valid "query". Because there are multiple values requested, it is considered to be a code lookup and as such should be specified in the <Filter/> like: XML Sample Request
<F ilter> <C ode>

Thomson Reuters Search

631

<S y mbolV alue v alue="V O D.L" /> <S y mbolV alue v alue="BT.L" /> </C ode> </F ilter>

This is not to say that <Code/> is not a relevant <Query/> element. Searches are still possible on a code value. For example: XML Sample Request
<Q uery > <C ode> <S y mbolV alue v alue="IBM .N " /> </C ode> </Q uery >

The following attributes can be assigned to the expression: Attribute Sort Description Only available for fields that are configured as sortable by the search engine. If a sort order is not specified Search results are returned in a ranked order. This is dictated by a static rank value defined for each document according to a set of business rules and a dynamic ranking created at run time designed to boost documents that are the best match for the query. Only available for fields for which the search engine is configured to provide analytics on a set of results. You would set this value to true for a field you want to be returned in the response. You can set this to be returned in the response without specifying query criteria.

Navigation Include

In this example along with setting the search for keyword "microsoft" it is also indicated that the response should return the values for AverageShareFound and CommonName by setting their include attributes to true. Note: Only fields with Include attribute set to true will be included in the response. XML Sample Request - Query Section use of Include Attribute
<Q uery > < Sear ch xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/RequestDefaultF ields" Include="tr ue" > <S tringV alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Q uery S pecDataty pes" V alue="microsoft" /> </S earch> < C ommonName xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/RequestDefaultF ields" Include="tr ue" /> </Q uery >

In the following example you can see Expressions outlined in bold: XML Sample Request - Query Section
<Q uery > <Sear ch xmlns="http://www.r euter s.com/ns/2 0 0 6 /0 5 /0 1 /webser vices/r kd/Sear ch/RequestDefaultFields" Include="tr ue" > <S tringV alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Q uery S pecDataty pes" V alue="microsoft" /> </S earch> <C ode xmlns="http://www.r euter s.com/ns/2 0 0 6 /0 5 /0 1 /webser vices/r kd/Sear ch/RequestDefaultFields" Include="tr ue"> <S y mbolV alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Q uery S pecDataty pes" E xactM atch="false" V alue="320486" N egated="false" /> </C ode> </Q uery >

Value fields represent a single expression and contain the actual value to be included in the criteria for the search. Each data type has a specific value container as shown: Attribute Description

632

TRKD API Developer's Guide

Value The value to match for this field. Negated Specifies that results should not contain this value. ExpressionType Only available for numeric and date fields. To allow the user to specify how the field will be matched by the search engine. UpperValue Only available for numeric and date fields. When an expression type of Between is specified, the user will be required to specify both the upper and lower bounds for the match. In these cases, Value is interpreted as the lower bound and UpperValue will specify the upper boundary of the range expression. ExactMatch Only available for symbol fields. This flag specifies that the search engine should perform an exact match against the field. Support for this feature is specified by the search engine and is not available by default for all symbol fields. This being the case, specifying that an exact match should be performed will not always guarantee that an exact match was performed by the search engine. Current support for this feature is only available for RIC fields. XML Sample Request - Query Section
<Q uery > <S earch xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/RequestDefaultF ields" Include="true" > <Str ingV alue xmlns="http://www.r euter s.com/ns/2 0 0 6 /0 5 /0 1 /webser vices/r kd/Sear ch/ Q uer ySpecDatatypes" V alue="micr osoft" /> </S earch> <C ode xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/RequestDefaultF ields" Include="true"> <SymbolV alue xmlns="http://www.r euter s.com/ns/2 0 0 6 /0 5 /0 1 /webser vices/r kd/Sear ch/ Q uer ySpecDatatypes " ExactM atch="false" V alue="3 2 0 4 8 6 " Negated="false" /> </C ode> </Q uery >

34.2.3 Filter
Values can be specified in a Filter rather than a Query when they are required to only limit the universe of results available to the query. The Filter parameter is typically used for query terms that relate to metadata, such as specifying the collection(s), language scope, document type or category for the query. One reason for using the Filter parameter rather than query is the lower overhead and faster execution time. Filters do not perform query transformation processing, such as approximate match. The terms will impact which documents that are returned (by limiting the scope of the query), but will not impact the ranking/sorting of the results. For example, the quality of the match (e.g. related to proximity) for filter terms will not impact the rank of the document. Features such as sorting and navigation are not available on expressions specified as part of a filter either. Note: Like with fields in the query section it is also possible to set the Include attribute to true to include the field in the response. XML Sample Request - Filter Section Example 1
<G etG ov C orpInst_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/G ov C orpInst_1"> <Filter > <IssueDate xmlns="http://www.r euter s.com/ns/2 0 0 6 /0 5 /0 1 /webser vices/r kd/Sear ch/Sear chall_Q uer ySpec_1 " Include="tr ue" Sor t="A scending" Navigation="tr ue"> <DateV alue xmlns="http://www.r euter s.com/ns/2 0 0 6 /0 5 /0 1 /webser vices/r kd/Sear ch/Q uer ySpecDatatypes " Expr essionT ype="LessT han" V alue="2 0 0 1 -0 3 -0 7 " Negated="false" /> </IssueDate> </Filter > < Q uery > <S earch xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/RequestDefaultF ields" Include="true" > <S tringV alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Q uery S pecDataty pes" V alue="cisco" /> </S earch> </Q uery > </G etG ov C orpInst_Request_1>

XML Sample Request - Filter Section Example 2

Thomson Reuters Search

633

<S earchall_1_Request xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema" xmlns="http://w w w .reuters.com/ns/frdsearch/1.0/S earchall_1_Request"> <Filter > <BusinessEntity xmlns="http://www.r euter s.com/ns/2 0 0 6 /0 5 /0 1 /webser vices/r kd/Sear ch/ RequestDefaultFields"> <Str ingV alue V alue="Q UO T E" xmlns="http://www.r euter s.com/ns/2 0 0 6 /0 5 /0 1 /webser vices/r kd/Sear ch/ Q uer ySpecDatatypes" /> </BusinessEntity> <A ssetC ategor y xmlns="http://www.r euter s.com/ns/2 0 0 6 /0 5 /0 1 /webser vices/r kd/Sear ch/ Sear chall_1 _Q uer ySpec"> <Str ingV alue V alue="O RD" xmlns="http://www.r euter s.com/ns/2 0 0 6 /0 5 /0 1 /webser vices/r kd/Sear ch/ Q uer ySpecDatatypes" /> </A ssetC ategor y> </Filter > <Q uery > <S earch Include="true" xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/RequestDefaultF ields"> <S tringV alue V alue="Reuters" xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Q uery S pecDataty pes" /> </S earch> <BusinessE ntity Include="true" xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/RequestDefaultF ields" /> <A ssetC ategory Include="true" xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/S earchall_1_Q uery S pec" /> </Q uery > </S earchall_1_Request>

Note: The types of request which contain many terms as a part of the <Query/> element are not executed. E.g: If your application sends requests such as: XML Sample Request
<Q uery > <C ode> <S y mbolV alue v alue="IBM .N " /> <S y mbolV alue v alue="BT.L" /> </C ode> </Q uery >

This is no longer considered to be a valid "query". Because there are multiple values requested, it is considered to be a code lookup and as such should be specified in the <Filter/> like: XML Sample Request
<F ilter> <C ode> <S y mbolV alue v alue="V O D.L" /> <S y mbolV alue v alue="BT.L" /> </C ode> </F ilter>

This is not to say that <Code/> is not a relevant <Query/> element. Searches are still possible on a code value. For example: XML Sample Request
<Q uery > <C ode> <S y mbolV alue v alue="C S C O .O " /> </C ode> </Q uery >

34.2.4 Searchable Field Types

All searchable fields in the Thomson Reuters Search web service fall into one of the following field types:

634

TRKD API Developer's Guide

RequestDefaultFields: Fields that are included by default for all operation requests. RequestOnlyFields: Fields that only appear in a request not a response. NameQualified: Fields that are specific to individual operations. Note: For a full listing of Fields and their Field Types refer to the XSD document.

34.2.5 Difference between Query and Filter in Thomson Reuters Search

Thomson Reuters Search uses the Query parameter to try and find as many matches in its database as possible. It tries alternate spellings, near matches, and will query against many different parameters in order to find good search results. For example if you enter "Microsof 20 Put Warrant" in the Search parameter, Thomson Reuters Search will suggest Microsoft despite the fact that it was spelt incorrectly. Once the spelling is corrected, it will search across a wide range of parameters until it finds that there are hits for Microsoft which are of asset class warrant, and of strike price 20. Thomson Reuters Search uses the Filter parameter to try to remove from the search results things which you tell it youre not interested in. There is no intelligence applied to items you specify in the filter parameter. For example, if you specify that the exchange must be LSE, then Thomson Reuters Search will not return any results which don't have LSE as the Exchange, it will not try to second-guess you. You should use Query in Thomson Reuters Search in the following cases: 1. 2. 3. 4. 5. When you have values for Name, Code and Search, because Query can have only those values specified. When you want your input to be intelligently interpreted. When you want to get near matches to the values you specify. When you want to retrieve navigation for metadata. When you want your results to be partially prioritised on how well they fit your query.

Use Filter when you: 1. Want to specify how the search results are to be cut down. 2. Do not want to apply any intelligence in search results.

34.3

Thomson Reuters Search Requests

This section provides examples on the use of the following Search operations: Name Search All Organization Commodity Quote Derivative Instruments Derivative Quote Equity Quote Fund Quote Government and Corporate Bond Instruments Index Instruments Index Quote Web Service GetSearchall_1 Description Searches any item in the index.

GetOrganisation_1 Search for Organizations involved in the financial markets. GetCommodityQuo Searches Commodity Quotes. te_1 GetDerivativeInst_ Searches on any derivative instrument. 1 GetDerivativeQuot Searches on any derivative quote, additional filter or query term required to limit e_1 to Option, Future, Warrant etc. GetEquityQuote_1 Searches on all Equity Quotes. GetFundQuote_1 Searches Government and Corporate Bond instruments. GetGovCorpInst_1 Searches Government and Corporate Bond instruments.

GetIndexInst_1

Searches Indices at Instrument level.

GetIndexQuote_1 Searches Quotes on indices.

34.3.1 SearchAll Request (GetSearchall_Request_1)

This operation searches and retrieves information on everything that is also covered in other operations separately:

Thomson Reuters Search

635

Organization Commodity Quote Derivative Instruments Derivative Quote Equity Quote Fund Quote Government and Corporate Bond Instruments Index Instruments Index Quote The trade off for using Search All is the amount of time it takes to return the information. Since it searches through such a vast amount of data the time it takes to return a response is considerable more than if you used a specific Search operation. If you know the specific operation use it to get the necessary information quicker. Note: Due to problems with permissioning Thomson Reuters disabled retrieval of ISIN data until we can implement a functionality where it will be permissioned appropriately. Customers have to separately license all ISIN data from a third party, and only after a customer has a license we can provide this data for them. For all ISIN fields we have to separately verify that the customer has a valid license and then update configuration so they can use the fields. As a result, you might get an error saying "You are not authorized to use the AlternateISIN field". Note: PI in GetSearchall_1 request is an ID used by the Thomson Reuters search engine. PIs are unique identifiers for each item in the search index.

34.3.1.1 Service Endpoint and Required Headers

Service Endpoint Thomson Reuters SearchAll Endpoint
http://api.rkd.reuters.com/api/2006/05/01/S earch/S earchall_1.sv c

Required Header Required HTTP Headers

P O S T /api/2006/05/01/S earch/S earchall_1.sv c H TTP /1.1 C ontent-Ty pe: application/soap+xml H ost: api.rkd.reuters.com C ontent-Length: [length]

34.3.1.2 WSDL
WSDL:
http://api.rkd.reuters.com/schemas/w sdl/S earch/S earchall_1_H ttpA ndRKDToken.w sdl

34.3.1.3 Using Navigation

The following example searches for the name "Cisco" and returns RIC, Primary RIC, Asset Category and a break up of how many items belong in each asset class. XML Sample Request - Search All Request with Navigate
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/S earch/S earchall_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/S earchall_1/ G etS earchall_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID>

636

TRKD API Developer's Guide

<Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etS earchall_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/S earchall_1"> <Q uery > < Sear ch xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/RequestDefaultF ields" Include="tr ue"> <S tringV alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Q uery S pecDataty pes" V alue="cisco" N egated="false" /> </S earch> < A ssetC ategor yName xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/S earchall_Q uery S pec_1" Include="tr ue" Navigation="tr ue" /> < P r imar yRIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/S earchall_Q uery S pec_1" Include="tr ue" /> < RIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/S earchall_Q uery S pec_1" Include="tr ue" /> </Q uery > </G etS earchall_Request_1> </Body > </E nv elope>

XML Sample Response - Search All Response with Navigate

<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader> <a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" s:mustU nderstand="1" http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/ http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/S earchall_1/G etS earchall_1_Reply </a:A ction> <a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etS earchall_Response_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/S earchall_1"> <ResultH eader xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes"> <F irstH it>1</F irstH it> <LastH it>40</LastH it> <H its>40</H its> <TotalH its>308</TotalH its> <E xecutionTime>125</E xecutionTime> <Duration>188</Duration> </ResultH eader> <N av igatorList xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes"> <S tringN av igator F ieldN ame="A ssetC ategory N ame" H itC ount="303" E ntropy ="1.208660933" Ratio="0.9837662338" S core="1.20866096" S ampleC ount="303"> <M odifier V alue="E quity /E quity /Index Warrant" C ount="165" /> <M odifier V alue="U nited S tates" C ount="106" /> <M odifier V alue="Israel" C ount="5" /> <M odifier V alue="U nited Kingdom" C ount="5" /> <M odifier V alue="C anada" C ount="3" /> ... </S tringN av igator> </N av igatorList> <Result> <H it> <BusinessE ntity xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ ResponseDefaultF ields">O RG A N IS A TIO N </BusinessE ntity > <DocumentTitle xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields"> <V alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">C isco S y stems Inc</ V alue> <S ubjectN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">C isco S y stems Inc</S ubjectN ame> </DocumentTitle> <P I xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">46747</P I> <P rimary RIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/S earchall_ResultS pec_1">C S C O .O </ P rimary RIC > </H it> <H it> <A ssetC ategory N ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/S earchall_ResultS pec_1">F ixed Income/F ixed Rate Bond</A ssetC ategory N ame> <BusinessE ntity xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ ResponseDefaultF ields">IN S TRU M E N T.F IXE DIN C O M E .G O V C O RP </BusinessE ntity > <DocumentTitle xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields"> <V alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">C isco S y stems Inc, F ixed Rate Bond, C S C O 5.250 22-F eb-2011</V alue> <S ubjectN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">C isco S y stems

Thomson Reuters Search

637

Inc</S ubjectN ame> <S impleTy pe xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">F ixed Rate Bond</S impleTy pe> <C haracteristics xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">C S C O 5.250 22-F eb-2011</C haracteristics> </DocumentTitle> <P I xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">0x0003860206eb771d</ P I> <RIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/S earchall_ResultS pec_1">17275RA B8=RRP S </ RIC > </H it> <H it> <A ssetC ategory N ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/S earchall_ResultS pec_1">F ixed Income/F ixed Rate Bond</A ssetC ategory N ame> <BusinessE ntity xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ ResponseDefaultF ields">IN S TRU M E N T.F IXE DIN C O M E .G O V C O RP </BusinessE ntity > <DocumentTitle xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields"> <V alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">C isco S y stems Inc, F ixed Rate Bond, C S C O 5.500 22-F eb-2016</V alue> <S ubjectN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">C isco S y stems Inc</S ubjectN ame> <S impleTy pe xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">F ixed Rate Bond</S impleTy pe> <C haracteristics xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">C S C O 5.500 22-F eb-2016</C haracteristics> </DocumentTitle> <P I xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">0x0003860206e50a6e</ P I> <RIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/S earchall_ResultS pec_1">17275RA C 6=RRP S </ RIC > </H it> ... </Result> </G etS earchall_Response_1> </Body > </E nv elope>

34.3.1.4 Search for Primary RIC using Company Name

The following request demonstrates how to search for primary RIC using company name (in this example Vodafone). XML Sample Request - Search for Primary RIC using Company Name
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/S earch/S earchall_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/S earchall_1/ G etS earchall_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etS earchall_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/S earchall_1"> <Q uery > <S earch xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/RequestDefaultF ields" Include=" tr ue "> <S tringV alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Q uery S pecDataty pes" V alue=" vodafone " N egated="false" /> </S earch> <P rimary RIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/S earchall_Q uery S pec_1" Include=" tr ue " /> </Q uery > </G etS earchall_Request_1> </Body > </E nv elope>

XML Sample Response - Search for Primary RIC using Company Name

638

TRKD API Developer's Guide

<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader> <a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/ rkd/S earch/S earchall_1/G etS earchall_1_Reply <a:/A ction> <a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </s:H eader> <Body > <G etS earchall_Response_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/S earchall_1"> <ResultH eader xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes"> <F irstH it>1</F irstH it> <LastH it>40</LastH it> <H its>40</H its> <TotalH its>253</TotalH its> <E xecutionTime>46</E xecutionTime> <Duration>94</Duration> <S pellingS uggestion>"v odafone"</S pellingS uggestion> </ResultH eader> <N av igatorList xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes" /> <Result> <H it> <BusinessE ntity xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ ResponseDefaultF ields">O RG A N IS A TIO N </BusinessE ntity > <DocumentTitle xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields"> <V alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">V odafone G roup P lc</V alue> <S ubjectN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ ResultS pecDataty pes">V odafone G roup P lc</S ubjectN ame> </DocumentTitle> <P I xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">10749</P I> <P rimary RIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/S earchall_ResultS pec_1">V O D. L</P rimary RIC > </H it> <H it> <BusinessE ntity xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ ResponseDefaultF ields">O RG A N IS A TIO N </BusinessE ntity > <DocumentTitle xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields"> <V alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">V odafone E gy pt Telecommunications C ompany </V alue> <S ubjectN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ ResultS pecDataty pes">V odafone E gy pt Telecommunications C ompany </S ubjectN ame> </DocumentTitle> <P I xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">2512496</P I> <P rimary RIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/S earchall_ResultS pec_1">V O DE . C A </P rimary RIC > </H it> ... <H it> <BusinessE ntity xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ ResponseDefaultF ields">IN S TRU M E N T.F IXE DIN C O M E .G O V C O RP </BusinessE ntity > <DocumentTitle xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields"> <V alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">V odafone G roup P LC , F ixed Rate Bond, V O D 5.125 10-A pr-2015</V alue> <S ubjectN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ ResultS pecDataty pes">V odafone G roup P LC </S ubjectN ame> <S impleTy pe xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">F ixed Rate Bond</S impleTy pe> <C haracteristics xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">V O D 5.125 10-A pr-2015</C haracteristics> </DocumentTitle> <P I xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ ResponseDefaultF ields">0x00038600556940f9</P I> </H it> </Result> </G etS earchall_Response_1> </Body > </E nv elope>

34.3.1.5 Search by Asset Category

The following example retrieves all RIC codes for Vodafone search string within ORD asset category.

Thomson Reuters Search

639

XML Sample Request - Search All Request for Items within an Asset Category
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/S earch/S earchall_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/S earchall_1/ G etS earchall_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etS earchall_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/S earchall_1"> <F ilter> < A ssetC ategor y xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/S earchall_Q uery S pec_1" Include="tr ue"> <S tringV alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Q uery S pecDataty pes" V alue="O RD" N egated="false" /> </A ssetC ategor y> </F ilter> <Q uery > < Sear ch xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/RequestDefaultF ields" Include="true"> <S tringV alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Q uery S pecDataty pes" V alue="vodafone" N egated="false" /> </Sear ch> < P r imar yRIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/S earchall_Q uery S pec_1" Include="tr ue" /> < RIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/S earchall_Q uery S pec_1" Include="tr ue" /> </Q uery > </G etS earchall_Request_1> </Body > </E nv elope>

XML Sample Response - Search All Response for Items within an Asset Category
<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader> <a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/ S earch/S earchall_1/G etS earchall_1_Reply </a:A ction> <a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etS earchall_Response_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/S earchall_1"> <ResultH eader xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes"> <F irstH it>1</F irstH it> <LastH it>5</LastH it> <H its>5</H its> <TotalH its>5</TotalH its> <E xecutionTime>46</E xecutionTime> <Duration>109</Duration> <S pellingS uggestion>"v odafone"</S pellingS uggestion> </ResultH eader> <N av igatorList xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes" /> <Result> <H it> <A ssetC ategory xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/S earchall_ResultS pec_1">O RD</ A ssetC ategory > <BusinessE ntity xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ ResponseDefaultF ields">IN S TRU M E N T.E Q U ITY</BusinessE ntity > <DocumentTitle xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields"> <V alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">V odafone A G , O rdinary S hare Issue</V alue> <S ubjectN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ ResultS pecDataty pes">V odafone A G </S ubjectN ame> <S impleTy pe xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">O rdinary S hare Issue</S impleTy pe> </DocumentTitle>

640

TRKD API Developer's Guide

<P I xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">257844</P I> <RIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/S earchall_ResultS pec_1">V DF O F .P K</ RIC > </H it> <H it> <A ssetC ategory xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/S earchall_ResultS pec_1">O RD</ A ssetC ategory > <BusinessE ntity xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ ResponseDefaultF ields">IN S TRU M E N T.E Q U ITY</BusinessE ntity > <DocumentTitle xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields"> <V alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">V odafone G roup P lc, O rdinary S hare Issue, M iF ID Top Liquidity S ecurity </V alue> <S ubjectN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ ResultS pecDataty pes">V odafone G roup P lc</S ubjectN ame> <S impleTy pe xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">O rdinary S hare Issue</S impleTy pe> <C haracteristics xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">M iF ID Top Liquidity S ecurity </C haracteristics> </DocumentTitle> <P I xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">262356</P I> <RIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/S earchall_ResultS pec_1">V O D.L</RIC > </H it> ... <H it> <A ssetC ategory xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/S earchall_ResultS pec_1">O RD</ A ssetC ategory > <BusinessE ntity xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ ResponseDefaultF ields">IN S TRU M E N T.E Q U ITY</BusinessE ntity > <DocumentTitle xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields"> <V alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">V odafoneP anafon H ellenic Telecom C ompany S A , O rdinary S hare Issue</V alue> <S ubjectN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ ResultS pecDataty pes">V odafone-P anafon H ellenic Telecom C ompany S A </S ubjectN ame> <S impleTy pe xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">O rdinary S hare Issue</S impleTy pe> </DocumentTitle> <P I xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">286428</P I> <RIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/S earchall_ResultS pec_1">V P F H F .P K</ RIC > </H it> </Result> </G etS earchall_Response_1> </Body > </E nv elope>

34.3.1.6 Retrieving RIC List From an Exchange

This request will return all RICs within London Stock Exchange by using the exchange code. XML Sample Request - Search All Request for a Specific Exchange
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/S earch/S earchall_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/S earchall_1/ G etS earchall_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etS earchall_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/S earchall_1"> <F ilter> < ExchangeC ode xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/S earchall_Q uery S pec_1" Include="tr ue" > <S tringV alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Q uery S pecDataty pes" V alue="LSE" Negated="false" /> </E xchangeC ode>

Thomson Reuters Search

641

< RIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/S earchall_Q uery S pec_1" Include="true" /> </F ilter> <Q uery /> </G etS earchall_Request_1> </Body > </E nv elope>

XML Sample Response - Search All Response for a Specific Exchange

<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader> <a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/ S earch/S earchall_1/G etS earchall_1_Reply </a:A ction> <a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etS earchall_Response_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/S earchall_1"> <ResultH eader xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes"> <F irstH it>1</F irstH it> <LastH it>40</LastH it> <H its>40</H its> <TotalH its>23385</TotalH its> <E xecutionTime>32</E xecutionTime> <Duration>78</Duration> </ResultH eader> <N av igatorList xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes" /> <Result> <H it> <BusinessE ntity xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">Q U O TE . E Q U ITY</BusinessE ntity > <P I xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">829400</P I> <DocumentTitle xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields"> <V alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">BP P lc, O rdinary , London S tock E xchange</V alue> <S ubjectN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">BP P lc</ S ubjectN ame> <S impleTy pe xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ ResultS pecDataty pes">O rdinary </S impleTy pe> <S ource xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">London S tock E xchange</S ource> </DocumentTitle> <E xchangeC ode xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/S earchall_ResultS pec_1">LS E </ E xchangeC ode> <RIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/S earchall_ResultS pec_1">BP .L</RIC > </H it> <H it> <BusinessE ntity xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">Q U O TE . E Q U ITY</BusinessE ntity > <P I xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">21264014</P I> <DocumentTitle xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields"> <V alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">Roy al Dutch S hell P lc, O rdinary , London S tock E xchange</V alue> <S ubjectN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">Roy al Dutch S hell P lc</S ubjectN ame> <S impleTy pe xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ ResultS pecDataty pes">O rdinary </S impleTy pe> <S ource xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">London S tock E xchange</S ource> </DocumentTitle> <E xchangeC ode xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/S earchall_ResultS pec_1">LS E </ E xchangeC ode> <RIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/S earchall_ResultS pec_1">RDS a.L</RIC > </H it> ... </Result> </G etS earchall_Response_1> </Body > </E nv elope>

642

TRKD API Developer's Guide

34.3.1.7 Retrieving RIC of an Exchange

This is another example on how to retrieve a RIC for a specified exchange. In this case we are retrieving a RIC for Dow Jones. Note: If you want the search performed on the whole phrase you have to put it in double quotes, otherwise, you will also get back results on individual words within the search criteria. XML Sample Request - Search All Request for a Specific Index
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/S earch/S earchall_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/S earchall_1/ G etS earchall_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etS earchall_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/S earchall_1"> <F ilter> < BusinessEntity xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/RequestDefaultF ields" Include="tr ue"> <S tringV alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Q uery S pecDataty pes" V alue="INST RUM ENT .INDEX" Negated="false" /> </BusinessE ntity > </F ilter> <Q uery > < Sear ch xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/RequestDefaultF ields" Include="true"> <S tringV alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Q uery S pecDataty pes" V alue=""dow jones industr ial aver age index"" Negated="false" /> </S earch> <P rimary RIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/S earchall_Q uery S pec_1" Include="true" /> <RIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/S earchall_Q uery S pec_1" Include="true" /> </Q uery > </G etS earchall_Request_1> </Body > </E nv elope>

XML Sample Response - Search All Response for a Specific Index

<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader> <a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" s:mustU nderstand="1">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/ S earch/S earchall_1/G etS earchall_1_Reply </a:A ction> <a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etS earchall_Response_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/S earchall_1"> <ResultH eader xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes"> <F irstH it>1</F irstH it> <LastH it>12</LastH it> <H its>12</H its> <TotalH its>12</TotalH its> <E xecutionTime>15</E xecutionTime> <Duration>453</Duration> <S pellingS uggestion>dow "lonkey industrial" av erage index</S pellingS uggestion> </ResultH eader> <N av igatorList xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes" /> <Result> <H it> <BusinessE ntity xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ ResponseDefaultF ields">IN S TRU M E N T.IN DE X</BusinessE ntity > <P I xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">271406</P I> <DocumentTitle xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields"> <V alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">Dow Jones

Thomson Reuters Search

643

Industrial A v erage Index, Index, U nited S tates</V alue> <S ubjectN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">Dow Jones Industrial A v erage Index</S ubjectN ame> <S impleTy pe xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">Index</ S impleTy pe> <C haracteristics xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">U nited S tates</C haracteristics> </DocumentTitle> <RIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/S earchall_ResultS pec_1"> .DJI </RIC > </H it> <H it> <BusinessE ntity xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ ResponseDefaultF ields">IN S TRU M E N T.IN DE X</BusinessE ntity > <P I xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">5183541</P I> <DocumentTitle xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields"> <V alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">Dow Jones Industrial A v erage Indicativ e U S D Index, Index, U nited S tates</V alue> <S ubjectN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">Dow Jones Industrial A v erage Indicativ e U S D Index</S ubjectN ame> <S impleTy pe xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">Index</ S impleTy pe> <C haracteristics xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">U nited S tates</C haracteristics> </DocumentTitle> </H it> ... </Result> </G etS earchall_Response_1> </Body > </E nv elope>

34.3.1.8 RIC Search in a Specified Exchange

This is another example on how to retrieve a RIC from a specified exchange. Here we search for the Vodafone RIC and specify the value for the exchange as LSE. By entering more descriptive search criteria you are able to reduce retrieval time. XML Sample Request - Search All Request for a Specific Index
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/S earch/S earchall_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/S earchall_1/ G etS earchall_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etS earchall_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/S earchall_1"> <F ilter> < ExchangeC ode xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/S earchall_Q uery S pec_1" Include="tr ue"> <S tringV alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Q uery S pecDataty pes" V alue="LSE" Negated="false" /> </E xchangeC ode> </F ilter> <Q uery > < Sear ch xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/RequestDefaultF ields" Include="tr ue"> <S tringV alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Q uery S pecDataty pes" V alue="vodafone" Negated="false" /> </S earch> </Q uery > </G etS earchall_Request_1> </Body > </E nv elope>

644

TRKD API Developer's Guide

XML Sample Response - Search All Response for a Specific Index

<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader> <a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" s:mustU nderstand="1">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/ S earch/S earchall_1/G etS earchall_1_Reply </a:A ction> <a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etS earchall_Response_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/S earchall_1"> <ResultH eader xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes"> <F irstH it>1</F irstH it> <LastH it>24</LastH it> <H its>24</H its> <TotalH its>24</TotalH its> <E xecutionTime>62</E xecutionTime> <Duration>125</Duration> <S pellingS uggestion>"v odafone"</S pellingS uggestion> </ResultH eader> <N av igatorList xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes" /> <Result> <H it> <BusinessE ntity xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">Q U O TE . E Q U ITY</BusinessE ntity > <P I xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">1049261</P I> <DocumentTitle xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields"> <V alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">V odafone G roup P lc, O rdinary , London S tock E xchange</V alue> <S ubjectN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">V odafone G roup P lc</S ubjectN ame> <S impleTy pe xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">O rdinary </ S impleTy pe> <S ource xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">London S tock E xchange</S ource> </DocumentTitle> <E xchangeC ode xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/S earchall_ResultS pec_1">LS E </ E xchangeC ode> </H it> <H it> <BusinessE ntity xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">Q U O TE . F IXE DIN C O M E </BusinessE ntity > <P I xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">23484205</P I> <DocumentTitle xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields"> <V alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">V odafone G roup P lc, Bond Q uote, London S tock E xchange</V alue> <S ubjectN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">V odafone G roup P lc</S ubjectN ame> <S impleTy pe xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">Bond Q uote</ S impleTy pe> <S ource xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">London S tock E xchange</S ource> </DocumentTitle> <E xchangeC ode xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/S earchall_ResultS pec_1">LS E </ E xchangeC ode> </H it> ... </Result> </G etS earchall_Response_1> </Body > </E nv elope>

34.3.1.9 Search for a RIC on the Nasdaq exchange using the ticker MSFT
The following request demonstrates how to search for a RIC on the Nasdaq exchange using the ticker 'MSFT'. XML Sample Request - Search for a RIC on the Nasdaq exchange using the ticker 'MSFT'
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope">

Thomson Reuters Search

645

<H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/S earch/S earchall_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/S earchall_1/ G etS earchall_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > < G etS earchall_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/S earchall_1"> <F ilter> <E xchangeC ode xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/S earchall_Q uery S pec_1" Include=" tr ue "> <S tringV alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Q uery S pecDataty pes" V alue=" NSQ " N egated="false" /> </E xchangeC ode> </F ilter> <Q uery > <S earch xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/RequestDefaultF ields" Include=" tr ue "> <S tringV alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Q uery S pecDataty pes" V alue=" M SFT " N egated="false" /> </S earch> <RIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/S earchall_Q uery S pec_1" Include=" tr ue " /> </Q uery > </G etS earchall_Request_1> </Body > </E nv elope>

XML Sample Response - Search for a RIC on the Nasdaq exchange using the ticker 'MSFT'
<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader> <a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/ S earch/S earchall_1/G etS earchall_1_Reply </a:A ction> <a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etS earchall_Response_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/S earchall_1"> <ResultH eader xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes"> <F irstH it>1</F irstH it> <LastH it>1</LastH it> <H its>1</H its> <TotalH its>1</TotalH its> <E xecutionTime>109</E xecutionTime> <Duration>187</Duration> </ResultH eader> <N av igatorList xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes" /> <Result> <H it> <BusinessE ntity xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">Q U O TE . E Q U ITY</BusinessE ntity > <P I xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields"> 7 3 3 3 3 7 </P I> <DocumentTitle xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields"> <V alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes"> M icr osoft C or p, O r dinar y, C onsolidated Issue Listed on NA SDA Q Global Select M ar ket</V alue> <S ubjectN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">M icrosoft C orp</S ubjectN ame> <S impleTy pe xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes ">O rdinary </S impleTy pe> <S ource xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">C onsolidated Issue Listed on N A S DA Q G lobal S elect M arket</S ource> </DocumentTitle> <E xchangeC ode xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/S earchall_ResultS pec_1">N S Q </ E xchangeC ode> <RIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/S earchall_ResultS pec_1"> M SFT .O </RIC > </H it> </Result> <Result> </G etS earchall_Response_1> </Body > </E nv elope>

646

TRKD API Developer's Guide

34.3.1.10 Retrieving a Breakdown of Search Results by Asset Class

To get a breakdown of your search results by asset class in Thomson Reuters Search, you have to add metadata to query and select navigation "= true". If you add the metadata to filter and select navigation "= true" it will not work. XML Sample Request
<G etS earchall_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/S earchall_1"> <Q uer y> <C ode Include="true" xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/RequestDefaultF ields"> <SymbolV alue ExactM atch="false" V alue="ibm" N egated="false" xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/ S earch/Q uery S pecDataty pes" /> </C ode> <BusinessE ntity Include="true" Navigation="tr ue" xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ RequestDefaultF ields" /> </Q uery > </G etS earchall_Request_1>

You can also use this feature to provide a breakdown of results by Exchange Code or by Currency for example. You cant get a breakdown by every metadata attribute, but there is a number which do support this functionality.

34.3.1.11 When to Use SearchAll and When More Specific Search Functions Like Equity Quote?
Thomson Reuters SearchAll operation takes more time but it is more convenient for a user who wants to retrieve relevant content. Specific search functions like Equity Quote or Index Instruments are faster and more targeted and they expose more metadata.

34.3.2 Organization (GetOrganisation_1)

Organization Search is a search specifically for the information on the Organization.

34.3.2.1 Service Endpoint and Required Headers

Service Endpoint Thomson Reuters Organization Search Endpoint
http://api.rkd.reuters.com/api/2006/05/01/S earch/O rganisation_1.sv c

Required Header Required HTTP Headers

P O S T /api/2006/05/01/S earch/O rganisation_1.sv c H TTP /1.1 C ontent-Ty pe: application/soap+xml H ost: w w w .api.rkd.reuters.com C ontent-Length: [length]

34.3.2.2 WSDL
WSDL:
http://api.rkd.reuters.com/schemas/w sdl/S earch/O rganisation_1_H ttpA ndRKDToken.w sdl

Thomson Reuters Search

647

34.3.2.3 Organization Search on Location

The following example retrieves information listed below for Organizations with headquarters in USA: CountryHeadquarters FundsCount LegalName Name CommonName DerivedCategory Note: Since organizations do not include derived categories, an Organization search filtered by 'DerivedCategory' will always return empty results. XML Sample Request - Organization Search in USA With Net Income Greater than One Billion
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/S earch/O rganisation_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/O rganisation_1/ G etO rganisation_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etO rganisation_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/O rganisation_1"> <F ilter> < C ountr yH eadquar ter s xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/O rganisation_Q uery S pec_1" Include="tr ue"> <S tringV alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Q uery S pecDataty pes" V alue="USA " Negated="false" /> </C ountr yH eadquar ter s> < FundsC ount xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/O rganisation_Q uery S pec_1" Include="tr ue" /> < LegalName xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/O rganisation_Q uery S pec_1" Include="tr ue" /> </F ilter> <Q uery > < C ommonName xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/RequestDefaultF ields" Include="tr ue" /> < Der ivedC ategor y xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/RequestDefaultF ields" Include="true" Navigation="tr ue" /> </Q uery > </G etO rganisation_Request_1> </Body > </E nv elope>

XML Sample Response - Organization Search in USA With Net Income Greater than One Billion
<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader> <a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" s:mustU nderstand="1">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/ S earch/O rganisation_1/G etO rganisation_1_Reply </a:A ction> <a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etO rganisation_Response_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/O rganisation_1"> <ResultH eader xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes"> <F irstH it>1</F irstH it> <LastH it>11</LastH it> <H its>11</H its> <TotalH its>11</TotalH its> <E xecutionTime>15</E xecutionTime> <Duration>31</Duration> </ResultH eader>

648

TRKD API Developer's Guide

<N av igatorList xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes" /> <Result> <H it> <BusinessE ntity xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ ResponseDefaultF ields">O RG A N IS A TIO N </BusinessE ntity > <P I xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">36999</P I> <DocumentTitle xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields"> <V alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">E xxon M obil C orp</ V alue> <S ubjectN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">E xxon M obil C orp</S ubjectN ame> </DocumentTitle> <C ommonN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/O rganisation_ResultS pec_1">E xxon M obil C orp</C ommonN ame> <C ountry H eadquarters xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ O rganisation_ResultS pec_1">U S A </C ountry H eadquarters> <F undsC ount xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/O rganisation_ResultS pec_1">0</ F undsC ount> <Industry C lassificationBenchmark xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ O rganisation_ResultS pec_1">0530</Industry C lassificationBenchmark> <LegalN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/O rganisation_ResultS pec_1">E xxon M obil C orporation</LegalN ame> <LongTermDebt xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ O rganisation_ResultS pec_1">6220000000</LongTermDebt> <N etIncome xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ O rganisation_ResultS pec_1">36130000000</N etIncome> <N etP rofit xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ O rganisation_ResultS pec_1">36130000000</N etP rofit> <N umberO fE mploy ees xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ O rganisation_ResultS pec_1">83700</N umberO fE mploy ees> </H it> <H it> <BusinessE ntity xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ ResponseDefaultF ields">O RG A N IS A TIO N </BusinessE ntity > <P I xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">37009</P I> <DocumentTitle xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields"> <V alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">G eneral E lectric C o</V alue> <S ubjectN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">G eneral E lectric C o</S ubjectN ame> </DocumentTitle> <C ommonN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ O rganisation_ResultS pec_1">G eneral E lectric C o</C ommonN ame> <C ountry H eadquarters xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ O rganisation_ResultS pec_1">U S A </C ountry H eadquarters> <F undsC ount xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/O rganisation_ResultS pec_1">0</ F undsC ount> <Industry C lassificationBenchmark xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ O rganisation_ResultS pec_1">2720</Industry C lassificationBenchmark> <LegalN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/O rganisation_ResultS pec_1">G eneral E lectric C ompany </LegalN ame> <LongTermDebt xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ O rganisation_ResultS pec_1">212281000000</LongTermDebt> <N etIncome xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ O rganisation_ResultS pec_1">18275000000</N etIncome> <N etP rofit xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ O rganisation_ResultS pec_1">18275000000</N etP rofit> <N umberO fE mploy ees xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ O rganisation_ResultS pec_1">316000</N umberO fE mploy ees> </H it> <H it> <BusinessE ntity xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ ResponseDefaultF ields">O RG A N IS A TIO N </BusinessE ntity > <P I xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">26589</P I> <DocumentTitle xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields"> <V alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">M icrosoft C orp</ V alue> <S ubjectN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">M icrosoft C orp</S ubjectN ame> </DocumentTitle> <C ommonN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ O rganisation_ResultS pec_1">M icrosoft C orp</C ommonN ame> <C ountry H eadquarters xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ O rganisation_ResultS pec_1">U S A </C ountry H eadquarters> <F undsC ount xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/O rganisation_ResultS pec_1">0</ F undsC ount> <Industry C lassificationBenchmark xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/

Thomson Reuters Search

649

O rganisation_ResultS pec_1">9530</Industry C lassificationBenchmark> <LegalN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/O rganisation_ResultS pec_1">M icrosoft C orporation</LegalN ame> <LongTermDebt xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/O rganisation_ResultS pec_1">0</ LongTermDebt> <N etIncome xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ O rganisation_ResultS pec_1">12599000000</N etIncome> <N etP rofit xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ O rganisation_ResultS pec_1">12599000000</N etP rofit> <N umberO fE mploy ees xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ O rganisation_ResultS pec_1">71000</N umberO fE mploy ees> </H it> ... </Result> </G etO rganisation_Response_1> </Body > </E nv elope>

34.3.2.4 Organization Search by Ticker

The following example searches for organization with IBM ticker: XML Sample Request - Organization Search by Ticker
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/S earch/O rganisation_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/O rganisation_1/ G etO rganisation_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etO rganisation_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/O rganisation_1"> <Q uery H eader xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Q uery S pecDataty pes"> <M axC ount>10</M axC ount> <P iv ot>0</P iv ot> <Timeout>0</Timeout> <S pellcheck>S uggest</S pellcheck> </Q uery H eader> <F ilter> <Ticker xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/O rganisation_Q uery S pec_1"> <S y mbolV alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Q uery S pecDataty pes" V alue=" IBM " /> </Ticker> </F ilter> <Q uery > <O rgid xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/O rganisation_Q uery S pec_1" Include="true" /> <Ticker xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/O rganisation_Q uery S pec_1" Include="true" /> </Q uery > </G etO rganisation_Request_1> </Body > </E nv elope>

XML Sample Response - Organization Search by Ticker

<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader> <a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" s:mustU nderstand="1">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/ S earch/O rganisation_1/G etO rganisation_1_Reply </a:A ction> <a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</a:RelatesTo> </s:H eader> <s:Body >

650

TRKD API Developer's Guide

<G etO rganisation_Response_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/O rganisation_1"> <ResultH eader xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes"> <F irstH it>1</F irstH it> <LastH it>1</LastH it> <H its>1</H its> <TotalH its>1</TotalH its> <E xecutionTime>47</E xecutionTime> <Duration>62</Duration> </ResultH eader> <N av igatorList xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes" /> <Result> <H it> <BusinessE ntity xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ ResponseDefaultF ields">O RG A N IS A TIO N </BusinessE ntity > <DocumentTitle xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields"> <V alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">International Business M achines C orp</V alue> <S ubjectN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">International Business M achines C orp</S ubjectN ame> </DocumentTitle> <O rgid xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/O rganisation_ResultS pec_1">18228</O rgid> <P I xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">37036</P I> <Ticker xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/O rganisation_ResultS pec_1">IBM </Ticker> </H it> </Result> </G etO rganisation_Response_1> </Body > </E nv elope>

34.3.3 Commodity Quote (GetCommodityQuote_Request_1)

With Commodity Quotes search you can search on Commodity information. Although it is possible to retrieve this information through Search All, the advantage of using this operation when searching on Commodities is a faster response since it only searches within the area of interest.

34.3.3.1 Service Endpoint, and Required Headers

Service Endpoint Thomson Reuters Commodity Quote Search Endpoint
http://api.rkd.reuters.com/api/2006/05/01/S earch/C ommodity Q uote_1.sv c

Required Header Required HTTP Headers

P O S T /api/2006/05/01/S earch/C ommodity Q uote_1.sv c H TTP /1.1 C ontent-Ty pe: application/soap+xml H ost: api.rkd.reuters.com C ontent-Length: [length]

34.3.3.2 WSDL
WSDL:
http://api.rkd.reuters.com/schemas/w sdl/S earch/C ommodity Q uote_1_H ttpA ndRKDToken.w sdl

Thomson Reuters Search

651

34.3.3.3 Commodity Search on Coffee

This example retrieves the following commodity information on search keywords "arabica cofee" : Asset Category Name Asset Type Currency Exchange Name ExpiryDate RIC Primary RIC XML Sample Request - Commodity Search
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/S earch/C ommodity Q uote_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ C ommodity Q uote_1/G etC ommodity Q uote_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etC ommodity Q uote_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/C ommodity Q uote_1"> <Q uery > < Sear ch xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/RequestDefaultF ields " Include="true"> <S tringV alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Q uery S pecDataty pes" V alue="ar abica coffee" Negated="false" /> </S earch> < Name xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/RequestDefaultF ields " Include="true" /> < A ssetC ategor yName xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/C ommodity Q uote_Q uery S pec_1" Include="true" /> < A ssetT ype xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/C ommodity Q uote_Q uery S pec_1" Include="true" /> < C ur r ency xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/C ommodity Q uote_Q uery S pec_1" Include="true" /> < ExchangeName xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/C ommodity Q uote_Q uery S pec_1" Include="true" /> < Expir yDate xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/C ommodity Q uote_Q uery S pec_1" Include="true" /> < P r imar yRIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/C ommodity Q uote_Q uery S pec_1" Include="true" /> < RIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/C ommodity Q uote_Q uery S pec_1" Include="true" /> </Q uery > </G etC ommodity Q uote_Request_1> </Body > </E nv elope>

XML Sample Response - Commodity Search

<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader> <a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/ S earch/C ommodity Q uote_1/G etC ommodity Q uote_1_Reply </a:A ction> <a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etC ommodity Q uote_Response_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/C ommodity Q uote_1"> <ResultH eader xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes"> <F irstH it>1</F irstH it> <LastH it>40</LastH it> <H its>40</H its> <TotalH its>82</TotalH its> <E xecutionTime>187</E xecutionTime> <Duration>344</Duration>

652

TRKD API Developer's Guide

<S pellingS uggestion>arabia coffee</S pellingS uggestion> </ResultH eader> <N av igatorList xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes" /> <Result> <H it> <BusinessE ntity xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">Q U O TE . C O M M O DITY</BusinessE ntity > <P I xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">16254</P I> <DocumentTitle xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields"> <V alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">N E W YO RK BO A RD O F TRA DE (C S C ) C O F F E E A RA BIC A F U TU RE S C H A IN , C ommodity F uture, Board of Trade of the C ity of N ew York, Inc. (C offee,S ugar and C ocoa)</V alue> <S ubjectN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">N E W YO RK BO A RD O F TRA DE (C S C ) C O F F E E A RA BIC A F U TU RE S C H A IN </S ubjectN ame> <S impleTy pe xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">C ommodity F uture</S impleTy pe> <S ource xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">Board of Trade of the C ity of N ew York, Inc. (C offee,S ugar and C ocoa)</S ource> </DocumentTitle> <A ssetC ategory N ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/C ommodity Q uote_ResultS pec_1 ">C ommodity /C ommodity F uture</A ssetC ategory N ame> <A ssetTy pe xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/C ommodity Q uote_ResultS pec_1 ">DE RIV A TIV E </A ssetTy pe> <C urrency xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/C ommodity Q uote_ResultS pec_1">U S c</ C urrency > <E xchangeN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/C ommodity Q uote_ResultS pec_1 ">Board of Trade of the C ity of N ew York, Inc. (C offee,S ugar and C ocoa)</E xchangeN ame> <RIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/C ommodity Q uote_ResultS pec_1">0#KC :</RIC > </H it> ... <H it> <BusinessE ntity xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">Q U O TE . C O M M O DITY</BusinessE ntity > <P I xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">255696</P I> <DocumentTitle xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields"> <V alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">C A M E RO O N A RA BIC A LA V E A C O F F E E E X DO C K LE H A V RE , C ommodity C ash, C ash C ommodity Rates E M E A </V alue> <S ubjectN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">C A M E RO O N A RA BIC A LA V E A C O F F E E E X DO C K LE H A V RE </S ubjectN ame> <S impleTy pe xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">C ommodity C ash</S impleTy pe> <S ource xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">C ash C ommodity Rates E M E A </S ource> </DocumentTitle> <A ssetC ategory N ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ C ommodity Q uote_ResultS pec_1">C ommodity /C ommodity C ash</A ssetC ategory N ame> <A ssetTy pe xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/C ommodity Q uote_ResultS pec_1 ">C O M M O DITY</A ssetTy pe> <C urrency xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/C ommodity Q uote_ResultS pec_1">E U R</ C urrency > <E xchangeN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/C ommodity Q uote_ResultS pec_1 ">C ash C ommodity Rates E M E A </E xchangeN ame> <RIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/C ommodity Q uote_ResultS pec_1">C F C M -LA LE H XDK</RIC > </H it> </Result> </G etC ommodity Q uote_Response_1> </Body > </E nv elope>

34.3.3.4 Commodity Search with a Filter

This example requests commodity information with a search on keyword "egyptian" and navigation set to true for Asset Category name to get the breakdown of records and Asset Categories they belong to. The Filter section contains further search criteria on AssetCategory, where we filter on specific categories: CFD,CSO,CIX, CMO, CCS, CFX, CMF, CSP, CST, CMW. The response will contain the following information: AssetCategory NavigatorList PI AssetCategoryName

Thomson Reuters Search

653

RIC XML Sample Request - Commodity Search Using a Filter

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/S earch/C ommodity Q uote_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ C ommodity Q uote_1/G etC ommodity Q uote_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etC ommodity Q uote_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/C ommodity Q uote_1"> <F ilter> < A ssetC ategor y xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/C ommodity Q uote_Q uery S pec_1" Include="tr ue"> <S tringV alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Q uery S pecDataty pes" V alue="C FD" Negated="false" /> <S tringV alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Q uery S pecDataty pes" V alue="C SO " Negated="false" /> <S tringV alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Q uery S pecDataty pes" V alue="C IX" Negated="false" /> <S tringV alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Q uery S pecDataty pes" V alue="C M O " Negated="false" /> <S tringV alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Q uery S pecDataty pes" V alue="C C S" Negated="false" /> <S tringV alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Q uery S pecDataty pes" V alue="C FX" Negated="false" /> <S tringV alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Q uery S pecDataty pes" V alue="C M F" Negated="false" /> <S tringV alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Q uery S pecDataty pes" V alue="C SP " Negated="false" /> <S tringV alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Q uery S pecDataty pes" V alue="C ST " Negated="false" /> <S tringV alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Q uery S pecDataty pes" V alue="C M W" Negated="false" /> </A ssetC ategory > </F ilter> <Q uery > < Sear ch xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/RequestDefaultF ields" Include="true"> <S tringV alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Q uery S pecDataty pes" V alue="egyptian" N egated="false" /> </S earch> < P I xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/RequestDefaultF ields" Include="true" /> < A ssetC ategor yName xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/C ommodity Q uote_Q uery S pec_1 " Include="true" Navigation="tr ue" /> < RIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/C ommodity Q uote_Q uery S pec_1" Include="true" /> </Q uery > </G etC ommodity Q uote_Request_1> </Body > </E nv elope>

XML Sample Response - Commodity Search Using a Filter

<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader> <a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/ S earch/C ommodity Q uote_1/G etC ommodity Q uote_1_Reply </a:A ction> <a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etC ommodity Q uote_Response_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/C ommodity Q uote_1"> <ResultH eader xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes"> <F irstH it>1</F irstH it> <LastH it>40</LastH it> <H its>40</H its>

654

TRKD API Developer's Guide

<TotalH its>72</TotalH its> <E xecutionTime>219</E xecutionTime> <Duration>312</Duration> </ResultH eader> <N av igatorList xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes"> <S tringN av igator F ieldN ame="A ssetC ategory N ame" H itC ount="72" E ntropy ="0" Ratio="1" S core="0" S ampleC ount="72"> <M odifier C ount="72" V alue="C ommodity /C ommodity C ash" /> </S tringN av igator> </N av igatorList> <Result> <H it> <BusinessE ntity xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">Q U O TE . C O M M O DITY</BusinessE ntity > <P I xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">6167144</P I> <DocumentTitle xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields"> <V alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">E G YP TIA N G 89 C O TTO N E G YP T F O B A LE XA N DRIA , C ommodity C ash, C ash C ommodity Rates E M E A </V alue> <S ubjectN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">E G YP TIA N G 89 C O TTO N E G YP T F O B A LE XA N DRIA </S ubjectN ame> <S impleTy pe xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">C ommodity C ash</S impleTy pe> <S ource xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">C ash C ommodity Rates E M E A </S ource> </DocumentTitle> <A ssetC ategory xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ C ommodity Q uote_ResultS pec_1">C C S </A ssetC ategory > <A ssetC ategory N ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ C ommodity Q uote_ResultS pec_1">C ommodity /C ommodity C ash</A ssetC ategory N ame> <RIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/C ommodity Q uote_ResultS pec_1">C O T-E G G 89</RIC > </H it> ... <H it> <BusinessE ntity xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">Q U O TE . C O M M O DITY</BusinessE ntity > <P I xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">38350415</P I> <DocumentTitle xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields"> <V alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">U S DA ;H ard Red Winter Wheat E xports E gy pt - Weekly N et S ales, C ommodity C ash</V alue> <S ubjectN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">U S DA ;H ard Red Winter Wheat E xports E gy pt - Weekly N et S ales</S ubjectN ame> <S impleTy pe xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">C ommodity C ash</S impleTy pe> </DocumentTitle> <A ssetC ategory xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/C ommodity Q uote_ResultS pec_1 ">C C S </A ssetC ategory > <A ssetC ategory N ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ C ommodity Q uote_ResultS pec_1">C ommodity /C ommodity C ash</A ssetC ategory N ame> <RIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/C ommodity Q uote_ResultS pec_1">H RW-WN S E G </RIC > </H it> </Result> </G etC ommodity Q uote_Response_1> </Body > </E nv elope>

34.3.4 Derivative Instruments (GetDerivativeInst_1)

This operation searches and retrieves information related to Derivative Instruments.

34.3.4.1 Service Endpoint and Required Headers

Service Endpoint Thomson Reuters Derivative Instrument Search Endpoint
http://api.rkd.reuters.com/api/2006/05/01/S earch/Deriv ativ eInst_1.sv c

Required Header

Thomson Reuters Search

655

Required HTTP Headers

P O S T /api/2006/05/01/S earch/Deriv ativ eInst_1.sv c H TTP /1.1 C ontent-Ty pe: application/soap+xml H ost: api.rkd.reuters.com C ontent-Length: [length]

34.3.4.2 WSDL
WSDL:
http://api.rkd.reuters.com/schemas/w sdl/S earch/Deriv ativ eInst_1_H ttpA ndRKDToken.w sdl

34.3.4.3 Retrieving Warrants for an Underlying Issuer

The following request retrieves records from Warrant Category for an Underlying issuer with id of 37036. The following fields are set to be returned in the response: IssuerCommonName UnderlyingQuoteRIC RIC UnderlyingIssuerPI

XML Sample Request - Derivative Instrument Search on Warrants for an Underlying Issuer
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/S earch/Deriv ativ eInst_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Deriv ativ eInst_1/ G etDeriv ativ eInst_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etDeriv ativ eInst_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Deriv ativ eInst_1"> <F ilter> < Der ivedC ategor y xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/RequestDefaultF ields" Include="tr ue"> <S tringV alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Q uery S pecDataty pes" V alue="WA RRA NT " Negated="false" /> </Deriv edC ategory > < Under lyingIssuer P I xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Deriv ativ eInst_Q uery S pec_1" Include="true"> <S tringV alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Q uery S pecDataty pes" V alue="3 7 0 3 6 " N egated="false" /> </U nderly ingIssuerP I> </F ilter> <Q uery > < Issuer C ommonName xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Deriv ativ eInst_Q uery S pec_1" Include="tr ue" /> < RIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Deriv ativ eInst_Q uery S pec_1" Include="tr ue" /> < Under lyingQ uoteRIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Deriv ativ eInst_Q uery S pec_1" Include="tr ue" /> </Q uery > </G etDeriv ativ eInst_Request_1> </Body > </E nv elope>

XML Sample Response - Derivative Instrument Search on Warrants for an Underlying Issuer
<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader>

656

TRKD API Developer's Guide

<a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/ S earch/Deriv ativ eInst_1/G etDeriv ativ eInst_1_Reply </a:A ction> <a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etDeriv ativ eInst_Response_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Deriv ativ eInst_1"> <ResultH eader xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes"> <F irstH it>1</F irstH it> <LastH it>40</LastH it> <H its>40</H its> <TotalH its>147</TotalH its> <E xecutionTime>93</E xecutionTime> <Duration>125</Duration> </ResultH eader> <N av igatorList xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes" /> <Result> <H it> <BusinessE ntity xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields ">IN S TRU M E N T.E Q U ITY</BusinessE ntity > <P I xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">24294068</P I> <DocumentTitle xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields"> <V alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">IBM O rd S hs, Warrant, H S BC Trinkaus & Burkhardt A G P U T 70.000 11-Jan-2008</V alue> <S ubjectN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">IBM O rd S hs</S ubjectN ame> <S impleTy pe xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">Warrant</ S impleTy pe> <C haracteristics xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">H S BC Trinkaus & Burkhardt A G P U T 70.000 11-Jan-2008</C haracteristics> </DocumentTitle> <IssuerC ommonN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Deriv ativ eInst_ResultS pec_1 ">H S BC Trinkaus & Burkhardt A G </IssuerC ommonN ame> <U nderly ingIssuerP I xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Deriv ativ eInst_ResultS pec_1 ">37036</U nderly ingIssuerP I> <U nderly ingQ uoteRIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Deriv ativ eInst_ResultS pec_1 ">IBM .N </U nderly ingQ uoteRIC > </H it> ... <H it> <BusinessE ntity xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields ">IN S TRU M E N T.E Q U ITY</BusinessE ntity > <P I xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">24294069</P I> <DocumentTitle xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields"> <V alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">IBM O rd S hs, Warrant, H S BC Trinkaus & Burkhardt A G P U T 70.000 15-Dec-2008</V alue> <S ubjectN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">IBM O rd S hs</S ubjectN ame> <S impleTy pe xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">Warrant</ S impleTy pe> <C haracteristics xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">H S BC Trinkaus & Burkhardt A G P U T 70.000 15-Dec-2008</C haracteristics> </DocumentTitle> <IssuerC ommonN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Deriv ativ eInst_ResultS pec_1 ">H S BC Trinkaus & Burkhardt A G </IssuerC ommonN ame> <U nderly ingIssuerP I xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Deriv ativ eInst_ResultS pec_1 ">37036</U nderly ingIssuerP I> <U nderly ingQ uoteRIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Deriv ativ eInst_ResultS pec_1 ">IBM .N </U nderly ingQ uoteRIC > </H it> </Result> </G etDeriv ativ eInst_Response_1> </Body > </E nv elope>

34.3.5 Derivative Quote (GetDerivativeQuote_1)

The DerivativeQuote operation gives the ability to search on all the derivative quote information in the Thomson Reuters index.

Thomson Reuters Search

657

34.3.5.1 Service Endpoint and Required Headers

Service Endpoint Thomson Reuters Derivative Quote Search Endpoint
http://api.rkd.reuters.com/api/2006/05/01/S earch/Deriv ativ eQ uote_1.sv c

Required Header Required HTTP Headers

P O S T /api/2006/05/01/S earch/Deriv ativ eQ uote_1.sv c H TTP /1.1 C ontent-Ty pe: application/soap+xml H ost: api.rkd.reuters.com C ontent-Length: [length]

34.3.5.2 WSDL
WSDL:
http://api.rkd.reuters.com/schemas/w sdl/S earch/Deriv ativ eQ uote_1_H ttpA ndRKDToken.w sdl

34.3.5.3 Search for Index Membership

This example demonstrates how to use Derivative Quote operation to retrieve records for a specified underlying issuer. The request also states to return the following information: CommonName ExchangeName RIC UnderlyingIssuerPI XML Sample Request - Derivative Quote Search with Underlying Issuer
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/S earch/Deriv ativ eQ uote_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ Deriv ativ eQ uote_1/G etDeriv ativ eQ uote_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etDeriv ativ eQ uote_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Deriv ativ eQ uote_1"> <F ilter> < C ommonName xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/RequestDefaultF ields" Include="tr ue" /> < ExchangeName xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Deriv ativ eQ uote_Q uery S pec_1" Include="tr ue" /> < RIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Deriv ativ eQ uote_Q uery S pec_1" Include="tr ue" / > < Under lyingIssuer P I xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Deriv ativ eQ uote_Q uery S pec_1" Include="tr ue"> <S tringV alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Q uery S pecDataty pes" V alue="3 7 0 3 6 " Negated="false" /> </U nderly ingIssuerP I> </F ilter> <Q uery > <N ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/RequestDefaultF ields" Include="true" /> </Q uery > </G etDeriv ativ eQ uote_Request_1> </Body > </E nv elope>

658

TRKD API Developer's Guide

XML Sample Response - Derivative Quote Search with Underlying Issuer

<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader> <a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/ S earch/Deriv ativ eQ uote_1/G etDeriv ativ eQ uote_1_Reply </a:A ction> <a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etDeriv ativ eQ uote_Response_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Deriv ativ eQ uote_1"> <ResultH eader xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes"> <F irstH it>1</F irstH it> <LastH it>40</LastH it> <H its>40</H its> <TotalH its>1254</TotalH its> <E xecutionTime>218</E xecutionTime> <Duration>266</Duration> </ResultH eader> <N av igatorList xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes" /> <Result> <H it> <BusinessE ntity xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">Q U O TE . E Q U ITY</BusinessE ntity > <P I xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">19136336</P I> <DocumentTitle xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields"> <V alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">LIF F E U K IBM C orporation P D E quity F uture C hain, F uture, U S D, The London International F inancial F utures and O ptions E xchange</ V alue> <S ubjectN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">LIF F E U K IBM C orporation P D E quity F uture C hain</S ubjectN ame> <S impleTy pe xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">F uture</ S impleTy pe> <C haracteristics xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">U S D</ C haracteristics> <S ource xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">The London International F inancial F utures and O ptions E xchange</S ource> </DocumentTitle> <E xchangeN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Deriv ativ eQ uote_ResultS pec_1">The London International F inancial F utures and O ptions E xchange</E xchangeN ame> <RIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Deriv ativ eQ uote_ResultS pec_1">0#IBM Xlf:</ RIC > <U nderly ingIssuerP I xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Deriv ativ eQ uote_ResultS pec_1 ">37036</U nderly ingIssuerP I> </H it> ... <H it> <BusinessE ntity xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">Q U O TE . E Q U ITY</BusinessE ntity > <P I xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">34495239</P I> <DocumentTitle xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields"> <V alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">IBM JU N 8 84 P , O ption, P U T 84.000 E U R 20-Jun-2008, E urex</V alue> <S ubjectN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">IBM JU N 8 84 P </S ubjectN ame> <S impleTy pe xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">O ption</ S impleTy pe> <C haracteristics xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">P U T 84.000 E U R 20-Jun-2008</C haracteristics> <S ource xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">E urex</S ource> </DocumentTitle> <E xchangeN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ Deriv ativ eQ uote_ResultS pec_1">E urex</E xchangeN ame> <RIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Deriv ativ eQ uote_ResultS pec_1">IBM 840R8.E X</ RIC > <U nderly ingIssuerP I xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Deriv ativ eQ uote_ResultS pec_1 ">37036</U nderly ingIssuerP I> </H it> </Result> </G etDeriv ativ eQ uote_Response_1> </Body >

Thomson Reuters Search

659

</E nv elope>

34.3.6 Equity Quote (GetEquityQuote_1)

This operation searches all Equity Quotes.

34.3.6.1 Service Endpoint and Required Headers

Service Endpoint Thomson Reuters Equity Quote Search Endpoint
http://api.rkd.reuters.com/api/2006/05/01/S earch/E quity Q uote_1.sv c

Required Header Required HTTP Headers

P O S T /api/2006/05/01/S earch/E quity Q uote_1.sv c H TTP /1.1 C ontent-Ty pe: application/soap+xml H ost: api.rkd.reuters.com C ontent-Length: [length]

34.3.6.2 WSDL
WSDL:
http://api.rkd.reuters.com/schemas/w sdl/S earch/E quity Q uote_1_H ttpA ndRKDToken.w sdl

34.3.6.3 Retrieve All RICs for a Particular Index

This example retrieves RICs from Equity Quote for Dow Jones: XML Sample Request - Search Equity Quote for a Specific Index
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/S earch/E quity Q uote_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_1/ G etE quity Q uote_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etE quity Q uote_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_1"> <F ilter/> <Q uery > < RIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_Q uery S pec_1" Include="tr ue" /> </Q uery > </G etE quity Q uote_Request_1> </Body > </E nv elope>

XML Sample Response - Search Equity Quote for a Specific Index

<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope">

660

TRKD API Developer's Guide

<s:H eader> <a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/ S earch/E quity Q uote_1/G etE quity Q uote_1_Reply </a:A ction> <a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etE quity Q uote_Response_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/G etE quity Q uote_1_Reply "> <ResultH eader xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes"> <F irstH it>1</F irstH it> <LastH it>30</LastH it> <H its>30</H its> <TotalH its>30</TotalH its> <E xecutionTime>31</E xecutionTime> <Duration>109</Duration> </ResultH eader> <N av igatorList xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes" /> <Result> <H it> <BusinessE ntity xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">Q U O TE . E Q U ITY</BusinessE ntity > <P I xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">7759230</P I> <DocumentTitle xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields"> <V alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">M icrosoft C orp, O rdinary , N A S DA Q S tock E xchange G lobal S elect M arket</V alue> <S ubjectN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">M icrosoft C orp</S ubjectN ame> <S impleTy pe xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">O rdinary </ S impleTy pe> <S ource xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">N A S DA Q S tock E xchange G lobal S elect M arket</S ource> </DocumentTitle> <IndexM embership xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ E quity Q uote_ResultS pec_1">271404/271406/271449/271455/276367/279529/280520/280586/280713/296670/315319/321391/3 25547/327496/329820/334798/334799/346454/346842/347349/356474/359012/359337/359341/367178/370142/384370/389183/ 394162/394844/400161/512390/522354/529873/5286056/5286057/5286058/5286059/5847432/6003336/6003338/6105340/6105 358/6105377/6105470/11188749/18780593/18895463/18895608/18895731/18896327/18897045/20727980</IndexM embership> < RIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_ResultS pec_1"> M SFT .O Q </ RIC > </H it> <H it> <BusinessE ntity xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">Q U O TE . E Q U ITY</BusinessE ntity > <P I xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">1090154</P I> <DocumentTitle xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields"> <V alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">G eneral E lectric C o, O rdinary , N ew York S tock E xchange</V alue> <S ubjectN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">G eneral E lectric C o</S ubjectN ame> <S impleTy pe xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">O rdinary </ S impleTy pe> <S ource xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">N ew York S tock E xchange</S ource> </DocumentTitle> <IndexM embership xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ E quity Q uote_ResultS pec_1">271404/271406/271449/271455/279529/280586/280713/296670/325547/334798/334799/340932/3 46454/346799/347349/356474/373345/384179/384370/394162/400161/529873/5286064/5286065/5286066/5286067/5847432/60 81820/6105322/6105356/6105373/6105438/6245458/11188749/18780579/18895463/18895467/18895614/18896096/18896270</ IndexM embership> < RIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_ResultS pec_1"> GE.N</RIC > </H it> ... </Result> </G etE quity Q uote_Response_1> </Body > </E nv elope>

34.3.6.4 Search for all Equity RICs from the London Stock Exchange
This example searches for all Equity RICs from the London Stock Exchange.

Thomson Reuters Search

661

XML Sample Request - Search for all Equity RICs from the London Stock Exchange
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/S earch/E quity Q uote_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_1/ G etE quity Q uote_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etE quity Q uote_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_1"> <Q uery > <E xchangeC ode xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_Q uery S pec_1" Include=" tr ue "> <S tringV alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Q uery S pecDataty pes" V alue=" LSE " N egated="false" /> </E xchangeC ode> <RIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_Q uery S pec_1" Include=" tr ue " /> </Q uery > </G etE quity Q uote_Request_1> </Body > </E nv elope>

XML Sample Response - Search for all Equity RICs from the London Stock Exchange
<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader> <a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/ S earch/E quity Q uote_1/G etE quity Q uote_1_Reply </a:A ction> <a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etE quity Q uote_Response_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_1"> <ResultH eader xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes"> <F irstH it>1</F irstH it> <LastH it>40</LastH it> <H its>40</H its> <TotalH its>4840</TotalH its> <E xecutionTime>62</E xecutionTime> <Duration>203</Duration> </ResultH eader> <N av igatorList xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes" /> <Result> <H it> <BusinessE ntity xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">Q U O TE . E Q U ITY</BusinessE ntity > <DocumentTitle xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields"> <V alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes"> Royal Dutch Shell P lc, O r dinar y, M iFID T op Liquidity Secur ity, London Stock Exchange </V alue> <S ubjectN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">Roy al Dutch S hell P lc</S ubjectN ame> <S impleTy pe xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">O rdinary </ S impleTy pe> <C haracteristics xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">M iF ID Top Liquidity S ecurity </C haracteristics> <S ource xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">London S tock E xchange</S ource> </DocumentTitle> <E xchangeC ode xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_ResultS pec_1">LS E </ E xchangeC ode> <P I xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">21264014</P I> <RIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_ResultS pec_1"> RDSa.L </RIC > </H it> .... <H it> <BusinessE ntity xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">Q U O TE . E Q U ITY</BusinessE ntity >

662

TRKD API Developer's Guide

<DocumentTitle xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields"> <V alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes"> J Sainsbur y P LC , O r dinar y, M iFID T op Liquidity Secur ity, London Stock Exchange </V alue> <S ubjectN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">J S ainsbury P LC </S ubjectN ame> <S impleTy pe xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">O rdinary </ S impleTy pe> <C haracteristics xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">M iF ID Top Liquidity S ecurity </C haracteristics> <S ource xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">London S tock E xchange</S ource> </DocumentTitle> <E xchangeC ode xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_ResultS pec_1">LS E </ E xchangeC ode> <P I xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">1049304</P I> <RIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_ResultS pec_1"> SBRY .L </RIC > </H it> </Result> </G etE quity Q uote_Response_1> </Body > </E nv elope>

34.3.6.5 Search for IBM trading on a number of Named Exchanges (New York, Hamburg and Euro TLX)
This example shows how to search for IBM trading on a number of Named Exchanges (New York, Hamburg and Euro TLX). XML Sample Request - Search for IBM trading on a number of Named Exchanges (New York, Hamburg and Euro TLX)
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/S earch/E quity Q uote_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_1/ G etE quity Q uote_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etE quity Q uote_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_1"> <F ilter> <E xchangeC ode xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_Q uery S pec_1" Include=" tr ue "> <S tringV alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Q uery S pecDataty pes" V alue=" NY S " N egated="false" /> <S tringV alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Q uery S pecDataty pes" V alue=" H A M " N egated="false" /> <S tringV alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Q uery S pecDataty pes" V alue=" ET X " N egated="false" /> </E xchangeC ode> </F ilter> <Q uery > <S earch xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/RequestDefaultF ields" Include=" tr ue "> <S tringV alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Q uery S pecDataty pes" V alue=" IBM " N egated="false" /> </S earch> </Q uery > </G etE quity Q uote_Request_1> </Body > </E nv elope>

XML Sample Response - Search for IBM trading on a number of Named Exchanges (New York, Hamburg and Euro TLX)

Thomson Reuters Search

663

<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader> <a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/ S earch/E quity Q uote_1/G etE quity Q uote_1_Reply </a:A ction> <a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etE quity Q uote_Response_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_1"> <ResultH eader xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes"> <F irstH it>1</F irstH it> <LastH it>3</LastH it> <H its>3</H its> <TotalH its>3</TotalH its> <E xecutionTime>0</E xecutionTime> <Duration>47</Duration> </ResultH eader> <N av igatorList xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes" /> <Result> <H it> <BusinessE ntity xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">Q U O TE . E Q U ITY</BusinessE ntity > <DocumentTitle xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields"> <V alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes"> Inter national Business M achines C or p, O r dinar y, New Y or k Stock Exchange </V alue> <S ubjectN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ ResultS pecDataty pes">International Business M achines C orp</S ubjectN ame> <S impleTy pe xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ ResultS pecDataty pes">O rdinary </S impleTy pe> <S ource xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">N ew York S tock E xchange</S ource> </DocumentTitle> <E xchangeC ode xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ E quity Q uote_ResultS pec_1">N YS </E xchangeC ode> <P I xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields"> 1 0 9 0 3 7 0 </P I> </H it> <H it> <BusinessE ntity xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">Q U O TE . E Q U ITY</BusinessE ntity > <DocumentTitle xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields"> <V alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes"> Inter national Business M achines C or p, O r dinar y, H ambur g Stock Exchange </V alue> <S ubjectN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ ResultS pecDataty pes">International Business M achines C orp</S ubjectN ame> <S impleTy pe xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ ResultS pecDataty pes">O rdinary </S impleTy pe> <S ource xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">H amburg S tock E xchange</S ource> </DocumentTitle> <E xchangeC ode xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ E quity Q uote_ResultS pec_1">H A M </E xchangeC ode> <P I xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields"> 9 8 6 7 3 7 </P I> </H it> <H it> <BusinessE ntity xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">Q U O TE . E Q U ITY</BusinessE ntity > <DocumentTitle xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields"> <V alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes"> Inter national Business M achines C or p, O r dinar y, Eur o T LX </V alue> <S ubjectN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ ResultS pecDataty pes">International Business M achines C orp</S ubjectN ame> <S impleTy pe xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ ResultS pecDataty pes">O rdinary </S impleTy pe> <S ource xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">E uro TLX</ S ource> </DocumentTitle> <E xchangeC ode xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ E quity Q uote_ResultS pec_1">E TX</E xchangeC ode> <P I xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields"> 2 6 9 2 4 0 6 8 </P I> </H it> </Result> </G etE quity Q uote_Response_1> </Body > </E nv elope>

664

TRKD API Developer's Guide

34.3.6.6 Search for Quote Detail by Issuer Ticker

This example shows how to search for quote detail by Issuer Ticker ("IBM"). The response will also return the following values: EstimateData IsPrimaryRIC IssuerTicker IssuerMXID XML Sample Request - Search for Quote Detail by Issuer Ticker
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/S earch/E quity Q uote_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_1/ G etE quity Q uote_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etE quity Q uote_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_1"> <Q uery H eader xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Q uery S pecDataty pes"> <M axC ount>10</M axC ount> <P iv ot>0</P iv ot> <Timeout>0</Timeout> <S pellcheck>S uggest</S pellcheck> </Q uery H eader> <F ilter> <IsP rimary RIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_Q uery S pec_1"> <BooleanV alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Q uery S pecDataty pes" V alue="tr ue" /> </IsP rimary RIC > < Issuer T icker xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_Q uery S pec_1"> <S y mbolV alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Q uery S pecDataty pes" V alue="IBM " /> </IssuerTicker> </F ilter> <Q uery > <E stimateData xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_Q uery S pec_1" Include="tr ue" /> <E stimateList xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_Q uery S pec_1" Include="tr ue" / > <IsP rimary RIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_Q uery S pec_1" Include="tr ue" /> <IssuerTicker xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_Q uery S pec_1" Include="tr ue" / > <IssuerM XID xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_Q uery S pec_1" Include="tr ue" / > </Q uery > </G etE quity Q uote_Request_1> </Body > </E nv elope>

XML Sample Response - Search for Quote Detail by Issuer Ticker

<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader> <a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1"> http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/ S earch/E quity Q uote_1/G etE quity Q uote_1_Reply </a:A ction> <a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etE quity Q uote_Response_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_1"> <ResultH eader xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes"> <F irstH it>1</F irstH it>

Thomson Reuters Search

665

<LastH it>1</LastH it> <H its>1</H its> <TotalH its>1</TotalH its> <E xecutionTime>78</E xecutionTime> <Duration>63</Duration> </ResultH eader> <N av igatorList xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes" /> <Result> <H it> <BusinessE ntity xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">Q U O TE . E Q U ITY</BusinessE ntity > <DocumentTitle xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields"> <V alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes"> Inter national Business M achines C or p, O r dinar y, New Y or k C onsolidated </V alue> <S ubjectN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ ResultS pecDataty pes">International Business M achines C orp</S ubjectN ame> <S impleTy pe xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">O rdinary </ S impleTy pe> <S ource xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">N ew York C onsolidated</S ource> </DocumentTitle> <IsP rimary RIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_ResultS pec_1">true</ IsP rimary RIC > <IssuerM XID xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ E quity Q uote_ResultS pec_1">100085757</IssuerM XID> <IssuerTicker xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_ResultS pec_1">IBM </ IssuerTicker> <P I xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">1097326</P I> </H it> </Result> </G etE quity Q uote_Response_1> </Body > </E nv elope>

34.3.6.7 Search for Quote Detail by Issuer MXID

This example shows how to search for quote detail by Issuer MXID ("100085757"). XML Sample Request - Search for Quote Detail by Issuer MXID
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/S earch/E quity Q uote_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_1/ G etE quity Q uote_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etE quity Q uote_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_1"> <Q uery H eader xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Q uery S pecDataty pes"> <M axC ount>10</M axC ount> <P iv ot>0</P iv ot> <Timeout>0</Timeout> <S pellcheck>S uggest</S pellcheck> </Q uery H eader> <F ilter> <IsP rimary RIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_Q uery S pec_1"> <BooleanV alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Q uery S pecDataty pes" V alue="tr ue" /> </IsP rimary RIC > < Issuer M XID xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_Q uery S pec_1"> <S y mbolV alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Q uery S pecDataty pes" E xactM atch="false" V alue="1 0 0 0 8 5 7 5 7 " Negated="false" /> </IssuerM XID> </F ilter> <Q uery > <E stimateData xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_Q uery S pec_1" Include="tr ue" />

666

TRKD API Developer's Guide

<IsP rimary RIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_Q uery S pec_1" Include="tr ue" /> <IssuerM XID xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_Q uery S pec_1" Include="tr ue" / > <IssuerTicker xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_Q uery S pec_1" Include="tr ue" / > </Q uery > </G etE quity Q uote_Request_1> </Body > </E nv elope>

XML Sample Response - Search for Quote Detail by Issuer MXID

<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader> <a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/ S earch/E quity Q uote_1/G etE quity Q uote_1_Reply </a:A ction> <a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etE quity Q uote_Response_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_1"> <ResultH eader xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes"> <F irstH it>1</F irstH it> <LastH it>1</LastH it> <H its>1</H its> <TotalH its>1</TotalH its> <E xecutionTime>62</E xecutionTime> <Duration>78</Duration> </ResultH eader> <N av igatorList xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes" /> <Result> <H it> <BusinessE ntity xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">Q U O TE . E Q U ITY</BusinessE ntity > <DocumentTitle xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields"> <V alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes"> Inter national Business M achines C or p, O r dinar y, New Y or k C onsolidated </V alue> <S ubjectN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ ResultS pecDataty pes">International Business M achines C orp</S ubjectN ame> <S impleTy pe xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">O rdinary </ S impleTy pe> <S ource xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">N ew York C onsolidated</S ource> </DocumentTitle> <IsP rimary RIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_ResultS pec_1">true</ IsP rimary RIC > <IssuerM XID xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ E quity Q uote_ResultS pec_1">100085757</IssuerM XID> <IssuerTicker xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_ResultS pec_1">IBM </ IssuerTicker> <P I xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">1097326</P I> </H it> </Result> </G etE quity Q uote_Response_1> </Body > </E nv elope>

34.3.6.8 Search for Quote Detail by Estimate ID

This example shows how to search for quote detail by Estimate ID ("CA_A2651_1"). XML Sample Request - Search for Quote Detail by Estimate ID
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/S earch/E quity Q uote_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID>

Thomson Reuters Search

667

<A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_1/ G etE quity Q uote_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etE quity Q uote_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_1"> <Q uery H eader xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Q uery S pecDataty pes"> <M axC ount>5</M axC ount> <P iv ot>0</P iv ot> <Timeout>0</Timeout> <S pellcheck>O n</S pellcheck> </Q uery H eader> <F ilter> <E stimateData xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_Q uery S pec_1" Include="true"> <S tringV alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Q uery S pecDataty pes" V alue="C A _A 2 6 5 1 _1 " Negated="false" /> </E stimateData> <IsP rimary RIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_Q uery S pec_1" Include="tr ue" /> <IssuerM XID xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_Q uery S pec_1" Include="tr ue" / > </F ilter> <Q uery /> </G etE quity Q uote_Request_1> </Body > </E nv elope>

XML Sample Response - Search for Quote Detail by Estimate ID

<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader> <a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/ S earch/E quity Q uote_1/G etE quity Q uote_1_Reply </a:A ction> <a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etE quity Q uote_Response_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_1"> <ResultH eader xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes"> <F irstH it>1</F irstH it> <LastH it>5</LastH it> <H its>5</H its> <TotalH its>17</TotalH its> <E xecutionTime>94</E xecutionTime> <Duration>109</Duration> </ResultH eader> <N av igatorList xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes" /> <Result> <H it> <BusinessE ntity xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">Q U O TE . E Q U ITY</BusinessE ntity > <DocumentTitle xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields"> <V alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes"> T homson Reuter s C or por ation, O r dinar y, T he T or onto Stock Exchange </V alue> <S ubjectN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">Thomson Reuters C orporation</S ubjectN ame> <S impleTy pe xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">O rdinary </ S impleTy pe> <S ource xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">The Toronto S tock E xchange</S ource> </DocumentTitle> <E stimateData xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_ResultS pec_1"> <E stimateID xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ ResultS pecDataty pes">C A _A 2651_1</E stimateID> <Repno xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">A 2651</Repno> <RepnoN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">"Thomson Reuters C orporation"</RepnoN ame> <P ricingRIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">TRI.TO </ P ricingRIC > <E stimateA ctiv e xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">True</

668

TRKD API Developer's Guide

E stimateA ctiv e> <E stimateC ountry xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">C A N </ E stimateC ountry > <E stimateC urrency xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">U S D</ E stimateC urrency > <E stimateE xchange xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">TS E </ E stimateE xchange> <E stimateIssueID xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">1</ E stimateIssueID> </E stimateData> ... <E stimateData xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_ResultS pec_1"> <E stimateID xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ ResultS pecDataty pes">U S _A 489F _1</E stimateID> <Repno xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">A 489F </Repno> <RepnoN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">"Thomson Reuters C orporation (U S A )"</RepnoN ame> <P ricingRIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">TRI</ P ricingRIC > <E stimateA ctiv e xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">True</ E stimateA ctiv e> <E stimateC ountry xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">U S A </ E stimateC ountry > <E stimateC urrency xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">U S D</ E stimateC urrency > <E stimateE xchange xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ ResultS pecDataty pes">N YS E </E stimateE xchange> <E stimateIssueID xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">1</ E stimateIssueID> </E stimateData> <IsP rimary RIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_ResultS pec_1">true</ IsP rimary RIC > <IssuerM XID xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ E quity Q uote_ResultS pec_1">100042713</IssuerM XID> <P I xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">748450</P I> </H it> ... <H it> <BusinessE ntity xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">Q U O TE . E Q U ITY</BusinessE ntity > <DocumentTitle xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields"> <V alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes"> T homson Reuter s C or por ation, O r dinar y, NY SE A r ca </V alue> <S ubjectN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">Thomson Reuters C orporation</S ubjectN ame> <S impleTy pe xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">O rdinary </ S impleTy pe> <S ource xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">N YS E A rca</ S ource> </DocumentTitle> <E stimateData xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_ResultS pec_1"> <E stimateID xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ ResultS pecDataty pes">C A _A 2651_1</E stimateID> <Repno xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">A 2651</Repno> <RepnoN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">"Thomson Reuters C orporation"</RepnoN ame> <P ricingRIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">TRI.TO </ P ricingRIC > <E stimateA ctiv e xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">True</ E stimateA ctiv e> <E stimateC ountry xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">C A N </ E stimateC ountry > <E stimateC urrency xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">U S D</ E stimateC urrency > <E stimateE xchange xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">TS E </ E stimateE xchange> <E stimateIssueID xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">1</ E stimateIssueID> </E stimateData> ... <E stimateData xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_ResultS pec_1"> <E stimateID xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ ResultS pecDataty pes">U S _A 489F _1</E stimateID> <Repno xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">A 489F </Repno> <RepnoN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">"Thomson Reuters C orporation (U S A )"</RepnoN ame> <P ricingRIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">TRI</

Thomson Reuters Search

669

P ricingRIC > <E stimateA ctiv e xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">True</ E stimateA ctiv e> <E stimateC ountry xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">U S A </ E stimateC ountry > <E stimateC urrency xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">U S D</ E stimateC urrency > <E stimateE xchange xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ ResultS pecDataty pes">N YS E </E stimateE xchange> <E stimateIssueID xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">1</ E stimateIssueID> </E stimateData> <IsP rimary RIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_ResultS pec_1">false</ IsP rimary RIC > <IssuerM XID xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ E quity Q uote_ResultS pec_1">100042713</IssuerM XID> <P I xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">8002074</P I> </H it> </Result> </G etE quity Q uote_Response_1> </Body > </E nv elope>

34.3.6.9 Retrieving MXID by Company Name

This request returns MXID by company name. XML Sample Request - Retrieving MXID by Company Name
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/S earch/S earchall_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/S earchall_1/ G etS earchall_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etE quity Q uote_Request_1 xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema" xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_1"> <F ilter> <IsP rimary RIC Include="true" xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_Q uery S pec_1"> <BooleanV alue V alue="true" xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Q uery S pecDataty pes"/> </IsP rimary RIC > <RIC Include="true" xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_Q uery S pec_1"/> </F ilter> <Q uery > < Name Include ="true" xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/RequestDefaultF ields"> <S tringV alue V alue=" M icr osoft" N egated="false" xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ Q uery S pecDataty pes"/> </N ame> < Issuer M XID Include ="true" xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_Q uery S pec_1"/ > </Q uery > </G etE quity Q uote_Request_1> </Body > </E nv elope>

XML Sample Response - Retrieving MXID by Company Name

<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader> <a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/ S earch/S earchall_1/G etS earchall_1_Reply </a:A ction>

670

TRKD API Developer's Guide

<a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etE quity Q uote_Response_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_1"> <ResultH eader xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes"> <F irstH it>1</F irstH it> <LastH it>1</LastH it> <H its>1</H its> <TotalH its>1</TotalH its> <E xecutionTime>282</E xecutionTime> <Duration>328</Duration> </ResultH eader> <N av igatorList xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes"/> <Result> <H it> <BusinessE ntity xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">Q U O TE . E Q U ITY</BusinessE ntity > <DocumentTitle xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields"> <V alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">M icrosoft C orp, O rdinary , C onsolidated Issue Listed on N A S DA Q G lobal S elect M arket</V alue> <S ubjectN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">M icrosoft C orp</S ubjectN ame> <S impleTy pe xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">O rdinary </ S impleTy pe> <S ource xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">C onsolidated Issue Listed on N A S DA Q G lobal S elect M arket</S ource> </DocumentTitle> <IsP rimary RIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_ResultS pec_1">true</ IsP rimary RIC > < Issuer M XID xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_ResultS pec_1"> 1 0 0 0 8 9 3 5 9 </IssuerM XID> <P I xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">733337</P I> <RIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_ResultS pec_1">M S F T.O </RIC > </H it> </Result> </G etE quity Q uote_Response_1> </Body > </E nv elope>

34.3.6.10 Retrieving MXID by Company Symbol

This request returns MXID by company symbol. XML Sample Request - Retrieving MXID by Company Symbol
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/S earch/S earchall_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/S earchall_1/ G etS earchall_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etE quity Q uote_Request_1 xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema" xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_1"> <F ilter> <C ode Include="true" xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/RequestDefaultF ields"> < SymbolV alue E xactM atch="false" V alue=" T RIL " N egated="false" xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/ rkd/S earch/Q uery S pecDataty pes" /> < SymbolV alue E xactM atch="false" V alue=" M SFT " N egated="false" xmlns="http://w w w .reuters.com/ns/2006/05/01/ w ebserv ices/rkd/S earch/Q uery S pecDataty pes" /> </C ode> <IsP rimary RIC Include="true" xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_Q uery S pec_1"> <BooleanV alue V alue="true" xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Q uery S pecDataty pes" /> </IsP rimary RIC > <RIC Include="true" xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_Q uery S pec_1" />

Thomson Reuters Search

671

</F ilter> <Q uery > <IssuerM XID Include="true" xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_Q uery S pec_1" /> </Q uery > </G etE quity Q uote_Request_1> </Body > </E nv elope>

XML Sample Response - Retrieving MXID by Company Symbol

<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader> <a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/ S earch/S earchall_1/G etS earchall_1_Reply </a:A ction> <a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etE quity Q uote_Response_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_1"> <ResultH eader xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes"> <F irstH it>1</F irstH it> <LastH it>5</LastH it> <H its>5</H its> <TotalH its>5</TotalH its> <E xecutionTime>375</E xecutionTime> <Duration>422</Duration> </ResultH eader> <N av igatorList xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes"/> <Result> <H it> <BusinessE ntity xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">Q U O TE . E Q U ITY</BusinessE ntity > <DocumentTitle xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields"> <V alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">M icrosoft C orp, O rdinary , C onsolidated Issue Listed on N A S DA Q G lobal S elect M arket</V alue> <S ubjectN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">M icrosoft C orp</S ubjectN ame> <S impleTy pe xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">O rdinary </ S impleTy pe> <S ource xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">C onsolidated Issue Listed on N A S DA Q G lobal S elect M arket</S ource> </DocumentTitle> <IsP rimary RIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_ResultS pec_1">true</ IsP rimary RIC > < Issuer M XID xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_ResultS pec_1"> 1 0 0 0 8 9 3 5 9 </IssuerM XID> <P I xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">733337</P I> <RIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_ResultS pec_1">M S F T.O </RIC > </H it> <H it> <BusinessE ntity xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">Q U O TE . E Q U ITY</BusinessE ntity > <DocumentTitle xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields"> <V alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">Thomson Reuters P LC , O rdinary , M iF ID Top Liquidity S ecurity , London S tock E xchange</V alue> <S ubjectN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">Thomson Reuters P LC </S ubjectN ame> <S impleTy pe xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">O rdinary </ S impleTy pe> <C haracteristics xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">M iF ID Top Liquidity S ecurity </C haracteristics> <S ource xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">London S tock E xchange</S ource> </DocumentTitle> <IsP rimary RIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_ResultS pec_1">true</ IsP rimary RIC > < Issuer M XID xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_ResultS pec_1"> 1 0 6 8 6 7 6 0 0 </IssuerM XID> <P I xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">1049418</P I> <RIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_ResultS pec_1">TRIL.L</RIC > </H it> <H it> <BusinessE ntity xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">Q U O TE .

672

TRKD API Developer's Guide

E Q U ITY</BusinessE ntity > <DocumentTitle xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields"> <V alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">M egasoft Ltd, O rdinary , Bombay S tock E xchange</V alue> <S ubjectN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">M egasoft Ltd</S ubjectN ame> <S impleTy pe xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">O rdinary </ S impleTy pe> <S ource xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">Bombay S tock E xchange</S ource> </DocumentTitle> <IsP rimary RIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_ResultS pec_1">true</ IsP rimary RIC > <P I xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">13743734</P I> <RIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_ResultS pec_1">M S F T.BO </ RIC > </H it> <H it> <BusinessE ntity xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">Q U O TE . E Q U ITY</BusinessE ntity > <DocumentTitle xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields"> <V alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">M asafat F or S pecialized Transportation, O rdinary , A mman F inancial M arket</V alue> <S ubjectN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">M asafat F or S pecialized Transportation</S ubjectN ame> <S impleTy pe xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">O rdinary </ S impleTy pe> <S ource xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">A mman F inancial M arket</S ource> </DocumentTitle> <IsP rimary RIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_ResultS pec_1">true</ IsP rimary RIC > <P I xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">27422658</P I> <RIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_ResultS pec_1">M S F T.A M </ RIC > </H it> <H it> <BusinessE ntity xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">Q U O TE . E Q U ITY</BusinessE ntity > <DocumentTitle xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields"> <V alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">Transcon Research &amp; Infotech Ltd, O rdinary , Bombay S tock E xchange</V alue> <S ubjectN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">Transcon Research &amp; Infotech Ltd</S ubjectN ame> <S impleTy pe xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">O rdinary </ S impleTy pe> <S ource xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">Bombay S tock E xchange</S ource> </DocumentTitle> <IsP rimary RIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_ResultS pec_1">true</ IsP rimary RIC > <P I xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">1148553</P I> <RIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_ResultS pec_1">TRIL.BO </RIC > </H it> </Result> </G etE quity Q uote_Response_1> </Body > </E nv elope>

34.3.6.11 Retrieving Estimate ID by Company Name

This request returns EstimateID by company name. XML Sample Request - Retrieving EstimateID by Company Name
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/S earch/S earchall_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/S earchall_1/ G etS earchall_1</A ction>

Thomson Reuters Search

673

<A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etE quity Q uote_Request_1 xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema" xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_1"> <F ilter> <IsP rimary RIC Include="true" xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_Q uery S pec_1"> <BooleanV alue V alue="true" xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Q uery S pecDataty pes"/> </IsP rimary RIC > <RIC Include="true" xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_Q uery S pec_1"/> </F ilter> <Q uery > < Name Include ="true" xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/RequestDefaultF ields"> <S tringV alue V alue=" M icr osoft" N egated="false" xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ Q uery S pecDataty pes"/> </N ame> < EstimateData Include =" tr ue " xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ E quity Q uote_Q uery S pec_1"/> </Q uery > </G etE quity Q uote_Request_1> </Body > </E nv elope>

34.3.6.12 Retrieving Estimate IDs by Company Symbols

This request returns Estimate IDs by company symbols. XML Sample Request - Retrieving Estimate IDs by Company Symbols
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/S earch/S earchall_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/S earchall_1/ G etS earchall_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etE quity Q uote_Request_1 xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema" xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_1"> <F ilter> <C ode Include="true" xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/RequestDefaultF ields"> < SymbolV alue E xactM atch="false" V alue=" T RIL " N egated="false" xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/ rkd/S earch/Q uery S pecDataty pes" /> < SymbolV alue E xactM atch="false" V alue=" M SFT " N egated="false" xmlns="http://w w w .reuters.com/ns/2006/05/01/ w ebserv ices/rkd/S earch/Q uery S pecDataty pes" /> </C ode> <IsP rimary RIC Include="true" xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_Q uery S pec_1"> <BooleanV alue V alue="true" xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Q uery S pecDataty pes" /> </IsP rimary RIC > <RIC Include="true" xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/E quity Q uote_Q uery S pec_1" /> </F ilter> <Q uery > < EstimateData Include =" tr ue " xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ E quity Q uote_Q uery S pec_1" /> </Q uery > </G etE quity Q uote_Request_1> </Body > </E nv elope>

674

TRKD API Developer's Guide

34.3.7 Fund Quote (GetFundQuote_1)

This operation gives access and ability to search on information related to Fund Quotes.

34.3.7.1 Service Endpoint and Required Headers

Service Endpoint Thomson Reuters Fund Quote Search Endpoint
http://api.rkd.reuters.com/api/2006/05/01/S earch/F undQ uote_1.sv c

Required Header Required HTTP Headers

P O S T /api/2006/05/01/S earch/F undQ uote_1.sv c H TTP /1.1 C ontent-Ty pe: application/soap+xml H ost: api.rkd.reuters.com C ontent-Length: [length]

34.3.7.2 WSDL
WSDL:
http://api.rkd.reuters.com/schemas/w sdl/S earch/F undQ uote_1_H ttpA ndRKDToken.w sdl

34.3.7.3 Fund Search with Currency and Exchange Information

The following example searches for funds for BankINV dealing in Euros on the Copenhagen Stock Exchange. The request is set to return the following information: Currency ExchangeName CommonName RIC

XML Sample Request -Search Fund Quote with Currency and Exchange Information
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/S earch/F undQ uote_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/F undQ uote_1/ G etF undQ uote_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etF undQ uote_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/F undQ uote_1"> <F ilter> < C ur r ency xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/F undQ uote_Q uery S pec_1" Include="tr ue" > <S tringV alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Q uery S pecDataty pes" V alue="Eur " Negated="false" /> </C urrency > < ExchangeName xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/F undQ uote_Q uery S pec_1" Include="true"> <S tringV alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Q uery S pecDataty pes" V alue="C openhagen Stock Exchange" Negated="false" /> </E xchangeN ame>

Thomson Reuters Search

675

</F ilter> <Q uery > < Sear ch xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/RequestDefaultF ields" Include="tr ue"> <S tringV alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Q uery S pecDataty pes" V alue="BankInv" Negated="false" /> </S earch> < C ommonName xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/RequestDefaultF ields" Include="tr ue" /> < RIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/F undQ uote_Q uery S pec_1" Include="tr ue" /> </Q uery > </G etF undQ uote_Request_1> </Body > </E nv elope>

XML Sample Response - Search Fund Quote with Currency and Exchange Information
<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader> <a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/ S earch/F undQ uote_1/G etF undQ uote_1_Reply </a:A ction> <a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etF undQ uote_Response_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/F undQ uote_1"> <ResultH eader xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes"> <F irstH it>1</F irstH it> <LastH it>2</LastH it> <H its>2</H its> <TotalH its>2</TotalH its> <E xecutionTime>0</E xecutionTime> <Duration>78</Duration> <S pellingS uggestion>"banking"</S pellingS uggestion> </ResultH eader> <N av igatorList xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes" /> <Result> <H it> <BusinessE ntity xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">Q U O TE . F U N D</BusinessE ntity > <P I xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">22400857</P I> <DocumentTitle xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields"> <V alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">BankInv G l E mkt O pen F und, O pen F und, E U R, C openhagen S tock E xchange</V alue> <S ubjectN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">BankInv G l E mkt O pen F und</S ubjectN ame> <S impleTy pe xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">O pen F und</S impleTy pe> <C haracteristics xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">E U R</ C haracteristics> <S ource xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">C openhagen S tock E xchange</S ource> </DocumentTitle> <C ommonN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ F undQ uote_ResultS pec_1">BA N KIN V G L E M KT</C ommonN ame> <C urrency xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/F undQ uote_ResultS pec_1">E U R</ C urrency > <E xchangeN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ F undQ uote_ResultS pec_1">C openhagen S tock E xchange</E xchangeN ame> <RIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/F undQ uote_ResultS pec_1">BA IG E M .C O </ RIC > </H it> <H it> <BusinessE ntity xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">Q U O TE . F U N D</BusinessE ntity > <P I xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">22401235</P I> <DocumentTitle xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields"> <V alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">BankInv G l E m Bd O pen F und, O pen F und, E U R, C openhagen S tock E xchange</V alue> <S ubjectN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">BankInv G l E m Bd O pen F und</S ubjectN ame> <S impleTy pe xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">O pen F und</S impleTy pe> <C haracteristics xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">E U R</

676

TRKD API Developer's Guide

C haracteristics> <S ource xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">C openhagen S tock E xchange</S ource> </DocumentTitle> <C ommonN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ F undQ uote_ResultS pec_1">BA N KIN V G L E M BD</C ommonN ame> <C urrency xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/F undQ uote_ResultS pec_1">E U R</ C urrency > <E xchangeN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ F undQ uote_ResultS pec_1">C openhagen S tock E xchange</E xchangeN ame> <RIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/F undQ uote_ResultS pec_1">BA IE M B.C O </ RIC > </H it> </Result> </G etF undQ uote_Response_1> </Body > </E nv elope>

34.3.8 Government and Corporate Bond Instruments (GetGovCorpInst_1)

This operation makes available all Government and Corporate Bonds at instrument level. Instrument level is used to store all details about a Bonds terms and conditions.

34.3.8.1 Service Endpoint and Required Headers

Service Endpoint Thomson Reuters Government and Corporate Bond Instruments Search Endpoint
http://api.rkd.reuters.com/api/2006/05/01/S earch/G ov C orpInst_1.sv c

Required Header Required HTTP Headers

P O S T /api/2006/05/01/S earch/G ov C orpInst_1.sv c H TTP /1.1 C ontent-Ty pe: application/soap+xml H ost: api.rkd.reuters.com C ontent-Length: [length]

34.3.8.2 WSDL
WSDL:
http://api.rkd.reuters.com/schemas/w sdl/S earch/G ov C orpInst_1_H ttpA ndRKDToken.w sdl

34.3.8.3 Search on Government and Corporate Bond Instruments

The example below demonstrates a Government and Corporate Bond Instruments search by using Contributor Code, Coupon Rate, a range for Maturity Date and Moodys Rating Ranking as search criteria. The search retrieves the following information: CouponRate MaturityDate RIC XML Sample Request - Search Fund Quote with Currency and Exchange Information
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/S earch/G ov C orpInst_1.sv c</To>

Thomson Reuters Search

677

<M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/G ov C orpInst_1/ G etG ov C orpInst_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etG ov C orpInst_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/G ov C orpInst_1"> <F ilter> < C ouponRate xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/G ov C orpInst_Q uery S pec_1" Include="tr ue"> <N umberV alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Q uery S pecDataty pes" Expr essionT ype="Gr eater T han" V alue="9 " Negated="false" /> </C ouponRate> < M atur ityDate xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/G ov C orpInst_Q uery S pec_1" Include="tr ue"> <DateV alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Q uery S pecDataty pes" Expr essionT ype="Gr eater T han" V alue="2 0 0 7 -0 1 -0 1 " Negated="false" /> </M aturity Date> </F ilter> <Q uery > < RIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/G ov C orpInst_Q uery S pec_1" Include="tr ue" /> </Q uery > </G etG ov C orpInst_Request_1> </Body > </E nv elope>

XML Sample Response - Search Fund Quote with Currency and Exchange Information
<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader> <a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/ S earch/G ov C orpInst_1/G etG ov C orpInst_1_Reply </a:A ction> <a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etG ov C orpInst_Response_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/G ov C orpInst_1"> <ResultH eader xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes"> <F irstH it>1</F irstH it> <LastH it>38</LastH it> <H its>38</H its> <TotalH its>38</TotalH its> <E xecutionTime>47</E xecutionTime> <Duration>109</Duration> </ResultH eader> <N av igatorList xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes" /> <Result> <H it Index="1"> <BusinessE ntity xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ ResponseDefaultF ields">IN S TRU M E N T.F IXE DIN C O M E .G O V C O RP </BusinessE ntity > <C ouponRate xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/G ov C orpInst_ResultS pec_1">9.75</ C ouponRate> <DocumentTitle xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields"> <V alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">Q atar, S tate of, F ixed Rate Bond, Q A TA R 9.750 15-Jun-2030</V alue> <S ubjectN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">Q atar, S tate of</S ubjectN ame> <S impleTy pe xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">F ixed Rate Bond</S impleTy pe> <C haracteristics xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">Q A TA R 9.750 15-Jun-2030</C haracteristics> </DocumentTitle> <M aturity Date xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/G ov C orpInst_ResultS pec_1">2030-0615T00:00:00Z</M aturity Date> <P I xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">0x0002a0006fd2617e</ P I> <RIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ G ov C orpInst_ResultS pec_1">Q A 011341969=</RIC > </H it> <H it Index="2">

678

TRKD API Developer's Guide

<BusinessE ntity xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ ResponseDefaultF ields">IN S TRU M E N T.F IXE DIN C O M E .G O V C O RP </BusinessE ntity > <C ouponRate xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/G ov C orpInst_ResultS pec_1">23.188</ C ouponRate> <DocumentTitle xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields"> <V alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">Italy , Republic O f, F ixed Rate Bond, ITA LY 23.188 20-F eb-2031</V alue> <S ubjectN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">Italy , Republic O f</S ubjectN ame> <S impleTy pe xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">F ixed Rate Bond</S impleTy pe> <C haracteristics xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">ITA LY 23.188 20-F eb-2031</C haracteristics> </DocumentTitle> <M aturity Date xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/G ov C orpInst_ResultS pec_1">2031-0220T00:00:00Z</M aturity Date> <P I xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">0x0002a000552b70ac</ P I> <RIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ G ov C orpInst_ResultS pec_1">XS 0124812503=R</RIC > </H it> ... </Result> </G etG ov C orpInst_Response_1> </Body > </E nv elope>

34.3.9 Index Instruments

This web service returns index instruments, in other words details of indices themselves. Note: Thomson Reuters Search on Index Instruments retrieves all available data on index instruments, while Thomson Reuters Search on Index Quote retrieves only the data you are permissioned for.

34.3.9.1 Service Endpoint and Required Headers

Service Endpoint Thomson Reuters Index Instruments Search Endpoint
http://api.rkd.reuters.com/api/2006/05/01/S earch/IndexInst_1.sv c

Required Header Required HTTP Headers

P O S T /api/2006/05/01/S earch/IndexInst_1.sv c H TTP /1.1 C ontent-Ty pe: application/soap+xml H ost: api.rkd.reuters.com C ontent-Length: [length]

34.3.9.2 WSDL
WSDL:
http://api.rkd.reuters.com/schemas/w sdl/S earch/IndexInst_1_H ttpA ndRKDToken.w sdl

34.3.10 Index Quote

The Index Quote operation is used to search for Index Quotes. It can be used to drill-down from Index instruments using PI from Instrument level and BaseAssetPI from the Quote level.

Thomson Reuters Search

679

Note: Thomson Reuters Search on Index Instruments retrieves all available data on index instruments, while Thomson Reuters Search on Index Quote retrieves only the data you are permissioned for.

34.3.10.1 Service Endpoint and Required Headers

Service Endpoint Thomson Reuters Index Quote Search Endpoint
http://api.rkd.reuters.com/api/2006/05/01/S earch/IndexQ uote_1.sv c

Required Header Required HTTP Headers

P O S T /api/2006/05/01/S earch/IndexQ uote_1.sv c H TTP /1.1 C ontent-Ty pe: application/soap+xml H ost: api.rkd.reuters.com C ontent-Length: [length]

34.3.10.2 WSDL
WSDL:
http://api.rkd.reuters.com/schemas/w sdl/S earch/IndexQ uote_1_H ttpA ndRKDToken.w sdl

34.3.10.3 Retrieving Index by PI

In this example we retrieve the RIC by using the PI number 12003613. XML Sample Request -Search Fund Quote with Currency and Exchange Information
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/S earch/IndexQ uote_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/IndexQ uote_1/ G etIndexQ uote_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etIndexQ uote_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/IndexQ uote_1"> <Q uery > < P I xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/RequestDefaultF ields" Include="true"> <S tringV alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/Q uery S pecDataty pes" V alue="1 2 0 0 3 6 1 3 " Negated="false" /> </P I> < RIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/IndexQ uote_Q uery S pec_1" Include="tr ue" /> </Q uery > </G etIndexQ uote_Request_1> </Body > </E nv elope>

XML Sample Response - Search Fund Quote with Currency and Exchange Information
<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader> <a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/ S earch/IndexQ uote_1/G etIndexQ uote_1_Reply </a:A ction>

680

TRKD API Developer's Guide

<a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etIndexQ uote_Response_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/IndexQ uote_1"> <ResultH eader xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes"> <F irstH it>1</F irstH it> <LastH it>1</LastH it> <H its>1</H its> <TotalH its>1</TotalH its> <E xecutionTime>31</E xecutionTime> <Duration>78</Duration> </ResultH eader> <N av igatorList xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes" /> <Result> <H it> <BusinessE ntity xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">Q U O TE . IN DE X</BusinessE ntity > <P I xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">12003613</P I> <DocumentTitle xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields"> <V alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">F TS E U RO F IRS T 100, Index Q uote, U nited Kingdom, F TS E International</V alue> <S ubjectN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ ResultS pecDataty pes">F TS E U RO F IRS T 100</S ubjectN ame> <S impleTy pe xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">Index Q uote</S impleTy pe> <C haracteristics xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">U nited Kingdom</C haracteristics> <S ource xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">F TS E International</S ource> </DocumentTitle> <RIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/IndexQ uote_ResultS pec_1">.F TE F C 1R</RIC > </H it> </Result> </G etIndexQ uote_Response_1> </Body > </E nv elope>

34.4

Understanding the Thomson Reuters Search Response

The Thomson Reuters Search response consists of the following sections: Result Header - contains information about the result set. Navigator List - provides analytic on the results in the form of a Navigator list. Result - the Result element of the response can contain zero or many Hit records.

34.4.1 Result Header

The Result Header will contain information describing the returned result set. The header is provided in all Search operations responses. XML Sample Response - Search All Response for a specific Index
<ResultH eader xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes"> <Fir stH it>1</F irstH it> <LastH it>19</LastH it> <H its>19</H its> <T otalH its>19</TotalH its> <ExecutionT ime>16</E xecutionTime> <Dur ation>63</Duration> <SpellingSuggestion>"v odafone"</S pellingS uggestion> </ResultH eader>

Attribute FirstHit LastHit

Description The offset or pivot value of the first result in current set of results. The offset of the last result in the current set of results.

Thomson Reuters Search

681

Hits TotalHits ExecutionTime Duration SpellingSuggest ion

The number of records included in this current set of results. The total number of records identified by the search engine. The execution time (in milliseconds) of the query. The total duration of the query, including the processing overhead incurred by the SQS. Suggests spelling.

34.4.2 Navigator List

Navigator List provides analytics on a set of results. By setting the Navigation attribute equal to true for a specific field in the Request (for fields that support Navigation) you indicate that you want the response to contain a break down of records according to the categories associated with that field. XML Sample Response - Search All Response with Navigate
<N av igatorList xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes"> <Str ingNavigator FieldName="A ssetC ategor yName" H itC ount="3 0 3 " Entr opy="1 .2 0 8 6 6 0 9 3 3 " Ratio="0 .9 8 3 7 6 6 2 3 3 8 " Scor e="1 .2 0 8 6 6 0 9 6 " SampleC ount="3 0 3 "> <M odifier V alue="Equity/Equity/Index War r ant" C ount="1 6 5 " /> <M odifier V alue="U nited S tates" C ount="106" /> <M odifier V alue="Israel" C ount="5" /> <M odifier V alue="U nited Kingdom" C ount="5" /> <M odifier V alue="C anada" C ount="3" /> ... </S tringN av igator> </N av igatorList>

Attribute

Description

StringNavigator This element provides general information about the navigation list. Contains the following attributes: FieldName :The name of the field to which the analytic relates. HitCount: The total number records identified in the query for which the analytic was generated. Entropy: Ratio: Score: Min: The minimum value identified for the field (O nly applicable to numeric and date analy tics). Max: The maximum value identified for the field (O nly applicable to numeric and date analy tics). Mean: The mean average value identified for the field (O nly applicable to numeric and date analy tics). SampleCount: The number of records on which the analytic was generated. Maybe different to the value for HitCount. Modifier A Modifier element is created for each analysis item. Contains the following attributes: Count :The number of records that would be returned by applying the criteria defined by this analytic modifier. Value: The value that this analytic is describing. For numeric analytics, this specifies the lower boundary of the range expressed by this modifier. UpperValue: The upper boundary of the analytic range (O nly applicable to numeric and date analy tics).

34.4.3 Result
The Result element of the response can contain zero or many Hit records. In the case of the result fields contained by each hit, the data types are no longer required to express criteria for a search query. With the exception of the DocumentTitle field, each field is described in terms of its native xml schema data type.

682

TRKD API Developer's Guide

XML Sample Response - Search All Response with Navigate

<Result> <H it> <BusinessE ntity xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ ResponseDefaultF ields">O RG A N IS A TIO N </BusinessE ntity > <DocumentTitle xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields"> <V alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">V odafone G roup P lc</V alue> <S ubjectN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ ResultS pecDataty pes">V odafone G roup P lc</S ubjectN ame> </DocumentTitle> <P I xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">10749</P I> <P rimary RIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/S earchall_ResultS pec_1">V O D. L</P rimary RIC > </H it> <H it> <BusinessE ntity xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ ResponseDefaultF ields">O RG A N IS A TIO N </BusinessE ntity > <DocumentTitle xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields"> <V alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">V odafone E gy pt Telecommunications C ompany </V alue> <S ubjectN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ ResultS pecDataty pes">V odafone E gy pt Telecommunications C ompany </S ubjectN ame> </DocumentTitle> <P I xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields">2512496</P I> <P rimary RIC xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/S earchall_ResultS pec_1">V O DE . C A </P rimary RIC > </H it> ... <H it> <BusinessE ntity xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ ResponseDefaultF ields">IN S TRU M E N T.F IXE DIN C O M E .G O V C O RP </BusinessE ntity > <DocumentTitle xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResponseDefaultF ields"> <V alue xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">V odafone G roup P LC , F ixed Rate Bond, V O D 5.125 10-A pr-2015</V alue> <S ubjectN ame xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ ResultS pecDataty pes">V odafone G roup P LC </S ubjectN ame> <S impleTy pe xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">F ixed Rate Bond</S impleTy pe> <C haracteristics xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ResultS pecDataty pes">V O D 5.125 10-A pr-2015</C haracteristics> </DocumentTitle> <P I xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S earch/ ResponseDefaultF ields">0x00038600556940f9</P I> </H it> </Result>

The following are the default fields returned for every request. Attribute BusinessEntity PI DocumentTitle Description Shows business entity. The unique identifier for each document in the index. For display purposes the fields that best describes the result.

Screener

683

chapter 35

Screener

You can use Thomson Reuters Screener to filter companies according to a set of criteria and return information about those companies. Screening provides the capability to select a subset of available companies and subset of variables describing those companies very quickly. The Screener operates with various data objects and variable lists. Screening is logically broken into two pieces: Screening Screening is the ability to specify filter data ("Screening profile") to apply against a large universe of companies to produce a much shorter list of companies for consideration ("Screened result set"). For example, select all companies with a P/E greater than X, closing price greater than Y, with a rating of Buy. The screening system performs all normal mathematical and logical operations on the underlying fundamental, forecast and pricing data. Report Writing Report writing is the ability to take the screened result set and output those companies with specific data fields. The data fields involved may be different than those involved with the screening profile. The definition of those data fields is called a "report format". Screening and report writing are integrated into a single TRKD API call.

35.1

Authentication/Authorization, Service Endpoint, and Required Headers

Authorization All requests to the Thomson Reuters Screener service require an authorization token. For details, see section Understanding Authentication Tokens. Authentication Thomson Reuters Screener uses Reuters impersonation tokens for each effective user. In this case, Thomson Reuters must create each user before your application authenticates them. Unmanaged effective users are not supported in Thomson Reuters Screener. For additional information, see section Creating a Token . Service Endpoint Thomson Reuters Screener Endpoint
http://api.rkd.reuters.com/api/2009/10/01/S creener_1.sv c

Required Header Required HTTP Headers

P O S T /2009/10/01/S creener_1.sv c H TTP /1.1 C ontent-Ty pe: application/soap+xml H ost: api.rkd.reuters.com C ontent-Length: [length]

35.2

WSDL
WSDL:

684

TRKD API Developer's Guide

http://api.rkd.reuters.com/schemas/w sdl/S creener_1_H ttpA ndRKDToken.w sdl

35.3

Data Organization
The Screener operates on data about companies and associated variables against those companies. The screener allows the data to be defined in separate "sections". These sections allow the compilation of data that respect either generation requirements or entitlement requirements. Those entitlement requirements will respect contractual obligations.

35.4

Variables
Variables represent a unit of data for particular company. For each variable the Screener has the following attributes: Name Up to 40 characters. Note that all names in screener are case-insensitive. Type An enumeration (such as Boolean, string etc.) described by the following schema fragment:
<xs:restriction base="xs:string"> <xs:enumeration v alue="v tS tring"/> <xs:enumeration v alue="v tN umber"/> <xs:enumeration v alue="v tBoolean"/> <xs:enumeration v alue="v tDate"/> <xs:enumeration v alue="v tE num"/> <xs:enumeration v alue="v tA rray "/> </xs:restriction>

The meanings are obvious with the exception of this value of the enumeration: ~ "VtEnum" is used when variable can have limited set of values, such as zip codes, area codes, names of the analysts etc. Prec The precision of "vtNumber". Integer values are represented by precision equal to 0. The Screener provides data conversion based on "prec" attribute. The Screener drops trailing zeros and rounds the data. For example: if precision is 3: - "8.500" becomes 8.5 if precision is 1 - "8.56" becomes "8.6" if precision is 1 - "8.54" becomes "8.5" Desc Description. This field usually contains short description of the variable. For example, "Consensus recommendation". Body This attribute usually contains a long description of the variable. The user interface can use this value as a means of a help screen for the variable. It is useful to keep the full description as HTML. Head The column title. It can be up to 1024 symbols. This attribute usually contains up to three words divided by <CR><LF>. The user interface can use it as a title for a corresponding column. The variable definitions contain all the information required for the creation of data-driven front end. The ability to create a data-driven interface is one of the principals behind the Screener design. It is only also possible to get all variables available to your application. Each variable has enough attributes associated with it to all a display for a user interface to be constructed.

35.4.1 Getting Actual Codes for Variables

You can use vEnum value for fields attribute in Get Variable request to retrieve codes and values for variables of enum type.

Screener

685

fields value descriptions: Value vType vDesc vPrec vBody vEnum Example: Request:
<G etV ar_Request_1 xmlns="http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/rkd/S creener_1" fields="v Ty pe v P rec v H ead v Desc v Body vEnum " />

Description Type Description Precision of floating point variables Long description Code and names of enumeration value if variable is enum type

Response:
<G etV ar_Response_1 xmlns="http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/rkd/S creener_1"> <!-- cut to reduce the size --> <v ar desc="Region C ode" name="RegionC ode" prec="0" ty pe="v tE num"> <enum code="A P ">A sia P acific</enum> <enum code="E U ">E urope and A frica</enum> <enum code="N A ">A mericas</enum> <body >Region C ode for country of E xchange</body > </v ar> <!-- cut to reduce the size --> </G etV ar_Response_1>

In Calculate request you can use value codes retrieved by the Get Variable request:
<criteria>IS IN S E T ({RegionC ode},[EU,A P ])</criteria>

35.5

Lists
This section provides information on company lists.

35.5.1 Company Lists

A company list is a defined list of companies to limit selection of company rows from. Use this feature to provide screening capability on watch lists or portfolios. Another useful type of the company list is a list presented as a screening criterion. An example would be "North American active companies". This list can be represented by expression:
Is In S et({E xchange},[A M E X,N A S D,N YS E ,O TC ]).A N D.{IsA ctiv e}

This expression uses the "Is In Set" Screener function, as well as built-in variable "IsActive". For more details, see section Supported Operations. Company lists also can be used for three different purposes. First, the usage is to start from particular list as a starting point for subsequent criteria. This list is called "exact" list. In second case the user might compare his/her own companies to the list of the companies passing criteria. Those are called "include" lists. The third type of the list is called an "exclude" list. This is useful if caller wants to figure out what companies pass criteria besides the ones he/she already has.

35.6

Screening
Screening is used to retrieve data from the Screener. You can consider the result of the screen execution as a set of orthogonal matrixes (record sets). Each line in the record set corresponds to the company, and each column corresponds to the variable requested. It is possible to specify which particular columns (variables) to return (see the description of the forms below), to return only the number of companies passing the criterion. Thus, "report writing" is a user interface construct. The Screener resolves criterion and variables requested in the above record sets.

686

TRKD API Developer's Guide

The list of criteria defines the actual search to be performed on the data. Each criterion specifies the subset of the companies to be selected. Each subsequent criterion is applied on top of results of the previous one, and therefore narrows down the list of companies passing the screen.

35.7

Format
The set of "format" elements defines which variables return from a screen. The Screener can return the row set for last nonsuppressed criteria. The role of "format" element is to define which columns will be returned. For additional information, see section Calculation Request.

35.8

Calculation Request
A calculation request is not an object, but is the main screener request to execute a screen and retrieve the associated data. A calculation request is a combination of: criteria format(s) company list(s) At least one of the above should be present to execute a meaningful screen. A calculation request "glues" these elements together by setting various attributes of expressions and limiting the sizes and positions of the record sets. You can suppress the return of row set by criterion using its "content" attribute. This attribute can have one of three values: ctAll - the default value returns all requested data. ctNone - returns nothing about this record set. ctNoData - returns just number of companies passing criterion. The request can have only one format as expressions in criteria, or none. One format can be applied to all criteria. If the request uses an "exact" company list, this company list becomes row set number 0. All criteria have one contiguous enumeration regardless if their results are suppressed or not. The format supplied in the request also has "pos" (position) sub-element. Use this sub-element define how to position the row set and how many rows to return. For example: <pos row="401" rows="100"/> This means "return 100 rows starting from row number 401". Note: Your application is configured to return a maximum number or rows. The default configuration is 750 rows. If your query exceeds this maximum, you will not receive an error - the Screener simply limits your query to return the configured maximum. Position can be set by: RepoNo symbol company name explicit row number If more than one of the above is present, the Screener uses only the first one (in the order above).

35.8.1 Using Position for Searching

The request for positioning by symbol or company name (in conjunction with sorting) effectively provides the search capabilities in the screener. For example, a request containing
<pos sy mbol="IBM " row s="100"/>

Screener

687

will try to find "IBM" in this record set, and to return 100 rows starting from IBM. Since a search of the result set is possible, the action on not finding the search criteria needs to be handled. The attribute "IfNotFound" is used to set this behavior.

35.8.2 Sort Order

You can set the sort order(s) for the row set columns. For example:
<form index="-1" fields="cH ead cP rec"> <col name="Ticker" sort="ascend" sortO rder="1" /> <col name="N ame" sort="ascend" sortO rder="0" /> <col name="A ctiv e" /> </form>

The above example of the format sets the sorting by "Company Name", and then by "Ticker"; both sorts ascending.

35.8.3 Statistics
The caller can also request five different kinds of statistics for a column: total average minimum maximum standard deviation

35.9

Supported Operations
Lexem(s) (,) + * / < > <= >= =,== <>,!= AND, .AND., && OR, .OR., || NOT, .NOT., ! IS [NOT] IN SET(<var>, <array>) { <name>} 'string', "string", string [digits][.][digits] T, F, TRUE, FALSE m[m]/d[d]/y[y][yy], m[m]-d[d]Priority* special 3 3 4 4 2 2 2 2 2 2 1 0 5 6 Supported Types* number, date, set number, date, set number, date number, date string, number, date, boolean, set string, number, date, boolean, set string, number, date, boolean, set string, number, date, boolean, set string, number, date, boolean, set, NA, NM string, number, date, boolean, set, NA, NM Description Parentheses Addition Subtraction Multiplication Division Less Greater Less or equal Greater or equal Equal Not equal Boolean Boolean Boolean Is used to check if variable <var> is in the array <array>. Works only with string, enumeration variables Variable(field) <name>. Number argument Date argument (long format). m - month, d -

6 -

688

TRKD API Developer's Guide

y[y][yy] m[m]/y[y][yy], m[m]-y[y][yy] [comma-separated text] NA NM

day, y - year Date argument (short format). m - month, y year Array argument. Used only in IS [NOT] IN SET operation as a second argument Special argument to indicate the NA value (from "Not Available") Special argument to indicate NM value (from "No Match")

* - 0 is the lowest priority, 6 is the highest priority. Operation with the highest priority will be executed first. * - For the operations with the same priority left-to-right order of execution is presumed.

35.10 Supported Functions

The Screener allows the use of Statistical Functions in expressions. These functions can be included in expressions, in requests, as well as in column definitions. Statistics function is calculated over a set of companies (a sample). The initial set of companies (which is received from the selected datasets) becomes a sample for the first criteria. The first criterion's result set of companies becomes a sample for the second criteria and for the columns of format assigned to the first criteria. The second criterion's result set of companies becomes a sample for the third criteria and second criterion's format columns and so on and so forth. The following statistical functions are supported: Function ^ and ** EXP(x) COUNT COUNT(arg_boolean) ABS(x) MIN(x,y) MAX(arg) SUM(arg) AVG(arg) STDEV(arg) WAVG(arg1, arg2) MEDIAN(arg) RANK(arg) RANK(arg,arg_boolean) Description power (2^3 raise 2 to the third power), if x or y = NA or NM whole operation returns NA or NM. Exponent (e^x), if x = NA or NM whole operation returns NA or NM. Returns the sample size. Returns the number of records where arg_boolean is true. Absolute value, if x = NA or NM whole operation returns NA or NM. Returns the lowest numeric value in the sample (returns NM for non-numeric data). Returns the highest numeric value in the sample (returns NM for non-numeric data). Calculates the sum of the numeric sample (returns NM for non-numeric data). Calculates the average (or mean) of the numeric sample (returns NM for non-numeric data). Calculates the standard deviation of the numeric sample (returns NM for non-numeric data). Calculates the weighted average of the numeric sample arg1 weighted by the numeric sample arg2 (returns NM for non-numeric data). Calculates the median value of the numeric sample (NA and NM values are ignored; returns NM for non-numeric data). Returns the ascending rank of the element arg in the sample (NA and NM values will have NM rank). Returns the rank of the element (if the arg_boolean is true, in ascending order; if the arg_boolean is false, in descending order) in the sample (NA and NM values will have the rank of NM). Returns the percentile of the element in ascending order, in the sample (NA and NM values will have the percentile of NM). Returns the percentile of the element (if the arg_boolean is true, in ascending order; if the arg_boolean is false, in descending order) in the sample (NA and NM values will have the percentile of NM). Returns the quartile of the element in ascending order, in the sample (NA and NM values will have the quartile of NM). Returns the quartile of the element (if the arg_boolean is true, in ascending order; if the arg_boolean is false, in descending order) in the sample (NA and NM values will have the quartile of NM). Returns the n-tile of the element in ascending order, in the sample. The second argument

PERCENTILE(arg) PERCENTILE(arg, arg_boolean) QUARTILE(arg) QUARTILE(arg,arg_boolean)

NTILE(arg,arg_numeric)

Screener

689

NTILE(arg,arg_numeric, arg_boolean) LN(x) LOG(x) IF(x,y,z)

IFNA(x,y) IFNM(x,y) IFN(x,y)

sets the value of n (NA and NM values will have the n-tile of NM). Returns the n-tile of the element (if the arg_boolean is true, in ascending order; if the arg_boolean is false, in descending order) in the sample. The second argument sets the value of n (NA and NM values will have the n-tile of NM). Natural logarithm (to the base e), if x = NA or NM whole operation returns NA or NM. Logarithm to the base 10, if x = NA or NM whole operation returns NA or NM. If operation if x is true then select y otherwise z, if x = NA or NM whole operation returns NA or NM. It is required that Y and Z have the same data type. Otherwise result of expression will case an error on calculation and verification. NA test and replacement if x is NA then use y, otherwise use x. NM test and replacement if x is NM then use y, otherwise use x. NA and NM test and replacement if x is NM or NA then use y, otherwise use x.

35.10.1 Numeric Infinity and Not-a-Number

The Screener provides more efficient processing of numeric infinity and not-a-number situations. The following new constants have been added to allow dealing with infinity values, in particular - to allow comparison and produce correct XML response: INF: Positive infinity -INF: Negative infinity In addition, the following functions are available to facilitate the handling of infinity and not-a-number values: Function ISNAN(arg) Description Returns true if arg is NaN (not-a-number value).

IFNAN(arg1, arg2) Replace arg1 with arg2 if arg1 is NaN. IFINF(arg1, arg2) Replace arg1 with arg2 if arg1 is INF or INF.

35.10.2 Extended String and Array Comparison Functions

Provided below is a list of functions that support extended string and array comparison: Function CONTAINS(arg1, arg2) CONTAINS(arg1, arg2, arg_boolean) arg1 = arg2 STARTSWITH(arg1,arg2) STARTSWITH(arg1, arg2, arg_boolean) ENDSWITH(arg1, arg2) ENDSWITH(arg1, arg2, arg_boolean) Description If string arg2 is 1) a substring of string arg1 2) an element of array arg1 then returns true, false - otherwise. Case-insensitive. If string arg2 is 1) a substring of string arg1; 2) an element of array arg1 then returns true, false - otherwise. If arg_boolean = TRUE then casesensitive, otherwise - case-insensitive. If one of the arguments is array, and another is not array, but can be treated as string "=" works as CONTAINS(arg1,arg2). If 1) string arg1 starts with substring arg2; 2) the first element of array arg1 equal to string arg2 then return true, false - otherwise. Case-insensitive. If 1) string arg1 starts with substring arg2; 2) the first element of array arg1 equal to string arg2 then return true, otherwise - false. If arg_boolean = TRUE then case-sensitive, otherwise - case-insensitive. If 1) string arg1 ends with substring arg2; 2) the last element of array arg1 equal to string arg2 then return true, otherwise - false. Case-insensitive. If 1) string arg1 ends with substring arg2; 2) the last element of array arg1 equal to string arg2 then return true, false - otherwise. If arg_boolean = TRUE then case-sensitive, otherwise - case-insensitive.

35.11 Example Requests

The next section documents a typical User Interface approach to using the Screener using the external client interface.

690

TRKD API Developer's Guide

35.11.1 Calculation Requests

Calculation requests are used for screening (filtering) companies according to the set of criteria, as well as for data retrieval. Note: Your application is configured to return a maximum number or rows. The default configuration is 750 rows. If your query exceeds this maximum, you will not receive an error - the Screener simply limits your query to return the configured maximum. The request below retrieves Ticker, Company Name, the sign of company being active, and price. This request selects the first 100 companies where price is less than 20. XML Sample Request - Calculation Request
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/10/01/S creener_1.sv c/A nony mous</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/rkd/S creener_1/ C alculate_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <C alculate_Request_1 xmlns="http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/rkd/S creener_1"> <criteria>{P rice}<20</criteria> <form> <col name="Ticker"/> <col name="N ame"/> <col name="A ctiv e"/> <col name="P rice"/> <pos row s="100"/> </form> </C alculate_Request_1> </Body > </E nv elope>

Note: The 'Content' attribute can have three values: 1. All 2. None 3. NoData Please keep in mind that all three values can be applied only to the last criterion specified in the Calculate_1 request. The value "All" is ignored for all other criteria specified in the request.

35.11.2 Getting Variables (GetVar_1)

GetVar requests are used for getting information about all available for user variables. XML Sample Request - Get Variable
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/10/01/S creener_1.sv c/A nony mous</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/rkd/S creener_1/ G etV ar_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etV ar_Request_1 fields="v Ty pe v Desc v P rec v Body v E num" xmlns="http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/rkd/ S creener_1" />

Screener

691

</Body > </E nv elope>

The response returns the following information: XML Sample Response - Get Variable
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/ rkd/S creener_1/G etV ar_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <G etV ar_Response_1 xmlns="http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/rkd/S creener_1"> <v ar desc="N umber of Buy Recommendations, C urrent" name="#Buy Rec_C " prec="0" ty pe="v tN umber"> <body >N umber of Buy Recommendations, C urrent</body > </v ar> <v ar desc="N umber of H old Recommendations, C urrent" name="#H oldRec_C " prec="0" ty pe="v tN umber"> <body >N umber of H old Recommendations, C urrent</body > </v ar> <v ar desc="N umber of O utperform Recommendations, C urrent" name="#O utP Rec_C " prec="0" ty pe="v tN umber"> <body >N umber of O utperform Recommendations, C urrent</body > </v ar> <v ar desc="N umber of S ell Recommendations, C urrent" name="#S ellRec_C " prec="0" ty pe="v tN umber"> <body >N umber of S ell Recommendations, C urrent</body > </v ar> <v ar desc="N umber of U nderperform Recommendations, C urrent" name="#U ndP Rec_C " prec="0" ty pe="v tN umber"> <body >N umber of U nderperform Recommendations, C urrent</body > </v ar> <v ar desc="A ccrued E xpenses - Last y ear, Reporting C urrency " name="A ccE xp_RA " prec="3" ty pe="v tN umber"> <body >This is A ccrued E xpenses - Last y ear, Reporting C urrency </body > </v ar> <v ar desc="A ccrued E xpenses - 1 interim period ago, Reporting C urrency " name="A ccE xp_RP Q " prec="3" ty pe="v tN umber"> <body >This is A ccrued E xpenses - 1 interim period ago, Reporting C urrency </body > </v ar> <v ar desc="A ccrued E xpenses - 2 interim periods ago, Reporting C urrency " name="A ccE xp_RP Q 2" prec="3" ty pe="v tN umber"> <body >This is A ccrued E xpenses - 2 interim periods ago, Reporting C urrency </body > </v ar> </G etV ar_Response_1> </Body > </E nv elope>

35.11.3 Checking for Validity

Before screening you can use the application to check the expression and variable name for validity. The following example checks the validity of an expression. XML Sample Request - Checking for Validity
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/10/01/S creener_1.sv c/A nony mous</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/rkd/S creener_1/V erify _1</ A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <V erify _Request_1 xmlns="http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/rkd/S creener_1"> <expression>{P rice}>20 A N D {P rice}<=40</expression> </V erify _Request_1> </Body >

692

TRKD API Developer's Guide

</E nv elope>

XML Sample Response - Checking for Validity

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/ rkd/S creener_1/V erify _1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <V erify _Response_1 xmlns="http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/rkd/S creener_1"> <expression code="ecO K" desc="N o errors." pos="0" ty pe="etBoolean"> <v ar pos="0">P RIC E </v ar> <v ar pos="15">P RIC E </v ar> </expression> </V erify _Response_1> </Body > </E nv elope>

Note that attribute "code" contains "ecOK" value. This means that the expression is syntactically correct.

35.11.4 Screening Company Lists

You can use the Screener to start screening from a particular list of companies. The typical scenario is when a user wants to screen the companies in his/her watch list, or intends to start from certain kind of companies - like US companies, for example. If you need to screen on top of the explicit list of companies the Screener uses the term "exact list" for those use a request like the following: XML Sample Request - Screening an Exact List
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/10/01/S creener_1.sv c/A nony mous</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/rkd/S creener_1/ C alculate_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <C alculate_Request_1 xmlns="http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/rkd/S creener_1"> <form> <col name="Ticker"/> <col name="Repono"/> <col name="N ame"/> </form> <list ty pe="sy mbol" mode="exact"> <i>IBM </i> <i>IN TC </i> <i>A M D</i> <i>C S C O </i> <i>M S F T</i> </list> </C alculate_Request_1> </Body > </E nv elope>

Note that the companies in the list element are specified explicitly by their symbols. You can also specify companies Reuters report numbers (REPONO). In this case, set the type of the <list> element to "repono".

Screener

693

35.11.4.1 Using Criteria for an Exact List

You can also specify a list using criteria. For example: XML Sample Request - Screening an Exact List Based on Criteria
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/10/01/S creener_1.sv c/A nony mous</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/rkd/S creener_1/ C alculate_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <C alculate_Request_1 xmlns="http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/rkd/S creener_1"> <form> <col name="Ticker"/> <col name="Repono"/> <col name="N ame"/> </form> <list ty pe="sy mbol" mode="exact"> <criteria>{P rice}>11.5.A N D.{P rice}<12.5</criteria> </list> </C alculate_Request_1> </Body > </E nv elope>

35.11.4.2 Including/Excluding Companies from the List

It is often useful to compare the user watch list to the list of companies that passed screening criteria. To include a list of companies (even if they do not pass the criteria), use a request like the following: XML Sample Request - Screening with Include
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/10/01/S creener_1.sv c/A nony mous</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/rkd/S creener_1/ C alculate_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <C alculate_Request_1 xmlns="http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/rkd/S creener_1"> <form> <col name="Ticker"/> <col name="Repono"/> <col name="N ame"/> </form> <list ty pe="sy mbol" mode="include"> <i>IBM </i> <i>IN TC </i> <i>A M D</i> <i>C S C O </i> <i>M S F T</i> </list> </C alculate_Request_1> </Body > </E nv elope>

694

TRKD API Developer's Guide

Note that for this request, mode is set to "include". You can also exclude companies by setting mode to "exclude".

35.11.5 Working with Forms

Forms define what type of output (what columns) the result should contain. The request below contains the form modifying the output of companies with price greater than 20. The form specifies that screener should return Ticker, Repono, and Company Name. XML Sample Request - Simple Form Example
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/10/01/S creener_1.sv c/A nony mous</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/rkd/S creener_1/ C alculate_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <C alculate_Request_1 xmlns="http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/rkd/S creener_1"> <criteria>{P rice}>10</criteria> <criteria>{P rice}>20</criteria> <criteria>{P rice}>30</criteria> <criteria>{P rice}>40</criteria> <form> <col name="Ticker"/> <col name="Repono"/> <col name="N ame"/> <pos row s="10"/> </form> </C alculate_Request_1> </Body > </E nv elope>

35.11.6 Positioning, Paging, and Search

The record set returned by certain criteria can be very large. TRKD API configures a maximum number of rows you can return in a single screen request. By default, this maximum is 750 rows. In addition, is possible to specify your own limit to the number of rows returned. Consider request below: XML Sample Request - Returning 100 Rows
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/10/01/S creener_1.sv c/A nony mous</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/rkd/S creener_1/ C alculate_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <C alculate_Request_1 xmlns="http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/rkd/S creener_1"> <criteria>{P rice}>10</criteria> <criteria>{P rice}>20</criteria> <criteria>{P rice}>30</criteria> <criteria>{P rice}>40</criteria> <form>

Screener

695

<col name="Ticker"/> <col name="Repono"/> <col name="N ame"/> <pos row s="100"/> </form> </C alculate_Request_1> </Body > </E nv elope>

The attribute "rows" of element "pos" element specifies number of rows to return. In this particular case only 100 rows will be returned. Note: Your application is configured to return a maximum number or rows. The default configuration is 750 rows. If your query exceeds this maximum, you will not receive an error - the Screener simply limits your query to return the configured maximum.

35.11.6.1 Implementing Paging

If the user interface provides some kind of paging, it needs to retrieve a certain subset of the whole record set. Use the "row" attribute to retrieve this subset. XML Sample Request - Paging Example
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/10/01/S creener_1.sv c/A nony mous</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/rkd/S creener_1/ C alculate_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <C alculate_Request_1 xmlns="http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/rkd/S creener_1"> <criteria>{P rice}>10</criteria> <criteria>{P rice}>20</criteria> <criteria>{P rice}>30</criteria> <criteria>{P rice}>40</criteria> <form> <col name="Ticker"/> <col name="Repono"/> <col name="N ame"/> <pos row ="401" row s="100"/> </form> </C alculate_Request_1> </Body > </E nv elope>

If you are paging by 100 rows, the request above returns the fifth page of the result set. Note that rows are numbered starting from "1".

35.11.6.2 Searching
You can also position the record set to the row containing a specific company. Effectively this is a searching mechanism. The request below positions the record set to the company with the ticker symbol "BEC": XML Sample Request - Searching for a Company
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/10/01/S creener_1.sv c/A nony mous</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID>

696

TRKD API Developer's Guide

<A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/rkd/S creener_1/ C alculate_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <C alculate_Request_1 xmlns="http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/rkd/S creener_1"> <criteria>{P rice}>10</criteria> <criteria>{P rice}>20</criteria> <criteria>{P rice}>30</criteria> <criteria>{P rice}>40</criteria> <form> <col name="Ticker"/> <col name="Repono"/> <col name="N ame"/> <pos sy mbol="BE C " row s="10"/> </form> </C alculate_Request_1> </Body > </E nv elope>

You can also search by REPONO. One of the important questions in implementing a search is: what should the behavior be if the search is unsuccessful? The Screener supports two different behaviors: 1. Return nothing (no rows). This is a default behavior. 2. Return rows from the row specified by "row" attribute. The example above uses the default behavior. For an unsuccessful search, the result is similar to: XML Sample Response - Unsuccessful Search
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/ rkd/S creener_1/V erify _1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <C alculate_Response_1 xmlns="http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/rkd/S creener_1"> <rs all="144" found="false" row ="145" row s="0"> <h> <c name="Ticker" ty pe="string" /> <c name="RepoN o" ty pe="string" /> <c name="N ame" ty pe="string" /> <c name="P RIC E " ty pe="number" /> </h> </rs> </C alculate_Response_1> </Body > </E nv elope>

Note that the record set has found="false" and no rows are returned. To select the second behavior, use the attribute "ifNotFound" with value "pos". For example: XML Sample Request - Searching for a Company
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/10/01/S creener_1.sv c/A nony mous</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/rkd/S creener_1/ C alculate_1</A ction>

Screener

697

<A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <C alculate_Request_1 xmlns="http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/rkd/S creener_1"> <criteria>{P rice}>10</criteria> <criteria>{P rice}>20</criteria> <criteria>{P rice}>30</criteria> <form> <col name="Ticker"/> <col name="Repono"/> <col name="N ame"/> <pos sy mbol="BE C " ifN otF ound="pos" row s="10"/> </form> </C alculate_Request_1> </Body > </E nv elope>

In this case, found still will be set to "false" and the last record set will be positioned at row 10.

35.11.7 Grouping
The result from a request can be grouped by relevant columns. For example, the request and response below groups companies under subgroups "Industry", and under the "Industry Sector" group. If more than one grouping column is specified, the result will be in the form of nested groups. The groups can be sorted by the group value and/or by the group's single value columns. The following is an example Request of Grouping: XML Sample Request - Grouping Request
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/10/01/S creener_1.sv c/A nony mous</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/rkd/S creener_1/ C alculate_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <C alculate_Request_1 xmlns="http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/rkd/S creener_1"> <criteria content="ctN one">{A ctiv e} A N D {E xchangeC ountry C ode}='U S A '</criteria> <criteria>{P rice}>100</criteria> <form> <col name="N ame"/> <col name="S ectorDescr" groupO rder="0"/> <col name="IndDescr" groupO rder="1"/> </form> </C alculate_Request_1> </Body > </E nv elope>

XML Sample Response - Grouping Response

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/ rkd/S creener_1/V erify _1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body >

698

TRKD API Developer's Guide

<C alculate_Response_1 xmlns="http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/rkd/S creener_1"> <rs all="25" row ="1" row s="25"> <h> <c name="N ame" ty pe="string" /> </h> <g all="11" n="S E C TO RDE S C R" row ="1" row s="11"> <g all="1" n="IN DDE S C R" row ="1" row s="1"> <r> <v >N ational Western Life Insurance C ompany </v > </r> <s name="IndDescr" ty pe="string" rtd="group"> <v >Insurance (Life)</v > </s> </g> <g all="3" n="IN DDE S C R" row ="1" row s="3"> <r> <v >F irst C itizens Bancorporation, Inc</v > </r> <r> <v >F armers & M erchant Banc.</v > </r> <r> <v >F irst N ational Bank A laska</v > </r> <s name="IndDescr" ty pe="string" rtd="group"> <v >Regional Banks</v > </s> </g> <s name="S ectorDescr" ty pe="string" rtd="group"> <v >F inancial</v > </s> </g> </rs> </C alculate_Response_1> </Body > </E nv elope>

35.11.7.1 Position Grouping

groupRow and groupRows, attributes of the pos element, enable selection of a group's rows. The functionality of these attributes is similar to that of the attributes row and rows. However, these attributes are functional only for the last nested group.

35.11.8 Single Value Columns

The Screener allows the user to calculate single values. This single value can be calculated for a list of companies or for a specified group. The example request and response below provide the average share price of all active companies having a share price greater than $ 500, registered on the stock exchanges in the USA. XML Sample Request - Single Value Column Request
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/10/01/S creener_1.sv c/A nony mous</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/rkd/S creener_1/ C alculate_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body >

Screener

699

<C alculate_Request_1 xmlns="http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/rkd/S creener_1"> <criteria content="ctN one">{A ctiv e} A N D {E xchangeC ountry C ode}='U S A '</criteria> <criteria>{P rice}>500</criteria> <form> <col name="N ame"/> <col name="A v gP rice" rtd="S ome text"> <expression>A V G ({P rice})</expression> </col> </form> </C alculate_Request_1> </Body > </E nv elope>

XML Sample Request - Single Value Column Response

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/ rkd/S creener_1/C alculate_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <C alculate_Response_1 xmlns="http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/rkd/S creener_1"> <rs all="12" row ="1" row s="12"> <h> <c name="N ame" ty pe="string" /> </h> <r> <v >N V R, Inc.</v > </r> <r> <v >F irst C itizens Bancorporation, Inc</v > </r> ... <r> <v >F irst N ational Bank A laska</v > </r> <s name="A V G P RIC E " ty pe="number" rtd="S ome text"> <v >10147</v > </s> </rs> </C alculate_Response_1> </Body > </E nv elope>

The example below shows a request and response that provide the minimum share price of all active companies having a share price greater than $ 300, registered on the stock exchanges in the USA, grouped under respective industry sectors. XML Sample 2 - Single Value Column Request
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/10/01/S creener_1.sv c/A nony mous</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/rkd/S creener_1/ C alculate_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <C alculate_Request_1 xmlns="http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/rkd/S creener_1"> <criteria content="ctN one">{A ctiv e} A N D {E xchangeC ountry C ode}='U S A '</criteria> <criteria>{P rice}>300</criteria> <form> <col name="N ame"/> <col name="S ectorDescr" groupO rder="0"/> <col name="M inP rice" groupRef="S ectorDescr" rtd="P rice">

700

TRKD API Developer's Guide

<expression>M IN ({P rice})</expression> </col> </form> </C alculate_Request_1> </Body > </E nv elope>

XML Sample 2 - Single Value Column Response

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/ rkd/S creener_1/C alculate_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <C alculate_Response_1 xmlns="http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/rkd/S creener_1"> <rs all="18" row ="1" row s="18"> <h> <c name="N ame" ty pe="string" /> </h> ... <g all="9" n="S E C TO RDE S C R" row ="1" row s="9"> <r> <v >F irst C itizens Bancorporation, Inc</v > </r> <r> <v >F armers & M erchant Banc.</v > </r> ... <r> <v >F irst N ational Bank A laska</v > </r> <s name="S ectorDescr" ty pe="string" rtd="group"> <v >F inancial</v > </s> <s name="M IN P RIC E " ty pe="number" rtd="P rice"> <v >327</v > </s> </g> ... </rs> </C alculate_Response_1> </Body > </E nv elope>

35.11.9 Custom Columns

The columns may have custom expression. See the example below: XML Sample Request - Custom Columns Request
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/10/01/S creener_1.sv c/A nony mous</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/rkd/S creener_1/ C alculate_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <C alculate_Request_1 xmlns="http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/rkd/S creener_1"> <criteria content="ctN one">{A ctiv e} A N D {E xchangeC ountry C ode}='U S A '</criteria> <criteria>{P rice}>500</criteria> <form>

Screener

701

<col name="N ame"/> <col name="H alfP rice"> <expression>A V G ({P rice})/2</expression> </col> </form> </C alculate_Request_1> </Body > </E nv elope>

35.11.10 Defining Scope of Request

The attribute scope allows the Screener a selection between a sample of the whole result or a sample of the response companies. For example, take the case where the criteria for a request returns 1000 rows, but the response is limited to five rows using the element pos. In this case the Screener allows the use of either the initial 1000 companies or the response's five companies. To use the initial 1000 companies, the scope should be specified as scWhole; to use only five response companies, the scope should be specified as scRows. The default specification is scWhole, and will be used if scope is not present in request. The example below shows a request and response that provides the average price for all active companies having a share price greater than $ 300, registered on the stock exchanges in the USA. It also shows the average price for the first two companies per group, among all companies having a share price greater than $ 300, registered on the stock exchanges in the USA grouped under respective industry sectors. XML Sample Request - Average Price for the First Two Companies per Group
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/10/01/S creener_1.sv c/A nony mous</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/rkd/S creener_1/ C alculate_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <C alculate_Request_1 xmlns="http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/rkd/S creener_1"> <criteria content="ctN one">{A ctiv e} A N D {E xchangeC ountry C ode}='U S A '</criteria> <criteria>{P rice}>300</criteria> <form> <col name="N ame"/> <col name="S ectorDescr" groupO rder="0"/> <col name="A v gP rice1" groupRef="S ectorDescr" rtd="P rice" scope="scWhole"> <expression>A V G ({P rice})</expression> </col> <col name="A v gP rice2" groupRef="S ectorDescr" rtd="P rice" scope="scRow s"> <expression>A V G ({P rice})</expression> </col> <pos groupRow s="2"/> </form> </C alculate_Request_1> </Body > </E nv elope>

XML Sample Response - Average Price for the First Two Companies per Group
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/ rkd/S creener_1/C alculate_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader>

702

TRKD API Developer's Guide

<Body > <C alculate_Response_1 xmlns="http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/rkd/S creener_1"> <rs all="18" row ="1" row s="11"> <h> <c name="N ame" ty pe="string" /> </h> ... <g all="9" n="S E C TO RDE S C R" row ="1" row s="2"> <r> <v >F irst C itizens Bancorporation, Inc</v > </r> <r> <v >F armers & M erchant Banc.</v > </r> <s name="S ectorDescr" ty pe="string" rtd="group"> <v >F inancial</v > </s> <s name="A V GP RIC E1 " type="number " r td="P r ice"> <v>1 0 5 7 6 </v> </s> <s name="A V GP RIC E2 " type="number " r td="P r ice"> <v>5 8 3 </v> </s> </g> ... </rs> </C alculate_Response_1> </Body > </E nv elope>

35.12 Application Logic

The logic of the Screener service can be explained by the following: 1. Step 1 (with GetVariable_1): End user perspective: the user specifies screening criteria and submits the request: i. Variables list is shown on the page, it is possible to select variable and see its description or go to the help page and find detailed description for the variables; ii. The enters calculation criteria by selecting required variables and setting necessary conditions to these variables; iii. The user enters output variables (and statistics for them) that will become columns in the resulting table; Application perspective: i. The application tries to get screener variables for the particular service user in application cache. If attempt fails then the application gets screener variables for the particular service user through TRKD and stores the response in the cache for 1 day. So, there is no need to execute the GetVariable_1 request during the day for this particular service user again. The variables in the response contain the following attributes: Type (vType) the end user should know the type of variables he/she operates. If the type is "enum", then the end user should be able to select particular value(s) from the enum for calculating criteria; Description (vDesc) the end user is shown description for every variable he wants; Precision (vPrec) the end user should know the precision of floating point variables; to be shown in mini-help; Long description (vBody) if the end user does not understand the meaning of the variable from the information in <vDesc>, he/she can find detailed description in application help pages; Enum values (vEnum) if a variable is of enum type, then the end user will be able to select particular enum value(s); ii. The application builds a page for the end user using the variables list and other date entered as the screening criteria; 2. Step 2 (with Verify_1 and Calculate_1): End user perspective: the application displays a table with the screening calculation result where names of table columns are short descriptions of variable and floating point values have the same precision as shown in mini-help for the corresponding variables. If the specified criteria were incorrect, then the corresponding error message is shown. Application perspective: i. The application sends "Verify_1" request and if errors count is not zero, it builds an error page for the user;

Screener

703

ii. If no errors occurred during request verification, then the "Calculate_1" request is executed with the following values in "fields" parameter: Proposed column title (cHead) the titles proposed by TRKD and can be used when displaying table with results; Precision (cPrec) to show the end user the actual precision of variable values (f.e.: TRKD returns 3.5 while precision is 3, so the end user may see 3.500). (main idea of the opus above is caching variables description on clients side) "Value type" description (t="" attribute in response): "Value type" attribute can be equal to one of three values: "r" default value, means that value type corresponds to the column type (Reference) "a" value type is NA (Not A vailable) "m" value type is NM (No Match) A request that returns "Value type" attribute is shown below: XML Sample Request
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/10/01/S creener_1.sv c/A nony mous</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/rkd/S creener_1/ C alculate_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <C alculate_Request_1 xmlns="http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/rkd/S creener_1"> <criteria>{P rice}&gt;20</criteria> <form> <col name="N ame"/> <col name="#H oldRec_C "/> <col name="#Buy Rec_C "/> <pos row s="2"/> </form> </C alculate_Request_1> </Body > </E nv elope>

The response returns the following information: XML Sample Response

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/ rkd/S creener_1/C alculate_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <C alculate_Response_1 xmlns="http://w w w .reuters.com/ns/2009/10/01/w ebserv ices/rkd/S creener_1"> <rs row ="1" row s="20" all="21034"> <h> <c name="N ame" ty pe="string"/> <c name="#H oldRec_C " ty pe="number"/> <c name="#Buy Rec_C " ty pe="number"/> </h> <r> <v >C A S IO C O M P U TE R C O LTD</v > <v >4</v > // actual value, default value t='r' is not returned <v >1</v > </r> <r> <v >N IP P O N M IN IN G H O LDIN G S , IN C .</v >

704

TRKD API Developer's Guide

<v t="a"/> // t="a" means <v t="a"/> </r> </rs> </C alculate_Response_1> </Body > </E nv elope>

that the value is not available for the company

Significant Developments

705

chapter 36

Significant Developments

Thomson Reuters Significant Developments is a news analysis and filtering service that identifies crucial, market-moving company news on a near real-time basis for a large universe of public companies. You can use Significant Developments to screen through company press releases and briefly summarize major company specific developments. The targeted coverage is 30,000+ publicly traded companies in 80 countries. Thomson Reuters Significant Developments allows users to keep abreast of the market without screening through high volumes of press releases. This service allows for customized reports on companies and/or areas of interest (e.g. M&A activity in a particular industry). The data, including history, is made available in a highly searchable format allowing users to analyze trends and patterns for a company, industry or subject matter. Thomson Reuters analysts monitor thousands of press releases daily, identifying those developments that are significant to a companys current or future operations. Each story, complete with a date, time and headline, is tagged according to subject and is assigned a significance level. There are 27 possible subject topics and three levels of significance (1 = high, 2 = medium, 3 = low). The Thomson Reuters significant development database is created by trained analysts on a real time basis who continuously monitor various news sources (Business Wire, Wall Street Journal, for example) for significant developments that are viewed as soon as they become available to public. The analysts create abstracts and tag them by subject and importance.

36.1

Authentication/Authorization, Service Endpoint, and Required Headers

Authorization All requests to the Significant Developments web service require an authorization token. For details, see section Understanding Authentication Tokens. Authentication Significant Developments uses Reuters impersonation tokens for each effective user. In this case, Thomson Reuters must create each user before your application authenticates them. Unmanaged effective users are not supported in Significant Developments. For additional information, see section Creating a Token . Service Endpoint Significant Developments Endpoint
http://api.rkd.reuters.com/api/2006/05/01/S ignificantDev elopments_1.sv c

Required Header Required HTTP Headers

P O S T api/2006/05/01/S ignificantDev elopments_1.sv c H TTP /1.1 C ontent-Ty pe: application/soap+xml H ost: api.rkd.reuters.com C ontent-Length: [length]

36.2

WSDL
WSDL:
http://api.rkd.reuters.com/schemas/w sdl/S ignificantDev elopments_1_H ttpA ndRKDToken.w sdl

706

TRKD API Developer's Guide

36.3

Significant Developments Requests

You can specify a number of criteria to filter significant developments, including: Company Development ID Front page stories Period Significance Number of Developments Topic Code Thomson Reuters Significant Developments currently provides a single request named GetSignificantDevelopments_Request_1 which allows three ways to search. These three types of search are: FindRequest: Allows the user to search by RIC codes, start and end dates, specific significance levels, topic codes etc. FindByIdRequest: Allows the user to retrieve a specific news story by searching on the development id. FindRequestByFrontPage: Allows the user to retrieve current days news stories based on whether they are on the front page or not. Note: Thomson Reuters recommends setting MaxNumberOfItems=100 for all requests to speed up the search and to avoid time out errors in cases when companies have accumulated an extremely large amount of stories that are not relevant to the search. Even though <MaxNumgberOfItems> is an optional attribute, Thomson Reuters recommends including <MaxNumberOfItems> in each significant developments request.

XML Sample Request - Significant Developments Find Request

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/S ignificantDev elopments_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/ S ignificantDev elopments_1/G etS ignificantDev elopments_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etS ignificantDev elopments_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S ignificantDev elopments_1"> <F indRequest S tartDate="<S tart Date (O ptional)>" E ndDate="<E nd Date (O ptional)>" S ignificance="<S ignificance Lev el (O ptional)>" Topics="<Topic List (O ptional)>" F rontP age="<F ront P age F lag (O ptional)" M axN umberO fItems="<M aximum number of items (O ptional)>" > <C ompany Identifiers> <RIC V alue="<RIC C ode>"/> </C ompany Identifiers> </F indRequest> </G etS ignificantDev elopments_Request_1> </Body > </E nv elope>

Attribute StartDate EndDate

Description The starting date where Thomson Reuters Significant Developments should begin searching for news stories. The end date where Thomson Reuters Significant Developments should end searching for news stories.

Significant Developments

707

Significance

There are currently 3 flags used to disclose the level of significance: 1 = High 2 = Medium 3 = Low Topics There are total of 22 topics available for Thomson Reuters Significant Development stories. Each development can include up to 3 topic codes depending on the nature of development story. There will always be a minimum of one topic code will be assigned to each development. For further information on Topic codes and their descriptions please refer to section Topics and Descriptions. FrontPage Indicates if response should only contain stories that are "Front Page". MaxNumberOfItem Sets the number of news stories returned in the response. s Note : Thomson Reuters recommends setting MaxNumberOfItems="100" for all requests to speed up the search and to avoid time out errors in cases when companies have accumulated an extremely large amount of stories that are not relevant to the search. Even though <MaxNumberOfItems> is an optional attribute, Thomson Reuters recommends including <MaxNumberOfItems> in each significant developments request. FindByIDRequest Example XML Sample Request - Significant Developments Find Request
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/S ignificantDev elopments_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/ S ignificantDev elopments_1/G etS ignificantDev elopments_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etS ignificantDev elopments_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S ignificantDev elopments_1"> <F indBy IdRequest> <Dev elopment>"<Dev elopmentID>"</Dev elopment> </F indBy IdRequest> </G etS ignificantDev elopments_Request_1> </Body > </E nv elope>

Attribute

Description

DevelopmentID Development Id of a news story. FindRequestByFrontPage XML Sample Request - Significant Developments Find Request
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/S ignificantDev elopments_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/ S ignificantDev elopments_1/G etS ignificantDev elopments_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etS ignificantDev elopments_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S ignificantDev elopments_1"> <F indRequestBy F rontP age F rontP age="<F ront P age F lag>" M axN umberO fItems="<M aximum number of items>" /> </G etS ignificantDev elopments_Request_1> </Body >

708

TRKD API Developer's Guide

</E nv elope>

Attribute FrontPage

Description Indicates if response should only contain stories that are "Front Page" or the ones that are not. The default value is "Yes". MaxNumberOfIte Sets the number of news stories returned in the response. ms Note : Thomson Reuters recommends setting MaxNumberOfItems="100" for all requests to speed up the search and to avoid time out errors in cases when companies have accumulated an extremely large amount of stories that are not relevant to the search. Even though <MaxNumberOfItems> is an optional attribute, Thomson Reuters recommends including <MaxNumberOfItems> in each significant developments request.

36.3.1 XSD
XSD
XSD: http://api.rkd.reuters.com/schemas/S ignificantDev elopments_1.xsd

36.3.2 Company Requests

Use a RIC symbol to get Significant Development stories about a company. XML Sample Request - Significant Developments Company Request
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/S ignificantDev elopments_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/ S ignificantDev elopments_1/G etS ignificantDev elopments_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etS ignificantDev elopments_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S ignificantDev elopments_1"> <F indRequest S ignificance="1 2 3" M axN umberO fItems="10"> <C ompanyIdentifier s> <RIC V alue="msft.o" /> </C ompanyIdentifier s> </F indRequest> </G etS ignificantDev elopments_Request_1> </Body > </E nv elope>

You can also make a single request for many companies by simply repeating the company identifier element for each company you want.

36.3.3 Multiple Company Request

The following example requests information on three companies (Vodafone, IBM and Microsoft) within a single request. XML Sample Request <E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/S ignificantDev elopments_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID>

Significant Developments

709

<A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/ S ignificantDev elopments_1/G etS ignificantDev elopments_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etS ignificantDev elopments_Request_1 xmlns=" http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S ignificantDev elopments_1"> <F indRequest S ignificance="1 2 3" M axN umberO fItems="10"> <C ompanyIdentifier s> <RIC V alue="vod.l" /> <RIC V alue="ibm.n" /> <RIC V alue="msft.o" /> </C ompanyIdentifier s> </F indRequest> </G etS ignificantDev elopments_Request_1> </Body > </E nv elope>

36.3.4 Period Specific Requests

Use StartDate and EndDate (GMT) to specify the period for the significant development request. XML Sample Request - Significant Developments Period Specific Request
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/S ignificantDev elopments_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/ S ignificantDev elopments_1/G etS ignificantDev elopments_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etS ignificantDev elopments_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S ignificantDev elopments_1"> <F indRequest S ignificance="1 2 3" M axN umberO fItems="10" Star tDate="2 0 0 6 -1 0 -2 0 T 0 0 :0 0 :0 0 " EndDate="2 0 0 6 -1 0 2 5 T 0 0 :0 0 :0 0 "> <C ompany Identifiers> <RIC V alue="v od.l" /> </C ompany Identifiers> </F indRequest> </G etS ignificantDev elopments_Request_1> </Body > </E nv elope>

Note: Thomson Reuters began collecting significant development stories in January 1999.

36.3.5 Significance Level Requests

The level of significance is assigned by our analyst team, after determining the priority of the given development for a given company. Use the significance attribute to limit the significant developments to a particular significance level (1, 2, 3). Use a space separated list to specify multiple levels. If you do not specify a significance level, the significant developments service returns all three levels. XML Sample Request - Significant Developments with Significance Level
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope">

710

TRKD API Developer's Guide

<H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/S ignificantDev elopments_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/ S ignificantDev elopments_1/G etS ignificantDev elopments_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etS ignificantDev elopments_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S ignificantDev elopments_1"> <F indRequest Significance="1 2 " M axN umberO fItems="10"> <C ompany Identifiers> <RIC V alue="v od.l" /> </C ompany Identifiers> </F indRequest> </G etS ignificantDev elopments_Request_1> </Body > </E nv elope>

36.3.6 Specifying the Number of Developments

Use the MaxNumberOfItems attribute to specify the number of significant developments to return. The default value is 100. Note: Thomson Reuters recommends setting MaxNumberOfItems=100 for all requests to speed up the search and to avoid time out errors in cases when companies have accumulated an extremely large amount of stories that are not relevant to the search. Even though <MaxNumberOfItems> is an optional attribute, Thomson Reuters recommends including <MaxNumberOfItems> in each significant developments request. XML Sample Request - Significant Developments Specifying the Number of Developments
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/S ignificantDev elopments_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/ S ignificantDev elopments_1/G etS ignificantDev elopments_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etS ignificantDev elopments_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S ignificantDev elopments_1"> <F indRequest S ignificance="1 2 3" M axNumber O fItems="1 0 "> <C ompany Identifiers> <RIC V alue="v od.l" /> </C ompany Identifiers> </F indRequest> </G etS ignificantDev elopments_Request_1> </Body > </E nv elope>

36.3.7 Topic Code Requests

There are a total of 40 topics. Each development can include up to three topic codes depending on the nature of the development. There is always a minimum of one topic code assigned to each development. For a list of codes and their descriptions, see section Topics and Descriptions. Use the Topics attribute to get Significant Developments about a particular topic. Use a space separated list for multiple topics. For additional information about topics and topic codes, see section Topics and Descriptions.

Significant Developments

711

XML Sample Request - Significant Developments Requests By Topic Code

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/S ignificantDev elopments_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/ S ignificantDev elopments_1/G etS ignificantDev elopments_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etS ignificantDev elopments_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S ignificantDev elopments_1"> <F indRequest S ignificance="1 2" M axN umberO fItems="10" T opics="2 0 1 2 0 4 "> <C ompany Identifiers> <RIC V alue="msft.o" /> </C ompany Identifiers> </F indRequest> </G etS ignificantDev elopments_Request_1> </Body > </E nv elope>

36.3.8 Front Page Requests

Thomson Reuters uses the Front Page designation to highlight the most important stories of the day and/or a specific time of the day. On most days, there should be at least four Front Page stories before and after the bell, totaling eight to ten top stories a day. In addition, Thomson Reuters monitors the standard press release sources for top significant developments, and checks other real time websites (for example, Yahoo! Finance, Reuters Front Page, Wall Street Journal Front Page, CBS MarketWatch, TheStreet.com) for potential Front Page news. Use the "FrontPage" attribute to limit the developments to front page stories only. Note: Thomson Reuters recommends setting MaxNumberOfItems=100 for all requests to speed up the search and to avoid time out errors in cases when companies have accumulated an extremely large amount of stories that are not relevant to the search. Even though <MaxNumberOfItems> is an optional attribute, Thomson Reuters recommends including <MaxNumberOfItems> in each significant developments request. XML Sample Request - Significant Developments Request with Front page stories
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/S ignificantDev elopments_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/ S ignificantDev elopments_1/G etS ignificantDev elopments_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etS ignificantDev elopments_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S ignificantDev elopments_1"> <F indRequest M axN umberO fItems="10" Fr ontP age=tr ue> </G etS ignificantDev elopments_Request_1> </Body > </E nv elope>

36.3.9 Development ID Requests

Thomson Reuters uses a Development ID to uniquely identify each development in the database. Thomson Reuters

712

TRKD API Developer's Guide

generates and maintains these numbers. Development IDs do not change over time and are never re-used. If you know a specific development ID, use that ID to get the development. XML Sample Request - Significant Developments Request by DeveloperID
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/S ignificantDev elopments_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/ S ignificantDev elopments_1/G etS ignificantDev elopments_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etS ignificantDev elopments_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S ignificantDev elopments_1"> <F indBy IdRequest> <Development>7 5 3 2 4 8 </Development> </F indBy IdRequest> </G etS ignificantDev elopments_Request_1> </Body > </E nv elope>

36.4

Understanding the Significant Development Response

The significant developments web service response contains the developments you request, as well as the related metadata. XML Sample Response - Significant Developments
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S ignificantDev elopments_1/ G etS ignificantDev elopments_1_Reply </a:A ction> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etS ignificantDev elopments_Response_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S ignificantDev elopments_1"> <F indResponse> <Dev elopment> <Xrefs> <RepN o>57840</RepN o> <Dev elopmentId>1297864</Dev elopmentId> <N ame>M icrosoft C orporation</N ame> <Ticker>M S F T</Ticker> <RIC >M S F T.O Q </RIC > <C ountry >U S A </C ountry > </Xrefs> <Dates> <S ource>2008-04-25T13:00:00</S ource> <Initiation> 2008-04-25T13:06:51.597</Initiation> <LastU pdate>2008-04-25T13:06:51.66</LastU pdate> </Dates> <F lags> <F rontP age>false</F rontP age> <S ignificance>3</S ignificance> </F lags> <Topics> <Topic1 C ode="207">A cquisitions</Topic1> </Topics> <H eadline>M icrosoft C orp. C ompletes Tender O ffer F or F ast S earch & Transfer A S A </H eadline>

Significant Developments

713

<Description>M icrosoft C orp. announced that it has completed settlement of its tender offer for F ast S earch & Transfer A S A , a prov ider of enterprise search solutions. M icrosoft's plans to acquire F A S T w ere originally announced January 8, 2008. F A S T w ill operate as a M icrosoft subsidiary , w ith a dedicated enterprise search research and dev elopment center in O slo, N orw ay , and offices throughout the w orld. </Description> </Dev elopment> </F indResponse> </G etS ignificantDev elopments_Response_1> </Body > </E nv elope>

The XREFS Section Data Type RepNo Description A RepNo (Reuters Report Number) uniquely identifies each issuer (company) covered by Thomson Reuters. Thomson Reuters generates and maintains these numbers. RepNos do not change over time and are never re-used.

Development ID Thomson Reuters uses a Development ID to uniquely identify each development in the database. Thomson Reuters generates and maintains these numbers. Development IDs do not change over time and are never re-used. Name Ticker RIC Country Company name. Ticker Id. RIC ID assigned to the company. Country the headquarters of the company is located in.

Development Dates There are three dates associated with each development: source, initiation and lastupdate. Each date is displayed in GMT. Data Type Source Date Initiation Date Description Indicates the date of the press release where the development news was originally sourced from. Indicates the date and time when the development new was entered into our database for the first time by our analyst staff.

LastUpdate Date Indicates the date and time when Thomson Reuters last updated the development news. If the initiation and lastupdate dates are the same, then there is no update for the given development after the first time it was entered. XML Sample
<Dates> <S ource>2006-08-23T23:00:00.0000000-04:00</S ource> <Initiation>2006-08-24T04:17:25.3730000-04:00</Initiation> <LastU pdate>2006-08-24T07:06:56.3700000-04:00</LastU pdate> </Dates>

The Front Page and Significance Flags Thomson Reuters associates two flags with each development: front page and significance. Data Type Front Page Significance Description Indicates if a given development is coming from a front page story or not. There are true or false flags used to indicate the nature of this data point. Indicates the level of importance (1=High, 2=Medium, 3=Low) for the development.

The level of significance is assigned by our analyst team, after determining the priority of the given development for a given company. Please, note that there is a list of guidelines used to determine the significance level. For example, large companies do not need every small contract identified. In some cases a development is critical towards one particular companys business, but for other companies, that same development is of very little importance. A sale agreement between IBM and a small market cap firm, as a news story, can be identified as a low level development for IBM, while it can be tagged as a high level development for the small market cap company. Thomson Reuters uses the Front Page designation to highlight the most important stories of the day and/or a specific time of the day. On most days, there should be at least four Front Page stories before and after the bell totaling eight to ten top

714

TRKD API Developer's Guide

stories a day. In addition, Thomson Reuters monitors the standard press release sources for top significant developments, and checks other real time web sites (for example, Yahoo! Finance, Reuters Front Page, Wall Street Journal Front Page, CBS MarketWatch, TheStreet.com) for potential Front Page news. XML Sample
<F lags> <F rontP age>false</F rontP age> <S ignificance>1</S ignificance> </F lags>

Topics and Topic Codes There are a total of 40 topics. Each development can include up to three topic codes depending on the nature of the development. There is always a minimum of one topic code assigned to each development. For a list of codes and their descriptions, see section Topics and Descriptions. XML Sample
<Topics> <Topic1 C ode="253">S trategic C ombinations</Topic1> <Topic2 /> <Topic3 /> </Topics>

Headline The headline usually includes relevant information such as the company name and issue topic. To create a useful headline, the analyst may shorten or otherwise form the headline to indicate the summary of the development. XML Sample
<H eadline>M ittal S teel C ompany N .V . A nd N ippon S teel To Lift O utput A t U S JV -Reuter</H eadline>

Description The description section contains the significant development story. XML Sample
<Description>M attel, Inc. announced that it has entered a multi-y ear w orldw ide licensing agreement w ith S creenlife LLC to manufacture, distribute and market the first DV D-based board game S cene It?. The licensing agreement also giv es M attel exclusiv e rights to the S cene It? Brand across a broad spectrum of toy categories including traditional, electronic and interactiv e games.</Description>

36.5

Handling Dual-listed Companies

While Thomson Reuters collects information about multiple issues per company (that is, shares outstanding, DPS for various classes of share etc.), these multiple classes of shares do not add to the total company count. An exception to this rule occurs when one company reports financials using two different accounting standards. This could happen, for example, for a non-US company with American Depository Receipts (ADRs) trading in the US and a local issue trading in its home exchange. If these two instruments are associated with financials using different accounting standards, then the Thomson Reuters Fundamental database contains two companies one to represent each of the above examples. A similar dual listing (with different accounting standards) could occur with other pairs of countries, such as UK/Australia etc. Currently there are about 1,000 companies in the database that are dual listed in this manner. You can obtain a list of all such companies upon request. Use the country of exchange for each company to determine the origin of each version of the company.

36.6

Topics and Descriptions

Thomson Reuters Analysts categorize Significant Development stories using the following Topics. Thomson Reuters assigns up to three topics to each story. Description Positive Earnings PreAnnouncement Explanation Pre-announcement (Guidance) provided by company when it expects to exceed (and by how much) estimates published by analysts or company themselves. Includes revised

Significant Developments

715

estimates, current consensus estimates, and reason for revision. Pre-announcement (Guidance) provided by company when it expects to fall below (and by how much) estimates published by analysts or company themselves. Includes revised estimates, current consensus estimates, and reason for revision. Other Pre-Announcement Pre-announcement (Guidance) provided by company when it expects to meet estimates published by analysts or company themselves. May also incorporate general business outlook or specific guidance when no published estimates are available. Includes revised estimates and current consensus estimates. Initial Public Offerings All new issuances of stock for the first time publicly on a stock exchange. Equity Financing /Related Includes the issuance of Common or Preferred Stock as a means of raising capital (secondary offerings, private placements, etc). Debt Financing Encompasses the issuance of new debt instruments as well as financial restructurings. Mergers / Acquisitions Includes name of company and brief business summary, specific terms of the deal, expected completion date and type of accounting treatment used. Does not include whether or not deal is accretive to earnings, is subject to regulatory factors or board/ shareholder approval and subsequent new management structure. Equity Investments Any purchase/sale of a companys equity by another company, individual or group of investors when interest represents less than 50% of company. Divestitures / Spin-offs Disposal or sale of product line, segment or division. Share Repurchase Companys repurchase of common stock on the open market. Indices Changes Includes DJIA, S&P 500, NASDAQ 100 Does not include other indices such as S&P MidCap 400, S&P SmallCap 600, Russell 2000. Litigation / Regulatory/ Related Includes lawsuits for a significant amount of money or resulting in discontinuation of a product, division or segment. Also includes Justice Department inquiries, state inquiries, criminal investigations and SEC investigations. Does not include class action security lawsuits or lawsuits of immaterial value. Accounting Issues Includes inquiries regarding companies accounting practices, earnings restatements, delayed filings, and auditors comments. Bankruptcy / Related Companies filing for, or emerging from, Chapter 11 Bankruptcy protection. Restructuring /Reorganization All reorganizations and organizational restructurings and cost of restructuring, where available. Includes workforce reductions, facility closures and consolidation of business segments/divisions. Joint Ventures /Strategic Alliances / Includes joint ventures, collaborations or alliances involving multiple companies and the Business Deals licensing of one companys product to another. Separate stories will be written up for each company involved. Expansion / New Markets / New Includes geographical expansion, the creation of new operating segments/units and Units entrance into new markets. Products Includes new products and enhancements to existing products with specified improvements. Not Included: Enhancements/beta versions of existing products. Officer Changes Changes to Chairman, CEO, President or CFO only. Exchange Changes Changes in exchange (NYSE, Nasdaq, Amex, OTC Bulletin Board). Name Changes Name changes as confirmed by an exchange. Special Events Includes all other developments that do not fall into any of the above categories or developments added based upon stock volatility (unless +/- movement in excess of 15%). This includes positive or weak earnings reports, analyst up/down grades, significant dividend cuts, and political news. Negative Earnings PreAnnouncement

Topic Code 201 202 204 207 210 213 214 216 217

Topic Products Production Guidance Joint Ventures / Strategic Alliances / Business Deals Mergers / Acquisitions Officer Changes Divestitures Spin-offs New Business / Unit / Subsidiary New Market

716

TRKD API Developer's Guide

219 222 225 226 227 228 231 232 233 234 237 240 242 243 244 245 246 249 252 253 254 255 256 257 258 259 260 261 281 282 283

Equity Investments Share Repurchases Restructuring / General Reorganization Layoffs Labour Issues Bankruptcy / Related Initial Public Offerings Equity Financing / Related Debt Financing / Related Indices Changes Exchange Changes Name Changes Accounting Issues Corporate Litigation Class Action Lawsuit Earnings Announcements Negative Earnings Pre-Announcement Positive Earnings Pre-Announcement Other Earnings Pre-Announcement Strategic Combinations Regulatory / Company Investigation No Significant Developments Reported Dividends Debt Ratings Special Events / Other Restatements Delinquent Filings Change in Accounting Method / Policy Too long Significant Development Too long Comments Too short Significant Development

Street Events

717

chapter 37

Street Events

The Street Events API is a web service providing access to StreetEvents' proprietary content. The service allows searching for events, retrieving detail for specific events, and retrieving events related to specific companies. The information returned by the service includes identifiers which may be passed to Thomson Reuters Document Retrieval (TRDR) to obtain briefs, transcripts, and SEC filings delta reports. The following operations are available through the People Search service: Get Economic Headlines (GetEconomicHeadlines_1) - searches for economic events based on date/time range, and/or relatedness to one or more specified market country code. Get Event (GetEvent_1) - retrieves details for a specific event. Get Event Headlines (GetEventHeadlines_1) - searches for events based on date/time range, type of event, relatedness to specific symbols or symbols in a portfolio, and/or relatedness to one or more specified markets or industries. Get Event Headlines Overview (GetEventHeadlinesOverview_1) - retrieves a limited set of recent and upcoming events related to a specific company. Get Webcast Url (GetWebcastUrl_1) - retrieves the url for a specific webcast.

37.1

Authentication/Authorization, Service Endpoint, and Required Headers

Authorization All requests to the Street Events service require an authorization token. For details, see section Understanding Authentication Tokens. Authentication The Street Events service uses Reuters impersonation tokens for each effective user. In this case, Thomson Reuters must create each user before your application authenticates them. Unmanaged effective users are not supported in Street Events. For additional information on creating a Service Token, see section Creating a Token. Service Endpoint Street Events Endpoint
http://api.rkd.reuters.com/api/2009/01/26/S treetE v ents_1.sv c

Required Header Required HTTP Headers

P O S T api/2009/01/26/S treetE v ents_1.sv c H TTP /1.1 C ontent-Ty pe: application/soap+xml H ost: api.rkd.reuters.com C ontent-Length: [length]

37.2

WSDL
WSDL:
http://api.rkd.reuters.com/schemas/w sdl/S treetE v ents_1_H ttpA ndRKDToken.w sdl

718

TRKD API Developer's Guide

37.3

Get Economic Headlines (GetEconomicHeadlines_1)

GetEconomicHeadlines_1 request allows clients to search for economic events based on when they occur, and/or inclusion of that company in specific set of country codes. Each criterion field included in a request is combined with other criteria using Boolean 'AND' logic- i.e., adding additional criteria to a request will increasingly filter the returned event headlines. Responses to all requests are limited to a maximum of 2000 headlines. The operation supports paging and sorting. The following example requests economic headlines for the specified time range and 'US' country code: XML Sample Request - Retrieving Economic Headlines
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/26/S treetE v ents_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/S treetE v ents_1/ G etE conomicH eadlines_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etE conomicH eadlines_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/S treetE v ents_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:c="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/S treetE v ents_1_C riteria" xmlns:e="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/S treetE v ents_1_E v ents"> <c:DateT imeRange > <c:F rom>2009-03-10T09:30:47.0Z</c:F rom> <c:To>2009-03-15T09:30:47.0Z</c:To> </c:DateTimeRange> <e:M ar ketC ountr yC odes > <e:C ountry C ode>U S </e:C ountry C ode> </e:M arketC ountry C odes> <e:P agination> <e:P ageNumber >1</e:P ageN umber> <e:Recor dsP er P age >2</e:RecordsP erP age> </e:P agination> </G etE conomicH eadlines_Request_1> </Body > </E nv elope>

The request can take the following attributes: Attribute DateTimeRange Description The date/time range over which events must be included in the search results. This is a required field, and the From date must precede the To date. MarketCountryC An optional array of ISO 3166 country codes. If included, only economic event headlines related to the odes specified country or countries will be returned by the search. If left empty or null, no market/countrybased filtering will be done. Classification An optional array of Economic Classification enumerations restricting the response to events with the specified classifications. Since events may have multiple classifications, the response may still indicate classifications outside of the subset included in this filter. Possible values are: Consumer sector External sector Government sector Industry sector Labour market Money and finance National accounts Prices Surveys and cyclical indexes Other If left null or empty, no classification filter will be applied.

Street Events

719

SortOrder Pagination

An optional field specifying the sort field and sort direction. If left blank or empty, default sorting is by ascending date. For more details see section SortCriterion. A required structure indicating which page to return and how many records to define as a "page". Pagination is a required field. The PageNumber and RecordsPerPage properties of Pagination must both be greater than 0. For more details see section Pagination.

The request returns the following information: XML Sample Response - Retrieving Economic Headlines
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/S treetE v ents_1/ G etE conomicH eadlines_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-02-12T14:04:32.1894661Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etE conomicH eadlines_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/S treetE v ents_1"> < EconomicH eadlines xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/S treetE v ents_1_E v ents"> <EconomicH eadline> <E v entId>2044329</E v entId> <E v entTy pe>E conomicE v ents</E v entTy pe> <Duration> <E ndDateTime>2009-03-10T11:45:00</E ndDateTime> <E ndQ ualifier>N one</E ndQ ualifier> <IsE stimate>false</IsE stimate> <S tartDateTime>2009-03-10T11:45:00</S tartDateTime> <S tartQ ualifier>DateTime</S tartQ ualifier> </Duration> <E v entN ame>IC S C -U BS Retail C hain S tore S ales (w /o M ar. 6, 2009)</E v entN ame> <C ountry C ode>U S </C ountry C ode> <E conomicIndicator> <IndicatorN ame></IndicatorN ame> <U nit></U nit> <S cale></S cale> <P eriod>w /o M ar. 6, 2009</P eriod> <E xpectedV alue>0.0000</E xpectedV alue> <A ctualV alue>0.0000</A ctualV alue> <P riorV alue>0.0000</P riorV alue> <LastU pdate>2008-12-01T16:00:06.02Z</LastU pdate> <C lassifications></C lassifications> <DataS treamM nemonic></DataS treamM nemonic> </E conomicIndicator> </E conomicH eadline> <E conomicH eadline> <E v entId>2065162</E v entId> <E v entTy pe>E conomicE v ents</E v entTy pe> <Duration> <E ndDateTime>2009-03-10T12:55:00</E ndDateTime> <E ndQ ualifier>N one</E ndQ ualifier> <IsE stimate>false</IsE stimate> <S tartDateTime>2009-03-10T12:55:00</S tartDateTime> <S tartQ ualifier>DateTime</S tartQ ualifier> </Duration> <E v entN ame>Redbook Retail S ales Index (w /o M ar. 6, 2009)</E v entN ame> <C ountry C ode>U S </C ountry C ode> <E conomicIndicator> <IndicatorN ame></IndicatorN ame> <U nit></U nit> <S cale></S cale> <P eriod>w /o M ar. 6, 2009</P eriod> <E xpectedV alue>0.0000</E xpectedV alue> <A ctualV alue>0.0000</A ctualV alue> <P riorV alue>0.0000</P riorV alue> <LastU pdate>2009-01-06T14:00:06.13Z</LastU pdate> <C lassifications></C lassifications> <DataS treamM nemonic></DataS treamM nemonic> </E conomicIndicator>

720

TRKD API Developer's Guide

</EconomicH eadline> </E conomicH eadlines> < P aginationResult xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/S treetE v ents_1_E v ents"> <P ageN umber>1</P ageN umber> <RecordsO nP age>2</RecordsO nP age> <RecordsP erP age>0</RecordsP erP age> <TotalRecords>22</TotalRecords> </P aginationResult> </G etE conomicH eadlines_Response_1> </Body > </E nv elope>

Attribute Economic Headlines Paginatio nResult

Description A collection of Economic event "headlines" matching the request criteria. If no matches were found, this will be an empty array. For more details see section EconomicHeadlines. A structure indicating the current page, the number of results on the page, and the total number of headlines matching the search criteria. For more details see section PaginationResult.

37.4

Get Event (GetEvent_1)

GetEvent_1 returns details related to a single event. The following example requests details for the event with '2120870' EventId and 'RIC' and 'ExchangeTicker' symbol types: XML Sample Request - Retrieving Event Details
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/26/S treetE v ents_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/S treetE v ents_1/ G etE v ent_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etE v ent_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/S treetE v ents_1" xmlns:xsi="http://w w w .w 3. org/2001/XM LS chema-instance" xmlns:c="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/S treetE v ents_1_C riteria" xmlns: e="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/S treetE v ents_1_E v ents"> <e:EventId >2120870</e:E v entId> <c:O utputSymbolT ypes > <c:O utputS y mbolTy pe>RIC </c:O utputS y mbolTy pe> <c:O utputS y mbolTy pe>E xchangeTicker</c:O utputS y mbolTy pe> </c:O utputS y mbolTy pes> </G etE v ent_Request_1> </Body > </E nv elope>

The request can take the following attributes: Attribute EventId Description A valid event id obtained from a Headline. Note: Keep in mind that the GetEvent_1 operation accepts only 'EventIds' retrieved with the help of GetEventHeadlines_1 and GetEventHeadlinesOverview_1 operations and is not designed to return data by economic 'EventsIds'.

OutputSymbolTy The Organizations of headline will be returned with company identifiers as per the OutputSymbolTypes. pes If it is not specified, the response will default to SE Exchange Ticker. For more details see section SymbolCriterion. Note: OutputSymbolTypes request parameter is restricted to RIC and ExchangeTicker values only. The response returns the following information:

Street Events

721

XML Sample Response - Retrieving Event Details

<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/S treetE v ents_1/G etE v ent_1_Reply </a: A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-02-12T14:04:32.1894661Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etE v ent_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/S treetE v ents_1"> < Event xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/S treetE v ents_1_E v ents"> <C ountry C ode>U S </C ountry C ode> <E v entTy pe>C onferences</E v entTy pe> <Duration> <E ndDateTime>2009-03-10T19:00:00</E ndDateTime> <E ndQ ualifier>DateO nly </E ndQ ualifier> <IsE stimate>false</IsE stimate> <S tartDateTime>2009-03-06T20:00:00</S tartDateTime> <S tartQ ualifier>DateO nly </S tartQ ualifier> </Duration> <E v entId>2120870</E v entId> <LastU pdate>2009-03-04T13:36:48.783Z</LastU pdate> <Liv eDialIn> <P assw ord xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"></P assw ord> <S tatus>N one</S tatus> </Liv eDialIn> <Liv eWebcast> <S tatus>N one</S tatus> <Duration> <E ndDateTime>2009-03-10T19:00:00</E ndDateTime> <E ndQ ualifier>DateO nly </E ndQ ualifier> <IsE stimate>false</IsE stimate> <S tartDateTime>2009-03-06T20:00:00</S tartDateTime> <S tartQ ualifier>DateO nly </S tartQ ualifier> </Duration> <WebcastId></WebcastId> </Liv eWebcast> <N ame>A merican A cademy of Dermatology A nnual M eeting</N ame> <Replay DialIn> <P assw ord xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"></P assw ord> <S tatus>N one</S tatus> </Replay DialIn> <Replay Webcast> <S tatus>N one</S tatus> <Duration> <E ndDateTime>0001-01-01T00:00:00</E ndDateTime> <E ndQ ualifier>N one</E ndQ ualifier> <IsE stimate>false</IsE stimate> <S tartDateTime>2009-03-06T22:00:00</S tartDateTime> <S tartQ ualifier>DateO nly </S tartQ ualifier> </Duration> <WebcastId></WebcastId> </Replay Webcast> <O rganizations> <O rganization> <N ame>A merican A cademy of Dermatology </N ame> <S y mbols xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/S treetE v ents_1_C riteria"></S y mbols> </O rganization> </O rganizations> <A ssociatedE v ents> <A ssociatedE v ent> <E v entTy pe>C onferenceP resentations</E v entTy pe> <Duration> <E ndDateTime>2009-03-07T17:20:00</E ndDateTime> <E ndQ ualifier>N one</E ndQ ualifier> <IsE stimate>false</IsE stimate> <S tartDateTime>2009-03-07T17:20:00</S tartDateTime> <S tartQ ualifier>DateTime</S tartQ ualifier> </Duration>

722

TRKD API Developer's Guide

<E v entId>2121022</E v entId> <N ame>N O V A BA Y P H A RM A C E U TIC A LS IN C at A merican A cademy of Dermatology A nnual M eeting</N ame> <LastU pdate>2009-03-04T15:54:54.387Z</LastU pdate> </A ssociatedE v ent> </A ssociatedE v ents> <C ontacts></C ontacts> <Location> <N ame></N ame> <Description></Description> <N otes></N otes> <A ddress> <A ddressLine1></A ddressLine1> <A ddressLine2></A ddressLine2> <C ity >S an F rancisco</C ity > <S tateP rov ince>C A </S tateP rov ince> <P ostalC ode></P ostalC ode> <C ountry C ode></C ountry C ode> </A ddress> <Room></Room> <P rimary P honeN umber></P rimary P honeN umber> <A lternateP honeN umber></A lternateP honeN umber> <P rimary F axN umber></P rimary F axN umber> <A lternateF axN umber xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"></A lternateF axN umber> <E mail></E mail> <U rl></U rl> </Location> <N otes></N otes> <S ource>C LIE N T</S ource> <S ponsor> <N ame>A merican A cademy of Dermatology </N ame> <S y mbols xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/S treetE v ents_1_C riteria"></S y mbols> </S ponsor> <S ummary ></S ummary > <Rsv pInformation> <Deadline>0001-01-01T00:00:00</Deadline> </Rsv pInformation> </Event> </G etE v ent_Response_1> </Body > </E nv elope>

Attribute Description Event A structure describing details related to a single event. For more details see section Event.

37.5

Get Event Headlines (GetEventHeadlines_1)

GetEventHeadlines_1 allows clients to search for events based on when they occur, their event type, relation to a specific company or inclusion in a portfolio, and/or inclusion of that company in specific set of industries or markets. Each criterion field included in a request is combined with other criteria using boolean 'AND' logic- i.e., adding additional criteria to a request will increasingly filter the returned event headlines. Responses to all requests are limited to a maximum of 2000 headlines. The operation supports paging and sorting. The following example requests event headlines for the specified time range and 'Conferences' event type in the USA: XML Sample Request - Retrieving Event Headlines
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/26/S treetE v ents_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/S treetE v ents_1/ G etE v entH eadlines_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etE v entH eadlines_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/S treetE v ents_1"

Street Events

723

xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:c="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/S treetE v ents_1_C riteria" xmlns:e="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/S treetE v ents_1_E v ents"> <e:M ar ketC ountr yC odes > <e:C ountry C ode> US </e:C ountry C ode> </e:M ar ketC ountr yC odes > <c:DateT imeRange > <c:Fr om >2009-03-26T09:30:47.0Z</c:F rom> <c:T o >2009-03-27T09:30:47.0Z</c:To> </c:DateT imeRange > <e:EventT ypes > <e:E v entTy pe>C onferences</e:E v entTy pe> </e:EventT ypes > <e:P agination> <e:P ageN umber>1</e:P ageN umber> <e:RecordsP erP age>10</e:RecordsP erP age> </e:P agination> </G etE v entH eadlines_Request_1> </Body > </E nv elope>

The request can take the following attributes: Attribute DateTimeRange EventTypes Description The Date/Time range over which events may be included in the search results. This is a required field, and the From date must precede the To date. An optional list of types of events to include in the search results. If left empty or null, no filtering will be done on event type, and all event types may appear in the search results. For more details see section EventType. An optional structure specifying an industry code schema and a list of codes defined in this schema. If specified, only events related to the requested industry or industries will be included in the search results. If left empty or null, no industry-based filtering will be done. Currently, GICS is the only supported schema, and this property is ignored. IndustryCodes - a list of industry codes defined in the requested schema.

IndustryCodes

MarketCountryC An optional array of ISO 3166 country codes. If included, only events related to the specified country odes or countries will be returned by the search. If left empty or null, no market/country-based filtering will be done. Pagination A required structure indicating which page to return and how many records to define as a "page". Pagination is a required field. The PageNumber and RecordsPerPage properties of Pagination must both be greater than 0. For more details see section Pagination. An option id representing either a PortfolioWarehouse portfolio or a StreetEvents watchlist. PortfolioId may be left empty, in this case portfolio-based filtering will be done. Otherwise, PortfolioId must be convertible to an integer. Additionally, StreetEvents watchlist ids must be prefixed with "SE". Failure to meet these requirements will result in a service fault of category InvalidRequest. An optional field specifying the sort field and sort direction. If left blank or empty, default sorting is by ascending date. For more details see section SortCriterion. An optional list of symbols by which to filter the returned headlines. If included, only events related to the listed symbols will be returned. If left empty or null, no symbol-based filtering will be done. For more details see section SymbolCriterion.

PortfolioId

SortOrder Symbols

OutputSymbolTy The Organizations of headline will be returned with company identifiers as per the OutputSymbolTypes. pes If it is not specified, the response will default to SE Exchange Ticker. For more details see section SymbolCriterion Note: OutputSymbolTypes request parameter is restricted to RIC and ExchangeTicker values only. The response returns the following information: XML Sample Response - Retrieving Event Headlines
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/S treetE v ents_1/ G etE v entH eadlines_1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1"

724

TRKD API Developer's Guide

xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-02-12T14:04:32.1894661Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etE v entH eadlines_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/S treetE v ents_1"> < EventH eadlines xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/S treetE v ents_1_E v ents"> <H eadline> <C ountry C ode>U S </C ountry C ode> <E v entTy pe>C onferences</E v entTy pe> <Duration> <E ndDateTime>2009-03-27T10:00:00</E ndDateTime> <E ndQ ualifier>DateO nly </E ndQ ualifier> <IsE stimate>false</IsE stimate> <S tartDateTime>2009-03-23T10:00:00</S tartDateTime> <S tartQ ualifier>DateO nly </S tartQ ualifier> </Duration> <E v entId>2087902</E v entId> <LastU pdate>2009-02-02T14:32:03.447Z</LastU pdate> <Liv eDialIn> <P assw ord xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"></P assw ord> <S tatus>N one</S tatus> </Liv eDialIn> <Liv eWebcast> <S tatus>N one</S tatus> <Duration> <E ndDateTime>2009-03-27T10:00:00</E ndDateTime> <E ndQ ualifier>DateO nly </E ndQ ualifier> <IsE stimate>false</IsE stimate> <S tartDateTime>2009-03-23T10:00:00</S tartDateTime> <S tartQ ualifier>DateO nly </S tartQ ualifier> </Duration> <WebcastId></WebcastId> </Liv eWebcast> <N ame>M errill Ly nch S un C ity 1-on-1 C onference</N ame> <Replay DialIn> <P assw ord xsi:nil="true" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance"></P assw ord> <S tatus>N one</S tatus> </Replay DialIn> <Replay Webcast> <S tatus>N one</S tatus> <Duration> <E ndDateTime>0001-01-01T00:00:00</E ndDateTime> <E ndQ ualifier>N one</E ndQ ualifier> <IsE stimate>false</IsE stimate> <S tartDateTime>2009-03-23T12:00:00</S tartDateTime> <S tartQ ualifier>DateO nly </S tartQ ualifier> </Duration> <WebcastId></WebcastId> </Replay Webcast> <O rganization> <N ame>M errill Ly nch</N ame> <S y mbols xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/S treetE v ents_1_C riteria"></S y mbols> </O rganization> <Rsv pRequired>false</Rsv pRequired> </H eadline> .... </EventH eadlines > < P aginationResult xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/S treetE v ents_1_E v ents"> <P ageN umber>1</P ageN umber> <RecordsO nP age>10</RecordsO nP age> <RecordsP erP age>10</RecordsP erP age> <TotalRecords>16</TotalRecords> </P aginationResult> </G etE v entH eadlines_Response_1> </Body > </E nv elope>

Attribute Description EventHea A collection of event summary "headlines" matching the request criteria. If no matches were found, this will be dlines an empty array. For more details see section Headline.

Street Events

725

Paginatio A structure indicating the current page, the number of results on the page, and the total number of headlines nResult matching the search criteria. For more details see section PaginationResult.

37.6

Get Event Headlines Overview (GetEventHeadlinesOverview_1)

GetEventHeadlinesOverview_1 request returns a limited set of recent and upcoming events related to a single company. The following example requests overview of event headlines for the 'Conferences' event type and specified symbols: XML Sample Request - Retrieving Event Headlines Overview
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/26/S treetE v ents_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/S treetE v ents_1/ G etE v entH eadlinesO v erv iew _1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etE v entH eadlinesO v erv iew _Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/S treetE v ents_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:c="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/S treetE v ents_1_C riteria" xmlns:e="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/S treetE v ents_1_E v ents"> <e:EventT ypes > <e:E v entTy pe>C onferences</e:E v entTy pe> </e:E v entTy pes> <e:Recor dsP er Gr oup >1</e:RecordsP erG roup> <c:Symbol > <c:Ty pe>E xchangeTicker</c:Ty pe> <c:V alue>* * H E </c:V alue> </c:S y mbol> </G etE v entH eadlinesO v erv iew _Request_1> </Body > </E nv elope>

The request can take the following attributes: Attribute EventTypes Description An optional list of types of events to include in the response. If left empty or null, no filtering will be done on event type, and all event types may appear in the response. For more details see section EventType.

RecordsPerGroup The number of event headlines to include in each returned group (Recent and Upcoming). RecordsPerGroup must be between 1 and 10, inclusive. Values outside of this range will result in a service fault. Symbol A required field indicating which symbol to return overview results for. For more details see section SymbolCriterion.

The response returns the following information: XML Sample Response - Retrieving Event Headlines Overview
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/S treetE v ents_1/ G etE v entH eadlinesO v erv iew _1_Reply </a:A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-02-12T14:04:32.1894661Z</Date> <DoN otS tore /> </C acheResponse>

726

TRKD API Developer's Guide

<a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etE v entH eadlinesO v erv iew _Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/S treetE v ents_1"> < RecentEventH eadlines xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/S treetE v ents_1_E v ents" /> < UpcomingEventH eadlines xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/S treetE v ents_1_E v ents" /> </G etE v entH eadlinesO v erv iew _Response_1> </Body > </E nv elope>

Attribute RecentEv entHeadli nes

Description A list of the most recent events related to the requested symbol. The number of events in this list will be equal to the RecordsPerGroup specified in the request, or a smaller value if RecordsPerGroup exceeds the total number of available past events. These headlines are sorted by descending date. For more details see section Headline. Upcoming A list of upcoming events related to the requested symbol. The number of events in this list will be equal to the EventHea RecordsPerGroup specified in the request, or a smaller value if RecordsPerGroup exceeds the total number of dlines available upcoming events. These headlines are sorted by ascending date. For more details see section Headline.

37.7

Get Webcast Url (GetWebcastUrl_1)

GetWebcastUrl_1 request returns the url for viewing and event's webcast or replay webcast. The following example requests url for the 'abcde' webcast id: XML Sample Request - Retrieving Webcast Url
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2009/01/26/S treetE v ents_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/S treetE v ents_1/ G etWebcastU rl_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[serv ice token]</Token> </A uthorization> </H eader> <Body > <G etWebcastU rl_Request_1 xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/S treetE v ents_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:c="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/S treetE v ents_1_C riteria" xmlns:e="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/S treetE v ents_1_E v ents"> <e:WebcastId >66E 1645B-E 2E 2-4041-9383-E 6E 3C 1E E F E F 1</e:WebcastId> </G etWebcastU rl_Request_1> </Body > </E nv elope>

The request can take the following attributes: Attribute WebcastId Description Webcast Id copied from the WebcastOverview structure of an Event or Headline. Null, empty, or malformed values will result in a server fault. For more details see sections Event and Headline.

The response returns the following information: XML Sample Response - Retrieving Webcast Url
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/S treetE v ents_1/G etWebcastU rl_1_Reply </a:

Street Events

727

A ction> <C acheResponse xsi:ty pe="DoN otS toreC acheResponse" xmlns="http://w w w .reuters.com/ns/2008/03/01/w ebserv ices/rkd/C ache_1" xmlns:xsi="http://w w w .w 3.org/2001/XM LS chema-instance" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema"> <Date>2009-02-12T14:04:32.1894661Z</Date> <DoN otS tore /> </C acheResponse> <a:RelatesTo>[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etWebcastU rl_Response_1 xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/S treetE v ents_1"> < Ur l xmlns="http://w w w .reuters.com/ns/2009/01/26/w ebserv ices/rkd/S treetE v ents_1_E v ents" /> </G etWebcastU rl_Response_1> </Body > </E nv elope>

Attribute Description Url A url to the requested webcast.

37.8

StreetEvents Data Type Reference

This section contains reference information data types used in the Street Events service.

37.8.1 Request Data Types

These types are used when making requests to the StreetEvents API.

37.8.1.1 EventType
EventType is an enumeration of the types of events included in StreetEvents content. EventType can have the following values: Conferences CorporateCallsAndPresentations EarningsCallsAndPresentations EarningsReleases EconomicEvents GuidanceCallsAndPresentations MergerAndAcquisitionCallsAndPresentations SalesAndTradingStatementCallsAndPresentations SalesAndTradingStatementReleases ShareholderAndAnnualMeetings

37.8.1.2 Pagination
Attribute PageNumber Description The requested page of a multi-page set of headlines. This field is 1-based - specifying PageNumber=1 returns the first available page. RecordsPerPage The maximum number of headlines to include in the returned page of results. The Pagination field allows the client to page through a large set of headlines. Typical usage is to make a first search with PageNumber set to 1 and RecordsPerPage set to a modest value (25 is recommended). The PaginationResult field of the response can then be used to calculate the meaningful range of values for PageNumber which can be used on subsequent searches using the same search criteria. See also section PaginationResult. Note: Specifying a combination of PageNumber and RecordsPerPage which exceeds the total available headlines for a given search will result in zero records returned.

728

TRKD API Developer's Guide

37.8.1.3 PaginationResult
Attribute PageNumber RecordsOnPage Description The page number of the current set of headlines. This value is 1-based, and will always match the PageNumber specified in the request. See also section Pagination. The number of records in the current set of headlines. This value will match the RecordsPerPage specified in the request except when the requested PageNumber matches or exceeds the total available pages. The total number of headlines matching the search criteria.

TotalRecords

37.8.1.4 SortCriterion
Attribute By Description The field on which to sort. Possible values are: Date Symbol CompanyName EventName EventType - Note: The applied EventType sorting is based on the "eventsort" column found in one of the tables. It is not alphabetical by event type name. If absent or set to a value other those listed above, sorting will default to Date. Specifies whether to sort Ascending or Descending. SortDirection is a enumeration with values "Ascending" and "Descending".

Direction SortDirection

37.8.1.5 SymbolCriterion
Attribute Symbol Type Description Symbol Type and Value. The symbol type. The following symbol types are supported: CIK CUSIP CUSIP6 EXCHANGETICKER IBES ISIN ILXID RIC SEDOL TKOCOMPANYID TKOQUOTEID TKOSECURITYID A symbol of the given symbol type.

Value

37.8.2 Response Data Types

These types are returned in the responses of the StreetEvents API.

37.8.2.1 Event
Attribute Brief Description A structure describing the Brief status and, if available, a content identifier (BriefId) which may be used to retrieve the brief from TRDR. Brief status can have the following values: Available Expected (in the future)

Street Events

729

None (not available) The ISO 3166 country code to which this event is related. The type of event described by this headline. For more details see section EventType. The start and end times of the event (a conference call or webcast). Can have the following values: 'IsEstimate ' - If true, the start and end dates/times are estimated. DateTimeQualifie r - is an enumeration which describes adjustments applied to a date and time. Possible values are: None DateOnly DateTime BeforeMarketOpen AfterMarketClose EventId A unique id for this event. This id may be used in a subsequent call to the GetEvent_1 request. LastUpdate The date/time at which event information was last updated. LiveDialIn A structure describing when and how to access the live dial-in. Can have the following values: Duration - the duration of a dial-in conference call or conference-call replay. Password - the password, if required, for a dial-in. PhoneNumber - the phone number for a dial-in. AlternatePhoneNumber - the alternate phone number, if any, for a dial-in. LiveWebcast A structure describing the status and, if available, a content identifier which may be used to retrieve the webcast url using the GetWebcastUrl_1 request. Can have the following values: Status - whether a webcast is available, expected, or not available. Duration - the start and end times of the webcast. WebcastId - if the status is Available, a content identifier which may be used to retrieve the webcast url using the GetWebcastUrl_1 request. Name The name of the event. ReplayDialIn A structure describing when and how to access the replay dial-in. Can have the following values: Duration - the duration of a dial-in conference call or conference-call replay. Password - the password, if required, for a dial-in. PhoneNumber - the phone number for a dial-in. AlternatePhoneNumber - the alternate phone number, if any, for a dial-in. ReplayWebca A structure describing the status and, if available, a content identifier which may be used to retrieve the st replay webcast url using the GetWebcastUrl_1 request. Can have the following values: Status - whether a webcast is available, expected, or not available. Duration - the start and end times of the webcast. WebcastId - if the status is Available, a content identifier which may be used to retrieve the webcast url using the GetWebcastUrl_1 request. Transcript A structure describing the Brief status (Available , Expected or None ) and, if available, a content identifier which may be used to retrieve the brief from TRDR. Organizations A list of organizations related to the event. Can have the following values: CompanyName - the organization's name. Symbols - collections of organizations symbols. See section SymbolCriterion for more details. AssociatedEv A list of events associated with this event. See section EventOverview for more details. ents Contacts A list of contacts for this event including their names, organization names, titles, addresses, phone numbers, e-mails, Urls. Location The location of this event. Can have the following values: Name - name of the location. Description - description of the location. Notes - notes about this location. Address - address of the location. Room - a room for this location. PrimaryPhoneNumber - a primary phone number for this location. AlternatePhoneNumber - an alternate phone number for this location. PrimaryFaxNumber - a primary fax number for this location. AlternateFaxNumber - an alternate fax number for this location Email - an email for this location. Url - a web url for this location. Notes Notes on this event. CountryCode EventType Duration

730

TRKD API Developer's Guide

Source Sponsor

The source of the event information. For example: CLIENT or Sponsor. The company name and symbol of the event's sponsor. Can have the following values: CompanyName - the organization's name. Symbols - collections of organizations symbols. See section SymbolCriterion for more details. Summary A summary of this event. RsvpInformat A structure indicating how to rsvp to this event. Can have the following values: ion Deadline - date/time before which Rsvp must be submitted. Email - e-mail address to which Rsvp may be submitted. FaxNumber - fax number to which Rsvp may be submitted. PhoneNumber - phone number for submitting the Rsvp. Url - web-site through which an Rsvp may be submitted. Dividend Dividend details. This field is populated only for events of type ExDividends. Can have the following values: AnnouncementDate - date on which an income payment was first announced. ExDate - date on or after which transactions are not eligible for an Income Payment, unless traded on a special basis. PaymentDate - income payment date. RecordDate - date by which transfers must be received at the registrar to participate in direct distribution of income. Amount - amount of the dividend. Currency - currency in which the dividend was paid. PaymentType - describes the nature or type of the dividend. See section IdcPaymentTypeCode1 for more details. SecondaryPaymentType - provides supplemental, or alternative, to PaymentType. See section IdcPaymentTypeCode2 for more details. Split Split details. This field is populated only for events of type StockSplits. Can have the following values: AnnouncementDate - date on which the capital event details were first added in FTID's system. ExDate - date on which the event begins and new purchases of the security no longer confer the benefits of the issue unless special trading conditions are attached. PaymentDate - first day of trading for capital event securities. RecordDate - holders registered by this date may participate in the capital event. Amount - a value reflecting the dilution or concentration of the parent security capital relative to the pre-issue capital. For example, a 2-for-1 stock split would equal 2.0. Ratio IPO IPO details. This field is populated only for events of type IpoFilings, IpoLockupExpirations, IpoPricings, IpoWithdrawals, SecondaryWithdrawals, SecondaryPricings, and SecondaryFilings. Can have the following values: FilingDate - date on which IPO was filed. LockupExpiryDate OfferingPrice FilingPriceLow FilingPriceHigh FinalPrice TotalShares WithdrawalDate PricingDate Exchange - exchange in which the IPO was filed. FormFiled - form with which the IPO was recorded. LeadUnderwriter Description FiscalPeriod Fiscal Period of the event. Can have the following values: Quarter - quarter of the Fiscal Period. FiscalYear - fiscal Year of the Fiscal Period.

37.8.2.2 EventOverview
Attribute EventType Duration Description The type of this event. For more details see section EventType. The start and end times of the event. Can have the following values:

Street Events

731

EventId Name LastUpdate Organization

Transcript

'IsEstimate ' - If true, the start and end dates/times are estimated. DateTimeQualifie r - is an enumeration which describes adjustments applied to a date and time. Possible values are: None DateOnly DateTime BeforeMarketOpen AfterMarketClose A unique id for this event. This id may be used in a subsequent call to the GetEvent_1 request. The name of this event. The date/time at which event information was last updated. The company name and symbol of the events subject company. Can have the following values: CompanyName - the organization's name. Symbols - collections of organizations symbols. See section SymbolCriterion for more details. A content identifier which may be used to construct a request to retrieve the transcript from TRDR.

37.8.2.3 Headline
Attribute Brief Description A structure describing the Brief status and, if available, a content identifier (BriefId) which may be used to retrieve the brief from TRDR. Brief status can have the following values: Available Expected (in the future) None (not available) CountryCode The ISO 3166 country code to which this event is related. EventType The type of event described by this headline. For more details see section EventType. Duration The start and end times of the event (a conference call or webcast). Can have the following values: 'IsEstimate ' - If true, the start and end dates/times are estimated. DateTimeQualifie r - is an enumeration which describes adjustments applied to a date and time. Possible values are: None DateOnly DateTime BeforeMarketOpen AfterMarketClose EventId A unique id for this event. This id must be used in a subsequent call to the GetEvent_1 request. LastUpdate The date/time at which event information was last updated. LiveDialIn A structure describing when and how to access the live dial-in. Can have the following values: Duration - the duration of a dial-in conference call or conference-call replay. Password - the password, if required, for a dial-in. PhoneNumber - the phone number for a dial-in. AlternatePhoneNumber - the alternate phone number, if any, for a dial-in. LiveWebcast A structure describing the status and, if available, a content identifier which may be used to retrieve the webcast url using the GetWebcastUrl_1 request. Can have the following values: Status - whether a webcast is available, expected, or not available. Duration - the start and end times of the webcast. WebcastId - if the status is Available, a content identifier which may be used to retrieve the webcast url using the GetWebcastUrl_1 request. Name The name of the event. ReplayDialIn A structure describing when and how to access the replay dial-in. Can have the following values: Duration - the duration of a dial-in conference call or conference-call replay. Password - the password, if required, for a dial-in. PhoneNumber - the phone number for a dial-in. AlternatePhoneNumber - the alternate phone number, if any, for a dial-in. ReplayWebca A structure describing the status and, if available, a content identifier which may be used to retrieve the st replay webcast url using the GetWebcastUrl_1 request. Can have the following values:

732

TRKD API Developer's Guide

Status - whether a webcast is available, expected, or not available. Duration - the start and end times of the webcast. WebcastId - if the status is Available, a content identifier which may be used to retrieve the webcast url using the GetWebcastUrl_1 request. Transcript A structure describing the Brief status (Available , Expected or None ) and, if available, a content identifier which may be used to retrieve the brief from TDR. Organization The company name and symbol of the event's subject company. Can have the following values: CompanyName - the organization's name. Symbols - collections of organizations symbols. See section SymbolCriterion for more details. RsvpRequired Indicates whether this event requires an rsvp. Location The location of this event. Can have the following values: Name - name of the location. Description - description of the location. Notes - notes about this location. Address - address of the location. Room - a room for this location. PrimaryPhoneNumber - a primary phone number for this location. AlternatePhoneNumber - an alternate phone number for this location. PrimaryFaxNumber - a primary fax number for this location. AlternateFaxNumber - an alternate fax number for this location Email - an email for this location. Url - a web url for this location.

37.8.2.4 EconomicHeadlines
Attribute EventId EventType Description A unique id for this event. An optional list of types of events to include in the search results. If left empty or null, no filtering will be done on event type, and all event types may appear in the search results. For more details see section EventType. Duration Date/time on which the subject document was filed. Can have the following values: 'IsEstimate ' - If true, the start and end dates/times are estimated. DateTimeQualifie r - is an enumeration which describes adjustments applied to a date and time. Possible values are: None DateOnly DateTime BeforeMarketOpen AfterMarketClose EventName The name of the event. CountryCode The ISO 3166 country code to which this event is related. IndicatorNam Indicator name for the event. e Unit Unit is derived from unit based on Expectedlevel and CalculatedheaderName column from U_EventEconomicIndicatorDetail table. Scale Scale is derived from scale based on Expectedlevel and CalculatedheaderName column from U_EventEconomicIndicatorDetail table. Period The Month or the quarter of the year the event belongs to. ExpectedValu Estimated value. e ActualValue Actual value. PriorValue Previous value. LastUpdate Last updated date/time. Classification An optional array of Economic Classification enumerations restricting the response to events with the specified classifications. Since events may have multiple classifications, the response may still indicate classifications outside of the subset included in this filter. Possible values are: Consumer sector

Street Events

733

Mnemonics

External sector Government sector Industry sector Labour market Money and finance National accounts Prices Surveys and cyclical indexes Other Mnemonics.

37.8.2.5 IdcPaymentTypeCode1
IdcPaymentTypeCode1 is an enumeration with the following values: NormalCashDividend CashDividendPayableOnShares LessForeignTaxesNonCanadian SpecialDividendsAndLiquidations OptionalDividend UsWithholdingIncomeTaxResident InitialDividendAfterSplit IncludesSecurityProfitsAndGains DividendRateUnknown ForeignCurrencyNonCanadian StockDividend StockSplits IssuesCalled StockRights CanadianFundsNonResidentTax15Percent CanadianFundsNonResidentTax10Percent UsFundsCanadianNonResidentTax15Percent UsFundsCanadianNonResidentTax10Percent ApproximateDividendRate StockDividendInOtherCompanyStock StockDividendOnIncreasedShares StockSplitOnIncreasedShares InitialCanadianDividendOnIncreasedSharesLessTax15Percent InitialCanadianDividendOnIncreasedSharesLessTax10Percent StockDividendInMoreThanTwoIssues PaymentOmitted PrincipalDividendUit SpecialPrincipalUit SpecialInterestUit PayableInUsDollars RateUnknown IssueCalled FirstPayment CanadianFunds UsFundsSubjectToCanadianWithholdingTax FixMismatch AnnouncedPayment NewSituation

37.8.2.6 IdcPaymentTypeCode2
IdcPaymentTypeCode2 is an enumeration with the following values: Undefined ShortPayPeriod

734

TRKD API Developer's Guide

LongPayPeriod IncludesPrincipalCapitalGains IncludesDividendArrears IncludesYearEndSpecialProceedsFromSale IncludesOptionalDividendsOnIncreasedShares DistributionOfWarrants CanadianCurrency ForeignCurrencyNonCanadian InitialDividendToPublic DividendInterestCanceled InitialCashDividendPayableAfterStockSplit InitialCashDividendPayableAfterStockDividend ApproximateDividend InitialDividendAfterSplitCanadianDollars InitialDividendAfterStockDividendCanadianDollars DividendInterestCanceledByCompany NetAfterTax Gross DistributionSameCompanyDifferentIssue DistributionOfAnIssueOfAnotherCompany CashEquivalents PartialPayment LimitedPartnershipDistribution PayableOnSharesIncludedInUnits PoisonPill ReturnOfCapital ReturnOfCapitalPlusIncome EstimatedReturnOfCapital EstimatedReturnOfCapitalPlusIncome Liquidation LiquidationSurrenderOfCertificatesRequired FinalPaymentTransferBooksAreClosed OptionalDividendTotalCashRateIncludedInSpecializedFields DividendCanBePaidOptionallyInCanadianOrUsDollars SpecialDividend SpecialDividendPlusIncome ExtraDividend ExtraDividendPlusIncome YearEndDividend YearEndDividendPlusIncome AdditionalDividend ParticipatingDividend ProceedsFromSaleOfRights RedemptionOfRights PayableOnPresentationOfCertificates CalledAndIncomePayment LongAndShortTermCapitalGainsPlusIncome LongTermCapitalGainsOnly LongTermCapitalGainsPlusIncome LongAndShortTermCapitalGainsPlusIncome2 ShortTermCapitalGainsOnly ShortTermCapitalGainsPlusIncome CapitalGainsBreakdownUnavailable OtherSeeContinuationRecord AtCloseOfBusiness

Time Series

735

chapter 38

Time Series

TimeSeries consists of two operations that focus on providing you with historical prices on instruments. InterDay: retrieves historical timeseries prices on an instrument, summarised in daily, weekly or monthly periods. IntraDay: retrieves a timeseries of intraday market prices on an instrument, summarised in periods from 1 minute to 1 hour.

38.1

Authentication/Authorization, Service Endpoint, and Required Headers

Authorization All requests to the TimeSeries web service require an authorization token. For details, see section Understanding Authentication Tokens. Authentication TimeSeries uses Reuters impersonation tokens for each effective user. In this case, Thomson Reuters must create each user before your application authenticates them. Unmanaged effective users are not supported in TimeSeries. For additional information on creating a Service Token, see section Creating a Token.

Service Endpoint Time Series Endpoint

http://api.rkd.reuters.com/api/2006/05/01/TimeS eries_1.sv c

Required Header Required HTTP Headers

P O S T /api/2006/05/01/TimeS eries_1.sv c H TTP /1.1 C ontent-Ty pe: application/soap+xml H ost: api.rkd.reuters.com C ontent-Length: [length]

38.2

WSDL
WSDL:
http://api.rkd.reuters.com/schemas/w sdl/TimeS eries_1_H ttpA ndRKDToken.w sdl

38.3

InterDay
Interday lets you retrieve historical timeseries prices on an instrument, summarised in daily, weekly or monthly periods. For each period, details such as the opening price, closing price, highest and lowest prices are retrieved. Historical timeseries prices for an instrument are available on a daily basis for the previous 2 years, and on a weekly or monthly basis for the previous 5 years. Note: Interday data can go back up to 30 years in some cases.

736

TRKD API Developer's Guide

38.3.1 Retrieving Daily InterDay Data

XSD
XSD: http://api.rkd.reuters.com/schemas/TimeS eries_1.xsd

The following example requests daily information between 1/22/2007 and 1/25/2007. XML Sample Request - Daily Interday Data
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/TimeS eries_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/TimeS eries_1/ G etInterday TimeS eries_2</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etInterday TimeS eries_Request_2 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/TimeS eries_1"> <S y mbol>M S F T.O </S y mbol> <S tartTime>2007-01-22T00:00:00</S tartTime> <E ndTime>2007-01-25T00:00:00</E ndTime> <Inter val>DA ILY </Inter val> </G etInterday TimeS eries_Request_2> </Body > </E nv elope>

Note: Thomson Reuters recommends that you do not query for too much data via HTTP. By design, the TimeSeries service is limited not to send more than 3600 records (rows) to minimize bandwidth consumption. Any data over the 3600 record limit is truncated. If you do need a great number of records (more than 3600 records), Thomson Reuter recommends that you break up your query into several requests and then combine the responses together. Attribute Symbol StartTime EndTime Description A RIC of the instrument whose intraday prices you want to retrieve. Start date and time criteria of the search. The format of the Start time should be: YYYY-MM-DDThh: mm:ss End date and time criteria of the search. The format of the Start time should be: YYYY-MM-DDThh:mm: ss Note: Please pay attention that maximum <EndDate> interval is >=2038. If you specify a greater <EndDate> interval, you will receive a blank response. Interval The interval between samples. The choices are: DAILY WEEKLY MONTHLY

Note: You might get ERR_NOSUCHRIC error on TimeSeries, even though the RIC exists because Thomson Reuters TimeSeries service gives the same error ("ERR_NOSUCHRIC") for RICs which it does not have history for and also for invalid RICs. So, if you are sure that your RIC exists, then it might be missing in the Thomson Reuters TimeSeries database. TRKD logs all requests for RICs which fail, and we periodically add RICs which are requested but not available. XML Sample Response - Daily Interday Data
<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader> <a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/ rkd/TimeS eries_1/G etInterday TimeS eries_2_Reply </a:A ction>

Time Series

737

<a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etInterday TimeS eries_Response_2 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/TimeS eries_1"> <Row > <O P E N >31.059999465942383</O P E N > <H IG H >31.1200008392334</H IG H > <LO W>30.510000228881836</LO W> <C LO S E >30.719999313354492</C LO S E > <V O LU M E >5.6152E 7</V O LU M E > <TIM E S TA M P >2007-01-22T00:00:00+00:00</TIM E S TA M P > </Row > .... <Row > <O P E N >31.079999923706055</O P E N > <H IG H >31.479999542236328</H IG H > <LO W>30.450000762939453</LO W> <C LO S E >30.450000762939453</C LO S E > <V O LU M E >9.9382E 7</V O LU M E > <TIM E S TA M P >2007-01-25T00:00:00+00:00</TIM E S TA M P > </Row > </G etInterday TimeS eries_Response_2> </s:Body > </s:E nv elope>

Note: The response for FI RICs return additional value in the response - 'CLOSEYIELD': XML Sample Response - Retrieving Daily Interday Data for 'AU10YT=XX' FI RIC
<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader> <a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/ rkd/TimeS eries_1/G etInterday TimeS eries_2_Reply </a:A ction> <a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etInterday TimeS eries_Response_2 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/TimeS eries_1"> <Row > <O P E N >"97.553"</O P E N > <H IG H >"98.07"</H IG H > <LO W>"97.553"</LO W> <C LO S E >"97.844"</C LO S E > < C LO SEY IELD>"4.755"</C LO S E YIE LD> <TIM E S TA M P >"2009-04-30T00:00:00+00:00"</TIM E S TA M P > </Row > <Row > <O P E N >"92.6"</O P E N > <H IG H >"93.023"</H IG H > <LO W>"92.113"</LO W> <C LO S E >"92.396"</C LO S E > < C LO SEY IELD>"5.46313"</C LO S E YIE LD> <TIM E S TA M P >"2009-09-23T00:00:00+00:00"</TIM E S TA M P > </Row > ..... </G etInterday TimeS eries_Response_2> </s:Body > </s:E nv elope>

38.4

IntraDay
The INTRADAY function lets you retrieve a timeseries of intraday market prices on an instrument, summarised in periods from 1 minute to 1 hour (configurable). This is typically used in an intraday graph to show how the price has changed during a day. For each period in the intraday timeseries, open price (the first tick in the period), close price (the last tick in the period), high price, low price and volume are returned. Intraday timeseries covering one day is returned. Note that tick-by-tick intraday timeseries is not available.

738

TRKD API Developer's Guide

The supported time intervals (periods) for Intraday timeseries are: - 1 minute - 5 minutes - 30 minutes - 60 minutes Note: All values for the current day and 10 previous days are available.

38.4.1 Retrieving Hourly Intraday Data

XSD
XSD: http://api.rkd.reuters.com/schemas/TimeS eries_1.xsd

The following example requests hourly information for 04/28/08. XML Sample Request - Hourly Intraday Data
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/TimeS eries_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/TimeS eries_1/ G etIntraday TimeS eries_2</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etIntraday TimeS eries_Request_2 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/TimeS eries_1"> <S y mbol>M S F T.O </S y mbol> <S tartTime>2008-04-28T00:00:00</S tartTime> <E ndTime>2008-04-29T00:00:00</E ndTime> <Inter val>H O UR</Inter val> </G etIntraday TimeS eries_Request_2> </Body > </E nv elope>

Attribute Symbol StartTime EndTime

Description A RIC of the instrument which intraday prices you want to retrieve. Start date and time criteria of the search. The format of the Start time should be: YYYY-MM-DDThh: mm:ss End date and time criteria of the search. The format of the Start time should be: YYYY-MM-DDThh:mm: ss Note: Please pay attention that maximum <EndDate> interval is >=2038. If you specify a greater <EndDate> interval, you will receive a blank response.

Interval

The interval between samples. The choices are: MINUTE 30MINUTES HOUR

Note: You might get ERR_NOSUCHRIC error on TimeSeries, even though the RIC exists because Thomson Reuters TimeSeries service gives the same error ("ERR_NOSUCHRIC") for RICs which it does not have history for and also for invalid RICs. So, if you are sure that your RIC exists, then it might be missing in the Thomson Reuters TimeSeries database. TRKD logs all requests for RICs which fail, and we periodically add RICs which are requested but not available. XML Sample Response - Hourly Intraday Data
<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader>

Time Series

739

<a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/ rkd/TimeS eries_1/G etIntraday TimeS eries_2_Reply </a:A ction> <a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etIntraday TimeS eries_Response_2 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/TimeS eries_1"> <Row > <O P E N >29.829999923706055</O P E N > <H IG H >29.829999923706055</H IG H > <LO W>29.829999923706055</LO W> <C LO S E >29.829999923706055</C LO S E > <V O LU M E >3400</V O LU M E > <TIM E S TA M P >2008-04-28T07:00:00-05:00</TIM E S TA M P > </Row > <Row > <O P E N >29.829999923706055</O P E N > <H IG H >29.829999923706055</H IG H > <LO W>29.829999923706055</LO W> <C LO S E >29.829999923706055</C LO S E > <V O LU M E >81942</V O LU M E > <TIM E S TA M P >2008-04-28T08:00:00-05:00</TIM E S TA M P > </Row > ... <Row > <O P E N >28.989999771118164</O P E N > <H IG H >28.989999771118164</H IG H > <LO W>28.989999771118164</LO W> <C LO S E >28.989999771118164</C LO S E > <V O LU M E >20808</V O LU M E > <TIM E S TA M P >2008-04-28T19:00:00-05:00</TIM E S TA M P > </Row > </s:Body > </s:E nv elope>

Note: The response for FI RICs return additional value in the response - 'CLOSEYIELD': XML Sample Response - Retrieving Hourly Intraday Data for 'PT30YT=XX' FI RIC
<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader> <a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/ rkd/TimeS eries_1/G etIntraday TimeS eries_2_Reply </a:A ction> <a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <G etIntraday TimeS eries_Response_2 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/TimeS eries_1"> <Row > <O P E N >"88.804"</O P E N > <H IG H >"88.83"</H IG H > <LO W>"88.76"</LO W> <C LO S E >"88.76"</C LO S E > < C LO SEY IELD>"4.854"</C LO S E YIE LD> <TIM E S TA M P >"2010-03-12T08:00:00+00:00"</TIM E S TA M P > </Row > <Row > <O P E N >"88.81"</O P E N > <H IG H >"89.1"</H IG H > <LO W>"88.8"</LO W> <C LO S E >"88.8"</C LO S E > < C LO SEY IELD>"4.851"</C LO S E YIE LD> <TIM E S TA M P >"2010-03-12T09:00:00+00:00"</TIM E S TA M P > </Row > ..... </G etIntraday TimeS eries_Response_2> </s:Body > </s:E nv elope>

740

TRKD API Developer's Guide

chapter 39

User Information Update

You can use the UserInfoUpdate service to retrieve and update user information from the user database. The following operations are available through the UserInfoUpdate service: Create User (Create_1) - creates new user. Modify User (Modify_1) - modifies existing information for a particular user. Get Accounts by Company ID (GetAccountsByCompanyId_1) - retrieves all the accounts for a particular company. Get User Information (GetUserInfo_1) - retrieves all available information about a particular user.

39.1

Authentication/Authorization, Service Endpoint, and Required Headers

Authorization All requests to the UserInfoUpdate service require an authorization token. For details, see section Understanding Authentication Tokens. Authentication Thomson Reuters UserInfoUpdate service uses Reuters impersonation tokens for each effective user. In this case, Thomson Reuters must create each user before your application authenticates them. Unmanaged effective users are not supported in Thomson Reuters UserInfoUpdate. For additional information on creating a Service Token, see section Creating a Token. Service Endpoint UserInfoUpdate Endpoint
http://api.rkd.reuters.com/api/2008/08/08/U serInfoU pdate_1.sv c

Required Header Required HTTP Headers

P O S T api/2008/08/08/U serInfoU pdate_1.sv c H TTP /1.1 C ontent-Ty pe: application/soap+xml H ost: api.rkd.reuters.com C ontent-Length: [length]

39.2

WSDL
WSDL:
http://api.rkd.reuters.com/schemas/w sdl/U serInfoU pdate_1_H ttpA ndRKDToken.w sdl

39.3

Create User (Create_1)

The Create_1 request creates a new user. Currently, there are two ways to refer to a user in the request/responses. Alias, which is also referred to as Login Name, or User Id, which is the unique Id in the Thomson Reuters system to identify a user. The following example creates a user with 'LoginName' "Fagus.Root@reuters.com" and specified password:

User Information Update

741

XML Sample Request - Creating User

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2008/08/08/U serInfoU pdate_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/ U serInfoU pdate_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <C reate_Request_1 xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/U serInfoU pdate_1"> <C ompany ID>30373</C ompany ID> <A ccountID>1934776</A ccountID> <LoginN ame>F agus.Root@reuters.com</LoginN ame> <LastN ame>Root</LastN ame> <F irstN ame>F agus</F irstN ame> <JobRoleID>121</JobRoleID> <E mailA dd>F agus.Root@reuters.com</E mailA dd> <address> <A ddressLine1>some address</A ddressLine1> <C ity >N ew York</C ity > <C ountry >U S A </C ountry > </address> </C reate_Request_1> </Body > </E nv elope>

Attribute CompanyID AccountID Enabled LoginName LastName FirstName JobRoleID JobTitle Division

Description Identifies the company. Identifies user account. The Account Id can be obtained, using the GetAccountsByCompanyId_1 request. See section Get Accounts by Company ID (GetAccountsByCompanyId_1) for more details. Enables or disables the user. Sometimes it is referred to as alias; this should be the user's email address. Shows user's last name. Shows user's first name. Identifies user's job role. See section User Job Roles for mapping. Shows user's job title. This field can be used to store the users division. Suggested uses would include the department or business division in which the user works; for example, Investment & Advisory division or Research & Asset Management. This field is meant to add a bit more insight into what the end user does. Shows user's email. It is used by the brokers for ROS entitlements. Can be used to add User Group ID, i.e. to bind a user to a certain group. Shows user's address. Contains the following fields: User Street Address 1 User Street Address 2 User City User State User Zip Code/Postal Code User Country Specifies user's password.

EmailAdd Group address

Password

The response returns the ID of the created user, which identifies the user in the Thomson Reuters system. Note: Remember the returned UserID as there is no facility to lookup a user and retrieve the id. XML Sample Response - Creating User

742

TRKD API Developer's Guide

<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/ rkd/U serInfoU pdate_1/C reate_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <C reate_Response_1 xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/U serInfoU pdate_1"> <U serID>12345<U serID/> </C reate_Response_1> </Body > </E nv elope>

Note: Once the user is created, it must be attached to a permission group. You can do this by using the SetPermGroupsMembership_1 request. See section Set Permissioning Groups Membership (SetPermGroupsMembership_1) for more details.

39.4

Get Accounts by Company ID (GetAccountsByCompanyId_1)

The GetAccountsByCompanyId_1 request retrieves all account IDs for a particular company. The following example retrieves all accounts for the company with Company Id '184'. XML Sample Request - Retrieving Accounts by Company ID
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2008/08/08/U serInfoU pdate_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/ U serInfoU pdate_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etA ccountsBy C ompany ID_Request_1 xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/U serInfoU pdate_1"> <C ompany ID>184</C ompany ID> </G etA ccountsBy C ompany ID_Request_1> </Body > </E nv elope>

The response returns the following information: XML Sample Response - Retrieving Accounts by Company ID
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/ rkd/U serInfoU pdate_1/G etA ccountsBy C ompany Id_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <G etA ccountsBy C ompany Id_Response_1 xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/U serInfoU pdate_1"> <A ccount> <A ccountID>1914782</A ccountID> <A ccountName>A P I Ids</A ccountN ame> </A ccount> <A ccount> <A ccountID>1932634</A ccountID> <A ccountN ame>Dev elopers</A ccountN ame> </A ccount> <A ccount>

User Information Update

743

<A ccountID>1915525</A ccountID> <A ccountN ame>O perations</A ccountN ame> </A ccount> <A ccount> <A ccountID>105</A ccountID> <A ccountN ame>Reuters E mploy ees</A ccountN ame> </A ccount> <A ccount> <A ccountID>873260</A ccountID> <A ccountN ame>Reuters M arket G uide E mploy ees</A ccountN ame> </A ccount> <A ccount> <A ccountID>1930582</A ccountID> <A ccountN ame>xC ancelled</A ccountN ame> </A ccount> </G etA ccountsBy C ompany Id_1> </Body > </E nv elope>

Attribute AccountID

Description Identifies a particular company account.

AccountName Shows name of the account.

39.5

Modify User (Modify_1)

The Modify_1 request modifies information for a particular user. It is possible to modify the following information: Login Name Last Name First Name Middle Name Name Prefix Name Suffix Job Role ID Job Title Division Mailing address You can also add/remove the following information: email address group(s) Note: See section Create User (Create_1) for more details on user information. The following example adds email address for the user with User ID '32018636'. XML Sample Request - Modifying User Information
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2006/05/01/U serInfoU pdate_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/ U serInfoU pdate_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <M odify _Request_1 xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/U serInfoU pdate_1"> <U serID>32018636</U serID> <C ompany ID>30818</C ompany ID>

744

TRKD API Developer's Guide

<E mailA dd>test.user@reuters.com</E mailA dd> </M odify _Request_1> </Body > </E nv elope>

The response returns the following information: XML Sample Response - Modifying User Information
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/ rkd/U serInfoU pdate_1/M odify _1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo> </H eader> <Body > <M odify _Response_1 xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/U serInfoU pdate_1"/> </Body > </E nv elope>

39.6

Get User Information (GetUserInfo_1)

The GetUserInfo_1 request retrieves all the information about a particular user. The following example retrieves all the information about the user with User ID 2130. XML Sample Request - Retrieving User Information
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://api.rkd.reuters.com/api/2008/08/08/U serInfoU pdate_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/ U serInfoU pdate_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <G etU serInfo_Request_1 xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/U serInfoU pdate_1"> < User ID>2130</U serID> < C ompanyID>184</C ompany ID> </G etU serInfo_Request_1> </Body > </E nv elope>

Attribute UserID CompanyID

Description Identifies the user. Identifies the company.

The response returns the following information: XML Sample Response - Retrieving User Information
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing" mustU nderstand="1">http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/ rkd/U serInfoU pdate_1/G etU serInfo_1_Reply </A ction> <RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</RelatesTo>

User Information Update

745

</H eader> <Body > <G etU serInfo_Response_1 xmlns="http://w w w .reuters.com/ns/2008/08/08/w ebserv ices/rkd/U serInfoU pdate_1"> <A ccountID>105</A ccountID> <E nabled>1</E nabled> <LoginN ame>ky </LoginN ame> <A lias>Kathy .P itel@Reuters.com</A lias> <LastN ame>P itel</LastN ame> <F irstN ame>Kathy </F irstN ame> <M iddleN ame /> <N ameP refix /> <N ameS uffix /> <G roup> <G roupID>18</G roupID> <G roupN ame>S S 5-LE G A L</G roupN ame> </G roup> <G roup> <G roupID>30</G roupID> <G roupN ame>IN TE RN A L/A RC H IV E (R)</G roupN ame> </G roup> <G roup> <G roupID>31</G roupID> <G roupN ame>P P V RE TA IL</G roupN ame> </G roup> </G etU serInfo_Response_1> </Body > </E nv elope>

Attribute AccountID Enabled LoginName LastName FirstName MiddleName NamePrefix NameSuffix Group

Description Shows ID of user account. Defines whether the account is enabled. Shows user's login name. Sometimes it is referred to as alias; this should be the user's email address. Shows user's last name. Shows user's first name. Shows user's middle name. Shows name prefix. Shows name suffix. Shows information about the group, which the user belongs to. GroupID - shows ID of the user group. GroupName - shows group name.

746

TRKD API Developer's Guide

chapter 40

Web Views

The TRKD API Web Views are designed to be used within clients' own internal portals by institutional users and externalfacing portals by non-professionals. A client can customize/personalize their appearance using CSS (cascading style sheets). The TRKD API Web Views include the following components: Quote Header o Providing a delayed or real-time quick snapshots of financial instruments including fundamentals and pricing data. Snap Quote o Providing real-time or delayed Snap Quote detail on a particular financial instrument or chain, enabling a user to view a set of related instruments on a specific stock, all constituents of an index, delivery months of futures, spot rates and more. QuoteList o Displays market data for multi-instrument and multi-field quote lists in a single request made by the user. News Headlines & Stories o Provides lists of News Headlines based on the search input - RIC, topic, code, company, etc. o Provides the News Story including live links to quotes and other News mentioned within the articles. Users also have the ability to print out the story in its entirety. Charts o Providing Intraday/Interday time series charting. Full customization of the charts is possible through pre-defined skins and parameters. Search o Making finding companies, stocks, indices, bonds or economic data quick and easy; picking between Organization and Country and/or Sector searches the view allows the user to search organizations and assets globally. Consensus Estimates o Consists of global consensus estimates for over 15,000 active and 10,000 inactive companies. It contains all estimate types/measures and periods available dependant on user subscription. Summary Financials & Ratios o Meets the demands of users who primarily intend to display or print information about publicly traded companies. The reports contain historical financial statements, estimated financials variables and a number of frequently used ratios. Significant Developments o Cutting out the noise - a news analysis and filtering service that identifies crucial, market-moving company news on a near real-time basis for a large universe of public companies. Online Reports o Delivering the latest ready-to-publish breaking news, with graphics and pictures organized by independent news category modules. Dedicated coverage of the topics that matter most to people, including environmental news, global markets and lifestyle news. Lipper o A suite of standalone Lipper views as well as Search & Fund Overview views providing developers the ability to create their own fund outlook and overview pages and/or display a pre-canned version of the Fund Overview with all the most relevant fund information.

40.1

Identifying the User

This chapter provides information on available authorization types and explains how to work with the TRKD API Web Views without cookies.

40.1.1 Authorizing Service Users

In order to use the TRKD Web Views the user needs to generate SessionID by passing the following URL in their browser to the authorization portal: HTTP Sample Request

Web Views

747

https://[v iew s_serv er]/v iew s/G etS erv iceS ession.ashx?appid=[appID]&su=[serv iceuser]&sp=[passw ord]

Parameter [appID]

Description An application identification string (appid) is a short descriptive string that uniquely identifies users application for tracking and entitlement purposes. Thomson Reuters assigns an appid during setup. Your application submits this appid with each API request. A single credential that you can use for all users of your application and across non user-specific views. The user credential provides the appropriate entitlements (rights) to data from various services. For example, a credential may be limited to estimates from particular regions. The password generated for the service user.

[views_server] The server where the TRKD Web Views service is installed, e.g.views.rkd.reuters.com.

[serviceuser]

[password]

Note: The governing security requirement does not allow plain text passwords passed over the wire. All session creation must be made over HTTPS.

40.1.2 Authorizing Effective Users

The most common scenario is an application that supports individual user credentials (authorization through effective users) to personalize each users experience. TRKD API supports two types of effective users, depending on the particular service you are using: Reuters - This type of effective user represents an identity created (through manual administration during setup of your application) and maintained in the Thomson Reuters user data store. Reuters type is the default effective user type. Unmanaged - This type of effective user represents an identity with no entry in the Thomson Reuters user data store. Your application is responsible for maintaining this user identity. Effective user must specify the following URL to generate a sessionID: HTTP Sample Request
https://[v iew s_serv er]/v iew s/G etS erv iceS ession.ashx?appid=[appID]&su=[effectiv euser]&sp=[passw ord]

Note: The governing security requirement does not allow plain text passwords passed over the wire. All session creation must be made over HTTPS. After users submit the URL in the browser: HTTP Sample Request
https://v iew s.rkd.reuters.com/v iew s/getserv icesession.ashx?appid=[appID]&su=username@company .com&sp=userP assw ord

They get the following XML response: XML Sample Response

<RkdS ession> <S essionID>c3fe91c7-e955-4a00-a408-4228d13d3fbe</S essionID> <E xpiration>2010-08-05T20:42:59Z</E xpiration> </RkdS ession>

Note: Tokens expire in 8 hours after generation moment. So, if it is generated at 10:14am EST you should see Expiration: 2010-07-01T23:14:05Z. Expiration time is shown in UTC (GMT+0). EST is a UTC-5. So 10 am -(-5) + 8 = 23 = 11pm. Your portals must IFRAME links to TRKD frames without encoding session ID in query string, e.g.:

748

TRKD API Developer's Guide

HTTP Sample Request

https://v iew s.rkd.reuters.com/v iew s/[appID]/N ew s/S tory .aspx?[p1n]=[p1v ]

When no session is present for an end user, the portal establishes the session with TRKD API and redirects end user back to the view with the session ID encoded in the URL query string: HTTP Sample Request
http://v iew s.rkd.reuters.com/v iew s/[appID]/N ew s/N ew sS tory .aspx?sid=[session id]&[p1n]=[p1v ]

After TRKD API validates a sessionID passed on query string, it redirects the user back to the original Web View URL, but this time the user will be passing a cookie: HTTP Sample Request
http://v iew s.rkd.reuters.com/v iew s/[appID]/N ew s/N ew sS tory .aspx?[p1n]=[p1v ]

After users get their SessionID, they can use the TRKD Web Views by passing the URL to the required view and adding "&sessionid=" and their SessionID (in bold) at the end of the URL, e.g.: HTTP Sample Request
http://v iew s.rkd.reuters.com/v iew s/[appID]/search/default.aspx?maxrec=1000&query =IBM & sessionid=c3 fe9 1 c7 -e9 5 5 -4 a0 0 -a4 0 8 4 2 2 8 d1 3 d3 fbe

After the browser saves the cookie (if it is configured to do so), the user can pass URL to any View without having to pass SessionID. The above URL is a search request to retrieve items where IBM is mentioned and is limited to 1000 results only. Note: Request Builder gets SessionID for users automatically.

40.1.3 Working without Cookies

If you prefer, you can work with the TRKD Web Views without cookies. In that case you will need to specify SessionID to each TRKD Web View URL. To do so, you need to add &usecookie=false at the end of the URL, e.g.: HTTP Sample Request
http://v iew s.rkd.reuters.com/v iew s/[appID]/search/default.aspx?maxrec=1000&query =IBM &sessionid=c3fe91c7-e955-4a00-a4084228d13d3fbe&usecookie=false

40.2

Preference Configuration
The TRKD API Web Views allow implementers and client administrators to define a number of 'cultural' parameters to be consistent for a given set of users. These preferences are outlined below and include preferences such as Language, CSS Version, Time Zone, Date format, Number format, and more. The implementer can also set up multiple different preference sets to use under a single service user ID to allow different groups of users to see data within the views tailored to their cultural preferences (Language, CSS Version, Time Zone, Date format, Number format, etc). Each Preference Set includes the possibility to set the following options: Parameter Description

Web Views

749

LANG

Language in which the Views will be shown. It must be specified in language-culture format e.g. en-US, etc. Available values are: English (en-US); French (fr-FR); Italian (it-IT); Spanish (es-ES); Chinese (Simplified and Traditional - zh-Hans and zh-Hant); Japanese (Kanji ja-JP) CSS_VERSION The version of the CSS file to be used for displaying Views. CSS styles can be defined by clients, but only TRKD Administrators can upload CSS files and activate them against user accounts. Contact the Online Solutions Team at Thomson Reuters to upload your files. BASECSS_VERSI Version of Base CSS file to be used for displaying Views. A Base_CSS is a style that is generated by ON Thomson Reuters. If the client needs to use the latest version it is necessary to omit this parameter or specify zero (0). TIMEZONE The time zone used for displaying financial data. The TRKD API Web Views supports all standard time zones e.g., for GMT the preference would read - 'GMT Standard Time'. See Standard Time Zones section for the list of standard time zones which can be used. DATEFORMAT The date format used for displaying financial data. Available values are: [0-31] [MONTH] [YYYY] MM/DD/YYYY DD/MM/YY MM/DD/YY TIMEFORMAT The time format used for displaying financial data. E.g.: hh:mm:ss, etc. NUMFORMAT The number format used for displaying financial data. E.g.: 12,345.99. USECOOKIE Enables/disables use of cookies. Note: TIMEZONE, DATEFORMAT, NUMFORMAT depend on the selected language-Culture parameter.

40.3

Client File Management Configuration

Users may determine that there is a necessity to customize the style sheet bundle which the TRKD API Web Views use so that the TRKD API Web Views will visually 'fit' into proprietary portals and web sites. If clients want to display the TRKD API Web Views as they are, then there is no need to modify any style sheets. In the case where client wants to make changes to the TRKD API Web Views visual signatures to align the views with their corporate signatures they will be provided with the CSS Tool Kit comprising of the following files where necessary: Base.css along with all other CSS files which control the Web Views Branding.css - by default this will be empty Html pages for each Web View Java script files Image files The client is responsible for modifying branding.css style sheet to adhere with the clients' visual signatures. Clients should only make changes to the branding.css delivered in the CSS Tool Kit bundle; any changes made to the Base.css file will be overwritten by the system. Clients should use the HTML pages delivered in the original bundle to test on-site whether their changes to the branding.css are correct prior to sending the upload bundle back to Thomson Reuters for upload. Client delivery of upload bundle should include only: Branding.css Html pages for each Web View Images Uploading Resources Pages in the Support Portal Only TRKD API Administrators can upload css files for a client. Contact the Online Solutions team at Thomson Reuters to upload your files.

750

TRKD API Developer's Guide

Once the agreement has been reached with the client and the TRKD Administrator verified the modified Style sheet is correct then the Administrator will 'activate' the CSS Version for production and change the preferences for the client ID(s) to use the correct CSS version. After TRKD API Administrator activates your custom style sheet version, the application will apply that style to all Web Views that you call under the specified Service User ID and preference set.

40.4

Library of TRKD API Web Views

The list of available TRKD API Web Views depends on users subscription and permissions. TRKD API provides access to the following Web Views: Web View Name Header Banner Disclaimer Disclaimer (JP) News News Story Quotes QuotesList Charts Search Significant Developments Fundamentals Estimates Online Reports Lipper* URL Example /views/[appID]/index/headerbanner.aspx?ric=[RIC] /views/[appID]/index/disclaimer.aspx /views/[appID]/index/disclaimer.aspx?lang=ja-JP /views/[appID]/news/headlines.aspx?code=[RIC] /views/[appID]/news/story.aspx?storyid=[storyID] /views/[appID]/quotes/default.aspx?ric=[RIC] /views/[appID]/quotelist/default.aspx?rics=[RICs] /views/[appID]/charts/default.aspx?rics=[RICs] /views/[appID]/search/default.aspx?query=[param1]&[param2]&etc /views/[appID]/index/sigdev/default.aspx?rics=[RIC] /views/[appID]/index/fundamentals/income.aspx?ric=[RIC] /views/[appID]/index/estimates/default.aspx?company=[RIC] /views/[appID]/onlinereports/headlines.aspx?olr_topic=[topic_name] /views/[appID]/lipper/overview.aspx?lipperid=[Lipper_ID]

The parameters shown below are just examples and each Web View and the full list of parameters to use with it can be found further in this document in the corresponding sections. Note: * - For details on all available Lipper Web Views please see the corresponding section. Developers can structure a URL call to a specific Web View by using the parameters defined in this document. The following abstract URL describes how to do that: HTTP Sample Request
http://[v iew s_serv er]/v iew s/[appID]/[v iew _name]/[v iew _page].aspx[?param1=v alue1][&param2=v alue2][&paramN =v alueN ] [&sessionid=sessionid_v alue]

The table provided below lists base parameters which can be used by each view (where appropriate): Parameter DISCLAIMER SESSIONID PREFSET LANG Description Defines whether to display header banner with the View (True/False). Defines SessionID parameter. Specifies the preference set to be used for the user. Specifies the language for the meta data in the View. Languages available as of January 2011: Japanese (LANG=ja-JP) and Simplified Chinese (LANG=zhCHS). CSS_VERSION Sets the CSS version to be used. BASECSS_VERSIO Sets the Base CSS version to be used. N

Web Views

751

TIMEZONE DATEFORMAT TIMEFORMAT NUMFORMAT BASECURRENCY

Specifies the time zone the user wants to display data in, if it differs from the one specified in the Preference Set. See time zone codes provided in the Standard Time Zones section. Defines the date format the user wants to display data in, if it differs from the one specified in the Preference Set. Defines the time format the user wants to display data in, if it differs from the one specified in the Preference Set. Defines the number format the user wants to display data in, if it differs from the one specified in the Preference Set. Defines the currency to be used for displaying pricing information. By default the pricing information is displayed in native currency. If the basecurrency is sent in the call, the values in the views are all aligned to the specified currency. Note: This does not apply to Forex, Money Markets or Indices asset class instruments. Defines whether to use cookies for authentication (True/False). Defines whether to include the print icon in the Web View (True/False). Note: Only applicable in News Story Web Views. Displays the relevant Thomson Reuters logo to the web view. The logos should be used in conjunction with the Thomson Reuters Branding Guidelines available on Thomson Reuters Customer Zone (Default is TRUE).

USECOOKIE PRINT

TRLOGO

Note: All parameters which are sent along with the Web View URL call to the TRKD Servers will override all preferences which are set for the user in that session instance. Any pages which contain Thomson Reuters content in a Client applications should have at least one instance of the Thomson Reuters / REUTERS brand logos (<TRLOGO>) and Thin Disclaimer (<DISCLAIMER>) displayed in a prominent location, where visible, any time one or more of our views are located in the web page. IN ADDITION TO THE ABOVE, THE FOLLOWING BRANDING IS REQUIRED FOR THE SPECIFIC CIRCUMSTANCES SET OUT BELOW: A. PAGES THAT CONTAIN REUTERS-ONLY HEADLINES The Reuters logo for Thomson Reuters media services must be displayed in a prominent position on the page, and in such a way that the logo is immediately visible when retrieving the headlines. B. PAGES THAT CONTAIN REUTERS AND THIRD PARTY HEADLINES Unless otherwise agreed with Reuters, each Reuters headline or group of Reuters headlines displayed must be attributed to Reuters e.g. finish with "(REUTERS)". C. PAGES THAT CONTAIN REUTERS NEWS STORIES The Reuters logo must be displayed on the page in a prominent position, close to the top, and in such a way that the logo is immediately visible when retrieving the news stories. "(REUTERS)" must appear in the slug line (top line) of the news item. D. REUTERS HEADLINES ON 3RD PARTY SITES (WHERE PERMITTED BY AGREEMENT) Each Reuters headline or group of Reuters headlines displayed must be attributed to Reuters e.g. finish with "(REUTERS)". E. PAGES THAT CONTAIN SOLELY THOMSON REUTERS FINANCIAL DATA The Thomson Reuters logo must be displayed on the page in a prominent position and in such a way that the logo is immediately visible when retrieving the data. F. PAGES THAT CONTAIN BOTH THOMSON REUTERS FINANCIAL DATA AND THIRD PARTY FINANCIAL DATA Each page containing Thomson Reuters data together with third party data must contain a notice "Selected data supplied by Thomson Reuters" in close proximity to the Thomson Reuters Content.

752

TRKD API Developer's Guide

40.4.1 Index Web View

The Index Web View displays the list (library) of Web Views that are available for the authorized user with sample URL calls for each view. The image below is an example with several Web Views that Index Web View can contain:

To get to the Index page a developer should: 1. Generate SessionID by making the following URL call: HTTP Sample Request
https://v iew s.rkd.reuters.com/v iew s/G etS erv iceS ession.ashx?appid=XXXXXXX&su=YYYYYYYYY&sp=ZZZZZZ

Note: Tokens expire in 8 hours after generation moment. So, if it is generated at 10:14am EST you should see Expiration: 2010-07-01T23:14:05Z. Expiration time is shown in UTC (GMT+0). EST is a UTC-5. So 10 am -(-5) + 8 = 23 = 11pm. 2. Use the retrieved SessionID and pass the following URL to the browser: HTTP Sample Request
http://v iew s.rkd.reuters.com/v iew s/[appID]/index/default.aspx?sessionid=xxxxxxxxxxxxxxxxxxxxxxxxxx

40.4.2 Header Banner Web View

The Header banner view allows users to retrieve a quick view of the RIC with some quote and fundamentals information. The following table specifies available input parameters for header banner view: Parameter RIC Description Reuters Instrument Code for the security to retrieve: RIC (including Chain RICs).

To display Header banner, the developer should specify the following at the end of URL:
/v iew s/[appID]/index/headerbanner.aspx?ric=[RIC ]

where [RIC] - Reuters Instrument Code

Web Views

753

Samples: 1. RIC search for Google: HTTP Sample Request - RIC Search for Google
http://v iew s.rkd.reuters.com/v iew s/[appID]/index/headerbanner.aspx?ric=G O O G .O

The developer will get the following Web View as a result:

2. RIC search for IBM: HTTP Sample Request - RIC Search for IBM
http://v iew s.rkd.reuters.com/v iew s/[appID]/index/headerbanner.aspx?ric=IBM .N

The application will display the following as a result:

3. RIC Search for Dow Jones Chain (returns no data) HTTP Sample Request - RIC Search for Dow Jones Chain
http://v iew s.rkd.reuters.com/v iew s/[appID]/index/headerbanner.aspx?ric= 0% 23.DJI

The application will display the following as a result:

Note: If RIC is not found/supported/classed as company RIC you will get the following message:

40.4.3 Thin Disclaimer Web View

To ensure attribution is given to Thomson Reuters for the data included in the Web Views, as per the client agreement for the data, clients may be required to show a disclaimer on their web site. By default the parameter DISCLAIMER is set to "DISCLAIMER=TRUE".

754

TRKD API Developer's Guide

As per the client agreement for the data, this disclaimer should be rendered in the view at all times if the exchange permissions which the user has calls for Thomson Reuters Attribution. Disclaimer should be placed at the bottom/middle of the views. To display thin Disclaimer in a view (Center/Bottom alignment), the developer should specify the following at the end of URL:
/v iew s/[appID]/index/thindisclaimer.aspx

HTTP Sample Request

http://v iew s.rkd.reuters.com/v iew s/[appID]/index/thindisclaimer.aspx

The developer will get the following Web View as a result:

40.4.4 Disclaimer Web View

To ensure attribution is given to Thomson Reuters for the data included in the views, clients are required in certain circumstances (which will be explained at agreement time) to show a disclaimer on their web site. The Thin disclaimer, as explained in the preceding section, should be displayed inside the view where appropriate. The full disclaimer should be displayed to the user if the hyperlink is clicked upon by the user. To display full Disclaimer, the developer should specify the following at the end of URL:
/v iew s/[appID]/index/disclaimer.aspx

HTTP Sample Request

http://v iew s.rkd.reuters.com/v iew s/[appID]/index/disclaimer.aspx

The developer gets the following in the response:

Note: To display full Disclaimer in Japanese, the developer should specify the following at the end of URL:
/v iew s/[appID]/index/disclaimer.aspx?lang=ja-JP

Web Views

755

40.4.5 Quotes Web View

The Quote Web View allows you to retrieve snap quote or quote chain information. TRKD API delivers snap prices only. Streaming pricing data is not delivered in the TRKD API Web Views. By default, TRKD API provides delayed stock prices. However, if your organization has an agreement within an exchange to provide its prices in real-time, then real-time snap prices can be delivered by TRKD API for that exchange. An instrument is identified by a RIC (Reuters Instrument Code). Each RIC has a series of explicit fields that contain different items of information (for example, today's high price, traded volume, etc.). Not all instruments contain the same fields, and the fields are not always returned in the same order. This depends on the type of financial instrument and its asset class (for example, stock, index, FX rate, fund, etc.). Full details of the asset classes and the fields (FIDs) that are displayed for each Web View are provided in the "TRKD API Web Views: AssetClass field mappings for Snap Quote View" document located here: https://customers.reuters.com/a/support/paz/pazDocs.aspx?dId=436066. The table below specifies available input parameters for quote input: Parameter Description RIC OLUMN3 Reuters Instrument Code for the security to retrieve (including Chain RICs). (Optional) Defines whether to display the retrieved quotes data in three columns. By default, the data is split into two columns.

CHART_LINK (Optional) Defines whether to display the link to the chart for the specified RIC, if available. NEWS_LINK (Optional) Defines whether to display the link to the news headlines for the specified RIC, if available. To make request for the quote data, the developer should specify the following at the end of URL:
/v iew s/[appID]/quotes/default.aspx?ric=[RIC ][&column3=true/false][&chart_link=true/false][&new s_link=true/false][&sessionid=sessionid_v alue]

HTTP Sample Request

http://v iew s.rkd.reuters.com/v iew s/[appID]/quotes/default.aspx?ric=IBM .N &column3=true&TRLO G O =true

You will get the following Web View as a result:

To search for MSFT quotes and display them in two-column format and exclude link to news data, you must construct the URL in the following way: HTTP Sample Request - Searching for Microsoft Quotes

756

TRKD API Developer's Guide

http://v iew s.rkd.reuters.com/v iew s/[appID]/quotes/default.aspx?ric=M S F T.O &new s_link=false&TRLO G O =true

As a result, you will get the following:

40.4.6 Quote Chain Web View

A quote chain provides summary price information for a series of related instruments, such as all the constituents of the FTSE 100 Index, or the highest net gainers of the day on NASDAQ. Most quote chain RICs begin with "0#". The number of instruments in a chain, the order of instruments and the position of any particular instrument, are not always constant and cannot be relied upon. They are often modified to reflect changing market conditions and may also differ between markets. The picture below gives an example of chain RICs retrieved:

Web Views

757

Note: In the Chain Quote views the RICs included in the chain are grouped into the same asset class. Specific FIDs are displayed for each asset class - this gives the user a better view of the chain RICs. If you want to search for FX Quote Chain then you must submit the following request: HTTP Sample Request - Searching for FX Quote Chain
http://v iew s.rkd.reuters.com/v iew s/[appID]/quotes/default.aspx?ric=F X% 3dX&TRLO G O =true

As a result, you will get something like this:

758

TRKD API Developer's Guide

40.4.7 QuoteList Web View

The QuoteList Web View lets you retrieve prices on multi-instrument and multi-field quote lists in a single request. User can send a list of the instruments (RICs) and the fields (FIDs) to the Web Views server, and the latest available information for the instruments are returned in the corresponding format. A QuoteList may contain any of the following types of instrument: exchange-traded stocks (for example: RIC VOD.L) indices (for example: RIC .DJI) exchange warrants (for example: RIC CH1031161.S) exchange bonds (for example: RIC CH1037959=S) bonds (for example: RIC US30YT=RR) exchange funds (for example: RIC SWBZ.S) foreign exchange (for example: RIC CHF=X) Note: If set, then the BASECURRENCY parameter is applied across all asset classes apart from Forex, Money Market or Indices Instruments asset classes. The table below specifies available input parameters for the QuoteList input: Parameter RICS Description List of Reuters Instrument Codes to retrieve (including Chain RICs). Note: Use vertical line (|) to specify several RICs (e.g. RR.L|IBM.N). To override RIC display name(s) user should pass additional information in RIC field. E.g.: ?RICS=IBM.N, International Business Machines (Optional) Defines whether to display the retrieved quotes data in three columns. By default, the data is displayed in a two column table. The default fields displayed when no others are sent in the call are: CLOSE (FID=CF_CLOSE) BID (FID=CF_BID) ASK (FID=CF_ASK) LAST (FID=CF_LAST) NETCHNG (FID=CF_NETCHNG) PCTCHNG (FID=CF_PCTCHNG) VOLUME (FID=CF_VOLUME)

FIELDS

Web Views

759

CURRENCY (FID=CF_CURRENCY) TRADE_DATE (FID=CF_TRADE_DATE) TRDRIM_1 (FID=CF_TRDTIM_1) TITLE (Optional) Displays the specified title of the QuoteList. ALLNEWS_LIN (Optional) Defines whether to display the link to All news stories for all RICS entered into the call string. K ERROR (Optional) TRUE / FALSE. If set to FALSE - the application will display only available/identifiable RICs in the rendered view. If set to TRUE - the application will display available/identifiable RICs and notify the user about invalid RICs at the bottom of the rendered view.

To make request for the QuoteList Web View, the implementer should specify the following at the end of URL:
/v iew s/[appID]/quotelist/default.aspx?rics=[RIC ][?fields=field1|field2|fieldN ][&title=v alue][&allnew s_link=link][&error=v alue] [&sessionid=sessionid_v alue]

HTTP Sample Request

http://v iew s.rkd.reuters.com/v iew s/[appID]/quotelist/default.aspx?rics=IBM .N &sessionid=2ae56598-0455-4d06-8c67269b4ff1c8a5&usecookie=false

The user will get a QuoteList Web View similar to this:

To request Quote list for IBM and GOOG with a name change for IBM and default fields display, you must construct the following URL: HTTP Sample Request - Quote List for IBM and Google
http://v iew s.rkd.reuters.com/v iew s/[appID]/quotelist/default.aspx?rics=IBM .N % 2cInternational+Business+M achines% 7cG O O G .O &title=IBM % 26G oogle

This will return the following Web View:

To request Quote list for 3M, GE, IEP and Textron with specified Fields to display, you must construct the following URL: HTTP Sample Request - Quote List for 3M, GE, IEP and Textron
http://v iew s.rkd.reuters.com/v iew s/[appID]/quotelist/default.aspx?rics=M M M .N % 7cG E .N % 7cIE P .N % 7cTXT.N &fields=H S T_C LO S E %

760

TRKD API Developer's Guide

7cN E TC H N G _1% 7cH IG H _1% 7cLO W_1&title=Library +Test

This will return the following Web View:

The list of available Fields (FIDs) for the QuoteList can be found in the TRKD Data Guide on the Customer Zone at the following link: https://customers.reuters.com/a/support/paz/pazDocs.aspx?dId=379957 Consolidated Fields Some RICs can have the same data in different fields as well as across multiple exchanges. For example, bid price for some RICs can be specified as BID_1, BID or BID_2. To consolidate the data TRKD team has created Consolidated fields (CF_). A CF_ field will serve as a universal field for all types of RICs. For example, for bid price it will be CF_BID. You can find the supported CF_ FIDs in the TRKD API Data Guide.

40.4.8 News Web View

The News Web Views set allows the user to retrieve a list of news headlines and an individual news story. The table provided below lists all available parameters which can be used for calling the News Headlines Web View: Parameter PAGESIZE FROMDATE TODATE LANGUAGE FREETEXT HEADLINE CODE Description (Optional) The number of news headlines to display per page. Pagination will be applied to the view where the number of headlines exceeds the PAGESIZE value, up to a maximum of 100 headlines. (Optional) The Date of the first headline to be retrieved in UTC (GMT+0) format. (Optional) The Date of the last headline to be retrieved in UTC (GMT+0) format. (Optional) Specified to return news in specific language. The list of LANGUAGE codes can be found in the 'News' tab within the TRKD Data Guide. Allows user to specify in a string key words to be searched for in the body of the story text. Allows user to enter in a string of key words to be searched for in the headline text. Search filters on RIC, Attribution, Company name, NamedItem and Topics all in single CODE field. Note 1: If CODE is not specified a request is sent to the backend without applying any filters, so backend returns records instead of error. Note 2: Country codes, Regions, Industrial Sectors, Sports, General & Cross Market finance codes can be found in the TRKD Data Guide and are classed as Topics. (Optional) Specifies to return news for specific company(s). Only RICs can be used as company identifiers. (Optional) Specifies to return news for specific topics by code. (Optional) Specifies to return news written by specific source(s). (Optional) Specifies to return news for specified news provider. Values="or,and". Logical operation between different parameters (i.e. if user has specified CODE and FREETEXT). By default, user requests only one value, i.e. CODE=IBM. This parameter allows to use more complex logic like: CODE=IBM&FREETEXT=USA&OP=AND (search IBM news where news text

COMPANIES TOPICS ATTRIBUTIONS PROVIDERS OP

Web Views

761

contains USA). Topic codes can be found by calling the 'Get News Topics' TRKD API method in the Thomson Reuters News service. CODEOP Values="or,and". User can enter several values in CODE parameter, i.e. CODE=IBM|Microsoft. Parameter indicates whether to search for IBM and Microsoft or IBM or Microsoft. LANGUAGEOP Values="or,and". The same as the previous parameter but for language. HEADLINEOP Values="or,and". The same as the previous parameter but for headline. FREETEXTOP Values="or,and". The same as the previous parameter but for free text. COMPANIESOP Values="or,and". The same as the previous parameter but for company. TOPICSOP Values="or,and". The same as the previous parameter but for topic. ATTRIBUTIONSOP Values="or,and". The same as the previous parameter but for attribution. PROVIDERSOP Values="or,and". The same as the previous parameter but for provider. MAXHEADLINES (Optional) The maximum number of headlines to be retrieved by the view (default is 25; max is 100).

To display news headlines, the developer can construct the following URL by using the table above:
http:[v iew s_serv er]/v iew s/[appID]/new s/headlines.aspx?companies= [ RIC ] & pagesize=1 0 & fr omdate=0 2 1 0 2 0 1 0 & todate=0 2 1 2 2 0 1 0 & language=enUS& fr eetext=USA & headline=some_headline& code=A ND& codeop=value& languageop=value& headline=value& fr eetextop =value& maxheadlines=4 0

The following URL requests news headlines for GOOG.O (Google) RIC with 10 headlines to be displayed per page and maximum 40 headlines: HTTP Sample Request - News Headlines for Google
http://v iew s.rkd.reuters.com/v iew s/[appID]/new s/headlines.aspx?code=G O O G .O &pagesize=10&maxheadlines=40

The developer gets the list of news headlines that meet the specified criteria:

762

TRKD API Developer's Guide

To search for news headlines in English language with a headline containing Private Payrolls from Reuters news you need to submit the following request: HTTP Sample Request - Headlines Containing Private Payrolls
http://v iew s.rkd.reuters.com/v iew s/[appID]/new s/headlines.aspx?headline=priv ate+pay rolls

To search for news headline for MKW, in English with corporation in the story, Gold in the headline and only headlines (maximum 50 displayed) from 07/01/2010 - 07/02/2010, you need to make the following request: HTTP Sample Request - Headlines for MKW
http://v iew s.rkd.reuters.com/v iew s/[appID]/new s/headlines.aspx? code=M KW&pagesize=5&maxheadlines=15&headline=gold&freetext=corporation&fromdate=2010-07-01T00% 3a00% 3a00&todate=2010-0702T23% 3a59% 3a59

To search for news headlines with Mergers and Acquisitions, you must submit the following request: HTTP Sample Request - Mergers and Acquisitions Headlines
http://v iew s.rkd.reuters.com/v iew s/[appID]/new s/headlines.aspx?code=M RG

Web Views

763

40.4.9 News Story Web View

The News Story Web View retrieves a single news item based on a unique story ID. The data is returned in the Thomson Reuters proprietary StoryML format (contains more detailed information). The table provided below lists all available parameters which can be used for calling the News Story Web View: Parameter Description STORYID PRINT The StoryID is a NewsML URN, which is specified in the following format: urn:newsml:[provider id]:[date]:[doc id], e.g., "urn:newsml:reuters.com:20001106:nJIJ6SS016". (Optional) Defines whether to include the Print link on the displayed page.

To display a news story, the user should can click a headline from the response or construct the following URL if they know the StoryID parameter:
/v iew s/[appID]/new s/story .aspx?story id=[story ID]

HTTP Sample Request

http://v iew s.rkd.reuters.com/v iew s/[appID]/new s/story .aspx?story id=urn% 3anew sml% 3areuters.com% 3a20110114% 3anS G E 70D03H % 3a2

The user gets the following News Story Web View as a response:

40.4.10 Charts Web View

The TRKD API Charts Web View is used to view a wide range of technical charts displays generated live by the Thomson Reuters Data Center analytics engine. Charting is available on an Intraday and Interday basis: INTERDAY lets you retrieve historical time series prices on an instrument, summarized in daily, weekly or monthly

764

TRKD API Developer's Guide

periods. INTRADAY lets you retrieve a time series of Intraday market prices on an instrument, summarized in periods from 1 minute to 1 hour (configurable). The supported time intervals (periods) for Intraday charts are: 1, 5, 15, 30, 60 minutes. This Web View provides many customizable features giving you the control of how the data will be displayed within the view. The user can customize the chart by selecting a specific pre-configured SKIN or changing skin parameters in the URL: A skin is a set of chart attributes stored together and associated with an index number. When requesting a chart, clients can simply choose a skin and the generated chart will have the width, height, colors, style, etc specified by the skin. Parameters are provided in the URL that requests the chart and can be used to override skin settings and also to customize chart contents. The table provided below lists all the parameters available in the chart view: Paramet er RICS StartDate EndDate PERIOD WIDTH HEIGHT DISPLAYLI NKS ALLDAY FONT SKIN GRID GRIDWIDT H GRIDCOLO R GRIDSTYLE VOL VOLCOLOR VOLSIZE VOLLINESI ZE STYLE Description The Reuters Instrument Code(s) for the securities which should be charted. Start date for timeseries to be retrieved. Defaults to 1 year ago. End date for timeseries to be retrieved. Defaults to current date. Granularity of data to display (minute, 30 mins, hourly, daily, weekly, monthly). Defaults to daily. (Optional) The width of the image in pixels. Defaults to 200px. (Optional) The height of the image in pixels. Defaults to 100px. Defines whether to display links to charts with other periodicity (1 day, 1 week, 1 month, 6 months, 1 year, 5 years) for the same instrument. (Optional) Defines whether to show all values for the day (YES) or only those within the exchange hours (NO). (Optional) Specifies a font to use. Zero is built-in raster, others are TrueType. (Optional) SKIN index. Chooses one of the pre-configured skins. Default is SKIN=0. (Optional) Defines whether or not to overlay chart with a grid. (Optional) Defines the width of grid. (Optional) The color of the grid lines, in red-green-blue 6-digit hexadecimal. (Optional) Defines grid style. Possible values="solid,dash,dashdot,dashdotdot,dot". (Optional) Defines whether or not to show a volume chart at the bottom. (Optional) Defines the color of volume chart. (Optional) Defines size of volume subchart. (Optional) Defines line size of volume subchart.

(Optional) Defines the style of the chart, either (line), (candles) or (Open/high/low/close). Possible values are:abscng,bband,cci,candle,chkmf,ema,envlp,hl,hlc,ipp,invrs,line,macd,macdf,mdnp,mom,obv,obvw,ohlc,osc, pctcng,pctr,roc,rsi,sma,stochf,stochs,vltycc,vol,wclose,wma". Default value is "line". LINECOLO (Optional) Defines color chart line for styles LINE and OHLC. R LINESIZE (Optional) Integer [1-5]. Defines width in pixels of chart line. LABELFOR (Optional) Defines how much data the label contains, full data, (e.g. Daily Microsoft Bid (23.43)) or short form MAT (MSFT.O Bid (24.32)). TEXTCOLO (Optional) Defines color of labels and axis values, in red-green-blue 6-digit hexadecimal. R VALUECOL (Optional) Defines color of axis values, in red-green-blue 6-digit hexadecimal. OR GRADIENT (Optional) Defines gradient for background image. BORDERC (Optional) Defines color of outer frame, in red-green-blue 6-digit hexadecimal. OLOR BORDERW (Optional) Defines width of border. IDTH

Web Views

765

BORDERST YLE SHOWRAN GE LEGEND LEGENDST YLE FILLCOLO R BGSTARTC OLOR BGENDCOL OR FRAME FRAMECOL OR FRAMEWI DTH FRAMESTY LE BGSTYLE

(Optional) Defines border style. Possible values="solid,dash,dashdot,dashdotdot,dot". (Optional) (Optional) Display chart legend. (Optional) Possible values="long,minimum,short". (Optional) Defines color of inner chart area (background), in red-green-blue 6-digit hexadecimal. (Optional) Defines background start color for the gradient. (Optional) Defines background end color for the gradient. Defines whether to display the values and volumes frames (and borders). (Optional) Defines color of value and volume borders, in red-green-blue 6-digit hexadecimal. (Optional) Defines width of frame. (Optional) Defines frame style. Possible values="solid, dashed, dotted, ridge, double, inset, outset, groove".

(Optional) Defines background style. Possible values="horizontal, vertical, forwarddiagonal, backwarddiagonal, largegrid, diagonalcross, percent05, percent10, percent20, percent25, percent30,percent40, percent50, percent60, percent70, percent75, percent80, percent90, lightdownwarddiagonal, lightupwarddiagonal, darkdownwarddiagonal, darkupwarddiagonal, widedownwarddiagonal, wideupwarddiagonal, lightvertical, lighthorizontal, narrowvertical, narrowhorizontal, darkvertical, darkhorizontal, dasheddownwarddiagonal, dashedupwarddiagonal, dashedhorizontal, dashedvertical, smallconfetti, largeconfetti, zigzag,wave, diagonalbrick, horizontalbrick, weave, plaid, divot, dottedgrid, dotteddiamond, shingle, trellis, sphere, smallgrid, smallcheckerboard, largecheckerboard, soliddiamond". GRADIENT (Optional) Defines gradient style. Possible values ="horizontal,vertical,forwarddiagonal,backwarddiagonal, STYLE horizontalcycle,verticalcycle,forwarddiagonalcycle,backwarddiagonalcycle". IMGTYPE (Optional) Defines image type. Possible values="png,bmp,jpeg,gif,emf". TITLE (Optional) Displays the custom title of a chart. TITLES (Optional) Specifies title(s) for Y axis. Possible values="none,type,currency,unit,displayunit,all". LEGENDPO (Optional) Defines legend position. S SHOWTITL (Optional) Shows the title of the chart. E SHOWXAXI (Optional) Displays x axis on the chart. S SHOWYAXI (Optional) Displays y axis on the chart. S Note: When user loads Chart Web View with parameters 'period' or 'startdate' the chart is displayed using the specified parameter. If after this user clicks a link of the pre-canned time-series, the values of 'period' or 'startdate' parameters will be overwritten and user will not be informed about. To make request for the quote data, the developer should specify the following at the end of URL:
/v iew s/[appID]/charts/default.aspx?rics=[RIC ]

HTTP Sample Request - Chart for IBM and Google (Default Skin)
http://v iew s.rkd.reuters.com/v iew s/[appID]/charts/default.aspx?rics=IBM .N |G O O G .O

By default, SKIN=0 is set, so the developer will get the following chart image as a result:

766

TRKD API Developer's Guide

The user can customize the chart in two ways: 1. By providing the SKIN parameter in the string this displays a 'pre-canned' chart provided by Thomson Reuters. To use the default skin, you might omit SKIN=0 parameter in the string. There are 19 different skins with the pre-set values (from [0] to [19]). 2. By providing the parameters listed in the above table in the string this allows the user to tailor the chart to their needs. HTTP Sample Requests
http://v iew s.rkd.reuters.com/v iew s/[appID]/charts/default.aspx?rics=G O O G .O &skin=6 OR http://v iew s.rkd.reuters.com/v iew s/[appID]/charts/default.aspx?rics=G O O G .O |V O D.L|M S F T.O |IBM .N &skin=8&linecolor=0;0;200|50;50;50| 200;100;0|0;200;0

Note: The Chart View which appears from the Chart Link in the Snap Quote view has SKIN=0. Users can customize the chart to look as needed. The SKIN=19 is designed to provide the same chart in a smaller form (width=300 and height=200). HTTP Sample Requests - Small Chart for Google
http://v iew s.rkd.reuters.com/v iew s/[appID]/charts/default.aspx?rics=G O O G .O &skin=19

The screen below shows chart for Google in small form:

Web Views

767

Please find the XML versions of the pre-canned skins in the Charts Skins section. If a user requests a chart with multiple RICs from different exchanges, then by default the first RIC will display on the right y-axis, the second will display on the left y-axis and any subsequent RICs in alternative currencies will be plotted on the left y-axis. To request a chart with multiple RICs and their currencies on separate axis you would submit a request similar to the following: HTTP Sample Requests - Chart with Multiple RICs and Currencies on Separate Axis
https://v iew s.rkd.reuters.com/v iew s/[appID]/charts/default.aspx?rics=G O O G .O % 7cV O D.L% 7cRIM .TO &linecolor=0% 3b0% 3b200% 7c50% 3b50% 3b50% 7c200% 3b100% 3b0

You will get the following result:

768

TRKD API Developer's Guide

To request a chart for CSCO in daily period in the style of bollinger bands with volume and custom colors, the request would be created as follows: HTTP Sample Requests - Customized Chart for Cisco
http://v iew s.rkd.reuters.com/v iew s/[appID]/charts/default.aspx?rics=C S C O .O &linecolor=255;128;0&v olcolor=0;90;132&S ty le=bband

The following result will be displayed:

Web Views

769

40.4.11 Search Web View

This view can be used to search for organizations, instruments, quotes and indices. Users can perform searches on the following data: Search All - Searches any item in the index. Organization - Searches Organizations involved in the financial markets. Commodity Quote - Searches Commodity Quotes. Derivative Instruments - Searches on any derivative instrument. Derivative Quote - Searches on any derivative quote, additional filter or query term required to limit to Option, Future, Warrant etc. Equity Quote - Searches Fund Quotes. Fund Quote - Searches Government and Corporate Bond instruments. Government and Corporate Bond Instruments - Searches Government and Corporate Bond instruments. Index Instruments - Searches Indices at Instrument level. Index Quote - Searches Quotes on indices. Note: You can use Chinese or Japanese characters when searching for data. The table provided below lists the parameters which can be used for the Search Web View: Parameter PRECISION Description (Optional) Defines whether to search for anything which starts from (Starts with [1]) or includes (Includes [2]) the characters specified in the search string. CODESCHEME (Optional) Specifies the code schemes included in the query. Default is "all" codes. Each scheme is identified by a 3-letter code (e.g. WPK, ISN, etc). MAXREC (Optional) The maximum number of records that will be returned for a requested record set. Null = 50 records, 0 = 0 records, >0 and <=1000 - the number of records to be returned. BLOCKSIZE (Optional) This is the maximum number of rows returned in one request. Null = 50 records, 0 = 0 records, >0 and <=50 - the number of records to be returned. SECTOR Industry code based on Thomson Reuters strategic classification TRBC. It should be specified as a hierarchical chain of sectors, like Basic Materials/Chemicals/Chemicals/Agricultural Chemicals. (For example: sector=basic+materials%2Fchemicals%2Fchemicals%2Fagricultural+chemicals) To retrieve full hierarchical chain of sectors you can use the Get Industry Classification Schema Full Hierarchy (GetIndustryClassificationSchemaFullHierarchy_1) request and specify TRBC2009 as taxonomy code. ASSETCATEGORY Allows user to show only specific asset classes in results e.g., Options, Warrants, Options etc. COUNTRY Name of country - Mandatory. For equity organizations, this is the Country of HQ. For bond organizations, this is the Country of Domicile. ISO 3-letter code (e.g. "GBR"). Dynamic list will be stored for a week. Country codes can be found in Country Codes section in Company Administration chapter. SHOWFORM Defines whether to show results screen in the frame or not: If set to TRUE then the user will see the results in the frame once submit is clicked. If set to FALSE the user will need to use their own search capability and pass all parameters into the URL for the results to show in designated frame. SHOWREFINERESU Parameter to show the refine results action. LTS QUERY Specifies a code or name (or part of name) of organization to search. (Example: query=ibm) REFINE Used to filter out the required class of securities (by SearchAllCategory value).(Example: refine=Options) SORTING Used to sort the wanted column in the displayed table. It is applied in the following pattern: [ad]\d+. (Example: sorting=a3 sorting the 3rd column in ascending order). DATE Used to filter out OptionStikes by expiration date, applied in combination with "exch" parameter. (Example: date=07/16/2010) PI Used to filter out the required class of securities issued by the company, having PI equal to the value passed in the "pi" parameter. (Example: pi=19676) EXCH Used to filter out OptionStikes by exchange code. Applied in combination with "date" parameter. (Example: exch=LIF). PAGE This parameter is used to navigate between pages. (Example: page=2)

770

TRKD API Developer's Guide

ISIN ITM

Used to filter out warrant quotes, which contains Issue ISIN equal to the value passed in the "isin" parameter (Example: isin=DE000UB9DJT8) Used to filter out OptionStikes by "in the money" flag. If 'itm' is true we leave only records with "in the money" flag. (Example: itm=true)

Note: If the user sets MAXREC=0 and/or BLOCKSIZE=0, then the View will return no results in the response. Thomson Reuters recommends that users specify the "MAXREC" and "BLOCKSIZE" parameters in their calls. Note: The reason for not applying base currency conversion to Warrants is that a warrant has multiple quote RICs and they may have multiple currencies. So, there isn't a single currency to convert the value from. To open the Search input form, you should specify the following at the end of URL:
/v iew s/[appID]/search/default.aspx

HTTP Sample Request

http://v iew s.rkd.reuters.com/v iew s/[appID]/search/default.aspx

The following Search form will be returned defaulting to Basic Search on Name:

The Advanced Search option provides the following options:

Users will have the option of searching for organizations from the 'Name' search or the 'Country/Sector' search. Examples: 1. This example searches for Microsoft items in the database and is configured to retrieve 1000 results max: HTTP Sample Request - Search for Microsoft
http://v iew s.rkd.reuters.com/v iew s/[appID]/search/default.aspx?query =microsoft&maxrec=1000

The user gets the following Web View as a result:

Web Views

771

Note: To switch off the input form so that it is not displayed for the user the developer should include '&SHOWFORM=FALSE' parameter. 2. This example searches for IBM bonds in the database and is configured to retrieve results in blocks each containing 5 records: HTTP Sample Request - Search for IBM Bonds
http://v iew s.rkd.reuters.com/v iew s/[appID]/search/default.aspx?query =ibm&assetcategory =bond&blocksize=5

The user gets the following Web View as a result:

3. This example searches for Cisco records under Equity asset category in the database and retrieves max 15 records: HTTP Sample Request - Search for Cisco
http://v iew s.rkd.reuters.com/v iew s/[appID]/search/default.aspx?query =C S C O &assetcategory =equity &maxrec=15

The user gets the following Web View as a result:

772

TRKD API Developer's Guide

4. This example searches for HSBC futures: HTTP Sample Request - Search for HSBC Futures
http://v iew s.rkd.reuters.com/v iew s/[appID]/search/default.aspx?query =H S BC &assetcategory =future

The user gets the following Web View as a result:

5. This example shows the search on FORD warrants: HTTP Sample Request - Search for Ford Warrants
http://v iew s.rkd.reuters.com/v iew s/[appID]/search/default.aspx?query =F O RD&assetcategory =w arrant

The user gets the following Web View as a result:

Web Views

773

6. This example searches for IBM Options in the database: HTTP Sample Request - Search for IBM Options
http://v iew s.rkd.reuters.com/v iew s/[appID]/search/default.aspx?query =IBM &assetcategory =option

The user gets the following Web View as a result:

7. This example searches for all GE items: HTTP Sample Request - Search for GE
http://v iew s.rkd.reuters.com/v iew s/[appID]/search/default.aspx?query =ge&assetcategory =all&blocksize=10

The user gets the following Web View as a result:

774

TRKD API Developer's Guide

8. This example searches for all option chains under GE: HTTP Sample Request - Search for Option Chains under GE
http://v iew s.rkd.reuters.com/v iew s/[appID]/search/default.aspx?query =ge&assetcategory =optionchains&blocksize=10

The user gets the following Web View as a result:

9. This example searches for all organizations in Norway: HTTP Sample Request - Search for All Organizations in Norway (with Input Form Removed)
http://v iew s.rkd.reuters.com/v iew s/[appID]/search/default.aspx?country =N O R&S H O WF O RM =F A LS E &BLO C KS IZE =10

The user gets the following Web View as a result:

10. Search for all organizations in Norway in the Applied Resources Sector: HTTP Sample Request - Search for All Organizations in Norway in the Applied Resources Sector

Web Views

775

http://v iew s.rkd.reuters.com/v iew s/[appID]/search/default.aspx?country =N O R&sector=basic+materials% 2F applied+resources

The user gets the following Web View as a result:

11. Search for all organizations in the Chemicals Sector: HTTP Sample Request - Search for All Organizations in the Chemicals Sector
http://v iew s.rkd.reuters.com/v iew s/[appID]/search/default.aspx?sector=basic+materials% 2F chemicals

The user gets the following Web View as a result:

40.4.12 Significant Developments Web View

Significant Developments is a news analysis and filtering service that identifies crucial, market-moving company news on a near real-time basis for a large universe of public companies. You can use Significant Developments Web Views to screen through company press releases and briefly summarize major company specific developments. The targeted coverage is 30,000+ publicly traded companies in 80 countries. The table provided below lists the parameters which can be used by the Significant Developments Web View:

776

TRKD API Developer's Guide

Parameter RICS MAXHEADLINES TOPIC

PERIODRANGE PERIODTO PERIODFROM TOPSTORIES SIGNIFICANCE

ORDERBY PAGESIZE SHOWFORM

XLS OUTPUT

Description The Reuters Instrument Code(s) for the company for which Significant Developments should be searched. (Optional) The maximum number of headlines to be retrieved by the view (default is 100). There are total of 22 topics available for Thomson Reuters Significant Development stories. Each development can include up to 3 topic codes depending on the nature of development story. There will always be a minimum of one topic code assigned to each development. For further information on Topic codes and their descriptions please refer to section Topics and Descriptions in Significant Developments Chapter. The period where Significant Developments should search for news stories. Available options are: Today, this week, 1 week, 2 weeks, 1 month, 2 months, 3 months, 6 months, 1 year, Custom. The end date where Significant Developments should end searching for news stories. The starting date where Significant Developments should begin searching for news stories. Indicates if response should only contain stories that are "Top Story". There are currently 3 flags used to disclose the level of significance: 1 = All 2 = High/Medium 3 = High Defines how response items must be ordered. Available options are: Release Date, Company name, Headline or Topic. Specifies the max number of significant development headlines to be displayed in the view at a given time. Defines whether to show results screen in the frame or not: If set to TRUE then the user will see the results in the frame once submit is clicked. If set to FALSE the user will need to use their own search capability and pass all parameters into the URL for the results to show in designated frame. Displays the button for outputting data to XLS file. Defines the format of the output file either HTML or XLS.

1. Search for Significant Developments for IBM in the past 2 weeks with a high/medium significance: HTTP Sample Request - IBM Significant Developments in Past 2 Weeks with a High/Medium Significance
http://v iew s.rkd.reuters.com/v iew s/[appID]/sigdev /default.aspx?rics=IBM .N &topstories=false&topic=0&significance=high&periodrange=w eek2

The user gets the following Web View as a result:

2. Search for Significant Developments which have a topic of divestitures in the past week with a high/medium significance: HTTP Sample Request - Topic is divestitures in Past Week with a High/Medium Significance
http://v iew s.rkd.reuters.com/v iew s/[appID]/sigdev /default.aspx?topstories=false&topic=213&significance=highmedium&periodrange=w eek1

The user gets the following Web View as a result:

Web Views

777

Note: Users can use the '&SHOWFORM=FALSE' parameter to remove the input form and display ONLY the results table.

40.4.13 Fundamentals Web View

Fundamentals Web Views allow users to access timely, accurate, and comprehensive financial summary information. Fundamentals data includes: Financial Statements Reports o Income Statement o Balance Sheet o Cash Flow Ratios Report The table provided below lists the parameters which can be used by the Fundamentals Web View (where appropriate): Parameter RIC PERIODBASIS TAB COMPONENT Description The Reuters Instrument Code(s) for the company for which Significant Developments should be searched. Defines the reporting basis. Either Annual or Interim. Defines what financial data should be displayed: Income Statement, Balance Sheet, Cash Flow or Ratios. (Available only for Ratios data) Defines the component of Ratios data available items are: PVOL - Price and Volume INCST - Income Statement VALR - Valuation PSHR - Per Share Data FSTR - Financial Strength DIV - Dividend GREAT - Growth MGMEFF - Management Effectiveness MARG - Margins BALSH - Balance Sheet CASH - Cash Flow DESCR - Descriptive EFFR - Efficiency Ratios INTRD - Insider Trading OWNER - Institutional Ownership

778

TRKD API Developer's Guide

SHOWTAB SHOWFORM

XLS XLS_ALL OUTPUT

PREL - Price Related PROFIT - Profitability Ratios SHARE - Share Related Items SHINT - Short Interest Enables/Disables tabs on the displayed View. Defines whether to show results screen in the frame or not: If set to TRUE then the user will see the results in the frame once submit is clicked. If set to FALSE the user will need to use their own search capability and pass all parameters into the URL for the results to show in designated frame. Displays the button for outputting data to XLS file. Displays the button for outputting all data to XLS file. Defines the format of the output file - either HTML or XLS.

Note: Users can use the &SHOWFORM=FALSE parameter to remove the input form and display only the results table. Samples: 1. To request a financial report for Google, the user must submit the following request: HTTP Sample Request - Google Financial Report
http://v iew s.rkd.reuters.com/v iew s/[appID]/fundamentals/income.aspx?ric=G O O G .O

The user gets the following Web View as a result:

2. To request Ratios and Statistics report for Google, the user must submit the following request: HTTP Sample Request - Google Ratios and Statistics Report
http://v iew s.rkd.reuters.com/v iew s/[appID]/fundamentals/ratios.aspx?ric=G O O G .O

The user gets the following Web View as a result:

Web Views

779

40.4.14 Estimates Web View

Estimates Web Views allows the users to access the database that includes global estimates for over 15,000 active and 10,000 inactive companies. It contains all estimates types and periods that Thomson Reuters collects - the estimate types (measures) which are displayed in the view are dependant on the permission type the user ID is set to. This Web View allows clients to access the following data collected by Thomson Reuters: Consensus Estimates Actuals Broker Recommendations Price Targets The table provided below lists the parameters which can be used by the Consensus Estimate Web View: Parameter COMPANY Description Company name. In the Thomson Reuters Estimates database each company, in the eyes of the broker, has its record. However, users of the data should be aware that for various reasons one company in the real world may have two separate records in this service. An example of such an occurrence is HSBC where there are major listings on both the London Stock Exchange and the Hong Kong Stock Exchange. Currently both listings will have separate sets of Estimates. The reason for this is that each listing will produce separate accounts based on different accounting standards and as such brokers treat them as two separate companies. Defines the reporting basis. Either Annual or Interim. Defines whether to show results screen in the frame or not: If set to TRUE then the user will see the results in the frame once submit is clicked. If set to FALSE the user will need to use their own search capability and pass all parameters into the URL for the results to show in designated frame. Displays the button for outputting data to XLS file. Defines the format of the output file either HTML or XLS. Displays all periods expanded in the display.

PERIODBASIS SHOWFORM

XLS OUTPUT SHOWALL Samples

1. To request Estimates for British Airways, with a link to XLS output and default annual periodicity, the user must submit the following URL: HTTP Sample Request - British Airways Estimates

780

TRKD API Developer's Guide

http://v iew s.rkd.reuters.com/v iew s/[appID]/estimates/default.aspx?company =BA Y.L&xls=true

The following Web View will be returned in the response:

2. To request Estimates for Microsoft with interim periodicity, the user must submit the following URL: HTTP Sample Request - Microsoft Estimates
http://v iew s.rkd.reuters.com/v iew s/[appID]/estimates/default.aspx?company =M S F T.O &periodbasis=interim

The following Web View will be returned in the response:

Web Views

781

3. To request Estimates for BP in XLS output, the user must submit the following URL: HTTP Sample Request - BP Estimates
http://v iew s.rkd.reuters.com/v iew s/[appID]/estimates/default.aspx?company =BP .L&output=xls

As the response the user will get a pop-up window asking where to save the generated XLS file with the requested BP Estimates data.

40.4.15 Online Reports

This Web View can be used to search for online news reports and render text and pictures from the reports. The table provided below lists the parameters which can be used for the Online Reports Web View: Parameter COLUMN Description Specifies the number of columns that the retrieved online reports will be split into. Default value - 1 column. MAXHEADLINES Specifies maximum number of headlines to be retrieved. By default the value is set to 10. OLR_DATE Specifies the date for which Online Reports should be displayed. OLR_FORMAT Specifies the format in which Online Reports should be returned. Possible values: hl - headlines (default); hl_synop - headlines + synopsis; hl_full - headlines in full format; OLR_TOPIC Specifies the topic to be searched for in Online Reports. OLR_TOPXHL_F Specifies the maximum number of Top reports to be displayed in full format. ULL PAGE This parameter is used to navigate between pages. (Example: page=2) PAGESIZE Specifies page size. SHOWFORM Specifies whether to display the search form. SID (optional)

782

TRKD API Developer's Guide

To display Online Reports Web View, the user can construct the following URL by using the table above:
http:[v iew s_serv er]/v iew s/[appID]/onlinereports/headlines.aspx?column=[ value1 ] & maxheadlines=[ value2 ] & olr _date=[ value3 ] & olr _for mat=[ value4 ] & olr _topic=[ value5 ] & olr _topxhl_full=[ value6 ] & page=[ value7 ] & pagesize=[ value8 ] & showfor m=[ tr ue/false] & sid=[ value9 ]

The table below shows available parameters for a single online report: Parameter PRINT PRINT_ICON PRINT_IMG_ID STORY_IMG Description Displays the print link. Displays the print icon. Defines whether to show or not the picture on the page. Defines what picture to display.

STORY_IMG_SIZ Specifies image size for the image in an online report. E Possible values: thumbnail (default) - sized 150x106 pixels; view- 450x319 pixels; base - 450x319 pixels; STORYID Specifies the story id in urn format.

To display a news story, the user should can click a headline from the response or construct the following URL if they know the StoryID parameter:
/v iew s/[appID]/onlinereports/story .aspx?pr int=[v alue1]&pr int_icon=[v alue2]&pr int_img_id =[v alue3]&stor y_img =[v alue4]& stor y_img_size =[v alue5]&stor yid =[story ID]

Samples 1. This example searches Online Reports for U.S. top news with 3 TopX stories: HTTP Sample Request - U.S. Top News with 3 TopX Stories
http://v iew s.rkd.reuters.com/v iew s/[appID]/onlinereports/headlines.aspx?olr_topic=O LU S TO P N E WS &olr_topxhl_full=3&olr_date=false

The user gets the following Web View as a result:

Web Views

783

2. This example searches Online Reports for Brazilian Entertainment News in full format: HTTP Sample Request - Brazilian Entertainment News in Full Format
http://v iew s.rkd.reuters.com/v iew s/[appID]/onlinereports/headlines.aspx?olr_topic=O LG BRE N T&column=3&olr_for mat=hl_full&maxheadlines=25&pagesize=9&story _img_size=v iew

The user gets the following Web View as a result:

784

TRKD API Developer's Guide

3. This example searches Online Reports for UK entertainment with 4 TopX stories and synopsis format: HTTP Sample Request - UK Entertainment with 4 TopX Stories and Synopsis Format
http://v iew s.rkd.reuters.com/v iew s/[appID]/onlinereports/headlines.aspx?olr_topic=O LC A C O U N TRY&column=3&olr_for mat=hl_full&maxheadlines=25&pagesize=9&story _img_size=v iew

The user gets the following Web View as a result:

4. This example shows a single story from UK entertainment: HTTP Sample Request - Single Story from UK Entertainment

Web Views

785

http://v iew s.rkd.reuters.com/v iew s/[appID]/onlinereports/story .aspx? olr_topic=O LG BE N T&olr_topxhl_full=4&column=2&olr_format=hl_sy nop&maxheadlines=15&story id= urn% 3anew sml% 3aonlinereport.com% 3a20110112% 3anTRE 70B06J20110112003009% 3a137

The user gets the following Web View as a result:

40.4.16 Lipper
The library of Lipper Web Views allows users to access the entire universe of Lipper data and services. Currently, the Lipper Library contains the following Web Views: Asset Allocation - gets asset's allocation details. Asset Attributes - gets asset's list of attributes details. Asset Summary - gets asset's summary details. Benchmark - gets the benchmark for the given benchmark category and asset(s). Charges - gets the information about various charges paid by the given asset(s) as of the given effective date. Countries Registered for Sale - gets a list of the countries where the given assets are registered for sale. Cross References - gets the cross-reference information (asset identifier and Lipper ID) for the given crossreference code. Lipper Leader Score - gets Lipper Leader Scores for the given asset(s) based on the universe and data date. Minimum Investment - gets minimum investment data for the given asset(s). Objective - gets objective information for the give asset(s). Support Companies - gets company information for the given asset(s) and company role. Technical Analysis - gets technical analysis information for the given asset(s). TotalNetAsset History - gets a detailed list of the Total Net Asset (TNA) values for the specified period for the given asset(s). Top10 Holdings - gets the list of 10 top-performing holdings. Classifications - gets all of the classification information for the given asset(s), including classification schemes and the corresponding classification types. Performance Header - gets performance headers for the given asset(s). European Union Tax Directive - gets EU tax directive information for the given asset(s). Search - allows the client to look for an asset based on several types of characteristics. Overview - allow the user to retrieve a wide range of basic Lipper fund data. Top Performing Funds (All) - gets the list of top/best performing funds (based on year-to-date performance). Bottom Performing Funds (All) - gets the list of bottom/worst performing funds (based on year-to-date performance). Top Performing Funds (by LGC) - gets the list of top/best performing funds by Lipper Global Classification Schema. Bottom Performing Funds (by LGC) - gets the list of bottom/worst performing funds by Lipper Global Classification Schema. Comparative Performance - gets comparative performance for the specified funds. Newly Available Funds - gets the list of funds recently added to Lipper database. Calendar Year Performance - gets the performance information for the specified fund for the current year.

786

TRKD API Developer's Guide

40.4.16.1 Lipper Asset Allocation

This Web View can be used to display allocation details for a specific fund. The table provided below lists the parameters which can be used for the Lipper Asset Location Web View: Parameter ALLOCATION Description The allocation scheme. For full listing of allocation schemes see section Allocation Enumeration in the Lipper Data Enumerations section.

ALLOCATIONDA The allocation date. TE ERROR (Optional) TRUE / FALSE. If set to FALSE - the application will display only available/identifiable funds in the rendered view. If set to TRUE - the application will display available/identifiable funds and notify the user about invalid funds at the bottom of the rendered view. The display language for the collected allocations data. Possible values: languageneutral chinesesimplified chinesetaiwan traditionalchinese dutch english french german italian japanese korean spanish thai A unique eight- or nine-digit number that identifies an asset.

LANGUAGE

LIPPERIDS

To display Lipper Asset Allocation Web View, the user can construct the following URL by using the table above:
http:[v iew s_serv er]/v iew s/[appID]/lipper/assetallocation.aspx?allocation=[ value1 ] & allocationdate=[ value2 ] & er r or =[ value3 ] & language=[ value4 ] & lipper ids=[ value5 |value6 |valueN]

This example searches for the specified funds: HTTP Sample Request - Asset Allocation
http://v iew s.rkd.reuters.com/v iew s/[appID]/lipper/assetallocation.aspx?lipperids= 4 0 0 0 0 7 0 0 |4 0 0 0 0 2 5 5 |4 0 0 0 7 9 2 5 &allocation=A ll

The user gets the following Web View as a result:

Web Views

787

40.4.16.2 Lipper Asset Attributes

This Web View can be used to retrieve a detailed list of attributes for the specified asset(s). Attributes are basic characteristics of a fund, like asset type, status, universe, etc. The table provided below lists the parameters which can be used for the Lipper Asset Attributes Web View: Parameter ERROR Description (Optional) TRUE / FALSE. If set to FALSE - the application will display only available/identifiable funds in the rendered view. If set to TRUE - the application will display available/identifiable funds and notify the user about invalid funds at the bottom of the rendered view. The display language for the collected attributes data. Possible values: languageneutral chinesesimplified chinesetaiwan traditionalchinese dutch english french german italian japanese korean spanish thai A unique eight- or nine-digit number that identifies an asset.

LANGUAGE

LIPPERIDS

To display Lipper Asset Attributes Web View, the user can construct the following URL by using the table above:
http:[v iew s_serv er]/v iew s/[appID]/lipper/assetattributes.aspx?er r or =[ value1 ] & language=[ value2 ] & lipper ids=[ value3 |value4 | valueN]

This example searches for the specified funds: HTTP Sample Request - Asset Attributes
http://v iew s.rkd.reuters.com/v iew s/[appID]/lipper/assetattributes.aspx?lipperids= 4 0 0 0 0 7 0 0 |4 0 0 0 0 2 5 5 |4 0 0 0 7 9 2 5

The user gets the following Web View as a result:

40.4.16.3 Lipper Asset Summary

This Web View can be used to display summary details for a specific fund.

788

TRKD API Developer's Guide

The table provided below lists the parameters which can be used for the Lipper Asset Summary Web View: Parameter CURRENCY ERROR Description The currency for the returned data. For full listing of available currency codes, see section Currency Code Enumeration in the Lipper Data Enumerations chapter. Default - USD. (Optional) TRUE / FALSE. If set to FALSE - the application will display only available/identifiable funds in the rendered view. If set to TRUE - the application will display available/identifiable funds and notify the user about invalid funds at the bottom of the rendered view. The display language for the collected data. Possible values: languageneutral chinesesimplified chinesetaiwan traditionalchinese dutch english french german italian japanese korean spanish thai The asset identifier of a particular collective investment within Lipper.

LANGUAGE

LIPPERIDS

To display Lipper Asset Summary Web View, the user can construct the following URL by using the table above:
http:[v iew s_serv er]/v iew s/[appID]/lipper/assetsummary .aspx?cur r ency=[ value1 ] & er r or =[ value2 ] & language=[ value3 ] & lipper ids= [ value4 |value5 |valueN]

This example searches for the specified funds: HTTP Sample Request - Asset Summary
http://v iew s.rkd.reuters.com/v iew s/[appID]/lipper/assetsummary .aspx?lipperids=40000700|40000255|40007925

The user gets the following Web View as a result:

Web Views

789

40.4.16.4 Lipper Benchmark

This Web View can be used to display the benchmark for the given asset(s). A benchmark is a standard against which the performance of a security, index or investor can be measured. The table provided below lists the parameters which can be used for the Lipper Benchmark Web View: Parameter ERROR Description (Optional) TRUE / FALSE. If set to FALSE - the application will display only available/identifiable funds in the rendered view. If set to TRUE - the application will display available/identifiable funds and notify the user about invalid funds at the bottom of the rendered view. The display language for the returned data. Possible values: languageneutral chinesesimplified chinesetaiwan traditionalchinese dutch english french german italian japanese korean spanish thai A Lipper ID is a unique eight- or nine-digit number (e.g., 60003333) that identifies a collective investment.

LANGUAGE

LIPPERIDS

To display Lipper Benchmarks Web View, the user can construct the following URL by using the table above:
http:[v iew s_serv er]/v iew s/[appID]/lipper/benchmarks.aspx?er r or =[ value1 ] & language=[ value2 ] & lipper ids=[ value3 |value4 | valueN]

790

TRKD API Developer's Guide

This example searches for the benchmarks for the specified funds: HTTP Sample Request - Lipper Benchmarks
http://v iew s.rkd.reuters.com/v iew s/[appID]/lipper/benchmarks.aspx?lipperids=40000700|40000255|40007925

The user gets the following Web View as a result:

40.4.16.5 Lipper Charges

This Web View can be used to display the information about various charges paid by the given asset(s) as of the given effective date. The table provided below lists the parameters which can be used for the Lipper Charges Web View: Parameter Description

EFFECTIVE_DAT The effective date for the charges data. E ERROR (Optional) TRUE / FALSE. If set to FALSE - the application will display only available/identifiable funds in the rendered view. If set to TRUE - the application will display available/identifiable funds and notify the user about invalid funds at the bottom of the rendered view. Display language for the returned data. Possible values: languageneutral chinesesimplified chinesetaiwan traditionalchinese dutch english french german italian japanese korean spanish thai A Lipper ID is a unique eight- or nine-digit number (e.g., 60003333) that identifies a collective investment.

LANGUAGE

LIPPERIDS

To display Lipper Charges Web View, the user can construct the following URL by using the table above:
http:[v iew s_serv er]/v iew s/[appID]/lipper/charges.aspx?effective_date=[ value1 ] & er r or =[ value2 ] & language=[ value3 ] & lipper ids=

Web Views

791

[ value4 |value5 |valueN]

This example searches for the specified funds: HTTP Sample Request - Lipper Charges
http://v iew s.rkd.reuters.com/v iew s/[appID]/lipper/charges.aspx?lipperids=40000700|40000255|40007925

The user gets the following Web View as a result:

40.4.16.6 Lipper Countries Registered For Sale

This Web View can be used to display a list of the countries where the given assets are registered for sale. The table provided below lists the parameters which can be used for the Lipper Countries Registered for Sale Web View: Parameter ERROR Description (Optional) TRUE / FALSE. If set to FALSE - the application will display only available/identifiable funds in the rendered view. If set to TRUE - the application will display available/identifiable funds and notify the user about invalid funds at the bottom of the rendered view. The display language for the returned data.

LANGUAGE

792

TRKD API Developer's Guide

LIPPERIDS

Possible values: languageneutral chinesesimplified chinesetaiwan traditionalchinese dutch english french german italian japanese korean spanish thai A Lipper ID is a unique eight- or nine-digit number (e.g., 60003333) that identifies a collective investment.

To display Lipper Countries Registered for Sale Web View, the user can construct the following URL by using the table above:
http:[v iew s_serv er]/v iew s/[appID]/lipper/countriesregisteredforsale.aspx?er r or =[ value1 ] & language=[ value2 ] & lipper ids=[ value3 | value4 |valueN]

This example searches for the specified funds: HTTP Sample Request - Countries Registered for Sale
http://v iew s.rkd.reuters.com/v iew s/[appID]/lipper/countriesregisteredforsale.aspx?lipperids=40000700|40000255|40007925

The user gets the following Web View as a result:

40.4.16.7 Lipper Cross References

This Web View can be used to display cross-reference information (asset identifier and Lipper ID) for the given crossreference code. The table provided below lists the parameters which can be used for the Lipper Cross References Web View: Parameter BLOCK_SIZE ERROR Description Defines the size of blocks in which the data will be returned. Default value - 3. (Optional) TRUE / FALSE. If set to FALSE - the application will display only available/identifiable funds in the rendered view. If set to TRUE - the application will display available/identifiable funds and notify the user about invalid funds at the bottom of the rendered view. Possible values: languageneutral chinesesimplified chinesetaiwan

LANGUAGE

Web Views

793

LIPPERIDS

traditionalchinese dutch english french german italian japanese korean spanish thai A Lipper ID is a unique eight- or nine-digit number (e.g., 60003333) that identifies a collective investment.

To display Lipper Cross References Web View, the user can construct the following URL by using the table above:
http:[v iew s_serv er]/v iew s/[appID]/lipper/crossreferences.aspx?blocksize=[ value2 ] & er r or =[ value3 ] & language=[ value4 ] & lipper ids= [ value5 |value6 |valueN]

This example searches for the specified funds: HTTP Sample Request - Cross References
http://v iew s.rkd.reuters.com/v iew s/[appID]/lipper/crossreferences.aspx?lipperids=40000700|40000255|40007925

The user gets the following Web View as a result:

40.4.16.8 Lipper Leader Score Card

This Web View can be used to display Lipper Leader Scores for the given asset(s) based on the universe and data date. The table provided below lists the parameters which can be used for the Lipper Leader Score Card Web View: Parameter Description EFFECTIVE_DAT The effective date for which Lipper Leader score data will be returned. E ERROR (Optional) TRUE / FALSE. If set to FALSE - the application will display only available/identifiable funds in the rendered view. If set to TRUE - the application will display available/identifiable funds and notify the user about invalid funds at the bottom of the rendered view. LANGUAGE Possible values: languageneutral chinesesimplified chinesetaiwan

794

TRKD API Developer's Guide

traditionalchinese dutch english french german italian japanese korean spanish thai LEAD_SCORE_SI Defines the size of leader score. Possible values are medium/large. Default is medium. ZE LIPPERIDS A Lipper ID is a unique eight- or nine-digit number (e.g., 60003333) that identifies a collective investment. UNIVERSE The code that represents the Universe, for which the Lipper Leader Scores will be returned. For the list of available Universes, see the Universe Enumeration section in the Lipper Data Enumerations chapter. Note: Lipper Leader Scores are derived from highly sophisticated formulas that analyze funds against clearly defined criteria. Funds are compared to similar funds, and only those that truly stand out are awarded Lipper Leader status. There are five Lipper Leader Score Categories: Consistent Return, Expense, Preservation, Tax Efficiency, and Total Return. For each of these categories, there are three year, five year, ten year, and overall scores. Funds are rated on a numeric sale of 5 to 1; 5 represents funds with the highest rating, and 1 represents the lowest rating. To display Lipper Leader Score Card Web View, the user can construct the following URL by using the table above:
http:[v iew s_serv er]/v iew s/[appID]/lipper/leaderscorecard.aspx?effective_date=[ value1 ] & er r or =[ value2 ] & language=[ value3 ] & lead_scor e_size=[ value4 ] & lipper ids=[ value5 |value6 |valueN] & univer se[ value7 ]

This example searches for the specified funds: HTTP Sample Request - Leader Score Card
http://v iew s.rkd.reuters.com/v iew s/[appID]/lipper/leaderscorecard.aspx?lipperids=40000700|40000255|40007925

The user gets the following Web View as a result:

40.4.16.9 Lipper Leader Score Card 2

This Web View can be used to display Lipper Leader Scores for the given asset(s) based on the universe and data date.

Web Views

795

The only difference between Lipper Leader Score Card and Lipper Leader Score Card is the data orientation (horizontal/ vertical). The table provided below lists the parameters which can be used for the Lipper Leader Score Card 2 Web View: Parameter Description

EFFECTIVE_DAT The effective date for which Lipper Leader score data will be returned. E ERROR (Optional) TRUE / FALSE. If set to FALSE - the application will display only available/identifiable funds in the rendered view. If set to TRUE - the application will display available/identifiable funds and notify the user about invalid funds at the bottom of the rendered view. The display language for the returned data. Possible values: languageneutral chinesesimplified chinesetaiwan traditionalchinese dutch english french german italian japanese korean spanish thai

LANGUAGE

LEAD_SCORE_SI Defines the size of leader score. Possible values are medium/large. Default is medium. ZE LIPPERIDS UNIVERSE A Lipper ID is a unique eight- or nine-digit number (e.g., 60003333) that identifies a collective investment. The code that represents the Universe, for which the Lipper Leader Scores will be returned. For the list of available Universes, see the Universe Enumeration section in the Lipper Data Enumerations chapter.

To display Lipper Leader Score Card 2 Web View, the user can construct the following URL by using the table above:
http:[v iew s_serv er]/v iew s/[appID]/lipper/leaderscorecard2.aspx?effective_date=[ value1 ] & er r or =[ value2 ] & language=[ value3 ] & lead_scor e_size=[ value4 ] & lipper ids=[ value5 |value6 |valueN] & univer se[ value7 ]

This example searches for the specified funds: HTTP Sample Request - Leader Score Card 2
http://v iew s.rkd.reuters.com/v iew s/[appID]/lipper/leaderscorecard2.aspx?lipperids=40000700|40000255|40007925

The user gets the following Web View as a result:

796

TRKD API Developer's Guide

40.4.16.10 Lipper Minimum Investment

This Web View can be used to retrieve minimum investment data for the given asset(s). The table provided below lists the parameters which can be used for the Lipper Minimum Investment Web View: Parameter ERROR Description (Optional) TRUE / FALSE. If set to FALSE - the application will display only available/identifiable funds in the rendered view. If set to TRUE - the application will display available/identifiable funds and notify the user about invalid funds at the bottom of the rendered view. The display language for the returned data. Possible values: languageneutra chinesesimplified chinesetaiwan traditionalchinese dutch english french german italian japanese korean spanish thai A Lipper ID is a unique eight- or nine-digit number (e.g., 60003333) that identifies a collective investment.

LANGUAGE

LIPPERIDS

Web Views

797

To display Lipper Minimum Investment Web View, the user can construct the following URL by using the table above:
http:[v iew s_serv er]/v iew s/[appID]/lipper/minimuminv estment.aspx?er r or =[ value1 ] & language=[ value2 ] & lipper ids=[ value3 | value4 |valueN]

This example searches for the specified funds: HTTP Sample Request - Lipper Minimum Investment
http://v iew s.rkd.reuters.com/v iew s/[appID]/lipper/minimuminv estment.aspx?lipperids=40000700|40000255|40007925

The user gets the following Web View as a result:

40.4.16.11 Lipper Objective

This Web View can be used to display asset's objective details. The table provided below lists the parameters which can be used for the Lipper Objective Web View: Parameter LANGUAGE Description The display language for the returned data. Possible values: languageneutral chinesesimplified chinesetaiwan traditionalchinese dutch english french german italian japanese korean spanish thai A Lipper ID is a unique eight- or nine-digit number (e.g., 60003333) that identifies a collective investment.

LIPPERID

To display Lipper Objective Web View, the user can construct the following URL by using the table above:
http:[v iew s_serv er]/v iew s/[appID]/lipper/objectiv e.aspx?language=[ value1 ] & lipper id=[ value2 ]

This example searches for the specified funds:

798

TRKD API Developer's Guide

HTTP Sample Request - Lipper Objective

http://v iew s.rkd.reuters.com/v iew s/[appID]/lipper/objectiv e.aspx?lipperid=40000700

The user gets the following Web View as a result:

40.4.16.12 Lipper Support Companies

This Web View can be used to display company information and company role for the given asset(s). The table provided below lists the parameters which can be used for the Lipper Support Companies Web View: Parameter ERROR Description (Optional) TRUE / FALSE. If set to FALSE - the application will display only available/identifiable funds in the rendered view. If set to TRUE - the application will display available/identifiable funds and notify the user about invalid funds at the bottom of the rendered view. The display language for the returned data. Possible values: languageneutral chinesesimplified chinesetaiwan traditionalchinese dutch english french german italian japanese korean spanish thai A Lipper ID is a unique eight- or nine-digit number (e.g., 60003333) that identifies a collective investment.

LANGUAGE

LIPPERIDS

To display Lipper Support Companies Web View, the user can construct the following URL by using the table above:
http:[v iew s_serv er]/v iew s/[appID]/lipper/supportcompanies.aspx?er r or =[ value1 ] & language=[ value2 ] & lipper ids=[ value3 |valueN]

This example searches for the specified funds: HTTP Sample Request - Lipper Support Companies
http://v iew s.rkd.reuters.com/v iew s/[appID]/lipper/supportcompanies.aspx?lipperids=40000700|40000255|40007925

The user gets the following Web View as a result:

Web Views

799

40.4.16.13 Lipper Technical Analysis

This Web View can be used to retrieve technical analysis data display allocation details for a specific fund. The table provided below lists the parameters which can be used for the Lipper Asset Location Web View: Parameter CURRENCY LANGUAGE Description The currency for the returned price. For full listing of available currency codes, see section Currency Code Enumeration in the Lipper Data Enumerations chapter. The display language for the returned data. Possible values: languageneutral chinesesimplified chinesetaiwan traditionalchinese dutch english french german italian japanese korean spanish thai A Lipper ID is a unique eight- or nine-digit number (e.g., 60003333) that identifies a collective investment.

LIPPERID

To display Lipper Technical Analysis Web View, the user can construct the following URL by using the table above:
http:[v iew s_serv er]/v iew s/[appID]/lipper/technicalanaly sis.aspx?cur r ency=[ value1 ] & language=[ value2 ] & lipper id=[ value3 ]

This example searches for the specified funds: HTTP Sample Request - Lipper Technical Analysis
http://v iew s.rkd.reuters.com/v iew s/[appID]/lipper/technicalanaly sis.aspx?lipperid=40000700

The user gets the following Web View as a result:

800

TRKD API Developer's Guide

40.4.16.14 Lipper TotalNetAsset History

This Web View can be used to retrieve a detailed list of the Total Net Asset (TNA) values for the specified period for the given asset(s). TNA stands for Total Net Asset or the total funds under management, expressed in millions in currency of the fund. The table provided below lists the parameters which can be used for the Lipper TotalNetAsset (TNA) History Web View: Parameter BEGIN_DATE CURRENCY END_DATE ERROR Description The begin date of the specified period. The currency for the returned price. For full listing of available currency codes, see section Currency Code Enumeration in the Lipper Data Enumerations chapter. The end date of the specified period. (Optional) TRUE / FALSE. If set to FALSE - the application will display only available/identifiable funds in the rendered view. If set to TRUE - the application will display available/identifiable funds and notify the user about invalid funds at the bottom of the rendered view. The display language for the returned data. Possible values: languageneutral chinesesimplified chinesetaiwan traditionalchinese dutch english french german italian japanese korean spanish thai

LANGUAGE

Web Views

801

LATEST_ONLY LIPPERIDS

If set to true then only data for the most recently available date will be returned. If false then all available TNA data will be returned. A Lipper ID is a unique eight- or nine-digit number (e.g., 60003333) that identifies a collective investment.

To display Lipper TNA History Web View, the user can construct the following URL by using the table above:
http:[v iew s_serv er]/v iew s/[appID]/lipper/tnahistory .aspx?begin_date=[ value1 ] & cur r ency=[ value2 ] & end_date=[ value3 ] & er r or = [ value4 ] & language=[ value5 ] & latest_only=[ value6 ] & lipper ids=[ value7 |value8 |valueN]

This example searches for the specified funds: HTTP Sample Request - Lipper TNA History
http://v iew s.rkd.reuters.com/v iew s/[appID]/lipper/tnahistory .aspx?lipperids=40000700|40000255|40007925

The user gets the following Web View as a result:

40.4.16.15 Lipper Top10 Holdings

This Web View can be used to show the portfolio's top ten holdings with the greatest asset weighting (by %TNA). The table provided below lists the parameters which can be used for the Lipper Top 10 Holdings Web View: Parameter Description ALLOCATIONDA The allocation date. TE ERROR (Optional) TRUE / FALSE.

802

TRKD API Developer's Guide

LANGUAGE

LIPPERIDS

If set to FALSE - the application will display only available/identifiable funds in the rendered view. If set to TRUE - the application will display available/identifiable funds and notify the user about invalid funds at the bottom of the rendered view. The display language for the returned data. Possible values: languageneutral chinesesimplified chinesetaiwan traditionalchinese dutch english french german italian japanese korean spanish thai A Lipper ID is a unique eight- or nine-digit number (e.g., 60003333) that identifies a collective investment.

To display Lipper Lipper Top 10 Holdings Web View, the user can construct the following URL by using the table above:
http:[v iew s_serv er]/v iew s/[appID]/lipper/top10holdings.aspx?allocationdate=[ value1 ] & er r or =[ value2 ] & language=[ value3 ] & lipper ids=[ value4 |value5 |valueN]

This example searches for the specified funds: HTTP Sample Request - Lipper Top 10 Holdings
http://v iew s.rkd.reuters.com/v iew s/[appID]/lipper/top10holdings.aspx?lipperids=40000700|40000255|40007925

The user gets the following Web View as a result:

Web Views

803

40.4.16.16 Lipper Classifications

This Web View can be used to retrieve classification types for the given asset(s) based on the classSchemeID. A classification is a designation assigned to assets based on various characteristics of the assets. For example, Equity North America is a classification assigned to an asset. Classifications are organized into classification schemes. Lipper offers or tracks multiple classification schemes around the world. For example, Equity North America is a classification within the Lipper Global Classification scheme. Lipper Fund Classifications Lipper fund classifications provide the ability to make meaningful 'like for like' comparisons across funds with similar investment mandates. Choose from style based holdings classifications; proprietary fund association local market schemes; or take a much broader approach by using the Lipper Global Classification which encompasses all funds tracked by Lipper. The table provided below lists the parameters which can be used for the Lipper Classifications Web View: Parameter BLOCKSIZE Description The size of blocks in which data is returned. Default value is 3.

EFFECTIVE_DAT The effective date for the classifications data. E ERROR (Optional) TRUE / FALSE. If set to FALSE - the application will display only available/identifiable funds in the rendered view. If set to TRUE - the application will display available/identifiable funds and notify the user about invalid funds at the bottom of the rendered view. The display language for the returned data. Possible values: languageneutral chinesesimplified chinesetaiwan traditionalchinese dutch english french german italian japanese korean spanish thai A Lipper ID is a unique eight- or nine-digit number (e.g., 60003333) that identifies a collective investment.

LANGUAGE

LIPPERIDS

To display Lipper Classifications Web View, the user can construct the following URL by using the table above:
http:[v iew s_serv er]/v iew s/[appID]/lipper/classification.aspx?blocksize=[ value1 ] & effective_date=[ value2 ] & er r or =[ value3 ] & language=[ value4 ] & lipper ids=[ value5 |value6 |valueN]

This example searches for the specified funds: HTTP Sample Request - Lipper Classifications
http://v iew s.rkd.reuters.com/v iew s/[appID]/lipper/classification.aspx?lipperids=40000700|40000255|40007925

The user gets the following Web View as a result:

804

TRKD API Developer's Guide

40.4.16.17 Lipper Performance Header

This Web View can be used to retrieve performance header for a specific fund. The table provided below lists the parameters which can be used for the Lipper Performance Header Web View: Parameter CURRENCY LANGUAGE Description The display currency for the returned data. For full listing of available currency codes, see section Currency Code Enumeration in the Lipper Data Enumerations chapter. The display language for the returned data. Possible values: languageneutral chinesesimplified chinesetaiwan traditionalchinese dutch english french german italian japanese korean spanish thai A Lipper ID is a unique eight- or nine-digit number (e.g., 60003333) that identifies a collective investment.

LIPPERID

To display Lipper Performance Header Web View, the user can construct the following URL by using the table above:
http:[v iew s_serv er]/v iew s/[appID]/lipper/performanceheader.aspx?cur r ency=[ value1 ] & language=[ value2 ] & lipper id=[ value3 ]

This example searches for the specified funds: HTTP Sample Request - Lipper Performance Header
http://v iew s.rkd.reuters.com/v iew s/[appID]/lipper/performanceheader.aspx?lipperid=40000700

The user gets the following Web View as a result:

Web Views

805

40.4.16.18 Lipper European Union Tax Directive

This Web View can be used to retrieve EU tax directive information for the given asset(s). The EU Tax Directive applies only to bank interest, bond interest, and analogous income, such as income from bond funds, money-market funds, loans and mortgages. The table provided below lists the parameters which can be used for the Lipper EU Tax Directive Web View: Parameter ERROR Description (Optional) TRUE / FALSE. If set to FALSE - the application will display only available/identifiable funds in the rendered view. If set to TRUE - the application will display available/identifiable funds and notify the user about invalid funds at the bottom of the rendered view. The display language for the retrieved data. Possible values: languageneutral chinesesimplified chinesetaiwan traditionalchinese dutch english french german italian japanese korean spanish thai A Lipper ID is a unique eight- or nine-digit number (e.g., 60003333) that identifies a collective investment. The code that represents the Universe, for which the Lipper Leader Scores will be returned. For the list of available Universes, see the Universe Enumeration section in the Lipper Data Enumerations chapter.

LANGUAGE

LIPPERIDS UNIVERSE

To display Lipper European Union Tax Directive Web View, the user can construct the following URL by using the table above:
http:[v iew s_serv er]/v iew s/[appID]/lipper/eutaxdirectiv e.aspx?allocation=[ value1 ] & allocationdate=[ value2 ] & er r or =[ value3 ] & language=[ value4 ] & lipper ids=[ value5 |value6 |valueN] & univer se=[ value7 ]

This example searches for the specified funds: HTTP Sample Request - Lipper European Union Tax Directive
http://v iew s.rkd.reuters.com/v iew s/[appID]/lipper/eutaxdirectiv e.aspx?lipperids=40000700|40000255|40007925

The user gets the following Web View as a result:

806

TRKD API Developer's Guide

40.4.16.19 Lipper Search

This Web View allows the client to look for an asset based on several types of characteristics. For example, Lipper Search gives the user the ability to search for assets with a name that 'begins with' or 'contains' certain words or phrases. The table provided below lists the parameters which can be used for the Lipper Search Web View: Parameter MAXREC PAGE PAGESIZE Description Defines the maximum number of results to be returned. Default is 65535. This parameter is used to navigate between pages. (Example: page=2). Defines number of results to be displayed per page. Default is 10.

SEARCH_STRIN The classification scheme for which to search according to the specified search string value. Note that this G field does not accept any special characters. SEARCH_STYLE Defines search options. Possible values are: beginswith and contains. SHOWFORM SID UNIVERSE Defines whether to display the search form. (Optional) The code of the Universe. For full listing of universe codes, see section Universe Enumeration in the Lipper Data Enumerations chapter.

To display Lipper Search Web View, the user can construct the following URL by using the table above:
http:[v iew s_serv er]/v iew s/[appID]/lipper/search.aspx?maxr ec=[ value1 ] & page=[ value2 ] & pagesize=[ value3 ] & sear ch_str ing= [ value4 ] & sear ch_style=[ value5 ] & showfor m=[ value6 ] & sid=[ value7 ] & univer se=[ value8 ]

This example searches for the specified funds: HTTP Sample Request - Lipper Search
http://v iew s.rkd.reuters.com/v iew s/[appID]/lipper/search.aspx

The user gets the following Web View search form as a result:

Web Views

807

40.4.16.20 Lipper Overview

This Web View allows the user to retrieve a wide range of basic Lipper fund data. The table provided below lists the parameters which can be used for the Lipper Overview Web View: Parameter BEGIN_DATE CURRENCY Description The begin date of the specified period. The display currency for the returned data. For full listing of available currency codes, see section Currency Code Enumeration in the Lipper Data Enumerations chapter.

EFFECTIVE_DAT The effective date for the retrieved overview data. E END_DATE LANGUAGE The end date of the specified period. The display language for the retrieved data. Possible values: languageneutral chinesesimplified chinesetaiwan traditionalchinese dutch english french german italian japanese korean spanish thai If set to true then only data for the most recently available date will be returned. If false then all available data will be returned.

LATEST_ONLY

LEAD_SCORE_SI Defines Lipper Score size. Possible values are: large, medium. ZE LIPPERID UNIVERSE A Lipper ID is a unique eight- or nine-digit number (e.g., 60003333) that identifies a collective investment. The code that represents the Universe, for which the data will be returned. For the list of available Universes, see the Universe Enumeration section in the Lipper Data Enumerations chapter.

To display Lipper Overview Web View, the user can construct the following URL by using the table above:
http:[v iew s_serv er]/v iew s/[appID]/lipper/ov erv iew .aspx?begin_date=[ value1 ] & cur r ency=[ value2 ] & effective_date=[ value3 ] & end_date=[ value4 ] & language=[ value5 ] & latest_only=[ value6 ] & lead_scor e_size=[ value7 ] & lipper id=[ value8 ] & univer se=[ value9 ]

This example searches for the specified funds: HTTP Sample Request - Lipper Overview
http://v iew s.rkd.reuters.com/v iew s/[appID]/lipper/ov erv iew .aspx?lipperid=40000255

808

TRKD API Developer's Guide

The user gets the following Web View as a result:

40.4.16.21 Lipper Top Performing Funds (All)

This Web View can be used to retrieve the given country's best or top-performing funds. The table provided below lists the parameters which can be used for the Lipper Top Performing Funds (All) Web View: Parameter COUNTRIES CURRENCY Description The country for which the best performing funds should be returned. For full listing of available country codes, see section Countries Enumeration in the Lipper Data Enumerations chapter. The display currency for the returned list. For full listing of available currency codes, see section Currency Code Enumeration in the Lipper Data Enumerations chapter.

INCL_HEDGEFU If true, hedge funds will be included in the returned list of poorest performing funds; otherwise, hedge NDS funds will not be included in the results. Hedge funds are investment funds open to a limited range of investors. A hedge fund allows more investment and trading activities than other investment funds and an investor pays a special performance fee to its investment manager. LANGUAGE The display language for the returned data. Possible values: languageneutral chinesesimplified chinesetaiwan traditionalchinese dutch english french german italian japanese korean spanish thai

NUMBER_OF_AS The number of funds that should be included in the list of top performers. Default is 10. SETS To display Lipper Top Performing Funds (All) Web View, the user can construct the following URL by using the table above:

Web Views

809

http:[v iew s_serv er]/v iew s/[appID]/lipper/topperformingfund.aspx?countr ies=[ value1 ] & cur r ency=[ value2 ] & incl_hedgefunds= [ value3 ] & language=[ value4 ] & number _of_assets=[ value5 ]

This example searches for the specified funds: HTTP Sample Request - Top Performing Funds (All)
http://v iew s.rkd.reuters.com/v iew s/[appID]/lipper/topperformingfund.aspx?currency =U S D&countries=U S A |C A N |G BR&incl_hedgefunds=true

The user gets the following Web View as a result:

40.4.16.22 Lipper Bottom Performing Funds (All)

This Web View can be used to display allocation details for a specific fund. The table provided below lists the parameters which can be used for the Lipper Bottom Performing Funds (All) Web View: Parameter COUNTRIES Description The country for which the poorest performing funds should be returned. For full listing of available country codes, see section Countries Enumeration in the Lipper Data Enumerations chapter. CURRENCY The display currency for the returned list. For full listing of available currency codes, see section Currency Code Enumeration in the Lipper Data Enumerations chapter. INCL_HEDGEFU If true, hedge funds will be included in the returned list of poorest performing funds; otherwise, hedge NDS funds will not be included in the results. Hedge funds are investment funds open to a limited range of investors. A hedge fund allows more investment and trading activities than other investment funds and an investor pays a special performance fee to its investment manager. The display language for the returned data. Possible values: languageneutral chinesesimplified chinesetaiwan traditionalchinese dutch english

LANGUAGE

810

TRKD API Developer's Guide

french german italian japanese korean spanish thai NUMBER_OF_AS The number of funds that should be included in the list of poorest performers. Default is 10. SETS

To display Lipper Bottom Performing Funds (All) Web View, the user can construct the following URL by using the table above:
http:[v iew s_serv er]/v iew s/[appID]/lipper/bottomperformingfund.aspx?countr ies=[ value1 ] & cur r ency=[ value2 ] & incl_hedgefunds= [ value3 ] & language=[ value4 ] & number _of_assets=[ value5 ]

This example searches for the specified funds: HTTP Sample Request - Lipper Bottom Performing Funds (All)
http://v iew s.rkd.reuters.com/v iew s/[appID]/lipper/bottomperformingfund.aspx?currency =U S D&countries=U S A |C A N | G BR&incl_hedgefunds=true

The user gets the following Web View as a result:

40.4.16.23 Lipper Top Performing Funds (by LGC)

This Web View can be used to retrieve the top or best-performing funds (based on year-to-date performance) for one or more Lipper Global Classification Schemas. Lipper Fund Classifications Lipper fund classifications provide the ability to make meaningful 'like for like' comparisons across funds with similar investment mandates. Choose from style based holdings classifications; proprietary fund association local market schemes; or take a much broader approach by using the Lipper Global Classification which encompasses all funds tracked by Lipper. The table provided below lists the parameters which can be used for the Lipper Top Performing Funds (by LGC) Web View:

Web Views

811

Parameter CURRENCY

Description The display currency for the returned list. For full listing of available currency codes, see section Currency Code Enumeration in the Lipper Data Enumerations chapter. LANGUAGE The display language for the returned data. Possible values: languageneutral chinesesimplified chinesetaiwan traditionalchinese dutch english french german italian japanese korean spanish thai NUMBER_OF_AS The number of funds that should be included in the list of poorest performers. Default is 10. SETS SCHEMAS The Lipper Global Classification schema for which top-performing funds should be returned. Available Lipper Global Classification schemes are listed in the LG Classification Scheme Enumeration section in the Lipper Data Enumerations chapter. To display Lipper Top Performing Funds (by LGC) Web View, the user can construct the following URL by using the table above:
http:[v iew s_serv er]/v iew s/[appID]/lipper/topperforminglgcfunds.aspx?cur r ency=[ value1 ] & language=[ value2 ] & number _of_assets= [ value3 ] & schemas=[ value4 ]

This example searches for the specified funds: HTTP Sample Request - Lipper Top Performing Funds (by LGC)
http://v iew s.rkd.reuters.com/v iew s/[appID]/lipper/topperforminglgcfunds.aspx?number_of_assets=15&schemas=LipperG lobalH edge| LipperG lobalBonds

The user gets the following Web View as a result:

40.4.16.24 Lipper Bottom Performing Funds (by LGC)

This Web View can be used to retrieve the bottom or worst-performing funds (based on year-to-date performance) for one or more Lipper Global Classification Schemas. Lipper Fund Classifications Lipper fund classifications provide the ability to make meaningful 'like for like' comparisons across funds with similar investment mandates. Choose from style based holdings classifications; proprietary fund association local market schemes; or take a much broader approach by using the Lipper Global Classification which encompasses all funds tracked by Lipper. The table provided below lists the parameters which can be used for the Lipper Bottom Performing Funds (by LGC) Web View: Parameter Description

812

TRKD API Developer's Guide

CURRENCY

The display currency for the returned list. For full listing of available currency codes, see section Currency Code Enumeration in the Lipper Data Enumerations chapter. LANGUAGE The display language for the returned data. Possible values: languageneutral chinesesimplified chinesetaiwan traditionalchinese dutch english french german italian japanese korean spanish thai NUMBER_OF_AS The number of funds that should be included in the list of poorest performers. Default is 10. SETS SCHEMAS The Lipper Global Classification schema for which bottom-performing funds should be returned. Available Lipper Global Classification schemes are listed in the LG Classification Scheme Enumeration section in the Lipper Data Enumerations chapter. To display Lipper Bottom Performing Funds (by LGC) Web View, the user can construct the following URL by using the table above:
http:[v iew s_serv er]/v iew s/[appID]/lipper/bottomperforminglgcfunds.aspx?cur r ency=[ value1 ] & language=[ value2 ] & number _of_assets=[ value3 ] & schemas=[ value4 ]

This example searches for the specified funds: HTTP Sample Request - Lipper Bottom Performing Funds (by LGC)
http://v iew s.rkd.reuters.com/v iew s/[appID]/lipper/bottomperforminglgcfunds.aspx?number_of_assets=15&schemas=LipperG lobalH edge| LipperG lobalBonds

The user gets the following Web View as a result:

40.4.16.25 Lipper Comparative Performance

This Web View can be used to calculate and return comparative performance (by %) for the specified funds. The table provided below lists the parameters which can be used for the Lipper Comparative Performance Web View: Parameter CURRENCY ERROR Description The currency for the returned comparison information. For full listing of available currency codes, see section Currency Code Enumeration in the Lipper Data Enumerations chapter. (Optional) TRUE / FALSE. If set to FALSE - the application will display only available/identifiable funds in the rendered view. If set to TRUE - the application will display available/identifiable funds and notify the user about invalid funds at the bottom of the rendered view. Possible values:

LANGUAGE

Web Views

813

LIPPERIDS

languageneutral chinesesimplified chinesetaiwan traditionalchinese dutch english french german italian japanese korean spanish thai A Lipper ID is a unique eight- or nine-digit number (e.g., 60003333) that identifies a collective investment.

To display Lipper Comparative Performance Web View, the user can construct the following URL by using the table above:
http:[v iew s_serv er]/v iew s/[appID]/lipper/comparativ eperformance.aspx?cur r ency=[ value1 ] & er r or =[ value2 ] & language=[ value3 ] & lipper ids=[ value4 |valueN]

This example searches for the specified funds: HTTP Sample Request - Lipper Comparative Performance
http://v iew s.rkd.reuters.com/v iew s/[appID]/lipper/comparativ eperformance.aspx?lipperids=40000700|40000255|40007925 cy =U S D

The user gets the following Web View as a result:

40.4.16.26 Lipper Newly Available Funds

This Web View can be used to display allocation details for a specific fund.

814

TRKD API Developer's Guide

The table provided below lists the parameters which can be used for the Lipper Newly Available Funds Web View: Parameter COUNTRY Description The country for which the newly available funds should be returned. For full listing of available country codes, see section Countries Enumeration in the Lipper Data Enumerations chapter.

INCEPTION_DAT The inception date to be used in the search. E LANGUAGE The display language for the retrieved data. Possible values: languageneutral chinesesimplified chinesetaiwan traditionalchinese dutch english french german italian japanese korean spanish thai This parameter is used to navigate between pages. (Example: page=2). Defines the number of results to be displayed per page. Default is 10. (Optional)

PAGE PAGESIZE SID

USE_HYPERLINK Defines whether to include a hyperlink for a fund name. To display Lipper Newly Available Funds Web View, the user can construct the following URL by using the table above:
http:[v iew s_serv er]/v iew s/[appID]/lipper/new ly av ailablefunds.aspx?countr y=[ value1 ] & inceptiondate=[ value2 ] & language=[ value3 ] & page=[ value4 ] & pagesize=[ value5 ] & sid=[ value6 ] & use_hyper link=[ value7 ]

This example searches for the specified funds: HTTP Sample Request - Lipper Newly Available Funds
http://v iew s.rkd.reuters.com/v iew s/[appID]/lipper/new ly av ailablefunds.aspx

The user gets the following Web View as a result:

Web Views

815

40.4.16.27 Lipper Calendar Year Performance

This Web View can be used to retrieve calendar year performance calculation for the specified assets. The table provided below lists the parameters which can be used for the Lipper Calendar Year Performance Web View: Parameter CURRENCY ERROR Description The currency for the returned comparison information. For full listing of available currency codes, see section Currency Code Enumeration in the Lipper Data Enumerations chapter. (Optional) TRUE / FALSE. If set to FALSE - the application will display only available/identifiable funds in the rendered view. If set to TRUE - the application will display available/identifiable funds and notify the user about invalid funds at the bottom of the rendered view. Possible values: languageneutral chinesesimplified chinesetaiwan traditionalchinese dutch english french german italian japanese korean spanish thai A Lipper ID is a unique eight- or nine-digit number (e.g., 60003333) that identifies a collective investment.

LANGUAGE

LIPPERIDS

To display Lipper Calendar Year Performance Web View, the user can construct the following URL by using the table above:
http:[v iew s_serv er]/v iew s/[appID]/lipper/calendary earperformance.aspx?cur r ency=[ value1 ] & er r or =[ value2 ] & language=[ value3 ] & lipper ids=[ value4 |valueN]

This example searches for the specified funds: HTTP Sample Request - Lipper Calendar Year Performance

816

TRKD API Developer's Guide

http://v iew s.rkd.reuters.com/v iew s/[appID]/lipper/calendary earperformance.aspx?lipperids=40000700|40000255|40007925 cy =U S D

40.5

Error Messaging
Errors that occur in response to a request for HTML are returned directly to the user as formatted HTML displays. Error responses allow the users to easily identify what the issue is. Error messages are localized and displayed in the language set in the user preferences. Examples:

40.6

Support
If you cannot find the information you need in the TRKD API Developer's Guide or have questions, please contact our Online Solutions team directly at OnlineSolutions@thomsonreuters.com and a Thomson Reuters Knowledge Direct product specialist will assist you. For non-technical questions or if you are interested in purchasing Thomson Reuters Knowledge Direct API, please contact your Thomson Reuters sales representative. As the data feed consultants support 'new' clients only for the first 90 days of adoption, you can contact Thomson Reuters Help consultants. To contact Thomson Reuters, log into the Customer Zone, navigate to the Thomson Reuters Knowledge Direct API product page, and click Contact Us. Include as many details as possible.

40.7

Standard Time Zones

The table below lists all time zones (in alphabetical order) that can be specified when displaying financial data: Time Zone Afghanistan Standard Time Alaskan Standard Time Arab Standard Time Arabian Standard Time Arabic Standard Time Atlantic Standard Time Display (GMT+04:30) Kabul (GMT-09:00) Alaska (GMT+03:00) Kuwait, Riyadh (GMT+04:00) Abu Dhabi, Muscat (GMT+03:00) Baghdad (GMT-04:00) Atlantic Time (Canada)

Web Views

817

AUS Central Standard Time AUS Eastern Standard Time Azerbaijan Standard Time Azores Standard Time Canada Central Standard Time Cape Verde Standard Time Caucasus Standard Time Cen. Australia Standard Time Central America Standard Time Central Asia Standard Time Central Brazilian Standard Time Central Europe Standard Time Central European Standard Time Central Pacific Standard Time Central Standard Time Central Standard Time China Standard Time Dateline Standard Time E. Africa Standard Time E. Australia Standard Time E. Europe Standard Time E. South America Standard Time Eastern Standard Time Egypt Standard Time Ekaterinburg Standard Time Fiji Standard Time FLE Standard Time Georgian Standard Time GMT Standard Time Greenland Standard Time Greenwich Standard Time GTB Standard Time Hawaiian Standard Time India Standard Time Iran Standard Time Israel Standard Time Korea Standard Time Mid-Atlantic Standard Time Mountain Standard Time Mountain Standard Time (Mexico) Myanmar Standard Time N. Central Asia Standard

(GMT+09:30) Darwin (GMT+10:00) Canberra, Melbourne, Sydney (GMT +04:00) Baku (GMT-01:00) Azores (GMT-06:00) Saskatchewan (GMT-01:00) Cape Verde Islands (GMT+04:00) Yerevan (GMT+09:30) Adelaide (GMT-06:00) Central America (GMT+06:00) Astana, Dhaka (GMT -04:00) Manaus (GMT+01:00) Belgrade, Bratislava, Budapest, Ljubljana, Prague (GMT+01:00) Sarajevo, Skopje, Warsaw, Zagreb (GMT+11:00) Magadan, Solomon Islands, New Caledonia (GMT-06:00) Central Time (US and Canada) (Mexico) (GMT-06:00) Guadalajara, Mexico City, Monterrey (GMT+08:00) Beijing, Chongqing, Hong Kong SAR, Urumqi (GMT-12:00) International Date Line West (GMT+03:00) Nairobi (GMT+10:00) Brisbane (GMT+02:00) Minsk (GMT-03:00) Brasilia (GMT-05:00) Eastern Time (US and Canada) (GMT+02:00) Cairo (GMT+05:00) Ekaterinburg (GMT+12:00) Fiji Islands, Kamchatka, Marshall Islands (GMT+02:00) Helsinki, Kiev, Riga, Sofia, Tallinn, Vilnius (GMT +04:00) Tblisi (GMT) Greenwich Mean Time : Dublin, Edinburgh, Lisbon, London (GMT-03:00) Greenland (GMT) Casablanca, Monrovia (GMT+02:00) Athens, Bucharest, Istanbul (GMT-10:00) Hawaii (GMT+05:30) Chennai, Kolkata, Mumbai, New Delhi (GMT+03:30) Tehran (GMT+02:00) Jerusalem (GMT+09:00) Seoul (GMT-02:00) Mid-Atlantic (GMT-07:00) Mountain Time (US and Canada) (GMT-07:00) Chihuahua, La Paz, Mazatlan (GMT+06:30) Yangon (Rangoon) (GMT+06:00) Almaty, Novosibirsk

818

TRKD API Developer's Guide

Time Namibia Standard Time Nepal Standard Time New Zealand Standard Time Newfoundland Standard Time North Asia East Standard Time North Asia Standard Time Pacific SA Standard Time Pacific Standard Time Romance Standard Time Russian Standard Time SA Eastern Standard Time SA Pacific Standard Time SA Western Standard Time Samoa Standard Time SE Asia Standard Time Singapore Standard Time South Africa Standard Time Sri Lanka Standard Time Taipei Standard Time Tasmania Standard Time Tokyo Standard Time Tonga Standard Time US Eastern Standard Time US Mountain Standard Time Vladivostok Standard Time W. Australia Standard Time W. Central Africa Standard Time W. Europe Standard Time West Asia Standard Time West Pacific Standard Time Yakutsk Standard Time

(GMT +02:00) Windhoek (GMT+05:45) Kathmandu (GMT+12:00) Auckland, Wellington (GMT-03:30) Newfoundland and Labrador (GMT+08:00) Irkutsk, Ulaanbaatar (GMT+07:00) Krasnoyarsk (GMT-04:00) Santiago (GMT-08:00) Pacific Time (US and Canada); Tijuana (GMT+01:00) Brussels, Copenhagen, Madrid, Paris (GMT+03:00) Moscow, St. Petersburg, Volgograd (GMT-03:00) Buenos Aires, Georgetown (GMT-05:00) Bogota, Lima, Quito (GMT-04:00) Caracas, La Paz (GMT-11:00) Midway Island, Samoa (GMT+07:00) Bangkok, Hanoi, Jakarta (GMT+08:00) Kuala Lumpur, Singapore (GMT+02:00) Harare, Pretoria (GMT+06:00) Sri Jayawardenepura (GMT+08:00) Taipei (GMT+10:00) Hobart (GMT+09:00) Osaka, Sapporo, Tokyo (GMT+13:00) Nuku'alofa (GMT-05:00) Indiana (East) (GMT-07:00) Arizona (GMT+10:00) Vladivostok (GMT+08:00) Perth (GMT+01:00) West Central Africa (GMT+01:00) Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna (GMT+05:00) Islamabad, Karachi, Tashkent (GMT+10:00) Guam, Port Moresby (GMT+09:00) Yakutsk

40.8

Chart Skins
The following XML file provides parameters for 19 pre-configured chart skins: XML Sample
<skins> <skin id="0"> <Width>500</Width> <H eight>300</H eight> <S ty le>line</S ty le> <G rid>true</G rid> <A llDay >false</A llDay > <P eriod>daily </P eriod> <G ridWidth>1</G ridWidth> <G ridC olor>200;200;200</G ridC olor> <G ridS ty le>dot</G ridS ty le>

Web Views

819

<F ont>1</F ont> <TextC olor>0;0;0</TextC olor> <LabelF ormat>sy mbol</LabelF ormat> <BorderWidth>1</BorderWidth> <BorderC olor>100;100;100</BorderC olor> <BorderS ty le>dot</BorderS ty le> <LineC olor>0;0;153|207;47;10|105;105;105|237;157;38|201;99;167|93;171;56|138;86;44|155;128;168|14;156;151|173;153;61</ LineC olor> <LineS ize>1</LineS ize> <V ol>true</V ol> <V olC olor>0;51;255</V olC olor> <V olS ize>2</V olS ize> <V olLineS ize>1</V olLineS ize> <V alue>true</V alue> <V alueC olor>50;50;50</V alueC olor> <S how Range>true</S how Range> <Legend>true</Legend> <LegendS ty le>short</LegendS ty le> <F rame>false</F rame> <F rameC olor>0;0;0</F rameC olor> <F rameWidth>1</F rameWidth> <F rameS ty le>solid</F rameS ty le> <F illC olor>0;51;0</F illC olor> <Display Links>true</Display Links> <BgS tartC olor>255;255;255</BgS tartC olor> <BgE ndC olor>230;230;230</BgE ndC olor> <G radient>true</G radient> <BgS ty le>largegrid</BgS ty le> <G radientS ty le>forw arddiagonal</G radientS ty le> <ImgTy pe>P N G </ImgTy pe> </skin> <skin id="1"> <Width>200</Width> <H eight>150</H eight> <S ty le>line</S ty le> <G rid>true</G rid> <A llDay >false</A llDay > <P eriod>hourly </P eriod> <G ridWidth>1</G ridWidth> <G ridC olor>139;139;155</G ridC olor> <G ridS ty le>Dot</G ridS ty le> <F ont>1</F ont> <TextC olor>50;50;50</TextC olor> <LabelF ormat>S y mbol</LabelF ormat> <BorderWidth>1</BorderWidth> <BorderC olor>139;139;155</BorderC olor> <BorderS ty le>S olid</BorderS ty le> <LineC olor>0;102;204|207;47;10|105;105;105|237;157;38|201;99;167|93;171;56|138;86;44|155;128;168|14;156;151|173;153;61</ LineC olor> <LineS ize>0</LineS ize> <V ol>false</V ol> <V alue>true</V alue> <V alueC olor>50;50;50</V alueC olor> <S how Range>true</S how Range> <Legend>true</Legend> <LegendS ty le>short</LegendS ty le> <F rame>false</F rame> <F illC olor>204;225;255</F illC olor> <Display Links>true</Display Links> <BgS tartC olor>255;255;255</BgS tartC olor> <BgE ndC olor>255;255;255</BgE ndC olor> <G radient>true</G radient> <BgS ty le>LargeG rid</BgS ty le> <G radientS ty le>F orw ardDiagonal</G radientS ty le> <ImgTy pe>P N G </ImgTy pe> </skin> <skin id="2"> <Width>200</Width> <H eight>150</H eight> <S ty le>line</S ty le> <G rid>true</G rid> <A llDay >false</A llDay > <P eriod>hourly </P eriod> <G ridWidth>1</G ridWidth> <G ridC olor>139;139;155</G ridC olor> <G ridS ty le>Dot</G ridS ty le> <F ont>1</F ont>

820

TRKD API Developer's Guide

<TextC olor>255;255;204</TextC olor> <LabelF ormat>N ame</LabelF ormat> <BorderWidth>1</BorderWidth> <BorderC olor>139;139;155</BorderC olor> <BorderS ty le>S olid</BorderS ty le> <LineC olor>255;153;0|207;47;10|105;105;105|237;157;38|201;99;167|93;171;56|138;86;44|155;128;168|14;156;151|173;153;61</ LineC olor> <LineS ize>2</LineS ize> <V ol>false</V ol> <V alue>true</V alue> <V alueC olor>245;245;245</V alueC olor> <S how Range>true</S how Range> <Legend>true</Legend> <LegendS ty le>short</LegendS ty le> <F rame>false</F rame> <F illC olor>255;153;0</F illC olor> <Display Links>true</Display Links> <BgS tartC olor>0;0;100</BgS tartC olor> <BgE ndC olor>0;0;50</BgE ndC olor> <G radient>true</G radient> <BgS ty le>LargeG rid</BgS ty le> <G radientS ty le>F orw ardDiagonal</G radientS ty le> <ImgTy pe>P N G </ImgTy pe> </skin> <skin id="3"> <Width>700</Width> <H eight>400</H eight> <S ty le>line</S ty le> <G rid>true</G rid> <A llDay >false</A llDay > <P eriod>hourly </P eriod> <G ridWidth>1</G ridWidth> <G ridC olor>139;139;155</G ridC olor> <G ridS ty le>Dot</G ridS ty le> <F ont>1</F ont> <TextC olor>255;165;0</TextC olor> <LabelF ormat>N ame</LabelF ormat> <BorderWidth>1</BorderWidth> <BorderC olor>139;139;155</BorderC olor> <BorderS ty le>S olid</BorderS ty le> <LineC olor>255;153;0|207;47;10|105;105;105|237;157;38|201;99;167|93;171;56|138;86;44|155;128;168|14;156;151|173;153;61</ LineC olor> <LineS ize>2</LineS ize> <V ol>true</V ol> <V olC olor>0;51;255</V olC olor> <V olS ize>2</V olS ize> <V olLineS ize>5</V olLineS ize> <V alue>true</V alue> <V alueC olor>245;245;245</V alueC olor> <S how Range>true</S how Range> <Legend>true</Legend> <LegendS ty le>short</LegendS ty le> <F rame>false</F rame> <F illC olor>255;153;0</F illC olor> <Display Links>true</Display Links> <BgS tartC olor>0;0;100</BgS tartC olor> <BgE ndC olor>0;0;50</BgE ndC olor> <G radient>true</G radient> <BgS ty le>LargeG rid</BgS ty le> <G radientS ty le>F orw ardDiagonal</G radientS ty le> <ImgTy pe>P N G </ImgTy pe> </skin> <skin id="4"> <Width>500</Width> <H eight>400</H eight> <S ty le>ohlc</S ty le> <G rid>true</G rid> <A llDay >false</A llDay > <P eriod>daily </P eriod> <G ridWidth>1</G ridWidth> <G ridC olor>139;139;155</G ridC olor> <G ridS ty le>Dot</G ridS ty le> <F ont>1</F ont> <TextC olor>0;0;0</TextC olor> <LabelF ormat>S y mbol</LabelF ormat> <BorderWidth>1</BorderWidth> <BorderC olor>139;139;155</BorderC olor>

Web Views

821

<BorderS ty le>S olid</BorderS ty le> <LineC olor>0;0;0|207;47;10|105;105;105|237;157;38|201;99;167|93;171;56|138;86;44|155;128;168|14;156;151|173;153;61</ LineC olor> <LineS ize>0</LineS ize> <V ol>true</V ol> <V olC olor>255;0;0</V olC olor> <V olS ize>2</V olS ize> <V olLineS ize>0</V olLineS ize> <V alue>true</V alue> <V alueC olor>0;0;0</V alueC olor> <S how Range>true</S how Range> <Legend>true</Legend> <LegendS ty le>short</LegendS ty le> <F rame>false</F rame> <F illC olor>0;0;0</F illC olor> <Display Links>true</Display Links> <BgS tartC olor>204;255;255</BgS tartC olor> <BgE ndC olor>255;255;255</BgE ndC olor> <G radient>true</G radient> <BgS ty le>ZigZag</BgS ty le> <G radientS ty le>F orw ardDiagonal</G radientS ty le> <ImgTy pe>P N G </ImgTy pe> </skin> <skin id="5"> <Width>500</Width> <H eight>400</H eight> <S ty le>line</S ty le> <G rid>true</G rid> <A llDay >false</A llDay > <P eriod>daily </P eriod> <G ridWidth>1</G ridWidth> <G ridC olor>139;139;155</G ridC olor> <G ridS ty le>Dot</G ridS ty le> <F ont>1</F ont> <TextC olor>0;0;0</TextC olor> <LabelF ormat>S y mbol</LabelF ormat> <BorderWidth>1</BorderWidth> <BorderC olor>139;139;155</BorderC olor> <BorderS ty le>S olid</BorderS ty le> <LineC olor>255;0;0|207;47;10|105;105;105|237;157;38|201;99;167|93;171;56|138;86;44|155;128;168|14;156;151|173;153;61</ LineC olor> <LineS ize>2</LineS ize> <V ol>true</V ol> <V olC olor>255;255;255</V olC olor> <V olS ize>2</V olS ize> <V olLineS ize>0</V olLineS ize> <V alue>true</V alue> <V alueC olor>255;255;255</V alueC olor> <S how Range>true</S how Range> <Legend>true</Legend> <LegendS ty le>short</LegendS ty le> <F rame>false</F rame> <F illC olor>0;0;0</F illC olor> <Display Links>true</Display Links> <BgS tartC olor>255;255;255</BgS tartC olor> <BgE ndC olor>51;0;153</BgE ndC olor> <G radient>true</G radient> <BgS ty le>LargeG rid</BgS ty le> <G radientS ty le>V ertical</G radientS ty le> <ImgTy pe>P N G </ImgTy pe> </skin> <skin id="6"> <Width>500</Width> <H eight>400</H eight> <S ty le>ohlc</S ty le> <G rid>true</G rid> <A llDay >false</A llDay > <P eriod>daily </P eriod> <G ridWidth>1</G ridWidth> <G ridC olor>139;139;155</G ridC olor> <G ridS ty le>Dot</G ridS ty le> <F ont>3</F ont> <TextC olor>255;255;255</TextC olor> <LabelF ormat>N ame</LabelF ormat> <BorderWidth>1</BorderWidth> <BorderC olor>139;139;155</BorderC olor> <BorderS ty le>S olid</BorderS ty le>

822

TRKD API Developer's Guide

<LineC olor>255;165;0|207;47;10|105;105;105|237;157;38|201;99;167|93;171;56|138;86;44|155;128;168|14;156;151|173;153;61</ LineC olor> <LineS ize>2</LineS ize> <V ol>true</V ol> <V olC olor>255;69;0</V olC olor> <V olS ize>2</V olS ize> <V olLineS ize>5</V olLineS ize> <V alue>true</V alue> <V alueC olor>255;255;255</V alueC olor> <S how Range>true</S how Range> <Legend>true</Legend> <LegendS ty le>short</LegendS ty le> <F rame>false</F rame> <F illC olor>0;0;0</F illC olor> <Display Links>true</Display Links> <BgS tartC olor>51;51;0</BgS tartC olor> <BgE ndC olor>0;102;0</BgE ndC olor> <G radient>true</G radient> <BgS ty le>LightDow nw ardDiagonal</BgS ty le> <G radientS ty le>F orw ardDiagonal</G radientS ty le> <ImgTy pe>P N G </ImgTy pe> </skin> <skin id="7"> <Width>500</Width> <H eight>400</H eight> <S ty le>line</S ty le> <G rid>true</G rid> <A llDay >false</A llDay > <P eriod>daily </P eriod> <G ridWidth>1</G ridWidth> <G ridC olor>139;139;155</G ridC olor> <G ridS ty le>Dot</G ridS ty le> <F ont>1</F ont> <TextC olor>0;0;0</TextC olor> <LabelF ormat>S y mbol</LabelF ormat> <BorderWidth>1</BorderWidth> <BorderC olor>139;139;155</BorderC olor> <BorderS ty le>S olid</BorderS ty le> <LineC olor>255;0;0|207;47;10|105;105;105|237;157;38|201;99;167|93;171;56|138;86;44|155;128;168|14;156;151|173;153;61</ LineC olor> <LineS ize>2</LineS ize> <V ol>true</V ol> <V olC olor>51;0;153</V olC olor> <V olS ize>2</V olS ize> <V olLineS ize>2</V olLineS ize> <V alue>true</V alue> <V alueC olor>0;0;0</V alueC olor> <S how Range>true</S how Range> <Legend>true</Legend> <LegendS ty le>short</LegendS ty le> <F rame>false</F rame> <F illC olor>0;0;0</F illC olor> <Display Links>true</Display Links> <BgS tartC olor>255;255;255</BgS tartC olor> <BgE ndC olor>255;255;255</BgE ndC olor> <G radient>true</G radient> <BgS ty le>H orizontal</BgS ty le> <G radientS ty le>H orizontal</G radientS ty le> <ImgTy pe>P N G </ImgTy pe> </skin> <skin id="8"> <Width>500</Width> <H eight>400</H eight> <S ty le>pctcng</S ty le> <G rid>true</G rid> <A llDay >false</A llDay > <P eriod>daily </P eriod> <G ridWidth>1</G ridWidth> <G ridC olor>139;139;155</G ridC olor> <G ridS ty le>Dot</G ridS ty le> <F ont>1</F ont> <TextC olor>0;0;0</TextC olor> <LabelF ormat>S y mbol</LabelF ormat> <BorderWidth>1</BorderWidth> <BorderC olor>139;139;155</BorderC olor> <BorderS ty le>S olid</BorderS ty le> <LineC olor>0;102;0|207;47;10|105;105;105|237;157;38|201;99;167|93;171;56|138;86;44|155;128;168|14;156;151|173;153;61</

Web Views

823

LineC olor> <LineS ize>1</LineS ize> <V ol>true</V ol> <V olC olor>255;51;0</V olC olor> <V olS ize>2</V olS ize> <V olLineS ize>1</V olLineS ize> <V alue>true</V alue> <V alueC olor>0;51;0</V alueC olor> <S how Range>true</S how Range> <Legend>true</Legend> <LegendS ty le>short</LegendS ty le> <F rame>false</F rame> <F illC olor>0;0;0</F illC olor> <Display Links>true</Display Links> <BgS tartC olor>255;255;255</BgS tartC olor> <BgE ndC olor>255;255;255</BgE ndC olor> <G radient>true</G radient> <BgS ty le>H orizontal</BgS ty le> <G radientS ty le>H orizontal</G radientS ty le> <ImgTy pe>P N G </ImgTy pe> </skin> <skin id="9"> <Width>500</Width> <H eight>400</H eight> <S ty le>pctcng</S ty le> <G rid>true</G rid> <A llDay >false</A llDay > <P eriod>daily </P eriod> <G ridWidth>1</G ridWidth> <G ridC olor>139;139;155</G ridC olor> <G ridS ty le>Dot</G ridS ty le> <F ont>1</F ont> <TextC olor>255;255;255</TextC olor> <LabelF ormat>N ame</LabelF ormat> <BorderWidth>1</BorderWidth> <BorderC olor>139;139;155</BorderC olor> <BorderS ty le>S olid</BorderS ty le> <LineC olor>51;102;204|207;47;10|105;105;105|237;157;38|201;99;167|93;171;56|138;86;44|155;128;168|14;156;151| 173;153;61</LineC olor> <LineS ize>1</LineS ize> <V ol>true</V ol> <V olC olor>255;0;0</V olC olor> <V olS ize>3</V olS ize> <V olLineS ize>1</V olLineS ize> <V alue>true</V alue> <V alueC olor>255;255;255</V alueC olor> <S how Range>true</S how Range> <Legend>true</Legend> <LegendS ty le>short</LegendS ty le> <F rame>false</F rame> <F illC olor>0;0;0</F illC olor> <Display Links>true</Display Links> <BgS tartC olor>0;0;0</BgS tartC olor> <BgE ndC olor>255;255;255</BgE ndC olor> <G radient>true</G radient> <BgS ty le>H orizontal</BgS ty le> <G radientS ty le>H orizontal</G radientS ty le> <ImgTy pe>P N G </ImgTy pe> </skin> <skin id="10"> <Width>500</Width> <H eight>400</H eight> <S ty le>pctcng</S ty le> <G rid>true</G rid> <A llDay >false</A llDay > <P eriod>daily </P eriod> <G ridWidth>1</G ridWidth> <G ridC olor>139;139;155</G ridC olor> <G ridS ty le>Dot</G ridS ty le> <F ont>1</F ont> <TextC olor>0;0;0</TextC olor> <LabelF ormat>S y mbol</LabelF ormat> <BorderWidth>1</BorderWidth> <BorderC olor>139;139;155</BorderC olor> <BorderS ty le>S olid</BorderS ty le> <LineC olor>255;0;0|207;47;10|105;105;105|237;157;38|201;99;167|93;171;56|138;86;44|155;128;168|14;156;151|173;153;61</ LineC olor>

824

TRKD API Developer's Guide

<LineS ize>2</LineS ize> <V ol>true</V ol> <V olC olor>51;0;153</V olC olor> <V olS ize>2</V olS ize> <V olLineS ize>2</V olLineS ize> <V alue>true</V alue> <V alueC olor>0;0;0</V alueC olor> <S how Range>true</S how Range> <Legend>true</Legend> <LegendS ty le>short</LegendS ty le> <F rame>false</F rame> <F illC olor>0;0;0</F illC olor> <Display Links>true</Display Links> <BgS tartC olor>255;255;255</BgS tartC olor> <BgE ndC olor>204;255;255</BgE ndC olor> <G radient>true</G radient> <BgS ty le>H orizontal</BgS ty le> <G radientS ty le>F orw ardDiagonalC y cle</G radientS ty le> <ImgTy pe>P N G </ImgTy pe> </skin> <skin id="11"> <Width>500</Width> <H eight>400</H eight> <S ty le>line</S ty le> <G rid>true</G rid> <A llDay >false</A llDay > <P eriod>daily </P eriod> <G ridWidth>1</G ridWidth> <G ridC olor>139;139;155</G ridC olor> <G ridS ty le>Dot</G ridS ty le> <F ont>1</F ont> <TextC olor>0;0;0</TextC olor> <LabelF ormat>S y mbol</LabelF ormat> <BorderWidth>1</BorderWidth> <BorderC olor>139;139;155</BorderC olor> <BorderS ty le>S olid</BorderS ty le> <LineC olor>0;255;0|207;47;10|105;105;105|237;157;38|201;99;167|93;171;56|138;86;44|155;128;168|14;156;151|173;153;61</ LineC olor> <LineS ize>2</LineS ize> <V ol>true</V ol> <V olC olor>255;0;0</V olC olor> <V olS ize>2</V olS ize> <V olLineS ize>2</V olLineS ize> <V alue>true</V alue> <V alueC olor>192;192;192</V alueC olor> <S how Range>true</S how Range> <Legend>true</Legend> <LegendS ty le>short</LegendS ty le> <F rame>false</F rame> <F illC olor>0;0;0</F illC olor> <Display Links>true</Display Links> <BgS tartC olor>255;255;255</BgS tartC olor> <BgE ndC olor>0;0;0</BgE ndC olor> <G radient>true</G radient> <BgS ty le>H orizontal</BgS ty le> <G radientS ty le>V ertical</G radientS ty le> <ImgTy pe>P N G </ImgTy pe> </skin> <skin id="12"> <Width>500</Width> <H eight>400</H eight> <S ty le>pctcng</S ty le> <G rid>true</G rid> <A llDay >false</A llDay > <P eriod>daily </P eriod> <G ridWidth>1</G ridWidth> <G ridC olor>139;139;155</G ridC olor> <G ridS ty le>Dot</G ridS ty le> <F ont>1</F ont> <TextC olor>0;0;0</TextC olor> <LabelF ormat>S y mbol</LabelF ormat> <BorderWidth>1</BorderWidth> <BorderC olor>139;139;155</BorderC olor> <BorderS ty le>S olid</BorderS ty le> <LineC olor>0;102;0|207;47;10|105;105;105|237;157;38|201;99;167|93;171;56|138;86;44|155;128;168|14;156;151|173;153;61</ LineC olor> <LineS ize>1</LineS ize>

Web Views

825

<V ol>true</V ol> <V olC olor>255;51;0</V olC olor> <V olS ize>2</V olS ize> <V olLineS ize>1</V olLineS ize> <V alue>true</V alue> <V alueC olor>0;51;0</V alueC olor> <S how Range>true</S how Range> <Legend>true</Legend> <LegendS ty le>short</LegendS ty le> <F rame>false</F rame> <F illC olor>0;0;0</F illC olor> <Display Links>true</Display Links> <BgS tartC olor>255;255;255</BgS tartC olor> <BgE ndC olor>255;255;255</BgE ndC olor> <G radient>true</G radient> <BgS ty le>H orizontal</BgS ty le> <G radientS ty le>H orizontal</G radientS ty le> <ImgTy pe>P N G </ImgTy pe> </skin> <skin id="13"> <Width>500</Width> <H eight>400</H eight> <S ty le>pctcng</S ty le> <G rid>true</G rid> <A llDay >false</A llDay > <P eriod>daily </P eriod> <G ridWidth>1</G ridWidth> <G ridC olor>139;139;155</G ridC olor> <G ridS ty le>Dot</G ridS ty le> <F ont>1</F ont> <TextC olor>245;245;245</TextC olor> <LabelF ormat>S y mbol</LabelF ormat> <BorderWidth>1</BorderWidth> <BorderC olor>139;139;155</BorderC olor> <BorderS ty le>S olid</BorderS ty le> <LineC olor>255;0;0|207;47;10|105;105;105|237;157;38|201;99;167|93;171;56|138;86;44|155;128;168|14;156;151|173;153;61</ LineC olor> <LineS ize>0</LineS ize> <V ol>false</V ol> <V alue>true</V alue> <V alueC olor>245;245;245</V alueC olor> <S how Range>true</S how Range> <Legend>true</Legend> <LegendS ty le>short</LegendS ty le> <F rame>false</F rame> <F illC olor>0;0;0</F illC olor> <Display Links>true</Display Links> <BgS tartC olor>0;0;0</BgS tartC olor> <BgE ndC olor>255;255;255</BgE ndC olor> <G radient>true</G radient> <BgS ty le>LargeG rid</BgS ty le> <G radientS ty le>H orizontalC y cle</G radientS ty le> <ImgTy pe>P N G </ImgTy pe> </skin> <skin id="14"> <Width>500</Width> <H eight>400</H eight> <S ty le>candle</S ty le> <G rid>true</G rid> <A llDay >false</A llDay > <P eriod>daily </P eriod> <G ridWidth>1</G ridWidth> <G ridC olor>139;139;155</G ridC olor> <G ridS ty le>Dot</G ridS ty le> <F ont>1</F ont> <TextC olor>0;0;128</TextC olor> <LabelF ormat>N ame</LabelF ormat> <BorderWidth>1</BorderWidth> <BorderC olor>139;139;155</BorderC olor> <BorderS ty le>S olid</BorderS ty le> <LineC olor>0;0;255|207;47;10|105;105;105|237;157;38|201;99;167|93;171;56|138;86;44|155;128;168|14;156;151|173;153;61</ LineC olor> <LineS ize>0</LineS ize> <V ol>true</V ol> <V olC olor>0;153;255</V olC olor> <V olS ize>2</V olS ize> <V olLineS ize>1</V olLineS ize>

826

TRKD API Developer's Guide

<V alue>true</V alue> <V alueC olor>0;0;0</V alueC olor> <S how Range>true</S how Range> <Legend>true</Legend> <LegendS ty le>short</LegendS ty le> <F rame>false</F rame> <F illC olor>0;0;0</F illC olor> <Display Links>true</Display Links> <BgS tartC olor>255;255;255</BgS tartC olor> <BgE ndC olor>255;255;255</BgE ndC olor> <G radient>true</G radient> <BgS ty le>LargeG rid</BgS ty le> <G radientS ty le>F orw ardDiagonal</G radientS ty le> <ImgTy pe>P N G </ImgTy pe> </skin> <skin id="15"> <Width>500</Width> <H eight>400</H eight> <S ty le>ohlc</S ty le> <G rid>true</G rid> <A llDay >false</A llDay > <P eriod>daily </P eriod> <G ridWidth>1</G ridWidth> <G ridC olor>139;139;155</G ridC olor> <G ridS ty le>Dot</G ridS ty le> <F ont>1</F ont> <TextC olor>255;99;71</TextC olor> <LabelF ormat>N ame</LabelF ormat> <BorderWidth>1</BorderWidth> <BorderC olor>139;139;155</BorderC olor> <BorderS ty le>S olid</BorderS ty le> <LineC olor>255;0;0|207;47;10|105;105;105|237;157;38|201;99;167|93;171;56|138;86;44|155;128;168|14;156;151|173;153;61</ LineC olor> <LineS ize>0</LineS ize> <V ol>true</V ol> <V olC olor>255;0;0</V olC olor> <V olS ize>2</V olS ize> <V olLineS ize>2</V olLineS ize> <V alue>true</V alue> <V alueC olor>255;255;255</V alueC olor> <S how Range>true</S how Range> <Legend>true</Legend> <LegendS ty le>short</LegendS ty le> <F rame>false</F rame> <F illC olor>0;0;0</F illC olor> <Display Links>true</Display Links> <BgS tartC olor>60;0;0</BgS tartC olor> <BgE ndC olor>40;0;0</BgE ndC olor> <G radient>true</G radient> <BgS ty le>S olidDiamond</BgS ty le> <G radientS ty le>F orw ardDiagonal</G radientS ty le> <ImgTy pe>P N G </ImgTy pe> </skin> <skin id="16"> <Width>500</Width> <H eight>400</H eight> <S ty le>line</S ty le> <G rid>true</G rid> <A llDay >false</A llDay > <P eriod>daily </P eriod> <G ridWidth>1</G ridWidth> <G ridC olor>139;139;155</G ridC olor> <G ridS ty le>Dot</G ridS ty le> <F ont>1</F ont> <TextC olor>0;128;0</TextC olor> <LabelF ormat>S y mbol</LabelF ormat> <BorderWidth>1</BorderWidth> <BorderC olor>139;139;155</BorderC olor> <BorderS ty le>S olid</BorderS ty le> <LineC olor>0;0;255|207;47;10|105;105;105|237;157;38|201;99;167|93;171;56|138;86;44|155;128;168|14;156;151|173;153;61</ LineC olor> <LineS ize>2</LineS ize> <V alue>true</V alue> <V alueC olor>0;0;0</V alueC olor> <S how Range>true</S how Range> <Legend>true</Legend> <LegendS ty le>short</LegendS ty le>

Web Views

827

<F rame>false</F rame> <F illC olor>0;0;0</F illC olor> <Display Links>true</Display Links> <BgS tartC olor>255;204;255;204</BgS tartC olor> <BgE ndC olor>255;255;255</BgE ndC olor> <G radient>true</G radient> <BgS ty le>LargeG rid</BgS ty le> <G radientS ty le>V ertical</G radientS ty le> <ImgTy pe>P N G </ImgTy pe> </skin> <skin id="17"> <Width>600</Width> <H eight>600</H eight> <S ty le>line</S ty le> <G rid>true</G rid> <A llDay >false</A llDay > <P eriod>daily </P eriod> <G ridWidth>1</G ridWidth> <G ridC olor>139;139;155</G ridC olor> <G ridS ty le>Dot</G ridS ty le> <F ont>1</F ont> <TextC olor>0;0;0</TextC olor> <LabelF ormat>S y mbol</LabelF ormat> <BorderWidth>1</BorderWidth> <BorderC olor>139;139;155</BorderC olor> <BorderS ty le>S olid</BorderS ty le> <LineC olor>255;0;0|207;47;10|105;105;105|237;157;38|201;99;167|93;171;56|138;86;44|155;128;168|14;156;151|173;153;61</ LineC olor> <LineS ize>2</LineS ize> <V ol>true</V ol> <V olC olor>51;0;153</V olC olor> <V olS ize>1</V olS ize> <V olLineS ize>2</V olLineS ize> <V alue>true</V alue> <V alueC olor>0;0;0</V alueC olor> <S how Range>true</S how Range> <Legend>true</Legend> <LegendS ty le>short</LegendS ty le> <F rame>false</F rame> <F illC olor>0;0;0</F illC olor> <Display Links>true</Display Links> <BgS tartC olor>255;255;255</BgS tartC olor> <BgE ndC olor>255;255;255</BgE ndC olor> <G radient>true</G radient> <BgS ty le>H orizontal</BgS ty le> <G radientS ty le>H orizontal</G radientS ty le> <ImgTy pe>P N G </ImgTy pe> </skin> <skin id="18"> <Width>600</Width> <H eight>600</H eight> <S ty le>pctcng</S ty le> <G rid>true</G rid> <A llDay >false</A llDay > <P eriod>daily </P eriod> <G ridWidth>1</G ridWidth> <G ridC olor>139;139;155</G ridC olor> <G ridS ty le>Dot</G ridS ty le> <F ont>1</F ont> <TextC olor>245;245;245</TextC olor> <LabelF ormat>S y mbol</LabelF ormat> <BorderWidth>1</BorderWidth> <BorderC olor>139;139;155</BorderC olor> <BorderS ty le>S olid</BorderS ty le> <LineC olor>255;0;0|207;47;10|105;105;105|237;157;38|201;99;167|93;171;56|138;86;44|155;128;168|14;156;151|173;153;61</ LineC olor> <LineS ize>1</LineS ize> <V ol>false</V ol> <V alue>true</V alue> <V alueC olor>245;245;245</V alueC olor> <S how Range>true</S how Range> <Legend>true</Legend> <LegendS ty le>short</LegendS ty le> <F rame>false</F rame> <F illC olor>0;0;0</F illC olor> <Display Links>true</Display Links> <BgS tartC olor>0;0;0</BgS tartC olor>

828

TRKD API Developer's Guide

<BgE ndC olor>64;64;64</BgE ndC olor> <G radient>true</G radient> <BgS ty le>H orizontal</BgS ty le> <G radientS ty le>V erticalC y cle</G radientS ty le> <ImgTy pe>P N G </ImgTy pe> </skin> <skin id="19"> <Width>300</Width> <H eight>200</H eight> </skin> </skins>

Troubleshooting and Debugging Your Application

829

chapter 41

Troubleshooting and Debugging Your Application

In the case where you get SOAP faults which signify an error or a malformed request you can use the following information provided in the SOAP fault to determine the problem: Subcode: Subcode will give you the error value. Reason: A brief description of the error. MessageID: Each request has a MessageID which can be used by Thomson Reuters Support to see the original message . ClientErrorReference: Is a unique error ID logged by Thomson Reuters with additional debugging information. With the information above you can either find the problem yourself or contact Support and pass this information to them for further details and help. For information on contacting Support see section Contacting Support.

41.1

Interpreting SOAP Faults

TRKD API uses standard SOAP faults to signal errors. You can use the fault Subcode and Reason to interpret the fault. In the following example, the Subcode Security_UserNotEntitledForApp indicates that the user is not properly entitled. This fault also provides additional Reason description. XML Sample Request - SOAP Fault Example
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://w w w .reuters.com/api/2006/05/01/TokenM anagement_1.sv c</To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/TokenM anagement_1/ C reateImpersonationToken_1</A ction> <A uthorization xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1"> <A pplicationID>[A ppID]</A pplicationID> <Token>[Impersonation Token]</Token> </A uthorization> </H eader> <Body > <C reateImpersonationToken_Request_1 xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/TokenM anagement_1"> <E ffectiv eU sername>test@reuters.com</E ffectiv eU sername> </C reateImpersonationToken_Request_1> </Body > </E nv elope>

XML Sample Response - SOAP Fault Example

<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader> <a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" s:mustU nderstand="1">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/ rkd/F aults_1/F ault_1_Reply </a:A ction> <a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <s:F ault> <s:C ode> <s:V alue>s:Receiv er</s:V alue> <s:Subcode>

830

TRKD API Developer's Guide

<s:V alue>a:Secur ity_User NotEntitledFor A pp</s:V alue> </s:Subcode> </s:C ode> <s:Reason> <s:T ext xml:lang="en-US">User 'foo@ r euter s.com' is not entitled to make r equests on behalf of application id 'REUT ERSDEV '</s:T ext> </s:Reason> <s:Detail> <C lientE rrorReference xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/F aults_1"> <Timestamp>2007-03-23T21:39:24.443546Z</Timestamp> <E rrorReference>ec65919e4e9840339a7b467b253a7139</E rrorReference> <S erv erReference>C 9D8A 58A 87F A 58B773944E 3A E 6F 44C 39630272F DC 4D74032</S erv erReference> </C lientE rrorReference> </s:Detail> </s:F ault> </Body > </E nv elope>

41.2

The ClientErrorReference
Each TRKD SOAP fault contains a ClientErrorReference. Thomson Reuters logs each ErrorReference along with additional debugging information accessible by Thomson Reuters support staff. If you are unable to debug the problem based on the fault Subcode, contact Thomson Reuters support and include the ErrorReference. For additional information, see section Contacting Support. The following example shows a SOAP fault with the unique ErrorRefrence id that can be used by Thomson Reuters support to retrieve further information on error. XML Sample Response - SOAP Fault Example
<s:E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <s:H eader> <a:A ction xmlns="http://w w w .w 3.org/2005/08/addressing" s:mustU nderstand="1">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/ rkd/F aults_1/F ault_1_Reply </a:A ction> <a:RelatesTo xmlns="http://w w w .w 3.org/2005/08/addressing">[M essageID]</a:RelatesTo> </s:H eader> <s:Body > <s:F ault> <s:C ode> <s:V alue>s:Receiv er</s:V alue> <s:S ubcode> <s:V alue>a:S ecurity _U serN otE ntitledF orA pp</s:V alue> </s:S ubcode> </s:C ode> <s:Reason> <s:Text xml:lang="en-U S ">U ser 'foo@reuters.com' is not entitled to make requests on behalf of application id 'RE U TE RS DE V '</s: Text> </s:Reason> <s:Detail> <C lientE rrorReference xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/F aults_1"> <Timestamp>2007-03-23T21:39:24.443546Z</Timestamp> <Er r or Refer ence>ec6 5 9 1 9 e4 e9 8 4 0 3 3 9 a7 b4 6 7 b2 5 3 a7 1 3 9 </Er r or Refer ence> <S erv erReference>C 9D8A 58A 87F A 58B773944E 3A E 6F 44C 39630272F DC 4D74032</S erv erReference> </C lientE rrorReference> </s:Detail> </s:F ault> </Body > </E nv elope>

Troubleshooting and Debugging Your Application

831

41.3

Using MessageID
To help debug any problems that occur, your application should include a unique message identifier in the SOAP header of each request to the TRKD API. For example: XML Sample Request - Using MessageID
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/rkd/2006/05/01/S ignificantDev elopments_1.sv c</To> <M essageID xmlns="http://www.w3 .or g/2 0 0 5 /0 8 /addr essing">[ Unique M essage ID] </M essageID> ...

TRKD logs each message ID. TRKD also returns the message ID in the SOAP header of the response. For example: XML Sample Response - Using MessageID
<s:E nv elope xmlns:s="http://w w w .w 3.org/2003/05/soap-env elope" xmlns:a="http://w w w .w 3.org/2005/08/addressing"> <s:H eader> <a:A ction s:mustU nderstand="1">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/S ignificantDev elopments_1/ G etS ignificantDev elopments_1Response</a:A ction> <a:RelatesT o>[ Unique M essage ID] </a:RelatesT o> ...

Your application should log the message ID. When you contact Thomson Reuters for support (see section Contacting Support ), include the message ID in your problem description, along with: Your application identification string Your service user Your effective user The ClientErrorReference The SOAP request and response

41.4

Using Request Examples from Developer's Guide in the API Console

When using request examples from Developer's Guide in the API Console you do not need to include SOAP header into the request body, use the body itself. See an example of how it works with Create Service Token Request: Example in Developer's Guide: XML Sample Request
<E nv elope xmlns="http://w w w .w 3.org/2003/05/soap-env elope"> <H eader> <To xmlns="http://w w w .w 3.org/2005/08/addressing">https://api.rkd.reuters.com/api/2006/05/01/TokenM anagement_1.sv c/A nony mous</ To> <M essageID xmlns="http://w w w .w 3.org/2005/08/addressing">[U nique M essage ID]</M essageID> <A ction xmlns="http://w w w .w 3.org/2005/08/addressing">http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/TokenM anagement_1/ C reateS erv iceToken_1</A ction> </H eader> <Body > <C reateS erv iceToken_Request_1 xmlns:global="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1" xmlns="http:// w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/TokenM anagement_1"> <A pplicationID xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1">[A ppID]</A pplicationID> <U sername>[serv ice user]</U sername> <P assw ord>[passw ord]</P assw ord> </C reateS erv iceToken_Request_1> </Body > </E nv elope>

832

TRKD API Developer's Guide

To make this request in the API Console, you have to use ONLY the body of this request: XML Sample Request
<C reateS erv iceToken_Request_1 xmlns:global="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1" xmlns="http:// w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/TokenM anagement_1"> <A pplicationID xmlns="http://w w w .reuters.com/ns/2006/05/01/w ebserv ices/rkd/C ommon_1">[A ppID]</A pplicationID> <U sername>[serv ice user]</U sername> <P assw ord>[passw ord]</P assw ord> </C reateS erv iceToken_Request_1>

41.5

Contacting Support
If you are unable to debug your application, you can contact Thomson Reuters for help. To contact Thomson Reuters, log into the Customer Zone, navigate to the Thomson Reuters Knowledge Direct product page, and click Contact Us. Include as many details as possible. You must include: Your application identification string (AppID) (see section Understanding Application Identification Strings (appids)) Your service user (see section Understanding Service Users, Impersonation (Effective Users)) Your effective user (see section Understanding Service Users, Impersonation (Effective Users)) The Unique Message ID (see section Using MessageID) The ClientErrorReference included in the SOAP fault (see section ClientErrorReference) The SOAP request and response The Contact Us form generates a Thomson Reuters Service Request (SR), which guarantees prompt service and tracking from the Thomson Reuters Support Center.

Coding Examples

833

chapter 42

Coding Examples

The Thomson Reuters Knowledge Direct (TRKD) API does not require you to code using any particular technology platform or coding style. The following sections contain best-practices example snippets using C# and proxy classes generated by Microsofts svcutil. You can download client code examples from the Customer Zone, https://customers.reuters.com. Log in and navigate to the Thomson Reuters Knowledge Direct page, API delivery section.

42.1

Prerequisites
To run the examples in this chapter and the client code samples, you need the following: Microsoft Visual Studio .2005 Windows Communication Foundation (WCF) TRKD API web services rely on the WS-* standards. To properly manage these standards, you must be running the Microsoft Windows Communication Foundation (WCF) included as part of .NET Framework 3.0 (http://www.microsoft.com/ net/wcf.aspx). ServiceModel Metadata Utility Tool (svcutil) To generate proper proxy classes, you must use Microsofts ServiceModel Metadata Utility Tool (svcutil). Svcutil is part of the Windows SDK 6.0 (http://www.microsoft.com/downloads/details.aspx?FamilyId=C2B1E300-F358-4523-B479F53D234CDCCF&displaylang=en). Note that, after installation, svcutil is located in C:\Program Files\Microsoft SDKs\Windows\v6.0\Bin. Note: Older Microsoft tools like wsdl.exe and Visual Studio ASP.NET Add Web Reference do not create compatible proxy classes. Note: Currently, you can enhance Visual Studio 2005 with Extensions for .NET Framework 3.0. However, although these extensions include Add Service Reference, this UI does not provide access to features of svcutil required to create proper TRKD API proxy classes. SVCUTIL.EXE Issues When svcutil generates classes from the wsdl, it generates elements of messages with XmlSerializer but elements of faults with DataContract serializer. Fault complex types are generated twice, therefore generated code does not compile. Previously, 3.0.4219.0 version of svcutil was used in the project. 3.0.4506.2152 is the correct version of svcutil. It is the version that is shipped with Visual Studio 2008 SP1. If you do not have Visual Studio 2008 on your machine, svcutil.exe is also available from the latest version of Windows SDK v6.0A. You can find more details about this issue here: http://connect.microsoft.com/wcf/feedback/ViewFeedback.aspx? FeedbackID=424733 In the article Visual Studio Product Team replied: While this specific issue has not yet been fixed in more recent .NET Framework versions, 3.5 SP1 did add the ability to generate faults with XmlSerializer. If you are able to upgrade to .NET Framework 3.5 SP1 (or 3.0 SP2) then you can pass the /useSerializerForFaults switch to svcutil. This will cause only XmlSerializer types to be generated, and so will eliminate this issue.

42.2

Working with the Client Code Samples

You can download client code samples from the Customer Zone. Log in and navigate to the Thomson Reuters Knowledge Direct page, API delivery section. Each code sample contains code you can build and run in your own development environment. Each code samples is either a console application or a web application. These code samples demonstrate best

834

TRKD API Developer's Guide

practices for the basic manipulation of TRKD API services.

42.2.1 Installing a Code Sample

To install a code sample, simply download and unzip the sample into a working directory in your development environment. For example:

42.2.2 Building a Code Sample

Load the client code sample in Microsoft Visual Studio by double-clicking the corresponding Samples.sln. Build the sample like any other solution, with Build -> Build Solution (or F6).

42.2.3 Running a Code Sample

You can run a client sample in Debug mode within Visual Studio like any other solution, with Debug -> Start Debugging. You can also run the client sample (outside of the debugger) by double-clicking the executable. Note: The first step is to create a Service Token, the second step is to perform the appropriate service request. Client sample for web application:

Coding Examples

835

42.3

Creating Your Own Client Application

This section provides the information on how to build your own client application.

42.3.1 Using Generated Proxy Classes

Each TRKD service publishes its metadata using a WSDL document. This WSDL can be used by appropriate tools to generate proxy classes which are able to communicate with TRKD services.

42.3.1.1 Downloading XSDs and WSDLs

To generate client proxy classes, you must have an instance of all required XSD and WSDL documents locally. You can download these documents for the TRKD API servers. To keep your code as simple as possible, Thomson Reuters recommends only downloading XSDs and WSDLs for the services your application requires. For example, do not download and generate proxies from News_1_HttpAndRKDToken.wsdl if your application only displays Earning Estimates. All TRKD API client applications require TokenManagement_1, so you will always need: http://api.rkd.reuters.com/schemas/TokenManagement_1.xsd http://api.rkd.reuters.com/schemas/wsdl/TokenManagement_1_HttpsAndAnonymous.wsdl as well as the shared http://api.rkd.reuters.com/schemas/Cache_1.xsd http://api.rkd.reuters.com/schemas/Common_1.xsd http://api.rkd.reuters.com/schemas/Faults_1.xsd In addition, download the XSD(s) and WSDL(s) for the services your application will use. For example, Times Series requires: http://api.rkd.reuters.com/schemas/TimeSeries_1.xsd http://api.rkd.reuters.com/schemas/wsdl/TimeSeries_1_HttpAndRKDToken.wsdl

836

TRKD API Developer's Guide

42.3.2 Generating Proxy Classes

Use Microsofts ServiceModel Metadata Utility Tool (svcutil) to generate you proxy classes (see section Prerequisites). Since TRKD API services use common XML types, you can use the type sharing of feature of svcutil. From the command line, run: svcutil <local_folder>\*.xsd <local_folder>\*.wsdl /out:<output file name> where <local_folder> where you downloaded the XSD and WSDL documents. This command generates proxy classes and output.config files you can include in your Visual Studio project. In addition, you can simplify your code by using svcutil to map XML namespace to CLR namespaces. For example: svcutil <local_folder>\*.xsd <local_folder>\*.wsdl /out:RkdProxyClasses.cs /n:http://www.reuters.com/ns/2006/05/01/ webservices/rkd/Admin_1,ReutersKnowledge.Api.Admin_1 /n:http://www.reuters.com/ns/2006/05/01/webservices/rkd/ Common_1,ReutersKnowledge.Api.Common_1 /n:http://www.reuters.com/ns/2006/05/01/webservices/rkd/TokenManagement_1,ReutersKnowledge.Api. TokenManagement_1 Note: You must download the schemas which are included by reference in the schemas for the individual methods (for example TokenManagement_1.xsd includes Common_1.xsd) otherwise you might get the 'Cannot import wsdl:portType' error occurs when you try to generate proxy classes using svcutil utility without downloading all the schemas.

42.3.3 Creating a Service Token

Use TokenManagement_1Client to create a service token.
ITokenM anagement_1 tokenM anagementC lient = new TokenM anagement_1C lient(); C reateS erv iceToken_Request_1 innerRequest = new C reateS erv iceToken_Request_1(); C reateS erv iceToken_1_RequestM essage serv iceTokenRequest = new C reateS erv iceToken_1_RequestM essage(); innerRequest.A pplicationID = applicationID; innerRequest.U sername = serv iceuser; innerRequest.P assw ord = passw ord; serv iceTokenRequest.C reateS erv iceToken_Request_1 = innerRequest; C reateS erv iceToken_1_ResponseM essage serv iceTokenResponseM essage = tokenM anagementC lient.C reateS erv iceToken_1(serv iceTokenRequest);

Use the token to populate the AuthorizationType object required for data requests:
authorization = new A uthorizationTy pe(); authorization.A pplicationID = applicationID; authorization.Token = serv iceTokenResponseM essage.C reateS erv iceToken_Response_1.Token;

42.3.4 Caching Tokens and Handling Token Expiration

Since tokens are valid for 90 minutes, you should code your application to continue to use the token until it expires, rather than requesting a new token with each data request. When a token expires, TRKD API generates a FaultException with the message "Token expired." Use this as a signal to get a new token. In addition, the message Token is invalid indicates an (unlikely) condition where the token is corrupted. In this case, your application should get a new token. For example:
try { return S endG etTimeS eriesRequest(tm.authorization, timeS eriesInnerRequest, timeS eriesC lient); } catch (F aultE xception<C lientE rrorReference> tsF ault) { // F or an expired token or inv alid token, create an new token and // try again. if ((tsF ault.M essage.E quals(TokenE xpiredM essage))

Coding Examples

837

|| (tsF ault.M essage.E quals(TokenInv alidM essage))) { tm.createS erv iceToken(appID, user, pass, true); return S endG etTimeS eriesRequest(tm.authorization, timeS eriesInnerRequest, timeS eriesC lient); } else { throw ; } }

42.3.5 Using MessageID

To help debug any problems that occur, your application should include a unique message identifier in the SOAP header of each request to TRKD API. Your application should log the message ID. For example:
using (new O perationC ontextS cope(((TokenM anagement_1C lient)tokenM anagementC lient).InnerC hannel)) { G uid msgId = G uid.N ew G uid(); O perationC ontext.C urrent.O utgoingM essageH eaders.M essageId = new U niqueId(msgId); DebugLog.addRecord("C reateS erv iceToken_Request_1", msgId.ToS tring(), DateTime.N ow .ToS tring()); try { C reateS erv iceToken_1_ResponseM essage serv iceTokenResponseM essage = tokenM anagementC lient.C reateS erv iceToken_1(serv iceTokenRequest);

When you contact Thomson Reuters for support, include the message ID in your problem description.

42.3.6 Handling Errors (Faults)

TRKD API services return errors to your application as SOAP faults. In most cases, you can use the fault message to trigger an appropriate message to the client or other appropriate handling. Each TRKD API SOAP fault includes ClientErrorReference. Thomson Reuters logs each ErrorReference along with additional debugging information accessible by Thomson Reuters support staff. As part of your error handling, your application should log the ClientErrorReference as well as the MessageID (which uniquely maps the response to the request). For example:
catch (F aultE xception<C lientE rrorReference> tmsF ault) { // Log the C lientReferenceID and M essageID E rrorLog.addRecord(tmsF ault.Detail.E rrorReference, (string)tmsF ault.Data[RelatesToH eader], tmsF ault.M essage, DateTime.N ow .ToS tring()); if (tmsF ault.M essage.E quals("Inv alid user name or passw ord.")) { C onsole.WriteLine("P lease enter a v alid user name and passw ord."); } else { // U nexpected error authenticating. Trigger some monitoring //alert and tell the client to try again later. C onsole.WriteLine("P lease try again later. M essage is: " + tmsF ault.M essage); } }

When you contact Thomson Reuters for support, include the ErrorRefernce and message ID in your problem description.

838

TRKD API Developer's Guide

42.3.7 Overriding Server Certificate Validation

In certain situations, you may find it helpful to override the server certificate validation procedure.
S erv iceP ointM anager.S erv erC ertificateV alidationC allback = new RemoteC ertificateV alidationC allback(true);

This code forces the client application to accept every certificate that the server provides. This method weakens the security of the application because the authentication of the server is bypassed. To safely work around this problem, make sure that the certificate of the server contains the expected name before you allow the connection to continue. For additional information, see http://support.microsoft.com/default.aspx?scid=kb%3BEN-US%3B823177.

42.3.8 Supporting Responses Larger than 65,536 Bytes

To guard against Denial of Service attacks, the app.config for proxy classes generated with Microsofts svcutil.exe default to a limit of 65,536 bytes for response messages. See http://msdn2.microsoft.com/en-us/library/ms733135.aspx. Since many TRKD API services (for example, Estimates_1) can return more than 65,536 bytes, you must modify this default. For an TRKD API client, use the maximum value of 2 GB by setting maxReceivedMessageSize="268435456" in app.config.

42.3.9 Connecting to TRKD API Servers Being behind a Proxy

If you are behind a proxy and try to connect to TRKD API servers using the "app.config" file from the code samples provided by Thomson Reuters, keep in mind that your system may not be properly configured to use the auto-configured proxy. As a result, you may experience problems while connecting to our servers and get the following error:
"C reating new token...F ailed to create new token. Reason: C ould not connect to https://api.rkd.reuters.com/api/2006/05/01/ TokenM anagement_1.sv c/A nony mous. TC P error code 10060: A connection attempt failed because the connected party did not properly respond after a period of time, or established connection failed because connected host has failed to respond 159.220.40.240:443"

To solve this problem, you have to modify app.config. Find the following line in the code:

useDefaultWebProxy="true"
and replace it with the following:

proxyAddress="[your.proxy.server]" useDefaultWebProxy="false"

42.4

Debugging Request/Response Problems

Integrated Development Environments (IDEs) like Visual Studio and generated proxy classes hide (intentionally) the details of the actual SOAP messages to and from web services. This abstraction generally speeds application development, but it can sometimes make it difficult to understand why particular requests are failing. Also, since TRKD API does not require clients to use specific technologies, our Support team requires SOAP request and response examples to debug problems. Seeing the actual SOAP requests and responses can also help you compare your application behavior to SOAP messages generated by the TRKD API support tools, Request Builder and API Console (to access the support tools, visit the Customer Zone, https://customers.reuters.com. Log in and navigate to the Thomson Reuters Knowledge Direct page, API delivery section). You can use a protocol analyzer (commonly called a sniffer) to see the actual SOAP requests and responses your application is forming. For example, Ethereal (www.ethereal.com) is free protocol analyzer software, under the GNU General Public License.

Coding Examples

839

840

TRKD API Developer's Guide

chapter 43

Building Java TRKD Client

Each TRKD service publishes its metadata using WSDL. This WSDL can be used by appropriate tools to generate Java proxy classes which are able to communicate with TRKD services. This chapter describes how you can generate Java code for TRKD proxy classes using Sun Metro framework tools.

43.1

TRKD Metadata
For each service TRKD has XML schema which defines request/response XML types. These schemas may reference other schemas which reside at the same location. Each TRKD service may contain several operations. Each operation may be exposed via several different bindings. In order to prevent name conflicts TRKD provides one WSDL file per service binding. I.e. a single WSDL contains service operations exposed via the same binding. In regard to this WSDL file names and target namespaces are appended with the binding name.

43.1.1 Naming Rules

Artifact Rule XML schema file name Format: <ServiceName>_<ServiceVersion>.xsd Example: TokenManagement_1.xsd XML schema target Format: http://www.reuters.com/ns/<DateStamp>/webservices/rkd/ namespace < Serv iceName> _< Serv iceVersion> Example: http://www.reuters.com/ns/2006/05/01/webservices/rkd/TokenManagement_1 WSDL file name Format: <ServiceName>_<ServiceVersion>_<EndpointBinding>.wsdl Example: TokenManagement_1_HttpAndAnonymous.wsdl WSDL target Format: http://www.reuters.com/ns/<DateStamp>/webservices/rkd/ namespace < Serv iceName> _< Serv iceVersion> /< EndpointBinding> Example: http://www.reuters.com/ns/2006/05/01/webservices/rkd/TokenManagement_1/ HttpAndAnonymous

43.1.2 Supported Bindings

Name HttpsAndAnony mous HttpAndRKDToke n Description Transport HTTPS No authentication Transport HTTP TRKD token in SOAP header for authentication

43.1.3 Metada Files Location

XML schemas are available at http://<RKD_ServerName>/schemas. For Search-* services at http://<RKD_ServerName>/ schemas/Search. WSDLs are available at http://<RKD_ServerName>/schemas/wsdl. For Search-* services at http://<RKD_ServerName>/ schemas/wsdl/Search.

Building Java TRKD Client

841

43.2

Prerequisites
This section lists the software you need to install.

43.2.1 Sun JDK

Please download and install Sun JDK version 1.5 or higher from the download page. After that please create environment system variable JAVA_HOME, set it to Sun JDK installation and add %JAVA_HOME%\bin to Path environment system variable.

43.2.2 Framework
You need to use Sun Metro framework: Please download Sun Metro from the site we recommend version 1.4 or higher and follow the installation instructions. After that please create environment system variable METRO_HOME, set it to Sun Metro installation and add % METRO_HOME%\bin to Path environment system variable. Note: If you are using Sun JDK 1.6 up to Update Release 3 please copy webservices-api.jar to %JAVA_HOME%/jre/lib/ endorsed from %METRO_HOME%\lib. It is necessary because Metro tools use JAX-WS which version is newer than the one bundled with JDK 1.6. Please ignore this note for Update Release 4 or later of Sun JDK 1.6. More details are available here.

43.2.3 Apache Ant

Please download Apache Ant 1.6.5 or higher from this site and follow the installation instructions. After that please create environment system variable ANT_HOME, set it to Apache Ant installation directory and add %ANT_HOME%\bin to Path environment system variable.

43.2.4 Eclipse
We recommend downloading Eclipse Ganymede 3.4.0 or higher from the site and installing it according to the installation instructions.

43.3

Generating Java Proxy Code

This chapter provides detailed instructions on how to generate Java proxy code using Sun Metro framework tool.

43.3.1 Using Wsimport Utility Tool Ant Task from Sun Metro Framework
The Wsimport Utility Tool is a part of Sun Metro Framework and is used to generate generates JAX-WS portable artifacts from wsdl file. We recommend using Wsimport Ant task: https://metro.dev.java.net/nonav/1.3/docs/wsimportant.html

43.3.1.1 TRKD Java Classes for TRKD Services

The following Ant script generates client code for a particular TRKD service (in this case for TokenManagement_1_HttpsAndAnonymous.wsdl) please create build.xml file with the content as below: XML Sample

<?xml v ersion="1.0"?> <project default="build" basedir="."> <record name="build.log" loglev el="v erbose"/> <property env ironment="env "/> <path id="class.path">

842

TRKD API Developer's Guide

<fileset dir="$ {env .M E TRO _H O M E }\lib\" includes="* .jar"/> </path> <target name="build"> <taskdef name="w simport" classname="com.sun.tools.w s.ant.WsImport" classpathref="class.path"/> <property name="w sdl" v alue="http://api.rkd.reuters.com/schemas/w sdl/TokenM anagement_1_H ttpsA ndA nony mous.w sdl"/> <w simport w sdl="$ {w sdl}" sourcedestdir="src" xnocompile="true" extension="true" v erbose="true"> <binding dir="$ {basedir}/etc" includes="* .xml" /> </w simport> </target> </project>

This will generate corresponding Java files which you can include in your Eclipse project and use generated proxy class in your application. Lets describe some things in the script: <fileset dir="${env.METRO_HOME}\lib\" includes="*.jar"/> - specifies to get Java library jar files from the location which is set in the environment variable METRO_HOME <taskdef name="wsimport" classname="com.sun.tools.ws.ant.WsImport" classpathref="class.path"/> specifies Java class where Wsimport Ant task is implemented. <property name="wsdl" value="http://api.rkd.reuters.com/schemas/wsdl/ TokenManagement_1_HttpsAndAnonymous.wsdl"/> - specifies WSDL url.
<w simport w sdl="$ {w sdl}" sourcedestdir="src" xnocompile="true" extension="true" v erbose="true"> <binding dir="$ {basedir}/etc" includes="* .xml" /> </w simport>

wsdl="${wsdl}" - specifies WSDL url declared before. sourcedestdir="src" - specifies the directory where generated Java classes will be put. xnocompile="true" - specifies to not compile Java classes. extension="true" - specifies to use extension for SOAP bindings (required for RKD services). verbose="true" - specifies detailed level of messages produced by Ant task <binding dir="${basedir}/etc" includes="*.xml" /> - specifies the directory where binding files necessary for generating proper Java package names are located (please read the next subsection for details on these files)

43.3.1.2 Generating Proper Java Package Names

Generally, you can customize Java package names via Metro Web Service Stack WSDL Customization (documentation available here). In case of external xsd files imported to wsdl use external JAXB-binding files in order to map namespaces to Java package names. Example (imported-schemas.xml)

<?xml v ersion="1.0" encoding="U TF -8"?> <jaxb:bindings jaxb:v ersion="2.0" xmlns:jaxb="http://jav a.sun.com/xml/ns/jaxb" xmlns:xs="http://w w w .w 3.org/2001/XM LS chema"> <jaxb:bindings schemaLocation="http://api.rkd.reuters.com/schemas/TokenM anagement_1.xsd" node="/xs:schema"> <jaxb:schemaBindings> <jaxb:package name="com.reuters.w ebserv ice.rkd.token"/> </jaxb:schemaBindings> </jaxb:bindings> <jaxb:bindings schemaLocation="http://api.rkd.reuters.com/schemas/F aults_1.xsd" node="/xs:schema"> <jaxb:schemaBindings> <jaxb:package name="com.reuters.w ebserv ice.rkd.exceptions"/>

Building Java TRKD Client

843

</jaxb:schemaBindings> </jaxb:bindings> <jaxb:bindings schemaLocation="http://api.rkd.reuters.com/schemas/S erialization_200310.xsd" node="/xs:schema"> <jaxb:schemaBindings> <jaxb:package name="com.microsoft.schemas.serialization"/> </jaxb:schemaBindings> </jaxb:bindings> <jaxb:bindings schemaLocation="http://api.rkd.reuters.com/schemas/C ache_1.xsd" node="/xs:schema"> <jaxb:schemaBindings> <jaxb:package name="com.reuters.w ebserv ice.rkd.cache"/> </jaxb:schemaBindings> </jaxb:bindings> <jaxb:bindings schemaLocation="http://api.rkd.reuters.com/schemas/C ommon_1.xsd" node="/xs:schema"> <jaxb:schemaBindings> <jaxb:package name="com.reuters.w ebserv ice.rkd.common"/> </jaxb:schemaBindings> </jaxb:bindings> </jaxb:bindings>

In the example above the schemaLocation attribute in the 'jaxb:bindings' tag specifies external schema location and name attribute in the 'jaxb-package' tag specifies Java package name you want to specify for this schema. In case external types are declared in wsdl use external jaxws:bindings files in order to map namespaces to Java package names. Example (inline-schema.xml)

<jaxw s:bindings w sdlLocation="http://api.rkd.reuters.com/schemas/w sdl/TokenM anagement_1_H ttpsA ndA nony mous.w sdl" xmlns:xsd="http://w w w .w 3.org/2001/XM LS chema" xmlns:jaxb="http://jav a.sun.com/xml/ns/jaxb" xmlns:w sdl="http://schemas.xmlsoap.org/w sdl/" xmlns:jaxw s="http://jav a.sun.com/xml/ns/jaxw s"> <jaxw s:package name="com.reuters.w ebserv ice.rkd.token.https"/> </jaxw s:bindings>

In the example above the wsdlLocation attribute in the jaxws-bindings element specifies wsdl url and name attribute in the jasws:package element specifies Java package name you want to specify for types declared in wsdl (actually map targetNamespace attribute of wsdl to selected Java package).

43.3.1.3 Running Ant Script

Please create a subdirectory for the generated Java source code ("src" in our case) in the directory where you placed your Ant build.xml file. After that open command line in the directory where build.xml is located and run the following command:
ant

You should get something like this (make sure build is successful in case of errors please check build.log file located in the same directory):

844

TRKD API Developer's Guide

43.4

Creating Eclipse Project Based on Java Files Generated by Wsimport Ant Task Using Sun Metro Framework
First, create a new Java project: File->New->Other:

Building Java TRKD Client

845

In the next wizard window select Java Project and click the "Next >" button:

846

TRKD API Developer's Guide

Then enter project name and click the "Next >" button:

Building Java TRKD Client

847

In the next window select Libraries tab (we need to create Sun Metro library and add it to the project) click the "Add Library" button:

848

TRKD API Developer's Guide

Then select "User Library" and click the "Next >" button:

Building Java TRKD Client

849

In the new window click the "User Libraries" button:

850

TRKD API Developer's Guide

Then in the next wizard dialog click the "New" button in order to create a new library:

Building Java TRKD Client

851

Enter library name:

The new library will be added:

852

TRKD API Developer's Guide

Then please make sure it is selected in the dialog and click the "Add JARs" button. Add all jar-files which are usually located in the lib subdirectory of your Sun Metro installation:

Building Java TRKD Client

853

You will see on the next screen that jar-files were added click the "OK" button.

854

TRKD API Developer's Guide

On the next screen, make sure your new library is selected and click the "Finish" button.

Building Java TRKD Client

855

As a result, Sun Metro jar-files will be available in your project:

856

TRKD API Developer's Guide

After that you need to copy the generated Java source code to the new Eclipse project. Please do the following: 1. Copy the directory in Windows Explorer as on the picture given below:

Building Java TRKD Client

857

2. Then paste it directly into Eclipse workspace into source code directory ("src" in our case):

858

TRKD API Developer's Guide

Source code must appear in Eclipse project preparation has finished now.

43.5

Creating Java Client Application for Webservice Access in Eclipse Project

It is assumed that the project described in the previous section has been created. If not, please create it according to the instructions given in the corresponding chapter. Now select the source code directory of the project in Eclipse as shown on the picture below:

Building Java TRKD Client

859

Then select New->Class in the menu:

In the new window please specify a package name for the new class (com.reuters.webservice.rkd.client in our case) and select the "public static void main (String[] args)" check box in "Which method stubs would you like to create?" and click the "Finish" button:

860

TRKD API Developer's Guide

You can enter you client code now (at the moment you can enter client code sample from the next section).

43.6

Client Code Sample

This section provides client code samples.

43.6.1 Sun Metro

Sun Metro Code Sample

package com.reuters.w ebserv ice.rkd.client; import import import import import jav a.io.BufferedReader; jav a.io.IO E xception; jav a.io.InputS treamReader; jav a.io.S tringReader; jav ax.xml.w s.soap.A ddressingF eature;

import org.xml.sax.InputS ource;

Building Java TRKD Client

861

import org.xml.sax.S A XE xception; import com.reuters.w ebserv ice.rkd.token.C reateImpersonationTokenRequest2; import com.reuters.w ebserv ice.rkd.token.C reateS erv iceTokenRequest1; import com.reuters.w ebserv ice.rkd.token.C reateTokenResponse; import com.reuters.w ebserv ice.rkd.token.E ffectiv eU sernameTy pe; import com.reuters.w ebserv ice.rkd.token.https.ITokenM anagement1; import com.reuters.w ebserv ice.rkd.token.https. ITokenM anagement1H ttpsA ndA nony mousITokenM anagement1H ttpsA ndA nony mousC reateImpersonationToken2C lientE rrorReferenceF aultM es sage; import com.reuters.w ebserv ice.rkd.token.https. ITokenM anagement1ITokenM anagement1H ttpsA ndA nony mousC reateS erv iceToken1C lientE rrorReferenceF aultM essage; import com.reuters.w ebserv ice.rkd.token.https.TokenM anagement1; import com.sun.org.apache.xerces.internal.parsers.DO M P arser; import com.sun.xml.w s.dev eloper.WS BindingP rov ider; import com.sun.xml.w s.messagedump.M essageDumpingF eature; public class H ttpsA ndA nony mous_M etroC lient { /* * * @param args */ public static v oid main(S tring[] args) { S y stem.out.println("H ttpsA ndA nony mous_M etroC lient start"); // create the serv ice TokenM anagement1 serv ice = new TokenM anagement1(); // P repare to plug in the code that allow s to read S O A P messages M essageDumpingF eature messageDumper = new M essageDumpingF eature(); // get the port ITokenM anagement1 port = serv ice .getH ttpsA ndA nony mousITokenM anagement1H ttpsA ndA nony mous( new A ddressingF eature(true), messageDumper); // enter serv ice user credentials // open up standard input BufferedReader br = new BufferedReader(new InputS treamReader(S y stem.in)); S tring serv iceU serN ame = null; S tring serv iceU serP assw ord = null; S tring serv iceU serA pplicationID = null; try { S y stem.out.println("P lease enter serv ice username: "); serv iceU serN ame = br.readLine(); S y stem.out.println("P lease enter serv ice user passw ord: "); serv iceU serP assw ord = br.readLine(); S y stem.out.println("P lease enter application ID: "); serv iceU serA pplicationID = br.readLine(); } catch (IO E xception ioe) { S y stem.out.println("IO error try ing to read serv ice user credentials!"); S y stem.exit(1); } // creating serv ice token S y stem.out.println("C reating serv ice token..."); C reateS erv iceTokenRequest1 request = new C reateS erv iceTokenRequest1(); C reateTokenResponse response; request.setA pplicationID(serv iceU serA pplicationID); request.setP assw ord(serv iceU serP assw ord); request.setU sername(serv iceU serN ame); try { response = port.createS erv iceToken1(request); S y stem.out.println("S oap request message: "); S y stem.out.println(messageDumper.nextM essage()); S y stem.out.println("S oap response message: "); S y stem.out.println(messageDumper.nextM essage());

862

TRKD API Developer's Guide

S y stem.out.println("S erv ice token created successfully . V alid till: " + response.getE xpiration().toS tring()); S y stem.out.println("Is v alid now : "+ response.getE xpiration().isV alid()); } catch (ITokenM anagement1ITokenM anagement1H ttpsA ndA nony mousC reateS erv iceToken1C lientE rrorReferenceF aultM essage e) { S y stem.out.println("S oap request message: "); S y stem.out.println(messageDumper.nextM essage()); S tring soapResponse = messageDumper.nextM essage(); S y stem.out.println("S oap response message: "); S y stem.out.println(soapResponse); try { DO M P arser parser = new DO M P arser(); parser.parse(new InputS ource(new S tringReader(soapResponse))); } catch (IO E xception ioE x) { ioE x.printS tackTrace(); } catch (S A XE xception saxE x) { saxE x.printS tackTrace(); } S y stem.out .println("S erv ice token error message: " + e.getM essage()); S y stem.out.println(e.getF aultInfo()); S y stem.out.println("S erv ice token error reference " + e.getF aultInfo().getE rrorReference()); S y stem.out.println("S erv ice token serv er reference " + e.getF aultInfo().getS erv erReference()); } S tring effectiv eU serN ame = null; try { S y stem.out.println("P lease enter effectiv e username: "); effectiv eU serN ame = br.readLine(); } catch (IO E xception ioe) { S y stem.out.println("IO error try ing to read effectiv e user name!"); S y stem.exit(1); } // creating impersonation token S y stem.out.println("C reating impersonation token..."); C reateImpersonationTokenRequest2 impersonationRequest = new C reateImpersonationTokenRequest2(); impersonationRequest.setA pplicationID(serv iceU serA pplicationID); impersonationRequest.setP assw ord(serv iceU serP assw ord); impersonationRequest.setU sername(serv iceU serN ame); E ffectiv eU sernameTy pe effectiv eU ser = new E ffectiv eU sernameTy pe(); effectiv eU ser.setV alue(effectiv eU serN ame); impersonationRequest.setE ffectiv eU sername(effectiv eU ser); try { response = port.createImpersonationToken2(impersonationRequest); S y stem.out.println("Impersonation token created successfully . V alid till: " + response.getE xpiration().toS tring()); S y stem.out.println("Is v alid now : "+ response.getE xpiration().isV alid()); } catch (ITokenM anagement1H ttpsA ndA nony mousITokenM anagement1H ttpsA ndA nony mousC reateImpersonationToken2C lientE rrorReference F aultM essage e) { S y stem.out.println("Impersonation token error message: "+ e.getM essage()); S y stem.out.println("Impersonation token error reference "+ e.getF aultInfo().getE rrorReference()); S y stem.out.println("Impersonation token serv er reference "+ e.getF aultInfo().getS erv erReference()); } S y stem.out.println("H ttpsA ndA nony mous_M etroC lient finish"); }

Building Java TRKD Client

863

In this code example we get service token and impersonation token. Lets describe the code in more details:
TokenM anagement1 serv ice = new TokenM anagement1();

Here we instantiate service which will be used later in order to get Java proxy class.
ITokenM anagement1 port = serv ice .getH ttpsA ndA nony mousITokenM anagement1H ttpsA ndA nony mous(new A ddressingF eature(tr ue ));

Here we get Java proxy class via a service instance. Please pay attention to the AddressingFeature class it is recommended to pass it to proxy on the client side in order to make sure the WS-Addressing feature (which is required for TRKD services access) is supported on the client side. More information on WS-Addressing support for Java clients is available here.
S tring serv iceU serN ame = null; S tring serv iceU serP assw ord = null; S tring serv iceU serA pplicationID = null; try { S y stem.out.println("P lease enter serv ice username: "); serv iceU serN ame = br.readLine(); S y stem.out.println("P lease enter serv ice user passw ord: "); serv iceU serP assw ord = br.readLine(); S y stem.out.println("P lease enter application ID: "); serv iceU serA pplicationID = br.readLine(); } catch (IO E xception ioe) { S y stem.out.println("IO error try ing to read serv ice user credentials!"); S y stem.exit(1); }

Here we read service username, password and application ID via command line.
C reateS erv iceTokenRequest1 request = new C reateS erv iceTokenRequest1(); C reateTokenResponse response; request.setA pplicationID(serv iceU serA pplicationID); request.setP assw ord(serv iceU serP assw ord); request.setU sername(serv iceU serN ame);

Here we prepare request which will be passed to the CreateServiceToken operation in service.
C reateTokenResponse response; try { response = port.createS erv iceToken1(request); S y stem.out.println("S erv ice token created successfully . V alid till: "+ response.getE xpiration().toS tring());

Here we call the CreateServiceToken operation in service the result is returned in the response object. If there are problems during the operation call the corresponding exception is thrown and we print error message in a catch block:
S y stem.out.println("S erv ice token error message: " + e.getM essage());

In the code below we specify the effective username via command line:
S tring effectiv eU serN ame = null; try { S y stem.out.println("P lease enter effectiv e username: "); effectiv eU serN ame = br.readLine(); } catch (IO E xception ioe) { S y stem.out.println("IO error try ing to read effectiv e user name!"); S y stem.exit(1);

864

TRKD API Developer's Guide

And then prepare request which will be passed to the CreateImpersonationToken operation in service. EffectiveUsername type was generated automatically from the corresponding xsd schema.
S y stem.out.println("C reating impersonation token..."); C reateImpersonationTokenRequest2 impersonationRequest = new C reateImpersonationTokenRequest2(); impersonationRequest.setA pplicationID(serv iceU serA pplicationID); impersonationRequest.setP assw ord(serv iceU serP assw ord); impersonationRequest.setU sername(serv iceU serN ame); E ffectiv eU sernameTy pe effectiv eU ser = new E ffectiv eU sernameTy pe(); effectiv eU ser.setV alue(effectiv eU serN ame); impersonationRequest.setE ffectiv eU sername(effectiv eU ser);

In the code below we call CreateImpersonationToken operation in service the result is returned in the response object.
response = port.createImpersonationToken2(impersonationRequest); S y stem.out .println("Impersonation token created successfully . V alid till: "+ response.getE xpiration().toS tring());

If there are problems during the operation call the corresponding exception is thrown and we print error message in a catch block:
S y stem.out.println("Impersonation token error message: "+ e.getM essage());

43.6.2 Running Code Sample

After you enter the code go to Run->Run As-> Java application:

You will receive Console output something like on the picture below:

Building Java TRKD Client

865

43.7

Code Style Recommendations

We recommend you using Code conventions for the Java Programming Language. You can setup Eclipse to check your project source code via Project->Properties Checkstyle tab and make sure the " Checkstyle active for this project " check box is selected as shown on the picture below:

43.8

Typical Problems
This section lists typical problems you may come across when building Java TRKD Client.

866

TRKD API Developer's Guide

43.8.1 Errors when Trying to Import WSDL via Java IDEs

Java IDEs like Eclipse provide wizards that allow creating wrapper classes from WSDL files. But quite often various errors occur as on the picture below. Often it is not possible to use various import options when you import via Java IDE which are actually required. We recommend using Ant tasks in specialized tools which are bundled in web services frameworks for wsdl import. Please review the recommended solution for Sun Metro.

43.8.2 MustUnderstand Exception

Mustunderstand SOAP exception For example:
E xception in thread "main" jav ax.xml.w s.soap.S O A P F aultE xception: M ustU nderstand headers:[{http://w w w .w 3.org/2005/08/addressing}A ction] are not understood at com.sun.xml.internal.w s.protocol.soap.M U Tube.createM U S O A P F aultE xception(M U Tube.jav a:140) at com.sun.xml.internal.w s.protocol.soap.C lientM U Tube.processResponse(C lientM U Tube.jav a:82) at com.sun.xml.internal.w s.api.pipe.F iber.__doRun(F iber.jav a:591) at com.sun.xml.internal.w s.api.pipe.F iber._doRun(F iber.jav a:540) at com.sun.xml.internal.w s.api.pipe.F iber.doRun(F iber.jav a:525) at com.sun.xml.internal.w s.api.pipe.F iber.runS y nc(F iber.jav a:422) at com.sun.xml.internal.w s.client.S tub.process(S tub.jav a:235) at com.sun.xml.internal.w s.client.sei.S E IS tub.doP rocess(S E IS tub.jav a:120) at com.sun.xml.internal.w s.client.sei.S y ncM ethodH andler.inv oke(S y ncM ethodH andler.jav a:230) at com.sun.xml.internal.w s.client.sei.S y ncM ethodH andler.inv oke(S y ncM ethodH andler.jav a:210) at com.sun.xml.internal.w s.client.sei.S E IS tub.inv oke(S E IS tub.jav a:103) at $ P roxy 39.retriev eItem1(U nknow n S ource) at Q uoteC lient.Q uote.print(Q uote.jav a:53) at Q uoteC lient.M ain.main(M ain.jav a:31) Jav a Result:1

The most possible reason of the error is that WS-Addressing feature is not supported (or not engaged please review code samples sections in order to engage WS-addressing feature section) by your Java web services framework.

867

2011 Thomson Reuters. All rights reserved. Republication or redistribution of Thomson Reuters content, including by framing or similar means, is prohibited w ithout the prior w ritten consent of Thomson Reuters. 'Thomson Reuters' and the Thomson Reuters logo are registered trademarks and trademarks of Thomson Reuters and its affiliated companies.

FOR MORE INFORMATION SEND US A SALE ENQUIRY AT reuters.com/salesenquiry READ MORE ABOUT OUR PRODUCTS AT reuters.com/productinfo FIND OUT HOW TO CONTACT YOUR LOCAL OFFICE reuters.com/contacts