Академический Документы
Профессиональный Документы
Культура Документы
Version 1.0
Updated: June 24, 2008
Page 2 of 32
Table of Contents
Introduction ................................................................................................................................................... 4
4
Purpose ............................................................................................................................................ 4
1.2 Technical Components ........................................................................................................................... 5
4
Authentication and Security ............................................................................................................. 5
4
Page 3 of 32
Introduction
RatingsXpress Credit Research (Web Service Delivery) provides clients with real-time search and
retrieval capabilities of its research articles. It is a unique delivery mechanism for RatingsXpress Credit
Research clients.
Available services are:
1. Research: Search and view Standard & Poors content by using embedded web services. A
combination of keywords and keyword types initiate a query of the database, returning results as
links (URLs) to research articles.
2. Inventory: Conduct an inventory check of S&Ps content by using CUSIP market identifiers.
3. Entity Name: Search on an Entity Name to retrieve S&Ps proprietary Entity ID and associated
six-digit CUSIP(s).
4
Purpose
This guide provides complete implementation information in addition to detailed descriptions of the
following product details:
Security
Authentication
XML formats
XML schemas
SOAP files
WSDL file
Search parameters mandatory and optional
Document type (HTML)
Page 4 of 32
Authentication and security: Secure Sockets Layer (SSL) encryption, password protection
Information structure: XML
Web services standards: SOAP, WSDL
Web browser: Microsoft Internet Explorer version 6 or higher, or Mozilla Firefox version 1.5 or
higher
Many of the files described in this Implementation Guide have been included for your convenience.
Please see section 1.6 Standard & Poors Contact Information for the file downloads location.
Each web service request is authenticated to confirm the clients identity and entitlements. Each request
contains a unique username and password combination. Unauthorized access results in an error
message.
Two scenarios where authentication may fail are:
RatingsXpress Credit Research (Web Service Delivery) protects client information by using SSL with 128bit encryption during the request and response exchange.
Research articles are also secured with SSL. All URLs pointing to the research articles on S&Ps web
server begin with HyperText Protocol Secure (HTTPS). Any connection not using HTTPS to exchange
data will fail.
RatingsXpress Credit Research (Web Services Delivery) uses SOAP to enable communication by hosting
XML tags in the SOAP body.
Sample SOAP Request: [The sample below is just a small portion of the actual SOAP message]
<?xml version=1.0 encoding=UTF-8?>
<env:Envelope xmlns:env=http://schemas.xmlsoap.org/soap/envelope/
xmlns:xsi=http://www.w3.org/2001/XMLSchema-instance
xmlns:soapenc=http://schemas.xmlsoap.org/soap/encoding/
xmlns:xsd=http://www.w3.org/2001/XMLSchema>
<env:Body env:encodingStyle=http://schemas.xmlsoap.org/soap/encoding/>
<m:getResearch xmlns:m=http://sp.com/rxs/service>
<request xmlns:n1=http://sp.com/rxs/schemas/ResearchRequest
xsi:type=n1:researchRequest>
<username xsi:type=n1:username>test@sandp.com</username>
<password xsi:type=n1:password>RXS</password>
<keyword xsi:type=n1:keyword>XYZ COMPANY</keyword>
<keywordType xsi:type=n1:keywordType>TITLE</keywordType>
</request>
</m:getResearch>
</env:Body>
</env:Envelope>
Page 5 of 32
Sample SOAP Response: [The sample below is just a small portion of the actual SOAP message.]
<?xml version=1.0 encoding=iso-8859-1?>
<env:Envelope xmlns:env=http://schemas.xmlsoap.org/soap/envelope/
xmlns:xsi=http://www.w3.org/2001/XMLSchema-instance
xmlns:soapenc=http://schemas.xmlsoap.org/soap/encoding/
xmlns:xsd=http://www.w3.org/2001/XMLSchema>
<env:Body env:encodingStyle=http://schemas.xmlsoap.org/soap/encoding/>
<m:getResearchResponse xmlns:m=http://sp.com/rxs/service
xmlns:n1=http://sp.com/rxs/schemas/ResearchResponse>
<researchResponse xsi:type=n1:researchResponse>
<keyword xsi:type=n1:keyword>XYZ COMPANY</keyword>
<keywordType xsi:type=n1:keywordType>TITLE</keywordType>
<articleList xsi :type= n1 :articleList >
<numArticlesReturned xsi:type=n1:numArticlesReturned>2</numArticlesReturned>
<article xsi :type= n1 :article >
<articleDate xsi :type= n1 :articleDate >2000-11-01</articleDate>
<articleTitle xsi:type=n1:articleTitle>BULLETIN: XYZ Corp. Authorizes
More Shares</articleTitle>
<articleAbstract xsi:type=n1:articleAbstract>BULLETIN: XYZ CORP merges
with ABC Incorporated.</articleAbstract>
<articleType xsi:type=n1:articleType>NEWS</articleType>
<articleSubType
xsi:type=n1:articleSubType>RATING_ACTION</articleSubType>
<identifiers xsi:type=n1:identifiers xsi:nil=true/>
<url xsi:type=n1:url>
https://services.ratingsxpress.com/ws/controller/Article?id=789012&userid=DS786SDFNK3209HDS
%SD97SKDF1&product=WS</url>
</article>
<article xsi :type= n1 :article >
<articleDate xsi :type= n1 :articleDate >2001-12-01</articleDate>
<articleTitle xsi:type=n1:articleTitle>BULLETIN: XYZ Corp. Reports on
merger.</articleTitle>
<articleAbstract xsi:type=n1:articleAbstract>XYZ Corp. recently
announced that it agreed to purchase ABC.</articleAbstract>
<articleType xsi:type=n1:articleType>NEWS</articleType>
<articleSubType
xsi:type=n1:articleSubType>RATING_ACTION</articleSubType>
<identifiers xsi:type=n1:identifiers xsi:nil=true/>
<url
xsi:type=n1:url>https://services.ratingsxpress.com/ws/controller/Article?id=123456&userid
=DS786SDFNK3209HDS%SD97SKDF1&product=WS</url>
</article>
</articleList>
</researchResponse>
</m:getResearchResponse>
</env:Body>
</env:Envelope>
D. Web Browser
All research articles are displayed in an SSL-compliant web browser.
Page 6 of 32
Required (Y/N)
Y
Y
Y
Y
N
N
N
N
N
Commentary
Full Analysis
Summary Analysis
Research Updates
News Rating Action
News Bulletins
Page 7 of 32
News Comments
Lengths
6, 8, or 9 digits
6, 8, or 9 digits
8 digits
5 digits
12 digits
2, 3, 4, 5, or 6 digits
4 digits
160 characters
160 characters
160 characters
160 characters
18 digits
3 or 2 characters
Please see the Appendix: Schema Codes to identify the appropriate codes to include in the XML tags.
Page 8 of 32
Page 9 of 32
Identifier field is used when a research request searches for multiple identifiers. This links the specific
market identifier that was queried on to its specific research article.
Page 10 of 32
Page 11 of 32
Page 12 of 32
</env:Body>
</env:Envelope>
Page 13 of 32
Page 14 of 32
Six-digit CUSIP(s)
S&Ps Entity ID
Sector
Published entity name
The response also contains the number of matched entity names based on the request.
Based on client requirements, the entity name web service may be deployed as a stand-alone function, or
coupled with the research request. For example, entity name and research web services can be used
together to search and retrieve research:
Step 1: Submit an entity name request to search for an entity ID based on entitys name
Step 2: Receive the entity ID
Step 3: Submit a research request that returns articles based on the entity ID
Page 15 of 32
Page 16 of 32
Page 17 of 32
WSDL:
https://services.ratingsxpress.com/ws/SandP?WSDL
Schemas:
Research Request
https://services.ratingsxpress.com/ws/schemas/ResearchRequest/ResearchRequest.xsd
Research Response
https://services.ratingsxpress.com/ws/schemas/ResearchResponse/ResearchResponse.xsd
Inventory Request
https://services.ratingsxpress.com/ws/schemas/InventoryRequest/InventoryRequest.xsd
Inventory Response
https://services.ratingsxpress.com/ws/schemas/InventoryResponse/InventoryResponse.xsd
Entity Name Request
https://services.ratingsxpress.com/ws/schemas/EntityRequest/EntityRequest.xsd
Entity Name Response
https://services.ratingsxpress.com/ws/schemas/EntityResponse/EntityResponse.xsd
Error Response
https://services.ratingsxpress.com/ws/schemas/ErrorResponse/ErrorResponse.xsd
Page 18 of 32
1.8 Appendix
A. Error Response Schema
RatingsXpress Credit Research (Web Service Delivery) reports error conditions via a SoapFault as
supported by the SOAP specification. The SoapFault is constructed using the elements as defined
below.
faultCode: The faultCode element will contain one of the values permitted by the SOAP
specification.
faultString: The faultString element will contain the error description string.
FaultActor: The faultActor element will contain one of two values: http://services.ratingsxpress.com or
Client. This value indicates which SOAP actor from the operation has introduced the fault.
RatingsXpress Credit Research (Web Service Delivery) error pattern employs a common element
structure consisting of an error response element and a repeating group of fault elements. This structure
serves the purpose of informing the client of all errors in case the request results in multiple errors. The
consistent structure serves to establish a contract in conveying error information for the purposes of:
Page 19 of 32
Page 20 of 32
Page 21 of 32
Username
Password
Keyword
Keyword Type
From Date
To Date
Number of Articles Returned
Research Type
Sort By
Sector
Subsector
Industry
Region
Country
State (U.S.)
For example, a valid XML request file for a keyword type search on the research title must contain
TITLE in the keyword type XML tag.
An Inventory request file, requires a value for a single field:
Username
Password
Keyword
Keyword Type
Please note:
Sector, subsector, and industry are optional search parameters in a research request. A valid search
using one of these parameters must conform to a hierarchical tree. For example, a search for the Bank
(industry) must contain Global Issuers (sector) and Financial Institutions (subsector) codes as well.
However, a search based on a sector, does not require values for subsector and industry. A full
description of the hierarchical values appears in the sector, subsector, and industry tables below.
Figure 1.7.2: Keyword Type Codes and Descriptions
Code
Description
AUTHOR
Search article author only
BODY
Search article body only
CINS
Search CINS identifier only
CUSIP
Search CUSIP identifier only
ENTITY_ID
ENTITY_NAME
Page 22 of 32
Code
FULL_TEXT
GICS
ISIN
NAIC
NAICS
SIC
TITLE
WHATS_NEW
Description
Search author, body, and title
Search GICS identifier only
Search ISIN identifier only
Search INSURANCE NAIC
identifier only
Search NAICS identifier only
Search SIC identifier only
Search article title only
Search returns only those
articles, which fall within the
timeframe of 24 hours, 7
days, or 30 days
NEWS_BULLETINS
News: Bulletins
NEWS_COMMENTS
News: Comments
ARTICLE_DATE
Page 23 of 32
Sector Code
STRUC
STRUC
STRUC
Code
ABS
CDO
CMBS
STRUC
STRUC
REC
RMBS
STRUC
SE
Description
Asset Backed Securities
Collateralized Debt Obligations
Commercial Mortgage-Backed
Securities
Real Estate Companies
Residential Mortgage-Backed
Securities
Servicer Evaluations
Description
Industry
Aerospace &
Defense
Automobiles &
Components
Building Materials
Capital Goods
Chemicals
Consumer Products
Energy
Commercial Services
& Supplies*
Paper & Forest
Products
Health Care
Information
Technology
Hotels & Gaming
Homebuilding
Media &
Entertainment
Metals & Mining
Containers &
Packaging
Property & Real
Estate
Retailing
Telecom Services
Transportation
Page 24 of 32
Sector/Subsector Codes
Sector:
Subsector:
Sector:
Subsector:
Sector:
Subsector:
Sector:
Subsector:
GLOBISS
UTIL
GLOBISS
UTIL
GLOBISS
UTIL
GLOBISS
UTIL
Sector:
Subsector:
Sector:
Subsector:
Sector:
Subsector:
Sector:
Subsector:
Sector:
Subsector:
Sector:
Subsector:
Sector:
Subsector:
Sector:
Subsector:
Sector:
Subsector:
Sector:
Subsector:
Sector:
Subsector:
Sector:
Subsector:
GLOBISS
INS
GLOBISS
INS
GLOBISS
INS
GLOBISS
INS
GLOBISS
INS
GLOBISS
INS
GLOBISS
INS
GLOBISS
INS
GLOBISS
INS
GLOBISS
INS
GLOBISS
INS
GLOBISS
INS
Sector:
Subsector:
Sector:
Subsector:
Sector:
Subsector:
Sector:
Subsector:
Sector:
Subsector:
Sector:
Subsector:
Sector:
Subsector:
Sector:
Subsector:
Sector:
Subsector:
GLOBISS
FI
GLOBISS
FI
GLOBISS
FI
GLOBISS
FI
GLOBISS
FI
GLOBISS
FI
GLOBISS
FI
GLOBISS
FI
GLOBISS
FI
Code
UTILITY COMPANIES
19
Description
Industry
Electric
17
Gas
18
Water
27
Multi
INSURANCE
FINANCEGCO
FINANCESCO
Industry
Financial Guaranty
HEALTSERV
Financial Service
Company
Health
INSUREBROK
Insurance Broker
INSUREHLCO
Insurance Holding
Company
Life Insurance
Company
Mortgage Insurance
Company
Multi-Line Insurer
LIFEINSCO
MORINSCO
MULTILNINS
PROPCASUC
REINSURER
SPLPURPCO
TITINSCO
FINANCIAL
INSTITUTIONS
ASSTMNGR
Property/Casualty
Insurance
Reinsurance
Special Purpose
Company
Title Insurance
Company
Industry
Asset Manager
BANK
Bank
BANKHLDCO
BANKSUB
Bank Holding
Company
Bank Subsidiary
BROKERCO
Brokerage Company
BLDGSCTY
Building Society
BUSTRUST
Business Trust
CRUNION
Credit Union
DPSTRYINST
Depository
Institutions
Page 25 of 32
Sector/Subsector Codes
Sector:
GLOBISS
Subsector:
FI
Sector:
GLOBISS
Subsector:
FI
Sector:
GLOBISS
Subsector:
FI
Sector:
GLOBISS
Subsector:
FI
Sector:
GLOBISS
Subsector:
FI
Sector:
GLOBISS
Subsector:
FI
Sector:
GLOBISS
Subsector:
FI
Sector:
GLOBISS
Subsector:
FI
Sector:
GLOBISS
Subsector:
FI
Sector:
GLOBISS
Subsector:
FI
Sector:
GLOBISS
Subsector:
FI
Sector:
Subsector:
GLOBISS
FI
Sector:
Subsector:
Sector:
Subsector:
GLOBISS
SOV
GLOBISS
GOVS
Code
FINANCECO
Description
Finance Company
FINANCINST
Financial Institution
FINANCESCO
Financial Service
Company
Funds
FUNDS
GOVTAGYS
GRANTRUST
Government
Agencies
Grantor Trust
MASTTRUST
Master Trust
MORINST
Mortgage Institution
OWNERTRUS
Owner Trust
REALESTINV
Real Estate
Investment Trust
Real Estate-Based
Financial Services
Company
Savings & Loan
Company
Industry
Sovereigns
REALESTFIN
SAVLOANCO
SOVEREIGNS
SOVEREIGNS
GOVS
International Public
Finance
Code
ANT
ARE
ARG
ARM
ATF
ATG
AUS
AUT
AZE
BDI
BEL
BEN
BFA
BGD
BHR
BHS
BGR
BIH
BLR
BLZ
BMU
BOL
BRA
BRB
BRN
BTN
BVT
BWA
CAF
CAN
CCK
CHE
CHI
CHL
CHN
CIV
COK
CMR
COD
COG
COL
COM
CPV
CRI
CUB
CXR
CYM
CYP
CZE
DEU
DJI
Description
Netherland Antilles
United Arab Emirates
Argentina
Armenia
French Southern Territories
Antigua & Barbuda
Australia
Austria
Azerbaijan
Burundi
Belgium
Benin
Burkina Faso
Bangladesh
Bahrain
Bahamas
Bulgaria
Bosnia & Herzegovina
Belarus
Belize
Bermuda
Bolivia
Brazil
Barbados
Brunei
Bhutan
Bouvet Island
Botswana
Central African Republic
Canada
Cocos (Keeling) Islands
Switzerland
Channel Islands
Chile
China
Ivory Coast
Cook Islands
Cameroon
Congo-Kinshasa
Congo-Brazzaville
Colombia
Comoros
Cape Verde
Costa Rica
Cuba
Christmas Island
Cayman Islands
Cyprus
Czech Republic
Germany
Djibouti
Page 27 of 32
Code
DMA
DNK
DOM
DZA
ECU
EGY
ERI
ESH
ESP
EST
ETH
FIN
FJI
FLK
FRA
FRO
FSM
GAB
GBR
GEO
GGY
GHA
GIB
GIN
GLP
GMB
GNB
GNQ
GRC
GRD
GRL
GTM
GUF
GUY
HKG
HMD
HND
HRV
HTI
HUN
IDN
IMN
IND
IOT
IRL
IRN
IRQ
ISL
ISR
ITA
JAM
Description
Dominica
Denmark
Dominican Republic
Algeria
Ecuador
Egypt
Eritrea
Western Sahara
Spain
Estonia
Ethiopia
Finland
Fiji
Falkland Islands (Malvinas)
France
Faroe Islands
Micronesia
Gabon
United Kingdom
Georgia
Guernsey
Ghana
Gibraltar
Guinea
Guadeloupe
Gambia
Guinea-Bissau
Equatorial Guinea
Greece
Grenada
Greenland
Guatemala
French Guinea
Guyana
Hong Kong
Heard Island/McDonald Islands
Honduras
Croatia
Haiti
Hungary
Indonesia
Isle of Man
India
British Indian Ocean Territory
Ireland
Iran
Iraq
Iceland
Israel
Italy
Jamaica
Page 28 of 32
Code
JEY
JOR
JPN
KAZ
KEN
KGZ
KHM
KIR
KNA
KOR
KWT
LAO
LBN
LBR
LCA
LBY
LIE
LKA
LSO
LTU
LUX
LVA
MAR
MAC
MCO
MDA
MDG
MDV
MEX
MHL
MKD
MLI
MLT
MMR
MNE
MNG
MNP
MOZ
MRT
MSR
MTQ
MUL
MUS
MWI
MYS
MYT
NAM
NCL
NER
NFK
NGA
Description
Jersey
Jordan
Japan
Kazakhstan
Kenya
Kyrgyzstan
Cambodia
Kiribati
Saint Kitts and Nevis
South Korea
Kuwait
Laos
Lebanon
Liberia
Saint Lucia
Libya
Liechtenstein
Sri Lanka
Lesotho
Lithuania
Luxembourg
Latvia (Republic of)
Morocco
Macau
Monaco
Moldova
Madagascar
Maldives
Mexico
Marshall Islands
Macedonia
Mali
Malta
Myanmar
Montenegro
Mongolia
Northern Mariana Islands
Mozambique
Mauritania
Montserrat
Martinique
Multiple
Mauritius
Malawi
Malaysia
Mayotte
Nambia
New Caledonia
Niger
Norfolk Island
Nigeria
Page 29 of 32
Code
NIC
NIU
NLD
NOR
NPL
NRU
NZL
OMN
PAK
PAN
PCN
PER
PHL
PLW
PNG
POL
PRK
PRT
PRY
PYF
QAT
REU
ROU
RUS
RWA
SAU
SDN
SEN
SGP
SHN
SJM
SLB
SLE
SLV
SMR
SOM
SPM
SRB
STP
SUP
SUR
SVK
SVN
SWE
SWZ
SYC
SYR
TCA
TCD
TGO
THA
Description
Nicaragua
Niue
Netherlands
Norway
Nepal
Nauru
New Zealand
Oman
Pakistan
Panama
Pitcairn
Peru
Philippines
Palau
Papua New Guinea
Poland
North Korea
Portugal
Paraguay
French Polynesia
Qatar
Reunion
Romania
Russia
Rwanda
Saudi Arabia
Sudan
Senegal
Singapore
Saint Helena
Svalbard and Jan Mayen
Solomon Islands
Sierra Leone
El Salvador
San Marino
Somalia
Saint Pierre and Miquelon
Serbia
Sao Tome & Principe
Supranational
Suriname (The Republic of)
Slovak Republic
Slovenia
Sweden
Swaziland
Seychelles
Syria
Turks & Caicos
Chad
Togo
Thailand
Page 30 of 32
Code
TJK
TKL
TKM
TLS
TON
TTO
TUN
TUR
TUV
TWN
TZA
UGA
UKR
URY
USA
UZB
VAT
VCT
VEN
VGB
VNM
VUT
WLF
WSM
YEM
ZAF
ZMB
ZWE
Description
Tajikistan
Tokelau
Turkmenistan
East Timor
Tonga
Trinidad & Tobago
Tunisia
Turkey
Tuvalu
Taiwan
Tanzania
Uganda
Ukraine (Republic of)
Uruguay
United States
Uzbekistan
Holy See (Vatican City States)
St. Vincent & the Grenadines
Venezuela
British Virgin Islands
Vietnam
Vanuatu
Wallis and Futuna
Samoa
Yemen
South Africa
Zambia
Zimbabwe
Page 31 of 32
Code
IL
IN
KS
KY
LA
MA
MB
MD
ME
MI
MN
MO
MS
MT
NB
NC
ND
NE
NF
NH
NJ
NM
NS
NV
NY
OH
OK
ON
OR
PA
PE
PR
QC
RI
SC
SD
SK
TN
TX
UM
UT
VA
VI
VT
WA
WI
WV
WY
YT
Description
Illinois
Indiana
Kansas
Kentucky
Louisiana
Massachusetts
Manitoba
Maryland
Maine
Michigan
Minnesota
Missouri
Mississippi
Montana
New Brunswick
North Carolina
North Dakota
Nebraska
Newfoundland
New Hampshire
New Jersey
New Mexico
Nova Scotia
Nevada
New York
Ohio
Oklahoma
Ontario
Oregon
Pennsylvania
Prince Edward Island
Puerto Rico
Quebec
Rhode Island
South Carolina
South Dakota
Saskatchewan
Tennessee
Texas
United States Minor Outlying Islands
Utah
Virginia
Virgin Islands
Vermont
Washington
Wisconsin
West Virginia
Wyoming
Yukon Territory
Page 32 of 32