T2A Web Service

T2A

Click here for a complete list of operations.

company_appointments

Obtain a list of the officer appointments for a UK company.

Using a full company number, this method returns a list of the appointments of company directors, secretaries and other officers.

The data for each individual includes:-

Full address
Date of birth
Type of appointment
Director ID (can be used in the 'director_details' method)

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

Parameter	Value
api_key:
client:
company_number:
page_id:

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /soap/t2a.asmx HTTP/1.1
Host: api.t2a.io
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://api.t2a.io/soap/company_appointments"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <company_appointments xmlns="https://api.t2a.io/soap">
      <api_key>string</api_key>
      <client>string</client>
      <company_number>string</company_number>
      <page_id>string</page_id>
    </company_appointments>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <company_appointmentsResponse xmlns="https://api.t2a.io/soap">
      <company_appointmentsResult>
        <previous_page_id>string</previous_page_id>
        <next_page_id>string</next_page_id>
        <appt_list>
          <director>
            <director_appt_list xsi:nil="true" />
            <director_disq_list xsi:nil="true" />
            <num_current_appt>string</num_current_appt>
            <num_resigned_appt>string</num_resigned_appt>
            <num_dissolved_appt>string</num_dissolved_appt>
            <num_appt>string</num_appt>
            <nationality>string</nationality>
            <country_state_of_residence>string</country_state_of_residence>
            <corporate_indicator>string</corporate_indicator>
            <officer_type>string</officer_type>
            <service_address_list xsi:nil="true" />
          </director>
          <director>
            <director_appt_list xsi:nil="true" />
            <director_disq_list xsi:nil="true" />
            <num_current_appt>string</num_current_appt>
            <num_resigned_appt>string</num_resigned_appt>
            <num_dissolved_appt>string</num_dissolved_appt>
            <num_appt>string</num_appt>
            <nationality>string</nationality>
            <country_state_of_residence>string</country_state_of_residence>
            <corporate_indicator>string</corporate_indicator>
            <officer_type>string</officer_type>
            <service_address_list xsi:nil="true" />
          </director>
        </appt_list>
      </company_appointmentsResult>
    </company_appointmentsResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /soap/t2a.asmx HTTP/1.1
Host: api.t2a.io
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <company_appointments xmlns="https://api.t2a.io/soap">
      <api_key>string</api_key>
      <client>string</client>
      <company_number>string</company_number>
      <page_id>string</page_id>
    </company_appointments>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <company_appointmentsResponse xmlns="https://api.t2a.io/soap">
      <company_appointmentsResult>
        <previous_page_id>string</previous_page_id>
        <next_page_id>string</next_page_id>
        <appt_list>
          <director>
            <director_appt_list xsi:nil="true" />
            <director_disq_list xsi:nil="true" />
            <num_current_appt>string</num_current_appt>
            <num_resigned_appt>string</num_resigned_appt>
            <num_dissolved_appt>string</num_dissolved_appt>
            <num_appt>string</num_appt>
            <nationality>string</nationality>
            <country_state_of_residence>string</country_state_of_residence>
            <corporate_indicator>string</corporate_indicator>
            <officer_type>string</officer_type>
            <service_address_list xsi:nil="true" />
          </director>
          <director>
            <director_appt_list xsi:nil="true" />
            <director_disq_list xsi:nil="true" />
            <num_current_appt>string</num_current_appt>
            <num_resigned_appt>string</num_resigned_appt>
            <num_dissolved_appt>string</num_dissolved_appt>
            <num_appt>string</num_appt>
            <nationality>string</nationality>
            <country_state_of_residence>string</country_state_of_residence>
            <corporate_indicator>string</corporate_indicator>
            <officer_type>string</officer_type>
            <service_address_list xsi:nil="true" />
          </director>
        </appt_list>
      </company_appointmentsResult>
    </company_appointmentsResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /soap/t2a.asmx/company_appointments?api_key=string&client=string&company_number=string&page_id=string HTTP/1.1
Host: api.t2a.io

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<company_appointments_res xmlns="https://api.t2a.io/soap">
  <previous_page_id>string</previous_page_id>
  <next_page_id>string</next_page_id>
  <appt_list>
    <director>
      <director_appt_list>
        <director_appt d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <director_appt d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </director_appt_list>
      <director_disq_list>
        <director_disq d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <director_disq d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </director_disq_list>
      <num_current_appt>string</num_current_appt>
      <num_resigned_appt>string</num_resigned_appt>
      <num_dissolved_appt>string</num_dissolved_appt>
      <num_appt>string</num_appt>
      <nationality>string</nationality>
      <country_state_of_residence>string</country_state_of_residence>
      <corporate_indicator>string</corporate_indicator>
      <officer_type>string</officer_type>
      <service_address_list>
        <address d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <address d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </service_address_list>
    </director>
    <director>
      <director_appt_list>
        <director_appt d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <director_appt d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </director_appt_list>
      <director_disq_list>
        <director_disq d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <director_disq d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </director_disq_list>
      <num_current_appt>string</num_current_appt>
      <num_resigned_appt>string</num_resigned_appt>
      <num_dissolved_appt>string</num_dissolved_appt>
      <num_appt>string</num_appt>
      <nationality>string</nationality>
      <country_state_of_residence>string</country_state_of_residence>
      <corporate_indicator>string</corporate_indicator>
      <officer_type>string</officer_type>
      <service_address_list>
        <address d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <address d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </service_address_list>
    </director>
  </appt_list>
</company_appointments_res>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /soap/t2a.asmx/company_appointments HTTP/1.1
Host: api.t2a.io
Content-Type: application/x-www-form-urlencoded
Content-Length: length

api_key=string&client=string&company_number=string&page_id=string

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<company_appointments_res xmlns="https://api.t2a.io/soap">
  <previous_page_id>string</previous_page_id>
  <next_page_id>string</next_page_id>
  <appt_list>
    <director>
      <director_appt_list>
        <director_appt d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <director_appt d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </director_appt_list>
      <director_disq_list>
        <director_disq d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <director_disq d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </director_disq_list>
      <num_current_appt>string</num_current_appt>
      <num_resigned_appt>string</num_resigned_appt>
      <num_dissolved_appt>string</num_dissolved_appt>
      <num_appt>string</num_appt>
      <nationality>string</nationality>
      <country_state_of_residence>string</country_state_of_residence>
      <corporate_indicator>string</corporate_indicator>
      <officer_type>string</officer_type>
      <service_address_list>
        <address d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <address d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </service_address_list>
    </director>
    <director>
      <director_appt_list>
        <director_appt d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <director_appt d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </director_appt_list>
      <director_disq_list>
        <director_disq d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <director_disq d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </director_disq_list>
      <num_current_appt>string</num_current_appt>
      <num_resigned_appt>string</num_resigned_appt>
      <num_dissolved_appt>string</num_dissolved_appt>
      <num_appt>string</num_appt>
      <nationality>string</nationality>
      <country_state_of_residence>string</country_state_of_residence>
      <corporate_indicator>string</corporate_indicator>
      <officer_type>string</officer_type>
      <service_address_list>
        <address d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <address d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </service_address_list>
    </director>
  </appt_list>
</company_appointments_res>