ClickBook Homepage
spacer
spacer

Web Services 1.3

Group Schemas

BasicDetails
BasicDetailsClientFile
NewClientFile
NewEmailAddressClientFile
NewUserRegistration
ReminderSettings
StreetAddress

Usage

The ClickBook API supports the update of existing user-specific data and the creation of new user-specific data in some cases. The API provides a mechanism that describes "groups" (schemas) of "Items" (fields) and their properties for consumption by user interfaces. The properties of Items are used in the back-end to validate input.

A group schema can be retrieved by calling GETSCHEMAITEMGROUP of the Public endpoint.

In the following example, the schema is retrieved for registering a new end-user (business customer).

Example Request:

1 2 3 4 5 6 7 8 9 10
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope>
   <soapenv:Header />
   <soapenv:Body>
      <urn:GETSCHEMAITEMGROUP>
         <APIKEY>?</APIKEY>
         <GROUPNAME>NewUserRegistration</GROUPNAME>
      </urn:GETSCHEMAITEMGROUP>
   </soapenv:Body>
</soapenv:Envelope>

Response:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope>
   <soapenv:Body>
      <ns1:GETSCHEMAITEMGROUPResponse xmlns:ns1="urn:DefaultNamespace">
         <GETSCHEMAITEMGROUPReturn>
            <SCHEMA>NewUserRegistration</SCHEMA>
            <CONTEXTFORM />
            <CONTEXTID />
            <ITEM>
               <TITLE>First Name</TITLE>
               <UIALIAS>inp-firstname</UIALIAS>
               <FLAGS>YV</FLAGS>
               <VALUES xsi:nil="true" />
               <DEFAULT xsi:nil="true" />
               <OPTIONS xsi:nil="true" />
            </ITEM>
            <ITEM>
               <TITLE>Last Name</TITLE>
               <UIALIAS>inp-lastname</UIALIAS>
               <FLAGS>YV</FLAGS>
               <VALUES xsi:nil="true" />
               <DEFAULT xsi:nil="true" />
               <OPTIONS xsi:nil="true" />
            </ITEM>
            <ITEM>
               <TITLE>Contact Number</TITLE>
               <UIALIAS>inp-telfixed</UIALIAS>
               <FLAGS>N YV</FLAGS>
               <VALUES xsi:nil="true" />
               <DEFAULT xsi:nil="true" />
               <OPTIONS xsi:nil="true" />
            </ITEM>
            <ITEM>
               <TITLE>Mobile Number</TITLE>
               <UIALIAS>inp-telmobile</UIALIAS>
               <FLAGS>NV</FLAGS>
               <VALUES xsi:nil="true" />
               <DEFAULT xsi:nil="true" />
               <OPTIONS xsi:nil="true" />
            </ITEM>
            <ITEM>
               <TITLE>Email Address</TITLE>
               <UIALIAS>inp-emailaddress1</UIALIAS>
               <FLAGS>E YV</FLAGS>
               <VALUES xsi:nil="true" />
               <DEFAULT xsi:nil="true" />
               <OPTIONS xsi:nil="true" />
            </ITEM>
            <ITEM>
               <TITLE>Confirm Email Address</TITLE>
               <UIALIAS>inp-emailaddress2</UIALIAS>
               <FLAGS>E YV</FLAGS>
               <VALUES xsi:nil="true" />
               <DEFAULT xsi:nil="true" />
               <OPTIONS xsi:nil="true" />
            </ITEM>
            <ITEM>
               <TITLE>Create Password</TITLE>
               <UIALIAS>inp-password1</UIALIAS>
               <FLAGS>P YV</FLAGS>
               <VALUES xsi:nil="true" />
               <DEFAULT xsi:nil="true" />
               <OPTIONS xsi:nil="true" />
            </ITEM>
            <ITEM>
               <TITLE>Confirm Password</TITLE>
               <UIALIAS>inp-password2</UIALIAS>
               <FLAGS>P YV</FLAGS>
               <VALUES xsi:nil="true" />
               <DEFAULT xsi:nil="true" />
               <OPTIONS xsi:nil="true" />
            </ITEM>
            <ITEM>
               <TITLE>Agree to Terms & Conditions</TITLE>
               <UIALIAS>inp-agreeterms</UIALIAS>
               <FLAGS>T Y</FLAGS>
               <VALUES xsi:nil="true" />
               <DEFAULT xsi:nil="true" />
               <OPTIONS xsi:nil="true" />
            </ITEM>
            <ITEM>
               <TITLE>TimeZone</TITLE>
               <UIALIAS>inp-timezone</UIALIAS>
               <FLAGS>Y</FLAGS>
               <VALUES xsi:nil="true" />
               <DEFAULT xsi:nil="true" />
               <OPTIONS xsi:nil="true" />
            </ITEM>
            <ITEM>
               <TITLE>Country</TITLE>
               <UIALIAS>inp-country</UIALIAS>
               <FLAGS>O Y</FLAGS>
               <VALUES xsi:nil="true" />
               <DEFAULT xsi:nil="true" />
               <OPTIONS xsi:type="soapenc:Array" soapenc:arrayType="xsd:string[238]">
                  <item />
                  <item>United States</item>
                  <item>Australia</item>
                  <item>New Zealand</item>
                  <item>United Kingdom</item>
                  <item>Canada</item>
                  <item />
                  <item>Afghanistan</item>
                  <item>Albania</item>
                  <item>Algeria</item>
                  <item>American Samoa</item>
                  <item>Andorra</item>
                  <item>Angola</item>
                  <item>Anguilla</item>
                  <item>Antarctica</item>
                  <item>Antigua and Barbuda</item>
                  <item>Argentina</item>
                  <item>Armenia</item>
                  <item>Aruba</item>
                  <item>Austria</item>
                  <item>Azerbaijan</item>
                  <item>Bahamas</item>
                  <item>Bahrain</item>
                  <item>Bangladesh</item>
                  <item>Barbados</item>
                  <item>Belarus</item>
                  <item>Belgium</item>
                  <item>Belize</item>
                  <item>Benin</item>
                  <item>Bermuda</item>
                  <item>Bhutan</item>
                  <item>Bolivia</item>
                  <item>Bosnia and Herzegovina</item>
                  <item>Botswana</item>
                  <item>Bouvet Island</item>
                  <item>Brazil</item>
                  <item>British Indian Ocean Territory</item>
                  <item>Brunei Darussalam</item>
                  <item>Bulgaria</item>
                  <item>Burkina Faso</item>
                  <item>Burundi</item>
                  <item>Cambodia</item>
                  <item>Cameroon</item>
                  <item>Cape Verde</item>
                  <item>Caribbean Islands</item>
                  <item>Cayman Islands</item>
                  <item>Central African Republic</item>
                  <item>Chad</item>
                  <item>Chile</item>
                  <item>China</item>
                  <item>Christmas Island</item>
                  <item>Cocos (Keeling) Islands</item>
                  <item>Colombia</item>
                  <item>Comoros</item>
                  <item>Congo</item>
                  <item>Cook Islands</item>
                  <item>Costa Rica</item>
                  <item>Cote D'Ivoire</item>
                  <item>Croatia</item>
                  <item>Cyprus</item>
                  <item>Czech Republic</item>
                  <item>Denmark</item>
                  <item>Djibouti</item>
                  <item>Dominica</item>
                  <item>Dominican Republic</item>
                  <item>East Timor</item>
                  <item>Ecuador</item>
                  <item>Egypt</item>
                  <item>El Salvador</item>
                  <item>Equatorial Guinea</item>
                  <item>Eritrea</item>
                  <item>Estonia</item>
                  <item>Ethiopia</item>
                  <item>Falkland Islands (Malvinas)</item>
                  <item>Faroe Islands</item>
                  <item>Fiji</item>
                  <item>Finland</item>
                  <item>France</item>
                  <item>France, Metropolitan</item>
                  <item>French Guiana</item>
                  <item>French Polynesia</item>
                  <item>French Southern Territories</item>
                  <item>Gabon</item>
                  <item>Gambia</item>
                  <item>Georgia</item>
                  <item>Germany</item>
                  <item>Ghana</item>
                  <item>Gibraltar</item>
                  <item>Greece</item>
                  <item>Greenland</item>
                  <item>Grenada</item>
                  <item>Guadeloupe</item>
                  <item>Guam</item>
                  <item>Guatemala</item>
                  <item>Guinea-Bissau</item>
                  <item>Guinea</item>
                  <item>Guyana</item>
                  <item>Haiti</item>
                  <item>Heard Island and McDonald Islands</item>
                  <item>Honduras</item>
                  <item>Hong Kong</item>
                  <item>Hungary</item>
                  <item>Iceland</item>
                  <item>India</item>
                  <item>Indonesia</item>
                  <item>Ireland</item>
                  <item>Israel</item>
                  <item>Italy</item>
                  <item>Jamaica</item>
                  <item>Japan</item>
                  <item>Jordan</item>
                  <item>Kazakhstan</item>
                  <item>Kenya</item>
                  <item>Kiribati</item>
                  <item>Korea, Republic of</item>
                  <item>Kuwait</item>
                  <item>Kyrgyzstan</item>
                  <item>Lao People's Democratic Republic</item>
                  <item>Latvia</item>
                  <item>Lebanon</item>
                  <item>Lesotho</item>
                  <item>Liberia</item>
                  <item>Liechtenstein</item>
                  <item>Lithuania</item>
                  <item>Luxembourg</item>
                  <item>Macau</item>
                  <item>Macedonia</item>
                  <item>Madegascar</item>
                  <item>Malawi</item>
                  <item>Malaysia</item>
                  <item>Maldives</item>
                  <item>Mali</item>
                  <item>Malta</item>
                  <item>Marshall Islands</item>
                  <item>Martinique</item>
                  <item>Mauritania</item>
                  <item>Mauritius</item>
                  <item>Mayotte</item>
                  <item>Mexico</item>
                  <item>Micronesia</item>
                  <item>Moldova, Republic of</item>
                  <item>Monaco</item>
                  <item>Mongolia</item>
                  <item>Montserrat</item>
                  <item>Morocco</item>
                  <item>Mozambique</item>
                  <item>Myanmar</item>
                  <item>Namibia</item>
                  <item>Nauru</item>
                  <item>Nepal</item>
                  <item>Netherlands Antilles</item>
                  <item>Netherlands</item>
                  <item>New Caledonia</item>
                  <item>Nicaragua</item>
                  <item>Niger</item>
                  <item>Nigeria</item>
                  <item>Niue</item>
                  <item>Norfolk Island</item>
                  <item>Northern Mariana Islands</item>
                  <item>Norway</item>
                  <item>N. Korea</item>
                  <item>Oman</item>
                  <item>Other</item>
                  <item>Pakistan</item>
                  <item>Pakistan</item>
                  <item>Palau</item>
                  <item>Panama</item>
                  <item>Papua New Guinea</item>
                  <item>Paraguay</item>
                  <item>Peru</item>
                  <item>Phillippines</item>
                  <item>Pitcairn</item>
                  <item>Poland</item>
                  <item>Portugal</item>
                  <item>Puerto Rico</item>
                  <item>Qatar</item>
                  <item>Reunion</item>
                  <item>Romania</item>
                  <item>Russian Federation</item>
                  <item>Rwanda</item>
                  <item>Saint Helena</item>
                  <item>Saint Kitts and Nevis</item>
                  <item>Saint Lucia</item>
                  <item>Saint Pierre and Miquelon</item>
                  <item>Saint Vincent and the Grenadines</item>
                  <item>Samoa</item>
                  <item>San Marino</item>
                  <item>Sao Tome and Principe</item>
                  <item>Saudi Arabia</item>
                  <item>Senegal</item>
                  <item>Seychelles</item>
                  <item>Sierra Leone</item>
                  <item>Singapore</item>
                  <item>Slovakia</item>
                  <item>Slovenia</item>
                  <item>Solomon Islands</item>
                  <item>Somalia</item>
                  <item>South Africa</item>
                  <item>South Georgia and the South Sandwich</item>
                  <item>Spain</item>
                  <item>Sri Lanka</item>
                  <item>Sudan</item>
                  <item>Suriname</item>
                  <item>Svalbard and Jan Mayen</item>
                  <item>Swaziland</item>
                  <item>Sweden</item>
                  <item>Switzerland</item>
                  <item>Taiwan</item>
                  <item>Tajikistan</item>
                  <item>Tanzania</item>
                  <item>Thailand</item>
                  <item>Togo</item>
                  <item>Tokelau</item>
                  <item>Tonga</item>
                  <item>Trinidad and Tobago</item>
                  <item>Tunisia</item>
                  <item>Turkey</item>
                  <item>Turkmenistan</item>
                  <item>Turks and Caicos Islands</item>
                  <item>Tuvalu</item>
                  <item>Uganda</item>
                  <item>Ukraine</item>
                  <item>United Arab Emirates</item>
                  <item>Uruguay</item>
                  <item>Uzbekistan</item>
                  <item>Vanautu</item>
                  <item>Vatican City State</item>
                  <item>Venezuela</item>
                  <item>Viet Nam</item>
                  <item>Virgin Islands (British)</item>
                  <item>Virgin Islands (U.S.)</item>
                  <item>Wallis and Futuna Islands</item>
                  <item>Western Sahara</item>
                  <item>Yemen</item>
                  <item>Yugoslavia</item>
                  <item>Zaire</item>
                  <item>Zambia</item>
                  <item>Zimbabwe</item>
               </OPTIONS>
            </ITEM>
         </GETSCHEMAITEMGROUPReturn>
      </ns1:GETSCHEMAITEMGROUPResponse>
   </soapenv:Body>
</soapenv:Envelope>





Disclaimer  Privacy Policy  Terms & Conditions  Contact Us  Search 
All Rights reserved - ClickBook.net