T2A
Click here for a complete list of operations.
company_mortgage_index
Obtain the mortgage charge information for a UK company.
Using a full company number, this method returns a list of charges past and present against the company.
The information includes the name of the person or body entitled to that charge, the status of the charge, and the relevant dates.
Test
To test the operation using the HTTP POST protocol, click the 'Invoke' button.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_mortgage_index" <?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_mortgage_index 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_mortgage_index> </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_mortgage_indexResponse xmlns="https://api.t2a.io/soap"> <company_mortgage_indexResult> <previous_page_id>string</previous_page_id> <next_page_id>string</next_page_id> <charge_list> <company_charge> <charge_number>string</charge_number> <description>string</description> <creation_date>string</creation_date> <registration_date>string</registration_date> <charge_satisfied>string</charge_satisfied> <person_entitled_list xsi:nil="true" /> <alteration_indicator>string</alteration_indicator> <detail_on_fiche_ind>string</detail_on_fiche_ind> <receiver_appt_ind>string</receiver_appt_ind> <charge_type>string</charge_type> <satistfied_date>string</satistfied_date> <amount>string</amount> </company_charge> <company_charge> <charge_number>string</charge_number> <description>string</description> <creation_date>string</creation_date> <registration_date>string</registration_date> <charge_satisfied>string</charge_satisfied> <person_entitled_list xsi:nil="true" /> <alteration_indicator>string</alteration_indicator> <detail_on_fiche_ind>string</detail_on_fiche_ind> <receiver_appt_ind>string</receiver_appt_ind> <charge_type>string</charge_type> <satistfied_date>string</satistfied_date> <amount>string</amount> </company_charge> </charge_list> </company_mortgage_indexResult> </company_mortgage_indexResponse> </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_mortgage_index 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_mortgage_index> </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_mortgage_indexResponse xmlns="https://api.t2a.io/soap"> <company_mortgage_indexResult> <previous_page_id>string</previous_page_id> <next_page_id>string</next_page_id> <charge_list> <company_charge> <charge_number>string</charge_number> <description>string</description> <creation_date>string</creation_date> <registration_date>string</registration_date> <charge_satisfied>string</charge_satisfied> <person_entitled_list xsi:nil="true" /> <alteration_indicator>string</alteration_indicator> <detail_on_fiche_ind>string</detail_on_fiche_ind> <receiver_appt_ind>string</receiver_appt_ind> <charge_type>string</charge_type> <satistfied_date>string</satistfied_date> <amount>string</amount> </company_charge> <company_charge> <charge_number>string</charge_number> <description>string</description> <creation_date>string</creation_date> <registration_date>string</registration_date> <charge_satisfied>string</charge_satisfied> <person_entitled_list xsi:nil="true" /> <alteration_indicator>string</alteration_indicator> <detail_on_fiche_ind>string</detail_on_fiche_ind> <receiver_appt_ind>string</receiver_appt_ind> <charge_type>string</charge_type> <satistfied_date>string</satistfied_date> <amount>string</amount> </company_charge> </charge_list> </company_mortgage_indexResult> </company_mortgage_indexResponse> </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_mortgage_index?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_mortgage_index_res xmlns="https://api.t2a.io/soap"> <previous_page_id>string</previous_page_id> <next_page_id>string</next_page_id> <charge_list> <company_charge> <charge_number>string</charge_number> <description>string</description> <creation_date>string</creation_date> <registration_date>string</registration_date> <charge_satisfied>string</charge_satisfied> <person_entitled_list> <company_charge_person_entitled d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <company_charge_person_entitled d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> </person_entitled_list> <alteration_indicator>string</alteration_indicator> <detail_on_fiche_ind>string</detail_on_fiche_ind> <receiver_appt_ind>string</receiver_appt_ind> <charge_type>string</charge_type> <satistfied_date>string</satistfied_date> <amount>string</amount> </company_charge> <company_charge> <charge_number>string</charge_number> <description>string</description> <creation_date>string</creation_date> <registration_date>string</registration_date> <charge_satisfied>string</charge_satisfied> <person_entitled_list> <company_charge_person_entitled d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <company_charge_person_entitled d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> </person_entitled_list> <alteration_indicator>string</alteration_indicator> <detail_on_fiche_ind>string</detail_on_fiche_ind> <receiver_appt_ind>string</receiver_appt_ind> <charge_type>string</charge_type> <satistfied_date>string</satistfied_date> <amount>string</amount> </company_charge> </charge_list> </company_mortgage_index_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_mortgage_index 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_mortgage_index_res xmlns="https://api.t2a.io/soap"> <previous_page_id>string</previous_page_id> <next_page_id>string</next_page_id> <charge_list> <company_charge> <charge_number>string</charge_number> <description>string</description> <creation_date>string</creation_date> <registration_date>string</registration_date> <charge_satisfied>string</charge_satisfied> <person_entitled_list> <company_charge_person_entitled d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <company_charge_person_entitled d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> </person_entitled_list> <alteration_indicator>string</alteration_indicator> <detail_on_fiche_ind>string</detail_on_fiche_ind> <receiver_appt_ind>string</receiver_appt_ind> <charge_type>string</charge_type> <satistfied_date>string</satistfied_date> <amount>string</amount> </company_charge> <company_charge> <charge_number>string</charge_number> <description>string</description> <creation_date>string</creation_date> <registration_date>string</registration_date> <charge_satisfied>string</charge_satisfied> <person_entitled_list> <company_charge_person_entitled d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <company_charge_person_entitled d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> </person_entitled_list> <alteration_indicator>string</alteration_indicator> <detail_on_fiche_ind>string</detail_on_fiche_ind> <receiver_appt_ind>string</receiver_appt_ind> <charge_type>string</charge_type> <satistfied_date>string</satistfied_date> <amount>string</amount> </company_charge> </charge_list> </company_mortgage_index_res>