|
Below is a comprehensive list of the individual elements that can be included in your xml documents.
|
|
| Element Name |
cwMessage |
| Parent |
None |
| Occurences |
Min |
1 |
Max |
1 |
| Data Type |
- |
| Description |
The root element used to encompass the contents of all the other elements. |
| Element Name |
Header |
| Parent |
cwMessage |
| Occurences |
Min |
1 |
Max |
1 |
| Data Type |
- |
| Description |
Holds a number of sub elements to identify the sender and the relevant authentication details. |
| Element Name |
MessageDetails |
| Parent |
Header |
| Occurences |
Min |
1 |
Max |
1 |
| Data Type |
- |
| Description |
Holds a number of sub elements to indicate the type of procedure being called and the unique transaction ID associated with the transaction. |
| Element Name |
Class |
| Parent |
MessageDetails |
| Occurences |
Min |
1 |
Max |
1 |
| Data Type |
- |
| Description |
Informs the gateway of the procedure being called. Currently there is only one option here 'InsertCompany' for inserting company data throught the Gateway. |
| Element Name |
TransactionID |
| Parent |
MessageDetails |
| Occurences |
Min |
1 |
Max |
1 |
| Data Type |
Integer (Min Length = 4, Max. Length = 8) |
| Description |
A unique value that must be supplied to distingiush each document. |
| Element Name |
SenderDetails |
| Parent |
Header |
| Occurences |
Min |
1 |
Max |
1 |
| Data Type |
- |
| Description |
Holds the authentication elements used to qualify the presenter. |
| Element Name |
Authentication |
| Parent |
SenderDetails |
| Occurences |
Min |
1 |
Max |
1 |
| Data Type |
- |
| Description |
Holds the authentication sub elements used to qualify the presenter. |
| Element Name |
AccountNumber |
| Parent |
Authentication |
| Occurences |
Min |
1 |
Max |
1 |
| Data Type |
Numeric (Min Length = 10, Max. Length = 14) |
| Description |
The unique account number that identifies the presenters reseller account. |
| Element Name |
AccountEmail |
| Parent |
Authentication |
| Occurences |
Min |
1 |
Max |
1 |
| Data Type |
Email Address |
| Description |
The email address associated with the presenters reseller account. |
| Element Name |
AccountPassword |
| Parent |
Authentication |
| Occurences |
Min |
1 |
Max |
1 |
| Data Type |
Alph Numeric (Min Length = 6, Max. Length = 12) |
| Description |
The account password used to authenticate the presenter |
| Element Name |
Body |
| Parent |
cwMessage |
| Occurences |
Min |
1 |
Max |
1 |
| Data Type |
- |
| Description |
Holds all the sub elements that expose information about the company. |
| Element Name |
SystemSettings |
| Parent |
Body |
| Occurences |
Min |
1 |
Max |
1 |
| Data Type |
- |
| Description |
Holds a number of elements that indicate the base package and delivery instructions. |
| Element Name |
PackageRef |
| Parent |
SystemSettings |
| Occurences |
Min |
1 |
Max |
1 |
| Data Type |
res01: Basic, res02:Standard, res03:Executive |
| Description |
Indicate which base package has been selected |
| Element Name |
DeliveryID |
| Parent |
SystemSettings |
| Occurences |
Min |
1 |
Max |
1 |
| Data Type |
Boolean |
| Description |
Indicates if any physical items should be delivered to the registered office address or the presenters address (1/true: Presenters Address, 0/false: RO Address) |
| Element Name |
CompanyNameDetails |
| Parent |
Body |
| Occurences |
Min |
1 |
Max |
1 |
| Data Type |
- |
| Description |
Holds information about the proposed company name. |
| Element Name |
CompanyName |
| Parent |
CompanyNameDetails |
| Occurences |
Min |
1 |
Max |
1 |
| Data Type |
Alpha Numeric (Max Length = 150) |
| Description |
Indicates the proposed company name to register. Must include the word 'Limited' at the end of the string. |
| Element Name |
RegisteredOfficeDetails |
| Parent |
Body |
| Occurences |
Min |
1 |
Max |
1 |
| Data Type |
- |
| Description |
Holds information about the proposed registered office address. |
| Element Name |
Address1 |
| Parent |
RegisteredOfficeDetails |
| Occurences |
Min |
1 |
Max |
1 |
| Data Type |
Alpha Numeric (Max Length = 50) |
| Description |
Indicates the first line of the registered office address. |
| Element Name |
Address2 |
| Parent |
RegisteredOfficeDetails |
| Occurences |
Min |
1 |
Max |
0 |
| Data Type |
Alpha Numeric (Max Length = 50) |
| Description |
Indicates the second line of the registered office address. |
| Element Name |
Address3 |
| Parent |
RegisteredOfficeDetails |
| Occurences |
Min |
1 |
Max |
0 |
| Data Type |
Alpha Numeric (Max Length = 50) |
| Description |
Indicates the third line of the registered office address. |
| Element Name |
Town |
| Parent |
RegisteredOfficeDetails |
| Occurences |
Min |
1 |
Max |
1 |
| Data Type |
Alpha Numeric (Max Length = 50) |
| Description |
Indicates the town of the registered office address. |
| Element Name |
County |
| Parent |
RegisteredOfficeDetails |
| Occurences |
Min |
1 |
Max |
1 |
| Data Type |
Alpha Numeric (Max Length = 50) |
| Description |
Indicates the county of the registered office address. |
| Element Name |
Postcode |
| Parent |
RegisteredOfficeDetails |
| Occurences |
Min |
1 |
Max |
1 |
| Data Type |
Alpha Numeric (Max Length = 15) |
| Description |
Indicates the postcode of the registered office address. |
| Element Name |
Country |
| Parent |
RegisteredOfficeDetails |
| Occurences |
Min |
1 |
Max |
1 |
| Data Type |
Alpha Numeric (Max Length = 2) |
| Description |
Indicates the country of the registered office address. Supply EW for Engalnd or Wales, or SC for Scotland. |
| Element Name |
ShareCapitalDetails |
| Parent |
Body |
| Occurences |
Min |
1 |
Max |
1 |
| Data Type |
- |
| Description |
Contains elements relating to the share captial of the company. |
| Element Name |
Currency |
| Parent |
ShareCapitalDetails |
| Occurences |
Min |
1 |
Max |
1 |
| Data Type |
3 Character ISO currency code (Length = 3) |
| Description |
Indicates the currency of the proposed share capital expressed in accordance with ISO 4217 (eg GBP = British Pound) |
| Element Name |
AuthorisedShares |
| Parent |
ShareCapitalDetails |
| Occurences |
Min |
1 |
Max |
1 |
| Data Type |
Integer |
| Description |
Indicates the number of authorised shares. |
| Element Name |
NominalShareValue |
| Parent |
ShareCapitalDetails |
| Occurences |
Min |
1 |
Max |
1 |
| Data Type |
Double |
| Description |
Indicates the nominal share value. |
| Element Name |
PersonnelDetails |
| Parent |
Body |
| Occurences |
Min |
1 |
Max |
1 |
| Data Type |
- |
| Description |
Contains elements relating to the personnel of the company. |
| Element Name |
PersonnelItem |
| Parent |
PersonnelDetails |
| Occurences |
Min |
2 |
Max |
UNLIMITED |
| Data Type |
- |
| Description |
Contains sub elements relating to the particulars of the directors, secretaries and shareholders. |
| Element Name |
PersonnelParticulars |
| Parent |
PersonnelItem |
| Occurences |
Min |
1 |
Max |
1 |
| Data Type |
- |
| Description |
Contains sub elements relating to the name, dob, nationality and occupation of the member of personnel. |
| Element Name |
CorporateID |
| Parent |
PersonnelParticulars |
| Occurences |
Min |
1 |
Max |
1 |
| Data Type |
Boolean |
| Description |
Indicates if the member of personnel is a company or an individual (1/true: Company, 0/false: Individual) |
| Element Name |
FirstName |
| Parent |
PersonnelParticulars |
| Occurences |
Min |
0 |
Max |
1 |
| Data Type |
Alph numeric (Max Length = 50) (Mandatory for non-corporate personnel) |
| Description |
The first name of the member of personnel |
| Element Name |
MiddleName |
| Parent |
PersonnelParticulars |
| Occurences |
Min |
0 |
Max |
1 |
| Data Type |
Alph numeric (Max Length = 50) |
| Description |
The middle name of the member of personnel |
| Element Name |
Surname |
| Parent |
PersonnelParticulars |
| Occurences |
Min |
0 |
Max |
1 |
| Data Type |
Alph numeric (Max Length = 50) (Mandatory for non-corporate personnel) |
| Description |
The surname of the member of personnel |
| Element Name |
Nationality |
| Parent |
PersonnelParticulars |
| Occurences |
Min |
0 |
Max |
1 |
| Data Type |
Alph numeric (Max Length = 30) (Mandatory for non-corporate personnel) |
| Description |
The nationality of the member of personnel |
| Element Name |
Occupation |
| Parent |
PersonnelParticulars |
| Occurences |
Min |
0 |
Max |
1 |
| Data Type |
Alph numeric (Max Length = 30) (Mandatory for non-corporate personnel) |
| Description |
The occupation of the member of personnel |
| Element Name |
DOB |
| Parent |
PersonnelParticulars |
| Occurences |
Min |
0 |
Max |
1 |
| Data Type |
Date (dd/mm/ccyy) (Mandatory for non-corporate personnel) |
| Description |
The DOB of the member of personnel. Please note all directors and secretaries must be aged 16 or over. |
| Element Name |
CorporateCompanyName |
| Parent |
PersonnelParticulars |
| Occurences |
Min |
0 |
Max |
1 |
| Data Type |
Alpha numeric (Max Length = 50) (Mandatory for corporate personnel) |
| Description |
The name of the company being appointed. |
| Element Name |
AuthorisingOfficerFirstName |
| Parent |
PersonnelParticulars |
| Occurences |
Min |
0 |
Max |
1 |
| Data Type |
Alpha numeric (Max Length = 50) (Mandatory for corporate personnel) |
| Description |
The first name of the individual who authorises the corporate appointement. |
| Element Name |
AuthorisingOfficerSurname |
| Parent |
PersonnelParticulars |
| Occurences |
Min |
0 |
Max |
1 |
| Data Type |
Alpha numeric (Max Length = 50) (Mandatory for corporate personnel) |
| Description |
The surname of the individual who authorises the corporate appointement. |
| Element Name |
PersonnelAddressDetails |
| Parent |
PersonnelItem |
| Occurences |
Min |
1 |
Max |
1 |
| Data Type |
- |
| Description |
Contains sub elements that indicate the member of personnels home address. |
| Element Name |
Address1 |
| Parent |
PersonnelAddressDetails |
| Occurences |
Min |
1 |
Max |
1 |
| Data Type |
Alpha numeric (Max Length = 50) |
| Description |
First line of the individuals address. |
| Element Name |
Address2 |
| Parent |
PersonnelAddressDetails |
| Occurences |
Min |
0 |
Max |
1 |
| Data Type |
Alpha numeric (Max Length = 50) |
| Description |
Second line of the individuals address. |
| Element Name |
Town |
| Parent |
PersonnelAddressDetails |
| Occurences |
Min |
1 |
Max |
1 |
| Data Type |
Alpha numeric (Max Length = 50) |
| Description |
Town of the individuals address. |
| Element Name |
County |
| Parent |
PersonnelAddressDetails |
| Occurences |
Min |
0 |
Max |
1 |
| Data Type |
Alpha numeric (Max Length = 50) |
| Description |
County of the individuals address. |
| Element Name |
Postcode |
| Parent |
PersonnelAddressDetails |
| Occurences |
Min |
1 |
Max |
1 |
| Data Type |
Alpha numeric (Max Length = 15) |
| Description |
Postcode of the individuals address. |
| Element Name |
Country |
| Parent |
PersonnelAddressDetails |
| Occurences |
Min |
1 |
Max |
1 |
| Data Type |
Alpha numeric (Max Length = 50) |
| Description |
Country of the individuals address. |
| Element Name |
PersonnelAppointments |
| Parent |
PersonnelItem |
| Occurences |
Min |
1 |
Max |
1 |
| Data Type |
- |
| Description |
Contains sub elements that indicate the role of the member of personnel, eg director and secretary etc. |
| Element Name |
DIR |
| Parent |
PersonnelAppointments |
| Occurences |
Min |
1 |
Max |
1 |
| Data Type |
Boolean |
| Description |
Indicates if the individual is a director (1/true: Yes, 0/false: No) |
| Element Name |
SEC |
| Parent |
PersonnelAppointments |
| Occurences |
Min |
1 |
Max |
1 |
| Data Type |
Boolean |
| Description |
Indicates if the individual is a secretary (1/true: Yes, 0/false: No) |
| Element Name |
SHA |
| Parent |
PersonnelAppointments |
| Occurences |
Min |
1 |
Max |
1 |
| Data Type |
Boolean |
| Description |
Indicates if the individual is a shareholder (1/true: Yes, 0/false: No) |
| Element Name |
SharesTaken |
| Parent |
PersonnelAppointments |
| Occurences |
Min |
0 |
Max |
1 |
| Data Type |
Integer (Mandatory if the individual is a shareholder) |
| Description |
Indicates if the individual is a shareholder (1/true: Yes, 0/false: No) |
| Element Name |
DeclarantID |
| Parent |
PersonnelAppointments |
| Occurences |
Min |
0 |
Max |
1 |
| Data Type |
Boolean (Must be present for exactly one member of personnel) |
| Description |
The declarant is the individual who undertakes that all the supplied information is accurate. 1/True Indicates that the individual is the delcarant. This element need not be present for any one other than the declarant. |
| Element Name |
Directorships |
| Parent |
PersonnelItem |
| Occurences |
Min |
0 |
Max |
1 |
| Data Type |
- |
| Description |
Contains information relating to any other directorships held by the individual. This information is only required for directors |
| Element Name |
DirectorshipItem |
| Parent |
Directorships |
| Occurences |
Min |
0 |
Max |
5 |
| Data Type |
- |
| Description |
Contains information relating to a specific directorship. |
| Element Name |
DirCompanyName |
| Parent |
DirectorshipItem |
| Occurences |
Min |
1 |
Max |
1 |
| Data Type |
Alpha Number (Max Length = 50) |
| Description |
The name of the company where the directorship is held |
| Element Name |
DirCompanyNumber |
| Parent |
DirectorshipItem |
| Occurences |
Min |
1 |
Max |
1 |
| Data Type |
Alpha Number (Max Length = 8) |
| Description |
The number of the company where the directorship is held |
| Element Name |
OrderDetails |
| Parent |
Body |
| Occurences |
Min |
1 |
Max |
1 |
| Data Type |
- |
| Description |
Contains a series of elements to indicate what additional products or services are being ordered. |
| Element Name |
BMA |
| Parent |
OrderDetails |
| Occurences |
Min |
1 |
Max |
1 |
| Data Type |
Boolean (true/false, 1,0) |
| Description |
Bound Memorandum and Articles (£9.99) |
| Element Name |
COI |
| Parent |
OrderDetails |
| Occurences |
Min |
1 |
Max |
1 |
| Data Type |
Boolean (true/false, 1,0) |
| Description |
Certificate of Incorporation (£9.99) |
| Element Name |
CCR |
| Parent |
OrderDetails |
| Occurences |
Min |
1 |
Max |
1 |
| Data Type |
Boolean (true/false, 1,0) |
| Description |
Combined Company Register (£18.99) |
| Element Name |
PCS |
| Parent |
OrderDetails |
| Occurences |
Min |
1 |
Max |
1 |
| Data Type |
Boolean (true/false, 1,0) |
| Description |
Plier Style Company Seal (£18.99) |
| Element Name |
FBM |
| Parent |
OrderDetails |
| Occurences |
Min |
1 |
Max |
1 |
| Data Type |
Boolean (true/false, 1,0) |
| Description |
First Board Minutes (£4.99) |
| Element Name |
DSA |
| Parent |
OrderDetails |
| Occurences |
Min |
1 |
Max |
1 |
| Data Type |
Boolean (true/false, 1,0) |
| Description |
Directors Service Agreement (£14.99) |
| Element Name |
EMP |
| Parent |
OrderDetails |
| Occurences |
Min |
1 |
Max |
1 |
| Data Type |
Boolean (true/false, 1,0) |
| Description |
Employment Pack (£14.99) |
| Element Name |
BNP |
| Parent |
OrderDetails |
| Occurences |
Min |
1 |
Max |
1 |
| Data Type |
Boolean (true/false, 1,0) |
| Description |
Brass Name Plate (£19.99) |
| Element Name |
CWS |
| Parent |
OrderDetails |
| Occurences |
Min |
1 |
Max |
1 |
| Data Type |
Boolean (true/false, 1,0) |
| Description |
Reason 8 Website Setup (£9.99) |
| Element Name |
FMS |
| Parent |
OrderDetails |
| Occurences |
Min |
1 |
Max |
1 |
| Data Type |
Boolean (true/false, 1,0) |
| Description |
Fraud Monitoring Service (£9.99) |
|
|