The XML Gateway is capable of reading and parsing company information posted in XML format using the HTTP POST method (content type set as text/xml). The response is delivered to the browser at runtime detailing any errors that may have occurred while reading, parsing and validating the xml document.
Error Checking
Any XML document posted to the Gateway undergoes two separate checking procedures to ensure the data is compliant and can be migrated into the database without problem. The outcome of these checks will be displayed in the following table:
| PARSER RESPONSE |
| VALIDATOR RESPONSE |
The nature of these checks are described below.
Parsing
Initially the XML document posted will be compared against the Schema to ensure the document is well formed and the elements have been sequenced correctly. The parser will recognise missing elements, elements that are not in the correct order or not recognised by the Schema. In some cases the parser will check to ensure the data supplied is of the correct type and within a fixed length or numerical range.
Validation
Once it has been confirmed that the document is compliant with the Schema then it will be passed to the Validator for further more detailed checks. The validator will look at the structure of the Company and will highlight any inconsistencies in the information. To be specific the validator will carry out the following checks.
The account details resolve to an account stored on our system
The Company Name has not already been submitted to the Gateway.
At least one director, secretary and shareholder has been nominated.
A sole director is not also acting as the secretary.
The issued share capital is not greater than the authorised share capital.
If there are no validation errors then the Validator Response will be flagged as 'SUCCESSFUL' otherwise a 'FAILED' message will be displayed along with details of the error encountered.
Testing the Gateway
While testing the Gateway we recommend that you add the additional querystring value to the Gateway URL 'testMode=1'. The presence of this value will indicate to our server that you are testing your software and that no data should be inserted into your account. The URL you post you XML documents to should look like this when you wish the test mode to be invoked:
http://www.company-wizard.co.uk/XML-Gateway/version/1.0/?testMode=1
Completing a submission
Once you have successfully posted a company to the XML Gateway the details for the submission can be accessed in your the XML Gateway Order Screen (accessible from your control panel). Any new orders recently posted to the gateway that have not yet been submitted for processing are highlighted in Green, please note that until the company has been submitted from this screen it will not be processed and forwarded to Companies House for review. We also recommend that you check the details of the application before clicking on the submit button.
|
