Documentation

T2A API Documentation

  1. Introduction
  2. General API Guide
    1. API Endpoint & Authentication
    2. Free Test Mode
    3. XML and JSON REST API Overview
    4. URL Encoding a GET Request
    5. SOAP API
    6. Using XML, JSON and SOAP Methods
    7. Asynchronous Methods
    8. Using Your Account Control Panel
    9. Security
  3. Code Examples
  4. XML, JSON and SOAP API Details
    1. General XML, JSON and SOAP Overview
    2. A JavaScript Key
    3. Security
    4. Invoking Methods
    5. Using T2A from JavaScript
    6. .NET Developers and the SOAP API
    7. Result Page Caching
    8. Common XML, JSON and SOAP Error Codes
    9. Common Response Structures
  5. Appendices
    1. ISO 3166-1 Country Codes
    2. Co-ordinate Systems
    3. Data Sources
    4. Company Categories
    5. Company Form Types
    6. Company Officer Disqualification Details
    7. Company Officer Types
    8. Company Statuses

.NET Developers and the SOAP API

.NET developers using Visual Studio should create a web reference using https://api.t2a.io/soap

In the examples below, our web reference is named t2a. The class containing the methods is named t2a.T2A, and the result classes are also in the t2a namespace.

This is a C# illustration of the use of the ip_location method:-

// create a web reference using https://api.t2a.io/soap
//
// the reference here is named t2a, and the class is called T2A
//
// create an instance of t2a.T2A
t2a.T2A myclass = new t2a.T2A();
// the result class is also in t2a
//
t2a.ip_location_res res = myclass.ip_location(api_key, null, ip_address);
// check the status, if ok, display results, otherwise display the error
if (res.status.CompareTo("ok") == 0)

This is a Visual Basic illustration of the use of ip_location:-

' execute the method
' replace with your own API key
Dim api_key As String = "---"
' create a web reference using https://api.t2a.io/soap
' the reference here is named t2a, and the class is called T2A
' create an instance of t2a.T2A
Dim myclass2 As New t2a.T2A()
' the result class is also in t2a
Dim res As t2a.ip_location_res = myclass2.ip_location(api_key, "",
ip_address)
' check the status, if ok, display results, otherwise display the error
If (res.status = "ok") Then

Next: Result Page Caching