Reference for http://services.cro.ie/cws/companies?company_num={COMPANY_NUM}&company_name={COMPANY_NAME}&alpha={ALPHA}&company_bus_ind={COMPANY_BUS_IND}&searchType={SEARCHTYPE}&address={ADDRESS}&skip={SKIP}&max={MAX}&sortBy={SORTBY}&sortDir={SORTDIR}&format={FORMAT}&htmlEnc={HTMLENC}
Performs a search of Company and Business Names. Returns a maximum of 250 possible matches. 'company_name' is the Company/Business name. 'company_bus_ind' is the Company/Business indicator. If excluded or left empty, only Companies will be returned. To specify companies explicitly in the query string, it should be set to C. For business names, set to B. To return both companies AND business names, set to E (may add significant delay). 'searchType' is the Search Type: 1=Exact Match, 2=Starts with (default), 3=Contains phrase (slowest). The Search Type only applies to the 'company_name' parameter. 'address' is any part of the Company Address. 'skip' is for specifying how many rows to skip over in results. 'max' is the maximum number of rows to return. Set 'htmlEnc=1' if you want to display the results in a web page with Html encoding
Url: http://services.cro.ie/cws/companies?company_num={COMPANY_NUM}&company_name={COMPANY_NAME}&alpha={ALPHA}&company_bus_ind={COMPANY_BUS_IND}&searchType={SEARCHTYPE}&address={ADDRESS}&skip={SKIP}&max={MAX}&sortBy={SORTBY}&sortDir={SORTDIR}&format={FORMAT}&htmlEnc={HTMLENC}
HTTP Method: GET
| Message direction | Format | Body |
|---|---|---|
| Request | N/A | The Request body is empty. |
| Response | Xml | Example,Schema |
| Response | Json | Example |
The following is an example response Xml body:
<ArrayOfCompany xmlns="services.cro.ie">
<Company>
<company_num>2147483647</company_num>
<company_bus_ind>String content</company_bus_ind>
<company_name>String content</company_name>
<company_addr_1>String content</company_addr_1>
<company_addr_2>String content</company_addr_2>
<company_addr_3>String content</company_addr_3>
<company_addr_4>String content</company_addr_4>
<company_reg_date>String content</company_reg_date>
<company_status_desc>String content</company_status_desc>
<company_status_date>String content</company_status_date>
<last_ar_date>String content</last_ar_date>
<next_ar_date>String content</next_ar_date>
<last_acc_date>String content</last_acc_date>
<comp_type_desc>String content</comp_type_desc>
<company_type_code>2147483647</company_type_code>
<company_status_code>2147483647</company_status_code>
<place_of_business>String content</place_of_business>
<eircode>String content</eircode>
</Company>
<Company>
<company_num>2147483647</company_num>
<company_bus_ind>String content</company_bus_ind>
<company_name>String content</company_name>
<company_addr_1>String content</company_addr_1>
<company_addr_2>String content</company_addr_2>
<company_addr_3>String content</company_addr_3>
<company_addr_4>String content</company_addr_4>
<company_reg_date>String content</company_reg_date>
<company_status_desc>String content</company_status_desc>
<company_status_date>String content</company_status_date>
<last_ar_date>String content</last_ar_date>
<next_ar_date>String content</next_ar_date>
<last_acc_date>String content</last_acc_date>
<comp_type_desc>String content</comp_type_desc>
<company_type_code>2147483647</company_type_code>
<company_status_code>2147483647</company_status_code>
<place_of_business>String content</place_of_business>
<eircode>String content</eircode>
</Company>
</ArrayOfCompany>
The following is an example response Json body:
[{
"company_num":2147483647,
"company_bus_ind":"String content",
"company_name":"String content",
"company_addr_1":"String content",
"company_addr_2":"String content",
"company_addr_3":"String content",
"company_addr_4":"String content",
"company_reg_date":"String content",
"company_status_desc":"String content",
"company_status_date":"String content",
"last_ar_date":"String content",
"next_ar_date":"String content",
"last_acc_date":"String content",
"comp_type_desc":"String content",
"company_type_code":2147483647,
"company_status_code":2147483647,
"place_of_business":"String content",
"eircode":"String content"
}]
The following is the response Xml Schema:
<xs:schema xmlns:tns="services.cro.ie" elementFormDefault="qualified" targetNamespace="services.cro.ie" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:complexType name="ArrayOfCompany">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="Company" nillable="true" type="tns:Company" />
</xs:sequence>
</xs:complexType>
<xs:element name="ArrayOfCompany" nillable="true" type="tns:ArrayOfCompany" />
<xs:complexType name="Company">
<xs:sequence>
<xs:element minOccurs="0" name="company_num" type="xs:int" />
<xs:element minOccurs="0" name="company_bus_ind" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="company_name" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="company_addr_1" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="company_addr_2" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="company_addr_3" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="company_addr_4" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="company_reg_date" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="company_status_desc" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="company_status_date" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="last_ar_date" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="next_ar_date" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="last_acc_date" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="comp_type_desc" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="company_type_code" type="xs:int" />
<xs:element minOccurs="0" name="company_status_code" type="xs:int" />
<xs:element minOccurs="0" name="place_of_business" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="eircode" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:element name="Company" nillable="true" type="tns:Company" />
</xs:schema>
Additional response Xml Schemas:
<xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/" attributeFormDefault="qualified" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="anyType" nillable="true" type="xs:anyType" />
<xs:element name="anyURI" nillable="true" type="xs:anyURI" />
<xs:element name="base64Binary" nillable="true" type="xs:base64Binary" />
<xs:element name="boolean" nillable="true" type="xs:boolean" />
<xs:element name="byte" nillable="true" type="xs:byte" />
<xs:element name="dateTime" nillable="true" type="xs:dateTime" />
<xs:element name="decimal" nillable="true" type="xs:decimal" />
<xs:element name="double" nillable="true" type="xs:double" />
<xs:element name="float" nillable="true" type="xs:float" />
<xs:element name="int" nillable="true" type="xs:int" />
<xs:element name="long" nillable="true" type="xs:long" />
<xs:element name="QName" nillable="true" type="xs:QName" />
<xs:element name="short" nillable="true" type="xs:short" />
<xs:element name="string" nillable="true" type="xs:string" />
<xs:element name="unsignedByte" nillable="true" type="xs:unsignedByte" />
<xs:element name="unsignedInt" nillable="true" type="xs:unsignedInt" />
<xs:element name="unsignedLong" nillable="true" type="xs:unsignedLong" />
<xs:element name="unsignedShort" nillable="true" type="xs:unsignedShort" />
<xs:element name="char" nillable="true" type="tns:char" />
<xs:simpleType name="char">
<xs:restriction base="xs:int" />
</xs:simpleType>
<xs:element name="duration" nillable="true" type="tns:duration" />
<xs:simpleType name="duration">
<xs:restriction base="xs:duration">
<xs:pattern value="\-?P(\d*D)?(T(\d*H)?(\d*M)?(\d*(\.\d*)?S)?)?" />
<xs:minInclusive value="-P10675199DT2H48M5.4775808S" />
<xs:maxInclusive value="P10675199DT2H48M5.4775807S" />
</xs:restriction>
</xs:simpleType>
<xs:element name="guid" nillable="true" type="tns:guid" />
<xs:simpleType name="guid">
<xs:restriction base="xs:string">
<xs:pattern value="[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}" />
</xs:restriction>
</xs:simpleType>
<xs:attribute name="FactoryType" type="xs:QName" />
<xs:attribute name="Id" type="xs:ID" />
<xs:attribute name="Ref" type="xs:IDREF" />
</xs:schema>
<tns:schema targetNamespace="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://www.w3.org/2001/XMLSchema">
<tns:element name="schema">
<tns:complexType />
</tns:element>
</tns:schema>