All the request parameters for the 'getCompanyMatchesByIdentifier' operation. All the request parameters for the 'getCompanyMatchesByName' operation. Full or partial name of the company to be matched. City of the company being matched. Use this if applicable to narrow down the matched list returned. All the request parameters for the 'getCompanyMatchesByKeyword' operation. Keyword to perform the match with. This should be one or part of one of the words the company name is constituted of. The city name of the company to be matched. Use exclusively with the 'Keyword' parameter. Postcode of the company being matched. Use exclusively with the 'Keyword' parameter. All response elements for the 'getCompanyMatch*' operations. Client reference associate with match request. All the request parameters for the 'getCompanyProducts' operation. This parameter should be populated with the 'CompanyMatchIdentifier' returned in the 'getCompanyMatches*' operation response. It is unique to the country matched company. All the response elements for the 'getCompanyProducts' operation. All the response elements for the 'getCompanyReport' operation. The value for this element determines whether 'ReportXML', 'ReportBinary' or 'ReportText' will be populated with the report. For example if the 'ReportMimeType' value is 'pdf' then the 'ReportBinary' element contains the report. 'ReportMimeType' value is 'xml' then the 'ReportXML' element contains the report. 'ReportMimeType' value is 'html' then the 'ReportText' element contains the report. The report as XML elements. The schema the XML relates to depends on individual partner configuration. The default schema is the 'GraydonUKCompanySchema'. This will be populated for reports requested with mime type 'xml' The report as a binary string. This will contain any binary format mime type requested. The report as a text string. This will be populated for reports requested with mime type 'htmll'. All the request parameters for the 'getCompanyReport' operation. Language the resulting report should be in. The default is 'E' for English. This parameter should be populated with the eqvilant 'OrderReference' element returned in the response for the 'placeOrder' operation. The mime type the resulting report should be in. i.e. 'xml', 'html'. All the request parameters for the 'getCountryAvailability' operation. Specify the 'Country' parameter to return the available countries and products for a single country. Omit this parameter and all countries and their respective products are returned. All the response elements for the 'getCompanyReport' operation. Parameters required for requesting the availability of products for all or a specified country Result of requesting the availability of products for all or a specified country This is the fault response. It is return if incorrect use of the webservice is detected or 'expected' and 'unexpected' errors are encountered. Unique transaction identifier. This provides a quick and simple way to refer to problem or suspect requests/responses through the web service. The 'FaultType' can be 'expected' or 'unexpected' 'expected' describes errors that are encountered during the normal flow of processing service operations. These should be coded for by the partner. 'unexpected' can relate to connectivity, system or application errors that are not in the normal flow of processing. The fault is a unquie identifier for the error encountered. A description or stack trace of the error. A 'tip' in English on possible solution to rectifying the error. All the request parameters for the 'getCompanyMatchesByPostCode' operation. Postal code for the company to be matched. This can be partial of full. Details logged on for the webservice request and response Authentication parameters mandatory for every operation requested Graydon supplied unique client user identifier Graydon supplied user identifier related password Partner supplied client identifier. Used for transaction auditing purposes. Graydon supplied unique session identifier. For faster and more reliable response implementation of sessions use is recommended. Standard service response information Unique transaction identifier. This provides a quick and simple way to refer to problem or suspect requests/responses through the web service. Unique session identifier Recorded date and time for receipt of the service request Recorded date and time for delivery of the service response. Service additional diagnostic information. Help to determine any problems whilst using the service. This details all information relating to the country and it's related products. Country whose availability is being scrutinised. All the details related to a product. This is the speed of service available for the product. This is only supplied for products that require an agency investigate of the subject company. The product level relates to the level of data available for this type of product. '1' representing the lowest. Type of product this can either be 'Database' which means the report will be built from existing data on the database, or 'Investigation' which requires a reporter to collate further information on the subject company and add it to the database in order for a report to be built. Number of delivery days from. Number of delivery days to. This is a unique identifier that should be used to when the subsequent 'placeOrder' operation is used. Standard company match parameters. The country to find matches in. Client reference relating to this match request. Details of a subject company. Name of the subject company. Unique match identifier, supplied to be used for product availabilty checking. Registered address for the subject company Trading address of the subject company Date the subject company was incorporated Date the subject company was known since. Date for the subject company's annual return. Date of the latest accounts held in association to the subject company. Date the subject company's accounts were last filed. A single or many 'CountryAndProduct' elements. A single or many 'Product' elements. Legal form for the subject company. Unique graydon code used to define legal form Local country agency code used to define legal form Legal form description One or may 'Activity' elements Activity of the subject company The type of classification system for which Code is meaningful. Examples include SIC or NACE. Activity description code. For example, if the Type is SIC (Standard Industrial Classification), the value for Code will be the company's SIC code. The textual description of the Code. For example, if the Type is "NACE" and Code is '6420' the description would be 'A group engaged in the supply of communication products, services and equipment.' All the response elements for the 'placeOrder' operation. All the request parameters for the 'placeOrder' operation. This parameter is user defined and can be used in conjuction with specific solutions provided by Graydon This parameter should be populated with the person who created the order. It is mandatory. Any future problems encountered due to the order detail can be corresponded through this email address. This parameter should be populated with the 'CompanyProductIdentifier' returned in the response for the 'getCompanyProducts' operation. Each 'Product' element in this response contains one of these elements with a session unique value. Order details. Language of the ordered report Name of the subject company Speed of service for the ordered report. Country of the subject company. Registered address of the subject company. Company Identifiers used for the subject company. Partner's credit opinion value for the subject company. Partner's credit opinion currency for the credit opinion. Partner's credit opinion period for the credit opinion. Client reference for the order. Attention of detail for the order Bankers details for the subject company Special remarks on the subject company Telephone number for the subject company. All status and detail for a specific order Graydon's unique order reference for this order. The current state of the order i.e. 'Complete' The date the order was placed. The date the order was completed Date the order is due. This is only applicable to investigated orders. All the request parameters for the 'ping' operation. The method to be used to ping the service. All the response elements for the 'getDemoCompanies' operation. Use this element to determine what state the service is in. The possible values are 'ServiceAvailable', 'ServiceNotAvailable' Information message in English about the state of the service. All the request parameters for the 'getCompanyMatchIdentifiers' operation. Specify a 'Country' parameter for an exact response on that country. No 'Country' parameter specified and all online countries and related identifiers are returned. All the response elements for the 'getCompanyMatchIdentifiers' operation. All request parameters for the 'checkOrders' operation. Graydon's unique order reference, supplied when the order was orginally placed. Use when a single order is to be checked. Using this in conjunction with the 'DateFrom', 'DateTo' parameters is optional. Current date is assumed if not supplied. This determines which state type i.e. 'Completed' the returned orders are in. Use this in conjunction with the 'OrderState' and 'DateTo' parameters. All response elements for the 'checkOrders' operation. Indentifiers used for the subject company. Identifier for the subject company Type of identifier for the subject company Description in english for the type of identifier for the subject company. This is not required for matching. One or many Company Identifiers One or more 'OrderStatus' elements All the request parameters for the 'getDemoCompanies' operation. Specify the 'Country' parameter to return the demostration companies for a single country. Omit this parameter and all countries and their respective demostration companies are returned. All the response elements for the 'getDemoCompanies' operation. A single or many 'Company' elements. Company match identifier contains elements for company identfier per country. One or many 'CompanyMatchIdentifier' elements. All the request parameters for the 'getCompanyMatchMethods' operation. Specify the 'Country' parameter and 'MatchMethods' for a single country will be in the response. No 'Country' parameter specified and 'MatchMethods' for every available online country will be returned. All the response elements for the 'getCompanyMatchMethods' operation. All the available match methods per country. Online country name. A single or many 'CompanyMatchMethod' elements. Descriptive detail of the match method. If more than one 'MatchMethod' is provided, then their order dictates the usage preference. If this element is 'true' then this 'MatchMethod' iteration is to be considered the best match method within its context. This is the matching method e.g. 'Keyword', 'Name' etc. If 'true' then the 'City' parameter may also be supplied for the match. If true then the 'PostCode' parameter may also be supplied for the match. A description in English detailing the match methods and any possible idiosyncrasies A single or more 'MatchMethod' elements. A single or many 'MimeType' elements. The format of the report e.g. 'xml'. This contains the type of partner element as defined by the partner This determines whether the 'Value' parmaeter contains 'Numeric' or 'String' formatted data. This is the value of the partner element Specify the 'Country' parameter to return the available countries and products for a single country. All the request parameters for the 'getCompanyMatchesByPostCode' operation. Get a match for a company by using the appropriate identifier for the country being matched in. Specify the 'Country' parameter within the 'CompanyMatches_Parameters', also supply the 'CompanyIdentifier' parameter. Determine which identifier should be supplied by using the 'getCompanyMatchIdentifiers' operation beforehand, this response with the identifier type used to search in the desired country. Determine which search method is available and which of these is the best using the 'getCompanyMatchMethods', the response will give you an array of available match methods. The response is a single 'Company' element within the 'CompanyMatches' element, this has all the information on the matched company held in many elements. If no companies are found to match the given search criteria a 'graydonComanyData_Fault' is thrown containing appropriate error information. Get a list of matches for a company by using the company name and city for the country being matched in. Specify the 'Country' parameter within the 'CompanyMatches_Parameters', also supply the 'Name', 'City' parameter (The last element is optional). Determine which search method is available and which of these is the best using the 'getCompanyMatchMethods', the response will give you an array of available match methods. The response is an array of 'Company' elements within the 'CompanyMatches' element, this has all the information on the matched company held in many elements. If no companies are found to match the given search criteria a 'graydonComanyData_Fault' is thrown containing appropriate error information. Get a list of matches for a company by using the a company name keyword and city/postcode for the country being matched in. Specify the 'Country' parameter within the 'CompanyMatches_Parameters', also supply the 'Keyword', 'City' and 'PostCode' parameter (Last two elements are optional). Determine which identifier should be suDetermine which search method is available and which of these is the best using the 'getCompanyMatchMethods', the response will give you an array of available match methods. The response is an array of 'Company' elements within the 'CompanyMatches' element, this has all the information on the matched company held in many elements. If no companies are found to match the given search criteria a 'graydonComanyData_Fault' is thrown containing appropriate error information. Get the list of products and their availability for a subject company. Provide the 'CompanyMatchIdentifier' parameter (This is provided on each company match). The subject company should be identified via a matching operation prior to this operations use. Get the report for your subject company. Provide the 'OrderReference' parameter which was returned when the 'placeOrder' operation was performed. You can only get a company report once the originating order's state is either 'Completed', 'CompletedwithUpdate' or 'Delivered'. Determine the order's state using the 'checkOrders' operation. The 'MimeType' parameter determines which of these are populated with the report 'ReportXML', 'ReportBinary' and 'ReportText'. Place an order for a report on the subject company. Provide the 'CompanyProductIdentifier' parameter returned from the 'getCompanyProducts'. The subject company should be have it's product availability checked prior to this operations use. The response contains a unique 'OrderReference' is returned, to be later used to get the report. It also the 'OrderState' within the 'OrderStatus' element, use this to determine if the 'getReport' operation can be performed for the order. Get the availability of products and services for a single or all countries. Provide the 'Country' parameter when a single country is desired. The response contains a single or multiple 'CountryAndProduct' elements which inturn cotains the 'Country' and multiple 'Product' elements with the relevant details. Get a list of matches for a company by using the company's postcode for the country being matched in. Specify the 'Country' parameter within the 'CompanyMatches_Parameters', also supply the 'Name', 'City' parameter (The last element is optional). Determine which search method is available and which of these is the best using the 'getCompanyMatchMethods', the response will give you an array of available match methods. The response is an array of 'Company' elements within the 'CompanyMatches' element, this has all the information on the matched company held in many elements. If no companies are found to match the given search criteria a 'graydonComanyData_Fault' is thrown containing appropriate error information. This operation can be performed in using two methods "basic" or "complete", as specified in the "PingMethod" parameter for the operation. The "basic" method is simply to confirm that the 'GraydonCompanyData' web service is available. This could be used to log supposed availability of the service on a periodic basis. The "complete" method actually performs a check on backend servers and is therefore more comprehensive. You could use this before performing a periodic batch operation, to determine whether it should be run. Get a list of company identifiers for a single or all country. Provide the 'Country' parameter to request identifiers for a single country. Use this to determine which type of identifier can be used with the 'getCompanyMatchesByIdentifier' method. The response contains an array of 'CompanyMatchIdentifier', each containing the related 'Country' and the 'CompanyIdentifier' element holding the 'Type' for that country. Check the status and detail of a single or all order history within a given period. The period can be specified using the 'DateFrom' 'DateTo' parameters, along with the type of order state you wish returned using the 'OrderState' parameter. A single order can be checked using just the 'OrderReference' parameter. The response will contains the 'OrdersStatus' element which in turn holds one ore more 'OrderStatus' elements. This will have all the information relating to the order including it's unique 'OrderReference' element. This can be used to retrieve the related report if the order state is 'completed'. The maximum number of 'OrderStatus' elements returned is 250. Get the demonstration companies available for a single or all countries. Provide the 'Country' parameter when a single country is desired. The response contains a single or multiple 'Company' elements which icontains the relevant details for the demonstration company. Get the available matching methods for a single or all countries. Provide the 'Country' parameter if you want methods for a single country and not all. This helps determine the best search method to implement per country and the availability of additional search criteria such as 'City'. The response is a single or array of 'CompanyMatchMethods' each contains the related country and an array of available 'MatchMethod' elements. The order of the 'MatchMethods' elements determines order of preference for searching in that country. Get the available Graydon XSL stylesheets for a particular country. The stylesheets can be used to transform Graydon XML into HTML and are useful for determining how the GraydonCompanySchema is structured. Get a match for a company by using the appropriate identifier for the country being matched in. Specify the 'Country' parameter within the 'CompanyMatches_Parameters', also supply the 'CompanyIdentifier' parameter. Determine which identifier should be supplied by using the 'getCompanyMatchIdentifiers' operation beforehand, this response with the identifier type used to search in the desired country. Determine which search method is available and which of these is the best using the 'getCompanyMatchMethods', the response will give you an array of available match methods. The response is a single 'Company' element within the 'CompanyMatches' element, this has all the information on the matched company held in many elements. If no companies are found to match the given search criteria a 'graydonComanyData_Fault' is thrown containing appropriate error information. Get a list of matches for a company by using the company name and city for the country being matched in. Specify the 'Country' parameter within the 'CompanyMatches_Parameters', also supply the 'Name', 'City' parameter (The last element is optional). Determine which search method is available and which of these is the best using the 'getCompanyMatchMethods', the response will give you an array of available match methods. The response is an array of 'Company' elements within the 'CompanyMatches' element, this has all the information on the matched company held in many elements. If no companies are found to match the given search criteria a 'graydonComanyData_Fault' is thrown containing appropriate error information. Get a list of matches for a company by using the a company name keyword and city/postcode for the country being matched in. Specify the 'Country' parameter within the 'CompanyMatches_Parameters', also supply the 'Keyword', 'City' and 'PostCode' parameter (Last two elements are optional). Determine which search method is available and which of these is the best using the 'getCompanyMatchMethods', the response will give you an array of available match methods. The response is an array of 'Company' elements within the 'CompanyMatches' element, this has all the information on the matched company held in many elements. If no companies are found to match the given search criteria a 'graydonComanyData_Fault' is thrown containing appropriate error information. Get the list of products and their availability for a subject company. Provide the 'CompanyMatchIdentifier' parameter (This is provided on each company match). The subject company should be identified via a matching operation prior to this operations use. Get the report for your subject company. Provide the 'OrderReference' parameter which was returned when the 'placeOrder' operation was performed. You can only get a company report once the originating order's state is either 'Completed', 'CompletedwithUpdate' or 'Delivered'. Determine the order's state using the 'checkOrders' operation. The 'MimeType' parameter determines which of these are populated with the report 'ReportXML', 'ReportBinary' and 'ReportText'. Place an order for a report on the subject company. Provide the 'CompanyProductIdentifier' parameter returned from the 'getCompanyProducts'. The subject company should be have it's product availability checked prior to this operations use. The response contains a unique 'OrderReference' is returned, to be later used to get the report. It also the 'OrderState' within the 'OrderStatus' element, use this to determine if the 'getReport' operation can be performed for the order. Get the availability of products and services for a single or all countries. Provide the 'Country' parameter when a single country is desired. The response contains a single or multiple 'CountryAndProduct' elements which inturn cotains the 'Country' and multiple 'Product' elements with the relevant details. Get a list of matches for a company by using the company's postcode for the country being matched in. Specify the 'Country' parameter within the 'CompanyMatches_Parameters', also supply the 'Name', 'City' parameter (The last element is optional). Determine which search method is available and which of these is the best using the 'getCompanyMatchMethods', the response will give you an array of available match methods. The response is an array of 'Company' elements within the 'CompanyMatches' element, this has all the information on the matched company held in many elements. If no companies are found to match the given search criteria a 'graydonComanyData_Fault' is thrown containing appropriate error information. This operation can be performed in using two methods "basic" or "complete", as specified in the "PingMethod" parameter for the operation. The "basic" method is simply to confirm that the 'GraydonCompanyData' web service is available. This could be used to log supposed availability of the service on a periodic basis. The "complete" method actually performs a check on backend servers and is therefore more comprehensive. You could use this before performing a periodic batch operation, to determine whether it should be run. Get a list of company identifiers for a single or all country. Provide the 'Country' parameter to request identifiers for a single country. Use this to determine which type of identifier can be used with the 'getCompanyMatchesByIdentifier' method. The response contains an array of 'CompanyMatchIdentifier', each containing the related 'Country' and the 'CompanyIdentifier' element holding the 'Type' for that country. Check the status and detail of a single or all order history within a given period. The period can be specified using the 'DateFrom' 'DateTo' parameters, along with the type of order state you wish returned using the 'OrderState' parameter. A single order can be checked using just the 'OrderReference' parameter. The response will contains the 'OrdersStatus' element which in turn holds one ore more 'OrderStatus' elements. This will have all the information relating to the order including it's unique 'OrderReference' element. This can be used to retrieve the related report if the order state is 'completed'. The maximum number of 'OrderStatus' elements returned is 250. Get the demonstration companies available for a single or all countries. Provide the 'Country' parameter when a single country is desired. The response contains a single or multiple 'Company' elements which icontains the relevant details for the demonstration company. Get the available matching methods for a single or all countries. Provide the 'Country' parameter if you want methods for a single country and not all. This helps determine the best search method to implement per country and the availability of additional search criteria such as 'City'. The response is a single or array of 'CompanyMatchMethods' each contains the related country and an array of available 'MatchMethod' elements. The order of the 'MatchMethods' elements determines order of preference for searching in that country. Graydon Company Data Webservice. Provides access to millions of companies across many countries.