Syntax
Function CreateClient(ParentID As Integer, FirstName As String, SecondName As String, ThirdName As String, LastName As String, Username As String, Password As String, Phone As String, Fax As String, Mobile As String, TelPW As String, POB As String, Country As String, Email As String, Address As String, ReadOnlyLogin As Boolean, ForceChangePassword as Boolean, Leverage As String) As String
Description
The CreateClient operation is used to initialize a new client under the specific given parent ID.
Request Parameters
| Name |
Description |
Required |
| ParentID |
- ParentIdentifier which the new client will be under it
- Type: Integer
- Default: None
- Constraints: Must be valid parent and accessible by logged in dealer
|
Yes |
| FirstName |
- Client first name
- Type: String
- Default: None
|
Yes |
| SecondName |
- Client second name
- Type: String
- Default: None
|
Yes |
| ThirdName |
- Client third name
- Type: String
- Default: None
|
Yes |
| LastName |
- Client last name
- Type: String
- Default: None
|
Yes |
| Username |
- The username for the new client
- Type: String
- Default: None
|
Yes |
| Password |
- Password for new client
- Type: String
- Default: None
|
Yes |
| Phone |
- Client phone number
- Type: String
- Default: None
|
Yes |
| Fax |
- Client Fax number
- Type: String
- Default: None
|
Yes |
| Mobile |
- Client mobile number
- Type: String
- Default: None
|
Yes |
| TelPW |
- Client telephone password
- Type: String
- Default: None
|
Yes |
| POB |
- Post office box
- Type: String
- Default: None
|
Yes |
| Country |
- Client Country
- Type: String
- Default: None
- Constraints: must be one of the following countries:
-Afghanistan
-Albania
-Algeria
-American Samoa
-Andorra
-Angola
-Anguilla
-Antigua and Barbuda
-Argentina
-Armenia
-Aruba
-Ascension Island
-Australia
-Austria
-Azerbaijan
-the Bahamas
-Bahrain
-Bangladesh
-Barbados
-Belarus
-Belgium
-Belize
-Benin
-Bermuda
-Bhutan
-Bolivia
-Bosnia and Herzegovina
-Botswana
-Brazil
-Brunei
-Bulgaria
-Burkina Faso
-Burundi
-Cambodia
-Cameroon
-Canada
-Cape Verde
-Cayman Islands
-The central African Republic
-Chad
-Chile
-China
-Cocos (Keeling) Islands
-Colombia
-Comoros
-Congo
-Congo (DRC)
-Cook Islands
-Costa Rica
-Cote d’Ivoire
-Croatia
-Cuba
-Cyprus
-the Czech Republic
-Denmark
-Diego Garcia
-Djibouti
-Dominica
-the Dominican Republic
-Ecuador
-Egypt
-el Salvador
-Equatorial Guinea
-Eritrea
-Estonia
-Ethiopia
-Falkland Islands (Islas Malvinas)
-Faroe Islands
-Fiji Islands
-Finland
-France
-French Antilles
-French Guiana
-French Polynesia
-Gabon
-the Gambia
-Georgia
-Germany
-Ghana
-Gibraltar
-Greece
-Greenland
-Grenada
-Guadeloupe
-Guam
-Guantanamo Bay
-Guatemala
-Guinea
– Guinea -Bissau
-Guyana
-Haiti
-Honduras
-Hong Kong SAR
-Hungary
-Iceland
-India
-Indonesia
-Iran
-Iraq
-Ireland
-Israel
-Italy
-Jamaica
-Japan
-Jordan
-Kazakhstan
-Kenya
-Kiribati
-Korea
-Kuwait
-Kyrgyzstan
-Laos
-Latvia
-Lebanon
-Lesotho
-Liberia
-Libya
-Liechtenstein
-Lithuania
-Luxembourg
-Macao SAR
-Macedonia, the Former Yugoslav Republic of
-Madagascar
-Malawi
-Malaysia
-the Maldives
-Mali
-Malta
-Marshall Islands
-Martinique
-Mauritania
-Mauritius
-Mayotte
-Mexico
-Micronesia
-Moldova
-Monaco
-Mongolia
-Montserrat
-Morocco
-Mozambique
-Myanmar
-Namibia
-Nauru
-Nepal
-Netherlands Antilles
-Netherlands, the
-New Caledonia
-New Zealand
-Nicaragua
-Niger
-Nigeria
-Niue
-Norfolk Island
-North Korea
-Norway
-Oman
-Pakistan
-Palau
-Palestine
-Panama
-Papua New Guinea
-Paraguay
-Peru
-the Philippines
-Poland
-Portugal
-Puerto Rico
-Qatar
-Reunion
-Romania
-Russia
-Rwanda
-So Tom and Principe
-Samoa
-San Marino
-Saudi Arabia
-Senegal
-Serbia and Montenegro
-Seychelles
-Sierra Leone
-Singapore
-Slovakia
-Slovenia
-Solomon Islands
-Somalia
-South Africa
-Spain
-Sri Lanka
-St.Helena
-St. Kitts and Nevis
-St.Lucia
-St. Pierre and Miquelon
-St. Vincent and the Grenadines
-Sudan
-Suriname
-Swaziland
-Sweden
-Switzerland
-Syria
-Taiwan
-Tajikistan
-Tanzania
-Thailand
-Timor -Leste
-Togo
-Tokelau
-Tonga
-Trinidad and Tobago
-Tunisia
-Turkey
-Turkmenistan
-the Turks and Caicos Islands
-Tuvalu
-Uganda
-Ukraine
-the United Arab Emirates
-the United Kingdom
-the United States
-Uruguay
-Uzbekistan
-Vanuatu
-Vatican City
-Venezuela
-Vietnam
-the Virgin Islands
-Virgin Islands, British
-Wallis and Futuna
-Yemen
-Zambia
-Zimbabwe
|
Yes |
| Email |
- Client Email address
- Type: String
- Default: None
|
Yes |
| Address |
- Client Address
- Type: String
- Default: None
|
Yes |
| IsOnlyLogin |
- To indicate if the client will only monitor the trades or not
- Type: Boolean
- Default: None
|
Yes |
| ForceChangePassword |
- To indicate if the client will have to change the password after the first login or not
- Type: Boolean
- Default: none
|
Yes |
| Leverage |
- Client Leverage
- Type: string
- Default: none
- Example: 1:250
|
Yes |
Response Elements
| Name |
Description |
| Result |
This operation returns a new client identifier in case of success, otherwise, an explicit error code is returned. |
See Also
VertexFX Backoffice WCF Service Index