|
|
|
how do i use getdata?
|
Introduction
General XML Stucture
Request XML Stucture
Response XML Stucture
Operations
GetCompanyInformation
CompanySearch
GetNonLtdCompanyInformation
NonLtdCompanySearch
Calling GetData
XML Over HTTP or Representational State Transfer (REST)
Simple Object Access Protocol (SOAP)
|
| Introduction
|
The GetData Web Service requires an XML string
as its input and returns an XML string as its output. The input XML contains
the request information including a creditsafeuk.com username and password, the
operation to run and the necessary parameters for that operation. The output
XML contains the response information, that is, the information requested in
the XML request message.
A customer must generate the request XML and transform the response XML to
display the company information as desired.
https://www.creditsafeuk.com/GetDataUK/Service/CreditsafeServices.asmx is
the Uniform Resource Location (URL) for the www.creditsafeuk.com GetData Web
Service. GetData supports both REST (or XML over HTTP) and SOAP client implementations.
|
|
|
|
| General XML Structure
|
|
|
Request XML Structure
All request XML sent to GetData contains an <xmlrequest> element
and within this element a <header> element and a <body>
element. These elements are described in Table 1.
|
Element
|
Meaning
|
|
<xmlrequest>
|
This is the root element of the request XML. This element contains two child elements: <header> and <body>
|
|
<header>
|
The <header> element contains reference information such as the username, password and the operation requested
|
|
<body>
|
The <body> element contains the parameters for the operation. The structure of the <body> element differs according to the operation requested
|
|
Table 1: Request XML Structure
The XML request structure required by GetData is shown in Figure 1.
<xmlrequest>
<header>
<username>UserName</username>
<password>Password</password>
<operation>Operation</operation>
<language>EN</language>
<chargereference>ChargeReference</chargereference>
</header>
<body>
<!--
the request body XML goes here and the structure is dependent on the
operation requested
-->
</body>
</xmlrequest>
|
Figure 1: Request XML
The <header> element contains reference information such as the username and
password of the Creditsafeuk account making the request and the operation to perform.
The <header> element structure never changes regardless of the operation requested.
The structure of the <header> element is described in Table 2.
|
Element
|
Meaning
|
Supported Values
|
|
<username>
|
www.creditsafeuk.com account Username
|
|
|
<password>
|
www.creditsafeuk.com account Password
|
|
|
<language>
|
The language to return the response in
|
EN - English
|
|
<operation>
|
The GetData operation to perform
|
GetCompanyInformation
CompanySearch
GetNonLtdCompanyInformation
NonLtdCompanySearch
|
|
<chargerreference>
|
A client charge reference number
|
|
|
Table 2: Request Header Element
The <body> element of a GetData request is specific to the operation requested:
GetCompanyInformation describes the request <body> for the GetCompanyInformation operation.
CompanySearch describes the request <body> for the CompanySearch operation.
GetNonLtdCompanyInformation describes the request <body> for the GetNonLtdCompanyInformation operation.
NonLtdCompanySearch describes the request <body> for the NonLtdCompanySearch operation.
|
|
|
|
|
Response XML Structure
All response XML from GetData contains an <xmlresponse> element and within
this element a <header> element and a <body> element. Table 3
outlines the purpose of these XML elements.
|
Element
|
Meaning
|
|
<xmlresponse>
|
This is the root element of the response XML. This element contains two child elements: <header> and <body>
|
|
<header>
|
The <header> element contains reference information such as the time, version and provider.
|
|
<body>
|
The <body> element contains the actual data returned. The structure of the <body> element differs according to the operation requested.
|
|
Table 3: Response XML Structure
The XML response structure returned by GetData is shown in Figure 2.
<xmlresponse>
<header>
<reportinformation>
<time>Time</time>
<reporttype>ReportType</reporttype>
<country>Country</country>
<version>Version</version>
<provider>Provider</provider>
<chargereference>ChargeReference</chargereference>
</reportinformation>
</header>
<body>
<!--
the response body XML goes here and the structure is dependent on the
operation GetData is responding to
-->
</body>
|
Figure 2: Response XML
The <header> element contains reference information such as the time, version and
provider of the response. The <header> element structure never changes regardless of the
operation. The structure of the <header> element is described in Table 4.
|
Element
|
Meaning
|
Supported Values
|
|
<reportinformation>
|
The parent element for the report information
|
|
|
<time>
|
The time the response message was generated
|
Date and time in format mm/dd/yyyy hh:nn:ss
|
|
<reporttype>
|
This element contains the type of report returned by GetData i.e. what type of information
is held in the <body> element
|
GetCompanyInformation
GetCompanyInformationError
CompanySearch
CompanySearchError
GetNonLtdCompanyInformation
GetNonLtdCompanyInfromationError
NonLtdCompanySearch
NonLtdCompanySearchError
Error
|
|
<country>
|
The country to return data from
|
As specified in the request message (<body>)
|
|
<version>
|
The application version
|
Version 4.0
|
|
<provider>
|
The name of the service provider
|
www.creditdsafe.com
|
|
<chargerreference>
|
A client charge reference number as specified in the request
|
|
|
Table 4: Response Header Element
The <body> element of a GetData response is specific to the operation.
GetCompanyInformation describes the response <body> for the GetCompanyInformation operation.
CompanySearch describes the response <body> for the CompanySearch operation.
GetNonLtdCompanyInformation describes the response <body> for the GetNonLtdCompanyInformation operation.
NonLtdCompanySearch describes the response <body> for the NonLtdCompanySearch operation.
|
|
|
|
| Operations
|
GetData supports four operations:
-
GetCompanyInformation
This operation returns credit information for a Limited Company with the
specified company number. The information returned includes base information
(such as name, address and telephone number), credit rating history, credit
limit history, CCJ history, Gazette master entries, previous names history and
financial information (such as profit & loss, balance sheet and ratios).
-
CompanySearch
This operation returns a list of Limited Companies that match the specified
search criteria. Search criteria can include company name, address, postcode
and telephone number.
-
GetNonLtdCompanyInformation
This operation returns credit information for a Non-Limited Company with the
specified company number. The information returned includes base information
(such as name, address, telephone numbers), credit rating history, credit limit
history, CCJ history and event history.
-
NonLtdCompanySearch
This operation returns a list of Non-Limited Companies that match the specified
search criteria. Search criteria can include company name, address, postcode
and telephone number.
|
|
|
|
| GetCompanyInformation
|
Figure 3 shows an example request to retrieve Limited Company
Information. The request XML is split into <header> and
<body> elements.
<xmlrequest>
<header>
<username>DemoUser</username>
<password>Password</password>
<operation>GetCompanyInformation</operation>
<language>EN</language>
<chargereference></chargereference>
</header>
<body>
<package>standard</package>
<country>UK</country>
<companynumber>X9999999</companynumber>
</body>
</xmlrequest>
|
Figure 3: GetCompanyInformation Request
|
|
The GetCompanyInformation request <header> element has the same structure as all other
operation requests. The <operation> element must have the value GetCompanyInformation.
|
|
|
The GetCompanyInformation operation <body>
element is described in Table 5.
|
Element
|
Meaning
|
Supported Values
|
|
<package>
|
The package name that determines the data to be returned
|
standard
|
|
<country>
|
The country to retrieve data from
|
UK - United Kingdom
|
|
<companynumber>
|
The unique company number assigned to the company by Companies House
|
|
|
Table 5: GetCompanyInformation <body> Element
|
The request XML shown in Figure 3 will return the company
information defined by the "standard" package for the UK company with company
number "X9999999". Figure 4 shows a typical response to this request.
<xmlresponse>
<header>
<reportinformation>
<time>08/06/2006 16:55:51</time>
<reporttype>GetCompanyInformation</reporttype>
<country>UK</country>
<version>4.0</version>
<provider>www.creditsafe.com</provider>
<chargereference></chargereference>
</reportinformation>
</header>
<body>
<companies>
<company>
<baseinformation>
<number>X9999999</number>
<name>TEST COMPANY LIMITED</name>
<telephone>02920886500</telephone>
<tpsregistered>N</tpsregistered>
<address1>BRYN HOUSE</address1>
<address2>CAERPHILLY BUSINESS PARK</address2>
<address3>VAN ROAD</address3>
<address4>CARDIFF CF83 3GG</address4>
<postcode>CF83 3GG</postcode>
<siccode>7260</siccode>
<sicdescription>OTHER COMPUTER RELATED ACTIVITIES</sicdescription>
<website>creditsafeuk.com</website>
<companytype>Private limited with Share Capital</companytype>
<accountstype>Group</accountstype>
<annualreturndate>04/10/2004</annualreturndate>
<incorporationdate>01/01/2004</incorporationdate>
<accountsfilingdate></accountsfilingdate>
<latestaccountsdate>31/12/2005</latestaccountsdate>
</baseinformation>
<industries />
<tradingaddresses>
<tradingaddress>
<address1>Unit 24</address1>
<address2>Park Gate Business Centre</address2>
<address3>Chandlers Way, Park Gate</address3>
<address4>Southampton</address4>
<postcode>SO31 1FQ</postcode>
<telephone>577599</telephone>
<tpsregistered>N</tpsregistered>
</tradingaddress>
</tradingaddresses>
<ratings>
<ratingdetail>
<date>12/05/2006</date>
<score>0</score>
<description>Caution - Credit at your discretion</description>
</ratingdetail>
<ratingdetail>
<date>10/01/2006</date>
<score>-9</score>
<description>Directors not appointed</description>
</ratingdetail>
<ratingdetail>
<date>21/09/2005</date>
<score>65</score>
<description>Good Credit Worthiness</description>
</ratingdetail>
</ratings>
<limits>
<limitdetail>
<limit>0</limit>
<date>12/05/2006</date>
</limitdetail>
<limitdetail>
<limit>-1</limit>
<date>10/01/2006</date>
</limitdetail>
</limits>
<previousnames>
<previousname>
<name>TEST COMPANY LIMITED</name>
<date>24/09/1999</date>
</previousname>
</previousnames>
|
Figure 4: GetCompanyInformation Response
The GetCompanyInformation response <header> element has the same structure as all other operation
responses with the <reporttype> set to GetCompanyInformation. The information returned from the GetCompanyInformation
<body> is shown in Table 6.
|
Element
|
Meaning
|
|
<companies>
|
The parent element of the Limited Company information
|
|
<company>
|
The root element of the Limited Company information
|
|
<baseinformation>
|
Contains base information about the company such as number, name, address and telephone number
|
|
<industries>
|
Contains the industries of the company
|
|
<tradingaddresses>
|
Contains the trading addresses of the company
|
|
<ratings>
|
Contains the credit rating of the company
|
|
<limits>
|
Contains the credit limits of the company
|
|
<previousnames>
|
Contains the previous names of the company
|
|
<recordofpayments>
|
Contains detailed information about County Court Judgements against the company
|
|
<ccjsummary>
|
Contains a summary of outstanding County Court Judgments against the company
|
|
<statushistorys>
|
Contains the Gazette master entries of the company
|
|
<eventhistorys>
|
Contains key event information about the company
|
|
<mortgages>
|
Contains detailed mortgage information about the company
|
|
<mortgagesummary>
|
Contains a summary of the mortgage information for the company
|
|
<shareholders>
|
Contains detailed shareholder information about the company
|
|
<shareholdersummary>
|
Contains a summary of the shareholder information for the company
|
|
<financials>
|
Parent element for financial data
|
|
<period>
|
Contains the dates (period) the accounts cover
|
|
<profitloss>
|
Contains profit and loss financial information about the company
|
|
<balancesheet>
|
Contains balance sheet financial information about the company
|
|
<capitalreserves>
|
Contains capital and reserves financial information about the company
|
|
<miscellaneous>
|
Contains miscellaneous financial information about the company
|
|
<ratios>
|
Contains ratio financial information about the company
|
|
<directors>
|
Contains current company director information about the company including all current directorship positions held by each director
|
|
Table 6: GetCompanyInformation Response Information
Please refer to the documentation for more information about the data
returned from the GetCompanyInformation operation. Refer to the demonstration
to see an example of the GetCompanyInformation operation.
|
|
|
|
| CompanySearch
|
Figure 5 shows an example request to search
for a Limited Company. The request XML is split into <header> and
<body> elements.
<xmlrequest>
<header>
<username>DemoUser</username>
<password>Password</password>
<operation>CompanySearch</operation>
<language>EN</language>
<chargereference></chargereference>
</header>
<body>
<country>UK</country>
<name>ibm</name>
<namesearchmode>begin</namesearchmode>
<startposition>1</startposition>
<pagesize>25</pagesize>
</body>
</xmlrequest>
|
Figure 5: CompanySearch Request
|
|
The <header> element contains the
same information as all other requests.
The <operation> element must be set to the value CompanySearch.
|
|
The CompanySearch <body> element
is described in Table 7.
|
|
Element
|
Meaning
|
Supported Values
|
|
<name>
|
This is the search criteria for the company name
|
Any text
|
|
<namesearchmode>
|
This is the search criteria operator for the company name
|
begin (default)
contain
|
|
<address>
|
This is the search criteria for the company address
|
Any text
|
|
<addresssearchmode>
|
This is the search criteria for the company address
|
begin (default)
contain
|
|
<postcode>
|
This is the search criteria for the company postcode
|
Any text
|
|
<telephone>
|
This is the search criteria for the company telephone number
|
Any text
|
|
<country>
|
This is the Country to search in
|
UK - United Kingdom
|
|
<startposition>
|
This specifies the start position to view records from
|
A numeric value
|
|
<pagesize>
|
This specifies the maximum number of records to return in a response message
|
A numeric value
|
|
Table 7: CompanySearch <body> Element
The request XML shown in Figure 5 will search the first 25 Limited Companies whose name
begins with "IBM". Figure 6 shows a typical response for this request.
<xmlresponse>
<header>
<reportinformation>
<time>21/06/2006 16:55:51</time>
<reporttype>CompanySearch</reporttype>
<country>UK</country>
<version>4.0</version>
<provider>www.creditsafe.com</provider>
<chargereference></chargereference>
</reportinformation>
</header>
<body>
<resultcounters>
<startposition>1</startposition>
<endposition>25</endposition>
<totalcount>43</totalcount>
<pagesize>25</pagesize>
</resultcounters>
<results>
<result>
<name>I B M INTERNATIONAL SERVICES CORPORATION</name>
<number>FC017866</number>
<country>UK</country>
<address>OLD ORCHARD ROAD</address>
</result>
<result>
<name>I B M UNITED KINGDOM HOLDINGS LIMITED</name>
<number>00122953</number>
<country>UK</country>
<address>P.O. BOX 41</address>
</result>
<result>
<name>I B MACFADZEAN LIMITED</name>
<number>SC254976</number>
<country>UK</country>
<address>226 KING STREET</address>
</result>
|
Figure 6: CompanySearch Response
The CompanySearch response <header> element has the same structure as all other operation responses with
the <reporttype> set to CompanySearch. The information returned from the CompanySearch <body>
is shown in Table 8.
|
Element
|
Meaning
|
|
<resultcounters>
|
Parent element for the count information
|
|
<startposition>
|
This element holds the position of the first record being displayed (as specified in the request XML)
|
|
<endposition>
|
This element holds the position of the last record being displayed
|
|
<totalcount>
|
This element shows the total number of records that matched the search criteria. This value never changes regardless of which page is being displayed.
|
|
<pagesize>
|
This element shows the current page size (as specified in the request XML)
|
|
|
|
|
<results>
|
Parent element for the Limited Companies that matched the search criteria
|
|
<result>
|
This element is the root element for a Limited Company that matched the search criteria
|
|
<name>
|
The name of the Limited Company that matched the search criteria
|
|
<number>
|
The company number of the Limited Company that matched the search criteria
|
|
<country>
|
The country of the Limited Company that matched the search criteria (specified in the request XML)
|
|
<address>
|
The address of the Limited Company that matched the search criteria
|
|
Table 8: CompanySearch Response Information
Please refer to the documentation for more information about the data
returned from the CompanySearch operation. Refer to the demonstration
to see an example of the CompanySearch operation.
|
|
|
|
| GetNonLtdCompanyInformation
|
Figure 7 shows an example request to retrieve
Non Limited Company Information. The request XML is split into <header> and
<body> elements.
<xmlrequest>
<header>
<username>DemoUser</username>
<password>Password</password>
<operation>GetNonLtdCompanyInformation</operation>
<language>EN</language>
<chargereference></chargereference>
</header>
<body>
<package>nonltdstandard</package>
<country>UK</country>
<companynumber>9999999</companynumber>
</body>
</xmlrequest>
|
Figure 7: GetNonLtdCompanyInformation Request
|
The GetNonLtdCompanyInformation request <header> element has the same structure as all other
operation requests. The <operation> element must have the value GetNonLtdCompanyInformation.
The GetNonLtdCompanyInformation operation <body> is described in Table 9.
|
Element
|
Meaning
|
Supported Values
|
|
<package>
|
The package name that determines the data to be returned
|
nonltdstandard
|
|
<country>
|
The country to retrieve data from
|
UK - United Kingdom
|
|
<companynumber>
|
The unique company number of the Non Limited Company
|
|
|
Table 8: GetNonLtdCompanyInformation Element
The request XML shown in Figure 7 will return the Non Limited Company information defined by
the "nonltdstandard" package for the UK company with company number "9999999".
Figure 8 shows a typical response to this request.
<xmlresponse>
<header>
<reportinformation>
<time>22/06/2006 09:38:37</time>
<reporttype>GetNonLtdCompanyInformation</reporttype>
<country>UK</country>
<version>4.0</version>
<provider>www.creditsafe.com</provider>
<chargereference></chargereference>
</reportinformation>
</header>
<body>
<companies>
<company>
<baseinformation>
<number>9999999</number>
<name>GARETH NON LIMITED TEST COMPANY</name>
<address1>THE BIG HOUSE,999 LETS B AVENUE</address1>
<address2>THE COVE(LOCALITY)</address2>
<address3>PENARTH</address3>
<address4>VALE OF GLAMORGAN</address4>
<postcode>CF00 8PP</postcode>
<mpsregistered>Y</mpsregistered>
<addressdate>05/2000</addressdate>
<addressreason>New Business</addressreason>
<premisestype>Office & Administration</premisestype>
<telephonenumbers>
<telephonenumber>
<telephone>02920886500</telephone>
<tpsregistered>N</tpsregistered>
<main>Y</main>
</telephonenumber>
</telephonenumbers>
<faxnumbers>
<faxnumber>
<fax>029 20 886500</fax>
<fpsregistered>Y</fpsregistered>
<main>Y</main>
</faxnumber>
<faxnumber>
<fax>029 20 886500</fax>
<fpsregistered>Y</fpsregistered>
<main>N</main>
</faxnumber>
</faxnumbers>
<activities>SAMPLE COMPANY AND TESTING</activities>
<employees>10</employees>
<website>CREDITSAFEUK.COM</website>
<email>UKINFO@CREDITSAFEUK.COM</email>
</baseinformation>
<ratings>
<ratingdetail>
<date>04/03/2006</date>
<score>77</score>
<description>Good Credit Worthiness</description>
</ratingdetail>
</ratings>
<limits>
<limitdetail>
<limit>3000</limit>
<date>04/03/2006</date>
</limitdetail>
</limits>
|
Figure 8: GetNonLtdCompanyInformation Response
The GetNonLtdCompanyInformation response <header> element has the same structure
as all other operation responses with the <reporttype> set to
GetNonLtdCompanyInformation. The information returned from the
GetNonLtdCompanyInformation <body> is shown in Table 9.
|
Element
|
Meaning
|
|
<companies>
|
The parent element of the Non Limited Company information
|
|
<company>
|
The root element of the Non Limited Company information
|
|
<baseinformation>
|
Contains base information about the Non Limited Company such as number, name, address and telephone number
|
|
<ratings>
|
Contains the credit rating of the Non Limited Company
|
|
<limits>
|
Contains the credit limits of the Non Limited Company
|
|
<matchedccjsummary>
|
Contains a summary of outstanding matched County Court Judgments against the Non Limited Company
|
|
<matchedrecordofpayments>
|
Contains detailed information about matched County Court Judgments against the Non Limited Company
|
|
<possiblematchedccjsummary>
|
Contains a summary of outstanding possible County Court Judgments against the Non Limited Company
|
|
<possiblematchedrecordofpayments>
|
Contains detailed information about possible County Court Judgments against the Non Limited Company
|
|
<seniorexecutive>
|
Contains information about the senior executive of the Non Limited Company
|
|
<events>
|
Contains key event information about the Non Limited Company (such as change of address, new ccjs etc.)
|
|
Table 9: GetNonLtdCompanyInformation Response Information
Please refer to the documentation for more information about the data
returned from the GetNonLtdCompanyInformation operation. Refer to the demonstration
to see an example of the GetNonLtdCompanyInformation operation.
|
|
|
|
| NonLtdCompanySearch
|
Figure 9 shows an example request to search
for a Non Limited Company. The request XML is split into <header> and
<body> elements.
<xmlrequest>
<header>
<username>DemoUser</username>
<password>Password</password>
<operation>NonLtdCompanySearch</operation>
<language>EN</language>
<chargereference></chargereference>
</header>
<body>
<country>UK</country>
<name>albert</name>
<namesearchmode>begin</namesearchmode>
<startposition>1</startposition>
<pagesize>25</pagesize>
</body>
</xmlrequest>
|
Figure 9: NonLtdCompanySearch Request
|
|
The <header> element contains the
same information as all other operations. The <operation> element
must be set to the value NotLtdCompanySearch.
|
|
The NonLtdCompanySearch <body> element
is described in Table 10.
|
|
Element
|
Meaning
|
Supported Values
|
|
<name>
|
This is the search criteria for the company name
|
Any text
|
|
<namesearchmode>
|
This is the search criteria operator for the company name
|
begin (default)
contain
|
|
<address>
|
This is the search criteria for the company address
|
Any text
|
|
<addresssearchmode>
|
This is the search criteria for the company address
|
begin (default)
contain
|
|
<postcode>
|
This is the search criteria for the company postcode
|
Any text
|
|
<telephone>
|
This is the search criteria for the company telephone number
|
Any text
|
|
<country>
|
This is the Country to search in
|
UK - United Kingdom
|
|
<startposition>
|
This specifies the start position to view records from
|
A numeric value
|
|
<pagesize>
|
This specifies the maximum number of records to return in a response message
|
A numeric value
|
|
Table 10: NonLtdCompanySearch <body> Element
The request XML shown in Figure 9 will search
the first 25 Non Limited Companies whose name begins with "albert". Figure 10 shows a
typical response for this request.
<xmlresponse>
<header>
<reportinformation>
<time>22/06/2006 10:11:00</time>
<reporttype>NonLtdCompanySearch</reporttype>
<country>UK</country>
<version>4.0</version>
<provider>www.creditsafe.com</provider>
<chargereference></chargereference>
</reportinformation>
</header>
<body>
<resultcounters>
<startposition>1</startposition>
<endposition>25</endposition>
<totalcount>246</totalcount>
<pagesize>25</pagesize>
</resultcounters>
<results>
<result>
<name>ALBERT D J NOTT</name>
<number>1361260</number>
<country>UK</country>
<address></address>
</result>
<result>
<name>ALBERT TAGUE</name>
<number>1833236</number>
<country>UK</country>
<address>31-33 QUEEN ST</address>
</result>
<result>
<name>ALBERT TAGUE IN MORECAMBE</name>
<number>1833237</number>
<country>UK</country>
<address>31-33 QUEEN ST</address>
</result>
|
Figure 10: NonLtdCompanySearch Response
The NonLtdCompanySearch response <header> element has the same structure as all other operation responses with
the <reporttype> set to NonLtdCompanySearch. The information returned from the NonLtdCompanySearch <body>
is shown in Table 11.
|
Element
|
Meaning
|
|
<resultcounters>
|
Parent element for the count information
|
|
<startposition>
|
This element holds the position of the first record being displayed (as specified in the request XML)
|
|
<endposition>
|
This element holds the position of the last record being displayed
|
|
<totalcount>
|
This element shows the total number of records that matched the search criteria. This value never changes regardless of which page is being displayed.
|
|
<pagesize>
|
This element shows the current page size (as specified in the request XML)
|
|
|
|
|
<results>
|
Parent element for the Non Limited Companies that matched the search criteria
|
|
<result>
|
This element is the root element for a Non Limited Company that matched the search criteria
|
|
<name>
|
The name of the Non Limited Company that matched the search criteria
|
|
<number>
|
The company number of the Non Limited Company that matched the search criteria
|
|
<country>
|
The country of the Non Limited Company that matched the search criteria (specified in the request XML)
|
|
<address>
|
The address of the Non Limited Company that matched the search criteria
|
|
Table 11: NonLtdCompanySearch Response Information
Please refer to the documentation for more information about the data
returned from the NonLtdCompanySearch operation. Refer to the demonstration
to see an example of the NonLtdCompanySearch operation.
|
|
|
|
| Calling GetData
|
|
The GetData Web Service supports Representation State Transfer (REST) and Simple Object Access Protocol (SOAP)
implementations and can be called from any programming language/platform that supports these technologies.
|
XML Over HTTP or Representational State Transfer (REST)
GetData can be invoked using HTTP GET and POST methods. Figure 11 shows how to call GetData using REST
and the HTTP GET method passing the request XML as part of the URL in the querystring parameters.
https://www.creditsafeuk.com/getdatauk/service/CreditsafeServices.asmx/GetData?requestXmlStr=
<xmlrequest>
<header>
<username>DemoUser</username>
<password>Password</password>
<language>EN</language>
<operation>CompanySearch</operation>
<chargereference></chargereference>
</header>
<body>
<country>UK</country>
<name>ibm</name>
<namesearchmode>begin</namesearchmode>
<startposition>1</startposition>
<pagesize>25</pagesize>
</body>
</xmlrequest>
|
Figure 11: XML Over HTTP/REST Request
As this method is based on a HTTP GET or POST the URL can be entered directly into the browser. For Example:
https://www.creditsafeuk.com/getdatauk/service/CreditsafeServices.asmx/GetData?requestXmlStr=
<xmlrequest>
<header>
<username>DemoUser</username>
<password>Password</password>
<language>EN</language>
<operation>CompanySearch</operation>
<chargereference></chargereference>
</header>
<body>
<country>UK</country>
<name>ibm</name>
<namesearchmode>begin</namesearchmode>
<startposition>1</startposition>
<pagesize>25</pagesize>
</body>
</xmlrequest>
Figure 12 shows a typical response received from the REST request shown in Figure 11.
<?xml version="1.0" encoding="utf-8" ?>
<string xmlns="https://www.creditsafeuk.com/getdatuk/service/">
<xmlresponse>
<header>
<reportinformation>
<time>22/06/2006 11:46:28</time>
<reporttype>CompanySearch</reporttype>
<country>UK</country>
<version>4.0</version>
<provider>www.creditsafe.com</provider>
<chargereference></chargereference>
</reportinformation>
</header>
<body>
<resultcounters>
<startposition>1</startposition>
<endposition>25</endposition>
<totalcount>43</totalcount>
<pagesize>25</pagesize>
</resultcounters>
<results>
<result>
<name>I B M INTERNATIONAL SERVICES CORPORATION</name>
<number>FC017866</number>
<country>UK</country>
<address>OLD ORCHARD ROAD</address>
</result>
<result>
<name>I B M UNITED KINGDOM HOLDINGS LIMITED</name>
<number>00122953</number>
<country>UK</country>
<address>P.O. BOX 41</address>
</result>
<result>
<name>I B MACFADZEAN LIMITED</name>
<number>SC254976</number>
<country>UK</country>
<address>226 KING STREET</address>
</result>
|
Figure 12: XML Over HTTP/REST Response
Please refer to the documentation for more
information about calling GetData using XML Over HTTP/REST.
Refer to the example client applications to see an example calling data using XML Over HTTP/REST.
|
|
|
Simple Object Access Protocol (SOAP)
Calling GetData using SOAP is a case of passing the request XML within a SOAP message. Figure 13 shows
how the service can be called using SOAP. As SOAP is itself an XML structure the actual GetData request
XML needs to be encoded so that "<" characters are displayed as < and the ">"
characters are displayed as >.
<xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://wwww.w3.org/2001/XMLSchema"
xmlns:soap="http://shemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetData xmlns:="https://www.creditsafeuk.com/getdatauk/service/">
<requestXmlStr>
<xmlrequest>
<header>
<username>DemoUser</username>
<password>Password</password&vgt;
<language>EN</language>
<operation>CompanySearch</operation>
<chargereference></chargereference>
</header>
<body>
<country>UK</country>
<name>ibm</name>
<namesearchmode>begin</namesearchmode>
<startposition>1</startposition>
<pagesize>25</pagesize>
</body>
</xmlrequest>
</requestXmlStr>
</GetData>
</soap:Body>
</soap:Envelope>
|
Figure 13: SOAP Request
Figure 14 shows a typical response received from the SOAP request shown in Figure 13.
<xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://wwww.w3.org/2001/XMLSchema"
xmlns:soap="http://shemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetDataResponse
xmlns:="https://www.creditsafeuk.com/getdatauk/service/">
<GetDataResponse>
<xmlresponse>
<header>
<reportinformation>
<time>22/06/2006 11:46:28</time>
<reporttype>CompanySearch</reporttype>
<country>UK</country>
<version>4.0</version>
<provider>www.creditsafe.com</provider>
<chargereference></chargereference>
</reportinformation>
</header>
<body>
<resultcounters>
<startposition>1</startposition>
<endposition>25</endposition>
<totalcount>43</totalcount>
<pagesize>25</pagesize>
</resultcounters>
<results>
<result>
<name>I B M INTERNATIONAL SERVICES CORPORATION</name>
<number>FC017866</number>
<country>UK</country>
<address>OLD ORCHARD ROAD</address>
</result>
<result>
<name>I B M UNITED KINGDOM HOLDINGS LIMITED</name>
<number>00122953</number>
<country>UK</country>
<address>P.O. BOX 41</address>
</result>
<result>
<name>I B MACFADZEAN LIMITED</name>
<number>SC254976</number>
<country>UK</country>
<address>226 KING STREET</address>
</result>
</GetDataResponse>
</GetDataResponse>
</soap:Body>
</soap:Envelope>
|
Figure 14: SOAP Response
Please refer to the documentation for more
information about calling GetData using SOAP.
Refer to the example client applications to see an example calling data using SOAP.
|
|
|
|
|
|
|
|